diff --git a/README.md b/README.md index bbc39de..91a4e2b 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,6 @@ https://lut.im Le script installe le module perl *carton* via cpan et les paquets *fonts-droid* *ghostscript* *gsfonts* *imagemagick-common* *libavahi-client3* *libavahi-common-data* *libavahi-common3* *libcups2* *libcupsimage2* *libgs9* *libgs9-common* *libijs-0.35* *libjasper1* *libjbig0* *libjbig2dec0* *liblcms2-2* *liblqr-1-0* *libmagickcore5* *libpaper-utils* *libpaper1* *libtiff4* *perlmagick* *poppler-data*. **Mise à jour du package:** -sudo yunohost app upgrade --verbose lutim -u https://github.com/YunoHost-Apps/lutim_ynh +sudo yunohost app upgrade lutim -u https://github.com/YunoHost-Apps/lutim_ynh **Multi-utilisateur:** Non, accessible par tout les utilisateurs. diff --git a/check_process b/check_process index 73801d5..8e0dbfa 100644 --- a/check_process +++ b/check_process @@ -4,8 +4,8 @@ domain="domain.tld" (DOMAIN) path="/path" (PATH) admin="john" (USER) - is_public="Yes" (PUBLIC|public=Yes|private=No) - always_encrypt="Yes" + is_public=1 (PUBLIC|public=1|private=0) + always_encrypt=1 ; Checks pkg_linter=1 setup_sub_dir=1 @@ -16,18 +16,15 @@ upgrade=1 backup_restore=1 multi_instance=0 - wrong_user=1 - wrong_path=1 incorrect_path=1 - corrupt_source=0 - fail_download_source=0 port_already_use=1 (8095) - final_path_already_use=0 ;;; Levels Level 1=auto Level 2=auto Level 3=auto +# Level 4: Pas de gestion des utilisateurs Level 4=na +# Level 5: https://github.com/YunoHost-Apps/lutim_ynh/issues/14 Level 5=1 Level 6=auto Level 7=auto diff --git a/conf/app.src b/conf/app.src new file mode 100644 index 0000000..1317eb2 --- /dev/null +++ b/conf/app.src @@ -0,0 +1,2 @@ +SOURCE_URL>https://git.framasoft.org/luc/lutim/repository/archive.tar.gz?ref=1082f42682988453aef2a130ce99d3eae2e950ba +SOURCE_SUM=1a9a8dec0e418a87a32799b0b875813a diff --git a/conf/logrotate b/conf/logrotate deleted file mode 100644 index 097e483..0000000 --- a/conf/logrotate +++ /dev/null @@ -1,20 +0,0 @@ -__FINALPATH__/log/production.log { - # Effectue une rotation des logs tout les mois - monthly - # Ou si le fichier de log dépasse 100Mo - size 100M - # Garde un maximum de 12 anciens logs - rotate 12 - # Compresse pas les logs avec gzip - compress - # Compresse le log au cycle suivant. Donc garde toujours 2 logs non compressés. - delaycompress - # Copie et tronque le journal pour permettre la poursuite de l'écriture. Plutôt que de déplacer le log. - copytruncate - # Ne renvoi pas d'erreur si le fichier de log est absent. - missingok - # Ne fait pas de rotation si le log est vide. - notifempty - # Garde les anciens logs dans le même dossier. - noolddir -} diff --git a/conf/lutim.default b/conf/lutim.default deleted file mode 100644 index 74b1eaa..0000000 --- a/conf/lutim.default +++ /dev/null @@ -1,6 +0,0 @@ -# LDIR is the path where you installed Lutim -# It has to end with a final / -LDIR=__FINALPATH__ - -# USER is the user who will launch Lutim -USER=www-data diff --git a/conf/lutim.init b/conf/lutim.init deleted file mode 100755 index 94ecc1d..0000000 --- a/conf/lutim.init +++ /dev/null @@ -1,197 +0,0 @@ -#!/bin/sh -# vim: set ts=4 sw=4 sts=4 tw=0: -# vim: set expandtab: - -### BEGIN INIT INFO -# Provides: lutim -# Required-Start: $local_fs $remote_fs $network $syslog -# Required-Stop: $local_fs $remote_fs $network $syslog -# Default-Start: 2 3 4 5 -# Default-Stop: 0 1 6 -# Short-Description: starts lutim with hypnotoad -# Description: starts lutim with hypnotoad -### END INIT INFO - - -PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin -DAEMON=script/lutim -NAME=lutim -DESC=lutim - -if [ -f "/etc/default/lutim" ] -then - . /etc/default/lutim - if [ -z $LDIR ] - then - echo "LDIR variable is empty, please fill it in /etc/default/lutim" - exit 0 - fi - if [ -z $USER ] - then - echo "USER variable is empty, please fill it in /etc/default/lutim" - exit 0 - fi -else - echo "Missing /etc/default/lutim file" - exit 0 -fi - -if [ ! -f "$LDIR$DAEMON" ] -then - echo "Missing $LDIR$DAEMON file" - exit 0 -fi - -set -e - -. /lib/lsb/init-functions - -do_start() -{ - # Return - # 0 if daemon has been started - # 1 if daemon was already running - # 2 if daemon could not be started - - cd $LDIR - su $USER -c "carton exec hypnotoad $DAEMON >> /var/log/lutim/production.log 2>&1" - return "$?" -} - -do_stop() -{ - # Return - # 0 if daemon has been stopped - # 1 if daemon was already stopped - # 2 if daemon could not be stopped - # other if a failure occurred - - cd $LDIR - su $USER -c "carton exec hypnotoad -s $DAEMON >> /var/log/lutim/production.log 2>&1" - return "$?" -} - -do_status() -{ - cd $LDIR - if [ -f "script/hypnotoad.pid" ] - then - pgrep -lf $DAEMON >/dev/null 2>&1 - if [ "$?" = "0" ]; then - log_progress_msg "$NAME is running" - else - log_failure_msg "$NAME is NOT running but PID file exists" - fi - else - log_failure_msg "$NAME is NOT running" - fi -} - -case "$1" in - start) - log_daemon_msg "Starting $NAME" - cd $LDIR - if [ -f "script/hypnotoad.pid" ] - then - pgrep -lf $DAEMON >/dev/null 2>&1 - if [ "$?" = "0" ] - then - log_progress_msg "$NAME is already running. Unable to start." - log_end_msg 1; - else - do_start - case "$?" in - 0|1) - log_progress_msg "done" - log_end_msg 0 - ;; - 2) - log_failure_msg "failed" - log_end_msg 1 - ;; - esac - fi - else - do_start - case "$?" in - 0|1) - log_progress_msg "done" - log_end_msg 0 - ;; - 2) - log_failure_msg "failed" - log_end_msg 1 - ;; - esac - fi - ;; - stop) - log_daemon_msg "Stopping $NAME" - cd $LDIR - if [ -f "script/hypnotoad.pid" ] - then - pgrep -lf $DAEMON >/dev/null 2>&1 - if [ "$?" = "0" ]; then - do_stop - case "$?" in - 0|1) - log_progress_msg "done" - log_end_msg 0 - ;; - *) - log_failure_msg "failed" - log_end_msg 1 - ;; - esac - else - log_failure_msg "$NAME is NOT running. Unable to stop" - log_end_msg 1 - fi - else - log_failure_msg "$NAME is NOT running. Unable to stop" - log_end_msg 1 - fi - ;; - status) - log_daemon_msg "Checking $NAME status" - do_status - log_end_msg 0 - ;; - reload) - log_daemon_msg "Reloading $NAME" - do_start - sleep 1 - case "$?" in - 0|1) - log_progress_msg "done" - log_end_msg 0 - ;; - 2) - log_failure_msg "failed" - log_end_msg 1 - ;; - esac - ;; - restart) - log_daemon_msg "Restarting $NAME" - do_stop - sleep 6 - do_start - case "$?" in - 0|1) - log_progress_msg "done" - log_end_msg 0 - ;; - 2) - log_failure_msg "failed"; - log_end_msg 1 - ;; - esac - ;; - *) - echo "Usage: $0 {start|stop|status|reload|restart}" >&2 - exit 3 - ;; -esac - -exit 0 diff --git a/conf/lutim.service b/conf/lutim.service index 6007714..5bcc908 100644 --- a/conf/lutim.service +++ b/conf/lutim.service @@ -1,12 +1,11 @@ [Unit] Description=Image hosting and sharing service -Documentation=https://git.framasoft.org/luc/lutim -Requires=network.target After=network.target [Service] -Type=forking -User=www-data +Type=simple +User=__APP__ +Group=__APP__ RemainAfterExit=yes WorkingDirectory=__FINALPATH__ PIDFile=__FINALPATH__script/hypnotoad.pid diff --git a/conf/nginx.conf b/conf/nginx.conf index 732fb89..fa51eee 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,15 +1,7 @@ location __PATH__ { - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - location ~ [^/]\.php(/|$) { - fastcgi_split_path_info ^(.+?\.php)(/.*)$; - fastcgi_pass unix:/var/run/php5-fpm.sock; - fastcgi_index index.php; - include fastcgi_params; - fastcgi_param REMOTE_USER $remote_user; - fastcgi_param PATH_INFO $fastcgi_path_info; - } + if ($scheme = http) { + rewrite ^ https://$server_name$request_uri? permanent; + } # Include SSOWAT user panel. include conf.d/yunohost_panel.conf.inc; diff --git a/manifest.json b/manifest.json index e3d2509..c4d8516 100644 --- a/manifest.json +++ b/manifest.json @@ -9,12 +9,12 @@ "en": "Self hosting images and sharing anonymous application", "fr": "Application d'hébergement et de partage d'images anonyme" }, - "version": "0.6 dev", + "version": "0.6", "url": "https://lut.im", - "license": "free", + "license": "AGPL-3.0", "maintainer": { "name": "Maniack Crudelis et matlink", - "email": "maniackc_dev@crudelis.fr matlink@matlink.fr" + "email": "maniackc_dev@crudelis.fr" }, "multi_instance": false, "services": [ @@ -52,21 +52,21 @@ }, { "name": "is_public", + "type": "boolean", "ask": { "en": "Uploading images is it public?", "fr": "L'upload des images est-il public ?" }, - "choices": ["Yes", "No"], - "default": "No" + "default": false }, { "name": "always_encrypt", + "type": "boolean", "ask": { "en": "Force the encryption of images?", "fr": "Forcer le chiffrement des images ?" }, - "choices": ["Yes", "No"], - "default": "Yes" + "default": true } ] } diff --git a/scripts/.fonctions b/scripts/.fonctions index c18e8d3..2243dd2 100755 --- a/scripts/.fonctions +++ b/scripts/.fonctions @@ -1,103 +1,86 @@ #!/bin/bash -CHECK_VAR () { # Vérifie que la variable n'est pas vide. -# $1 = Variable à vérifier -# $2 = Texte à afficher en cas d'erreur - test -n "$1" || (echo "$2" >&2 && false) -} - -EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus. - exit_code=$? - if [ "$exit_code" -eq 0 ]; then - exit 0 # Quitte sans erreur si le script se termine correctement. - fi - trap '' EXIT - set +eu - 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 # Vérifie l'existance de la fonction avant de l'exécuter. - CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install. - fi - - # Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation. - sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json - - ynh_die -} - -TRAP_ON () { # Activate signal capture - set -eu # Exit if a command fail, and if a variable is used unset. - trap EXIT_PROPERLY EXIT # Capturing exit signals on shell script -} +#================================================= +# CHECKING +#================================================= CHECK_USER () { # Vérifie la validité de l'user admin # $1 = Variable de l'user admin. - ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false) -} - -CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin. - if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un / - path="/$path" # Ajoute un / en début de path - fi - if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # Si le dernier caractère est un / et que ce n'est pas le seul caractère. - path="${path:0:${#path}-1}" # Supprime le dernier caractère - fi + ynh_user_exists "$1" || ynh_die "Wrong user" } CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - sudo yunohost app checkurl $domain$path -a $app + sudo yunohost app checkurl $domain$path_url -a $app } CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé. final_path=/var/www/$app - if [ -e "$final_path" ] - then - echo "This path already contains a folder" >&2 - false - fi + test ! -e "$final_path" || ynh_die "This path already contains a folder" } -GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app. -# $1 = Nom de la base de donnée - db_user=$1 - db_user=${db_user//-/_} # mariadb ne supporte pas les - dans les noms de base de données. Ils sont donc remplacé par des _ - # Génère un mot de passe aléatoire. -# db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20) - db_pwd=$(ynh_string_random) - CHECK_VAR "$db_pwd" "db_pwd empty" - # Utilise '$app' comme nom d'utilisateur et de base de donnée - # Initialise la base de donnée et stocke le mot de passe mysql. - ynh_mysql_create_db "$db_user" "$db_user" $db_pwd - ynh_app_setting_set $app mysqlpwd $db_pwd +#================================================= +# DISPLAYING +#================================================= + +NO_PRINT () { # Supprime l'affichage dans stdout pour la commande en argument. + set +x + $@ + set -x } +WARNING () { # Écrit sur le canal d'erreur pour passer en warning. + $@ >&2 +} + +SUPPRESS_WARNING () { # Force l'écriture sur la sortie standard + $@ 2>&1 +} + +QUIET () { # Redirige la sortie standard dans /dev/null + $@ > /dev/null +} + +ALL_QUIET () { # Redirige la sortie standard et d'erreur dans /dev/null + $@ > /dev/null 2>&1 +} + +#================================================= +# SETUP +#================================================= + SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path -# $1 = Nom de l'archive téléchargée. - wget -nv -i ../sources/source_url -O $1 + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) + src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) + # Download sources from the upstream + wget -nv -O source.tar.gz $src_url # Vérifie la somme de contrôle de la source téléchargée. - md5sum -c ../sources/source_md5 --status || (echo "Corrupt source" >&2 && false) - # Décompresse la source - if [ "$(echo ${1##*.})" == "gz" ]; then - tar -x -f $1 - elif [ "$(echo ${1##*.})" == "zip" ]; then - unzip -q $1 - else - false # Format d'archive non pris en charge. - fi - # Copie les fichiers sources - sudo cp -a $(cat ../sources/source_dir)/. "$final_path" + echo "$src_checksum source.tar.gz" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $final_path + sudo tar -x -f source.tar.gz -C $final_path --strip-components 1 # Copie les fichiers additionnels ou modifiés. if test -e "../sources/ajouts"; then sudo cp -a ../sources/ajouts/. "$final_path" fi } -ADD_SYS_USER () { # Créer un utilisateur système dédié à l'app - if ! ynh_system_user_exists "$app" # Test l'existence de l'utilisateur - then - sudo useradd -d /var/www/$app --system --user-group $app --shell /usr/sbin/nologin || (echo "Unable to create $app system account" >&2 && false) - fi +SETUP_SOURCE_ZIP () { # Télécharge la source, décompresse et copie dans $final_path + src_url=$(cat ../conf/app.src | grep SOURCE_URL | cut -d'>' -f2) + src_checksum=$(cat ../conf/app.src | grep SOURCE_SUM | cut -d= -f2) + # Download sources from the upstream + wget -nv -O source.zip $src_url + # Vérifie la somme de contrôle de la source téléchargée. + echo "$src_checksum source.zip" | md5sum -c --status || ynh_die "Corrupt source" + # Extract source into the app dir + sudo mkdir -p $final_path + temp_dir=$(mktemp -d) + unzip -quo source.zip -d $temp_dir # On passe par un dossier temporaire car unzip ne permet pas d'ignorer le dossier parent. + sudo cp -a $temp_dir/*/. $final_path + rm -r $temp_dir + # Copie les fichiers additionnels ou modifiés. + if test -e "../sources/ajouts"; then + sudo cp -a ../sources/ajouts/. "$final_path" + fi } POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure. @@ -110,9 +93,123 @@ POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configu finalphpini=/etc/php5/fpm/conf.d/20-$app.ini sudo cp ../conf/php-fpm.ini $finalphpini sudo chown root: $finalphpini - sudo service php5-fpm reload + sudo systemctl reload php5-fpm } +YNH_CURL () { + data_post=$1 + url_access=$2 + sleep 1 + curl -kL -H "Host: $domain" --resolve $domain:443:127.0.0.1 --data "$data_post" "https://localhost$path_url$url_access" 2>&1 +} + +#================================================= +# REMOVE +#================================================= + +REMOVE_NGINX_CONF () { # Suppression de la configuration nginx + if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config + echo "Delete nginx config" + sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" + sudo systemctl reload nginx + fi +} + +REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm + 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 +} + +SECURE_REMOVE () { # Suppression de dossier avec vérification des variables + chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. + no_var=0 + while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine + do + no_var=1 + global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. + only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. + real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable. + if test -z "$real_var" || [ "$real_var" = "/" ]; then + WARNING echo "Variable $only_var is empty, suppression of $chaine cancelled." + return 1 + fi + chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine. + done + if [ "$no_var" -eq 1 ] + then + if [ -e "$chaine" ]; then + echo "Delete directory $chaine" + sudo rm -r "$chaine" + fi + return 0 + else + WARNING echo "No detected variable." + return 1 + fi +} + +#================================================= +# BACKUP +#================================================= + +BACKUP_FAIL_UPGRADE () { + WARNING echo "Upgrade failed." + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$backup_number; then # Vérifie l'existence de l'archive avant de supprimer l'application et de restaurer + sudo yunohost app remove $app # Supprime l'application avant de la restaurer. + sudo yunohost backup restore --ignore-hooks $app_bck-pre-upgrade$backup_number --apps $app --force # Restore the backup if upgrade failed + ynh_die "The app was restored to the way it was before the failed upgrade." + fi +} + +BACKUP_BEFORE_UPGRADE () { # Backup the current version of the app, restore it if the upgrade fails + backup_number=1 + old_backup_number=2 + app_bck=${app//_/-} # Replace all '_' by '-' + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade1; then # Vérifie l'existence d'une archive déjà numéroté à 1. + backup_number=2 # Et passe le numéro de l'archive à 2 + old_backup_number=1 + fi + + sudo yunohost backup create --ignore-hooks --apps $app --name $app_bck-pre-upgrade$backup_number # Créer un backup différent de celui existant. + if [ "$?" -eq 0 ]; then # Si le backup est un succès, supprime l'archive précédente. + if sudo yunohost backup list | grep -q $app_bck-pre-upgrade$old_backup_number; then # Vérifie l'existence de l'ancienne archive avant de la supprimer, pour éviter une erreur. + QUIET sudo yunohost backup delete $app_bck-pre-upgrade$old_backup_number + fi + else # Si le backup a échoué + ynh_die "Backup failed, the upgrade process was aborted." + fi +} + +HUMAN_SIZE () { # Transforme une taille en Ko en une taille lisible pour un humain + human=$(numfmt --to=iec --from-unit=1K $1) + echo $human +} + +CHECK_SIZE () { # Vérifie avant chaque backup que l'espace est suffisant + file_to_analyse=$1 + backup_size=$(sudo du --summarize "$file_to_analyse" | cut -f1) + free_space=$(sudo df --output=avail "/home/yunohost.backup" | sed 1d) + + if [ $free_space -le $backup_size ] + then + WARNING echo "Espace insuffisant pour sauvegarder $file_to_analyse." + WARNING echo "Espace disponible: $(HUMAN_SIZE $free_space)" + ynh_die "Espace nécessaire: $(HUMAN_SIZE $backup_size)" + fi +} + +#================================================= +# CONFIGURATION +#================================================= + STORE_MD5_CONFIG () { # Enregistre la somme de contrôle du fichier de config # $1 = Nom du fichier de conf pour le stockage dans settings.yml # $2 = Nom complet et chemin du fichier de conf. @@ -127,87 +224,278 @@ CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modi fi } -FIND_PORT () { # Cherche un port libre. -# $1 = Numéro de port pour débuter la recherche. - port=$1 - while ! sudo yunohost app checkport $port ; do - port=$((port+1)) - done - CHECK_VAR "$port" "port empty" + +#================================================= +#================================================= +# FUTUR YNH HELPERS +#================================================= +# Importer ce fichier de fonction avant celui des helpers officiel +# Ainsi, les officiels prendront le pas sur ceux-ci le cas échéant +#================================================= + +# Ignore the yunohost-cli log to prevent errors with conditionals commands +# usage: ynh_no_log COMMAND +# Simply duplicate the log, execute the yunohost command and replace the log without the result of this command +# It's a very badly hack... +ynh_no_log() { + ynh_cli_log=/var/log/yunohost/yunohost-cli.log + sudo cp -a ${ynh_cli_log} ${ynh_cli_log}-move + eval $@ + exit_code=$? + sudo mv ${ynh_cli_log}-move ${ynh_cli_log} + return $? } +# Normalize the url path syntax +# Handle the slash at the beginning of path and its absence at ending +# Return a normalized url path +# +# example: url_path=$(ynh_normalize_url_path $url_path) +# ynh_normalize_url_path example -> /example +# ynh_normalize_url_path /example -> /example +# ynh_normalize_url_path /example/ -> /example +# +# usage: ynh_normalize_url_path path_to_normalize +# | arg: url_path_to_normalize - URL path to normalize before using it +ynh_normalize_url_path () { + path_url=$1 + test -n "$path_url" || ynh_die "ynh_normalize_url_path expect a URL path as first argument and received nothing." + if [ "${path_url:0:1}" != "/" ]; then # If the first character is not a / + path_url="/$path_url" # Add / at begin of path variable + fi + if [ "${path_url:${#path_url}-1}" == "/" ] && [ ${#path_url} -gt 1 ]; then # If the last character is a / and that not the only character. + path_url="${path_url:0:${#path_url}-1}" # Delete the last character + fi + echo $path_url +} -### REMOVE SCRIPT +# Create a database, an user and its password. Then store the password in the app's config +# +# User of database will be store in db_user's variable. +# Name of database will be store in db_name's variable. +# And password in db_pwd's variable. +# +# usage: ynh_mysql_generate_db user name +# | arg: user - Owner of the database +# | arg: name - Name of the database +ynh_mysql_generate_db () { + db_pwd=$(ynh_string_random) # Generate a random password + ynh_mysql_create_db "$2" "$1" "$db_pwd" # Create the database + ynh_app_setting_set $app mysqlpwd $db_pwd # Store the password in the app's config +} -REMOVE_NGINX_CONF () { # Suppression de la configuration nginx - if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config - echo "Delete nginx config" - sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo service nginx reload +# Remove a database if it exist and the associated user +# +# usage: ynh_mysql_remove_db user name +# | arg: user - Proprietary of the database +# | arg: name - Name of the database +ynh_mysql_remove_db () { + if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $2"; then # Check if the database exist + echo "Remove database $2" >&2 + ynh_mysql_drop_db $2 # Remove the database + ynh_mysql_drop_user $1 # Remove the associated user to database + else + echo "Database $2 not found" >&2 fi } -REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm - 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 service php5-fpm reload +# Correct the name given in argument for mariadb +# +# Avoid invalid name for your database +# +# Exemple: dbname=$(ynh_make_valid_dbid $app) +# +# usage: ynh_make_valid_dbid name +# | arg: name - name to correct +# | ret: the corrected name +ynh_make_valid_dbid () { + dbid=${1//[-.]/_} # Mariadb doesn't support - and . in the name of databases. It will be replace by _ + echo $dbid } -REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate +# Manage a fail of the script +# +# Print a warning to inform that the script was failed +# Execute the ynh_clean_setup function if used in the app script +# +# usage of ynh_clean_setup function +# This function provide a way to clean some residual of installation that not managed by remove script. +# To use it, simply add in your script: +# ynh_clean_setup () { +# instructions... +# } +# This function is optionnal. +# +# Usage: ynh_exit_properly is used only by the helper ynh_check_error. +# You must not use it directly. +ynh_exit_properly () { + exit_code=$? + if [ "$exit_code" -eq 0 ]; then + exit 0 # Exit without error if the script ended correctly + fi + + trap '' EXIT # Ignore new exit signals + set +eu # Do not exit anymore if a command fail or if a variable is empty + + echo -e "!!\n $app's script has encountered an error. Its execution was cancelled.\n!!" >&2 + + if type -t ynh_clean_setup > /dev/null; then # Check if the function exist in the app script. + ynh_clean_setup # Call the function to do specific cleaning for the app. + fi + + ynh_die # Exit with error status +} + +# Exit if an error occurs during the execution of the script. +# +# Stop immediatly the execution if an error occured or if a empty variable is used. +# The execution of the script is derivate to ynh_exit_properly function before exit. +# +# Usage: ynh_abort_if_errors +ynh_abort_if_errors () { + set -eu # Exit if a command fail, and if a variable is used unset. + trap ynh_exit_properly EXIT # Capturing exit signals on shell script +} + +# Install dependencies with a equivs control file +# +# usage: ynh_install_app_dependencies dep [dep [...]] +# | arg: dep - the package name to install in dependence +ynh_install_app_dependencies () { + dependencies=$@ + manifest_path="../manifest.json" + if [ ! -e "$manifest_path" ]; then + manifest_path="../settings/manifest.json" # Into the restore script, the manifest is not at the same place + fi + version=$(sudo python3 -c "import sys, json;print(json.load(open(\"$manifest_path\"))['version'])") # Retrieve the version number in the manifest file. + dep_app=${app//_/-} # Replace all '_' by '-' + + if ynh_package_is_installed "${dep_app}-ynh-deps"; then + echo "A package named ${dep_app}-ynh-deps is already installed" >&2 + else + cat > ./${dep_app}-ynh-deps.control << EOF # Make a control file for equivs-build +Section: misc +Priority: optional +Package: ${dep_app}-ynh-deps +Version: ${version} +Depends: ${dependencies// /, } +Architecture: all +Description: Fake package for ${app} (YunoHost app) dependencies + This meta-package is only responsible of installing its dependencies. +EOF + ynh_package_install_from_equivs ./${dep_app}-ynh-deps.control \ + || ynh_die "Unable to install dependencies" # Install the fake package and its dependencies + ynh_app_setting_set $app apt_dependencies $dependencies + fi +} + +# Remove fake package and its dependencies +# +# Dependencies will removed only if no other package need them. +# +# usage: ynh_remove_app_dependencies +ynh_remove_app_dependencies () { + dep_app=${app//_/-} # Replace all '_' by '-' + ynh_package_autoremove ${dep_app}-ynh-deps # Remove the fake package and its dependencies if they not still used. +} + +# Use logrotate to manage the logfile +# +# usage: ynh_use_logrotate [logfile] +# | arg: logfile - absolute path of logfile +# +# If no argument provided, a standard directory will be use. /var/log/${app} +# You can provide a path with the directory only or with the logfile. +# /parentdir/logdir/ +# /parentdir/logdir/logfile.log +# +# It's possible to use this helper several times, each config will added to same logrotate config file. +ynh_use_logrotate () { + if [ "$#" -gt 0 ]; then + if [ "$(echo ${1##*.})" == "log" ]; then # Keep only the extension to check if it's a logfile + logfile=$1 # In this case, focus logrotate on the logfile + else + logfile=$1/.log # Else, uses the directory and all logfile into it. + fi + else + logfile="/var/log/${app}/.log" # Without argument, use a defaut directory in /var/log + fi + cat > ./${app}-logrotate << EOF # Build a config file for logrotate +$logfile { + # Rotate if the logfile exceeds 100Mo + size 100M + # Keep 12 old log maximum + rotate 12 + # Compress the logs with gzip + compress + # Compress the log at the next cycle. So keep always 2 non compressed logs + delaycompress + # Copy and truncate the log to allow to continue write on it. Instead of move the log. + copytruncate + # Do not do an error if the log is missing + missingok + # Not rotate if the log is empty + notifempty + # Keep old logs in the same dir + noolddir +} +EOF + sudo mkdir -p $(dirname "$logfile") # Create the log directory, if not exist + cat ${app}-logrotate | sudo tee -a /etc/logrotate.d/$app > /dev/null # Append this config to the others for this app. If a config file already exist +} + +# Remove the app's logrotate config. +# +# usage: ynh_remove_logrotate +ynh_remove_logrotate () { if [ -e "/etc/logrotate.d/$app" ]; then - echo "Delete logrotate config" sudo rm "/etc/logrotate.d/$app" fi } -SECURE_REMOVE () { # Suppression de dossier avec vérification des variables - chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables. - no_var=0 - while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine +# Find a free port and return it +# +# example: port=$(ynh_find_port 8080) +# +# usage: ynh_find_port begin_port +# | arg: begin_port - port to start to search +ynh_find_port () { + port=$1 + test -n "$port" || ynh_die "The argument of ynh_find_port must be a valid port." + while netcat -z 127.0.0.1 $port # Check if the port is free do - no_var=1 - global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée. - only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière. - real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une 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@") # remplace la variable par sa valeur dans la chaine. + port=$((port+1)) # Else, pass to next port done - if [ "$no_var" -eq 1 ] - then - if [ -e "$chaine" ]; then - echo "Delete directory $chaine" - sudo rm -r "$chaine" + echo $port +} + +# 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 - return 0 - else - echo "No detected variable." >&2 - return 1 + sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" fi } -REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé. -# $1 = Nom de la base de donnée - # Utilise '$app' comme nom d'utilisateur et de base de donnée - db_user=$1 - if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then - echo "Delete db" - ynh_mysql_drop_db $db_user - ynh_mysql_drop_user $db_user - fi -} - -REMOVE_SYS_USER () { # Supprime l'utilisateur système dédié à l'app - if ynh_system_user_exists "$app" # Test l'existence de l'utilisateur +# 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 - sudo userdel $app + echo "Remove the user $1" >&2 + sudo userdel $1 + else + echo "The user $1 was not found" >&2 fi } diff --git a/scripts/backup b/scripts/backup index dfc0d88..248fe65 100644 --- a/scripts/backup +++ b/scripts/backup @@ -1,39 +1,66 @@ #!/bin/bash -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# Source app helpers +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + final_path=$(ynh_app_setting_get $app final_path) domain=$(ynh_app_setting_get $app domain) -codename=$(ynh_app_setting_get $app codename) -# The parameter $1 is the backup directory location -# which will be compressed afterward -backup_dir=$1/apps/$app -sudo mkdir -p "$backup_dir" +#================================================= +# STANDARD BACKUP STEPS +#================================================= +# BACKUP OF THE MAIN DIR OF THE APP +#================================================= -# Backup sources & data -sudo cp -a $final_path/. $backup_dir/sources +CHECK_SIZE "$final_path" +ynh_backup "$final_path" "sources" -# Copy Nginx and YunoHost parameters to make the script "standalone" -sudo cp -a /etc/yunohost/apps/$app/. $backup_dir/yunohost -sudo cp -a /etc/nginx/conf.d/$domain.d/$app.conf $backup_dir/nginx.conf +#================================================= +# BACKUP OF THE NGINX CONFIGURATION +#================================================= -if [ "$codename" = "wheezy" ] -then - # Copie des fichiers du script init - sudo cp -a /etc/init.d/lutim $backup_dir/init.d_lutim - sudo cp -a /etc/default/lutim $backup_dir/default_lutim -else - # Copie des fichiers du script systemd - sudo cp -a /etc/systemd/system/lutim.service $backup_dir/ -fi +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "nginx.conf" -# Copie du fichier du cron -sudo cp -a /etc/cron.d/$app $backup_dir/cron_$app +#================================================= +# SPECIFIC BACKUP +#================================================= +# BACKUP LOGROTATE +#================================================= -# Copie la configuration de logrotate -sudo cp -a /etc/logrotate.d/$app $backup_dir/logrotate +ynh_backup "/etc/logrotate.d/$app" "logrotate" + +#================================================= +# BACKUP SYSTEMD +#================================================= + +ynh_backup "/etc/systemd/system/$app.service" "systemd" + +#================================================= +# BACKUP OF THE CRON FILE +#================================================= + +ynh_backup "/etc/cron.d/$app" "cron" diff --git a/scripts/install b/scripts/install index 36a72c3..ffa973a 100644 --- a/scripts/install +++ b/scripts/install @@ -1,164 +1,196 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -CLEAN_SETUP () { -# Nettoyage des résidus d'installation non pris en charge par le script remove. -# Pas de nettoyage supplémentaire nécessaire ici... - echo "" -} -TRAP_ON # Active trap pour arrêter le script si une erreur est détectée. +source .fonctions +source /usr/share/yunohost/helpers + +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= + +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# RETRIEVE ARGUMENTS FROM THE MANIFEST +#================================================= -# Retrieve arguments domain=$YNH_APP_ARG_DOMAIN -path=$YNH_APP_ARG_PATH +path_url=$YNH_APP_ARG_PATH admin=$YNH_APP_ARG_ADMIN is_public=$YNH_APP_ARG_IS_PUBLIC always_encrypt=$YNH_APP_ARG_ALWAYS_ENCRYPT app=$YNH_APP_INSTANCE_NAME -# Source app helpers -source /usr/share/yunohost/helpers - -script_dir=$PWD - -# Vérifie que les variables ne sont pas vides. -CHECK_VAR "$app" "app name not set" -CHECK_VAR "$script_dir" "script_dir not set" - +#================================================= +# CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS +#================================================= CHECK_USER "$admin" # Vérifie la validité de l'user admin - -CHECK_PATH # Vérifie et corrige la syntaxe du path. +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. CHECK_DOMAINPATH # Vérifie la disponibilité du path et du domaine. - CHECK_FINALPATH # Vérifie que le dossier de destination n'est pas déjà utilisé. -# Modifie le domaine pour qu'il passe dans une regex -domain_regex=$(echo "$domain" | sed 's@-@.@g') -CHECK_VAR "$domain_regex" "domain_regex empty" +#================================================= +# STORE SETTINGS FROM MANIFEST +#================================================= -FIND_PORT 8095 # Cherche un port libre. - -# Enregistre les infos dans la config YunoHost ynh_app_setting_set $app admin $admin ynh_app_setting_set $app domain $domain ynh_app_setting_set $app is_public $is_public -ynh_app_setting_set $app port $port ynh_app_setting_set $app always_encrypt $always_encrypt +#================================================= +# STANDARD MODIFICATIONS +#================================================= +# FIND AND OPEN A PORT +#================================================= + +port=$(ynh_find_port 8095) # Cherche un port libre. +# Ouvre le port dans le firewall +ALL_QUIET sudo yunohost firewall allow --no-upnp TCP $port +ynh_app_setting_set $app port $port + +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= -# Créer le repertoire de destination et stocke son emplacement. -sudo mkdir "$final_path" ynh_app_setting_set $app final_path $final_path +SETUP_SOURCE # Télécharge la source, décompresse et copie dans $final_path -SETUP_SOURCE "lutim.tar.gz" # Télécharge la source, décompresse et copie dans $final_path +#================================================= +# INSTALL DEPENDENCIES +#================================================= + +ynh_install_app_dependencies carton perlmagick + +#================================================= +# NGINX CONFIGURATION +#================================================= # Copie le fichier de config nginx sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +# Change variables in nginx configuration +sudo sed -i "s@__PATH__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# CREATE DEDICATED USER +#================================================= -# Installation de perlmagick, interface perl pour imagemagick et de carton, gestionnaire de dépendances perl -sudo apt-get update -sudo apt-get install carton perlmagick -qy +ynh_system_user_create $app # Créer un utilisateur système dédié à l'app + +#================================================= +# SPECIFIC SETUP +#================================================= +# SETUP LUTIM +#================================================= ## Copie et configuration du fichier de conf. sudo cp ../conf/lutim.conf.template "$final_path/lutim.conf" sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/lutim.conf" -sudo sed -i "s@__PATH__@$path@g" "$final_path/lutim.conf" +sudo sed -i "s@__PATH__@$path_url@g" "$final_path/lutim.conf" sudo sed -i "s@__PORT__@$port@g" "$final_path/lutim.conf" -if [ "$always_encrypt" = "No" ]; then - always_encrypt=0 -else - always_encrypt=1 -fi sudo sed -i "s@__ENCRYPT__@$always_encrypt@g" "$final_path/lutim.conf" -secret=$(dd if=/dev/urandom bs=1 count=200 2> /dev/null | tr -c -d 'A-Za-z0-9' | sed -n 's/\(.\{24\}\).*/\1/p') -CHECK_VAR "$secret" "secret empty" +secret=$(ynh_string_random) sudo sed -i "s@__SECRET__@$secret@g" "$final_path/lutim.conf" STORE_MD5_CONFIG "lutim.conf" "$final_path/lutim.conf" # Enregistre la somme de contrôle du fichier de config +#================================================= +# SETUP SYSTEMD +#================================================= -codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2) -CHECK_VAR "$codename" "codename empty" -ynh_app_setting_set $app codename $codename -if [ "$codename" = "wheezy" ] -then # On utilise le script init pour wheezy. - # Mise en place du script init - sudo cp ../conf/lutim.init /etc/init.d/lutim - sudo cp ../conf/lutim.default /etc/default/lutim - sudo chmod +x /etc/init.d/lutim - sudo chown root: /etc/init.d/lutim /etc/default/lutim - sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/default/lutim - ## Démarrage auto du service - sudo update-rc.d lutim defaults -else # Et le script systemd à partir de jessie - # Mise en place du script systemd - sudo cp ../conf/lutim.service /etc/systemd/system/lutim.service - sudo chown root: /etc/systemd/system/lutim.service - sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/systemd/system/lutim.service - ## Démarrage auto du service - sudo systemctl enable lutim.service -fi +sudo cp ../conf/lutim.service /etc/systemd/system/$app.service +sudo chown root: /etc/systemd/system/$app.service +sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/systemd/system/$app.service +sudo sed -i "s@__APP__@$app@g" /etc/systemd/system/$app.service +## Démarrage auto du service +sudo systemctl enable $app + +#================================================= +# SETUP CRON +#================================================= -## Mise en place des crons sudo cp ../conf/cron_lutim /etc/cron.d/$app sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/cron.d/$app sudo chmod +x $final_path/script/lutim -# Configuration de logrotate -sed -i "s@__FINALPATH__@$final_path@g" ../conf/logrotate -sudo cp ../conf/logrotate /etc/logrotate.d/$app +#================================================= +# INSTALL LUTIM WITH CARTON +#================================================= -# Installation de lutim via carton sudo mkdir -p /var/log/$app/ -cd $final_path +pushd $final_path # cd avec une stack pour revenir en arrière sudo carton install 2>&1 | sudo tee -a "/var/log/$app/setup_carton.log" +popd # Revient au dossier courant avant pushd # Configure le path du dossier perl en fonction de l'architecture système arch_dir=$(ls -1 $final_path/local/lib/perl5/ | grep linux-gnu) if [ "$?" -ne 0 ] then - echo "Impossible de trouver le dossier relatif à l'architecture système." | sudo tee -a "/var/log/$app/setup_carton.log" - false + ynh_die "Impossible de trouver le dossier relatif à l'architecture système." fi -CHECK_VAR "$arch_dir" "arch_dir empty" sudo sed -i "s@__ARCHDIR__@$arch_dir@g" "$final_path/script/lutim" -# Change variables in nginx configuration -sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf -sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf - -# Make app public or private -ynh_app_setting_set $app skipped_uris "/" -if [ "$is_public" = "No" ]; -then # Si l'app est privée, seul le visionnage des images reste public - if [ "$path" == "/" ]; then - path="" # Si path correspond à la racine, supprime le / pour éviter une erreur de la regex. - fi - ynh_app_setting_set $app protected_regex "$domain_regex$path/stats$","$domain_regex$path/manifest.webapp$","$domain_regex$path/$","$domain_regex$path/d/.*$","$domain_regex$path/m/.*$" -fi +#================================================= +# SETUP LOG FILE +#================================================= # Making log symbolic link to /var/log -sudo touch /var/log/$app/production.log -sudo chown www-data: /var/log/$app/production.log +sudo touch /var/log/$app/production.log +sudo chown $app: -R /var/log/$app sudo ln -s /var/log/$app/production.log "$final_path/log/production.log" -# Configure les droits d'accès au fichiers -sudo chown -R www-data: $final_path +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= -# Start lutim -sudo service lutim start +sudo chown -R $app: $final_path + +#================================================= +# START LUTIM +#================================================= + +sudo systemctl start lutim # Set right permissions on new files created at first start -sudo chown -R www-data: "$final_path" +sudo chown -R $app: $final_path +#================================================= +# GENERIC FINALISATION +#================================================= +# SETUP LOGROTATE +#================================================= + +ynh_use_logrotate + +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= -# Add lutim as a service sudo yunohost service add lutim -l $final_path/log/production.log +#================================================= +# SETUP SSOWAT +#================================================= -# Recharge la configuration Nginx -sudo service nginx reload -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +ynh_app_setting_set $app skipped_uris "/" +if [ $is_public -eq 0 ] +then # Si l'app est privée, seul le visionnage des images reste public + if [ "$path_url" == "/" ]; then + path_url="" # Si path correspond à la racine, supprime le / pour éviter une erreur de la regex. + fi + # Modifie le domaine pour qu'il passe dans une regex + domain_regex=$(echo "$domain" | sed 's@-@.@g') + ynh_app_setting_set $app protected_regex "$domain_regex$path_url/stats$","$domain_regex$path_url/manifest.webapp$","$domain_regex$path_url/$","$domain_regex$path_url/d/.*$","$domain_regex$path_url/m/.*$" +fi + +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index 3377a9e..699e49b 100644 --- a/scripts/remove +++ b/scripts/remove @@ -1,52 +1,77 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME - -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) -# Arrêt du service -if [ -e "/etc/init.d/lutim" ]; then - echo "Delete init.d script" - sudo service lutim stop - sudo rm "/etc/init.d/lutim" - sudo rm "/etc/default/lutim" - sudo update-rc.d -f lutim remove -fi -if [ -e "/etc/systemd/system/lutim.service" ]; then +#================================================= +# STANDARD REMOVE +#================================================= +# STOP AND REMOVE SERVICE +#================================================= + +if [ -e "/etc/systemd/system/$app.service" ]; then echo "Delete systemd script" - sudo service lutim stop - sudo rm "/etc/systemd/system/lutim.service" - sudo systemctl disable lutim.service + sudo systemctl stop $app + sudo systemctl disable $app.service + sudo rm "/etc/systemd/system/$app.service" fi -# Retire le service du monitoring de Yunohost. -if sudo yunohost service status | grep -q lutim # Test l'existence du service dans Yunohost +#================================================= +# DISABLE SERVICE IN ADMIN PANEL +#================================================= + +if sudo yunohost service status | grep -q $app # Test l'existence du service dans Yunohost then - echo "Remove lutim service" - sudo yunohost service remove lutim + echo "Remove $app service" + sudo yunohost service remove $app fi +#================================================= +# REMOVE DEPENDENCIES +#================================================= + +ynh_remove_app_dependencies + +#================================================= +# REMOVE THE MAIN DIR OF THE APP +#================================================= + SECURE_REMOVE '/var/www/$app' # Suppression du dossier de l'application +#================================================= +# REMOVE THE NGINX CONFIGURATION +#================================================= + REMOVE_NGINX_CONF # Suppression de la configuration nginx +#================================================= +# REMOVE THE LOGROTATE CONFIG +#================================================= + +ynh_remove_logrotate # Suppression de la configuration de logrotate + +#================================================= +# SPECIFIC REMOVE +#================================================= +# REMOVE CRON JOBS +#================================================= + # Retirer le cron if [ -e "/etc/cron.d/$app" ]; then echo "Delete cron" sudo rm "/etc/cron.d/$app" fi - -SECURE_REMOVE '/var/log/$app/' # Suppression des log - -REMOVE_LOGROTATE_CONF # Suppression de la configuration de logrotate - -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf - -echo -e "\e[0m" # Restore normal color diff --git a/scripts/restore b/scripts/restore index c04609a..2d4d694 100644 --- a/scripts/restore +++ b/scripts/restore @@ -1,58 +1,123 @@ #!/bin/bash -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME +#================================================= +# GENERIC STARTING +#================================================= +# MANAGE FAILURE OF THE SCRIPT +#================================================= -# Source app helpers +# Exit on command errors and treat unset variables as an error +set -eu + +#================================================= +# IMPORT GENERIC HELPERS +#================================================= + +if [ ! -e .fonctions ]; then + # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant + sudo cp ../settings/scripts/.fonctions ./.fonctions + sudo chmod a+rx .fonctions +fi +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + final_path=$(ynh_app_setting_get $app final_path) domain=$(ynh_app_setting_get $app domain) -codename=$(ynh_app_setting_get $app codename) +path_url=$(ynh_app_setting_get $app path) -# The parameter $1 is the uncompressed restore directory location -backup_dir=$1/apps/$app +#================================================= +# CHECK IF THE APP CAN BE RESTORED +#================================================= -# Restore sources & data -sudo cp -a $backup_dir/sources/. $final_path +sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ + || ynh_die "Path not available: ${domain}${path_url}" +test ! -d $final_path \ + || ynh_die "There is already a directory: $final_path " -# Restore Nginx and YunoHost parameters -sudo cp -a $backup_dir/yunohost/. /etc/yunohost/apps/$app -sudo cp -a $backup_dir/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# STANDARD RESTORE STEPS +#================================================= +# RESTORE OF THE NGINX CONFIGURATION +#================================================= - -# Installation de perlmagick, interface perl pour imagemagick et de carton, gestionnaire de dépendances perl -sudo apt-get update -sudo apt-get install carton perlmagick -qy - - -if [ "$codename" = "wheezy" ] -then - # Restauration des fichiers du script init - sudo cp -a $backup_dir/init.d_lutim /etc/init.d/lutim - sudo cp -a $backup_dir/default_lutim /etc/default/lutim - ## Démarrage auto du service - sudo update-rc.d lutim defaults -else - # Restauration des fichiers du script systemd - sudo cp -a $backup_dir/lutim.service /etc/systemd/system/lutim.service - ## Démarrage auto du service - sudo systemctl enable lutim.service +conf=/etc/nginx/conf.d/$domain.d/$app.conf +if [ -f $conf ]; then + ynh_die "There is already a nginx conf file at this path: $conf " fi +sudo cp -a ./nginx.conf $conf +#================================================= +# RESTORE OF THE MAIN DIR OF THE APP +#================================================= -# Restauration du fichier du cron -sudo cp -a $backup_dir/cron_$app /etc/cron.d/$app +sudo cp -a ./sources/. $final_path + +#================================================= +# RECREATE OF THE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Recreate the dedicated user, if not exist + +#================================================= +# RESTORE USER RIGHTS +#================================================= + +# Les fichiers appartiennent à root +sudo chown -R $app: $final_path + +#================================================= +# SPECIFIC RESTORE +#================================================= +# REINSTALL DEPENDENCIES +#================================================= + +ynh_install_app_dependencies carton perlmagick + +#================================================= +# ENABLE SERVICE IN ADMIN PANEL +#================================================= + +sudo yunohost service add $app --log "/var/log/$app/APP.log" + +#================================================= +# RESTORE SYSTEMD +#================================================= + +sudo cp -a ./systemd /etc/systemd/system/$app.service +## Démarrage auto du service +sudo systemctl enable $app.service + +#================================================= +# RESTORE OF THE CRON FILE +#================================================= + +sudo cp -a "cron" "/etc/cron.d/$app" + +#================================================= +# SETUP LOG FILE +#================================================= # Making log symbolic link to /var/log sudo mkdir -p /var/log/$app/ -sudo touch /var/log/$app/production.log -sudo chown www-data: /var/log/$app/production.log -# Restaure la configuration de logrotate -sudo cp -a $backup_dir/logrotate /etc/logrotate.d/$app +sudo touch /var/log/$app/production.log +sudo chown $app: -R /var/log/$app -# Restart webserver -sudo service nginx reload +#================================================= +# START LUTIM +#================================================= -# Start lutim -sudo service lutim start +sudo systemctl start lutim + +#================================================= +# GENERIC FINALISATION +#================================================= +# RELOAD NGINX +#================================================= + +sudo systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 866d55d..4de2f1f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -1,106 +1,170 @@ #!/bin/bash -source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script +#================================================= +# GENERIC STARTING +#================================================= +# IMPORT GENERIC HELPERS +#================================================= -# Récupère les infos de l'application. -app=$YNH_APP_INSTANCE_NAME - -# Source app helpers +source .fonctions source /usr/share/yunohost/helpers +#================================================= +# LOAD SETTINGS +#================================================= + +app=$YNH_APP_INSTANCE_NAME + domain=$(ynh_app_setting_get $app domain) -path=$(ynh_app_setting_get $app path) +path_url=$(ynh_app_setting_get $app path) is_public=$(ynh_app_setting_get $app is_public) port=$(ynh_app_setting_get $app port) always_encrypt=$(ynh_app_setting_get $app always_encrypt) final_path=$(ynh_app_setting_get $app final_path) +#================================================= +# FIX OLD THINGS +#================================================= + +if [ "$is_public" = "Yes" ]; then + ynh_app_setting_set $app is_public 1 # Fixe is_public en booléen + is_public=1 +elif [ "$is_public" = "No" ]; then + ynh_app_setting_set $app is_public 0 + is_public=0 +fi + if [ "${#final_path}" -eq 0 ] then # Si final_path n'est pas renseigné dans la config yunohost, cas d'ancien script, code final_path en dur final_path=/var/www/$app fi +if [ "$always_encrypt" = "Yes" ]; then + ynh_app_setting_set $app always_encrypt 1 # Fixe always_encrypt en booléen + always_encrypt=1 +elif [ "$always_encrypt" = "No" ]; then + ynh_app_setting_set $app always_encrypt 0 + always_encrypt=0 +fi -CHECK_PATH # Vérifie et corrige la syntaxe du path. -# Modifie le domaine pour qu'il passe dans une regex -domain_regex=$(echo "$domain" | sed 's@-@.@g') +#================================================= +# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +#================================================= -SETUP_SOURCE "lutim.tar.gz" # Télécharge la source, décompresse et copie dans $final_path +BACKUP_BEFORE_UPGRADE # Backup the current version of the app +ynh_clean_setup () { + BACKUP_FAIL_UPGRADE # restore it if the upgrade fails +} +ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. + +#================================================= +# CHECK THE PATH +#================================================= + +path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. + +#================================================= +# STANDARD UPGRADE STEPS +#================================================= +# DOWNLOAD, CHECK AND UNPACK SOURCE +#================================================= + +SETUP_SOURCE # Télécharge la source, décompresse et copie dans $final_path + +#================================================= +# NGINX CONFIGURATION +#================================================= # Et copie le fichier de config nginx sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf - # Change variables in nginx configuration -sudo sed -i "s@__PATH__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf +sudo sed -i "s@__PATH__@$path_url@g" /etc/nginx/conf.d/$domain.d/$app.conf sudo sed -i "s@__PORT__@$port@g" /etc/nginx/conf.d/$domain.d/$app.conf +#================================================= +# CREATE DEDICATED USER +#================================================= + +ynh_system_user_create $app # Create the dedicated user, if not exist + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# SETUP LUTIM +#================================================= + ## Copie et configuration du fichier de conf. CHECK_MD5_CONFIG "lutim.conf" "$final_path/lutim.conf" # Créé un backup du fichier de config si il a été modifié. sudo cp ../conf/lutim.conf.template "$final_path/lutim.conf" sudo sed -i "s@__DOMAIN__@$domain@g" "$final_path/lutim.conf" -sudo sed -i "s@__PATH__@$path@g" "$final_path/lutim.conf" +sudo sed -i "s@__PATH__@$path_url@g" "$final_path/lutim.conf" sudo sed -i "s@__PORT__@$port@g" "$final_path/lutim.conf" -if [ "always_encrypt" = "No" ]; then - always_encrypt=0 -else - always_encrypt=1 -fi sudo sed -i "s@__ENCRYPT__@$always_encrypt@g" "$final_path/lutim.conf" STORE_MD5_CONFIG "lutim.conf" "$final_path/lutim.conf" # Réenregistre la somme de contrôle du fichier de config -codename=$(lsb_release -a 2>/dev/null | grep Codename | cut -f 2) -ynh_app_setting_set $app codename $codename -if [ "$codename" = "wheezy" ] -then # On utilise le script init pour wheezy. - # Mise en place du script init - sudo cp ../conf/lutim.init /etc/init.d/lutim - sudo cp ../conf/lutim.default /etc/default/lutim - sudo chmod +x /etc/init.d/lutim - sudo chown root: /etc/init.d/lutim /etc/default/lutim - sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/default/lutim - ## Démarrage auto du service - sudo update-rc.d lutim defaults -else # Et le script systemd à partir de jessie - if [ -e /etc/init.d/lutim ] - then # Supprime le script init.d si il existe. - sudo rm -f /etc/default/lutim - sudo rm -f /etc/init.d/lutim - sudo update-rc.d -f lutim remove - fi - # Mise en place du script systemd - sudo cp ../conf/lutim.service /etc/systemd/system/lutim.service - sudo chown root:root /etc/systemd/system/lutim.service - sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/systemd/system/lutim.service - ## Démarrage auto du service - sudo systemctl enable lutim.service -fi +#================================================= +# SETUP SYSTEMD +#================================================= + +# Mise en place du script systemd +sudo systemctl stop $app +sudo cp ../conf/lutim.service /etc/systemd/system/$app.service +sudo chown root: /etc/systemd/system/$app.service +sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/systemd/system/$app.service +sudo sed -i "s@__APP__@$app@g" /etc/systemd/system/$app.service +## Démarrage auto du service +sudo systemctl enable $app + +#================================================= +# SETUP CRON +#================================================= -## Mise en place des crons sudo cp ../conf/cron_lutim /etc/cron.d/$app sudo sed -i "s@__FINALPATH__@$final_path/@g" /etc/cron.d/$app -# Configuration de logrotate -sed -i "s@__FINALPATH__@$final_path@g" ../conf/logrotate -sudo cp ../conf/logrotate /etc/logrotate.d/$app +#================================================= +# UPDATE LUTIM WITH CARTON +#================================================= -# Mise à jour de lutim via carton -cd $final_path +pushd $final_path # cd avec une stack pour revenir en arrière sudo carton install 2>&1 | sudo tee -a "/var/log/$app/setup_carton.log" +popd # Revient au dossier courant avant pushd + +#================================================= +# SECURING FILES AND DIRECTORIES +#================================================= + +sudo chown -R $app: $final_path + +#================================================= +# RESTART LUTIM +#================================================= + +sudo systemctl restart lutim + +#================================================= +# GENERIC FINALISATION +#================================================= +# SETUP LOGROTATE +#================================================= + +ynh_use_logrotate +sudo chown $app: -R /var/log/$app + +#================================================= +# SETUP SSOWAT +#================================================= -# Make app public or private ynh_app_setting_set $app skipped_uris "/" -if [ "$is_public" = "No" ]; +if [ $is_public -eq 0 ] then # Si l'app est privée, seul le visionnage des images reste public - ynh_app_setting_set $app protected_regex "$domain_regex$path/stats$","$domain_regex$path/manifest.webapp$","$domain_regex$path/$","$domain_regex$path/d/.*$","$domain_regex$path/m/.*$" + # Modifie le domaine pour qu'il passe dans une regex + domain_regex=$(echo "$domain" | sed 's@-@.@g') + ynh_app_setting_set $app protected_regex "$domain_regex$path_url/stats$","$domain_regex$path_url/manifest.webapp$","$domain_regex$path_url/$","$domain_regex$path_url/d/.*$","$domain_regex$path_url/m/.*$" fi -# Configure les droits d'accès au fichiers -sudo chown -R www-data: $final_path -# Restart lutim -sudo service lutim restart +#================================================= +# RELOAD NGINX +#================================================= - -# Recharge la configuration Nginx -sudo service nginx reload -# Régénère la configuration de SSOwat -sudo yunohost app ssowatconf +sudo systemctl reload nginx diff --git a/sources/source_dir b/sources/source_dir deleted file mode 100644 index ee81ef2..0000000 --- a/sources/source_dir +++ /dev/null @@ -1 +0,0 @@ -lutim-1082f42682988453aef2a130ce99d3eae2e950ba-1082f42682988453aef2a130ce99d3eae2e950ba \ No newline at end of file diff --git a/sources/source_md5 b/sources/source_md5 deleted file mode 100644 index 2c6025a..0000000 --- a/sources/source_md5 +++ /dev/null @@ -1 +0,0 @@ -1a9a8dec0e418a87a32799b0b875813a lutim.tar.gz \ No newline at end of file diff --git a/sources/source_url b/sources/source_url deleted file mode 100644 index 3fe379c..0000000 --- a/sources/source_url +++ /dev/null @@ -1 +0,0 @@ -https://git.framasoft.org/luc/lutim/repository/archive.tar.gz?ref=1082f42682988453aef2a130ce99d3eae2e950ba \ No newline at end of file