diff --git a/check_process b/check_process index 1e20307..a04343b 100644 --- a/check_process +++ b/check_process @@ -1,5 +1,4 @@ ;; Test complet - auto_remove=1 ; Manifest domain="domain.tld" (DOMAIN) path="/path" (PATH) @@ -16,14 +15,19 @@ multi_instance=0 incorrect_path=1 port_already_use=0 + change_url=0 ;;; Levels Level 1=auto Level 2=auto Level 3=auto Level 4=na - Level 5=auto +# Level 5: https://github.com/YunoHost-Apps/searx_ynh/issues/17 + Level 5=1 Level 6=auto Level 7=auto Level 8=0 Level 9=0 Level 10=0 +;;; Options +Email= +Notification=none diff --git a/manifest.json b/manifest.json index 643c7dd..5a33bc4 100644 --- a/manifest.json +++ b/manifest.json @@ -2,9 +2,6 @@ "name": "Searx", "id": "searx", "packaging_format": 1, - "requirements": { - "yunohost": ">= 2.4" - }, "description": { "en": "A privacy-respecting, hackable metasearch engine", "fr": "Un méta-moteur de recherche respectueux de la vie privée et bidouillable", @@ -17,6 +14,9 @@ "name": "opi", "email": "opi@zeropi.net" }, + "requirements": { + "yunohost": ">= 2.7.2" + }, "multi_instance": false, "services": [ "nginx", diff --git a/scripts/_common.sh b/scripts/_common.sh deleted file mode 100755 index 17bdf33..0000000 --- a/scripts/_common.sh +++ /dev/null @@ -1,502 +0,0 @@ -#!/bin/bash - -#================================================= -#================================================= -# TESTING -#================================================= -#================================================= - -ynh_nginx_config () { - finalnginxconf="/etc/nginx/conf.d/$domain.d/$app.conf" - ynh_backup_if_checksum_is_different "$finalnginxconf" 1 - sudo cp ../conf/nginx.conf "$finalnginxconf" - - # To avoid a break by set -u, use a void substitution ${var:-}. If the variable is not set, it's simply set with an empty variable. - # Substitute in a nginx config file only if the variable is not empty - if test -n "${path_url:-}"; then - ynh_replace_string "__PATH__" "$path_url" "$finalnginxconf" - fi - if test -n "${domain:-}"; then - ynh_replace_string "__DOMAIN__" "$domain" "$finalnginxconf" - fi - if test -n "${port:-}"; then - ynh_replace_string "__PORT__" "$port" "$finalnginxconf" - fi - if test -n "${app:-}"; then - ynh_replace_string "__NAME__" "$app" "$finalnginxconf" - fi - if test -n "${final_path:-}"; then - ynh_replace_string "__FINALPATH__" "$final_path" "$finalnginxconf" - fi - ynh_store_file_checksum "$finalnginxconf" - - sudo systemctl reload nginx -} - -ynh_remove_nginx_config () { - ynh_secure_remove "/etc/nginx/conf.d/$domain.d/$app.conf" - sudo systemctl reload nginx -} - -#================================================= -#================================================= - -#================================================= -# CHECKING -#================================================= - -CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine. - if sudo yunohost app --help | grep --quiet url-available - then - # Check availability of a web path - ynh_webpath_available $domain $path_url - # Register/book a web path for an app - ynh_webpath_register $app $domain $path_url - else - # Use the legacy command - sudo yunohost app checkurl $domain$path_url -a $app - fi -} - -#================================================= -# DISPLAYING -#================================================= - -WARNING () { # Écrit sur le canal d'erreur pour passer en warning. - $@ >&2 -} - -QUIET () { # Redirige la sortie standard dans /dev/null - $@ > /dev/null -} - -#================================================= -# 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 -} - -# Ce helper est temporaire et sert de remplacement à la véritable fonction ynh_restore_file. Le temps qu'elle arrive... -ynh_restore_file () { - if [ -f "$1" ]; then - ynh_die "There is already a file at this path: $1" - fi - sudo cp -a "${YNH_APP_BACKUP_DIR}$1" "$1" -} - -#================================================= -#================================================= -# 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 -#================================================= - -# 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 -# ynh_normalize_url_path / -> / -# -# 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 -} - -# 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_abort_if_errors. -# 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 -} - -# Define and install dependencies with a equivs control file -# This helper can/should only be called once per app -# -# 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 grep '\"version\": ' "$manifest_path" | cut -d '"' -f 4) # 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. -} - -# Create a system user -# -# usage: ynh_system_user_create user_name [home_dir] -# | arg: user_name - Name of the system user that will be create -# | arg: home_dir - Path of the home dir for the user. Usually the final path of the app. If this argument is omitted, the user will be created without home -ynh_system_user_create () { - if ! ynh_system_user_exists "$1" # Check if the user exists on the system - then # If the user doesn't exist - if [ $# -ge 2 ]; then # If a home dir is mentioned - user_home_dir="-d $2" - else - user_home_dir="--no-create-home" - fi - sudo useradd $user_home_dir --system --user-group $1 --shell /usr/sbin/nologin || ynh_die "Unable to create $1 system account" - fi -} - -# Delete a system user -# -# usage: ynh_system_user_delete user_name -# | arg: user_name - Name of the system user that will be create -ynh_system_user_delete () { - if ynh_system_user_exists "$1" # Check if the user exists on the system - then - echo "Remove the user $1" >&2 - sudo userdel $1 - else - echo "The user $1 was not found" >&2 - fi -} - -# Substitute/replace a string by another in a file -# -# usage: ynh_replace_string match_string replace_string target_file -# | arg: match_string - String to be searched and replaced in the file -# | arg: replace_string - String that will replace matches -# | arg: target_file - File in which the string will be replaced. -ynh_replace_string () { - delimit=@ - match_string=${1//${delimit}/"\\${delimit}"} # Escape the delimiter if it's in the string. - replace_string=${2//${delimit}/"\\${delimit}"} - workfile=$3 - - sudo sed --in-place "s${delimit}${match_string}${delimit}${replace_string}${delimit}g" "$workfile" -} - -# Remove a file or a directory securely -# -# usage: ynh_secure_remove path_to_remove -# | arg: path_to_remove - File or directory to remove -ynh_secure_remove () { - path_to_remove=$1 - forbidden_path=" \ - /var/www \ - /home/yunohost.app" - - if [[ "$forbidden_path" =~ "$path_to_remove" \ - # Match all paths or subpaths in $forbidden_path - || "$path_to_remove" =~ ^/[[:alnum:]]+$ \ - # Match all first level paths from / (Like /var, /root, etc...) - || "${path_to_remove:${#path_to_remove}-1}" = "/" ]] - # Match if the path finishes by /. Because it seems there is an empty variable - then - echo "Avoid deleting $path_to_remove." >&2 - else - if [ -e "$path_to_remove" ] - then - sudo rm -R "$path_to_remove" - else - echo "$path_to_remove wasn't deleted because it doesn't exist." >&2 - fi - fi -} - -# Download, check integrity, uncompress and patch the source from app.src -# -# The file conf/app.src need to contains: -# -# SOURCE_URL=Address to download the app archive -# SOURCE_SUM=Control sum -# # (Optional) Programm to check the integrity (sha256sum, md5sum$YNH_EXECUTION_DIR/...) -# # default: sha256 -# SOURCE_SUM_PRG=sha256 -# # (Optional) Archive format -# # default: tar.gz -# SOURCE_FORMAT=tar.gz -# # (Optional) Put false if source are directly in the archive root -# # default: true -# SOURCE_IN_SUBDIR=false -# # (Optionnal) Name of the local archive (offline setup support) -# # default: ${src_id}.${src_format} -# SOURCE_FILENAME=example.tar.gz -# -# Details: -# This helper download sources from SOURCE_URL if there is no local source -# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME -# -# Next, it check the integrity with "SOURCE_SUM_PRG -c --status" command. -# -# If it's ok, the source archive will be uncompress in $dest_dir. If the -# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be -# removed. -# -# Finally, patches named sources/patches/${src_id}-*.patch and extra files in -# sources/extra_files/$src_id will be applyed to dest_dir -# -# -# usage: ynh_setup_source dest_dir [source_id] -# | arg: dest_dir - Directory where to setup sources -# | arg: source_id - Name of the app, if the package contains more than one app -YNH_EXECUTION_DIR="." -ynh_setup_source () { - local dest_dir=$1 - local src_id=${2:-app} # If the argument is not given, source_id equal "app" - - # Load value from configuration file (see above for a small doc about this file - # format) - local src_url=$(grep 'SOURCE_URL=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sum=$(grep 'SOURCE_SUM=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_format=$(grep 'SOURCE_FORMAT=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - local src_filename=$(grep 'SOURCE_FILENAME=' "$YNH_EXECUTION_DIR/../conf/${src_id}.src" | cut -d= -f2-) - - # Default value - src_sumprg=${src_sumprg:-sha256sum} - src_in_subdir=${src_in_subdir:-true} - src_format=${src_format:-tar.gz} - src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') - if [ "$src_filename" = "" ] ; then - src_filename="${src_id}.${src_format}" - fi - local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" - - if test -e "$local_src" - then # Use the local source file if it is present - cp $local_src $src_filename - else # If not, download the source - wget -nv -O $src_filename $src_url - fi - - # Check the control sum - echo "${src_sum} ${src_filename}" | ${src_sumprg} -c --status \ - || ynh_die "Corrupt source" - - # Extract source into the app dir - sudo mkdir -p "$dest_dir" - if [ "$src_format" = "zip" ] - then - # Zip format - # Using of a temp directory, because unzip doesn't manage --strip-components - if $src_in_subdir ; then - local tmp_dir=$(mktemp -d) - sudo unzip -quo $src_filename -d "$tmp_dir" - sudo cp -a $tmp_dir/*/. "$dest_dir" - ynh_secure_remove "$tmp_dir" - else - sudo unzip -quo $src_filename -d "$dest_dir" - fi - else - local strip="" - if $src_in_subdir ; then - strip="--strip-components 1" - fi - if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] ; then - sudo tar -xf $src_filename -C "$dest_dir" $strip - else - ynh_die "Archive format unrecognized." - fi - fi - - # Apply patches - if (( $(find $YNH_EXECUTION_DIR/../sources/patches/ -type f -name "${src_id}-*.patch" 2> /dev/null | wc -l) > "0" )); then - local old_dir=$(pwd) - (cd "$dest_dir" \ - && for p in $YNH_EXECUTION_DIR/../sources/patches/${src_id}-*.patch; do \ - sudo patch -p1 < $p; done) \ - || ynh_die "Unable to apply patches" - cd $old_dir - fi - - # Add supplementary files - if test -e "$YNH_EXECUTION_DIR/../sources/extra_files/${src_id}"; then - sudo cp -a $YNH_EXECUTION_DIR/../sources/extra_files/$src_id/. "$dest_dir" - fi -} - -# Check availability of a web path -# -# example: ynh_webpath_available some.domain.tld /coffee -# -# usage: ynh_webpath_available domain path -# | arg: domain - the domain/host of the url -# | arg: path - the web path to check the availability of -ynh_webpath_available () { - local domain=$1 - local path=$2 - sudo yunohost domain url-available $domain $path -} - -# Register/book a web path for an app -# -# example: ynh_webpath_register wordpress some.domain.tld /coffee -# -# usage: ynh_webpath_register app domain path -# | arg: app - the app for which the domain should be registered -# | arg: domain - the domain/host of the web path -# | arg: path - the web path to be registered -ynh_webpath_register () { - local app=$1 - local domain=$2 - local path=$3 - sudo yunohost app register-url $app $domain $path -} - -# Calculate and store a file checksum into the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_store_file_checksum file -# | arg: file - The file on which the checksum will performed, then stored. -ynh_store_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_set $app $checksum_setting_name $(sudo md5sum "$1" | cut -d' ' -f1) -} - -# Verify the checksum and backup the file if it's different -# This helper is primarily meant to allow to easily backup personalised/manually -# modified config files. -# -# $app should be defined when calling this helper -# -# usage: ynh_backup_if_checksum_is_different file -# | arg: file - The file on which the checksum test will be perfomed. -# -# | ret: Return the name a the backup file, or nothing -ynh_backup_if_checksum_is_different () { - local file=$1 - local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_' - local checksum_value=$(ynh_app_setting_get $app $checksum_setting_name) - if [ -n "$checksum_value" ] - then # Proceed only if a value was stored into the app settings - if ! echo "$checksum_value $file" | sudo md5sum -c --status - then # If the checksum is now different - backup_file="/home/yunohost.conf/backup/$file.backup.$(date '+%Y%m%d.%H%M%S')" - sudo mkdir -p "$(dirname "$backup_file")" - sudo cp -a "$file" "$backup_file" # Backup the current file - echo "File $file has been manually modified since the installation or last upgrade. So it has been duplicated in $backup_file" >&2 - echo "$backup_file" # Return the name of the backup file - fi - fi -} diff --git a/scripts/backup b/scripts/backup index 6781d9d..96afb05 100755 --- a/scripts/backup +++ b/scripts/backup @@ -13,12 +13,12 @@ set -eu # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +# if [ ! -e _common.sh ]; then +# # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant +# cp ../settings/scripts/_common.sh ./_common.sh +# chmod a+rx _common.sh +# fi +# source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -37,14 +37,13 @@ domain=$(ynh_app_setting_get $app domain) # BACKUP OF THE MAIN DIR OF THE APP #================================================= -CHECK_SIZE "$final_path" -ynh_backup "$final_path" "${YNH_APP_BACKUP_DIR}$final_path" +ynh_backup "$final_path" #================================================= # BACKUP OF THE NGINX CONFIGURATION #================================================= -ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/nginx/conf.d/$domain.d/$app.conf" +ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= # SPECIFIC BACKUP @@ -52,4 +51,4 @@ ynh_backup "/etc/nginx/conf.d/$domain.d/$app.conf" "${YNH_APP_BACKUP_DIR}/etc/ng # BACKUP OF THE UWSGI CONFIG #================================================= -ynh_backup "/etc/uwsgi/apps-available/$app.ini" "${YNH_APP_BACKUP_DIR}/etc/uwsgi/apps-available/$app.ini" +ynh_backup "/etc/uwsgi/apps-available/$app.ini" diff --git a/scripts/install b/scripts/install index 8b41762..4e898b4 100644 --- a/scripts/install +++ b/scripts/install @@ -6,14 +6,15 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh +# source _common.sh 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. +# Exit if an error occurs during the execution of the script +ynh_abort_if_errors #================================================= # RETRIEVE ARGUMENTS FROM THE MANIFEST @@ -29,12 +30,17 @@ app=$YNH_APP_INSTANCE_NAME # CHECK IF THE APP CAN BE INSTALLED WITH THIS ARGS #================================================= -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 final_path final_path="/opt/yunohost/$app" test ! -e "$final_path" || ynh_die "This path already contains a folder" +# Normalize the url path syntax +path_url=$(ynh_normalize_url_path $path_url) + +# Check web path availability +ynh_webpath_available $domain $path_url +# Register (book) web path +ynh_webpath_register $app $domain $path_url + #================================================= # STORE SETTINGS FROM MANIFEST #================================================= @@ -55,11 +61,11 @@ ynh_install_app_dependencies git build-essential libxslt-dev python-dev python-v # NGINX CONFIGURATION #================================================= -ynh_nginx_config +ynh_add_nginx_config if [ "$path_url" = "/" ] then ynh_replace_string "__PATH_NO_ROOT__" "" /etc/nginx/conf.d/$domain.d/$app.conf - sudo sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf else ynh_replace_string "#noroot" "" /etc/nginx/conf.d/$domain.d/$app.conf ynh_replace_string "__PATH_NO_ROOT__" "$path_url" /etc/nginx/conf.d/$domain.d/$app.conf @@ -70,14 +76,16 @@ ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" # CREATE DEDICATED USER #================================================= -ynh_system_user_create $app # Créer un utilisateur système dédié à l'app +# Create a system user +ynh_system_user_create $app #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_app_setting_set $app final_path $final_path -ynh_setup_source "$final_path" # Télécharge la source, décompresse et copie dans $final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source "$final_path" #================================================= # SPECIFIC SETUP @@ -85,14 +93,14 @@ ynh_setup_source "$final_path" # Télécharge la source, décompresse et copie d # INSTALL SEARX IN A VIRTUALENV #================================================= -sudo virtualenv --system-site-packages "$final_path" -sudo bash -c "source $final_path/bin/activate && pip install --requirement $final_path/requirements-ynh.txt" +virtualenv --system-site-packages "$final_path" +bash -c "source $final_path/bin/activate && pip install --requirement $final_path/requirements-ynh.txt" #================================================= # CONFIGURE SEARX #================================================= -sudo cp ../conf/settings.yml "$final_path/searx/" +cp ../conf/settings.yml "$final_path/searx/" # Generate a secret key ynh_replace_string "__SECRETKEY__" "$(ynh_string_random)" "$final_path/searx/settings.yml" @@ -110,24 +118,24 @@ ynh_store_file_checksum "$final_path/searx/settings.yml" # SET PERMISSIONS ON SEARX DIRECTORY #================================================= -sudo chown $app: --recursive "$final_path" +chown $app: --recursive "$final_path" #================================================= # CONFIGURE UWSGI FOR SEARX #================================================= -sudo cp ../conf/searx.ini /etc/uwsgi/apps-available/$app.ini +cp ../conf/searx.ini /etc/uwsgi/apps-available/$app.ini ynh_replace_string "__APP__" "$app" /etc/uwsgi/apps-available/$app.ini ynh_replace_string "__FINALPATH__" "$final_path" /etc/uwsgi/apps-available/$app.ini -sudo ln -s /etc/uwsgi/apps-available/$app.ini /etc/uwsgi/apps-enabled/$app.ini +ln -s /etc/uwsgi/apps-available/$app.ini /etc/uwsgi/apps-enabled/$app.ini #================================================= # ENABLE UWSGI SERVICE IN ADMIN PANEL #================================================= -sudo systemctl restart uwsgi +systemctl restart uwsgi # Ajoute le service au monitoring de Yunohost. -sudo yunohost service add uwsgi --log "/var/log/uwsgi/app/$app.log" +yunohost service add uwsgi --log "/var/log/uwsgi/app/$app.log" #================================================= # GENERIC FINALISATION @@ -135,6 +143,7 @@ sudo yunohost service add uwsgi --log "/var/log/uwsgi/app/$app.log" # SETUP SSOWAT #================================================= +# Make app public if necessary if [ $is_public -eq 1 ] then ynh_app_setting_set $app skipped_uris "/" @@ -144,4 +153,4 @@ fi # RELOAD NGINX #================================================= -sudo systemctl reload nginx +systemctl reload nginx diff --git a/scripts/remove b/scripts/remove index 8319fdd..611f594 100644 --- a/scripts/remove +++ b/scripts/remove @@ -6,7 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh +# source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -23,8 +23,8 @@ domain=$(ynh_app_setting_get $app domain) # STOP AND REMOVE SERVICE #================================================= -# Suppression de la configuration uwsgi -sudo systemctl stop uwsgi +# Remove the uwsgi configuration +systemctl stop uwsgi if [ -h "/etc/uwsgi/apps-enabled/$app.ini" ]; then echo "Delete uwsgi config" ynh_secure_remove "/etc/uwsgi/apps-enabled/$app.ini" @@ -47,7 +47,8 @@ ynh_secure_remove "/opt/yunohost/$app" # REMOVE THE NGINX CONFIGURATION #================================================= -ynh_remove_nginx_config # Suppression de la configuration nginx +# Remove the dedicated nginx config +ynh_remove_nginx_config #================================================= # DISABLE SERVICE IN ADMIN PANEL @@ -56,12 +57,12 @@ ynh_remove_nginx_config # Suppression de la configuration nginx if [ -e /etc/init.d/uwsgi ] then # Redémarre le service uwsgi si il n'est pas désinstallé. - sudo systemctl start uwsgi + systemctl start uwsgi else - if sudo yunohost service status | grep -q uwsgi # Test l'existence du service dans Yunohost + if yunohost service status | grep -q uwsgi # Test l'existence du service dans Yunohost then echo "Remove uwsgi service" - sudo yunohost service remove uwsgi + yunohost service remove uwsgi fi fi @@ -71,4 +72,5 @@ fi # REMOVE DEDICATED USER #================================================= +# Delete a system user ynh_system_user_delete $app diff --git a/scripts/restore b/scripts/restore index b4211af..ddbe66f 100755 --- a/scripts/restore +++ b/scripts/restore @@ -13,12 +13,12 @@ set -eu # IMPORT GENERIC HELPERS #================================================= -if [ ! -e _common.sh ]; then - # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant - sudo cp ../settings/scripts/_common.sh ./_common.sh - sudo chmod a+rx _common.sh -fi -source _common.sh +# if [ ! -e _common.sh ]; then +# # Rapatrie le fichier de fonctions si il n'est pas dans le dossier courant +# cp ../settings/scripts/_common.sh ./_common.sh +# chmod a+rx _common.sh +# fi +# source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -35,7 +35,7 @@ path_url=$(ynh_app_setting_get $app path) # CHECK IF THE APP CAN BE RESTORED #================================================= -sudo yunohost app checkurl "${domain}${path_url}" -a "$app" \ +ynh_webpath_available $domain $path_url \ || ynh_die "Path not available: ${domain}${path_url}" test ! -d $final_path \ || ynh_die "There is already a directory: $final_path " @@ -52,7 +52,7 @@ ynh_restore_file "/etc/nginx/conf.d/$domain.d/$app.conf" # RESTORE OF THE MAIN DIR OF THE APP #================================================= -sudo mkdir -p /opt/yunohost +mkdir -p /opt/yunohost ynh_restore_file "$final_path" #================================================= @@ -65,7 +65,8 @@ ynh_install_app_dependencies libxslt-dev virtualenv python-pybabel zlib1g-dev li # RECREATE OF THE DEDICATED USER #================================================= -ynh_system_user_create $app # Recreate the dedicated user, if not exist +# Create the dedicated user (if not existing) +ynh_system_user_create $app #================================================= # SPECIFIC RESTORE @@ -73,14 +74,14 @@ ynh_system_user_create $app # Recreate the dedicated user, if not exist # RESTORE USER RIGHTS #================================================= -sudo chown $app: --recursive "$final_path" +chown $app: --recursive "$final_path" #================================================= # RESTORE THE UWSGI CONFIG #================================================= ynh_restore_file "/etc/uwsgi/apps-available/$app.ini" -sudo ln -s /etc/uwsgi/apps-available/$app.ini /etc/uwsgi/apps-enabled/$app.ini +ln -s /etc/uwsgi/apps-available/$app.ini /etc/uwsgi/apps-enabled/$app.ini #================================================= # GENERIC FINALISATION @@ -88,5 +89,5 @@ sudo ln -s /etc/uwsgi/apps-available/$app.ini /etc/uwsgi/apps-enabled/$app.ini # RELOAD NGINX AND UWSGI #================================================= -sudo systemctl restart uwsgi -sudo systemctl reload nginx +systemctl restart uwsgi +systemctl reload nginx diff --git a/scripts/upgrade b/scripts/upgrade index 9bb87c4..7c6c81f 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -6,7 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh +# source _common.sh source /usr/share/yunohost/helpers #================================================= @@ -24,15 +24,17 @@ final_path=$(ynh_app_setting_get $app final_path) # FIX OLD THINGS #================================================= +# Fix is_public as a boolean value if [ "$is_public" = "Yes" ]; then - ynh_app_setting_set $app is_public 1 # Fixe is_public en booléen + ynh_app_setting_set $app is_public 1 is_public=1 elif [ "$is_public" = "No" ]; then ynh_app_setting_set $app is_public 0 is_public=0 fi -if [ -z $final_path ]; then # Si final_path n'est pas renseigné dans app setting +# If final_path doesn't exist, create it +if [ -z $final_path ]; then final_path="/opt/yunohost/$app" ynh_app_setting_set $app final_path $final_path fi @@ -41,17 +43,18 @@ fi # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -BACKUP_BEFORE_UPGRADE # Backup the current version of the app +ynh_backup_before_upgrade # Backup the current version of the app ynh_clean_setup () { - BACKUP_FAIL_UPGRADE # restore it if the upgrade fails + ynh_restore_upgradebackup # restore it if the upgrade fails } -ynh_abort_if_errors # Active trap pour arrêter le script si une erreur est détectée. +ynh_abort_if_errors # Exit if an error occurs during the execution of the script #================================================= # CHECK THE PATH #================================================= -path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du path. +# Normalize the URL path syntax +path_url=$(ynh_normalize_url_path $path_url) #================================================= # STANDARD UPGRADE STEPS @@ -59,17 +62,18 @@ path_url=$(ynh_normalize_url_path $path_url) # Vérifie et corrige la syntaxe du # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_setup_source "$final_path" # Télécharge la source, décompresse et copie dans $final_path +# Download, check integrity, uncompress and patch the source from app.src +ynh_setup_source "$final_path" #================================================= # NGINX CONFIGURATION #================================================= -ynh_nginx_config +ynh_add_nginx_config if [ "$path_url" = "/" ] then ynh_replace_string "__PATH_NO_ROOT__" "" /etc/nginx/conf.d/$domain.d/$app.conf - sudo sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf + sed --in-place '/#noroot*/d' /etc/nginx/conf.d/$domain.d/$app.conf else ynh_replace_string "#noroot" "" /etc/nginx/conf.d/$domain.d/$app.conf ynh_replace_string "__PATH_NO_ROOT__" "$path_url" /etc/nginx/conf.d/$domain.d/$app.conf @@ -80,7 +84,8 @@ ynh_store_file_checksum "/etc/nginx/conf.d/$domain.d/$app.conf" # CREATE DEDICATED USER #================================================= -ynh_system_user_create $app # Create the dedicated user, if not exist +# Create a system user +ynh_system_user_create $app #================================================= # SPECIFIC UPGRADE @@ -88,17 +93,17 @@ ynh_system_user_create $app # Create the dedicated user, if not exist # UPGRADE SEARX IN ITS VIRTUALENV #================================================= -sudo virtualenv --system-site-packages "$final_path" -sudo bash -c "source $final_path/bin/activate && pip install --requirement $final_path/requirements-ynh.txt --upgrade" +virtualenv --system-site-packages "$final_path" +bash -c "source $final_path/bin/activate && pip install --requirement $final_path/requirements-ynh.txt --upgrade" #================================================= # CONFIGURE SEARX #================================================= -# Créé un backup du fichier de config si il a été modifié. +# Verify the checksum and backup the file if it's different ynh_backup_if_checksum_is_different "$final_path/searx/settings.yml" -sudo cp ../conf/settings.yml "$final_path/searx/" +cp ../conf/settings.yml "$final_path/searx/" # Generate a secret key ynh_replace_string "__SECRETKEY__" "$(ynh_string_random)" "$final_path/searx/settings.yml" @@ -118,21 +123,22 @@ ynh_store_file_checksum "$final_path/searx/settings.yml" # SECURING FILES AND DIRECTORIES #================================================= -sudo chown $app: --recursive "$final_path" +chown $app: --recursive "$final_path" #================================================= # CONFIGURE UWSGI FOR SEARX #================================================= -sudo cp ../conf/searx.ini /etc/uwsgi/apps-available/$app.ini +cp ../conf/searx.ini /etc/uwsgi/apps-available/$app.ini ynh_replace_string "__APP__" "$app" /etc/uwsgi/apps-available/$app.ini ynh_replace_string "__FINALPATH__" "$final_path" /etc/uwsgi/apps-available/$app.ini -sudo systemctl restart uwsgi +systemctl restart uwsgi #================================================= # SETUP SSOWAT #================================================= +# Make app public if necessary if [ $is_public -eq 1 ] then ynh_app_setting_set $app skipped_uris "/" @@ -142,4 +148,4 @@ fi # RELOAD NGINX #================================================= -sudo systemctl reload nginx +systemctl reload nginx