1985 lines
50 KiB
Bash
Executable File
1985 lines
50 KiB
Bash
Executable File
#!/bin/bash
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
#
|
|
|
|
#
|
|
# Plesk script
|
|
#
|
|
|
|
|
|
|
|
#default values
|
|
|
|
product_default_conf()
|
|
{
|
|
|
|
PRODUCT_ROOT_D=/opt/psa
|
|
PRODUCT_RC_D=/etc/init.d
|
|
PRODUCT_ETC_D=/opt/psa/etc
|
|
PLESK_LIBEXEC_DIR=/usr/lib/plesk-9.0
|
|
HTTPD_VHOSTS_D=/var/www/vhosts
|
|
HTTPD_CONF_D=/etc/apache2
|
|
HTTPD_INCLUDE_D=/etc/apache2/conf-enabled
|
|
HTTPD_BIN=/usr/sbin/apache2
|
|
HTTPD_LOG_D=/var/log/apache2
|
|
HTTPD_SERVICE=apache2
|
|
QMAIL_ROOT_D=/var/qmail
|
|
PLESK_MAILNAMES_D=/var/qmail/mailnames
|
|
RBLSMTPD=/usr/sbin/rblsmtpd
|
|
NAMED_RUN_ROOT_D=/var/named/run-root
|
|
WEB_STAT=/usr/bin/webalizer
|
|
MYSQL_VAR_D=/var/lib/mysql
|
|
MYSQL_BIN_D=/usr/bin
|
|
MYSQL_SOCKET=/var/run/mysqld/mysqld.sock
|
|
PGSQL_DATA_D=/var/lib/postgresql/16/main
|
|
PGSQL_CONF_D=/etc/postgresql/16/main
|
|
PGSQL_BIN_D=/usr/lib/postgresql/16/bin
|
|
DUMP_D=/var/lib/psa/dumps
|
|
DUMP_TMP_D=/tmp
|
|
MAILMAN_ROOT_D=/usr/lib/mailman
|
|
MAILMAN_VAR_D=/var/lib/mailman
|
|
PYTHON_BIN=/usr/bin/python2
|
|
GPG_BIN=/usr/bin/gpg
|
|
TAR_BIN=/usr/lib/plesk-9.0/sw-tar
|
|
AWSTATS_ETC_D=/etc/awstats
|
|
AWSTATS_BIN_D=/usr/lib/cgi-bin
|
|
AWSTATS_TOOLS_D=/usr/share/awstats/tools
|
|
AWSTATS_DOC_D=/usr/share/awstats
|
|
OPENSSL_BIN=/usr/bin/openssl
|
|
LIB_SSL_PATH=/lib/libssl.so
|
|
LIB_CRYPTO_PATH=/lib/libcrypto.so
|
|
CLIENT_PHP_BIN=/opt/psa/bin/php-cli
|
|
SNI_SUPPORT=true
|
|
APS_DB_DRIVER_LIBRARY=/usr/lib/x86_64-linux-gnu/sw/libmysqlserver.so.2.0
|
|
SA_MAX_MAIL_SIZE=256000
|
|
|
|
}
|
|
|
|
db_backup_aux()
|
|
{
|
|
local inten="$1"
|
|
local dfile="$2"
|
|
shift 2
|
|
|
|
local dump_dir="`dirname "$dfile"`"
|
|
|
|
echo_try "$inten"
|
|
|
|
mkdir -p -m 750 "$dump_dir"
|
|
|
|
(
|
|
umask 077 && touch "$dfile"
|
|
) || die "$inten ('umask 077; touch $dfile' failed with $?)"
|
|
|
|
if [ -z "${PLESK_ALLOW_INSECURE_DUMPS:-}" ]; then
|
|
|
|
local perms="`stat -c %a "$dfile"`"
|
|
if [ "$perms" != '600' ]; then
|
|
# try to perform chmod
|
|
chmod 0600 "$dfile"
|
|
perms="`stat -c %a "$dfile"`"
|
|
if [ "$perms" != '600' ]; then
|
|
# let's check permissions on $dump_dir
|
|
local dir_perms="`stat -c %a "$dump_dir"`"
|
|
if ! expr match "$dir_perms" '.*0$' >/dev/null; then
|
|
rm -f "$dfile"
|
|
die "$inten: '$dfile' is created with insecure permissions '$perms' (expected '600'), " \
|
|
"dumps directory '$dump_dir' has world-readable permissions '$dir_perms'. " \
|
|
"Try to fix permissions on '$dump_dir' or/and fix mount options for '$dump_dir'. " \
|
|
"(Or set environment variable PLESK_ALLOW_INSECURE_DUMPS=1)"
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
fi
|
|
|
|
local compress='cat -'
|
|
! expr match "$dfile" '.*.gz$' > /dev/null || compress='gzip -9'
|
|
|
|
mysqldump_stderr=$(mktemp)
|
|
(
|
|
set -o pipefail
|
|
dump_db "$@" 2>"$mysqldump_stderr" | $compress > "$dfile"
|
|
) || {
|
|
# Save stderr to product logs
|
|
cat "$mysqldump_stderr" >> "$product_problems_log"
|
|
cat "$mysqldump_stderr" >> "$product_log"
|
|
# Write output to stderr
|
|
cat "$mysqldump_stderr" >&2
|
|
rm -f "$dfile" "$mysqldump_stderr"
|
|
die "$inten"
|
|
}
|
|
|
|
cat "$mysqldump_stderr" >&2
|
|
rm -f "$mysqldump_stderr"
|
|
|
|
suc
|
|
}
|
|
|
|
# db_test test_query awk_script
|
|
# Runs test_query and processes it with awk_script. If the output is
|
|
# not empty, return 0, otherwise return 1. Hint: supply '1' for
|
|
# awk_script to test just for the presence of any output.
|
|
db_test()
|
|
{
|
|
local any_db=
|
|
eval `sh_get_args '--any-db) any_db=yes;;'`
|
|
|
|
local test_query="$1"
|
|
local awk_script="$2"
|
|
local output
|
|
|
|
if [ -n "$any_db" ]; then
|
|
output="`mysql_raw_anydb -e \"$test_query\" 2>>\"$product_log\"`"
|
|
else
|
|
output="`mysql_raw -e \"$test_query\" 2>>\"$product_log\"`"
|
|
fi
|
|
local status=$?
|
|
if [ "$status" -ne 0 ]; then
|
|
p_echo "$output"
|
|
die "run the following SQL query: $1"
|
|
fi
|
|
|
|
echo -n "$output" | awk -F '\t' -- "$awk_script" | test `wc -l` -ne 0
|
|
}
|
|
|
|
# db_select <query>
|
|
# runs <query> via mysql_raw
|
|
# writes output to db_select_output
|
|
# if query fails, output errors and return 1
|
|
db_select()
|
|
{
|
|
local desc="execute SQL query"
|
|
local query="$1"
|
|
|
|
local output
|
|
output="`mysql_raw -e \"$query\" 2>>\"$product_log\"`"
|
|
local status="$?"
|
|
if [ "$status" -ne "0" ]; then
|
|
p_echo "$output"
|
|
die "run the following SQL query: $query"
|
|
fi
|
|
|
|
db_select_output="$output"
|
|
return 0
|
|
}
|
|
|
|
# db_test_database database
|
|
# Returns 0 if the database exists
|
|
db_test_database()
|
|
{
|
|
local database="$1"
|
|
|
|
local mysql_db_name="mysql"
|
|
db_test "SHOW DATABASES" "\$1 == \"$database\""
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
# vim:ft=sh:
|
|
|
|
db_read_misc_attr()
|
|
{
|
|
db_select "SELECT val FROM misc WHERE param = '$1'"
|
|
echo "$db_select_output"
|
|
}
|
|
|
|
is_remote_db_feature_enabled()
|
|
{
|
|
[ -s "/etc/psa/private/dsn.ini" ]
|
|
}
|
|
|
|
get_dsn()
|
|
{
|
|
local section="$1"
|
|
local param="$2"
|
|
! is_remote_db_feature_enabled || get_ini_conf_var "/etc/psa/private/dsn.ini" "$section" "$param"
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
# vim:ft=sh
|
|
# Usage: pleskrc <service> <action>
|
|
pleskrc()
|
|
{
|
|
[ 2 -le $# ] || die "Not enough arguments"
|
|
|
|
local service_name=${1//[-.@]/_}
|
|
local action=$2
|
|
local ret=0
|
|
local inten
|
|
shift
|
|
shift
|
|
|
|
# Now check redefined functions
|
|
if test "$machine" = "linux" && is_function "${service_name}_${action}_${machine}_${linux_distr}"; then
|
|
"${service_name}_${action}_${machine}_${linux_distr}" "$@"
|
|
return $?
|
|
elif is_function "${service_name}_${action}_${machine}"; then
|
|
"${service_name}_${action}_${machine}" "$@"
|
|
return $?
|
|
elif is_function "${service_name}_${action}"; then
|
|
"${service_name}_${action}" "$@"
|
|
return $?
|
|
fi
|
|
|
|
# Not redefined - call default action
|
|
eval "service=\$${service_name}_service"
|
|
[ -n "$service" ] || die "$action $service_name service (Empty service name for '$service_name')"
|
|
|
|
if [ "$action" = "name" ]; then
|
|
echo "${service}.service"
|
|
return 0
|
|
fi
|
|
|
|
inten="$action service $service"
|
|
pleskrc_is_failure_for_action_ok "$action" || echo_try "$inten"
|
|
|
|
if [ -x "/bin/systemctl" -a "$do_upgrade" = "1" -a ! -f "/var/lock/parallels-panel-bootstrapper-running.lock" -a -z "$SYSTEMD_DAEMON_RELOADED" ]; then
|
|
# reload systemd units if requested from an upgrade package script - in case a unit was changed
|
|
/bin/systemctl daemon-reload
|
|
SYSTEMD_DAEMON_RELOADED="yes"
|
|
fi
|
|
|
|
service_ctl "$action" "$service" "$service_name"
|
|
ret="$?"
|
|
|
|
pleskrc_is_failure_for_action_ok "$action" || {
|
|
if [ "$ret" -eq 0 ]; then
|
|
suc
|
|
else
|
|
if [ -x "/bin/systemctl" ]; then
|
|
p_echo "`/bin/systemctl -l status \"${service}.service\" | awk 'BEGIN {s=0} s==1 {s=2} /^$/ {s=1} s==2 {print}'`"
|
|
fi
|
|
warn "$inten failed"
|
|
fi
|
|
}
|
|
|
|
return $ret
|
|
}
|
|
|
|
pleskrc_is_failure_for_action_ok()
|
|
{
|
|
local action="$1"
|
|
case "$action" in
|
|
status|exists|is-active|is-enabled|is-failed) return 0 ;;
|
|
esac
|
|
return 1
|
|
}
|
|
|
|
# NOTE:
|
|
# Function service_ctl is just helper for pleskrc().
|
|
# Do not call it directly, use pleskrc()!!!
|
|
service_ctl()
|
|
{
|
|
local action=$1
|
|
local service=$2
|
|
local service_name=$3
|
|
|
|
if [ "$action" != "exists" ]; then
|
|
_service_exec $service exists
|
|
if [ "$?" != "0" ]; then
|
|
p_echo "attempt to ${inten} - service doesn't exist (missing unit file or not executable control script)"
|
|
return 1
|
|
fi
|
|
fi
|
|
|
|
case "$action" in
|
|
start)
|
|
pleskrc "$service_name" status || _service_exec "$service" "$action"
|
|
;;
|
|
stop)
|
|
! pleskrc "$service_name" status || _service_exec "$service" "$action"
|
|
;;
|
|
restart)
|
|
if pleskrc "$service_name" status; then
|
|
_service_exec "$service" "$action"
|
|
else
|
|
_service_exec "$service" start
|
|
fi
|
|
;;
|
|
reload)
|
|
! pleskrc "$service_name" status || _service_exec "$service" "$action"
|
|
;;
|
|
status)
|
|
_service_exec "$service" status
|
|
;;
|
|
try-restart)
|
|
if [ -x "/bin/systemctl" ]; then
|
|
_service_exec "$service" "$action"
|
|
else
|
|
! pleskrc "$service_name" status || _service_exec "$service" "restart"
|
|
fi
|
|
;;
|
|
try-reload)
|
|
! pleskrc "$service_name" status || _service_exec "$service" "reload"
|
|
;;
|
|
reload-or-restart)
|
|
if [ -x "/bin/systemctl" ]; then
|
|
_service_exec "$service" "$action"
|
|
elif pleskrc "$service_name" status; then
|
|
_service_exec "$service" "reload"
|
|
else
|
|
_service_exec "$service" "start"
|
|
fi
|
|
;;
|
|
*)
|
|
_service_exec "$service" "$action"
|
|
;;
|
|
esac >> "$product_log"
|
|
}
|
|
|
|
_service_exec()
|
|
{
|
|
# Keep in sync with pylibplesk/plesk_service.py
|
|
local service=$1
|
|
local action=$2
|
|
|
|
local action_cmd
|
|
local sysvinit_service="/etc/init.d/$service"
|
|
|
|
if [ -x "/bin/systemctl" ]; then
|
|
case "${action}" in
|
|
exists)
|
|
if /bin/systemctl cat "$service.service" >/dev/null 2>&1; then
|
|
return 0 # systemd unit
|
|
elif [ -f "/lib/systemd/system/$service.service" ]; then
|
|
/bin/systemctl daemon-reload
|
|
return 0 # systemd unit which exists but was changed and has not been reloaded before
|
|
elif [ -x "$sysvinit_service" ]; then
|
|
return 0 # sysvinit compat
|
|
fi
|
|
return 1 # not found
|
|
;;
|
|
status)
|
|
action="is-active"
|
|
;;
|
|
reload|graceful)
|
|
action='reload-or-try-restart'
|
|
;;
|
|
esac
|
|
/bin/systemctl "$action" "${service}.service"
|
|
else
|
|
warn "Cannot $action $service on this system: no executable /bin/systemctl"
|
|
return 1
|
|
fi
|
|
}
|
|
|
|
is_function()
|
|
{
|
|
local type_output=$(type -t "$1")
|
|
test "X${type_output}" = "Xfunction"
|
|
}
|
|
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
|
|
# echo message to product log and console (always visible)
|
|
pp_echo()
|
|
{
|
|
if [ -n "$product_log" ] ; then
|
|
echo "$@" >> "$product_log" 2>&1
|
|
fi
|
|
echo "$@" >&2
|
|
}
|
|
|
|
# echo message to product log, also to console in debug mode
|
|
p_echo()
|
|
{
|
|
if [ -n "$product_log" ] ; then
|
|
echo "$@" >> "$product_log" 2>&1
|
|
fi
|
|
if [ -n "$PLESK_INSTALLER_DEBUG" -o -n "$PLESK_INSTALLER_VERBOSE" -o -z "$product_log" ] ; then
|
|
echo "$@" >&2
|
|
fi
|
|
}
|
|
|
|
# same as p_echo, but without new line
|
|
pnnl_echo()
|
|
{
|
|
p_echo -n "$@"
|
|
}
|
|
|
|
int_err()
|
|
{
|
|
report_problem "internal" "Internal error: $@"
|
|
exit 1
|
|
}
|
|
|
|
p_see_product_log()
|
|
{
|
|
log_is_in_dev "${product_log}" || printf " (see log file: ${product_log})" >&2
|
|
}
|
|
|
|
die()
|
|
{
|
|
report_problem "fatal" "ERROR while trying to $@"
|
|
printf "Check the error reason" >&2
|
|
p_see_product_log
|
|
echo ", fix and try again" >&2
|
|
|
|
selinux_close
|
|
|
|
exit 1
|
|
}
|
|
|
|
warn()
|
|
{
|
|
local inten="$1"
|
|
|
|
if [ -n "$PLESK_INSTALLER_DEBUG" -o -n "$PLESK_INSTALLER_VERBOSE" ]; then
|
|
p_echo
|
|
p_echo "WARNING!"
|
|
pnnl_echo "Some problems are found during $inten"
|
|
p_see_product_log
|
|
p_echo
|
|
p_echo "Continue..."
|
|
p_echo
|
|
fi
|
|
|
|
report_problem "warning" "Warning: $inten"
|
|
}
|
|
|
|
echo_try()
|
|
{
|
|
msg="$*"
|
|
pnnl_echo " Trying to $msg... "
|
|
}
|
|
|
|
suc()
|
|
{
|
|
p_echo "done"
|
|
}
|
|
|
|
write_structured_report()
|
|
{
|
|
# Write json error report into file $PLESK_INSTALLER_ERROR_REPORT if specified.
|
|
# @params are tags in format "key=value"
|
|
# Report body (human readable information) is read from stdin.
|
|
local report_file="$PLESK_INSTALLER_ERROR_REPORT"
|
|
|
|
[ -n "$report_file" ] || return 0
|
|
|
|
local python_bin=
|
|
for bin in "/opt/psa/bin/python" "/usr/local/psa/bin/python" "/usr/bin/python2" "/usr/libexec/platform-python" "/usr/bin/python3"; do
|
|
if [ -x "$bin" ]; then
|
|
python_bin="$bin"
|
|
break
|
|
fi
|
|
done
|
|
|
|
if [ ! -x "$python_bin" ]; then
|
|
p_echo "Cannot write structured error report: python interpreter not found."
|
|
return 1
|
|
fi
|
|
|
|
"$python_bin" -c 'import sys, json
|
|
report_file = sys.argv[1]
|
|
error = sys.stdin.read()
|
|
|
|
data = {
|
|
"error": error,
|
|
}
|
|
|
|
for tag in sys.argv[2:]:
|
|
k, v = tag.split("=", 1)
|
|
data[k] = v
|
|
|
|
with open(report_file, "a") as f:
|
|
json.dump(data, f)
|
|
f.write("\n")
|
|
' "$report_file" "date=$(date --utc --iso-8601=ns)" "$@"
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
reexec_with_clean_env()
|
|
{
|
|
# Usage: call this function as 'reexec_with_clean_env "$@"' at the start of a script.
|
|
# Don't use with scripts that require sensitive environment variables.
|
|
# Don't put the call under any input/output redirection.
|
|
# Purpose: make sure the script is executed with a sane environment.
|
|
|
|
local lc="`get_default_locale`"
|
|
export LANG="$lc" LC_MESSAGES="$lc" LC_ALL="$lc"
|
|
export PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin
|
|
umask 022
|
|
|
|
PLESK_SCRIPT_COMMAND_LINE="$0 $*"
|
|
[ -z "$PLESK_INSTALLER_ENV_CLEANED" ] || { unset PLESK_INSTALLER_ENV_CLEANED; return 0; }
|
|
[ -n "$BASH" ] || exec /bin/bash "$0" "$@"
|
|
|
|
# N.B.: the following code requires Bash. On Dash it would cause syntax error upon parse w/o eval.
|
|
eval '
|
|
local extra_vars=() # list of variables to preserve
|
|
for var in "${!PLESK_@}"; do # enumerate all PLESK_* variables
|
|
extra_vars+=("$var=${!var}")
|
|
done
|
|
extra_vars+=("PLESK_INSTALLER_ENV_CLEANED=1")
|
|
|
|
# Exec self with clean env except for extra_vars, shell opts, and arguments.
|
|
exec /usr/bin/env -i "${extra_vars[@]}" /bin/bash ${-:+-$-} "$0" "$@" || {
|
|
echo "Failed to reexec self ($0) with clean environment" >&2
|
|
exit 91 # Just some relatively unique error code
|
|
}
|
|
'
|
|
}
|
|
|
|
get_default_locale()
|
|
{
|
|
# Note that CentOS 7 typically doesn't have C.UTF-8
|
|
for lc in "C.UTF-8" "en_US.UTF-8" "C"; do
|
|
if [ -z "`LC_ALL=$lc locale 2>&1 >/dev/null`" ]; then
|
|
echo "$lc"
|
|
return 0
|
|
fi
|
|
done
|
|
echo "C"
|
|
}
|
|
|
|
# accumulates chown and chmod
|
|
set_ac()
|
|
{
|
|
local u_owner g_owner perms node
|
|
u_owner="$1"
|
|
g_owner="$2"
|
|
perms="$3"
|
|
node="$4"
|
|
|
|
# A very small optimization - replacing of two execs by one,
|
|
# it works only if the following conditions are observed:
|
|
# - u_owner is username (not UID);
|
|
# - g_owner is group (not GID);
|
|
# - perms is in octal mode.
|
|
# If some conditions aren't observed,
|
|
# optimization doesn't work,
|
|
# but it doesn't break function
|
|
[ "$(stat -c '%U:%G 0%a' $node)" != "$u_owner:$g_owner $perms" ] || return 0
|
|
chown $u_owner:$g_owner $node || die "chown $u_owner:$g_owner $node"
|
|
chmod $perms $node || die "chmod $perms $node"
|
|
}
|
|
|
|
detect_vz()
|
|
{
|
|
[ -z "$PLESK_VZ_RESULT" ] || return $PLESK_VZ_RESULT
|
|
|
|
PLESK_VZ_RESULT=1
|
|
PLESK_VZ=0
|
|
PLESK_VE_HW_NODE=0
|
|
PLESK_VZ_TYPE=
|
|
|
|
local issue_file="/etc/issue"
|
|
local vzcheck_file="/proc/self/status"
|
|
[ -f "$vzcheck_file" ] || return 1
|
|
|
|
local env_id=`sed -ne 's|^envID\:[[:space:]]*\([[:digit:]]\+\)$|\1|p' "$vzcheck_file"`
|
|
[ -n "$env_id" ] || return 1
|
|
if [ "$env_id" = "0" ]; then
|
|
# Either VZ/OpenVZ HW node or unjailed CloudLinux
|
|
PLESK_VE_HW_NODE=1
|
|
return 1
|
|
fi
|
|
|
|
if grep -q "CloudLinux" "$issue_file" >/dev/null 2>&1 ; then
|
|
return 1
|
|
fi
|
|
|
|
if [ -f "/proc/vz/veredir" ]; then
|
|
PLESK_VZ_TYPE="vz"
|
|
elif [ -d "/proc/vz" ]; then
|
|
PLESK_VZ_TYPE="openvz"
|
|
fi
|
|
|
|
PLESK_VZ=1
|
|
PLESK_VZ_RESULT=0
|
|
return 0
|
|
}
|
|
|
|
# detects lxc and docker containers
|
|
detect_lxc()
|
|
{
|
|
[ -z "$PLESK_LXC_RESULT" ] || return $PLESK_LXC_RESULT
|
|
PLESK_LXC_RESULT=1
|
|
PLESK_LXC=0
|
|
if { [ -f /proc/1/cgroup ] && grep -q 'docker\|lxc' /proc/1/cgroup; } || \
|
|
{ [ -f /proc/1/environ ] && cat /proc/1/environ | tr \\0 \\n | grep -q "container=lxc"; };
|
|
then
|
|
PLESK_LXC_RESULT=0
|
|
PLESK_LXC=1
|
|
fi
|
|
return "$PLESK_LXC_RESULT"
|
|
}
|
|
|
|
call_optional_function()
|
|
{
|
|
local type_output="`LC_ALL=C type \"$1\" 2>/dev/null | head -n 1`"
|
|
case "$type_output" in
|
|
*function)
|
|
"$@"
|
|
;;
|
|
*)
|
|
return 0
|
|
;;
|
|
esac
|
|
}
|
|
|
|
sh_get_args()
|
|
{
|
|
echo 'while true; do case "$1" in '"$1"'*) break;; esac; shift; done'
|
|
}
|
|
|
|
get_random_string()
|
|
{
|
|
local str_length="$1"
|
|
local str_symbols="$2"
|
|
if [ -x "$PRODUCT_ROOT_D/admin/sbin/random_str" -a -z "$str_symbols" ]; then
|
|
"$PRODUCT_ROOT_D/admin/sbin/random_str" "$str_length"
|
|
else
|
|
# random_str utility may be unavailable in pre phase
|
|
if [ -z "$str_length" ]; then
|
|
str_length="14"
|
|
fi
|
|
if [ -z "$str_symbols" ]; then
|
|
str_symbols="A-Za-z0-9_"
|
|
fi
|
|
|
|
< /dev/urandom tr -dc "$str_symbols" 2>/dev/null | head -c "$str_length" 2>/dev/null
|
|
fi
|
|
}
|
|
|
|
sequence()
|
|
{
|
|
if type seq >/dev/null 2>&1; then
|
|
seq $*
|
|
elif type jot >/dev/null 2>&1; then
|
|
jot $*
|
|
else
|
|
die "Unable to find seq or jot command"
|
|
fi
|
|
}
|
|
|
|
get_ini_conf_var()
|
|
{
|
|
local conf="$1"
|
|
local section="$2"
|
|
local param="$3"
|
|
|
|
[ -n "$conf" -a -n "$param" ] || die "get_ini_conf_var(): required parameters missing"
|
|
|
|
local section_empty=0
|
|
[ -n "$section" ] || section_empty=1
|
|
|
|
perl -n -e 'BEGIN { $insect='$section_empty' }
|
|
next if (/^\s*;/);
|
|
$insect=0 if (/^\s*\[.*\]/);
|
|
$insect=1 if (/^\s*\['$section'\]/);
|
|
$val = $2, $val =~ s/\s+$//, print $val . "\n"
|
|
if ($insect && /^\s*('$param')\s*=\s*([^;\n]*)(;.*)?$/);' $conf | head -n 1
|
|
}
|
|
|
|
sw_engine_pleskrun()
|
|
{
|
|
if [ -x $PRODUCT_ROOT_D/bin/sw-engine-pleskrun ]; then
|
|
$PRODUCT_ROOT_D/bin/sw-engine-pleskrun "$@"
|
|
elif [ -x "/usr/bin/sw-engine" ]; then
|
|
local args
|
|
if [ -e "$PRODUCT_ROOT_D/admin/conf/php.ini" ]; then
|
|
args="-c $PRODUCT_ROOT_D/admin/conf/php.ini"
|
|
else
|
|
args="-d psasem.semfile=\"$PRODUCT_ROOT_D/var/psasem.sem\""
|
|
fi
|
|
/usr/bin/sw-engine $args "$@"
|
|
else
|
|
echo "No Plesk PHP interpreter found"
|
|
return 1
|
|
fi
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
#-*- vim:syntax=sh
|
|
|
|
product_log_name_ex()
|
|
{
|
|
local aux_descr="$1"
|
|
local action="${CUSTOM_LOG_ACTION_NAME-installation}"
|
|
|
|
if [ -n "$aux_descr" ]; then
|
|
aux_descr="_${aux_descr}"
|
|
fi
|
|
|
|
if [ -n "$CUSTOM_LOG_NAME" ]; then
|
|
echo "${CUSTOM_LOG_NAME}${action:+_$action}${aux_descr}.log"
|
|
else
|
|
get_product_versions
|
|
echo "plesk_${product_this_version}${action:+_$action}${aux_descr}.log"
|
|
fi
|
|
}
|
|
|
|
product_log_name()
|
|
{
|
|
product_log_name_ex
|
|
}
|
|
|
|
product_problems_log_name()
|
|
{
|
|
product_log_name_ex "problems"
|
|
}
|
|
|
|
problems_log_tail()
|
|
{
|
|
[ -f "$product_problems_log" ] || return 0
|
|
{
|
|
tac "$product_problems_log" | awk '/^START/ { exit } { print }' | tac
|
|
} 2>/dev/null
|
|
}
|
|
|
|
product_log_tail()
|
|
{
|
|
[ -f "$product_log" ] || return 0
|
|
{
|
|
tac "$product_log" | awk '/^START/ { exit } { print }' | tac
|
|
} 2>/dev/null
|
|
}
|
|
|
|
product_and_problems_log_tail()
|
|
{
|
|
product_log_tail
|
|
[ "$product_log" = "$product_problems_log" ] || problems_log_tail
|
|
}
|
|
|
|
cleanup_problems_log()
|
|
{
|
|
[ -f "$product_problems_log" ] || return 0
|
|
touch "$product_problems_log.tmp"
|
|
chmod 0600 "$product_problems_log.tmp"
|
|
awk 'BEGIN { st = "" }
|
|
/^START/ && (st ~ /^START/) { print st; }
|
|
/^START/ { st=$0; next }
|
|
/^STOP/ && (st ~ /^START/) { st=""; next }
|
|
(st != "") { print st; st="" }
|
|
{ print }
|
|
' "$product_problems_log" > "$product_problems_log.tmp" && \
|
|
mv -f "$product_problems_log.tmp" "$product_problems_log" || \
|
|
rm -f "$product_problems_log.tmp"
|
|
|
|
if [ ! -s "$product_problems_log" ]; then
|
|
rm -f "$product_problems_log"
|
|
fi
|
|
}
|
|
|
|
mktemp_log()
|
|
{
|
|
local logname="$1"
|
|
local dir="$2"
|
|
|
|
if [ "${logname:0:1}" != "/" ]; then
|
|
logname="$dir/$logname"
|
|
fi
|
|
dir="`dirname $logname`"
|
|
if [ ! -d "$dir" ]; then
|
|
mkdir -p "$dir" || { echo "Unable to create log directory : $dir"; exit 1; }
|
|
if [ "$EUID" -eq "0" ]; then
|
|
set_ac root root 0700 "$dir"
|
|
fi
|
|
fi
|
|
|
|
if [ "${logname%XXX}" != "$logname" ]; then
|
|
mktemp "$logname"
|
|
else
|
|
echo "$logname"
|
|
fi
|
|
}
|
|
|
|
log_is_in_dev()
|
|
{
|
|
test "${1:0:5}" = "/dev/"
|
|
}
|
|
|
|
start_writing_logfile()
|
|
{
|
|
local logfile="$1"
|
|
local title="$2"
|
|
! log_is_in_dev "$logfile" || return 0
|
|
echo "START $title" >> "$logfile" || { echo "Cannot write installation log $logfile" >&2; exit 1; }
|
|
[ "$EUID" -ne "0" ] || set_ac root root 0600 "$logfile"
|
|
}
|
|
|
|
log_start()
|
|
{
|
|
true product_log_name product_problems_log_name mktemp_log
|
|
|
|
local title="$1"
|
|
local custom_log="$2"
|
|
local custom_problems_log="$3"
|
|
|
|
local product_log_dir="/var/log/plesk/install"
|
|
|
|
product_log="$product_log_dir/`product_log_name`"
|
|
product_problems_log="$product_log_dir/`product_problems_log_name`"
|
|
problems_occured=0
|
|
|
|
# init product log
|
|
[ ! -n "$custom_log" ] || product_log="$custom_log"
|
|
product_log=`mktemp_log "$product_log" "$product_log_dir"`
|
|
|
|
# init problems log
|
|
if [ -n "$custom_problems_log" ]; then
|
|
product_problems_log=`mktemp_log "$custom_problems_log" "$product_log_dir"`
|
|
elif [ -n "$custom_log" ]; then
|
|
product_problems_log="$product_log"
|
|
else
|
|
product_problems_log=`mktemp_log "$product_problems_log" "$product_log_dir"`
|
|
fi
|
|
|
|
# write starting message into logs
|
|
start_writing_logfile "$product_log" "$title"
|
|
if [ "$product_log" != "$product_problems_log" ]; then
|
|
start_writing_logfile "$product_problems_log" "$title"
|
|
fi
|
|
|
|
is_function profiler_setup && profiler_setup "$title" || :
|
|
}
|
|
|
|
log_transaction_start()
|
|
{
|
|
LOG_TRANSACTION_TITLE="$1"
|
|
LOG_TRANSACTION_SUBJECT="$2"
|
|
local log_transaction_custom_logfile="$3"
|
|
local log_transaction_custom_problems_logfile="$4"
|
|
|
|
transaction_begin autocommit
|
|
log_start "$LOG_TRANSACTION_TITLE" "$log_transaction_custom_logfile" "$log_transaction_custom_problems_logfile"
|
|
transaction_add_commit_action "log_transaction_stop"
|
|
transaction_add_rollback_action "log_transaction_stop"
|
|
}
|
|
|
|
log_transaction_stop()
|
|
{
|
|
log_stop "$LOG_TRANSACTION_TITLE" "$LOG_TRANSACTION_SUBJECT"
|
|
}
|
|
|
|
log_stop()
|
|
{
|
|
local title="$1"
|
|
local subject="$2"
|
|
|
|
if [ "$product_log" = "$product_problems_log" ] || \
|
|
log_is_in_dev "$product_problems_log"; then
|
|
[ -e "$product_log" ] && echo "STOP $title" >>"$product_log"
|
|
is_function profiler_stop && profiler_stop || :
|
|
return
|
|
fi
|
|
|
|
if [ -z "$subject" ]; then
|
|
subject="[${title}]"
|
|
fi
|
|
|
|
# check if problems are non-empty, check for problems_occured
|
|
local status
|
|
local problem_lines="`problems_log_tail | wc -l`"
|
|
if [ "$problem_lines" -eq 0 ]; then
|
|
status="completed successfully"
|
|
else
|
|
if [ $problems_occured -ne 0 ]; then
|
|
status="failed"
|
|
else
|
|
status="completed with warnings"
|
|
fi
|
|
fi
|
|
|
|
if [ -e "$product_log" ]; then
|
|
p_echo
|
|
p_echo "**** $subject $status."
|
|
p_echo
|
|
fi
|
|
|
|
if [ "$problem_lines" -ne 0 ]; then
|
|
[ ! -e "$product_log" ] || problems_log_tail >>"$product_log" 2>&1
|
|
problems_log_tail
|
|
fi
|
|
|
|
[ ! -e "$product_log" ] || echo "STOP $title" >>"$product_log"
|
|
if [ $problems_occured -ne 0 ]; then
|
|
echo "STOP $title: PROBLEMS FOUND" >>"$product_problems_log"
|
|
else
|
|
[ ! -s "$product_problems_log" ] || echo "STOP $title: OK" >>"$product_problems_log"
|
|
fi
|
|
|
|
if [ "X${PLESK_INSTALLER_KEEP_PROBLEMS_LOG}" = "X" ]; then
|
|
cleanup_problems_log
|
|
fi
|
|
|
|
is_function profiler_stop && profiler_stop || :
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
|
|
construct_report_template()
|
|
{
|
|
local severity="${1:-error}"
|
|
local summary="$2"
|
|
|
|
local update_ticket="`get_update_ticket`"
|
|
|
|
set_error_report_source
|
|
set_error_report_component
|
|
set_error_report_params
|
|
set_error_report_environment
|
|
|
|
true construct_report_code construct_report_debug construct_report_message
|
|
|
|
cat <<-EOL
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
|
<error>
|
|
<source>$report_source</source>
|
|
<severity>$severity</severity>
|
|
<datetime>`date --iso-8601=seconds`</datetime>
|
|
|
|
<component>$report_component</component>
|
|
<summary><![CDATA[`echo "$summary" | sed -e 's/\]\]>/] ]>/g'`]]></summary>
|
|
<message encoding="base64">`construct_report_message | base64`</message>
|
|
|
|
<additional_info>
|
|
<component_params encoding="base64">$report_params</component_params>
|
|
<code encoding="base64">`construct_report_code | base64`</code>
|
|
<debug encoding="base64">`construct_report_debug | base64`</debug>
|
|
<environment encoding="base64">$report_environment</environment>
|
|
<update_ticket>$update_ticket</update_ticket>
|
|
</additional_info>
|
|
</error>
|
|
EOL
|
|
}
|
|
|
|
construct_report_code()
|
|
{
|
|
local call_level=${1:-5}
|
|
local func_level=$[call_level - 1]
|
|
local lineno_func=${BASH_LINENO[ $func_level ]}
|
|
local script_name=${BASH_SOURCE[ $[func_level + 1] ]}
|
|
|
|
echo "# Call of ${FUNCNAME[$func_level]}() from ${FUNCNAME[$[func_level + 1]]}() at `readlink -m $script_name`:${BASH_LINENO[$func_level]}"
|
|
head -n $[lineno_func + 4] "$script_name" 2>/dev/null | tail -n 8
|
|
}
|
|
|
|
construct_report_debug()
|
|
{
|
|
local call_level=${1:-5}
|
|
call_level=$[call_level-1]
|
|
|
|
# Generate calls stack trace.
|
|
for i in `seq $call_level ${#FUNCNAME[@]}`; do
|
|
[ "${FUNCNAME[$i]}" != "main" ] || break
|
|
|
|
local func_call="`sed -n -e "${BASH_LINENO[$i]}p" "${BASH_SOURCE[$[i+1]]}" 2>/dev/null |
|
|
sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//'`"
|
|
[ -n "$func_call" -a -z "${func_call##*${FUNCNAME[$i]}*}" ] || func_call="${FUNCNAME[$i]}"
|
|
echo "#$[i - $call_level] `readlink -m ${BASH_SOURCE[$[i+1]]}`(${BASH_LINENO[$i]}): $func_call"
|
|
done
|
|
}
|
|
|
|
construct_report_message()
|
|
{
|
|
product_and_problems_log_tail
|
|
|
|
echo ""
|
|
if [ -n "$report_context" ]; then
|
|
echo "Context: $report_context"
|
|
echo ""
|
|
fi
|
|
if [ -n "$RP_LOADED_PATCHES" ]; then
|
|
echo "Loaded runtime patches: $RP_LOADED_PATCHES"
|
|
echo ""
|
|
fi
|
|
}
|
|
|
|
# Construct report to send it to our errors tracker
|
|
construct_report()
|
|
{
|
|
local severity="${1:-error}"
|
|
local summary="$2"
|
|
|
|
[ -n "$summary" ] || int_err "Unable to send error report. Some parameters are not defined."
|
|
|
|
set_error_report_source
|
|
get_product_versions
|
|
|
|
construct_report_template "$severity" "$summary" \
|
|
| $PRODUCT_ROOT_D/admin/bin/send-error-report --version "$product_this_version" $report_source >/dev/null 2>&1
|
|
}
|
|
|
|
# Use this function to report failed actions.
|
|
# Typical report should contain
|
|
# - reason or problem description (example: file copying failed)
|
|
# - how to resolve or investigate problem (example: check file permissions, free disk space)
|
|
# - how to re-run action (example: perform specific command, restart bootstrapper script, run installation again)
|
|
report_problem()
|
|
{
|
|
local severity="${1:-error}"
|
|
|
|
# Get first string of error as a summary of report
|
|
shift
|
|
|
|
local summary="$1"
|
|
|
|
[ -n "$product_problems_log" ] || product_problems_log="/dev/stderr"
|
|
|
|
p_echo
|
|
if [ "0$problems_occured" -eq 0 ]; then
|
|
echo "***** $process problem report *****" >> "$product_problems_log" 2>&1
|
|
fi
|
|
for problem_message in "$@"; do
|
|
p_echo "$problem_message"
|
|
if [ "$product_log" != "$product_problems_log" ]; then
|
|
echo "$problem_message" >> "$product_problems_log" 2>&1
|
|
fi
|
|
done
|
|
p_echo
|
|
|
|
construct_report "$severity" "$summary"
|
|
|
|
[ -n "$PLESK_INSTALLER_DEBUG" -o -n "$PLESK_INSTALLER_VERBOSE" ] || \
|
|
product_log_tail
|
|
|
|
problems_occured=1
|
|
}
|
|
|
|
set_error_report_source()
|
|
{
|
|
[ -z "$1" ] || report_source="$1"
|
|
[ -n "$report_source" ] || {
|
|
if [ -n "$PACKAGE_ID" -o -n "$PACKAGE_ACTION" -o -n "$PACKAGE_NAME" -o -n "$PACKAGE_VERSION" ]; then
|
|
report_source="install"
|
|
else
|
|
report_source="backend"
|
|
fi
|
|
}
|
|
}
|
|
|
|
set_error_report_component()
|
|
{
|
|
local component="$1"
|
|
|
|
if [ "$report_source" = "install" ]; then
|
|
[ -n "$report_component" ] || report_component="$PACKAGE_ID"
|
|
return 0
|
|
fi
|
|
|
|
[ -z "$component" ] || report_component="$1"
|
|
[ -n "$report_component" ] || report_component="`basename $0`"
|
|
}
|
|
|
|
set_error_report_params()
|
|
{
|
|
if [ "$report_source" = "install" ]; then
|
|
[ -n "$report_params" ] || report_params="`echo "$PACKAGE_ACTION of $PACKAGE_NAME $PACKAGE_VERSION" | base64`"
|
|
return 0
|
|
fi
|
|
|
|
[ -z "$*" ] || report_params="`echo "$*" | base64`"
|
|
[ -n "$report_params" ] || report_params="`echo "$PLESK_SCRIPT_COMMAND_LINE" | base64`"
|
|
}
|
|
|
|
detect_virtualization()
|
|
{
|
|
detect_vz
|
|
detect_lxc
|
|
local is_docker="`[ -f "/.dockerenv" ] && echo yes || :`"
|
|
local systemd_detect_virt_ct="`/usr/bin/systemd-detect-virt -c 2>/dev/null | grep -v '^none$' || :`"
|
|
local systemd_detect_virt_vm="`/usr/bin/systemd-detect-virt -v 2>/dev/null | grep -v '^none$' || :`"
|
|
local virt_what="`/usr/sbin/virt-what 2>/dev/null | xargs || :`"
|
|
|
|
if [ -n "$is_docker" ]; then
|
|
echo "docker $virt_what"
|
|
elif [ "$PLESK_VZ" = "1" ]; then
|
|
echo "${PLESK_VZ_TYPE:-virtuozzo}"
|
|
elif [ "$PLESK_LXC" = "1" ]; then
|
|
echo "lxc $virt_what"
|
|
elif [ -n "$systemd_detect_virt_ct" ]; then
|
|
echo "$systemd_detect_virt_ct $systemd_detect_virt_vm"
|
|
elif [ -n "$virt_what" ]; then
|
|
echo "$virt_what"
|
|
elif [ -n "$systemd_detect_virt_vm" ]; then
|
|
echo "$systemd_detect_virt_vm"
|
|
fi
|
|
}
|
|
|
|
default_error_report_environment()
|
|
{
|
|
local virtualization="`detect_virtualization`"
|
|
|
|
if [ -n "$virtualization" ]; then
|
|
echo "virtualization: $virtualization"
|
|
fi
|
|
}
|
|
|
|
set_error_report_environment()
|
|
{
|
|
[ -z "$*" ] || report_environment="`echo "$*" | base64`"
|
|
[ -n "$report_environment" ] || report_environment="`default_error_report_environment | base64`"
|
|
}
|
|
|
|
get_update_ticket()
|
|
{
|
|
[ -r $PRODUCT_ROOT_D/var/update_ticket ] && cat $PRODUCT_ROOT_D/var/update_ticket | awk '{$1=$1};1'
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
|
|
#
|
|
# Support for runtime patching of shell scripts (including utilities and package scripts).
|
|
#
|
|
|
|
# --- Service functions ---
|
|
|
|
# Load and apply a patch in a relatively safe way
|
|
rp_safe_load_patch()
|
|
{
|
|
local patch_file="$1"
|
|
echo_try "load shell patch '$patch_file'"
|
|
/bin/sh -n "$RP_BASEDIR/$patch_file" &&
|
|
{
|
|
. "$RP_BASEDIR/$patch_file"
|
|
RP_LOADED_PATCHES="$RP_LOADED_PATCHES $patch_file"
|
|
} &&
|
|
suc
|
|
}
|
|
|
|
# Apply patches specific to the current context (e.g., depending on utility basename or package name)
|
|
# This is currently not implemented. This may be overriden by "spark".
|
|
rp_patch_runtime_context_specific()
|
|
{
|
|
:
|
|
}
|
|
|
|
# --- Main entry points ---
|
|
|
|
rp_patch_runtime()
|
|
{
|
|
# List of loaded patch files
|
|
RP_LOADED_PATCHES=
|
|
|
|
local RP_BASEDIR="$PRODUCT_BOOTSTRAPPER_DIR/rp"
|
|
[ -d "$RP_BASEDIR" ] || return 0
|
|
|
|
if [ -r "$RP_BASEDIR/spark" ]; then
|
|
rp_safe_load_patch "spark"
|
|
fi
|
|
|
|
call_optional_function rp_patch_runtime_context_specific "$@"
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
transaction_begin()
|
|
{
|
|
[ -n "$TRANSACTION_STARTED" ] && die "Another transaction in progress!"
|
|
TRANSACTION_STARTED="true"
|
|
TRANSACTION_ROLLBACK_FUNCS=
|
|
TRANSACTION_COMMIT_FUNCS=
|
|
local transaction_autocommit="$1"
|
|
if [ -n "$transaction_autocommit" ]; then
|
|
trap "transaction_commit_auto" EXIT
|
|
trap "transaction_rollback" HUP PIPE INT QUIT TERM
|
|
else
|
|
trap "transaction_rollback" HUP PIPE INT QUIT TERM EXIT
|
|
fi
|
|
}
|
|
|
|
transaction_rollback()
|
|
{
|
|
TRANSACTION_RETURN_CODE="${TRANSACTION_RETURN_CODE:-$?}"
|
|
[ -z "$TRANSACTION_STARTED" ] && die "Transaction is not started!"
|
|
# perform rollback actions
|
|
local f
|
|
for f in ${TRANSACTION_ROLLBACK_FUNCS}; do
|
|
"$f"
|
|
done
|
|
TRANSACTION_STARTED=
|
|
TRANSACTION_ROLLBACK_FUNCS=
|
|
TRANSACTION_COMMIT_FUNCS=
|
|
trap - HUP PIPE INT QUIT TERM EXIT
|
|
exit 1
|
|
}
|
|
|
|
transaction_commit()
|
|
{
|
|
TRANSACTION_RETURN_CODE="${TRANSACTION_RETURN_CODE:-$?}"
|
|
[ -z "$TRANSACTION_STARTED" ] && die "Transaction is not started!"
|
|
# perform commit actions
|
|
local f
|
|
for f in ${TRANSACTION_COMMIT_FUNCS}; do
|
|
"$f"
|
|
done
|
|
TRANSACTION_STARTED=
|
|
TRANSACTION_ROLLBACK_FUNCS=
|
|
TRANSACTION_COMMIT_FUNCS=
|
|
trap - HUP PIPE INT QUIT TERM EXIT
|
|
}
|
|
|
|
transaction_commit_auto()
|
|
{
|
|
TRANSACTION_RETURN_CODE="$?"
|
|
if [ "$TRANSACTION_RETURN_CODE" -eq 0 ]; then
|
|
transaction_commit "$@"
|
|
else
|
|
transaction_rollback "$@"
|
|
fi
|
|
}
|
|
|
|
transaction_add_rollback_action()
|
|
{
|
|
[ -z "$TRANSACTION_STARTED" ] && die "Transaction is not started!"
|
|
# LIFO rollback order
|
|
[ -z "$TRANSACTION_ROLLBACK_FUNCS" ] \
|
|
&& TRANSACTION_ROLLBACK_FUNCS="$1" \
|
|
|| TRANSACTION_ROLLBACK_FUNCS="$1 $TRANSACTION_ROLLBACK_FUNCS"
|
|
}
|
|
|
|
transaction_add_commit_action()
|
|
{
|
|
[ -z "$TRANSACTION_STARTED" ] && die "Transaction is not started!"
|
|
# FIFO commit order
|
|
[ -z "$TRANSACTION_COMMIT_FUNCS" ] \
|
|
&& TRANSACTION_COMMIT_FUNCS="$1" \
|
|
|| TRANSACTION_COMMIT_FUNCS="$TRANSACTION_COMMIT_FUNCS $1"
|
|
}
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
# vim:ft=sh
|
|
|
|
initial_conf()
|
|
{
|
|
PRODNAME="psa"
|
|
PRODUCT_NAME="psa"
|
|
product=${PRODNAME}
|
|
PRODUCT_FULL_NAME="Plesk"
|
|
|
|
product_etc="/etc/${PRODNAME}"
|
|
prod_conf_t="/etc/psa/psa.conf"
|
|
|
|
support_contact="https://support.plesk.com/"
|
|
|
|
conceived_os_vendor=Ubuntu
|
|
conceived_os_version="24.04"
|
|
|
|
clients_group="psacln"
|
|
clients_GID="10001"
|
|
|
|
services_group="psaserv"
|
|
services_GID="10003"
|
|
|
|
product_suff="saved_by_${product}".`date "+%m.%d;%H:%M"`
|
|
product_suffo="saved_by_${product}"
|
|
|
|
# plesk default password
|
|
PRODUCT_DEFAULT_PASSWORD="setup"
|
|
}
|
|
|
|
read_conf()
|
|
{
|
|
[ -n "$prod_conf_t" ] || prod_conf_t=/etc/psa/psa.conf
|
|
|
|
if [ -s $prod_conf_t ]; then
|
|
tmp_var=`perl -e 'undef $/; $_=<>; s/#.*$//gm;
|
|
s/^\s*(\S+)\s*/$1=/mg;
|
|
print' $prod_conf_t`
|
|
eval $tmp_var
|
|
else
|
|
if ! is_product_installation; then
|
|
p_echo "Unable to find product configuration file: $prod_conf_t. Default values will be used."
|
|
return 1
|
|
fi
|
|
fi
|
|
return 0
|
|
}
|
|
|
|
get_my_cnf_param()
|
|
{
|
|
local r=
|
|
|
|
local my_cnf
|
|
find_my_cnf "non-fatal" && \
|
|
r=`perl -e '$p="'"$1"'";
|
|
undef $/; $_=<>; s/#.*$//gm;
|
|
/\[mysqld\](.*?)\[/sg;
|
|
$_=substr($1, rindex $1,"$p") and
|
|
/$p\s*=(.*)/m and print $1
|
|
' ${my_cnf}`
|
|
echo $r
|
|
}
|
|
|
|
get_mysql_socket()
|
|
{
|
|
# Marked as local as it's not used anywhere else now.
|
|
local mysql_socket="/var/run/mysqld/mysqld.sock"
|
|
|
|
local mysqlsock=`get_my_cnf_param socket`
|
|
local MYSQL_SOCKETS="/var/lib/mysql/mysql.sock /tmp/mysql.sock /var/run/mysqld/mysqld.sock"
|
|
|
|
for i in $mysql_socket $mysqlsock $MYSQL_SOCKETS; do
|
|
if [ -S "$i" ]; then
|
|
# This is used internally by mysqld_safe. Maybe this whole function isn't required nowadays.
|
|
# See also: http://dev.mysql.com/doc/refman/5.0/en/problems-with-mysql-sock.html
|
|
MYSQL_UNIX_PORT=$i
|
|
export MYSQL_UNIX_PORT
|
|
mysql_socket="$i"
|
|
break
|
|
fi
|
|
done
|
|
}
|
|
|
|
selinux_close()
|
|
{
|
|
if [ -z "$SELINUX_ENFORCE" -o "$SELINUX_ENFORCE" = "Disabled" ]; then
|
|
return
|
|
fi
|
|
|
|
setenforce "$SELINUX_ENFORCE"
|
|
}
|
|
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
# vim:ft=sh:
|
|
|
|
#set_params
|
|
|
|
set_common_params()
|
|
{
|
|
common_var=0
|
|
|
|
PATH=/sbin:/bin:/usr/sbin:/usr/bin:/usr/local/sbin:/usr/local/bin
|
|
LANG="`get_default_locale`"
|
|
export PATH LANG
|
|
unset GREP_OPTIONS
|
|
umask 022
|
|
ulimit -n 65535 2>/dev/null
|
|
|
|
get_product_versions
|
|
|
|
certificate_file="$PRODUCT_ETC_D/httpsd.pem"
|
|
services="/etc/services"
|
|
|
|
crontab="/usr/bin/crontab"
|
|
|
|
SYSTEM_RC_D="/etc/init.d"
|
|
PLESK_LIBEXEC_DIR="/usr/lib/plesk-9.0"
|
|
PLESK_DB_DIR="/var/lib/plesk"
|
|
PRODUCT_BOOTSTRAPPER_DIR="`printf "/opt/psa/bootstrapper/pp%s-bootstrapper" "$product_this_version"`"
|
|
AUTOGENERATED_CONFIGS="#ATTENTION!\n#\n#DO NOT MODIFY THIS FILE BECAUSE IT WAS GENERATED AUTOMATICALLY,\n#SO ALL YOUR CHANGES WILL BE LOST THE NEXT TIME THE FILE IS GENERATED.\n"
|
|
AUTOGENERATED_CONFIGS_UPGRADE="#ATTENTION!\n#\n#DO NOT MODIFY THIS FILE BECAUSE IT WAS GENERATED AUTOMATICALLY,\n#SO ALL YOUR CHANGES WILL BE LOST AFTER YOU UPGRADE PLESK.\n"
|
|
PRODUCT_LOGS_D="/var/log/plesk"
|
|
|
|
sendmail="/usr/sbin/sendmail"
|
|
ps="ps axw"
|
|
ifconfig="/sbin/ifconfig -a"
|
|
|
|
machine="linux"
|
|
if [ -f /etc/debian_version ]; then
|
|
linux_distr="debian"
|
|
else
|
|
linux_distr="redhat"
|
|
fi
|
|
|
|
dummy_home="/"
|
|
if [ -x /usr/sbin/nologin ]; then
|
|
dummy_shell="/usr/sbin/nologin"
|
|
else
|
|
dummy_shell="/bin/false"
|
|
fi
|
|
|
|
rp_patch_runtime
|
|
}
|
|
|
|
get_product_versions()
|
|
{
|
|
# Don't use global variables set elsewhere in this code. Use substitutions if needed.
|
|
local prod_root_d="/opt/psa"
|
|
|
|
product_name="psa"
|
|
|
|
if [ -z "$product_this_version" ]; then
|
|
# 1. Try to fetch version from file created by bootstrapper (should be 3-component).
|
|
product_this_version="`cat "/var/lock/plesk-target-version" 2>/dev/null`"
|
|
# 2. Fallback to $PRODUCT_ROOT_D/version (should be 3-component).
|
|
if [ -z "$product_this_version" -a -r "$prod_root_d/version" ]; then
|
|
product_this_version="`awk '{ print $1 }' "$prod_root_d/version"`"
|
|
fi
|
|
# 3. Fallback to hardcoded version (2-component). This may cause some other code to fail.
|
|
if [ -z "$product_this_version" ]; then
|
|
product_this_version="18.0"
|
|
echo "Unable to determine \$product_this_version, will use less precise value '$product_this_version'" >&2
|
|
fi
|
|
fi
|
|
|
|
product_version="$product_this_version"
|
|
|
|
if [ -z "$product_prev_version" ]; then
|
|
if [ -r "$prod_root_d/version.upg" ]; then
|
|
product_prev_version=`awk '{ print $1 }' "$prod_root_d/version.upg"`
|
|
elif [ -r "$prod_root_d/version" ]; then
|
|
product_prev_version=`awk '{ print $1 }' "$prod_root_d/version"`
|
|
else
|
|
product_prev_version="$product_this_version"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# Clean installation of the product is being performed
|
|
is_product_installation()
|
|
{
|
|
[ "X$do_upgrade" != "X1" -a ! -s "/opt/psa/version.upg" ]
|
|
}
|
|
|
|
set_mysql_auth()
|
|
{
|
|
# This function requires set_mysql_server_params and set_mysql_client_params (or set_mysqld_params)
|
|
# to be called before
|
|
local inten="set up mysql authentication"
|
|
local dsn_plesk_host="`get_dsn plesk host`"
|
|
local dsn_plesk_port="`get_dsn plesk port`"
|
|
local dsn_plesk_username="`get_dsn plesk username`"
|
|
local dsn_plesk_password="`get_dsn plesk password`"
|
|
|
|
get_admin_passwd
|
|
|
|
[ -n "$dsn_plesk_host" ] || pleskrc mysql start
|
|
|
|
mysql_host="${dsn_plesk_host:+--host=$dsn_plesk_host}"
|
|
mysql_port="${dsn_plesk_port:+--port=$dsn_plesk_port}"
|
|
mysql_user="--user=${dsn_plesk_username:-admin}"
|
|
mysql_passwd="${dsn_plesk_password:-$admin_passwd}"
|
|
|
|
if find_my_cnf 'non-fatal'; then
|
|
mysql_defaults="--defaults-file=$my_cnf"
|
|
else
|
|
mysql_defaults="--no-defaults"
|
|
fi
|
|
|
|
if [ -z "$PLESK_MYSQL_AUTH_SKIP_CONNECTION_CHECK" ]; then
|
|
mysql_test_connection 10 || die "$inten"
|
|
fi
|
|
suc
|
|
}
|
|
|
|
get_admin_passwd()
|
|
{
|
|
[ -z "$admin_passwd" ] || return 0
|
|
|
|
if [ -f "$mysql_passwd_file" ]; then
|
|
admin_passwd=`cat "$mysql_passwd_file"`
|
|
return 0
|
|
fi
|
|
|
|
admin_passwd=`get_random_string 1 'A-Z'`
|
|
admin_passwd+=`get_random_string 1 'a-z'`
|
|
admin_passwd+=`get_random_string 1 '0-9'`
|
|
admin_passwd+=`get_random_string 1 '_%=+\-@<>:.,:'`
|
|
admin_passwd+=`get_random_string 10 'A-Za-z0-9_%=+\-@<>:.,:'`
|
|
admin_passwd=`printf "%s" "$admin_passwd" | fold -w 1 | shuf - | tr -d '\n'`
|
|
|
|
[ -n "$admin_passwd" ] || admin_passwd="$PRODUCT_DEFAULT_PASSWORD"
|
|
touch "$admin_password_needs_encryption_flag"
|
|
}
|
|
|
|
mysql_test_connection()
|
|
{
|
|
inten="establish test connection"
|
|
echo_try $inten
|
|
attempts=${1:-1}
|
|
for i in `sequence $attempts`; do
|
|
echo "" | mysql_direct mysql >> "$product_log" 2>&1
|
|
if [ "$?" -eq "0" ]; then
|
|
p_echo "connected"
|
|
return 0
|
|
fi
|
|
[ "$attempts" -eq "1" ] || sleep 1
|
|
done
|
|
|
|
p_echo "failed"
|
|
return 1
|
|
}
|
|
|
|
find_my_cnf()
|
|
{
|
|
local non_fatal="$1"
|
|
local cnf_files="/etc/my.cnf /etc/mysql/my.cnf /var/db/mysql/my.cnf"
|
|
|
|
for my_cnf in $cnf_files; do
|
|
if [ -f ${my_cnf} ]; then
|
|
break
|
|
fi
|
|
done
|
|
|
|
[ -f "$my_cnf" -o -n "$non_fatal" ] || {
|
|
local msg="find the MySQL server configuration file. \
|
|
If you use a third-party MySQL server build, make sure you do not use implicit default configuration \
|
|
and you have the MySQL configuration file in one of the following locations: $cnf_files"
|
|
echo "Failed to $msg" | write_structured_report 'stage=mysqlsetup' 'level=fatal' 'errtype=mysqlnomycnf' "mycnffiles=$cnf_files" || :
|
|
die "$msg"
|
|
}
|
|
|
|
[ -f "$my_cnf" ] || return 1
|
|
|
|
my_cnf_d=`awk '/^\s*!includedir\>/ {print $2}' "$my_cnf" | head -1`
|
|
|
|
return 0
|
|
}
|
|
|
|
mysql_compare_versions()
|
|
{
|
|
local l_greater=2
|
|
local l_equal=0
|
|
local l_less=1
|
|
|
|
local lhs_major="`echo $1 | cut -d'.' -f1`"
|
|
local lhs_minor="`echo $1 | cut -d'.' -f2`"
|
|
local lhs_patch="`echo $1 | cut -d'.' -f3 | grep -o -e '^[0-9]\+'`"
|
|
|
|
local rhs_major="`echo $2 | cut -d'.' -f1`"
|
|
local rhs_minor="`echo $2 | cut -d'.' -f2`"
|
|
local rhs_patch="`echo $2 | cut -d'.' -f3 | grep -o -e '^[0-9]\+'`"
|
|
|
|
# TODO(galtukhov): rewrite string comparision as python one-liner
|
|
|
|
if [ "$lhs_major" -gt "$rhs_major" ]; then
|
|
return $l_greater
|
|
elif [ "$lhs_major" -lt "$rhs_major" ]; then
|
|
return $l_less
|
|
else
|
|
if [ "$lhs_minor" -gt "$rhs_minor" ]; then
|
|
return $l_greater
|
|
elif [ "$lhs_minor" -lt "$rhs_minor" ]; then
|
|
return $l_less
|
|
else
|
|
if [ "$lhs_patch" -gt "$rhs_patch" ]; then
|
|
return $l_greater
|
|
elif [ "$lhs_patch" -lt "$rhs_patch" ]; then
|
|
return $l_less
|
|
else
|
|
return $l_equal
|
|
fi
|
|
fi
|
|
fi
|
|
}
|
|
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
# -*- vim:ft=sh
|
|
|
|
# mysql
|
|
|
|
set_mysqld_params()
|
|
{
|
|
mysqld_user="mysql"
|
|
mysqld_UID=3306
|
|
mysqld_group="mysql"
|
|
mysqld_GID=3306
|
|
|
|
product_db_sql="$PRODUCT_BOOTSTRAPPER_DIR/db/${PRODNAME}_db.sql"
|
|
admin_password_needs_encryption_flag="$PLESK_DB_DIR/.encrypt_admin_password.flag"
|
|
|
|
set_mysql_server_params
|
|
set_mysql_client_params
|
|
}
|
|
|
|
set_mysql_server_params()
|
|
{
|
|
get_mysql_socket
|
|
|
|
if [ -n "/lib/systemd/system" -a -f "/lib/systemd/system/mariadb.service" ]; then
|
|
mysql_service="mariadb"
|
|
elif [ -n "/lib/systemd/system" -a -f "/lib/systemd/system/mysqld.service" ]; then
|
|
# Percona server
|
|
mysql_service="mysqld"
|
|
elif [ -n "/lib/systemd/system" -a -f "/lib/systemd/system/mysql.service" ]; then
|
|
# MySQL 8 installations on debian / ubuntu
|
|
mysql_service="mysql"
|
|
elif [ -x "${PRODUCT_RC_D}/mysql" ]; then
|
|
mysql_service="mysql"
|
|
elif [ -x "${PRODUCT_RC_D}/mysql.sh" ]; then
|
|
mysql_service="mysql.sh"
|
|
elif [ -x "${PRODUCT_RC_D}/mysqld" ]; then
|
|
mysql_service="mysqld"
|
|
elif [ -x "${PRODUCT_RC_D}/mysql" ]; then
|
|
mysql_service="mysql"
|
|
else
|
|
die "detect MySQL service name"
|
|
fi
|
|
}
|
|
|
|
set_mysql_client_params()
|
|
{
|
|
mysql_client="$MYSQL_BIN_D/mysql"
|
|
[ -f "$MYSQL_BIN_D/mariadb" ] && mysql_client="$MYSQL_BIN_D/mariadb"
|
|
|
|
# Override this variable as needed
|
|
mysql_db_name="$PRODNAME"
|
|
mysql_passwd_file="$product_etc/.${PRODNAME}.shadow"
|
|
|
|
mysql_args="-N"
|
|
mysql_args_raw="-Br"
|
|
|
|
local dsn_plesk_dbname="`get_dsn plesk dbname`"
|
|
[ -z "$dsn_plesk_dbname" ] || mysql_db_name="$dsn_plesk_dbname"
|
|
}
|
|
|
|
set_mysql_version_fork_params()
|
|
{
|
|
# Must be called only after `uses_mysql_client` and `set_mysqld_params`
|
|
# Requires working connection to the MySQL server
|
|
|
|
mysql_client_fork=""
|
|
mysql_server_fork=""
|
|
mysql_client_version=""
|
|
mysql_server_version=""
|
|
|
|
local version_string=""
|
|
|
|
version_string=$(mysql_raw -V)
|
|
if ! mysql_client_fork=$(detect_mysql_fork_by_version "$version_string"); then
|
|
return 1
|
|
fi
|
|
|
|
# @see \Plesk\Db\Mysql\Version
|
|
# MySQL below 8.0, Percona below 8.0 and MariaDB (any)
|
|
# Example version string: mysql Ver 15.1 Distrib 10.9.3-MariaDB, for Linux (x86_64) using readline 5.1
|
|
|
|
# MySQL 8.0, Percona 8.0 and above
|
|
# Example version string: mysql Ver 8.0.27 for Linux on x86_64 (MySQL Community Server - GPL)
|
|
|
|
# MariaDB 11.0 and above
|
|
# Example version string: mysql from 11.4.5-MariaDB, client 15.2 for Linux (x86_64) using EditLine wrapper
|
|
|
|
for match in 'Distrib\s+([\d.]+)' 'Ver\s+([\d.]+)' 'from\s+([\d.]+)'; do
|
|
mysql_client_version=$(echo "$version_string" | grep -Po "$match" | grep -Eo '[0-9.]+')
|
|
[ -z "$mysql_client_version" ] || break
|
|
done
|
|
|
|
version_string=$(mysql_anydb -e 'SELECT CONCAT(@@''version, @@''version_comment);')
|
|
if ! mysql_server_fork=$(detect_mysql_fork_by_version "$version_string"); then
|
|
return 1
|
|
fi
|
|
|
|
mysql_server_version=$(echo "$version_string" | grep -Eo '^[0-9.]+')
|
|
|
|
[ -n "$mysql_client_version" ] || p_echo "Cannot reliably detect MySQL client version"
|
|
[ -n "$mysql_server_version" ] || p_echo "Cannot reliably detect MySQL server version"
|
|
|
|
[ -n "$mysql_client_version" -a -n "$mysql_server_version" ] || return 1
|
|
}
|
|
|
|
#Invoke mysql
|
|
dbclient_invoke()
|
|
{
|
|
mysql_anydb -D$mysql_db_name "$@"
|
|
}
|
|
|
|
mysql_anydb()
|
|
{
|
|
(
|
|
export MYSQL_PWD="$mysql_passwd"
|
|
$mysql_client $mysql_defaults $mysql_host $mysql_port $mysql_user $mysql_args "$@" 2>>"$product_log"
|
|
local status=$?
|
|
|
|
if [ $status -gt 0 ]; then
|
|
$mysql_client $mysql_defaults $mysql_host $mysql_port $mysql_user $mysql_args -D$mysql_db_name $mysql_args_raw -e "SHOW ENGINE innodb status" >>"$product_log" 2>&1
|
|
fi
|
|
unset MYSQL_PWD
|
|
return $status
|
|
)
|
|
}
|
|
|
|
# Invoke mysql without any wrapper or something else
|
|
mysql_direct()
|
|
{
|
|
# a bit dirty but it works properly for passwords with spaces, quotes and double quotes:
|
|
if [ -n "$mysql_passwd" ]; then
|
|
(
|
|
export MYSQL_PWD="$mysql_passwd"
|
|
$mysql_client $mysql_defaults $mysql_host $mysql_port $mysql_user $mysql_args "$@" 2>>"$product_log"
|
|
rc=$?
|
|
unset MYSQL_PWD
|
|
return $rc
|
|
)
|
|
else
|
|
$mysql_client $mysql_defaults $mysql_host $mysql_port $mysql_user $mysql_args "$@" 2>>"$product_log"
|
|
fi
|
|
}
|
|
|
|
# Invoke mysql in raw mode
|
|
mysql_raw()
|
|
{
|
|
dbclient_invoke $mysql_args_raw "$@"
|
|
}
|
|
|
|
mysql_raw_anydb()
|
|
{
|
|
mysql_anydb $mysql_args_raw "$@"
|
|
}
|
|
|
|
dump_db()
|
|
{
|
|
local databases="" ignore_tables=""
|
|
for db in "$@"; do
|
|
if db_test_database "$db"; then
|
|
databases="$databases $db"
|
|
fi
|
|
done
|
|
|
|
# Assume that MYSQLDUMP_OPTIONS may contain --all-databases or other options to select targets
|
|
[ -n "$databases" -o -n "$MYSQLDUMP_OPTIONS" ] || return 1
|
|
|
|
ignore_tables=$(populate_ignore_tables)
|
|
|
|
(
|
|
set -o pipefail
|
|
export MYSQL_PWD="$mysql_passwd"
|
|
|
|
local dump_client="${MYSQL_BIN_D}/mysqldump"
|
|
[ -f "$MYSQL_BIN_D/mariadb-dump" ] && dump_client="$MYSQL_BIN_D/mariadb-dump"
|
|
|
|
$dump_client $mysql_defaults $mysql_user $mysql_host $mysql_port --quote-names $MYSQLDUMP_OPTIONS $ignore_tables ${databases:+--databases $databases} |
|
|
sed -e '
|
|
/^USE `mysql`;$/,/^USE / {
|
|
/^LOCK TABLES `innodb_index_stats` WRITE;$/,/^UNLOCK TABLES;$/ d;
|
|
/^LOCK TABLES `innodb_table_stats` WRITE;$/,/^UNLOCK TABLES;$/ d;
|
|
}'
|
|
rc=$?
|
|
unset MYSQL_PWD
|
|
return $rc
|
|
)
|
|
}
|
|
|
|
uses_mysql_client()
|
|
{
|
|
# Initialize local MySQL authentication parameters and test connection.
|
|
# After that db_*() and mysql*() functions may be used.
|
|
# Any MySQL-specific overrides (e.g., local mysql_db_name="whatever") should appear
|
|
# *after* calling this function.
|
|
# This function is for use in component installers that require access to MySQL DB.
|
|
|
|
set_mysql_server_params
|
|
set_mysql_client_params
|
|
set_mysql_auth
|
|
}
|
|
|
|
populate_ignore_tables()
|
|
{
|
|
# Returns --ignore-tables=<> parameters for use in mysqldump to stdout
|
|
# Parameters are based on fork and version of client and server
|
|
|
|
if ! set_mysql_version_fork_params; then
|
|
return 1
|
|
fi
|
|
|
|
local ignore_tables=""
|
|
local exit_code=""
|
|
|
|
# Note: This check may also be applied unconditionally, as new mysqldump in MariaDB always skips this table
|
|
if [ "$mysql_server_fork" = "mariadb" ]; then
|
|
# https://jira.mariadb.org/browse/MDEV-16028 (mysqldump from MariaDB < 10.3 and any MySQL is not compatible w/ MariaDB > 10.3)
|
|
# https://github.com/MariaDB/server/blob/10.3/client/mysqldump.c#L1079
|
|
|
|
mysql_compare_versions "10.3.0" "$mysql_server_version"
|
|
exit_code=$?
|
|
|
|
if [ "$exit_code" -ne "2" ]; then
|
|
mysql_compare_versions "10.3.0" "$mysql_client_version"
|
|
exit_code=$?
|
|
|
|
if [ "$mysql_client_fork" != "mariadb" ] || [ "$exit_code" -eq "2" ]; then
|
|
ignore_tables="--ignore-table=mysql.transaction_registry"
|
|
fi
|
|
fi
|
|
fi
|
|
|
|
echo "$ignore_tables"
|
|
}
|
|
|
|
detect_mysql_fork_by_version()
|
|
{
|
|
local version_string="$1"
|
|
if [ -z "$version_string" ]; then
|
|
p_echo "Cannot reliably detect fork from empty version string"
|
|
return 1
|
|
fi
|
|
|
|
if echo "$version_string" | grep -qi 'mariadb'; then
|
|
echo "mariadb"
|
|
elif echo "$version_string" | grep -qi 'percona'; then
|
|
echo "percona"
|
|
else
|
|
echo "mysql"
|
|
fi
|
|
}
|
|
|
|
set_phpmyadmin_params()
|
|
{
|
|
PHPMYADMIN_D="$PRODUCT_ROOT_D/phpMyAdmin"
|
|
PHPMYADMIN_CONFIG="$PHPMYADMIN_D/config.plesk.php"
|
|
# Executed as root, so must be placed in a directory which is root-owned and not world-writable
|
|
PHPMYADMIN_CONFIG_BACKUP="$PLESK_DB_DIR/phpMyAdmin.config.php.save"
|
|
|
|
# Layout of phpMyAdmin before 18.0.30
|
|
PHPMYADMIN_D_OLD="$PRODUCT_ROOT_D/admin/htdocs/domains/databases/phpMyAdmin"
|
|
PHPMYADMIN_CONFIG_OLD="$PHPMYADMIN_D_OLD/libraries/config.default.php"
|
|
}
|
|
|
|
pma__read_values()
|
|
{
|
|
local PHPMYADMIN_CONFIG="$1"
|
|
shift
|
|
|
|
[ -f "$PHPMYADMIN_CONFIG" ] && sw_engine_pleskrun -r '
|
|
try {
|
|
error_reporting(0);
|
|
define("TEMP_DIR", "/tmp"); // specific value is irrelevant
|
|
require_once("'$PHPMYADMIN_CONFIG'");
|
|
for ($i = 1; $i < $argc; $i++)
|
|
if (isset($cfg["Servers"][1][$argv[$i]]))
|
|
echo $argv[$i] . "=\"" . $cfg["Servers"][1][$argv[$i]] . "\"\n";
|
|
} catch (Exception $e) {}' -- "$@" 2>/dev/null || true
|
|
}
|
|
|
|
### Copyright 1999-2025. WebPros International GmbH. All rights reserved.
|
|
|
|
# -*- vim:ft=sh:
|
|
|
|
reexec_with_clean_env "$@"
|
|
|
|
PN=`basename $0`
|
|
CMD="${PN}${*:+ $*}"
|
|
|
|
usage()
|
|
{
|
|
cat << EOT
|
|
Usage: $PN [--title TITLE] [--dump-dir DIR] [--all-databases | --databases "DB1 ..."]
|
|
Create dump of plesk-related databases.
|
|
By default (if TITLE is not specified) creates and rotates ordered (daily) dumps.
|
|
|
|
Options:
|
|
-t, --title TITLE save dump into file with specified title (i.e. mysql.TITLE.TIMESTAMP.dump.gz).
|
|
Path to created dump is shown on stdout.
|
|
-d, --dump-dir DIR directory to store the dump under (default is DUMP_D)
|
|
-A, --all-databases dump all databases (not only Plesk-related)
|
|
-B, --databases DBS dump specified databases only (space separated)
|
|
-h, --help show this help
|
|
|
|
Examples:
|
|
Store dump into file with specified title:
|
|
\$ $PN --title "preresolve"
|
|
/var/lib/psa/dumps/mysql.preresolve.20141021-135730.dump.gz
|
|
EOT
|
|
}
|
|
|
|
#
|
|
# rotate /path/file 9 8 7 6 5 4 3 2 1 0
|
|
#
|
|
# if ziplog=YES then gzip the old logs
|
|
# if /path/file.scan exists, run it with the latest logfile name as arg
|
|
# $dumpf is set to the last resulting filename
|
|
#
|
|
ziplog=YES
|
|
#
|
|
rotate() {
|
|
file="$1"; shift
|
|
rm -f "$file.$1" "$file.$1.gz"
|
|
for i in "$@"; do
|
|
[ "$i" = "0" ] && j="" || j=".`expr $i - 1`"
|
|
[ -f "$file$j.gz" ] && mv -f "$file$j.gz" "$file.$i.gz" && dumpf="$file.$i.gz"
|
|
[ -f "$file$j" ] && mv -f "$file$j" "$file.$i" && dumpf="$file.$i"
|
|
[ "$i" = "0" -a -x $file.scan ] && $file.scan "$file.$i"
|
|
[ -f "$file.$i" ] && [ "$ziplog" = "YES" ] && gzip -9 "$file.$i" && dumpf="$file.$i.gz"
|
|
done
|
|
}
|
|
|
|
get_pma_db()
|
|
{
|
|
set_phpmyadmin_params
|
|
eval `pma__read_values "$PHPMYADMIN_CONFIG" "pmadb"`
|
|
echo "$pmadb"
|
|
}
|
|
|
|
#parse options
|
|
TEMP=`getopt -o t:d:AB:h --long title:,dump-dir:,all-databases,databases:,help -n "$PN" -- "$@"`
|
|
if [ $? != 0 ] ; then pp_echo "Internal error: failed to parse command line options." ; exit 1 ; fi
|
|
eval set -- "$TEMP"
|
|
|
|
opt_title=
|
|
opt_dump_dir=
|
|
opt_all_databases=
|
|
opt_databases=
|
|
|
|
while true; do
|
|
case $1 in
|
|
-t|--title) opt_title="$2"; shift 2;;
|
|
-d|--dump-dir) opt_dump_dir="$2"; shift 2;;
|
|
-A|--all-databases) opt_all_databases="yes"; shift;;
|
|
-B|--databases) opt_databases="$2"; shift 2;;
|
|
-h|--help) usage; exit 0;;
|
|
--) shift; break;;
|
|
*) pp_echo "Unrecognized option: $1"; usage; exit 1;;
|
|
esac
|
|
done
|
|
|
|
dumpf=""
|
|
|
|
main()
|
|
{
|
|
initial_conf
|
|
product_default_conf
|
|
read_conf
|
|
|
|
set_common_params
|
|
log_transaction_start "$CMD" "" "$PRODUCT_LOGS_D/mysqldump.log"
|
|
|
|
set_mysqld_params
|
|
uses_mysql_client
|
|
|
|
local filename=mysql.daily.dump
|
|
[ -z "$opt_title" ] || filename="mysql.${opt_title}.`date +%Y%m%d-%H%M%S`.dump"
|
|
dumpf="${opt_dump_dir:-$DUMP_D}/${filename}"
|
|
|
|
local dump_databases=""
|
|
if [ -n "$opt_all_databases" ]; then
|
|
export MYSQLDUMP_OPTIONS="--all-databases"
|
|
pp_echo "Dump all databases"
|
|
elif [ -n "$opt_databases" ]; then
|
|
dump_databases="$opt_databases"
|
|
pp_echo "Dump databases: $dump_databases"
|
|
else
|
|
local apsc_db_name="`db_read_misc_attr "aps_database"`"
|
|
local psa_db_name="`get_dsn plesk dbname`"
|
|
local horde_db_name="`get_dsn horde dbname`"
|
|
local roundcube_db_name="`get_dsn roundcube dbname`"
|
|
|
|
local known_databases="${psa_db_name:-"$PRODNAME"} mysql ${horde_db_name:-"horde"} sitebuilder5 $apsc_db_name ${roundcube_db_name:-"roundcubemail"} `get_pma_db`"
|
|
|
|
for database in $known_databases; do
|
|
if db_test_database "$database"; then
|
|
dump_databases="$dump_databases $database"
|
|
fi
|
|
done
|
|
|
|
if [ -z "$dump_databases" ]; then
|
|
pp_echo "No databases to dump"
|
|
exit 0
|
|
fi
|
|
|
|
pp_echo "Dump databases: $dump_databases"
|
|
fi
|
|
|
|
db_backup_aux 'Dump databases' "$dumpf" $dump_databases
|
|
|
|
if [ -z "$opt_title" ]; then
|
|
# rotate ordered dumps
|
|
rotate $dumpf 8 7 6 5 4 3 2 1 0
|
|
elif [ "$ziplog" = "YES" ]; then
|
|
# gzip "prefixed" dump
|
|
gzip -9 "$dumpf"
|
|
dumpf="$dumpf.gz"
|
|
fi
|
|
|
|
[ -f "$dumpf" ] || return 1
|
|
|
|
local size="`ls -sh "$dumpf" | cut -d' ' -f1`"
|
|
local lifetime= expire_by=
|
|
if [ -n "$opt_title" ]; then
|
|
local plesk_cron_daily="/etc/cron.daily/50plesk-daily"
|
|
lifetime="`grep -F "mysql.${opt_title}.*.dump" "$plesk_cron_daily" | grep -E -o '\<[0-9]+\s+days\>'`"
|
|
[ -z "$lifetime" ] || expire_by="`date -d "$(date -r "$dumpf") +$lifetime"`"
|
|
fi
|
|
pp_echo "Dump file size: $size."
|
|
${lifetime:+pp_echo "Dump file lifetime: $lifetime (will be automatically removed after $expire_by)."}
|
|
}
|
|
|
|
main 1>&2
|
|
|
|
# Tell Frontend path to created named dump (do not change w/o frontend agreement):
|
|
[ -z "$opt_title" ] || echo "$dumpf"
|