forked from librenms/librenms
-
Notifications
You must be signed in to change notification settings - Fork 0
/
daily.sh
executable file
·333 lines (297 loc) · 12.3 KB
/
daily.sh
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
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
#!/usr/bin/env bash
################################################################################
# Copyright (C) 2015 Daniel Preussker, QuxLabs UG <[email protected]>
# Copyright (C) 2016 Layne "Gorian" Breitkreutz <[email protected]>
# Copyright (C) 2017 Tony Murray <[email protected]>
# 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 --no-interaction"
# set log_file, using librenms 'log_dir' config setting, 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};
}
#######################################
# Check the PHP and Python version and branch and switch to the appropriate branch
# Returns:
# Exit-Code: 0 >= min ver, 1 < min ver
#######################################
check_dependencies() {
local branch=$(git rev-parse --abbrev-ref HEAD)
scripts/check_requirements.py > /dev/null 2>&1 || pip3 install -r requirements.txt > /dev/null 2>&1
local ver_56=$(php -r "echo (int)version_compare(PHP_VERSION, '5.6.4', '<');")
local ver_71=$(php -r "echo (int)version_compare(PHP_VERSION, '7.1.3', '<');")
local ver_72=$(php -r "echo (int)version_compare(PHP_VERSION, '7.2.5', '<');")
local python3=$(python3 -c "import sys;print(int(sys.version_info < (3, 5)))" 2> /dev/null)
local python_deps=$(scripts/check_requirements.py > /dev/null 2>&1; echo $?)
local phpver="master"
local pythonver="master"
local old_branches="php53 php56 php71-python2"
if [[ " $old_branches " =~ " $branch " ]] && [[ "$ver_72" == "0" && "$python3" == "0" && "$python_deps" == "0" ]]; then
status_run "Supported PHP and Python version, switched back to master branch." 'git checkout master'
elif [[ "$ver_56" != "0" ]]; then
phpver="php53"
if [[ "$branch" != "php53" ]]; then
status_run "Unsupported PHP version, switched to php53 branch." 'git checkout php53'
fi
elif [[ "$ver_71" != "0" ]]; then
phpver="php56"
if [[ "$branch" != "php56" ]]; then
status_run "Unsupported PHP version, switched to php56 branch." 'git checkout php56'
fi
elif [[ "$ver_72" != "0" || "$python3" != "0" || "$python_deps" != "0" ]]; then
local msg=""
if [[ "$ver_72" != "0" ]]; then
msg="Unsupported PHP version, $msg"
phpver="php71"
fi
if [[ "$python3" != "0" ]]; then
msg="python3 is not available, $msg"
pythonver="python3-missing"
elif [[ "$python_deps" != "0" ]]; then
msg="Python 3 dependencies missing, $msg"
pythonver="python3-deps"
fi
if [[ "$branch" != "php71-python2" ]]; then
status_run "${msg}switched to php71-python2 branch." 'git checkout php71-python2'
fi
fi
set_notifiable_result phpver ${phpver}
set_notifiable_result pythonver ${pythonver}
if [[ "$phpver" == "master" && "$pythonver" == "master" ]]; then
return 0;
fi
return 1;
}
#######################################
# Entry into program
# Globals:
# LIBRENMS_DIR
# Arguments:
#
# Returns:
# Exit-Code of Command
#######################################
main () {
local arg="$1";
local old_version="$2";
local new_version="$3";
local old_version="${old_version:=unset}" # if $1 is unset, make it mismatch for pre-update daily.sh
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
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
check_dependencies
php_ver_ret=$?
# make sure the vendor directory is clean
git checkout vendor/ --quiet > /dev/null 2>&1
update_res=0
if [[ "$up" == "1" ]] || [[ "$php_ver_ret" == "1" ]]; then
# Update current branch to latest
local branch=$(git rev-parse --abbrev-ref HEAD)
if [[ "$branch" == "HEAD" ]]; then
# if the branch is HEAD, then we are not on a branch, checkout master
git checkout master
fi
old_ver=$(git rev-parse --short HEAD)
status_run 'Updating to latest codebase' 'git pull --quiet' 'update'
update_res=$?
new_ver=$(git rev-parse --short HEAD)
else
# 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
# Call ourself again in case above pull changed or added something to daily.sh
${DAILY_SCRIPT} post-pull ${old_ver} ${new_ver}
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)
# re-check dependencies after pull with the new code
check_dependencies
# Check for missing vendor dir
if [ ! -f vendor/autoload.php ]; then
git checkout 609676a9f8d72da081c61f82967e1d16defc0c4e -- vendor/
git reset HEAD vendor/ # don't add vendor directory to the index
fi
status_run 'Updating Composer packages' "${COMPOSER} install --no-dev" 'update'
# Check if we need to revert (Must be in post pull so we can update it)
if [[ "$old_version" != "$new_version" ]]; then
check_dependencies # check php and python version and switch branches
# new_version may be incorrect if we just switch branches... ignoring that detail
status_run "Updated from $old_version to $new_version" ''
set_notifiable_result update 1 # only clear the error if update was a success
fi
# 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"
"refresh_os_cache"
"refresh_device_groups"
"recalculate_device_dependencies"
"syslog"
"eventlog"
"authlog"
"perf_times"
"callback"
"device_perf"
"purgeusers"
"bill_data"
"alert_log"
"rrd_purge"
"ports_fdb"
"route"
"ports_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[@]}";
;;
peeringdb)
local options=("peeringdb");
call_daily_php "${options[@]}";
;;
esac
fi
}
main "$@"