From 569efe3ed3886ea5c3318a925c78756abbacff26 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Thu, 7 Jul 2022 03:08:58 +0200 Subject: [PATCH 1/5] Upgrade to 4.2.1~ynh1 --- .github/workflows/updater.sh | 107 +++++++++++++++++++++++++++++ .github/workflows/updater.yml | 49 +++++++++++++ check_process | 14 ++-- conf/app.src | 9 +-- conf/nginx.conf | 7 +- manifest.json | 38 +++++----- scripts/_common.sh | 2 +- scripts/backup | 3 +- scripts/change_url | 9 ++- scripts/install | 93 ++++++++++++++----------- scripts/remove | 2 +- scripts/restore | 43 +++++++----- scripts/upgrade | 94 ++++++++++++++----------- sources/extra_files/app/.gitignore | 2 - sources/patches/.gitignore | 2 - 15 files changed, 327 insertions(+), 147 deletions(-) create mode 100644 .github/workflows/updater.sh create mode 100644 .github/workflows/updater.yml delete mode 100644 sources/extra_files/app/.gitignore delete mode 100644 sources/patches/.gitignore diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh new file mode 100644 index 0000000..4c864cb --- /dev/null +++ b/.github/workflows/updater.sh @@ -0,0 +1,107 @@ +#!/bin/bash + +#================================================= +# PACKAGE UPDATING HELPER +#================================================= + +# This script is meant to be run by GitHub Actions +# The YunoHost-Apps organisation offers a template Action to run this script periodically +# Since each app is different, maintainers can adapt its contents so as to perform +# automatic actions when a new upstream release is detected. + +#================================================= +# FETCHING LATEST RELEASE AND ITS ASSETS +#================================================= + +# Fetching information +current_version=$(cat manifest.json | jq -j '.version|split("~")[0]') +repo=$(cat manifest.json | jq -j '.upstream.code|split("https://github.com/")[1]') +# Some jq magic is needed, because the latest upstream release is not always the latest version (e.g. security patches for older versions) +version=$(curl --silent "https://api.github.com/repos/$repo/tags" | jq -r '.[] | select( .prerelease != true ) | .name' | sort -V | tail -1) +assets="https://github.com/YesWiki/yeswiki/archive/refs/tags/$version.tar.gz" + +# Later down the script, we assume the version has only digits and dots +# Sometimes the release name starts with a "v", so let's filter it out. +# You may need more tweaks here if the upstream repository has different naming conventions. +if [[ ${version:0:1} == "v" || ${version:0:1} == "V" ]]; then + version=${version:1} +fi + +# Setting up the environment variables +echo "Current version: $current_version" +echo "Latest release from upstream: $version" +echo "VERSION=$version" >> $GITHUB_ENV +echo "REPO=$repo" >> $GITHUB_ENV +# For the time being, let's assume the script will fail +echo "PROCEED=false" >> $GITHUB_ENV + +# Proceed only if the retrieved version is greater than the current one +if ! dpkg --compare-versions "$current_version" "lt" "$version" ; then + echo "::warning ::No new version available" + exit 0 +# Proceed only if a PR for this new version does not already exist +elif git ls-remote -q --exit-code --heads https://github.com/$GITHUB_REPOSITORY.git ci-auto-update-v$version ; then + echo "::warning ::A branch already exists for this update" + exit 0 +fi + +#================================================= +# UPDATE SOURCE FILES +#================================================= + +# Let's download source tarball +asset_url=$assets + +echo "Handling asset at $asset_url" + +src="app" + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download sources and calculate checksum +filename=${asset_url##*/} +curl --silent -4 -L $asset_url -o "$tempdir/$filename" +checksum=$(sha256sum "$tempdir/$filename" | head -c 64) + +# Delete temporary directory +rm -rf $tempdir + +# Get extension +if [[ $filename == *.tar.gz ]]; then + extension=tar.gz +else + extension=${filename##*.} +fi + +# Rewrite source file +cat < conf/$src.src +SOURCE_URL=$asset_url +SOURCE_SUM=$checksum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=$extension +SOURCE_IN_SUBDIR=true +SOURCE_FILENAME= +SOURCE_EXTRACT=true +EOT +echo "... conf/$src.src updated" + +#================================================= +# SPECIFIC UPDATE STEPS +#================================================= + +# Any action on the app's source code can be done. +# The GitHub Action workflow takes care of committing all changes after this script ends. + +#================================================= +# GENERIC FINALIZATION +#================================================= + +# Replace new version in manifest +echo "$(jq -s --indent 4 ".[] | .version = \"$version~ynh1\"" manifest.json)" > manifest.json + +# No need to update the README, yunohost-bot takes care of it + +# The Action will proceed only if the PROCEED environment variable is set to true +echo "PROCEED=true" >> $GITHUB_ENV +exit 0 diff --git a/.github/workflows/updater.yml b/.github/workflows/updater.yml new file mode 100644 index 0000000..fb72ba0 --- /dev/null +++ b/.github/workflows/updater.yml @@ -0,0 +1,49 @@ +# This workflow allows GitHub Actions to automagically update your app whenever a new upstream release is detected. +# You need to enable Actions in your repository settings, and fetch this Action from the YunoHost-Apps organization. +# This file should be enough by itself, but feel free to tune it to your needs. +# It calls updater.sh, which is where you should put the app-specific update steps. +name: Check for new upstream releases +on: + # Allow to manually trigger the workflow + workflow_dispatch: + # Run it every day at 6:00 UTC + schedule: + - cron: '0 6 * * *' +jobs: + updater: + runs-on: ubuntu-latest + steps: + - name: Fetch the source code + uses: actions/checkout@v2 + with: + token: ${{ secrets.GITHUB_TOKEN }} + - name: Run the updater script + id: run_updater + run: | + # Setting up Git user + git config --global user.name 'yunohost-bot' + git config --global user.email 'yunohost-bot@users.noreply.github.com' + # Run the updater script + /bin/bash .github/workflows/updater.sh + - name: Commit changes + id: commit + if: ${{ env.PROCEED == 'true' }} + run: | + git commit -am "Upgrade to v$VERSION" + - name: Create Pull Request + id: cpr + if: ${{ env.PROCEED == 'true' }} + uses: peter-evans/create-pull-request@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} + commit-message: Update to version ${{ env.VERSION }} + committer: 'yunohost-bot ' + author: 'yunohost-bot ' + signoff: false + base: testing + branch: ci-auto-update-v${{ env.VERSION }} + delete-branch: true + title: 'Upgrade to version ${{ env.VERSION }}' + body: | + Upgrade to v${{ env.VERSION }} + draft: false diff --git a/check_process b/check_process index 3986c80..10e61d7 100644 --- a/check_process +++ b/check_process @@ -3,9 +3,9 @@ ; Manifest domain="domain.tld" path="/path" - admin="john" - language="fr" is_public=1 + language="fr" + admin="john" wiki_name="MyYunoHostWiki" ; Actions is_public=1|0 @@ -23,16 +23,16 @@ setup_private=1 setup_public=1 upgrade=1 + # 2021-05-18-2~ynh2 upgrade=1 from_commit=792c90c592f52f8fb1a89c22ab9b73f1e0bc2a3d + # 2022.01.16.13~ynh1 + upgrade=1 from_commit=f577a55539cb2ff54b5cee099e1e22aa4ccea186 backup_restore=1 multi_instance=1 + port_already_use=0 change_url=1 actions=0 config_panel=0 ;;; Options Email= -Notification=change -;;; Upgrade options - ; commit=792c90c592f52f8fb1a89c22ab9b73f1e0bc2a3d - name=Merge branch 'testing' into master - manifest_arg=domain=DOMAIN&path=PATH&admin=USER&password=password&is_public=1& +Notification=none diff --git a/conf/app.src b/conf/app.src index b3233e6..f5f5e69 100644 --- a/conf/app.src +++ b/conf/app.src @@ -1,6 +1,7 @@ -SOURCE_URL=https://repository.yeswiki.net/doryphore/yeswiki-doryphore-2022-01-16-13.zip -SOURCE_SUM=2239572babfbd46e8b79ac6333827c55225b2f70990d51e934e82fda8894165f +SOURCE_URL=https://github.com/YesWiki/yeswiki/archive/refs/tags/v4.2.1.tar.gz +SOURCE_SUM=c2819433dec177361ceb9f89e9184650a519e0110d8f6716e34dccc7aa46014a SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=zip +SOURCE_FORMAT=tar.gz SOURCE_IN_SUBDIR=true -SOURCE_FILENAME=yeswiki-doryphore-2022-01-16-13.zip +SOURCE_FILENAME= +SOURCE_EXTRACT=true diff --git a/conf/nginx.conf b/conf/nginx.conf index 1bdcdb6..6d5a3bf 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -2,12 +2,7 @@ location __PATH__/ { # Path to source - alias __FINALPATH__/ ; - - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } + alias __FINALPATH__/; index index.php; diff --git a/manifest.json b/manifest.json index be32741..92c2a86 100644 --- a/manifest.json +++ b/manifest.json @@ -6,9 +6,9 @@ "en": "Wiki that is quick and easy to use", "fr": "Wiki facile et rapide à prendre en main" }, - "version": "2022.01.16.13~ynh1", + "version": "4.2.1~ynh1", "url": "https://yeswiki.net/", - "upstream": { + "upstream": { "license": "AGPL-3.0-only", "website": "https://yeswiki.net/", "demo": "https://ferme.yeswiki.net/?CreerSonWiki", @@ -32,7 +32,7 @@ } ], "requirements": { - "yunohost": ">= 4.2.3" + "yunohost": ">= 4.3.0" }, "multi_instance": true, "services": [ @@ -52,10 +52,6 @@ "example": "/yeswiki", "default": "/yeswiki" }, - { - "name": "admin", - "type": "user" - }, { "name": "is_public", "type": "boolean", @@ -63,7 +59,21 @@ "help": { "en": "If YesWiki is made public anyone will be able to view the wiki", "fr": "Si YesWiki est rendu publique toute personne pourra consulter le wiki" - } + } + }, + { + "name": "language", + "type": "string", + "ask": { + "en": "Choose the application language", + "fr": "Choisissez la langue de l'application" + }, + "choices": ["fr", "en", "ca", "es", "nl", "pt"], + "default": "fr" + }, + { + "name": "admin", + "type": "user" }, { "name": "wiki_name", @@ -76,17 +86,7 @@ "help": { "en": "If you want a name with spaces: replace them with %20 for each space.", "fr": "Si vous souhaitez un nom avec des espacements : remplacez les par %20 pour chaque espace" - } - }, - { - "name": "language", - "type": "string", - "ask": { - "en": "Choose the application language", - "fr": "Choisissez la langue de l'application" - }, - "choices": ["fr", "en", "ca", "es", "nl", "pt"], - "default": "fr" + } } ] } diff --git a/scripts/_common.sh b/scripts/_common.sh index 67cb766..d24124d 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,7 +7,7 @@ YNH_PHP_VERSION="7.3" # dependencies used by the app -extra_php_dependencies="php${YNH_PHP_VERSION}-zip" +pkg_dependencies="php${YNH_PHP_VERSION}-zip" loginldap_version="2021-03-01-2" diff --git a/scripts/backup b/scripts/backup index 33b53ee..86cad22 100755 --- a/scripts/backup +++ b/scripts/backup @@ -6,7 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= -#Keep this path for calling _common.sh inside the execution's context of backup and restore scripts +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script diff --git a/scripts/change_url b/scripts/change_url index 8764cd8..5494275 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -30,9 +30,9 @@ ynh_script_progression --message="Loading installation settings..." --weight=1 final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP +# BACKUP BEFORE CHANGE URL THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up YesWiki before changing its URL (may take a while)..." --weight=3 +ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=3 # Backup the current version of the app ynh_backup_before_upgrade @@ -40,7 +40,7 @@ ynh_clean_setup () { # Remove the new domain config file, the remove script won't do it as it doesn't know yet its location. ynh_secure_remove --file="/etc/nginx/conf.d/$new_domain.d/$app.conf" - # restore it if the upgrade fails + # Restore it if the upgrade fails ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script @@ -96,6 +96,9 @@ fi #================================================= # SPECIFIC MODIFICATIONS #================================================= +# UPDATE A CONFIG FILE +#================================================= +ynh_script_progression --message="Updating a configuration file..." ynh_replace_string --match_string="https://$old_domain${old_path%/}" --replace_string="https://$new_domain${new_path%/}" --target_file="$final_path/wakka.config.php" diff --git a/scripts/install b/scripts/install index 7fe77c7..e028f21 100755 --- a/scripts/install +++ b/scripts/install @@ -14,7 +14,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -26,10 +25,10 @@ ynh_abort_if_errors domain=$YNH_APP_ARG_DOMAIN path_url=$YNH_APP_ARG_PATH -admin=$YNH_APP_ARG_ADMIN is_public=$YNH_APP_ARG_IS_PUBLIC -wiki_name=$YNH_APP_ARG_WIKI_NAME language=$YNH_APP_ARG_LANGUAGE +admin=$YNH_APP_ARG_ADMIN +wiki_name=$YNH_APP_ARG_WIKI_NAME app=$YNH_APP_INSTANCE_NAME @@ -51,11 +50,26 @@ ynh_script_progression --message="Storing installation settings..." --weight=1 ynh_app_setting_set --app=$app --key=domain --value=$domain ynh_app_setting_set --app=$app --key=path --value=$path_url -ynh_app_setting_set --app=$app --key=admin --value=$admin ynh_app_setting_set --app=$app --key=language --value=$language +ynh_app_setting_set --app=$app --key=admin --value=$admin #================================================= # STANDARD MODIFICATIONS +#================================================= +# INSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing dependencies..." + +ynh_install_app_dependencies $pkg_dependencies + +#================================================= +# CREATE DEDICATED USER +#================================================= +ynh_script_progression --message="Configuring system user..." --weight=1 + +# Create a system user +ynh_system_user_create --username=$app --home_dir="$final_path" + #================================================= # CREATE A MYSQL DATABASE #================================================= @@ -66,14 +80,6 @@ db_user=$db_name ynh_app_setting_set --app=$app --key=db_name --value=$db_name ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=1 - -# Create a system user -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -83,6 +89,19 @@ ynh_app_setting_set --app=$app --key=final_path --value=$final_path # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Configuring PHP-FPM..." --weight=8 + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config +phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) + #================================================= # NGINX CONFIGURATION #================================================= @@ -91,24 +110,19 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=1 # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=8 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config --package="$extra_php_dependencies" -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - #================================================= # SPECIFIC SETUP +#================================================= +# INSTALL COMPOSER DEPENDENCIES +#================================================= +ynh_script_progression --message="Installing composer dependencies..." + +ynh_exec_warn_less ynh_install_composer --phpversion="$phpversion" --workdir="$final_path" + #================================================= # SETUP APPLICATION WITH CURL #================================================= -# Set right permissions for cURL install -chown -R $app:$app $final_path - # Set the app as temporarily public for cURL call ynh_permission_update --permission="main" --add="visitors" @@ -116,10 +130,8 @@ ynh_permission_update --permission="main" --add="visitors" ynh_systemd_action --service_name=nginx --action=reload # Installation with curl - ynh_script_progression --message="Finalizing installation..." --weight=2 - admin_temp_pass=$(ynh_string_random 6) ynh_local_curl "/?PagePrincipale&installAction=install" "config[default_language]=$language" "config[wakka_name]=$wiki_name" \ @@ -131,6 +143,11 @@ ynh_local_curl "/?PagePrincipale&installAction=install" "config[default_language # authorization of html ynh_replace_string --match_string="'allow_raw_html' => false," --replace_string="'allow_raw_html' => true," --target_file="$final_path/wakka.config.php" +ynh_replace_string --match_string="yeswiki_release' \?=> \?'.*',$" --replace_string="yeswiki_release' => '$(ynh_app_upstream_version)'," --target_file="$final_path/wakka.config.php" + +# Remove the public access +ynh_permission_update --permission="main" --remove="visitors" + #================================================= # DOWNLOAD AND CONFIGURE LDAP PLUGIN #================================================= @@ -146,20 +163,12 @@ unzip extension-loginldap-$loginldap_version.zip -d $final_path/tools ynh_app_setting_set --app=$app --key=loginldap_version --value=$loginldap_version # Add config at the end of wakka.config.php -ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_host' => '127.0.0.1',\n);"\ - --target_file="$final_path/wakka.config.php" +ynh_replace_string --match_string=");" --replace_string=" 'ldap_host' => '127.0.0.1',\n);" --target_file="$final_path/wakka.config.php" -ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_port' => '389',\n);"\ - --target_file="$final_path/wakka.config.php" +ynh_replace_string --match_string=");" --replace_string=" 'ldap_port' => '389',\n);" --target_file="$final_path/wakka.config.php" -ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_base' => 'ou=users,dc=yunohost,dc=org'\n);"\ - --target_file="$final_path/wakka.config.php" +ynh_replace_string --match_string=");" --replace_string=" 'ldap_base' => 'ou=users,dc=yunohost,dc=org'\n);" --target_file="$final_path/wakka.config.php" -#================================================= -# GENERIC FINALIZATION #================================================= # SECURE FILES AND DIRECTORIES #================================================= @@ -167,15 +176,19 @@ ynh_replace_string --match_string=");"\ # Set permissions to app files yeswiki_update_dir_rights $app $final_path +#================================================= +# GENERIC FINALIZATION #================================================= # SETUP SSOWAT #================================================= ynh_script_progression --message="Configuring permissions..." --weight=1 -# Make app public if necessary or protect it -if [ $is_public -eq 0 ] +# Make app public if necessary +if [ $is_public -eq 1 ] then - ynh_permission_update --permission="main" --remove="visitors" + # Everyone can access the app. + # The "main" permission is automatically created before the install script. + ynh_permission_update --permission="main" --add="visitors" fi #================================================= diff --git a/scripts/remove b/scripts/remove index 5609a6a..4720e95 100755 --- a/scripts/remove +++ b/scripts/remove @@ -35,7 +35,7 @@ ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing YesWiki main directory..." --weight=1 +ynh_script_progression --message="Removing app main directory..." --weight=1 # Remove the app directory securely ynh_secure_remove --file="$final_path" diff --git a/scripts/restore b/scripts/restore index 2b7a635..d993f22 100755 --- a/scripts/restore +++ b/scripts/restore @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -14,7 +15,6 @@ source /usr/share/yunohost/helpers #================================================= ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. true } # Exit if an error occurs during the execution of the script @@ -23,7 +23,7 @@ ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= -ynh_script_progression --message="Loading settings..." --weight=2 +ynh_script_progression --message="Loading installation settings..." --weight=2 app=$YNH_APP_INSTANCE_NAME @@ -44,12 +44,6 @@ test ! -d $final_path \ #================================================= # STANDARD RESTORATION STEPS -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" - #================================================= # RECREATE THE DEDICATED USER #================================================= @@ -61,28 +55,41 @@ ynh_system_user_create --username=$app --home_dir="$final_path" #================================================= # RESTORE THE APP MAIN DIR #================================================= -ynh_script_progression --message="Restoring YesWiki main directory..." --weight=2 +ynh_script_progression --message="Restoring the app main directory..." --weight=2 ynh_restore_file --origin_path="$final_path" -#================================================= -# RESTORE USER RIGHTS -#================================================= +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" # Restore permissions on app files yeswiki_update_dir_rights $app $final_path +#================================================= +# SPECIFIC RESTORATION +#================================================= +# REINSTALL DEPENDENCIES +#================================================= +ynh_script_progression --message="Reinstalling dependencies..." + +# Define and install dependencies +ynh_install_app_dependencies $pkg_dependencies + #================================================= # RESTORE THE PHP-FPM CONFIGURATION #================================================= -ynh_script_progression --message="Reconfiguring PHP-FPM..." --weight=11 +ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=11 ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" -ynh_add_fpm_config --package="$extra_php_dependencies" - #================================================= -# SPECIFIC RESTORATION +# RESTORE THE NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Restoring the NGINX web server configuration..." + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" + #================================================= # RESTORE THE MYSQL DATABASE #================================================= @@ -97,9 +104,9 @@ ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./ #================================================= # RELOAD NGINX AND PHP-FPM #================================================= -ynh_script_progression --message="Reloading NGINX web server and PHP-FPM.." --weight=1 +ynh_script_progression --message="Reloading NGINX web server and PHP-FPM..." --weight=1 -ynh_systemd_action --service_name=php${phpversion}-fpm --action=reload +ynh_systemd_action --service_name=php$phpversion-fpm --action=reload ynh_systemd_action --service_name=nginx --action=reload #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index 9ab3549..86478ac 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -18,37 +18,47 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) +language=$(ynh_app_setting_get --app=$app --key=language) admin=$(ynh_app_setting_get --app=$app --key=admin) final_path=$(ynh_app_setting_get --app=$app --key=final_path) -language=$(ynh_app_setting_get --app=$app --key=language) db_name=$(ynh_app_setting_get --app=$app --key=db_name) phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) #================================================= # CHECK VERSION #================================================= +ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up YesWiki before upgrading (may take a while)..." --weight=6 +ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=6 # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { - # restore it if the upgrade fails + # Restore it if the upgrade fails ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script ynh_abort_if_errors +#================================================= +# STANDARD UPGRADE STEPS #================================================= # ENSURE DOWNWARD COMPATIBILITY #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 +# Cleaning legacy permissions +if ynh_legacy_permissions_exists; then + ynh_legacy_permissions_delete_all + + ynh_app_setting_delete --app=$app --key=is_public +fi + # If db_name doesn't exist, create it if [ -z "$db_name" ]; then db_name=$(ynh_sanitize_dbid --db_name=$app) @@ -61,13 +71,6 @@ if [ -z "$final_path" ]; then ynh_app_setting_set --app=$app --key=final_path --value=$final_path fi -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - #================================================= # CREATE DEDICATED USER #================================================= @@ -76,8 +79,6 @@ ynh_script_progression --message="Making sure dedicated system user exists..." - # Create a dedicated user (if not existing) ynh_system_user_create --username=$app --home_dir="$final_path" -#================================================= -# STANDARD UPGRADE STEPS #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= @@ -89,11 +90,42 @@ then # Download, check integrity, uncompress and patch the source from app.src ynh_setup_source --dest_dir="$final_path" - ynh_replace_string --match_string="yeswiki_release' \?=> \?'.*',$"\ - --replace_string="yeswiki_release' => '$(ynh_app_upstream_version)',"\ - --target_file="$final_path/wakka.config.php" + ynh_replace_string --match_string="yeswiki_release' \?=> \?'.*',$" --replace_string="yeswiki_release' => '$(ynh_app_upstream_version)'," --target_file="$final_path/wakka.config.php" fi +chmod 750 "$final_path" +chmod -R o-rwx "$final_path" +chown -R $app:www-data "$final_path" + +#================================================= +# PHP-FPM CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=5 + +# Create a dedicated PHP-FPM config +ynh_add_fpm_config + +#================================================= +# NGINX CONFIGURATION +#================================================= +ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 + +# Create a dedicated NGINX config +ynh_add_nginx_config + +#================================================= +# SPECIFIC UPGRADE +#================================================= +# UPDATE COMPOSER DEPENDENCIES +#================================================= +ynh_script_progression --message="Updating composer dependencies..." + +ynh_exec_warn_less ynh_composer_exec --workdir="$final_path" --commands="update" + +#================================================= +# DOWNLOAD AND CONFIGURE LDAP PLUGIN +#================================================= + if [[ $(ynh_app_setting_get --app=$app --key=loginldap_version) != $loginldap_version ]] then ynh_script_progression --message="Upgrading LDAP plugin..." --weight=3 @@ -110,38 +142,14 @@ then if ! grep -q "ldap_host" "$final_path/wakka.config.php" then # Add LDAP config at the end of wakka.config.php - ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_host' => '127.0.0.1',\n);"\ - --target_file="$final_path/wakka.config.php" + ynh_replace_string --match_string=");" --replace_string=" 'ldap_host' => '127.0.0.1',\n);" --target_file="$final_path/wakka.config.php" - ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_port' => '389',\n);"\ - --target_file="$final_path/wakka.config.php" + ynh_replace_string --match_string=");" --replace_string=" 'ldap_port' => '389',\n);" --target_file="$final_path/wakka.config.php" - ynh_replace_string --match_string=");"\ - --replace_string=" 'ldap_base' => 'ou=users,dc=yunohost,dc=org'\n);"\ - --target_file="$final_path/wakka.config.php" + ynh_replace_string --match_string=");" --replace_string=" 'ldap_base' => 'ou=users,dc=yunohost,dc=org'\n);" --target_file="$final_path/wakka.config.php" fi fi -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=2 - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=5 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config --package="$extra_php_dependencies" - -#================================================= -# GENERIC FINALIZATION #================================================= # SECURE FILES AND DIRECTORIES #================================================= @@ -149,6 +157,8 @@ ynh_add_fpm_config --package="$extra_php_dependencies" # Set permissions on app files yeswiki_update_dir_rights $app $final_path +#================================================= +# GENERIC FINALIZATION #================================================= # RELOAD NGINX #================================================= diff --git a/sources/extra_files/app/.gitignore b/sources/extra_files/app/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/extra_files/app/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] diff --git a/sources/patches/.gitignore b/sources/patches/.gitignore deleted file mode 100644 index 783a4ae..0000000 --- a/sources/patches/.gitignore +++ /dev/null @@ -1,2 +0,0 @@ -*~ -*.sw[op] From 2f01151f3a05afa914cdf804437a09a892183fae Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Thu, 7 Jul 2022 01:09:03 +0000 Subject: [PATCH 2/5] Auto-update README --- README.md | 21 +++++++++++---------- README_fr.md | 27 ++++++++++++++++----------- 2 files changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 9651cb5..3352a12 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ It shall NOT be edited by hand. # YesWiki for YunoHost -[![Integration level](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg) +[![Integration level](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![Working status](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg) [![Install YesWiki with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yeswiki) *[Lire ce readme en français.](./README_fr.md)* @@ -25,13 +25,13 @@ However, with a YesWiki we can build a website with multiple uses: - Cultivate a bit of freedom... -**Shipped version:** 2022.01.16.13~ynh1 +**Shipped version:** 4.2.1~ynh1 **Demo:** https://ferme.yeswiki.net/?CreerSonWiki ## Screenshots -![](./doc/screenshots/yeswiki_screenshots.png) +![Screenshot of YesWiki](./doc/screenshots/yeswiki_screenshots.png) ## Disclaimers / important information @@ -43,21 +43,22 @@ At the moment SSO authentication is not supported. It is necessary to login on t ## Documentation and resources -* Official app website: https://yeswiki.net/ -* Official admin documentation: https://yeswiki.net/?DocumentatioN -* Upstream app code repository: https://github.com/YesWiki/yeswiki -* YunoHost documentation for this app: https://yunohost.org/app_yeswiki -* Report a bug: https://github.com/YunoHost-Apps/yeswiki_ynh/issues +* Official app website: +* Official admin documentation: +* Upstream app code repository: +* YunoHost documentation for this app: +* Report a bug: ## Developer info Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing). To try the testing branch, please proceed like that. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug or sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug ``` -**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file +**More info regarding app packaging:** diff --git a/README_fr.md b/README_fr.md index 6dc2669..1d7d4cd 100644 --- a/README_fr.md +++ b/README_fr.md @@ -1,10 +1,14 @@ + + # YesWiki pour YunoHost -[![Niveau d'intégration](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg) +[![Niveau d'intégration](https://dash.yunohost.org/integration/yeswiki.svg)](https://dash.yunohost.org/appci/app/yeswiki) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/yeswiki.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/yeswiki.maintain.svg) [![Installer YesWiki avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=yeswiki) *[Read this readme in english.](./README.md)* -*[Lire ce readme en français.](./README_fr.md)* > *Ce package vous permet d'installer YesWiki rapidement et simplement sur un serveur YunoHost. Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* @@ -21,13 +25,13 @@ Néanmoins, avec un YesWiki on peut fabriquer un site internet aux usages multip - Cultiver un bout de liberté... -**Version incluse :** 2022.01.16.13~ynh1 +**Version incluse :** 4.2.1~ynh1 **Démo :** https://ferme.yeswiki.net/?CreerSonWiki ## Captures d'écran -![](./doc/screenshots/yeswiki_screenshots.png) +![Capture d'écran de YesWiki](./doc/screenshots/yeswiki_screenshots.png) ## Avertissements / informations importantes @@ -39,21 +43,22 @@ Pour le moment l'authentification SSO n'est pas prise en charge. Il est nécessa ## Documentations et ressources -* Site officiel de l'app : https://yeswiki.net/ -* Documentation officielle de l'admin : https://yeswiki.net/?DocumentatioN -* Dépôt de code officiel de l'app : https://github.com/YesWiki/yeswiki -* Documentation YunoHost pour cette app : https://yunohost.org/app_yeswiki -* Signaler un bug : https://github.com/YunoHost-Apps/yeswiki_ynh/issues +* Site officiel de l'app : +* Documentation officielle de l'admin : +* Dépôt de code officiel de l'app : +* Documentation YunoHost pour cette app : +* Signaler un bug : ## Informations pour les développeurs Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing). Pour essayer la branche testing, procédez comme suit. -``` + +``` bash sudo yunohost app install https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug ou sudo yunohost app upgrade yeswiki -u https://github.com/YunoHost-Apps/yeswiki_ynh/tree/testing --debug ``` -**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file +**Plus d'infos sur le packaging d'applications :** From 6c2f4d7dab41e56bd1fe0eeed60d928df4bf5a03 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Thu, 7 Jul 2022 08:27:41 +0200 Subject: [PATCH 3/5] Update upgrade --- scripts/upgrade | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/scripts/upgrade b/scripts/upgrade index 86478ac..ab36b02 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -97,6 +97,13 @@ chmod 750 "$final_path" chmod -R o-rwx "$final_path" chown -R $app:www-data "$final_path" +#================================================= +# UPGRADE DEPENDENCIES +#================================================= +ynh_script_progression --message="Upgrading dependencies..." + +ynh_install_app_dependencies $pkg_dependencies + #================================================= # PHP-FPM CONFIGURATION #================================================= From 13f7efe03c4b058fceb1eb4c3a201612d27a7cf4 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 11 Jul 2022 23:51:02 +0200 Subject: [PATCH 4/5] Update upgrade --- scripts/upgrade | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/scripts/upgrade b/scripts/upgrade index ab36b02..fa65451 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -123,11 +123,11 @@ ynh_add_nginx_config #================================================= # SPECIFIC UPGRADE #================================================= -# UPDATE COMPOSER DEPENDENCIES +# INSTALL COMPOSER DEPENDENCIES #================================================= -ynh_script_progression --message="Updating composer dependencies..." +ynh_script_progression --message="Installing composer dependencies..." -ynh_exec_warn_less ynh_composer_exec --workdir="$final_path" --commands="update" +ynh_exec_warn_less ynh_install_composer --phpversion="$phpversion" --workdir="$final_path" #================================================= # DOWNLOAD AND CONFIGURE LDAP PLUGIN From 4089f9a4849a0961c26bc2c68847e4abe561d029 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Tue, 12 Jul 2022 20:33:31 +0200 Subject: [PATCH 5/5] Update check_process --- check_process | 2 -- 1 file changed, 2 deletions(-) diff --git a/check_process b/check_process index 10e61d7..ae81d83 100644 --- a/check_process +++ b/check_process @@ -23,8 +23,6 @@ setup_private=1 setup_public=1 upgrade=1 - # 2021-05-18-2~ynh2 - upgrade=1 from_commit=792c90c592f52f8fb1a89c22ab9b73f1e0bc2a3d # 2022.01.16.13~ynh1 upgrade=1 from_commit=f577a55539cb2ff54b5cee099e1e22aa4ccea186 backup_restore=1