mirror of
https://github.com/librenms/librenms.git
synced 2024-09-21 10:28:13 +00:00
1cd4fcb8b1
* feature: issue warning notification if php version is less than 5.6.4 rename set_notification function in daily.sh to set_notifiable_result print output when a daily.sh process fails * further notifiable clarification * Update the notification message. * make sure to remove the notification when updates are disabled move the notification code into the php check
256 lines
8.9 KiB
Bash
Executable File
256 lines
8.9 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
################################################################################
|
|
# Copyright (C) 2015 Daniel Preussker, QuxLabs UG <preussker@quxlabs.com>
|
|
# Layne "Gorian" Breitkreutz <Layne.Breitkreutz@thelenon.com>
|
|
# 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/>.
|
|
################################################################################
|
|
|
|
#######################################
|
|
# CONSTANTS
|
|
#######################################
|
|
# define DAILY_SCRIPT as the full path to this script and LIBRENMS_DIR as the directory this script is in
|
|
DAILY_SCRIPT=$(readlink -f "$0")
|
|
LIBRENMS_DIR=$(dirname "$DAILY_SCRIPT")
|
|
COMPOSER="php ${LIBRENMS_DIR}/scripts/composer_wrapper.php"
|
|
|
|
# set log_file, using librenms $config['log_dir'], if set
|
|
# otherwise we default to <LibreNMS Install Directory>/logs
|
|
LOG_DIR=$(php -r "@include '${LIBRENMS_DIR}/config.php'; echo isset(\$config['log_dir']) ? \$config['log_dir'] : '${LIBRENMS_DIR}/logs';")
|
|
|
|
# get the librenms user
|
|
LIBRENMS_USER=$(php -r "@include '${LIBRENMS_DIR}/config.php'; echo isset(\$config['user']) ? \$config['user'] : 'root';")
|
|
LIBRENMS_USER_ID=$(id -u "$LIBRENMS_USER")
|
|
|
|
|
|
#######################################
|
|
# Fancy-Print and run commands
|
|
# Globals:
|
|
# LOG_DIR
|
|
# Arguments:
|
|
# Text
|
|
# Command
|
|
# Returns:
|
|
# Exit-Code of Command
|
|
#######################################
|
|
status_run() {
|
|
# Explicitly define our arguments
|
|
local args="$@";
|
|
local arg_text=$1;
|
|
local arg_command=$2;
|
|
local arg_option=$3;
|
|
local log_file;
|
|
local exit_code;
|
|
local tmp;
|
|
local log_file=${LOG_DIR}/daily.log;
|
|
|
|
# set log_file, using librenms $config['log_dir'], if set
|
|
# otherwise we default to ./logs/daily.log
|
|
|
|
printf "%-50s" "${arg_text}";
|
|
echo "${arg_text}" >> ${log_file}
|
|
tmp=$(bash -c "${arg_command}" 2>&1);
|
|
exit_code=$?
|
|
echo "${tmp}" >> ${log_file}
|
|
echo "Returned: ${exit_code}" >> ${log_file}
|
|
|
|
# print OK if the command ran successfully
|
|
# or FAIL otherwise (non-zero exit code)
|
|
if [[ "${exit_code}" == "0" ]]; then
|
|
printf " \033[0;32mOK\033[0m\n";
|
|
else
|
|
printf " \033[0;31mFAIL\033[0m\n";
|
|
if [[ "${arg_option}" == "update" ]]; then
|
|
php "${LIBRENMS_DIR}/daily.php" -f notify -o "${tmp}"
|
|
fi
|
|
if [[ ! -z "${tmp}" ]]; then
|
|
# print output in case of failure
|
|
echo "${tmp}"
|
|
fi
|
|
fi
|
|
return ${exit_code}
|
|
}
|
|
|
|
#######################################
|
|
# Call daily.php
|
|
# Globals:
|
|
# LIBRENMS_DIR
|
|
# Arguments:
|
|
# args:
|
|
# Array of arguments to pass to
|
|
# daily.php
|
|
# Returns:
|
|
# Exit-Code of Command
|
|
#######################################
|
|
call_daily_php() {
|
|
local args=( "$@" );
|
|
|
|
for arg in "${args[@]}"; do
|
|
php "${LIBRENMS_DIR}/daily.php" -f "${arg}";
|
|
done
|
|
}
|
|
|
|
#######################################
|
|
# Send result of a notifiable process to php code for processing
|
|
# Globals:
|
|
# LIBRENMS_DIR
|
|
# Arguments:
|
|
# args:
|
|
# Type: update
|
|
# Result: 1 for success, 0 for failure
|
|
# Returns:
|
|
# Exit-Code of Command
|
|
#######################################
|
|
set_notifiable_result() {
|
|
local args="$@";
|
|
local arg_type=$1;
|
|
local arg_result=$2;
|
|
|
|
php "${LIBRENMS_DIR}/daily.php" -f handle_notifiable -t ${arg_type} -r ${arg_result};
|
|
}
|
|
|
|
#######################################
|
|
# Entry into program
|
|
# Globals:
|
|
# LIBRENMS_DIR
|
|
# Arguments:
|
|
#
|
|
# Returns:
|
|
# Exit-Code of Command
|
|
#######################################
|
|
main () {
|
|
local arg="$1";
|
|
cd ${LIBRENMS_DIR};
|
|
|
|
# if not running as $LIBRENMS_USER (unless $LIBRENMS_USER = root), relaunch
|
|
if [[ "$LIBRENMS_USER" != "root" ]]; then
|
|
# only try to su if we are root (or sudo)
|
|
if [[ "$EUID" -eq 0 ]]; then
|
|
echo "Re-running ${DAILY_SCRIPT} as ${LIBRENMS_USER} user"
|
|
sudo -u "$LIBRENMS_USER" "$DAILY_SCRIPT" "$@"
|
|
exit;
|
|
fi
|
|
|
|
if [[ "$EUID" -ne "$LIBRENMS_USER_ID" ]]; then
|
|
printf "\033[0;93mWARNING\033[0m: You should run this script as ${LIBRENMS_USER}\n";
|
|
fi
|
|
fi
|
|
|
|
# make sure autoload.php exists before trying to run any php that may require it
|
|
if [ ! -f "${LIBRENMS_DIR}/vendor/autoload.php" ]; then
|
|
${COMPOSER} install --no-dev
|
|
fi
|
|
|
|
if [[ -z "$arg" ]]; then
|
|
status_run 'Checking PHP version' "php ${LIBRENMS_DIR}/daily.php -f check_php_ver" 'check_php_ver'
|
|
|
|
up=$(php daily.php -f update >&2; echo $?)
|
|
if [[ "$up" == "0" ]]; then
|
|
${DAILY_SCRIPT} no-code-update
|
|
set_notifiable_result update 1 # make sure there are no update notifications if update is disabled
|
|
exit
|
|
fi
|
|
|
|
# make sure the vendor directory is clean
|
|
git checkout vendor/ --quiet > /dev/null 2>&1
|
|
|
|
update_res=0
|
|
if [[ "$up" == "1" ]]; then
|
|
# Update to Master-Branch
|
|
old_ver=$(git show --pretty="%H" -s HEAD)
|
|
status_run 'Updating to latest codebase' 'git pull --quiet' 'update'
|
|
update_res=$?
|
|
new_ver=$(git show --pretty="%H" -s HEAD)
|
|
elif [[ "$up" == "3" ]]; then
|
|
# Update to last Tag
|
|
old_ver=$(git describe --exact-match --tags $(git log -n1 --pretty='%h'))
|
|
status_run 'Updating to latest release' 'git fetch --tags && git checkout $(git describe --tags $(git rev-list --tags --max-count=1))' 'update'
|
|
update_res=$?
|
|
new_ver=$(git describe --exact-match --tags $(git log -n1 --pretty='%h'))
|
|
fi
|
|
|
|
if (( $update_res > 0 )); then
|
|
set_notifiable_result update 0
|
|
fi
|
|
|
|
if [[ "$old_ver" != "$new_ver" ]]; then
|
|
# status_run 'Updating Composer packages' "${COMPOSER} install --no-dev" 'update'
|
|
|
|
# Run post update checks
|
|
if [ ! -f "${LIBRENMS_DIR}/vendor/autoload.php" ]; then
|
|
status_run "Reverting update, check the output of composer diagnose" "git checkout $old_ver" 'update'
|
|
set_notifiable_result update 0
|
|
else
|
|
status_run "Updated from $old_ver to $new_ver" ''
|
|
set_notifiable_result update 1 # only clear the error if update was a success
|
|
fi
|
|
fi
|
|
|
|
cnf=$(echo $(grep '\[.distributed_poller.\]' config.php | egrep -v -e '^//' -e '^#' | cut -d = -f 2 | sed 's/;//g'))
|
|
if ((${BASH_VERSINFO[0]} < 4)); then
|
|
cnf=`echo $cnf|tr [:upper:] [:lower:]`
|
|
else
|
|
cnf=${cnf,,}
|
|
fi
|
|
|
|
if [[ -z "$cnf" ]] || [[ "$cnf" == "0" ]] || [[ "$cnf" == "false" ]]; then
|
|
# Call ourself again in case above pull changed or added something to daily.sh
|
|
${DAILY_SCRIPT} post-pull
|
|
fi
|
|
else
|
|
case $arg in
|
|
no-code-update)
|
|
# Updates of the code are disabled, just check for schema updates
|
|
# and clean up the db.
|
|
status_run 'Updating SQL-Schema' 'php includes/sql-schema/update.php'
|
|
status_run 'Cleaning up DB' "$DAILY_SCRIPT cleanup"
|
|
;;
|
|
post-pull)
|
|
# List all tasks to do after pull in the order of execution
|
|
status_run 'Updating SQL-Schema' 'php includes/sql-schema/update.php'
|
|
status_run 'Updating submodules' "$DAILY_SCRIPT submodules"
|
|
status_run 'Cleaning up DB' "$DAILY_SCRIPT cleanup"
|
|
status_run 'Fetching notifications' "$DAILY_SCRIPT notifications"
|
|
status_run 'Caching PeeringDB data' "$DAILY_SCRIPT peeringdb"
|
|
;;
|
|
cleanup)
|
|
# Cleanups
|
|
local options=("refresh_alert_rules"
|
|
"syslog"
|
|
"eventlog"
|
|
"authlog"
|
|
"perf_times"
|
|
"callback"
|
|
"device_perf"
|
|
"purgeusers"
|
|
"bill_data"
|
|
"alert_log"
|
|
"rrd_purge");
|
|
call_daily_php "${options[@]}";
|
|
;;
|
|
submodules)
|
|
# Init+Update our submodules
|
|
git submodule --quiet init
|
|
git submodule --quiet update
|
|
;;
|
|
notifications)
|
|
# Get notifications
|
|
local options=("notifications");
|
|
call_daily_php "${options[@]}";
|
|
;;
|
|
esac
|
|
fi
|
|
}
|
|
|
|
main "$@"
|