mirror of
https://github.com/YunoHost-Apps/dokuwiki_ynh.git
synced 2024-09-03 18:26:20 +02:00
795059f383
* [fix] Reactivate integrity check #26 * [fix] Use boolean type for is_public #25 * [fix] isolate user with php-fpm * [fix] boolean is_public for check_process * [fix] Create user for upgrade and restore * [fix] delete choices manifest.json * [fix] load generic function * [fix] delete reload php5-fpm * [fix] owner file with user dokuwiki * [fix] correctly ssowat config for install * [fix] Get file fonction if not been to the current directory * [fix] owner file with user dokuwiki - upgrade * [fix] Clean code * Reload php-fpm et after remove user * [fix] upgrade php5-fpm with a good user * [fix] owner root for all files & owner dokuwiki for write access * [fix] owner root for all files & owner dokuwiki for write access (upgrade script) * [fix] owner read & write for plugins directory
254 lines
8 KiB
Bash
254 lines
8 KiB
Bash
#!/bin/bash
|
||
|
||
ynh_version="2.4"
|
||
|
||
YNH_VERSION () { # Display number version of the YunoHost moulinette
|
||
ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
|
||
}
|
||
|
||
CHECK_VAR () { # Check variable is not empty
|
||
# $1 = Checking variable
|
||
# $2 = Text to display on error
|
||
test -n "$1" || (echo "$2" >&2 && false)
|
||
}
|
||
|
||
EXIT_PROPERLY () { # Causes the script to stop in the event of an error. And clean the residue.
|
||
trap '' ERR
|
||
echo -e "\e[91m \e[1m" # Shell in light red bold
|
||
echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" >&2
|
||
|
||
if type -t CLEAN_SETUP > /dev/null; then # Checks the existence of the function before executing it.
|
||
CLEAN_SETUP # Call the specific cleanup function of the install script.
|
||
fi
|
||
|
||
sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json
|
||
|
||
if [ "$ynh_version" = "2.2" ]; then
|
||
/bin/bash $script_dir/remove # Call the remove script. In 2.2, this behavior is not automatic.
|
||
fi
|
||
|
||
ynh_die
|
||
}
|
||
|
||
TRAP_ON () { # Activate signal capture
|
||
trap EXIT_PROPERLY ERR # Capturing exit signals on error
|
||
}
|
||
|
||
TRAP_OFF () { # Ignoring signal capture until TRAP_ON
|
||
trap '' ERR # Ignoring exit signals
|
||
}
|
||
|
||
CHECK_USER () { # Check the validity of the user admin
|
||
# $1 = User admin variable
|
||
ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false)
|
||
}
|
||
|
||
CHECK_PATH () { # Checks / at the beginning of the path. And his absence at the end.
|
||
if [ "${path:0:1}" != "/" ]; then # If the first character is not /
|
||
path="/$path" # Add / at the beginning of path
|
||
fi
|
||
if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # If the last character is a / and it is not the only character.
|
||
path="${path:0:${#path}-1}" # Delete last character
|
||
fi
|
||
}
|
||
|
||
CHECK_DOMAINPATH () { # Checks the availability of the path and domain.
|
||
sudo yunohost app checkurl $domain$path -a $app
|
||
}
|
||
|
||
CHECK_FINALPATH () { # Checks that the destination folder is not already in use.
|
||
final_path=/var/www/$app
|
||
if [ -e "$final_path" ]
|
||
then
|
||
echo "This path already contains a folder" >&2
|
||
false
|
||
fi
|
||
}
|
||
|
||
SETUP_SOURCE () { # Download source, decompress and copu into $final_path
|
||
src=$(cat ../sources/source_md5 | awk -F' ' {'print $2'})
|
||
sudo wget -nv -i ../sources/source_url -O $src
|
||
# Checks the checksum of the downloaded source.
|
||
md5sum -c ../sources/source_md5 --status || ynh_die "Corrupt source"
|
||
# Decompress source
|
||
if [ "$(echo ${src##*.})" == "tgz" ]; then
|
||
tar -x -f $src
|
||
elif [ "$(echo ${src##*.})" == "zip" ]; then
|
||
unzip -q $src
|
||
else
|
||
false # Unsupported archive format.
|
||
fi
|
||
# Copy file source
|
||
sudo cp -a $(cat ../sources/source_dir)/. "$final_path"
|
||
# Copy additional file and modified
|
||
if test -e "../sources/ajouts"; then
|
||
sudo cp -a ../sources/ajouts/. "$final_path"
|
||
fi
|
||
}
|
||
|
||
POOL_FPM () { # Create the php-fpm pool configuration file and configure it.
|
||
sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf
|
||
sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf
|
||
sed -i "s@__USER__@$app@g" ../conf/php-fpm.conf
|
||
finalphpconf=/etc/php5/fpm/pool.d/$app.conf
|
||
sudo cp ../conf/php-fpm.conf $finalphpconf
|
||
sudo chown root: $finalphpconf
|
||
finalphpini=/etc/php5/fpm/conf.d/20-$app.ini
|
||
sudo cp ../conf/php-fpm.ini $finalphpini
|
||
sudo chown root: $finalphpini
|
||
sudo systemctl reload php5-fpm
|
||
}
|
||
|
||
STORE_MD5_CONFIG () { # Saves the checksum of the config file
|
||
# $1 = Name of the conf file for storage in settings.yml
|
||
# $2 = Full name and path of the conf file.
|
||
ynh_app_setting_set $app $1_file_md5 $(sudo md5sum "$2" | cut -d' ' -f1)
|
||
}
|
||
|
||
CHECK_MD5_CONFIG () { # Created a backup of the config file if it was changed.
|
||
# $1 = Name of the conf file for storage in settings.yml
|
||
# $2 = Full name and path of the conf file.onf.
|
||
if [ "$(ynh_app_setting_get $app $1_file_md5)" != $(sudo md5sum "$2" | cut -d' ' -f1) ]; then
|
||
sudo cp -a "$2" "$2.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup.
|
||
fi
|
||
}
|
||
|
||
FIND_PORT () { # Search free port
|
||
# $1 = Port number to start the search.
|
||
port=$1
|
||
while ! sudo yunohost app checkport $port ; do
|
||
port=$((port+1))
|
||
done
|
||
CHECK_VAR "$port" "port empty"
|
||
}
|
||
|
||
|
||
### REMOVE SCRIPT
|
||
|
||
REMOVE_NGINX_CONF () { # Delete nginx configuration
|
||
if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then
|
||
echo "Delete nginx config"
|
||
sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
|
||
sudo systemctl reload nginx
|
||
fi
|
||
}
|
||
|
||
REMOVE_FPM_CONF () { # Delete pool php-fpm configuration
|
||
if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config
|
||
echo "Delete fpm config"
|
||
sudo rm "/etc/php5/fpm/pool.d/$app.conf"
|
||
fi
|
||
if [ -e "/etc/php5/fpm/conf.d/20-$app.ini" ]; then # Delete php config
|
||
echo "Delete php config"
|
||
sudo rm "/etc/php5/fpm/conf.d/20-$app.ini"
|
||
fi
|
||
sudo systemctl reload php5-fpm
|
||
}
|
||
|
||
REMOVE_LOGROTATE_CONF () { # Delete logrotate configuration
|
||
if [ -e "/etc/logrotate.d/$app" ]; then
|
||
echo "Delete logrotate config"
|
||
sudo rm "/etc/logrotate.d/$app"
|
||
fi
|
||
}
|
||
|
||
SECURE_REMOVE () { # Deleting a folder with variable verification
|
||
chaine="$1" # The argument must be given between simple quotes '', to avoid interpreting the variables.
|
||
no_var=0
|
||
while (echo "$chaine" | grep -q '\$') # Loop as long as there are $ in the string
|
||
do
|
||
no_var=1
|
||
global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole the first variable found.
|
||
only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole completely the variable by adding the $ at the beginning and keeping only the name of the variable. Mostly gets rid of / and a possible path behind.
|
||
real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` Allows to interpret a variable contained in a variable.
|
||
if test -z "$real_var" || [ "$real_var" = "/" ]; then
|
||
echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2
|
||
return 1
|
||
fi
|
||
chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # Replaces variable with its value in the string.
|
||
done
|
||
if [ "$no_var" -eq 1 ]
|
||
then
|
||
if [ -e "$chaine" ]; then
|
||
echo "Delete directory $chaine"
|
||
sudo rm -r "$chaine"
|
||
fi
|
||
return 0
|
||
else
|
||
echo "No detected variable." >&2
|
||
return 1
|
||
fi
|
||
}
|
||
|
||
|
||
# Check if a YunoHost user exists
|
||
#
|
||
# example: ynh_user_exists 'toto' || exit 1
|
||
#
|
||
# usage: ynh_user_exists username
|
||
# | arg: username - the username to check
|
||
ynh_user_exists() {
|
||
sudo yunohost user list --output-as json | grep -q "\"username\": \"${1}\""
|
||
}
|
||
|
||
# Retrieve a YunoHost user information
|
||
#
|
||
# example: mail=$(ynh_user_get_info 'toto' 'mail')
|
||
#
|
||
# usage: ynh_user_get_info username key
|
||
# | arg: username - the username to retrieve info from
|
||
# | arg: key - the key to retrieve
|
||
# | ret: string - the key's value
|
||
ynh_user_get_info() {
|
||
sudo yunohost user info "$1" --output-as plain | ynh_get_plain_key "$2"
|
||
}
|
||
|
||
# Get the list of YunoHost users
|
||
#
|
||
# example: for u in $(ynh_user_list); do ...
|
||
#
|
||
# usage: ynh_user_list
|
||
# | ret: string - one username per line
|
||
ynh_user_list() {
|
||
sudo yunohost user list --output-as plain --quiet \
|
||
| awk '/^##username$/{getline; print}'
|
||
}
|
||
|
||
# Check if a user exists on the system
|
||
#
|
||
# usage: ynh_system_user_exists username
|
||
# | arg: username - the username to check
|
||
ynh_system_user_exists() {
|
||
getent passwd "$1" &>/dev/null
|
||
}
|
||
|
||
# Create a system user
|
||
#
|
||
# usage: ynh_system_user_create user_name [home_dir]
|
||
# | arg: user_name - Name of the system user that will be create
|
||
# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home
|
||
ynh_system_user_create () {
|
||
if ! ynh_system_user_exists "$1" # Check if the user exists on the system
|
||
then # If the user doesn't exist
|
||
if [ $# -ge 2 ]; then # If a home dir is mentioned
|
||
user_home_dir="-d $2"
|
||
else
|
||
user_home_dir="--no-create-home"
|
||
fi
|
||
sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account"
|
||
fi
|
||
}
|
||
|
||
# Delete a system user
|
||
#
|
||
# usage: ynh_system_user_delete user_name
|
||
# | arg: user_name - Name of the system user that will be create
|
||
ynh_system_user_delete () {
|
||
if ynh_system_user_exists "$1" # Check if the user exists on the system
|
||
then
|
||
echo "Remove the user $1" >&2
|
||
sudo userdel $1
|
||
else
|
||
echo "The user $1 was not found" >&2
|
||
fi
|
||
}
|