From 5a328e76b9539abba71b5d476989bfa9b0303ee0 Mon Sep 17 00:00:00 2001
From: Tagada <36127788+Tagadda@users.noreply.github.com>
Date: Mon, 18 May 2020 12:46:36 +0200
Subject: [PATCH] Fix for Yunohost 3.7

---
 scripts/install |   1 +
 scripts/remove  |   1 +
 scripts/restore |   1 +
 scripts/upgrade |   1 +
 scripts/ynh_apt | 564 ++++++++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 568 insertions(+)
 create mode 100644 scripts/ynh_apt

diff --git a/scripts/install b/scripts/install
index 1985dfb..3338062 100644
--- a/scripts/install
+++ b/scripts/install
@@ -11,6 +11,7 @@ source ynh_install_ruby__2
 source ynh_send_readme_to_admin__2
 source ynh_add_swap
 source ynh_check_ram
+source ynh_apt
 source /usr/share/yunohost/helpers
 
 #=================================================
diff --git a/scripts/remove b/scripts/remove
index d955a8a..61e6a22 100644
--- a/scripts/remove
+++ b/scripts/remove
@@ -9,6 +9,7 @@
 source _common.sh
 source ynh_install_ruby__2
 source ynh_add_swap
+source ynh_apt
 source /usr/share/yunohost/helpers
 
 #=================================================
diff --git a/scripts/restore b/scripts/restore
index 129715f..9ea3f50 100644
--- a/scripts/restore
+++ b/scripts/restore
@@ -11,6 +11,7 @@ source ../settings/scripts/_common.sh
 source ../settings/scripts/ynh_install_ruby__2
 source ../settings/scripts/ynh_add_swap
 source ../settings/scripts/ynh_check_ram
+source ../settings/scripts/ynh_apt
 source /usr/share/yunohost/helpers
 
 #=================================================
diff --git a/scripts/upgrade b/scripts/upgrade
index 8e72f4c..c049b3a 100644
--- a/scripts/upgrade
+++ b/scripts/upgrade
@@ -10,6 +10,7 @@ source _common.sh
 source ynh_install_ruby__2
 source ynh_add_swap
 source ynh_check_ram
+source ynh_apt
 source /usr/share/yunohost/helpers
 
 #=================================================
