You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
513 lines
18 KiB
513 lines
18 KiB
|
|
#=================================================
|
|
# COMMON VARIABLES
|
|
#=================================================
|
|
|
|
pkg_dependencies="php5-gd php5-json php5-intl php5-mcrypt php5-curl php5-apcu php5-redis php5-ldap php5-imagick imagemagick acl tar smbclient postgresql php-pgsql"
|
|
|
|
if [ "$(lsb_release --codename --short)" != "jessie" ]; then
|
|
pkg_dependencies="$pkg_dependencies php-zip php-apcu php-mbstring php-xml"
|
|
fi
|
|
|
|
#=================================================
|
|
# COMMON HELPERS
|
|
#=================================================
|
|
|
|
# Execute a command with occ
|
|
exec_occ() {
|
|
(cd "$final_path" && exec_as "$app" \
|
|
php occ --no-interaction --no-ansi "$@")
|
|
}
|
|
|
|
# Create the external storage for the given folders and enable sharing
|
|
create_external_storage() {
|
|
local datadir="$1"
|
|
local mount_name="$2"
|
|
local mount_id=`exec_occ files_external:create --output=json \
|
|
"$2" 'local' 'null::null' -c "datadir=$datadir" || true`
|
|
! [[ $mount_id =~ ^[0-9]+$ ]] \
|
|
&& echo "Unable to create external storage" >&2 \
|
|
|| exec_occ files_external:option "$mount_id" enable_sharing true
|
|
}
|
|
|
|
# Rename a MySQL database and user
|
|
# Usage: rename_mysql_db DBNAME DBUSER DBPASS NEW_DBNAME_AND_USER
|
|
rename_mysql_db() {
|
|
local db_name=$1 db_user=$2 db_pwd=$3 new_db_name=$4
|
|
local sqlpath="/tmp/${db_name}-$(date '+%s').sql"
|
|
|
|
# Dump the old database
|
|
mysqldump -u "$db_user" -p"$db_pwd" --no-create-db "$db_name" > "$sqlpath"
|
|
|
|
# Create the new database and user
|
|
ynh_mysql_create_db "$new_db_name" "$new_db_name" "$db_pwd"
|
|
ynh_mysql_connect_as "$new_db_name" "$db_pwd" "$new_db_name" < "$sqlpath"
|
|
|
|
# Remove the old database
|
|
ynh_mysql_remove_db $db_name $db_name
|
|
ynh_secure_remove "$sqlpath"
|
|
}
|
|
|
|
#=================================================
|
|
# COMMON HELPERS -- SHOULD BE ADDED TO YUNOHOST
|
|
#=================================================
|
|
|
|
# Execute a command as another user
|
|
# usage: exec_as USER COMMAND [ARG ...]
|
|
exec_as() {
|
|
local USER=$1
|
|
shift 1
|
|
|
|
if [[ $USER = $(whoami) ]]; then
|
|
eval "$@"
|
|
else
|
|
sudo -u "$USER" "$@"
|
|
fi
|
|
}
|
|
|
|
# Check if an URL is already handled
|
|
# usage: is_url_handled URL
|
|
is_url_handled() {
|
|
local output=($(curl -k -s -o /dev/null \
|
|
-w 'x%{redirect_url} %{http_code}' "$1"))
|
|
# It's handled if it does not redirect to the SSO nor return 404
|
|
[[ ! ${output[0]} =~ \/yunohost\/sso\/ && ${output[1]} != 404 ]]
|
|
}
|
|
|
|
# Make the main steps to migrate an app to its fork.
|
|
#
|
|
# This helper has to be used for an app which needs to migrate to a new name or a new fork
|
|
# (like owncloud to nextcloud or zerobin to privatebin).
|
|
#
|
|
# This helper will move the files of an app to its new name
|
|
# or recreate the things it can't move.
|
|
#
|
|
# To specify which files it has to move, you have to create a "migration file", stored in ../conf
|
|
# This file is a simple list of each file it has to move,
|
|
# except that file names must reference the $app variable instead of the real name of the app,
|
|
# and every instance-specific variables (like $domain).
|
|
# $app is especially important because it's this variable which will be used to identify the old place and the new one for each file.
|
|
#
|
|
# If a database exists for this app, it will be dumped and then imported in a newly created database, with a new name and new user.
|
|
# Don't forget you have to then apply these changes to application-specific settings (depends on the packaged application)
|
|
#
|
|
# Same things for an existing user, a new one will be created.
|
|
# But the old one can't be removed unless it's not used. See below.
|
|
#
|
|
# If you have some dependencies for your app, it's possible to change the fake debian package which manages them.
|
|
# You have to fill the $pkg_dependencies variable, and then a new fake package will be created and installed,
|
|
# and the old one will be removed.
|
|
# If you don't have a $pkg_dependencies variable, the helper can't know what the app dependencies are.
|
|
#
|
|
# The app settings.yml will be modified as follows:
|
|
# - finalpath will be changed according to the new name (but only if the existing $final_path contains the old app name)
|
|
# - The checksums of php-fpm and nginx config files will be updated too.
|
|
# - If there is a $db_name value, it will be changed.
|
|
# - And, of course, the ID will be changed to the new name too.
|
|
#
|
|
# Finally, the $app variable will take the value of the new name.
|
|
# The helper will set the $migration_process variable to 1 if a migration has been successfully handled.
|
|
#
|
|
# You have to handle by yourself all the migrations not done by this helper, like configuration or special values in settings.yml
|
|
# Also, at the end of the upgrade script, you have to add a post_migration script to handle all the things the helper can't do during YunoHost upgrade (mostly for permission reasons),
|
|
# especially remove the old user, move some hooks and remove the old configuration directory
|
|
# To launch this script, you have to move it elsewhere and start it after the upgrade script.
|
|
# `cp ../conf/$script_post_migration /tmp`
|
|
# `(cd /tmp; echo "/tmp/$script_post_migration" | at now + 2 minutes)`
|
|
#
|
|
# usage: ynh_handle_app_migration migration_id migration_list
|
|
# | arg: migration_id - ID from which to migrate
|
|
# | arg: migration_list - File specifying every file to move (one file per line)
|
|
ynh_handle_app_migration () {
|
|
#=================================================
|
|
# LOAD SETTINGS
|
|
#=================================================
|
|
|
|
old_app=$YNH_APP_INSTANCE_NAME
|
|
local old_app_id=$YNH_APP_ID
|
|
local old_app_number=$YNH_APP_INSTANCE_NUMBER
|
|
|
|
# Get the id from which to migrate
|
|
local migration_id="$1"
|
|
# And the file with the paths to move
|
|
local migration_list="$2"
|
|
|
|
# Get the new app id in the manifest
|
|
local new_app_id=$(grep \"id\": ../manifest.json | cut -d\" -f4)
|
|
if [ $old_app_number -eq 1 ]; then
|
|
local new_app=$new_app_id
|
|
else
|
|
local new_app=${new_app_id}__${old_app_number}
|
|
fi
|
|
|
|
#=================================================
|
|
# CHECK IF IT HAS TO MIGRATE
|
|
#=================================================
|
|
|
|
migration_process=0
|
|
|
|
if [ "$old_app_id" == "$new_app_id" ]
|
|
then
|
|
# If the 2 id are the same
|
|
# No migration to do.
|
|
echo 0
|
|
return 0
|
|
else
|
|
if [ "$old_app_id" != "$migration_id" ]
|
|
then
|
|
# If the new app is not the authorized id, fail.
|
|
ynh_die "Incompatible application for migration from $old_app_id to $new_app_id"
|
|
fi
|
|
|
|
echo "Migrate from $old_app_id to $new_app_id" >&2
|
|
|
|
#=================================================
|
|
# CHECK IF THE MIGRATION CAN BE DONE
|
|
#=================================================
|
|
|
|
# TODO Handle multi instance apps...
|
|
# Check that there is not already an app installed for this id.
|
|
(yunohost app list --installed -f "$new_app" | grep -q id) \
|
|
&& ynh_die "$new_app is already installed"
|
|
|
|
#=================================================
|
|
# CHECK THE LIST OF FILES TO MOVE
|
|
#=================================================
|
|
|
|
local temp_migration_list="$(tempfile)"
|
|
|
|
# Build the list by removing blank lines and comment lines
|
|
sed '/^#.*\|^$/d' "../conf/$migration_list" > "$temp_migration_list"
|
|
|
|
# Check if there is no file in the destination
|
|
local file_to_move=""
|
|
while read file_to_move
|
|
do
|
|
# Replace all occurences of $app by $new_app in each file to move.
|
|
local move_to_destination="${file_to_move//\$app/$new_app}"
|
|
test -e "$move_to_destination" && ynh_die "A file named $move_to_destination already exists."
|
|
done < "$temp_migration_list"
|
|
|
|
#=================================================
|
|
# COPY YUNOHOST SETTINGS FOR THIS APP
|
|
#=================================================
|
|
|
|
local settings_dir="/etc/yunohost/apps"
|
|
cp -a "$settings_dir/$old_app" "$settings_dir/$new_app"
|
|
|
|
# Replace the old id by the new one
|
|
ynh_replace_string "\(^id: .*\)$old_app" "\1$new_app" "$settings_dir/$new_app/settings.yml"
|
|
# INFO: There a special behavior with yunohost app setting:
|
|
# if the id given in argument does not match with the id
|
|
# stored in the config file, the config file will be purged.
|
|
# That's why we use sed instead of app setting here.
|
|
# https://github.com/YunoHost/yunohost/blob/c6b5284be8da39cf2da4e1036a730eb5e0515096/src/yunohost/app.py#L1316-L1321
|
|
|
|
# Change the label if it's simply the name of the app
|
|
old_label=$(ynh_app_setting_get $new_app label)
|
|
if [ "${old_label,,}" == "$old_app_id" ]
|
|
then
|
|
# Build the new label from the id of the app. With the first character as upper case
|
|
new_label=$(echo $new_app_id | cut -c1 | tr [:lower:] [:upper:])$(echo $new_app_id | cut -c2-)
|
|
ynh_app_setting_set $new_app label $new_label
|
|
fi
|
|
|
|
#=================================================
|
|
# MOVE FILES TO THE NEW DESTINATION
|
|
#=================================================
|
|
|
|
while read file_to_move
|
|
do
|
|
# Replace all occurence of $app by $new_app in each file to move.
|
|
move_to_destination="$(eval echo "${file_to_move//\$app/$new_app}")"
|
|
local real_file_to_move="$(eval echo "${file_to_move//\$app/$old_app}")"
|
|
echo "Move file $real_file_to_move to $move_to_destination" >&2
|
|
mv "$real_file_to_move" "$move_to_destination"
|
|
done < "$temp_migration_list"
|
|
|
|
#=================================================
|
|
# UPDATE SETTINGS KNOWN ENTRIES
|
|
#=================================================
|
|
|
|
# Replace nginx checksum
|
|
ynh_replace_string "\(^checksum__etc_nginx.*\)_$old_app" "\1_$new_app/" "$settings_dir/$new_app/settings.yml"
|
|
|
|
# Replace php5-fpm checksums
|
|
ynh_replace_string "\(^checksum__etc_php5.*[-_]\)$old_app" "\1$new_app/" "$settings_dir/$new_app/settings.yml"
|
|
|
|
# Replace final_path
|
|
ynh_replace_string "\(^final_path: .*\)$old_app" "\1$new_app" "$settings_dir/$new_app/settings.yml"
|
|
|
|
#=================================================
|
|
# MOVE THE DATABASE
|
|
#=================================================
|
|
|
|
db_pwd=$(ynh_app_setting_get $old_app mysqlpwd)
|
|
db_name=$(ynh_app_setting_get $old_app db_name)
|
|
|
|
# Check if a database exists before trying to move it
|
|
local mysql_root_password=$(cat $MYSQL_ROOT_PWD_FILE)
|
|
if [ -n "$db_name" ] && mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"
|
|
then
|
|
new_db_name=$(ynh_sanitize_dbid $new_app)
|
|
echo "Rename the database $db_name to $new_db_name" >&2
|
|
|
|
local sql_dump="/tmp/${db_name}-$(date '+%s').sql"
|
|
|
|
# Dump the old database
|
|
ynh_mysql_dump_db "$db_name" > "$sql_dump"
|
|
|
|
# Create a new database
|
|
ynh_mysql_setup_db $new_db_name $new_db_name $db_pwd
|
|
# Then restore the old one into the new one
|
|
ynh_mysql_connect_as $new_db_name $db_pwd $new_db_name < "$sql_dump"
|
|
|
|
# Remove the old database
|
|
ynh_mysql_remove_db $db_name $db_name
|
|
# And the dump
|
|
ynh_secure_remove "$sql_dump"
|
|
|
|
# Update the value of $db_name
|
|
db_name=$new_db_name
|
|
ynh_app_setting_set $new_app db_name $db_name
|
|
fi
|
|
|
|
#=================================================
|
|
# CREATE A NEW USER
|
|
#=================================================
|
|
|
|
# Check if the user exists on the system
|
|
if ynh_system_user_exists "$old_app"
|
|
then
|
|
echo "Create a new user $new_app to replace $old_app" >&2
|
|
ynh_system_user_create $new_app
|
|
fi
|
|
|
|
#=================================================
|
|
# CHANGE THE FAKE DEPENDENCIES PACKAGE
|
|
#=================================================
|
|
|
|
# Check if a variable $pkg_dependencies exists
|
|
# If this variable doesn't exist, this part shall be managed in the upgrade script.
|
|
if [ -n "${pkg_dependencies:-}" ]
|
|
then
|
|
# Define the name of the package
|
|
local old_package_name="${old_app//_/-}-ynh-deps"
|
|
local new_package_name="${new_app//_/-}-ynh-deps"
|
|
|
|
if ynh_package_is_installed "$old_package_name"
|
|
then
|
|
# Install a new fake package
|
|
app=$new_app
|
|
ynh_install_app_dependencies $pkg_dependencies
|
|
# Then remove the old one
|
|
app=$old_app
|
|
ynh_remove_app_dependencies
|
|
fi
|
|
fi
|
|
|
|
#=================================================
|
|
# UPDATE THE ID OF THE APP
|
|
#=================================================
|
|
|
|
app=$new_app
|
|
|
|
|
|
# Set migration_process to 1 to inform that an upgrade has been made
|
|
migration_process=1
|
|
fi
|
|
}
|
|
|
|
|
|
#=================================================
|
|
# EXPERIMENTAL HELPERS
|
|
#=================================================
|
|
#=================================================
|
|
# YUNOHOST MULTIMEDIA INTEGRATION
|
|
#=================================================
|
|
|
|
# Install or update the main directory yunohost.multimedia
|
|
#
|
|
# usage: ynh_multimedia_build_main_dir
|
|
ynh_multimedia_build_main_dir () {
|
|
local ynh_media_release="v1.0"
|
|
local checksum="4852c8607db820ad51f348da0dcf0c88"
|
|
|
|
# Download yunohost.multimedia scripts
|
|
wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz
|
|
|
|
# Verify checksum
|
|
echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \
|
|
|| ynh_die "Corrupt source"
|
|
|
|
# Extract
|
|
mkdir yunohost.multimedia-master
|
|
tar -xf ${ynh_media_release}.tar.gz -C yunohost.multimedia-master --strip-components 1
|
|
./yunohost.multimedia-master/script/ynh_media_build.sh
|
|
}
|
|
|
|
# Grant write access to multimedia directories to a specified user
|
|
#
|
|
# usage: ynh_multimedia_addaccess user_name
|
|
#
|
|
# | arg: user_name - User to be granted write access
|
|
ynh_multimedia_addaccess () {
|
|
local user_name=$1
|
|
groupadd -f multimedia
|
|
usermod -a -G multimedia $user_name
|
|
}
|
|
|
|
#=================================================
|
|
# POSTGRESQL HELPERS
|
|
#=================================================
|
|
|
|
# Create a master password and set up global settings
|
|
# Please always call this script in install and restore scripts
|
|
#
|
|
# usage: ynh_psql_test_if_first_run
|
|
ynh_psql_test_if_first_run() {
|
|
if [ -f /etc/yunohost/psql ];
|
|
then
|
|
echo "PostgreSQL is already installed, no need to create master password"
|
|
else
|
|
pgsql=$(ynh_string_random)
|
|
pg_hba=""
|
|
echo "$pgsql" >> /etc/yunohost/psql
|
|
|
|
if [ -e /etc/postgresql/9.4/ ]
|
|
then
|
|
pg_hba=/etc/postgresql/9.4/main/pg_hba.conf
|
|
elif [ -e /etc/postgresql/9.6/ ]
|
|
then
|
|
pg_hba=/etc/postgresql/9.6/main/pg_hba.conf
|
|
else
|
|
ynh_die "postgresql shoud be 9.4 or 9.6"
|
|
fi
|
|
|
|
systemctl start postgresql
|
|
sudo --login --user=postgres psql -c"ALTER user postgres WITH PASSWORD '$pgsql'" postgres
|
|
|
|
# force all user to connect to local database using passwords
|
|
# https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html#EXAMPLE-PG-HBA.CONF
|
|
# Note: we can't use peer since YunoHost create users with nologin
|
|
# See: https://github.com/YunoHost/yunohost/blob/unstable/data/helpers.d/user
|
|
sed -i '/local\s*all\s*all\s*peer/i \
|
|
local all all password' "$pg_hba"
|
|
systemctl enable postgresql
|
|
systemctl reload postgresql
|
|
fi
|
|
}
|
|
|
|
# Open a connection as a user
|
|
#
|
|
# example: ynh_psql_connect_as 'user' 'pass' <<< "UPDATE ...;"
|
|
# example: ynh_psql_connect_as 'user' 'pass' < /path/to/file.sql
|
|
#
|
|
# usage: ynh_psql_connect_as user pwd [db]
|
|
# | arg: user - the user name to connect as
|
|
# | arg: pwd - the user password
|
|
# | arg: db - the database to connect to
|
|
ynh_psql_connect_as() {
|
|
user="$1"
|
|
pwd="$2"
|
|
db="$3"
|
|
sudo --login --user=postgres PGUSER="$user" PGPASSWORD="$pwd" psql "$db"
|
|
}
|
|
|
|
# # Execute a command as root user
|
|
#
|
|
# usage: ynh_psql_execute_as_root sql [db]
|
|
# | arg: sql - the SQL command to execute
|
|
# | arg: db - the database to connect to
|
|
ynh_psql_execute_as_root () {
|
|
sql="$1"
|
|
sudo --login --user=postgres psql <<< "$sql"
|
|
}
|
|
|
|
# Execute a command from a file as root user
|
|
#
|
|
# usage: ynh_psql_execute_file_as_root file [db]
|
|
# | arg: file - the file containing SQL commands
|
|
# | arg: db - the database to connect to
|
|
ynh_psql_execute_file_as_root() {
|
|
file="$1"
|
|
db="$2"
|
|
sudo --login --user=postgres psql "$db" < "$file"
|
|
}
|
|
|
|
# Create a database, an user and its password. Then store the password in the app's config
|
|
#
|
|
# After executing this helper, the password of the created database will be available in $db_pwd
|
|
# It will also be stored as "psqlpwd" into the app settings.
|
|
#
|
|
# usage: ynh_psql_setup_db user name [pwd]
|
|
# | arg: user - Owner of the database
|
|
# | arg: name - Name of the database
|
|
# | arg: pwd - Password of the database. If not given, a password will be generated
|
|
ynh_psql_setup_db () {
|
|
db_user="$1"
|
|
db_name="$2"
|
|
new_db_pwd=$(ynh_string_random) # Generate a random password
|
|
# If $3 is not given, use new_db_pwd instead for db_pwd.
|
|
db_pwd="${3:-$new_db_pwd}"
|
|
ynh_psql_create_db "$db_name" "$db_user" "$db_pwd" # Create the database
|
|
ynh_app_setting_set "$app" psqlpwd "$db_pwd" # Store the password in the app's config
|
|
}
|
|
|
|
# Create a database and grant privilegies to a user
|
|
#
|
|
# usage: ynh_psql_create_db db [user [pwd]]
|
|
# | arg: db - the database name to create
|
|
# | arg: user - the user to grant privilegies
|
|
# | arg: pwd - the user password
|
|
ynh_psql_create_db() {
|
|
db="$1"
|
|
user="$2"
|
|
pwd="$3"
|
|
ynh_psql_create_user "$user" "$pwd"
|
|
sudo --login --user=postgres createdb --owner="$user" "$db"
|
|
}
|
|
|
|
# Drop a database
|
|
#
|
|
# usage: ynh_psql_drop_db db
|
|
# | arg: db - the database name to drop
|
|
# | arg: user - the user to drop
|
|
ynh_psql_remove_db() {
|
|
db="$1"
|
|
user="$2"
|
|
sudo --login --user=postgres dropdb "$db"
|
|
ynh_psql_drop_user "$user"
|
|
}
|
|
|
|
# Dump a database
|
|
#
|
|
# example: ynh_psql_dump_db 'roundcube' > ./dump.sql
|
|
#
|
|
# usage: ynh_psql_dump_db db
|
|
# | arg: db - the database name to dump
|
|
# | ret: the psqldump output
|
|
ynh_psql_dump_db() {
|
|
db="$1"
|
|
sudo --login --user=postgres pg_dump "$db"
|
|
}
|
|
|
|
|
|
# Create a user
|
|
#
|
|
# usage: ynh_psql_create_user user pwd [host]
|
|
# | arg: user - the user name to create
|
|
ynh_psql_create_user() {
|
|
user="$1"
|
|
pwd="$2"
|
|
sudo --login --user=postgres psql -c"CREATE USER $user WITH PASSWORD '$pwd'" postgres
|
|
}
|
|
|
|
# Drop a user
|
|
#
|
|
# usage: ynh_psql_drop_user user
|
|
# | arg: user - the user name to drop
|
|
ynh_psql_drop_user() {
|
|
user="$1"
|
|
sudo --login --user=postgres dropuser "$user"
|
|
}
|