forked from librenms/librenms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
validate.php
executable file
·171 lines (142 loc) · 5.15 KB
/
validate.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
#!/usr/bin/env php
<?php
/*
* LibreNMS
*
* Copyright (c) 2014 Neil Lathwood <https://github.com/laf/ https://www.lathwood.co.uk/fa>
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version. Please see LICENSE.txt at the top level of
* the source code distribution for details.
*/
use LibreNMS\Config;
use LibreNMS\ValidationResult;
use LibreNMS\Validator;
chdir(__DIR__); // cwd to the directory containing this script
ini_set('display_errors', 1);
$options = getopt('g:m:s::h::');
if (isset($options['h'])) {
echo
"\n Validate setup tool
Usage: ./validate.php [-g <group>] [-s] [-h]
-h This help section.
-s Print the status of each group
-g Any validation groups you want to run, comma separated:
Non-default groups:
- mail: this will test your email settings (uses default_mail option even if default_only is not set)
- distributedpoller: this will test for the install running as a distributed poller
- rrdcheck: this will check to see if your rrd files are corrupt
Default groups:
- configuration: checks various config settings are correct
- database: checks the database for errors
- dependencies: checks that all required libraries are installed and up-to-date
- disk: checks for disk space and other disk related issues
- php: check that various PHP modules and functions exist
- poller: check that the poller and discovery are running properly
- programs: check that external programs exist and are executable
- python: check that various Python modules and functions exist
- system: checks system related items
- updates: checks the status of git and updates
- user: check that the LibreNMS user is set properly
Example: ./validate.php -g mail.
";
exit;
}
if (function_exists('posix_getuid') && posix_getuid() === 0) {
echo 'Do not run validate.php as root' . PHP_EOL;
exit(1);
}
// Check autoload
if (! file_exists('vendor/autoload.php')) {
print_fail('Composer has not been run, dependencies are missing', './scripts/composer_wrapper.php install --no-dev');
exit;
}
require_once 'vendor/autoload.php';
require_once 'includes/common.php';
require_once 'includes/functions.php';
// Buffer output
ob_start();
$precheck_complete = false;
register_shutdown_function(function () {
global $precheck_complete;
if (! $precheck_complete) {
// use this in case composer autoloader isn't available
spl_autoload_register(function ($class) {
@include str_replace('\\', '/', $class) . '.php';
});
print_header();
}
});
$pre_checks_failed = false;
// config.php checks
if (file_exists('config.php')) {
$syntax_check = `php -ln config.php`;
if (strpos($syntax_check, 'No syntax errors detected') === false) {
print_fail('Syntax error in config.php');
echo $syntax_check;
$pre_checks_failed = true;
}
$first_line = rtrim(`head -n1 config.php`);
if (! strpos($first_line, '<?php') === 0) {
print_fail("config.php doesn't start with a <?php - please fix this ($first_line)");
$pre_checks_failed = true;
}
if (strpos(`tail config.php`, '?>') !== false) {
print_fail('Remove the ?> at the end of config.php');
$pre_checks_failed = true;
}
}
// Composer check
$validator = new Validator();
$validator->validate(['dependencies']);
if ($validator->getGroupStatus('dependencies') == ValidationResult::FAILURE) {
$pre_checks_failed = true;
}
if ($pre_checks_failed) {
exit;
}
$init_modules = [];
require 'includes/init.php';
// make sure install_dir is set correctly, or the next includes will fail
if (! file_exists(Config::get('install_dir') . '/.env')) {
$suggested = realpath(__DIR__);
print_fail('\'install_dir\' config setting is not set correctly.', "It should probably be set to: $suggested");
exit;
}
if (\LibreNMS\DB\Eloquent::isConnected()) {
$validator->ok('Database connection successful', null, 'database');
} else {
$validator->fail('Error connecting to your database.', null, 'database');
}
$precheck_complete = true; // disable shutdown function
print_header();
if (isset($options['g'])) {
$modules = explode(',', $options['g']);
} elseif (isset($options['m'])) {
$modules = explode(',', $options['m']); // backwards compat
} else {
$modules = []; // all modules
}
// run checks
$validator->validate($modules, isset($options['s']) || ! empty($modules));
function print_header()
{
$output = ob_get_clean();
@ob_end_clean();
echo \LibreNMS\Util\Version::get()->header() . PHP_EOL;
echo $output;
}
// output matches that of ValidationResult
function print_fail($msg, $fix = null)
{
echo "[\033[31;1mFAIL\033[0m] $msg";
if ($fix && strlen($msg) > 72) {
echo PHP_EOL . ' ';
}
if (! empty($fix)) {
echo " [\033[34;1mFIX\033[0m] \033[34;1m$fix\033[0m";
}
echo PHP_EOL;
}