. * * @package LibreNMS * @link http://librenms.org * @copyright 2018 Tony Murray * @author Tony Murray */ namespace App; use App\Models\Device; use App\Models\Notification; use Auth; use Cache; use Carbon\Carbon; use LibreNMS\Config; use Symfony\Component\HttpFoundation\Response as SymfonyResponse; use Toastr; class Checks { public static function preBoot() { // check php extensions if ($missing = self::missingPhpExtensions()) { self::printMessage( "Missing PHP extensions. Please install and enable them on your LibreNMS server.", $missing, true ); } } /** * Pre-boot dependency check */ public static function postAutoload() { if (!class_exists(\Illuminate\Foundation\Application::class)) { self::printMessage( 'Error: Missing dependencies! Run the following command to fix:', './scripts/composer_wrapper.php install --no-dev', true ); } } /** * Post boot Toast messages */ public static function postAuth() { // limit popup messages frequency if (Cache::get('checks_popup_timeout') || !Auth::check()) { return; } Cache::put('checks_popup_timeout', true, Config::get('checks_popup_timer', 5)); $user = Auth::user(); if ($user->isAdmin()) { $notifications = Notification::isUnread($user)->where('severity', '>', 1)->get(); foreach ($notifications as $notification) { Toastr::error("$notification->body", $notification->title); } $warn_sec = Config::get('rrd.step', 300) * 3; if (Device::isUp()->where('last_polled', '<=', Carbon::now()->subSeconds($warn_sec))->exists()) { $warn_min = $warn_sec / 60; Toastr::warning('It appears as though you have some devices that haven\'t completed polling within the last ' . $warn_min . ' minutes, you may want to check that out :)', 'Devices unpolled'); } // Directory access checks $rrd_dir = Config::get('rrd_dir'); if (!is_dir($rrd_dir)) { Toastr::error("RRD Directory is missing ($rrd_dir). Graphing may fail. Validate your install"); } $temp_dir = Config::get('temp_dir'); if (!is_dir($temp_dir)) { Toastr::error("Temp Directory is missing ($temp_dir). Graphing may fail. Validate your install"); } elseif (!is_writable($temp_dir)) { Toastr::error("Temp Directory is not writable ($temp_dir). Graphing may fail. Validate your install"); } } } private static function printMessage($title, $content, $exit = false) { $content = (array)$content; if (PHP_SAPI == 'cli') { $format = "%s\n\n%s\n\n"; $message = implode(PHP_EOL, $content); } else { $format = "

%s

"; $message = ''; foreach ($content as $line) { $message .= "

$line

\n"; } } printf($format, $title, $message); if ($exit) { exit(1); } } private static function missingPhpExtensions() { // allow mysqli, but prefer mysqlnd if (!extension_loaded('mysqlnd') && !extension_loaded('mysqli')) { return ['mysqlnd']; } $required_modules = ['mbstring', 'pcre', 'curl', 'session', 'xml', 'gd']; return array_filter($required_modules, function ($module) { return !extension_loaded($module); }); } /** * Check exception for errors related to not being able to write to the filesystem * * @param \Exception $e * @return bool|SymfonyResponse */ public static function filePermissionsException($e) { if ($e instanceof \ErrorException) { // cannot write to storage directory if (starts_with($e->getMessage(), 'file_put_contents(') && str_contains($e->getMessage(), '/storage/')) { return self::filePermissionsResponse(); } } if ($e instanceof \Exception) { // cannot write to bootstrap directory if ($e->getMessage() == 'The bootstrap/cache directory must be present and writable.') { return self::filePermissionsResponse(); } } if ($e instanceof \UnexpectedValueException) { // monolog cannot init log file if (str_contains($e->getFile(), 'Monolog/Handler/StreamHandler.php')) { return self::filePermissionsResponse(); } } return false; } /** * Generate a semi generic list of commands for the user to run to fix file permissions * and render it to a nice html response * * @return SymfonyResponse */ private static function filePermissionsResponse() { $user = config('librenms.user'); $group = config('librenms.group'); $install_dir = base_path(); $commands = []; $dirs = [ base_path('bootstrap/cache'), base_path('storage'), Config::get('log_dir', base_path('logs')), Config::get('rrd_dir', base_path('rrd')), ]; // check if folders are missing $mkdirs = [ base_path('bootstrap/cache'), base_path('storage/framework/sessions'), base_path('storage/framework/views'), base_path('storage/framework/cache'), Config::get('log_dir', base_path('logs')), Config::get('rrd_dir', base_path('rrd')), ]; $mk_dirs = array_filter($mkdirs, function ($file) { return !file_exists($file); }); if (!empty($mk_dirs)) { $commands[] = 'sudo mkdir -p ' . implode(' ', $mk_dirs); } // always print chwon/setfacl/chmod commands $commands[] = "sudo chown -R $user:$group $install_dir"; $commands[] = 'sudo setfacl -d -m g::rwx ' . implode(' ', $dirs); $commands[] = 'sudo chmod -R ug=rwX ' . implode(' ', $dirs); // check if webserver is in the librenms group $current_groups = explode(' ', trim(exec('groups'))); if (!in_array($group, $current_groups)) { $current_user = trim(exec('whoami')); $commands[] = "usermod -a -G $group $current_user"; } // check for invalid log setting $log_file = config('app.log') ?: Config::get('log_file', base_path('logs/librenms.log')); if (!is_file($log_file) || !is_writable($log_file)) { // override for proper error output $dirs = [$log_file]; $install_dir = $log_file; $commands = [ '

Cannot write to log file: "' . $log_file . '"

', 'Make sure it exists and is writable, or change your LOG_DIR setting.' ]; } // selinux: $commands[] = '

If using SELinux you may also need:

'; foreach ($dirs as $dir) { $commands[] = "semanage fcontext -a -t httpd_sys_rw_content_t '$dir(/.*)?'"; } $commands[] = "restorecon -RFv $install_dir"; // use pre-compiled template because we probably can't compile it. $template = file_get_contents(base_path('resources/views/errors/static/file_permissions.html')); $content = str_replace('!!!!CONTENT!!!!', '

' . implode('

', $commands) . '

', $template); $content = str_replace('!!!!LOG_FILE!!!!', $log_file, $content); return SymfonyResponse::create($content); } }