diff --git a/.github/workflows/updater.sh b/.github/workflows/updater.sh deleted file mode 100644 index 43ec843..0000000 --- a/.github/workflows/updater.sh +++ /dev/null @@ -1,107 +0,0 @@ -#!/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/releases" | jq -r '.[] | select( .prerelease != true ) | .tag_name' | sort -V | tail -1) -assets="https://github.com/kevinpapst/kimai2/archive/$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="mysql" - -# 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 deleted file mode 100644 index a56d7cb..0000000 --- a/.github/workflows/updater.yml +++ /dev/null @@ -1,49 +0,0 @@ -# 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@v3 - 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@v4 - 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/README.md b/README.md index 9feb219..6ca25e2 100644 --- a/README.md +++ b/README.md @@ -16,12 +16,10 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in ## Overview -This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now. - Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE). -**Shipped version:** 2.0.33~ynh1 +**Shipped version:** 2.0.33~ynh2 **Demo:** https://www.kimai.org/demo/ @@ -29,23 +27,6 @@ Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic i ![Screenshot of Kimai2](./doc/screenshots/screenshot1.png) -## Disclaimers / important information - -* Require dedicated domain like **kimai.domain.tld**. -* This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server) -* As sqlite support ended on version 1.14, if you choosed an sqlite databse during installation, Kimai2 upgrade is blocked to version 1.13 - -#### Multi-user support - -LDAP is supported -HTTP auth is not supported -Defaul Kimai2 roles are: -* ROLE_USER -* ROLE_TEAMLEAD => Kimai2 (Teamlead) YunoHost permission -* ROLE_ADMIN => Kimai2 (Admin) YunoHost permission -* ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission -Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN - ## Documentation and resources * Official app website: diff --git a/README_fr.md b/README_fr.md index 0b65d70..38705d2 100644 --- a/README_fr.md +++ b/README_fr.md @@ -16,12 +16,10 @@ Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) po ## Vue d’ensemble -This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now. - Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE). -**Version incluse :** 2.0.33~ynh1 +**Version incluse :** 2.0.33~ynh2 **Démo :** https://www.kimai.org/demo/ @@ -29,23 +27,6 @@ Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic i ![Capture d’écran de Kimai2](./doc/screenshots/screenshot1.png) -## Avertissements / informations importantes - -* Require dedicated domain like **kimai.domain.tld**. -* This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server) -* As sqlite support ended on version 1.14, if you choosed an sqlite databse during installation, Kimai2 upgrade is blocked to version 1.13 - -#### Multi-user support - -LDAP is supported -HTTP auth is not supported -Defaul Kimai2 roles are: -* ROLE_USER -* ROLE_TEAMLEAD => Kimai2 (Teamlead) YunoHost permission -* ROLE_ADMIN => Kimai2 (Admin) YunoHost permission -* ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission -Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN - ## Documentations et ressources * Site officiel de l’app : diff --git a/check_process b/check_process deleted file mode 100644 index c2aad8a..0000000 --- a/check_process +++ /dev/null @@ -1,24 +0,0 @@ -;; Test complet - ; Manifest - domain="domain.tld" - is_public=1 - admin="john" - database="mysql" - registration=1 - ; Checks - pkg_linter=1 - setup_sub_dir=0 - setup_root=1 - setup_nourl=0 - setup_private=1 - setup_public=1 - upgrade=1 - # 1.30.0~ynh1 - upgrade=1 from_commit=8f44ac8fd4276c402c3cf68e373a6a3ff51e25b5 - backup_restore=1 - multi_instance=1 - port_already_use=0 - change_url=0 -;;; Options -Email=anmol@datamol.org -Notification=change diff --git a/conf/app.src b/conf/app.src deleted file mode 100644 index b71eb29..0000000 --- a/conf/app.src +++ /dev/null @@ -1,7 +0,0 @@ -SOURCE_URL=https://github.com/kevinpapst/kimai2/archive/2.0.33.tar.gz -SOURCE_SUM=9cad2555eb115711e100ca129c8152f3ec19ebfde6334a1ec5b7b2009b011959 -SOURCE_SUM_PRG=sha256sum -SOURCE_FORMAT=tar.gz -SOURCE_IN_SUBDIR=true -SOURCE_FILENAME= -SOURCE_EXTRACT=true diff --git a/conf/.env b/conf/dot_env similarity index 100% rename from conf/.env rename to conf/dot_env diff --git a/conf/nginx.conf b/conf/nginx.conf index 8a01591..2605779 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,5 +1,5 @@ #sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; -root __FINALPATH__/public/ ; +root __INSTALL_DIR__/public/ ; location __PATH__/ { diff --git a/doc/DISCLAIMER.md b/doc/ADMIN.md similarity index 51% rename from doc/DISCLAIMER.md rename to doc/ADMIN.md index a458f2b..6a2f459 100644 --- a/doc/DISCLAIMER.md +++ b/doc/ADMIN.md @@ -1,14 +1,12 @@ -* Require dedicated domain like **kimai.domain.tld**. -* This app is multi-instance (you can have more then one Kimai instance running on a YunoHost server) -* As sqlite support ended on version 1.14, if you choosed an sqlite databse during installation, Kimai2 upgrade is blocked to version 1.13 +As sqlite support ended on version 1.14, if you choosed an sqlite database during installation, Kimai2 upgrade is blocked to version 1.13. #### Multi-user support -LDAP is supported -HTTP auth is not supported Defaul Kimai2 roles are: + * ROLE_USER * ROLE_TEAMLEAD => Kimai2 (Teamlead) YunoHost permission * ROLE_ADMIN => Kimai2 (Admin) YunoHost permission * ROLE_SUPER_ADMIN => Kimai2 (Super_Admin) YunoHost permission + Those roles are directly managed using YunoHost permission system. User choosen during installation is granted the ROLE_SUPER_ADMIN diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index a474b6b..05d89be 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,3 +1 @@ -This is the reloaded version of the open source timetracker Kimai. Right now its in an early development phase, its usable but some advanced features from Kimai v1 are missing by now. - Kimai v2 has nothing in common with its predecessor Kimai v1 besides the basic ideas of time-tracking and the current development team. It is based on a lot of great frameworks. Special thanks to Symfony v4, Doctrine, AdminThemeBundle (based on AdminLTE). diff --git a/doc/PRE_INSTALL.md b/doc/PRE_INSTALL.md new file mode 100644 index 0000000..9e0e96c --- /dev/null +++ b/doc/PRE_INSTALL.md @@ -0,0 +1 @@ +This app requires a dedicated domain like `kimai.domain.tld`. diff --git a/manifest.json b/manifest.json deleted file mode 100644 index 9a5835a..0000000 --- a/manifest.json +++ /dev/null @@ -1,64 +0,0 @@ -{ - "name": "Kimai2", - "id": "kimai2", - "packaging_format": 1, - "description": { - "en": "Multi-user application for time-tracking with support for mobile devices", - "fr": "Application multi-utilisateurs de suivi du temps compatible avec les appareils mobiles", - "de": "Eine web-basierte Mehrbenutzer-Zeiterfassung mit Rechnungsdruck mit Unterstützung für mobile Endgeräte", - "cs": "Víceuživatelská webová aplikace pro sledování času s podporou mobilních zařízení" - }, - "version": "2.0.33~ynh1", - "url": "https://www.kimai.org", - "upstream": { - "license": "MIT", - "website": "https://www.kimai.org", - "demo": "https://www.kimai.org/demo/", - "admindoc": "https://www.kimai.org/documentation/", - "code": "https://github.com/kevinpapst/kimai2", - "cpe": "cpe:2.3:a:kimai:kimai_2" - }, - "license": "MIT", - "maintainer": { - "name": "Anmol Sharma", - "email": "anmol@datamol.org", - "url": "datamol.org" - }, - "requirements": { - "yunohost": ">= 11.2" - }, - "multi_instance": true, - "services": [ - "nginx", - "php8.1-fpm", - "mysql" - ], - "arguments": { - "install": [ - { - "name": "domain", - "type": "domain" - }, - { - "name": "is_public", - "type": "boolean", - "default": false - }, - { - "name": "admin", - "type": "user" - }, - { - "name": "registration", - "type": "boolean", - "ask": { - "en": "Are new users allowed to register?", - "fr": "Est-ce que de nouveaux utilisateurs peuvent s'y inscrire ?", - "de": "Sollen sich neue Benutzer selber registrieren können ?", - "cs": "Mohou se noví uživatelé registrovat?" - }, - "default": false - } - ] - } -} diff --git a/manifest.toml b/manifest.toml new file mode 100644 index 0000000..2c8277e --- /dev/null +++ b/manifest.toml @@ -0,0 +1,88 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/manifest.v2.schema.json + +packaging_format = 2 + +id = "kimai2" +name = "Kimai2" +description.en = "Multi-user application for time-tracking with support for mobile devices" +description.fr = "Application multi-utilisateurs de suivi du temps compatible avec les appareils mobiles" +description.de = "Eine web-basierte Mehrbenutzer-Zeiterfassung mit Rechnungsdruck mit Unterstützung für mobile Endgeräte" +description.cs = "Víceuživatelská webová aplikace pro sledování času s podporou mobilních zařízení" + +version = "2.0.33~ynh2" + +maintainers = [""] + +[upstream] +license = "MIT" +website = "https://www.kimai.org" +demo = "https://www.kimai.org/demo/" +admindoc = "https://www.kimai.org/documentation/" +code = "https://github.com/kevinpapst/kimai2" +cpe = "cpe:2.3:a:kimai:kimai_2" + +[integration] +yunohost = ">= 11.2" +architectures = "all" +multi_instance = true +ldap = true +sso = false +disk = "50M" +ram.build = "500M" +ram.runtime = "80M" + +[install] + [install.domain] + type = "domain" + + [install.init_main_permission] + type = "group" + default = "visitors" + + [install.admin] + type = "user" + + [install.registration] + ask.en = "Are new users allowed to register?" + ask.fr = "Est-ce que de nouveaux utilisateurs peuvent s'y inscrire ?" + ask.de = "Sollen sich neue Benutzer selber registrieren können ?" + ask.cs = "Mohou se noví uživatelé registrovat?" + type = "boolean" + default = false + +[resources] + [resources.sources.main] + url = "https://github.com/kevinpapst/kimai2/archive/2.0.33.tar.gz" + sha256 = "9cad2555eb115711e100ca129c8152f3ec19ebfde6334a1ec5b7b2009b011959" + + autoupdate.strategy = "latest_github_tag" + + [resources.system_user] + + [resources.install_dir] + + [resources.permissions] + main.url = "/" + # Non-web, LDAP groups + teamlead.allowed = "" + admin.allowed = "admins" + super_admin.allowed = "" + + [resources.apt] + packages = [ + "php8.1-gd", + "php8.1-intl", + "php8.1-json", + "php8.1-mbstring", + "php8.1-pdo", + "php8.1-zip", + "php8.1-xml", + "php8.1-xsl", + "php8.1-ldap", + "php8.1-mysql", + "php8.1-sqlite3", + "mariadb-server", + ] + + [resources.database] + type = "mysql" diff --git a/scripts/_common.sh b/scripts/_common.sh index 65431ab..b903125 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -6,20 +6,17 @@ # PHP APP SPECIFIC #================================================= -YNH_PHP_VERSION=8.1 - YNH_COMPOSER_VERSION=2.3.3 -php_dependencies="php${YNH_PHP_VERSION}-gd php${YNH_PHP_VERSION}-intl php${YNH_PHP_VERSION}-json php${YNH_PHP_VERSION}-mbstring php${YNH_PHP_VERSION}-pdo php${YNH_PHP_VERSION}-zip php${YNH_PHP_VERSION}-xml php${YNH_PHP_VERSION}-xsl php${YNH_PHP_VERSION}-ldap php${YNH_PHP_VERSION}-mysql php${YNH_PHP_VERSION}-sqlite3" - - -# dependencies used by the app (must be on a single line) -pkg_dependencies="$php_dependencies" - #================================================= # PERSONAL HELPERS #================================================= +boolstr() { + BOOLSTR=( false true ) + echo "${BOOLSTR[$1]}" +} + #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index cf3ab2e..c900e22 100755 --- a/scripts/backup +++ b/scripts/backup @@ -10,29 +10,6 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_print_info --message="Loading settings..." - -app=$YNH_APP_INSTANCE_NAME - -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -database=$(ynh_app_setting_get --app=$app --key=database) - #================================================= # DECLARE DATA AND CONF FILES TO BACKUP #================================================= @@ -42,18 +19,14 @@ ynh_print_info --message="Declaring files to be backed up..." # BACKUP THE APP MAIN DIR #================================================= -ynh_backup --src_path="$final_path" +ynh_backup --src_path="$install_dir" #================================================= -# BACKUP THE NGINX CONFIGURATION +# SYSTEM CONFIGURATION #================================================= ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" -#================================================= -# BACKUP THE PHP-FPM CONFIGURATION -#================================================= - ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= @@ -61,8 +34,8 @@ ynh_backup --src_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" #================================================= if [ "$database" = "mysql" ]; then - ynh_print_info --message="Backing up the MySQL database..." - ynh_mysql_dump_db --database="$db_name" > db.sql + ynh_print_info --message="Backing up the MySQL database..." + ynh_mysql_dump_db --database="$db_name" > db.sql fi #================================================= diff --git a/scripts/install b/scripts/install index 41a5c84..cc885fe 100755 --- a/scripts/install +++ b/scripts/install @@ -10,185 +10,83 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# MANAGE SCRIPT FAILURE +# INITIALIZE AND STORE SETTINGS #================================================= -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# RETRIEVE ARGUMENTS FROM THE MANIFEST -#================================================= - -domain=$YNH_APP_ARG_DOMAIN -path_url="/" -is_public=$YNH_APP_ARG_IS_PUBLIC -admin=$YNH_APP_ARG_ADMIN -registration=$YNH_APP_ARG_REGISTRATION - -app=$YNH_APP_INSTANCE_NAME - database="mysql" +ynh_app_setting_set --app="$app" --key=database --value="$database" + random_key=$(ynh_string_random --length=32) +ynh_app_setting_set --app="$app" --key=random_key --value="$random_key" -#================================================= -# CHECK IF THE APP CAN BE INSTALLED WITH THESE ARGS -#================================================= -ynh_script_progression --message="Validating installation parameters..." --weight=1 - -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - -# Register (book) web path -ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url - -#================================================= -# STORE SETTINGS FROM MANIFEST -#================================================= -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=registration --value=$registration -ynh_app_setting_set --app=$app --key=database --value=$database -ynh_app_setting_set --app=$app --key=random_key --value=$random_key - -#================================================= -# STANDARD MODIFICATIONS -#================================================= -# INSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Installing dependencies..." --weight=1 - -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 -#================================================= -ynh_script_progression --message="Creating a MySQL database..." --weight=1 - -db_name=$(ynh_sanitize_dbid --db_name=$app) -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 +ynh_permission_update -p "super_admin" --add "$admin" #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=1 -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" +ynh_setup_source --dest_dir="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -setfacl -dR -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" -setfacl -R -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring PHP-FPM..." --weight=1 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Configuring NGINX web server..." --weight=1 - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# SPECIFIC SETUP -#================================================= -# BUILD KIMAI2 -#================================================= -ynh_script_progression --message="Building Kimai2..." --weight=1 - -ynh_install_composer --phpversion="$phpversion" --workdir="$final_path" --install_args="--optimize-autoloader --no-interaction" -ynh_composer_exec --phpversion="$phpversion" --workdir="$final_path" --commands="require laminas/laminas-ldap" - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -setfacl -dR -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" -setfacl -R -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" +setfacl -dR -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" +setfacl -R -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" #================================================= # ADD A CONFIGURATION #================================================= ynh_script_progression --message="Adding a configuration file..." --weight=1 -if [ $registration -eq 1 ] -then - registration="true" -else - registration="false" -fi +registration=$(boolstr "$registration") -ynh_add_config --template="../conf/local.yaml" --destination="$final_path/config/packages/local.yaml" +ynh_add_config --template="local.yaml" --destination="$install_dir/config/packages/local.yaml" -chmod 400 "$final_path/config/packages/local.yaml" -chown $app:$app "$final_path/config/packages/local.yaml" +chmod 400 "$install_dir/config/packages/local.yaml" +chown "$app:$app" "$install_dir/config/packages/local.yaml" # Configure environement -ynh_add_config --template="../conf/.env" --destination="$final_path/.env" +ynh_add_config --template="dot_env" --destination="$install_dir/.env" -chmod 400 "$final_path/.env" -chown $app:$app "$final_path/.env" +chmod 400 "$install_dir/.env" +chown "$app:$app" "$install_dir/.env" + +#================================================= +# BUILD KIMAI2 +#================================================= +ynh_script_progression --message="Building $app..." --weight=1 + +ynh_install_composer --phpversion="$phpversion" --workdir="$install_dir" --install_args="--optimize-autoloader --no-interaction" +ynh_composer_exec --phpversion="$phpversion" --workdir="$install_dir" --commands="require laminas/laminas-ldap" + +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" +setfacl -dR -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" +setfacl -R -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" #================================================= # INSTALL KIMAI2 #================================================= -ynh_script_progression --message="Installing Kimai2..." --weight=1 +ynh_script_progression --message="Installing $app..." --weight=1 -pushd "$final_path" - ynh_exec_as $app php$phpversion bin/console kimai:install -n +pushd "$install_dir" + ynh_exec_as "$app" "php$phpversion" bin/console kimai:install -n popd #================================================= -# GENERIC FINALIZATION +# SYSTEM CONFIGURATION #================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring permissions..." --weight=1 +ynh_script_progression --message="Adding system configurations related to $app..." --weight=1 -ynh_permission_create --permission="teamlead" -ynh_permission_create --permission="admin" -ynh_permission_create --permission="super_admin" --allowed "$admin" +# Create a dedicated PHP-FPM config +ynh_add_fpm_config -# Make app public if necessary -if [ $is_public -eq 1 ] -then - # Everyone can access the app. - # The "main" permission is automatically created before the install script. - ynh_permission_update --permission="main" --add="visitors" -fi - -#================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 - -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/scripts/remove b/scripts/remove index 3c82806..5b17c2d 100755 --- a/scripts/remove +++ b/scripts/remove @@ -10,73 +10,16 @@ source _common.sh source /usr/share/yunohost/helpers #================================================= -# LOAD SETTINGS +# REMOVE SYSTEM CONFIGURATIONS #================================================= -ynh_script_progression --message="Loading settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -database=$(ynh_app_setting_get --app=$app --key=database) - -#================================================= -# STANDARD REMOVE -#================================================= -# REMOVE THE MYSQL DATABASE -#================================================= - -if [ "$database" = "mysql" ]; then - ynh_script_progression --message="Removing the MySQL database..." --weight=1 - - # Remove a database if it exists, along with the associated user - ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name -fi - -#================================================= -# REMOVE APP MAIN DIR -#================================================= -ynh_script_progression --message="Removing app main directory..." --weight=1 - -# Remove the app directory securely -ynh_secure_remove --file="$final_path" - -#================================================= -# REMOVE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Removing NGINX web server configuration..." --weight=1 +ynh_script_progression --message="Removing system configurations related to $app..." --weight=1 # Remove the dedicated NGINX config ynh_remove_nginx_config -#================================================= -# REMOVE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Removing PHP-FPM configuration..." --weight=1 - # Remove the dedicated PHP-FPM config ynh_remove_fpm_config -#================================================= -# REMOVE DEPENDENCIES -#================================================= -ynh_script_progression --message="Removing dependencies..." --weight=1 - -# Remove metapackage and its dependencies -ynh_remove_app_dependencies - -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= diff --git a/scripts/restore b/scripts/restore index ec44178..ff226f6 100755 --- a/scripts/restore +++ b/scripts/restore @@ -10,97 +10,37 @@ source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers -#================================================= -# MANAGE SCRIPT FAILURE -#================================================= - -ynh_clean_setup () { - true -} -# Exit if an error occurs during the execution of the script -ynh_abort_if_errors - -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) -database=$(ynh_app_setting_get --app=$app --key=database) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=1 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " - -#================================================= -# STANDARD RESTORATION STEPS -#================================================= -# RECREATE THE DEDICATED USER -#================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 - -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # RESTORE THE APP MAIN DIR #================================================= ynh_script_progression --message="Restoring the app main directory..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="$install_dir" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -setfacl -dR -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" -setfacl -R -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R $app:www-data "$install_dir" -#================================================= -# SPECIFIC RESTORATION -#================================================= -# REINSTALL DEPENDENCIES -#================================================= -ynh_script_progression --message="Reinstalling dependencies..." --weight=1 - -# Define and install dependencies -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# RESTORE THE PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the PHP-FPM configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" - -#================================================= -# RESTORE THE NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Restoring the NGINX web server configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" +setfacl -dR -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" +setfacl -R -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" #================================================= # RESTORE THE MYSQL DATABASE #================================================= - if [ "$database" = "mysql" ]; then - ynh_script_progression --message="Restoring the MySQL database..." --weight=1 - db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) - ynh_mysql_setup_db --db_user=$db_user --db_name=$db_name --db_pwd=$db_pwd - ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./db.sql + ynh_script_progression --message="Restoring the MySQL database..." --weight=1 + ynh_mysql_connect_as --user="$db_user" --password="$db_pwd" --database="$db_name" < ./db.sql fi +#================================================= +# RESTORE SYSTEM CONFIGURATIONS +#================================================= +ynh_script_progression --message="Restoring system configurations related to $app..." --weight=1 + +ynh_restore_file --origin_path="/etc/php/$phpversion/fpm/pool.d/$app.conf" + +ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" + #================================================= # GENERIC FINALIZATION #================================================= @@ -108,7 +48,7 @@ fi #================================================= 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 fca96d9..a43cf6f 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -9,209 +9,99 @@ source _common.sh source /usr/share/yunohost/helpers -#================================================= -# LOAD SETTINGS -#================================================= -ynh_script_progression --message="Loading settings..." --weight=1 - -app=$YNH_APP_INSTANCE_NAME - -domain=$(ynh_app_setting_get --app=$app --key=domain) -path_url=$(ynh_app_setting_get --app=$app --key=path) -admin=$(ynh_app_setting_get --app=$app --key=admin) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) -db_name=$(ynh_app_setting_get --app=$app --key=db_name) -db_user=$db_name -db_pwd=$(ynh_app_setting_get --app=$app --key=mysqlpwd) -registration=$(ynh_app_setting_get --app=$app --key=registration) -database=$(ynh_app_setting_get --app=$app --key=database) -random_key=$(ynh_app_setting_get --app=$app --key=random_key) - -#================================================= -# CHECK VERSION -#================================================= -ynh_script_progression --message="Checking version..." --weight=1 - -upgrade_type=$(ynh_check_app_version_changed) - -if [ "$database" == "sqlite" ] -then - ynh_script_progression --message="Sqlite is not more supported by Kimai2..." - ynh_script_progression --message="Kimai2 will be upgraded to last available version : 1.13" - if ynh_compare_current_package_version --comparison ge --version 1.17.1~ynh1 - then - ynh_script_progression --message="Kimai2 sqlite version is already to the last available version, no upgrade will be made" - ynh_die --message="" 0 - fi -fi - -#================================================= -# BACKUP BEFORE UPGRADE THEN ACTIVE TRAP -#================================================= -ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --weight=1 - -# Backup the current version of the app -ynh_backup_before_upgrade -ynh_clean_setup () { - # 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 -# If final_path doesn't exist, create it -if [ -z "$final_path" ]; then - final_path=/var/www/$app - ynh_app_setting_set --app=$app --key=final_path --value=$final_path +if [ "$database" == "sqlite" ]; then + ynh_script_progression --message="Sqlite is not supported by Kimai2 anymore..." + ynh_script_progression --message="Kimai2 will be upgraded to last available version : 1.13" + if ynh_compare_current_package_version --comparison ge --version 1.17.1~ynh1; then + ynh_script_progression --message="Kimai2 sqlite version is already to the last available version, no upgrade will be made" + ynh_die --message="" 0 + fi fi -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public +if [ -z "${registration:-}" ]; then + registration=0 + ynh_app_setting_set --app="$app" --key=registration --value="$registration" fi -if ! ynh_permission_exists --permission="teamlead"; then - ynh_permission_create --permission="teamlead" -fi - -if ! ynh_permission_exists --permission="admin"; then - ynh_permission_create --permission="admin" -fi - -if ! ynh_permission_exists --permission="super_admin"; then - ynh_permission_create --permission="super_admin" --allowed="$admin" -fi - -if [ -z "$registration" ]; then - registration_enabled="false" - ynh_app_setting_set --app=$app --key=registration --value=$registration -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= +ynh_script_progression --message="Upgrading source files..." --weight=1 -if [ "$upgrade_type" == "UPGRADE_APP" ] -then - ynh_script_progression --message="Upgrading source files..." --weight=1 +if ynh_compare_current_package_version --comparison le --version 1.30.0~ynh1; then + ynh_script_progression --message="Doing a hard cache flush for major Kimai 2 update from version 1.x to 2.x" - if ynh_compare_current_package_version --comparison le --version 1.30.0~ynh1 - then - ynh_script_progression --message="Doing a hard cache flush for major Kimai 2 update from version 1.x to 2.x" - - # Download, check integrity, uncompress and patch the source from app.src - # Remove local.yaml as recommended for major version upgrade https://github.com/kimai/kimai/blob/main/UPGRADING.md - # As a full_replace (see https://www.kimai.org/documentation/updates.html) is performed keep .env file - ynh_setup_source --dest_dir="$final_path" --keep=".env var/invoices/ var/data/" --full_replace=1 - else - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir="$final_path" --keep="config/packages/local.yaml var/invoices/ var/data/" - fi + # Download, check integrity, uncompress and patch the source from app.src + # Remove local.yaml as recommended for major version upgrade https://github.com/kimai/kimai/blob/main/UPGRADING.md + # As a full_replace (see https://www.kimai.org/documentation/updates.html) is performed keep .env file + ynh_setup_source --dest_dir="$install_dir" --keep=".env var/invoices/ var/data/" --full_replace=1 +else + # Download, check integrity, uncompress and patch the source from app.src + ynh_setup_source --dest_dir="$install_dir" --keep="config/packages/local.yaml var/invoices/ var/data/" fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -setfacl -dR -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" -setfacl -R -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" - -#================================================= -# UPGRADE DEPENDENCIES -#================================================= -ynh_script_progression --message="Upgrading dependencies..." --weight=1 - -ynh_install_app_dependencies $pkg_dependencies - -#================================================= -# PHP-FPM CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading PHP-FPM configuration..." --weight=1 - -# Create a dedicated PHP-FPM config -ynh_add_fpm_config -phpversion=$(ynh_app_setting_get --app=$app --key=phpversion) - -#================================================= -# NGINX CONFIGURATION -#================================================= -ynh_script_progression --message="Upgrading NGINX web server configuration..." --weight=1 - -# Create a dedicated NGINX config -ynh_add_nginx_config - -#================================================= -# SPECIFIC UPGRADE -#================================================= -# BUILD KIMAI2 -#================================================= -ynh_script_progression --message="Building $app..." --weight=1 - -ynh_install_composer --phpversion="$YNH_PHP_VERSION" --workdir="$final_path" --install_args="--optimize-autoloader --no-interaction" -ynh_composer_exec --phpversion="$YNH_PHP_VERSION" --workdir="$final_path" --commands="require laminas/laminas-ldap --optimize-autoloader" - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" -setfacl -dR -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" -setfacl -R -m g:"www-data":rwX -m u:$app:rwX "$final_path/var/" +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" +setfacl -dR -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" +setfacl -R -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" #================================================= # UPDATE A CONFIG FILE #================================================= ynh_script_progression --message="Updating a configuration file..." --weight=1 -if [ $registration -eq 1 ] -then - registration="true" -else - registration="false" -fi +registration=$(boolstr "$registration") -ynh_add_config --template="../conf/local.yaml" --destination="$final_path/config/packages/local.yaml" +ynh_add_config --template="local.yaml" --destination="$install_dir/config/packages/local.yaml" -chmod 400 "$final_path/config/packages/local.yaml" -chown $app:$app "$final_path/config/packages/local.yaml" +chmod 400 "$install_dir/config/packages/local.yaml" +chown "$app:$app" "$install_dir/config/packages/local.yaml" # Configure environement -ynh_add_config --template="../conf/.env" --destination="$final_path/.env" +ynh_add_config --template="dot_env" --destination="$install_dir/.env" -chmod 400 "$final_path/.env" -chown $app:$app "$final_path/.env" +chmod 400 "$install_dir/.env" +chown "$app:$app" "$install_dir/.env" + +#================================================= +# BUILD KIMAI2 +#================================================= +ynh_script_progression --message="Building $app..." --weight=1 + +ynh_install_composer --phpversion="$phpversion" --workdir="$install_dir" --install_args="--optimize-autoloader --no-interaction" +ynh_composer_exec --phpversion="$phpversion" --workdir="$install_dir" --commands="require laminas/laminas-ldap --optimize-autoloader" + +chmod 750 "$install_dir" +chmod -R o-rwx "$install_dir" +chown -R "$app:www-data" "$install_dir" +setfacl -dR -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" +setfacl -R -m g:"www-data":rwX -m u:"$app":rwX "$install_dir/var/" #================================================= # INSTALL KIMAI2 #================================================= ynh_script_progression --message="Installing $app..." --weight=1 -pushd "$final_path" - ynh_exec_as $app php$YNH_PHP_VERSION bin/console kimai:update -n +pushd "$install_dir" + ynh_exec_as "$app" "php$phpversion" bin/console kimai:update -n popd #================================================= -# GENERIC FINALIZATION +# REAPPLY SYSTEM CONFIGURATIONS #================================================= -# RELOAD NGINX -#================================================= -ynh_script_progression --message="Reloading NGINX web server..." --weight=1 +ynh_script_progression --message="Upgrading system configurations related to $app..." --weight=1 -ynh_systemd_action --service_name=nginx --action=reload +# Create a dedicated PHP-FPM config +ynh_add_fpm_config + +# Create a dedicated NGINX config +ynh_add_nginx_config #================================================= # END OF SCRIPT diff --git a/tests.toml b/tests.toml new file mode 100644 index 0000000..73bad57 --- /dev/null +++ b/tests.toml @@ -0,0 +1,19 @@ +#:schema https://raw.githubusercontent.com/YunoHost/apps/master/schemas/tests.v1.schema.json + +test_format = 1.0 + +[default] + + exclude = ["change_url"] + + # ------------------------------- + # Default args to use for install + # ------------------------------- + + args.registration = false + + # ------------------------------- + # Commits to test upgrade from + # ------------------------------- + + test_upgrade_from.8f44ac8fd4276c402c3cf68e373a6a3ff51e25b5.name = "Upgrade from 1.30"