diff --git a/scripts/ynh_apt b/scripts/ynh_apt
new file mode 100644
index 0000000..781e2c2
--- /dev/null
+++ b/scripts/ynh_apt
@@ -0,0 +1,564 @@
+#!/bin/bash
+
+# Check if apt is free to use, or wait, until timeout.
+#
+# [internal]
+#
+# usage: ynh_wait_dpkg_free
+# | exit: Return 1 if dpkg is broken
+#
+# Requires YunoHost version 3.3.1 or higher.
+ynh_wait_dpkg_free() {
+    local try
+    set +o xtrace # set +x
+    # With seq 1 17, timeout will be almost 30 minutes
+    for try in `seq 1 17`
+    do
+        # Check if /var/lib/dpkg/lock is used by another process
+        if lsof /var/lib/dpkg/lock > /dev/null
+        then
+            echo "apt is already in use..."
+            # Sleep an exponential time at each round
+            sleep $(( try * try ))
+        else
+            # Check if dpkg hasn't been interrupted and is fully available.
+            # See this for more information: https://sources.debian.org/src/apt/1.4.9/apt-pkg/deb/debsystem.cc/#L141-L174
+            local dpkg_dir="/var/lib/dpkg/updates/"
+
+            # For each file in $dpkg_dir
+            while read dpkg_file <&9
+            do
+                # Check if the name of this file contains only numbers.
+                if echo "$dpkg_file" | grep --perl-regexp --quiet "^[[:digit:]]+$"
+                then
+                    # If so, that a remaining of dpkg.
+                    ynh_print_err "E: dpkg was interrupted, you must manually run 'sudo dpkg --configure -a' to correct the problem."
+                    set -o xtrace # set -x
+                    return 1
+                fi
+            done 9<<< "$(ls -1 $dpkg_dir)"
+            set -o xtrace # set -x
+            return 0
+        fi
+    done
+    echo "apt still used, but timeout reached !"
+    set -o xtrace # set -x
+}
+
+# Check either a package is installed or not
+#
+# example: ynh_package_is_installed --package=yunohost && echo "ok"
+#
+# usage: ynh_package_is_installed --package=name
+# | arg: -p, --package=     - the package name to check
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_is_installed() {
+    # Declare an array to define the options of this helper.
+    local legacy_args=p
+    local -A args_array=( [p]=package= )
+    local package
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    ynh_wait_dpkg_free
+    dpkg-query --show --showformat='${Status}' "$package" 2>/dev/null \
+        | grep --count "ok installed" &>/dev/null
+}
+
+# Get the version of an installed package
+#
+# example: version=$(ynh_package_version --package=yunohost)
+#
+# usage: ynh_package_version --package=name
+# | arg: -p, --package=     - the package name to get version
+# | ret: the version or an empty string
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_version() {
+    # Declare an array to define the options of this helper.
+    local legacy_args=p
+    local -A args_array=( [p]=package= )
+    local package
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    if ynh_package_is_installed "$package"
+    then
+        dpkg-query --show --showformat='${Version}' "$package" 2>/dev/null
+    else
+        echo ''
+    fi
+}
+
+# APT wrapper for non-interactive operation
+#
+# [internal]
+#
+# usage: ynh_apt update
+#
+# Requires YunoHost version 2.4.0.3 or higher.
+ynh_apt() {
+    ynh_wait_dpkg_free
+    LC_ALL=C DEBIAN_FRONTEND=noninteractive apt-get --assume-yes --quiet -o=Dpkg::Use-Pty=0 $@
+}
+
+# Update package index files
+#
+# usage: ynh_package_update
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_update() {
+    ynh_apt update
+}
+
+# Install package(s)
+#
+# usage: ynh_package_install name [name [...]]
+# | arg: name - the package name to install
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_install() {
+    ynh_apt --no-remove --option Dpkg::Options::=--force-confdef \
+        --option Dpkg::Options::=--force-confold install $@
+}
+
+# Remove package(s)
+#
+# usage: ynh_package_remove name [name [...]]
+# | arg: name - the package name to remove
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_remove() {
+    ynh_apt remove $@
+}
+
+# Remove package(s) and their uneeded dependencies
+#
+# usage: ynh_package_autoremove name [name [...]]
+# | arg: name - the package name to remove
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_autoremove() {
+    ynh_apt autoremove $@
+}
+
+# Purge package(s) and their uneeded dependencies
+#
+# usage: ynh_package_autopurge name [name [...]]
+# | arg: name - the package name to autoremove and purge
+#
+# Requires YunoHost version 2.7.2 or higher.
+ynh_package_autopurge() {
+    ynh_apt autoremove --purge $@
+}
+
+# Build and install a package from an equivs control file
+#
+# [internal]
+#
+# example: generate an empty control file with `equivs-control`, adjust its
+#          content and use helper to build and install the package:
+#              ynh_package_install_from_equivs /path/to/controlfile
+#
+# usage: ynh_package_install_from_equivs controlfile
+# | arg: controlfile - path of the equivs control file
+#
+# Requires YunoHost version 2.2.4 or higher.
+ynh_package_install_from_equivs () {
+    local controlfile=$1
+
+    # retrieve package information
+    local pkgname=$(grep '^Package: ' $controlfile | cut --delimiter=' ' --fields=2)	# Retrieve the name of the debian package
+    local pkgversion=$(grep '^Version: ' $controlfile | cut --delimiter=' ' --fields=2)	# And its version number
+    [[ -z "$pkgname" || -z "$pkgversion" ]] \
+        && ynh_die --message="Invalid control file"	# Check if this 2 variables aren't empty.
+
+    # Update packages cache
+    ynh_package_update
+
+    # Build and install the package
+    local TMPDIR=$(mktemp --directory)
+
+    # Force the compatibility level at 10, levels below are deprecated 
+    echo 10 > /usr/share/equivs/template/debian/compat
+
+    # Note that the cd executes into a sub shell
+    # Create a fake deb package with equivs-build and the given control file
+    # Install the fake package without its dependencies with dpkg
+    # Install missing dependencies with ynh_package_install
+    ynh_wait_dpkg_free
+    cp "$controlfile" "${TMPDIR}/control"
+    (cd "$TMPDIR"
+    LC_ALL=C equivs-build ./control 1> /dev/null
+    dpkg --force-depends --install "./${pkgname}_${pkgversion}_all.deb" 2>&1)
+
+    ynh_package_install --fix-broken || \
+        { # If the installation failed 
+        # (the following is ran inside { } to not start a subshell otherwise ynh_die wouldnt exit the original process)
+        # Get the list of dependencies from the deb
+        local dependencies="$(dpkg --info "$TMPDIR/${pkgname}_${pkgversion}_all.deb" | grep Depends | \
+            sed 's/^ Depends: //' | sed 's/,//g')"
+        # Fake an install of those dependencies to see the errors
+        # The sed command here is, Print only from '--fix-broken' to the end.
+        ynh_package_install $dependencies --dry-run | sed --quiet '/--fix-broken/,$p' >&2
+        ynh_die --message="Unable to install dependencies"; }
+    [[ -n "$TMPDIR" ]] && rm --recursive --force $TMPDIR	# Remove the temp dir.
+
+    # check if the package is actually installed
+    ynh_package_is_installed "$pkgname"
+}
+
+# Define and install dependencies with a equivs control file
+#
+# This helper can/should only be called once per app
+#
+# example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
+#
+# usage: ynh_install_app_dependencies dep [dep [...]]
+# | arg: dep - the package name to install in dependence. Writing "dep3|dep4|dep5" can be used to specify alternatives. For example : dep1 dep2 "dep3|dep4|dep5" will require to install dep1 and dep 2 and (dep3 or dep4 or dep5).
+#
+# Requires YunoHost version 2.6.4 or higher.
+ynh_install_app_dependencies () {
+    local dependencies=$@
+    # Add a comma for each space between packages. But not add a comma if the space separate a version specification. (See  below)
+    dependencies="$(echo "$dependencies" | sed 's/\([^\<=\>]\)\ \([^(]\)/\1, \2/g')"
+    local dependencies=${dependencies//|/ | }
+    local 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
+
+    local version=$(grep '\"version\": ' "$manifest_path" | cut --delimiter='"' --fields=4)	# Retrieve the version number in the manifest file.
+    if [ ${#version} -eq 0 ]; then
+        version="1.0"
+    fi
+    local dep_app=${app//_/-}	# Replace all '_' by '-'
+
+    # Handle specific versions
+    if [[ "$dependencies" =~ [\<=\>] ]]
+    then
+        # Replace version specifications by relationships syntax
+        # https://www.debian.org/doc/debian-policy/ch-relationships.html
+        # Sed clarification
+        # [^(\<=\>] ignore if it begins by ( or < = >. To not apply twice.
+        # [\<=\>] matches < = or >
+        # \+ matches one or more occurence of the previous characters, for >= or >>.
+        # [^,]\+ matches all characters except ','
+        # Ex: 'package>=1.0' will be replaced by 'package (>= 1.0)'
+        dependencies="$(echo "$dependencies" | sed 's/\([^(\<=\>]\)\([\<=\>]\+\)\([^,]\+\)/\1 (\2 \3)/g')"
+    fi
+
+    #
+    # Epic ugly hack to fix the goddamn dependency nightmare of sury
+    # Sponsored by the "Djeezusse Fokin Kraiste Why Do Adminsys Has To Be So Fucking Complicated I Should Go Grow Potatoes Instead Of This Shit" collective
+    # https://github.com/YunoHost/issues/issues/1407
+    # 
+    # If we require to install php dependency
+    if echo $dependencies | grep --quiet 'php'
+    then
+        # And we have packages from sury installed (7.0.33-10+weirdshiftafter instead of 7.0.33-0 on debian)
+        if dpkg --list | grep "php7.0" | grep --quiet --invert-match "7.0.33-0+deb9"
+        then
+            # And sury ain't already installed
+            if ! grep --line-number --recursive --quiet "sury" /etc/apt/sources.list*
+            then
+                # Re-add sury
+                ynh_install_extra_repo --repo="https://packages.sury.org/php/ $(ynh_get_debian_release) main" --key="https://packages.sury.org/php/apt.gpg" --name=extra_php_version
+
+                # Pin this sury repository to prevent sury of doing shit
+                ynh_pin_repo --package="*" --pin="origin \"packages.sury.org\"" --priority=200 --name=extra_php_version
+                ynh_pin_repo --package="php${YNH_DEFAULT_PHP_VERSION}*" --pin="origin \"packages.sury.org\"" --priority=600 --name=extra_php_version --append
+            fi
+        fi
+    fi
+
+    cat > /tmp/${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 /tmp/${dep_app}-ynh-deps.control \
+        || ynh_die --message="Unable to install dependencies"	# Install the fake package and its dependencies
+    rm /tmp/${dep_app}-ynh-deps.control
+    ynh_app_setting_set --app=$app --key=apt_dependencies --value="$dependencies"
+}
+
+# Add dependencies to install with ynh_install_app_dependencies
+#
+# usage: ynh_add_app_dependencies --package=phpversion [--replace]
+# | arg: -p, --package=     - Packages to add as dependencies for the app.
+# | arg: -r, --replace      - Replace dependencies instead of adding to existing ones.
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_add_app_dependencies () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=pr
+    local -A args_array=( [p]=package= [r]=replace)
+    local package
+    local replace
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    replace=${replace:-0}
+
+    local current_dependencies=""
+    if [ $replace -eq 0 ]
+    then
+        local dep_app=${app//_/-}	# Replace all '_' by '-'
+        if ynh_package_is_installed --package="${dep_app}-ynh-deps"
+        then
+            current_dependencies="$(dpkg-query --show --showformat='${Depends}' ${dep_app}-ynh-deps) "
+        fi
+
+        current_dependencies=${current_dependencies// | /|}
+    fi
+
+    ynh_install_app_dependencies "${current_dependencies}${package}"
+}
+
+# Remove fake package and its dependencies
+#
+# Dependencies will removed only if no other package need them.
+#
+# usage: ynh_remove_app_dependencies
+#
+# Requires YunoHost version 2.6.4 or higher.
+ynh_remove_app_dependencies () {
+    local dep_app=${app//_/-}	# Replace all '_' by '-'
+    ynh_package_autopurge ${dep_app}-ynh-deps	# Remove the fake package and its dependencies if they not still used.
+}
+
+#=================================================
+
+# Install packages from an extra repository properly.
+#
+# usage: ynh_install_extra_app_dependencies --repo="repo" --package="dep1 dep2" [--key=key_url] [--name=name]
+# | arg: -r, --repo=    - Complete url of the extra repository.
+# | arg: -p, --package= - The packages to install from this extra repository
+# | arg: -k, --key=     - url to get the public key.
+# | arg: -n, --name=    - Name for the files for this repo, $app as default value.
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_install_extra_app_dependencies () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=rpkn
+    local -A args_array=( [r]=repo= [p]=package= [k]=key= [n]=name= )
+    local repo
+    local package
+    local key
+    local name
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    name="${name:-$app}"
+    key=${key:-}
+
+    # Set a key only if asked
+    if [ -n "$key" ]
+    then
+        key="--key=$key"
+    fi
+    # Add an extra repository for those packages
+    ynh_install_extra_repo --repo="$repo" $key --priority=995 --name=$name
+
+    # Install requested dependencies from this extra repository.
+    ynh_add_app_dependencies --package="$package"
+
+    # Remove this extra repository after packages are installed
+    ynh_remove_extra_repo --name=$app
+}
+
+# Add an extra repository correctly, pin it and get the key.
+#
+# [internal]
+#
+# usage: ynh_install_extra_repo --repo="repo" [--key=key_url] [--priority=priority_value] [--name=name] [--append]
+# | arg: -r, --repo=        - Complete url of the extra repository.
+# | arg: -k, --key=         - url to get the public key.
+# | arg: -p, --priority=    - Priority for the pin
+# | arg: -n, --name=        - Name for the files for this repo, $app as default value.
+# | arg: -a, --append       - Do not overwrite existing files.
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_install_extra_repo () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=rkpna
+    local -A args_array=( [r]=repo= [k]=key= [p]=priority= [n]=name= [a]=append )
+    local repo
+    local key
+    local priority
+    local name
+    local append
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    name="${name:-$app}"
+    append=${append:-0}
+    key=${key:-}
+    priority=${priority:-}
+
+    if [ $append -eq 1 ]
+    then
+        append="--append"
+        wget_append="tee --append"
+    else
+        append=""
+        wget_append="tee"
+    fi
+
+    # Split the repository into uri, suite and components.
+    # Remove "deb " at the beginning of the repo.
+    repo="${repo#deb }"
+
+    # Get the uri
+    local uri="$(echo "$repo" | awk '{ print $1 }')"
+
+    # Get the suite
+    local suite="$(echo "$repo" | awk '{ print $2 }')"
+
+    # Get the components
+    local component="${repo##$uri $suite }"
+
+    # Add the repository into sources.list.d
+    ynh_add_repo --uri="$uri" --suite="$suite" --component="$component" --name="$name" $append
+
+    # Pin the new repo with the default priority, so it won't be used for upgrades.
+    # Build $pin from the uri without http and any sub path
+    local pin="${uri#*://}"
+    pin="${pin%%/*}"
+    # Set a priority only if asked
+    if [ -n "$priority" ]
+    then
+        priority="--priority=$priority"
+    fi
+    ynh_pin_repo --package="*" --pin="origin \"$pin\"" $priority --name="$name" $append
+
+    # Get the public key for the repo
+    if [ -n "$key" ]
+    then
+        mkdir --parents "/etc/apt/trusted.gpg.d"
+        # Timeout option is here to enforce the timeout on dns query and tcp connect (c.f. man wget)
+        wget --timeout 900 --quiet "$key" --output-document=- | gpg --dearmor | $wget_append /etc/apt/trusted.gpg.d/$name.gpg > /dev/null
+    fi
+
+    # Update the list of package with the new repo
+    ynh_package_update
+}
+
+# Remove an extra repository and the assiociated configuration.
+#
+# [internal]
+#
+# usage: ynh_remove_extra_repo [--name=name]
+# | arg: -n, --name=    - Name for the files for this repo, $app as default value.
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_remove_extra_repo () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=n
+    local -A args_array=( [n]=name= )
+    local name
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    name="${name:-$app}"
+
+    ynh_secure_remove "/etc/apt/sources.list.d/$name.list"
+    ynh_secure_remove "/etc/apt/preferences.d/$name"
+    ynh_secure_remove "/etc/apt/trusted.gpg.d/$name.gpg"
+    ynh_secure_remove "/etc/apt/trusted.gpg.d/$name.asc"
+
+    # Update the list of package to exclude the old repo
+    ynh_package_update
+}
+
+# Add a repository.
+#
+# [internal]
+#
+# usage: ynh_add_repo --uri=uri --suite=suite --component=component [--name=name] [--append]
+# | arg: -u, --uri=         - Uri of the repository.
+# | arg: -s, --suite=       - Suite of the repository.
+# | arg: -c, --component=   - Component of the repository.
+# | arg: -n, --name=        - Name for the files for this repo, $app as default value.
+# | arg: -a, --append       - Do not overwrite existing files.
+#
+# Example for a repo like deb http://forge.yunohost.org/debian/ stretch stable
+#                             uri                               suite   component
+# ynh_add_repo --uri=http://forge.yunohost.org/debian/ --suite=stretch --component=stable
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_add_repo () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=uscna
+    local -A args_array=( [u]=uri= [s]=suite= [c]=component= [n]=name= [a]=append )
+    local uri
+    local suite
+    local component
+    local name
+    local append
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    name="${name:-$app}"
+    append=${append:-0}
+
+    if [ $append -eq 1 ]
+    then
+        append="tee --append"
+    else
+        append="tee"
+    fi
+
+    mkdir --parents "/etc/apt/sources.list.d"
+    # Add the new repo in sources.list.d
+    echo "deb $uri $suite $component" \
+        | $append "/etc/apt/sources.list.d/$name.list"
+}
+
+# Pin a repository.
+#
+# [internal]
+#
+# usage: ynh_pin_repo --package=packages --pin=pin_filter [--priority=priority_value] [--name=name] [--append]
+# | arg: -p, --package=     - Packages concerned by the pin. Or all, *.
+# | arg: -i, --pin=         - Filter for the pin.
+# | arg: -p, --priority=    - Priority for the pin
+# | arg: -n, --name=        - Name for the files for this repo, $app as default value.
+# | arg: -a, --append       - Do not overwrite existing files.
+#
+# See https://manpages.debian.org/stretch/apt/apt_preferences.5.en.html#How_APT_Interprets_Priorities for information about pinning.
+#
+# Requires YunoHost version 3.8.1 or higher.
+ynh_pin_repo () {
+    # Declare an array to define the options of this helper.
+    local legacy_args=pirna
+    local -A args_array=( [p]=package= [i]=pin= [r]=priority= [n]=name= [a]=append )
+    local package
+    local pin
+    local priority
+    local name
+    local append
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    package="${package:-*}"
+    priority=${priority:-50}
+    name="${name:-$app}"
+    append=${append:-0}
+
+    if [ $append -eq 1 ]
+    then
+        append="tee --append"
+    else
+        append="tee"
+    fi
+
+    mkdir --parents "/etc/apt/preferences.d"
+    echo "Package: $package
+Pin: $pin
+Pin-Priority: $priority
+" \
+    | $append "/etc/apt/preferences.d/$name"
+}
+