Files
librenms-librenms/LibreNMS/ComposerHelper.php
Tony Murray 1ad7f3138b Add Laravel to LibreNMS (#8318)
* Add Laravel to LibreNMS.

* Try to set permissions during initial install and first composer update to Laravel.

* Fix composer.lock
Fix missing db config keys

* Start building v1 layout
Port ajax_setresolution, inject csrf into jquery ajax calls
Layout works, building menu
Partially done.

* Fix device group list
remove stupid count relationships

* Print messages for common boot errors.
Don't log to laravel.log file.
Log to error_log until booted, then librenms.log

* Fix up some issues with Config loading
Start of custom directives

* Custom blade directives: config, notconfig, admin

* Preflight checks
Only load config files once.

* Update the composer.lock for php 5.6

* Menu through routing

* Start of alert menu

* Better alert scopes

* reduce cruft in models

* Alerting menu more or less working :D

* Fix style

* Improved preflight

* Fix chicken-eggs!

* Remove examples

* Better alert_rule status queries
Debugbar

* fix app.env check

* User Menu

* Settings bar (dropped refresh)
Search JS

* Toastr messages

* Rename preflight

* Use hasAccess(User) on most models.
Add port counts

* Missed a Preflight -> Checks rename

* Fix some formatting

* Boot Eloquent outside of Laravel
Use Eloquent for Config and Plugins so we don't have to connect with dbFacile inside Laravel.
Move locate_binary() into Config class

* Config WIP

* Try to fix a lot of config loading issues.

* Improve menu for non-admins removing unneeded menus
url() for all in menu

* Only use eloquent if it exists

* Include APP_URL in initial .env settings

* Implement Legacy User Provider

* Helper class for using Eloquent outside of Laravel.
Allows access to DB style queries too and checking the connection status.

* Fix up tests

* Fix device groups query

* Checking Travis

* copy config.test.php earlier

* dbFacile check config before connecting
Don't use exception to check if eloquent is connected, it gets grabbed by the exception handler.
Ignore missing config.php error.

* Fix config load with database is not migrated yet.

* Remove Config::load() from early boot.

* Use laravel config settings to init db (this prefers .env settings)
Fix bgp vars not set in menu
add _ide_helper.php to .gitignore

* Restrict dependencies to versions that support php 5.6

* Update ConfigTest

* Fix a couple of installation issues

* Add unique NODE_ID to .env

* Correct handling of title image

* Fix database config not loading. Thanks @laf

* Don't prepend /

* add class_exists checks for development service providers

* Fix config value casting

* Don't use functions that may not exist

* Update dbFacile.php

* d_echo may not be defined when Config used called.

* Add SELinux configuration steps
More detailed permissions check.
Check all and give complete corrective commands in one step.

* Ignore node_modules directory

* Re-add accidetal removal
2018-05-09 08:05:17 -05:00

164 lines
4.8 KiB
PHP

<?php
/**
* ComposerHelper.php
*
* Helper functions for composer
*
* 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.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* @package LibreNMS
* @link http://librenms.org
* @copyright 2016 Tony Murray
* @author Tony Murray <murraytony@gmail.com>
*/
namespace LibreNMS;
use Composer\Installer\PackageEvent;
use Composer\Script\Event;
class ComposerHelper
{
public static function postRootPackageInstall(Event $event)
{
if (!file_exists('.env')) {
self::setPermissions();
self::populateEnv();
}
}
public static function postInstall(Event $event)
{
if (!file_exists('.env')) {
self::setPermissions();
self::populateEnv();
}
}
public static function preUpdate(Event $event)
{
if (!getenv('FORCE')) {
echo "Running composer update is not advisable. Please run composer install to update instead.\n";
echo "If know what you are doing and want to write a new composer.lock file set FORCE=1.\n";
echo "If you don't know what to do, run: composer install\n";
exit(1);
}
}
public static function preInstall(Event $event)
{
$vendor_dir = $event->getComposer()->getConfig()->get('vendor-dir');
if (!is_file("$vendor_dir/autoload.php")) {
// checkout vendor from 1.36
$cmds = array(
"git checkout 609676a9f8d72da081c61f82967e1d16defc0c4e -- $vendor_dir",
"git reset HEAD $vendor_dir" // don't add vendor directory to the index
);
self::exec($cmds);
}
}
/**
* Initially populate .env file
*/
private static function populateEnv()
{
if (!file_exists('.env')) {
copy('.env.example', '.env');
self::exec('php artisan key:generate');
$config = [
'db_host' => '',
'db_port' => '',
'db_name' => '',
'db_user' => '',
'db_pass' => '',
'db_socket' => '',
'base_url' => '',
'user' => '',
'group' => '',
];
@include 'config.php';
self::setEnv([
'NODE_ID' => uniqid(),
'DB_HOST' => $config['db_host'],
'DB_PORT' => $config['db_port'],
'DB_USERNAME' => $config['db_user'],
'DB_PASSWORD' => $config['db_pass'],
'DB_DATABASE' => $config['db_name'],
'DB_SOCKET' => $config['db_socket'],
'APP_URL' => $config['base_url'],
'LIBRENMS_USER' => $config['user'],
'LIBRENMS_GROUP' => $config['group'],
]);
}
}
/**
* Set a setting in .env file
*
* @param array $settings KEY => value list of settings
* @param string $file
*/
private static function setEnv($settings, $file = '.env')
{
$content = file_get_contents($file);
if (substr($content, -1) !== "\n") {
$content .= PHP_EOL;
}
foreach ($settings as $key => $value) {
// only add non-empty settings
if (empty($value)) {
continue;
}
if (strpos($content, "$key=") !== false) {
// only replace ones that aren't already set for safety and uncomment
$content = preg_replace("/#?$key=\n/", "$key=$value\n", $content);
} else {
$content .= "$key=$value\n";
}
}
file_put_contents($file, $content);
}
private static function setPermissions()
{
$permissions_cmds = [
'setfacl -R -m g::rwx rrd/ logs/ storage/ bootstrap/cache/',
'setfacl -d -m g::rwx rrd/ logs/ storage/ bootstrap/cache/',
];
self::exec($permissions_cmds);
}
/**
* Run a command or array of commands and echo the command and output
*
* @param string|array $cmds
*/
private static function exec($cmds)
{
$cmd = "set -v\n" . implode(PHP_EOL, (array)$cmds);
passthru($cmd);
}
}