YunoHost-Apps/z-push_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/z-push_ynh.git synced 2024-09-03 18:05:58 +02:00
Code Issues Activity Actions

v2

Browse source
This commit is contained in:
Éric Gaspar 2023-11-02 21:43:27 +01:00
parent 5a20347262
commit 366ed99d99
10 changed files with 211 additions and 170 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
conf/app.src
View file

@ -1,7 +0,0 @@
SOURCE_URL=https://github.com/Z-Hub/Z-Push/archive/2.7.1.tar.gz
SOURCE_SUM=7aadddb5da06494a35c79e4b70d6ade6b2f62203f3df343077731f8952b64a41
SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true
SOURCE_FILENAME=
SOURCE_EXTRACT=true

2
conf/config.php
View file

@ -65,7 +65,7 @@
* State migration script is available, more informations: https://wiki.z-hub.io/x/xIAa * State migration script is available, more informations: https://wiki.z-hub.io/x/xIAa
*/ */
define('STATE_MACHINE', 'FILE'); define('STATE_MACHINE', 'FILE');
define('STATE_DIR', '__DATADIR__/'); define('STATE_DIR', '__DATA_DIR__/');
/********************************************************************************** /**********************************************************************************
* IPC - InterProcessCommunication * IPC - InterProcessCommunication

8
conf/nginx.conf
View file

@ -2,7 +2,7 @@
location /Microsoft-Server-ActiveSync { location /Microsoft-Server-ActiveSync {
# Path to source # Path to source
alias __FINALPATH__/; alias __INSTALL_DIR__/;
index index.php; index index.php;
@ -27,7 +27,7 @@ location /Microsoft-Server-ActiveSync {
} }
location /AutoDiscover/AutoDiscover.xml { location /AutoDiscover/AutoDiscover.xml {
alias __FINALPATH__/autodiscover/autodiscover.php; alias __INSTALL_DIR__/autodiscover/autodiscover.php;
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
include fastcgi_params; include fastcgi_params;
fastcgi_param HTTPS on; fastcgi_param HTTPS on;
@ -35,7 +35,7 @@ location /AutoDiscover/AutoDiscover.xml {
} }
location /Autodiscover/Autodiscover.xml { location /Autodiscover/Autodiscover.xml {
alias __FINALPATH__/autodiscover/autodiscover.php; alias __INSTALL_DIR__/autodiscover/autodiscover.php;
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
include fastcgi_params; include fastcgi_params;
fastcgi_param HTTPS on; fastcgi_param HTTPS on;
@ -43,7 +43,7 @@ location /Autodiscover/Autodiscover.xml {
} }
location /autodiscover/autodiscover.xml { location /autodiscover/autodiscover.xml {
alias __FINALPATH__/autodiscover/autodiscover.php; alias __INSTALL_DIR__/autodiscover/autodiscover.php;
fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock; fastcgi_pass unix:/var/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
include fastcgi_params; include fastcgi_params;
fastcgi_param HTTPS on; fastcgi_param HTTPS on;

48
manifest.toml Normal file
View file

@ -0,0 +1,48 @@
packaging_format = 2
id = "z-push"
name = "Z-Push"
description.en = "ActiveSync frontend that helps you synchronize emails, calendar and contacts"
description.fr = "Frontend ActiveSync qui permet de synchroniser emails, calendrier et contacts"
version = "2.7.1~ynh1"
maintainers = ["yalh76"]
[upstream]
license = "AGPL-3.0-or-later"
website = "http://z-push.org"
admindoc = "https://wiki.z-hub.io/display/ZP/Documentation"
code = "https://github.com/Z-Hub/Z-Push"
cpe = "???" # FIXME: optional but recommended if relevant, this is meant to contain the Common Platform Enumeration, which is sort of a standard id for applications defined by the NIST. In particular, Yunohost may use this is in the future to easily track CVE (=security reports) related to apps. The CPE may be obtained by searching here: https://nvd.nist.gov/products/cpe/search. For example, for Nextcloud, the CPE is 'cpe:2.3:a:nextcloud:nextcloud' (no need to include the version number)
fund = "???" # FIXME: optional but recommended (or remove if irrelevant / not applicable). This is meant to be an URL where people can financially support this app, especially when its development is based on volunteers and/or financed by its community. YunoHost may later advertise it in the webadmin.
[integration]
yunohost = ">= 11.0.9"
architectures = "all" # FIXME: can be replaced by a list of supported archs using the dpkg --print-architecture nomenclature (amd64/i386/armhf/arm64), for example: ["amd64", "i386"]
multi_instance = true
ldap = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "sso" key : the "ldap" key corresponds to wether or not a user *can* login on the app using its YunoHost credentials.
sso = "?" # FIXME: replace with true, false, or "not_relevant". Not to confuse with the "ldap" key : the "sso" key corresponds to wether or not a user is *automatically logged-in* on the app when logged-in on the YunoHost portal.
disk = "50M" # FIXME: replace with an **estimate** minimum disk requirement. e.g. 20M, 400M, 1G, ...
ram.build = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
ram.runtime = "50M" # FIXME: replace with an **estimate** minimum ram requirement. e.g. 50M, 400M, 1G, ...
[install.domain]
# this is a generic question - ask strings are automatically handled by Yunohost's core
type = "domain"
full_domain = true
[resources]
[resources.sources.main]
url = "https://github.com/Z-Hub/Z-Push/archive/2.7.1.tar.gz"
sha256 = "7aadddb5da06494a35c79e4b70d6ade6b2f62203f3df343077731f8952b64a41"
[resources.system_user]
[resources.install_dir]
[resources.data_dir]
[resources.permissions]
main.url = "/"

6
scripts/_common.sh
View file

@ -4,12 +4,12 @@
# COMMON VARIABLES # COMMON VARIABLES
#================================================= #=================================================
YNH_PHP_VERSION="7.4" #REMOVEME? YNH_PHP_VERSION="7.4"
php_dependencies="php${YNH_PHP_VERSION}-soap php${YNH_PHP_VERSION}-imap php${YNH_PHP_VERSION}-xsl php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-memcached" #REMOVEME? php_dependencies="php${YNH_PHP_VERSION}-soap php${YNH_PHP_VERSION}-imap php${YNH_PHP_VERSION}-xsl php${YNH_PHP_VERSION}-curl php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-cli php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-memcached"
# dependencies used by the app (must be on a single line) # dependencies used by the app (must be on a single line)
pkg_dependencies="libawl-php $php_dependencies" #REMOVEME? pkg_dependencies="libawl-php $php_dependencies"
#================================================= #=================================================

20
scripts/backup
View file

@ -14,24 +14,24 @@ source /usr/share/yunohost/helpers
# MANAGE SCRIPT FAILURE # MANAGE SCRIPT FAILURE
#================================================= #=================================================
ynh_clean_setup () { #REMOVEME? ynh_clean_setup () {
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
ynh_abort_if_errors #REMOVEME? ynh_abort_if_errors
#================================================= #=================================================
# LOAD SETTINGS # LOAD SETTINGS
#================================================= #=================================================
ynh_print_info --message="Loading settings..." ynh_print_info --message="Loading settings..."
app=$YNH_APP_INSTANCE_NAME #REMOVEME? app=$YNH_APP_INSTANCE_NAME
final_path=$(ynh_app_setting_get --app=$app --key=final_path) #REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
domain=$(ynh_app_setting_get --app=$app --key=domain) #REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
datadir=$(ynh_app_setting_get --app=$app --key=datadir) #REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath) #REMOVEME? final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath)
#================================================= #=================================================
# DECLARE DATA AND CONF FILES TO BACKUP # DECLARE DATA AND CONF FILES TO BACKUP
@ -42,13 +42,13 @@ ynh_print_info --message="Declaring files to be backed up..."
# BACKUP THE APP MAIN DIR # BACKUP THE APP MAIN DIR
#================================================= #=================================================
ynh_backup --src_path="$final_path" ynh_backup --src_path="$install_dir"
#================================================= #=================================================
# BACKUP THE DATA DIR # BACKUP THE DATA DIR
#================================================= #=================================================
ynh_backup --src_path="$datadir" --is_big ynh_backup --src_path="$data_dir" --is_big
#================================================= #=================================================
# BACKUP THE NGINX CONFIGURATION # BACKUP THE NGINX CONFIGURATION

114
scripts/install
View file

@ -13,75 +13,75 @@ source /usr/share/yunohost/helpers
# MANAGE SCRIPT FAILURE # MANAGE SCRIPT FAILURE
#================================================= #=================================================
ynh_clean_setup () { #REMOVEME? ynh_clean_setup () {
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
ynh_abort_if_errors #REMOVEME? ynh_abort_if_errors
#================================================= #=================================================
# RETRIEVE ARGUMENTS FROM THE MANIFEST # RETRIEVE ARGUMENTS FROM THE MANIFEST
#================================================= #=================================================
domain=$YNH_APP_ARG_DOMAIN #REMOVEME? domain=$YNH_APP_ARG_DOMAIN
path_url="/Microsoft-Server-ActiveSync" path="/Microsoft-Server-ActiveSync"
app=$YNH_APP_INSTANCE_NAME #REMOVEME? app=$YNH_APP_INSTANCE_NAME
#================================================= #=================================================
# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS # CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS
#================================================= #=================================================
ynh_script_progression --message="Validating installation parameters..." --weight=1 #REMOVEME? ynh_script_progression --message="Validating installation parameters..." --weight=1
final_path=/var/www/$app #REMOVEME? install_dir=/var/www/$app
test ! -e "$final_path" || ynh_die --message="This path already contains a folder" #REMOVEME? test ! -e "$install_dir" || ynh_die --message="This path already contains a folder"
# Register (book) web path # Register (book) web path
ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url #REMOVEME? ynh_webpath_register --app=$app --domain=$domain --path=$path
#================================================= #=================================================
# STORE SETTINGS FROM MANIFEST # STORE SETTINGS FROM MANIFEST
#================================================= #=================================================
ynh_script_progression --message="Storing installation settings..." --weight=1 #REMOVEME? ynh_script_progression --message="Storing installation settings..." --weight=1
ynh_app_setting_set --app=$app --key=domain --value=$domain #REMOVEME? ynh_app_setting_set --app=$app --key=domain --value=$domain
ynh_app_setting_set --app=$app --key=path --value=$path_url #REMOVEME? ynh_app_setting_set --app=$app --key=path --value=$path
#================================================= #=================================================
# STANDARD MODIFICATIONS # STANDARD MODIFICATIONS
#================================================= #=================================================
# INSTALL DEPENDENCIES # INSTALL DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Installing dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_script_progression --message="Installing dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_script_progression --message="Installing dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_script_progression --message="Installing dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Installing dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies #REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# CREATE DEDICATED USER # CREATE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Configuring system user..." --weight=1 #REMOVEME? ynh_script_progression --message="Configuring system user..." --weight=1
# Create a system user # Create a system user
ynh_system_user_create --username=$app --home_dir="$final_path" #REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
#================================================= #=================================================
ynh_script_progression --message="Setting up source files..." --weight=1 ynh_script_progression --message="Setting up source files..." --weight=1
ynh_app_setting_set --app=$app --key=final_path --value=$final_path #REMOVEME? ynh_app_setting_set --app=$app --key=install_dir --value=$install_dir
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
mkdir -p "$final_path/tmp" mkdir -p "$install_dir/tmp"
ynh_setup_source --dest_dir="$final_path/tmp" ynh_setup_source --dest_dir="$install_dir/tmp"
cp -af "$final_path/tmp/src/." "$final_path/." cp -af "$install_dir/tmp/src/." "$install_dir/."
ynh_secure_remove "$final_path/tmp" #REMOVEME? ynh_secure_remove "$install_dir/tmp"
chmod 750 "$final_path" chmod 750 "$install_dir"
chmod -R o-rwx "$final_path" chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$final_path" chown -R $app:www-data "$install_dir"
#================================================= #=================================================
# PHP-FPM CONFIGURATION # PHP-FPM CONFIGURATION
@ -90,7 +90,7 @@ ynh_script_progression --message="Configuring PHP-FPM..." --weight=1
# Create a dedicated PHP-FPM config # Create a dedicated PHP-FPM config
ynh_add_fpm_config --usage=low --footprint=low ynh_add_fpm_config --usage=low --footprint=low
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
@ -107,14 +107,14 @@ ynh_add_nginx_config
#================================================= #=================================================
ynh_script_progression --message="Creating a data directory..." --weight=1 ynh_script_progression --message="Creating a data directory..." --weight=1
datadir=/home/yunohost.app/$app #REMOVEME? data_dir=/home/yunohost.app/$app
ynh_app_setting_set --app=$app --key=datadir --value=$datadir #REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
mkdir -p $datadir mkdir -p $data_dir
chmod 750 "$datadir" chmod 750 "$data_dir"
chmod -R o-rwx "$datadir" chmod -R o-rwx "$data_dir"
chown -R $app:www-data "$datadir" chown -R $app:www-data "$data_dir"
#================================================= #=================================================
# CREATE FINAL LOG PATH # CREATE FINAL LOG PATH
@ -122,7 +122,7 @@ chown -R $app:www-data "$datadir"
ynh_script_progression --message="Creating a final log path..." --weight=1 ynh_script_progression --message="Creating a final log path..." --weight=1
final_logpath="/var/log/$app" final_logpath="/var/log/$app"
ynh_app_setting_set --app=$app --key=final_logpath --value=$final_logpath #REMOVEME? ynh_app_setting_set --app=$app --key=final_logpath --value=$final_logpath
mkdir -p $final_logpath mkdir -p $final_logpath
@ -143,13 +143,13 @@ ynh_replace_string --match_string="__FINAL_LOGPATH__" --replace_string=$final_lo
# Storage of state_dir in /home/yunohost.app # Storage of state_dir in /home/yunohost.app
# This contains the sync status in between device and z-push # This contains the sync status in between device and z-push
ynh_replace_string --match_string="__DATADIR__" --replace_string=$datadir --target_file="../conf/config.php" ynh_replace_string --match_string="__DATA_DIR__" --replace_string=$data_dir --target_file="../conf/config.php"
# Enable caldav carddav support # Enable caldav carddav support
if yunohost app list | grep -q 'id: baikal' ; then if yunohost app list | grep -q 'id: baikal' ; then
echo "Detected Baikal" echo "Detected Baikal"
bailkaldomain=$(ynh_app_setting_get --app="baikal" --key=domain) #REMOVEME? bailkaldomain=$(ynh_app_setting_get --app="baikal" --key=domain)
bailkalpath=$(ynh_app_setting_get --app="baikal" --key=path) #REMOVEME? bailkalpath=$(ynh_app_setting_get --app="baikal" --key=path)
bailkalpath=${bailkalpath%/} bailkalpath=${bailkalpath%/}
# Configuration of backend # Configuration of backend
@ -169,15 +169,15 @@ if yunohost app list | grep -q 'id: baikal' ; then
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-caldav.php $final_path/backend/caldav/config.php cp -af ../conf/backend/config-caldav.php $install_dir/backend/caldav/config.php
cp -af ../conf/backend/config-carddav.php $final_path/backend/carddav/config.php cp -af ../conf/backend/config-carddav.php $install_dir/backend/carddav/config.php
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
cp -af ../conf/backend/config-combined.php $final_path/backend/combined/config.php cp -af ../conf/backend/config-combined.php $install_dir/backend/combined/config.php
elif yunohost app list | grep -q 'id: nextcloud' ; then elif yunohost app list | grep -q 'id: nextcloud' ; then
echo "Detected NextCloud" echo "Detected NextCloud"
nextclouddomain=$(ynh_app_setting_get --app="nextcloud" --key=domain) #REMOVEME? nextclouddomain=$(ynh_app_setting_get --app="nextcloud" --key=domain)
nextcloudpath=$(ynh_app_setting_get --app="nextcloud" --key=path) #REMOVEME? nextcloudpath=$(ynh_app_setting_get --app="nextcloud" --key=path)
nextcloudpath=${nextcloudpath%/} nextcloudpath=${nextcloudpath%/}
# Configuration of backend # Configuration of backend
@ -197,10 +197,10 @@ elif yunohost app list | grep -q 'id: nextcloud' ; then
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-caldav.php $final_path/backend/caldav/config.php cp -af ../conf/backend/config-caldav.php $install_dir/backend/caldav/config.php
cp -af ../conf/backend/config-carddav.php $final_path/backend/carddav/config.php cp -af ../conf/backend/config-carddav.php $install_dir/backend/carddav/config.php
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
cp -af ../conf/backend/config-combined.php $final_path/backend/combined/config.php cp -af ../conf/backend/config-combined.php $install_dir/backend/combined/config.php
else else
# Configuration of backend # Configuration of backend
ynh_replace_string --match_string="__BACKEND__" --replace_string="BackendIMAP" --target_file="../conf/config.php" ynh_replace_string --match_string="__BACKEND__" --replace_string="BackendIMAP" --target_file="../conf/config.php"
@ -211,13 +211,13 @@ else
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="false" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="false" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
fi fi
# Copy config # Copy config
cp -af ../conf/config.php $final_path/config.php cp -af ../conf/config.php $install_dir/config.php
cp -af ../conf/backend/config-autodiscover.php $final_path/autodiscover/config.php cp -af ../conf/backend/config-autodiscover.php $install_dir/autodiscover/config.php
cp -af ../conf/backend/config-searchldap.php $final_path/backend/searchldap/config.php cp -af ../conf/backend/config-searchldap.php $install_dir/backend/searchldap/config.php
#Copy XMLElement.php #Copy XMLElement.php
ln -s /usr/share/awl/inc/XML* /var/www/$app/include/ ln -s /usr/share/awl/inc/XML* /var/www/$app/include/
@ -235,20 +235,20 @@ ynh_use_logrotate
#================================================= #=================================================
# SETUP SSOWAT # SETUP SSOWAT
#================================================= #=================================================
ynh_script_progression --message="Configuring permissions..." --weight=1 #REMOVEME? ynh_script_progression --message="Configuring permissions..." --weight=1
# Make app public # Make app public
ynh_permission_update --permission="main" --add="visitors" #REMOVEME? ynh_permission_update --permission="main" --add="visitors"
domain_regex=$(echo "$domain" | sed 's@-@.@g') domain_regex=$(echo "$domain" | sed 's@-@.@g')
ynh_permission_create --permission="autodiscover" --url="re:$domain_regex/[Aa]uto[Dd]iscover/.*" --allowed="visitors" --show_tile="false" --protected="true" #REMOVEME? ynh_permission_create --permission="autodiscover" --url="re:$domain_regex/[Aa]uto[Dd]iscover/.*" --allowed="visitors" --show_tile="false" --protected="true"
#================================================= #=================================================
# RELOAD NGINX # RELOAD NGINX
#================================================= #=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1 #REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

24
scripts/remove
View file

@ -14,12 +14,12 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_script_progression --message="Loading settings..." --weight=1 ynh_script_progression --message="Loading settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME #REMOVEME? app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain) #REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
final_path=$(ynh_app_setting_get --app=$app --key=final_path) #REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
datadir=$(ynh_app_setting_get --app=$app --key=datadir) #REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath) #REMOVEME? final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath)
#================================================= #=================================================
# STANDARD REMOVE # STANDARD REMOVE
@ -34,10 +34,10 @@ ynh_remove_logrotate
#================================================= #=================================================
# REMOVE APP MAIN DIR # REMOVE APP MAIN DIR
#================================================= #=================================================
ynh_script_progression --message="Removing app main directory..." --weight=1 #REMOVEME? ynh_script_progression --message="Removing app main directory..." --weight=1
# Remove the app directory securely # Remove the app directory securely
ynh_secure_remove --file="$final_path" #REMOVEME? ynh_secure_remove --file="$install_dir"
#================================================= #=================================================
# REMOVE DATA DIR # REMOVE DATA DIR
@ -47,7 +47,7 @@ ynh_secure_remove --file="$final_path"
if [ "${YNH_APP_PURGE:-0}" -eq 1 ] if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
then then
ynh_script_progression --message="Removing app data directory..." --weight=1 ynh_script_progression --message="Removing app data directory..." --weight=1
ynh_secure_remove --file="$datadir" #REMOVEME? ynh_secure_remove --file="$data_dir"
fi fi
#================================================= #=================================================
@ -69,10 +69,10 @@ ynh_remove_fpm_config
#================================================= #=================================================
# REMOVE DEPENDENCIES # REMOVE DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Removing dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Removing dependencies..." --weight=1
# Remove metapackage and its dependencies # Remove metapackage and its dependencies
ynh_remove_app_dependencies #REMOVEME? ynh_remove_app_dependencies
#================================================= #=================================================
# SPECIFIC REMOVE # SPECIFIC REMOVE
@ -88,10 +88,10 @@ ynh_secure_remove --file="$final_logpath"
#================================================= #=================================================
# REMOVE DEDICATED USER # REMOVE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Removing the dedicated system user..." --weight=1 #REMOVEME? ynh_script_progression --message="Removing the dedicated system user..." --weight=1
# Delete a system user # Delete a system user
ynh_system_user_delete --username=$app #REMOVEME? ynh_system_user_delete --username=$app
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT

52
scripts/restore
View file

@ -14,77 +14,77 @@ source /usr/share/yunohost/helpers
# MANAGE SCRIPT FAILURE # MANAGE SCRIPT FAILURE
#================================================= #=================================================
ynh_clean_setup () { #REMOVEME? ynh_clean_setup () {
true true
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
ynh_abort_if_errors #REMOVEME? ynh_abort_if_errors
#================================================= #=================================================
# LOAD SETTINGS # LOAD SETTINGS
#================================================= #=================================================
ynh_script_progression --message="Loading settings..." --weight=1 ynh_script_progression --message="Loading settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME #REMOVEME? app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain) #REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path) #REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path) #REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
datadir=$(ynh_app_setting_get --app=$app --key=datadir) #REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath) #REMOVEME? final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath)
#================================================= #=================================================
# CHECK IF THE APP CAN BE RESTORED # CHECK IF THE APP CAN BE RESTORED
#================================================= #=================================================
ynh_script_progression --message="Validating restoration parameters..." --weight=1 #REMOVEME? ynh_script_progression --message="Validating restoration parameters..." --weight=1
test ! -d $final_path \ #REMOVEME? test ! -d $install_dir \
|| ynh_die --message="There is already a directory: $final_path " || ynh_die --message="There is already a directory: $install_dir "
#================================================= #=================================================
# STANDARD RESTORATION STEPS # STANDARD RESTORATION STEPS
#================================================= #=================================================
# RECREATE THE DEDICATED USER # RECREATE THE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 #REMOVEME? ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
# Create the dedicated user (if not existing) # Create the dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path" #REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
#================================================= #=================================================
# RESTORE THE APP MAIN DIR # RESTORE THE APP MAIN DIR
#================================================= #=================================================
ynh_script_progression --message="Restoring the app main directory..." --weight=1 ynh_script_progression --message="Restoring the app main directory..." --weight=1
ynh_restore_file --origin_path="$final_path" ynh_restore_file --origin_path="$install_dir"
chmod 750 "$final_path" chmod 750 "$install_dir"
chmod -R o-rwx "$final_path" chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$final_path" chown -R $app:www-data "$install_dir"
#================================================= #=================================================
# RESTORE THE DATA DIRECTORY # RESTORE THE DATA DIRECTORY
#================================================= #=================================================
ynh_script_progression --message="Restoring the data directory..." --weight=1 ynh_script_progression --message="Restoring the data directory..." --weight=1
ynh_restore_file --origin_path="$datadir" --not_mandatory ynh_restore_file --origin_path="$data_dir" --not_mandatory
mkdir -p $datadir mkdir -p $data_dir
chmod 750 "$datadir" chmod 750 "$data_dir"
chmod -R o-rwx "$datadir" chmod -R o-rwx "$data_dir"
chown -R $app:www-data "$datadir" chown -R $app:www-data "$data_dir"
#================================================= #=================================================
# SPECIFIC RESTORATION # SPECIFIC RESTORATION
#================================================= #=================================================
# REINSTALL DEPENDENCIES # REINSTALL DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Reinstalling dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Reinstalling dependencies..." --weight=1
# Define and install dependencies # Define and install dependencies
ynh_install_app_dependencies $pkg_dependencies #REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# RESTORE THE PHP-FPM CONFIGURATION # RESTORE THE PHP-FPM CONFIGURATION
@ -95,7 +95,7 @@ ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf"
# Recreate a dedicated php-fpm config # Recreate a dedicated php-fpm config
ynh_add_fpm_config --usage=low --footprint=low ynh_add_fpm_config --usage=low --footprint=low
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# RESTORE THE NGINX CONFIGURATION # RESTORE THE NGINX CONFIGURATION

100
scripts/upgrade
View file

@ -14,13 +14,13 @@ source /usr/share/yunohost/helpers
#================================================= #=================================================
ynh_script_progression --message="Loading settings..." --weight=1 ynh_script_progression --message="Loading settings..." --weight=1
app=$YNH_APP_INSTANCE_NAME #REMOVEME? app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get --app=$app --key=domain) #REMOVEME? domain=$(ynh_app_setting_get --app=$app --key=domain)
path_url=$(ynh_app_setting_get --app=$app --key=path) #REMOVEME? path=$(ynh_app_setting_get --app=$app --key=path)
final_path=$(ynh_app_setting_get --app=$app --key=final_path) #REMOVEME? #REMOVEME? install_dir=$(ynh_app_setting_get --app=$app --key=install_dir)
datadir=$(ynh_app_setting_get --app=$app --key=datadir) #REMOVEME? data_dir=$(ynh_app_setting_get --app=$app --key=data_dir)
final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath) #REMOVEME? final_logpath=$(ynh_app_setting_get --app=$app --key=final_logpath)
#================================================= #=================================================
# CHECK VERSION # CHECK VERSION
@ -32,16 +32,16 @@ upgrade_type=$(ynh_check_app_version_changed)
#================================================= #=================================================
# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
#================================================= #=================================================
ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 #REMOVEME? ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1
# Backup the current version of the app # Backup the current version of the app
ynh_backup_before_upgrade #REMOVEME? ynh_backup_before_upgrade
ynh_clean_setup () { #REMOVEME? ynh_clean_setup () {
# Restore it if the upgrade fails # Restore it if the upgrade fails
ynh_restore_upgradebackup #REMOVEME? ynh_restore_upgradebackup
} }
# Exit if an error occurs during the execution of the script # Exit if an error occurs during the execution of the script
ynh_abort_if_errors #REMOVEME? ynh_abort_if_errors
#================================================= #=================================================
# STANDARD UPGRADE STEPS # STANDARD UPGRADE STEPS
@ -51,34 +51,34 @@ ynh_abort_if_errors
ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
# Cleaning legacy permissions # Cleaning legacy permissions
if ynh_legacy_permissions_exists; then #REMOVEME? if ynh_legacy_permissions_exists; then
ynh_legacy_permissions_delete_all #REMOVEME? ynh_legacy_permissions_delete_all
ynh_app_setting_delete --app=$app --key=is_public ynh_app_setting_delete --app=$app --key=is_public
fi fi
if [ -z "$datadir" ]; if [ -z "$data_dir" ];
then then
datadir="/home/yunohost.app/$app" data_dir="/home/yunohost.app/$app"
ynh_app_setting_set --app=$app --key=datadir --value=$datadir #REMOVEME? ynh_app_setting_set --app=$app --key=data_dir --value=$data_dir
ynh_app_setting_delete --app=$app --key=statedir ynh_app_setting_delete --app=$app --key=statedir
mkdir -p $datadir mkdir -p $data_dir
fi fi
if [ -z "$final_logpath" ]; if [ -z "$final_logpath" ];
then then
final_logpath="/var/log/$app" final_logpath="/var/log/$app"
ynh_app_setting_set --app=$app --key=final_logpath --value=$final_logpath #REMOVEME? ynh_app_setting_set --app=$app --key=final_logpath --value=$final_logpath
mkdir -p $final_logpath mkdir -p $final_logpath
fi fi
#================================================= #=================================================
# CREATE DEDICATED USER # CREATE DEDICATED USER
#================================================= #=================================================
ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 #REMOVEME? ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1
# Create a dedicated user (if not existing) # Create a dedicated user (if not existing)
ynh_system_user_create --username=$app --home_dir="$final_path" #REMOVEME? ynh_system_user_create --username=$app --home_dir="$install_dir"
#================================================= #=================================================
# DOWNLOAD, CHECK AND UNPACK SOURCE # DOWNLOAD, CHECK AND UNPACK SOURCE
@ -89,22 +89,22 @@ then
ynh_script_progression --message="Upgrading source files..." --weight=1 ynh_script_progression --message="Upgrading source files..." --weight=1
# Download, check integrity, uncompress and patch the source from app.src # Download, check integrity, uncompress and patch the source from app.src
mkdir "$final_path/tmp" mkdir "$install_dir/tmp"
ynh_setup_source --dest_dir="$final_path/tmp" ynh_setup_source --dest_dir="$install_dir/tmp"
cp -af "$final_path/tmp/src/." "$final_path/." cp -af "$install_dir/tmp/src/." "$install_dir/."
ynh_secure_remove --file="$final_path/tmp" #REMOVEME? ynh_secure_remove --file="$install_dir/tmp"
fi fi
chmod 750 "$final_path" chmod 750 "$install_dir"
chmod -R o-rwx "$final_path" chmod -R o-rwx "$install_dir"
chown -R $app:www-data "$final_path" chown -R $app:www-data "$install_dir"
#================================================= #=================================================
# UPGRADE DEPENDENCIES # UPGRADE DEPENDENCIES
#================================================= #=================================================
ynh_script_progression --message="Upgrading dependencies..." --weight=1 #REMOVEME? ynh_script_progression --message="Upgrading dependencies..." --weight=1
ynh_install_app_dependencies $pkg_dependencies #REMOVEME? ynh_install_app_dependencies $pkg_dependencies
#================================================= #=================================================
# PHP-FPM CONFIGURATION # PHP-FPM CONFIGURATION
@ -113,7 +113,7 @@ ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1
# Create a dedicated PHP-FPM config # Create a dedicated PHP-FPM config
ynh_add_fpm_config --usage=low --footprint=low ynh_add_fpm_config --usage=low --footprint=low
phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #REMOVEME? phpversion=$(ynh_app_setting_get --app=$app --key=phpversion)
#================================================= #=================================================
# NGINX CONFIGURATION # NGINX CONFIGURATION
@ -138,13 +138,13 @@ ynh_replace_string --match_string="__FINAL_LOGPATH__" --replace_string="$final_l
# Storage of state_dir in /home/yunohost.app # Storage of state_dir in /home/yunohost.app
# This contains the sync status in between device and z-push # This contains the sync status in between device and z-push
ynh_replace_string __DATADIR__ $datadir ../conf/config.php ynh_replace_string __DATA_DIR__ $data_dir ../conf/config.php
# Enable caldav carddav support # Enable caldav carddav support
if yunohost app list | grep -q 'id: baikal' ; then if yunohost app list | grep -q 'id: baikal' ; then
echo "Detected Baikal" echo "Detected Baikal"
bailkaldomain=$(ynh_app_setting_get --app=baikal --key=domain) #REMOVEME? bailkaldomain=$(ynh_app_setting_get --app=baikal --key=domain)
bailkalpath=$(ynh_app_setting_get --app=baikal --key=path) #REMOVEME? bailkalpath=$(ynh_app_setting_get --app=baikal --key=path)
bailkalpath=${bailkalpath%/} bailkalpath=${bailkalpath%/}
# Configuration of backend # Configuration of backend
@ -164,15 +164,15 @@ if yunohost app list | grep -q 'id: baikal' ; then
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-caldav.php $final_path/backend/caldav/config.php cp -af ../conf/backend/config-caldav.php $install_dir/backend/caldav/config.php
cp -af ../conf/backend/config-carddav.php $final_path/backend/carddav/config.php cp -af ../conf/backend/config-carddav.php $install_dir/backend/carddav/config.php
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
cp -af ../conf/backend/config-combined.php $final_path/backend/combined/config.php cp -af ../conf/backend/config-combined.php $install_dir/backend/combined/config.php
elif yunohost app list | grep -q 'id: nextcloud' ; then elif yunohost app list | grep -q 'id: nextcloud' ; then
echo "Detected NextCloud" echo "Detected NextCloud"
nextclouddomain=$(ynh_app_setting_get --app=nextcloud --key=domain) #REMOVEME? nextclouddomain=$(ynh_app_setting_get --app=nextcloud --key=domain)
nextcloudpath=$(ynh_app_setting_get --app=nextcloud --key=path) #REMOVEME? nextcloudpath=$(ynh_app_setting_get --app=nextcloud --key=path)
nextcloudpath=${nextcloudpath%/} nextcloudpath=${nextcloudpath%/}
# Configuration of backend # Configuration of backend
@ -192,10 +192,10 @@ elif yunohost app list | grep -q 'id: nextcloud' ; then
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="true" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-caldav.php $final_path/backend/caldav/config.php cp -af ../conf/backend/config-caldav.php $install_dir/backend/caldav/config.php
cp -af ../conf/backend/config-carddav.php $final_path/backend/carddav/config.php cp -af ../conf/backend/config-carddav.php $install_dir/backend/carddav/config.php
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
cp -af ../conf/backend/config-combined.php $final_path/backend/combined/config.php cp -af ../conf/backend/config-combined.php $install_dir/backend/combined/config.php
else else
# Configuration of backend # Configuration of backend
ynh_replace_string --match_string="__BACKEND__" --replace_string="BackendIMAP" --target_file="../conf/config.php" ynh_replace_string --match_string="__BACKEND__" --replace_string="BackendIMAP" --target_file="../conf/config.php"
@ -206,16 +206,16 @@ else
ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="false" --target_file="../conf/backend/config-imap.php" ynh_replace_string --match_string="__FLAGTOCHANGE__" --replace_string="false" --target_file="../conf/backend/config-imap.php"
# Copy config # Copy config
cp -af ../conf/backend/config-imap.php $final_path/backend/imap/config.php cp -af ../conf/backend/config-imap.php $install_dir/backend/imap/config.php
fi fi
# Copy config # Copy config
cp -af ../conf/config.php $final_path/config.php cp -af ../conf/config.php $install_dir/config.php
cp -af ../conf/backend/config-autodiscover.php $final_path/autodiscover/config.php cp -af ../conf/backend/config-autodiscover.php $install_dir/autodiscover/config.php
cp -af ../conf/backend/config-searchldap.php $final_path/backend/searchldap/config.php cp -af ../conf/backend/config-searchldap.php $install_dir/backend/searchldap/config.php
# Fixstates to avoid full resync of devices after version upgrades # Fixstates to avoid full resync of devices after version upgrades
$final_path/z-push-admin.php -a fixstates $install_dir/z-push-admin.php -a fixstates
#================================================= #=================================================
# GENERIC FINALIZATION # GENERIC FINALIZATION
@ -230,9 +230,9 @@ ynh_use_logrotate --non-append
#================================================= #=================================================
# RELOAD NGINX # RELOAD NGINX
#================================================= #=================================================
ynh_script_progression --message="Reloading NGINX web server..." --weight=1 #REMOVEME? ynh_script_progression --message="Reloading NGINX web server..." --weight=1
ynh_systemd_action --service_name=nginx --action=reload #REMOVEME? ynh_systemd_action --service_name=nginx --action=reload
#================================================= #=================================================
# END OF SCRIPT # END OF SCRIPT