upgrade to current master + PHP7.3

README.md

@@ -11,7 +11,7 @@ If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to
 streaming application and file manager allowing you to access your 
 music & videos from anywhere, using almost any internet enabled device.
 
-**Shipped version:** 3.9.0
+**Shipped version:** 4.1.1.1
 
 ## Screenshots
 

conf/app.src

@@ -1,5 +1,5 @@
-SOURCE_URL=https://github.com/ampache/ampache/archive/3.9.0.tar.gz
+SOURCE_URL=https://github.com/ampache/ampache/archive/f9ea16e7fc7a36636180241dc79f139b92bc8ff0.tar.gz
-SOURCE_SUM=1e523b52c6402693102dac183d7597d6e0aebf63580167f45661d0f15f57c072
+SOURCE_SUM=9cee154350b3b747b4ec6d405be768e8a3b0b1f0331a9f373c6a7c54c51f4775
 SOURCE_SUM_PRG=sha256sum
 SOURCE_FORMAT=tar.gz
 SOURCE_IN_SUBDIR=true

conf/nginx.conf

@@ -17,7 +17,7 @@ location __PATH__/ {
 	try_files $uri $uri/ index.php;
 	location ~ [^/]\.php(/|$) {
 		fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-		fastcgi_pass unix:/var/run/php/php7.0-fpm-__NAME__.sock;
+		fastcgi_pass unix:/var/run/php/php7.3-fpm-__NAME__.sock;
 		fastcgi_index index.php;
 		include fastcgi_params;
 		fastcgi_param REMOTE_USER $remote_user;

conf/php-fpm.conf

@@ -33,7 +33,7 @@ group = __USER__
 ;                            (IPv6 and IPv4-mapped) on a specific port;
 ;   '/path/to/unix/socket' - to listen on a unix socket.
 ; Note: This value is mandatory.
-listen = /var/run/php/php7.0-fpm-__NAMETOCHANGE__.sock
+listen = /var/run/php/php7.3-fpm-__NAMETOCHANGE__.sock
 
 ; Set listen(2) backlog.
 ; Default Value: 511 (-1 on FreeBSD and OpenBSD)
@@ -229,7 +229,7 @@ pm.max_spare_servers = 3
 ;   last request memory:  0
 ;
 ; Note: There is a real-time FPM status monitoring sample web page available
-;       It's available in: /usr/share/php/7.0/fpm/status.html
+;       It's available in: /usr/share/php/7.3/fpm/status.html
 ;
 ; Note: The value must start with a leading slash (/). The value can be
 ;       anything, but it may not be a good idea to use the .php extension or it

manifest.json

@@ -6,7 +6,7 @@
         "en": "A web based audio/video streaming application",
         "fr": "Une application de streaming audio et vidéo"
     },
-    "version": "3.9.0~ynh2",
+    "version": "4.1.1.1~ynh1",
     "url": "http://ampache.org",
     "license": "AGPL-3.0",
     "maintainer": {
@@ -19,7 +19,7 @@
     "multi_instance": true,
     "services" : [
         "nginx",
-        "php7.0-fpm",
+        "php7.3-fpm",
         "mysql"
     ],
     "arguments": {

scripts/_common.sh

@@ -5,7 +5,10 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="libav-tools|ffmpeg php-cli"
+pkg_dependencies="libav-tools|ffmpeg"
+
+extra_pkg_dependencies=""
+# php7.3-gmp php7.3-dom php7.3-pcre php7.3-spl php7.3-simplexml php7.3-ctype php7.3-date php7.3-iconv php7.3-curl php7.3-gd  php7.3-mbstring php7.3-libxml php7.3-xmlwriter php7.3-xmlreader
 
 #=================================================
 # EXPERIMENTAL HELPERS
@@ -58,6 +61,378 @@ ynh_install_composer () {
 		|| ynh_die "Unable to update core dependencies with Composer."
 }
 
+# Pin a repository.
+#
+# 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 for information about pinning.
+#
+ynh_pin_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=pirna
+	declare -Ar 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 -a"
+	else
+		append="tee"
+	fi
+
+	mkdir -p "/etc/apt/preferences.d"
+	echo "Package: $package
+Pin: $pin
+Pin-Priority: $priority" \
+	| $append "/etc/apt/preferences.d/$name"
+}
+
+# Add a repository.
+#
+# 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
+#
+ynh_add_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=uscna
+	declare -Ar 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 -a"
+	else
+		append="tee"
+	fi
+
+	mkdir -p "/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"
+}
+
+# Add an extra repository correctly, pin it and get the key.
+#
+# 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.
+ynh_install_extra_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=rkpna
+	declare -Ar 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:-0}
+	priority=${priority:-}
+
+	if [ $append -eq 1 ]
+	then
+		append="--append"
+		wget_append="tee -a"
+	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 -p "/etc/apt/trusted.gpg.d"
+		wget -q "$key" -O - | 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.
+#
+# usage: ynh_remove_extra_repo [--name=name]
+# | arg: -n, --name - Name for the files for this repo, $app as default value.
+ynh_remove_extra_repo () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=n
+	declare -Ar 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
+}
+
+# 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.
+ynh_install_extra_app_dependencies () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=rpkn
+	declare -Ar 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:-0}
+
+	# 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
+}
+
+#=================================================
+
+# patched version of ynh_install_app_dependencies to be used with ynh_add_app_dependencies
+
+# Define and install dependencies with a equivs control file
+# This helper can/should only be called once per app
+#
+# usage: ynh_install_app_dependencies dep [dep [...]]
+# | arg: dep - the package name to install in dependence
+#   You can give a choice between some package with this syntax : "dep1|dep2"
+#   Example : ynh_install_app_dependencies dep1 dep2 "dep3|dep4|dep5"
+#   This mean in the dependence tree : dep1 & dep2 & (dep3 | dep4 | dep5)
+#
+# Requires YunoHost version 2.6.4 or higher.
+ynh_install_app_dependencies () {
+    local dependencies=$@
+    dependencies="$(echo "$dependencies" | sed 's/\([^\<=\>]\)\ \([^(]\)/\1, \2/g')"
+    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 -d '"' -f 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
+
+    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"
+}
+
+ynh_add_app_dependencies () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=pr
+	declare -Ar 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}"
+}
+
+# Install another version of php.
+#
+# usage: ynh_install_php --phpversion=phpversion [--package=packages]
+# | arg: -v, --phpversion - Version of php to install. Can be one of 7.1, 7.2 or 7.3
+# | arg: -p, --package - Additionnal php packages to install
+ynh_install_php () {
+	# Declare an array to define the options of this helper.
+	local legacy_args=vp
+	declare -Ar args_array=( [v]=phpversion= [p]=package= )
+	local phpversion
+	local package
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+	package=${package:-}
+
+	# Store php_version into the config of this app
+	ynh_app_setting_set $app php_version $phpversion
+
+	if [ "$phpversion" == "7.0" ]
+	then
+		ynh_die "Do not use ynh_install_php to install php7.0"
+	fi
+
+	# Store the ID of this app and the version of php requested for it
+	echo "$YNH_APP_INSTANCE_NAME:$phpversion" | tee --append "/etc/php/ynh_app_version"
+
+	# Add an extra repository for those packages
+	ynh_install_extra_repo --repo="https://packages.sury.org/php/ $(lsb_release -sc) main" --key="https://packages.sury.org/php/apt.gpg" --priority=995 --name=extra_php_version
+
+	# Install requested dependencies from this extra repository.
+	# Install php-fpm first, otherwise php will install apache as a dependency.
+	ynh_add_app_dependencies --package="php${phpversion}-fpm"
+	ynh_add_app_dependencies --package="php$phpversion php${phpversion}-common $package"
+
+	# Set php7.0 back as the default version for php-cli.
+	update-alternatives --set php /usr/bin/php7.0
+
+	# Pin this extra repository after packages are installed to prevent sury of doing shit
+	ynh_pin_repo --package="*" --pin="origin \"packages.sury.org\"" 200 --name=extra_php_version
+	ynh_pin_repo --package="php7.0*" --pin="origin \"packages.sury.org\"" 600 --name=extra_php_version --append
+
+	# INTEGRATE SERVICE IN YUNOHOST
+	yunohost service add php${phpversion}-fpm --log "/var/log/php${phpversion}-fpm.log"
+}
+
+ynh_remove_php () {
+	# Get the version of php used by this app
+	local phpversion=$(ynh_app_setting_get $app php_version)
+
+	if [ "$phpversion" == "7.0" ] || [ -z "$phpversion" ]
+	then
+		if [ "$phpversion" == "7.0" ]
+		then
+			ynh_print_err "Do not use ynh_remove_php to install php7.0"
+		fi
+		return 0
+	fi
+
+	# Remove the line for this app
+	sed --in-place "/$YNH_APP_INSTANCE_NAME:$phpversion/d" "/etc/php/ynh_app_version"
+
+	# If no other app uses this version of php, remove it.
+	if ! grep --quiet "$phpversion" "/etc/php/ynh_app_version"
+	then
+		# Purge php dependences for this version.
+		ynh_package_autopurge "php$phpversion php${phpversion}-fpm php${phpversion}-common"
+		# Remove the service from the admin panel
+		yunohost service remove php${phpversion}-fpm
+	fi
+
+	# If no other app uses alternate php versions, remove the extra repo for php
+	if [ ! -s "/etc/php/ynh_app_version" ]
+	then
+		ynh_secure_remove /etc/php/ynh_app_version
+	fi
+}
+
+
+
 #=================================================
 # FUTURE OFFICIAL HELPERS
 #=================================================

scripts/backup

@@ -48,7 +48,7 @@ ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf"
 #=================================================
 ynh_script_progression --message="Backing up php-fpm configuration..."
 
-ynh_backup --src_path="/etc/php/7.0/fpm/pool.d/$app.conf"
+ynh_backup --src_path="/etc/php/7.3/fpm/pool.d/$app.conf"
 
 #=================================================
 # BACKUP THE MYSQL DATABASE

scripts/install

@@ -50,6 +50,17 @@ ynh_app_setting_set --app=$app --key=is_public --value=$is_public
 
 #=================================================
 # STANDARD MODIFICATIONS
+#=================================================
+# INSTALL PHP7.3
+#=================================================
+
+if [ "$(lsb_release --codename --short)" = "buster" ]; then
+	pkg_dependencies="$pkg_dependencies $extra_pkg_dependencies"
+else
+	ynh_print_info --message="Installing PHP7.3..."
+	ynh_install_php --phpversion="7.3" --package="$extra_pkg_dependencies"
+fi
+
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
@@ -135,9 +146,9 @@ ynh_mysql_connect_as --user=$app --password="$db_pwd" --database=$app < "$final_
 ynh_script_progression --message="Installing ampache with composer..." --weight=45
 
 # Install composer
-ynh_install_composer
+ynh_install_composer --phpversion="7.3" --workdir="$final_path"
 
-ynh_exec_warn_less ynh_composer_exec --commands=\"install --prefer-source --no-dev\"
+ynh_exec_warn_less ynh_composer_exec --phpversion="7.3" --workdir=$final_path --commands=\"install --prefer-source --no-dev\"
 
 #=================================================
 # INSTALL MULTIMEDIA DIRECTORIES

scripts/remove

@@ -31,6 +31,15 @@ ynh_script_progression --message="Removing the MySQL database..." --weight=3
 # Remove a database if it exists, along with the associated user
 ynh_mysql_remove_db --db_user=$db_user --db_name=$db_name
 
+#=================================================
+# REMOVE PHP
+#=================================================
+
+if [ "$(lsb_release --codename --short)" != "buster" ]; then
+	ynh_print_info --message="Removing php..."
+	ynh_remove_php
+fi
+
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================

scripts/restore

@@ -72,10 +72,21 @@ chown -R $app: $final_path
 # RESTORE THE PHP-FPM CONFIGURATION
 #=================================================
 
-ynh_restore_file --origin_path="/etc/php/7.0/fpm/pool.d/$app.conf"
+ynh_restore_file --origin_path="/etc/php/7.3/fpm/pool.d/$app.conf"
 
 #=================================================
 # SPECIFIC RESTORATION
+#=================================================
+# REINSTALL PHP7.3
+#=================================================
+
+if [ "$(lsb_release --codename --short)" = "buster" ]; then
+	pkg_dependencies="$pkg_dependencies $extra_pkg_dependencies"
+else
+	ynh_print_info --message="Reinstalling PHP7.3..."
+	ynh_install_php --phpversion="7.3" --package="$extra_pkg_dependencies"
+fi
+
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
@@ -99,7 +110,7 @@ ynh_mysql_connect_as --user=$db_user --password=$db_pwd --database=$db_name < ./
 #=================================================
 ynh_script_progression --message="Reloading nginx web server and php-fpm..."
 
-ynh_systemd_action --service_name=php7.0-fpm --action=reload
+ynh_systemd_action --service_name=php7.3-fpm --action=reload
 ynh_systemd_action --service_name=nginx --action=reload
 
 #=================================================

scripts/upgrade

@@ -111,6 +111,24 @@ ynh_script_progression --message="Upgrading nginx web server configuration..." -
 # Create a dedicated nginx config
 ynh_add_nginx_config
 
+#=================================================
+# UPGRADE PHP7.3
+#=================================================
+
+if [ "$(lsb_release --codename --short)" = "buster" ]; then
+    pkg_dependencies="$pkg_dependencies $extra_pkg_dependencies"
+else
+    if [ "$(ynh_app_setting_get --app=$app --key=php_version)" != "7.3" ]; then
+        ynh_print_info --message="Upgrading PHP7.3..."
+        ynh_remove_fpm_config
+        ynh_remove_app_dependencies
+        ynh_remove_php
+        ynh_install_php --phpversion="7.3" --package="$extra_pkg_dependencies"
+    else
+        ynh_install_php --phpversion="7.3" --package="$extra_pkg_dependencies"
+    fi
+fi
+
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
@@ -164,10 +182,10 @@ then
     ynh_script_progression --message="Upgrading ampache with composer..." --weight=30
 
     # Install composer
-    ynh_install_composer
+    ynh_install_composer --phpversion="7.3" --workdir="$final_path"
 
-    ynh_composer_exec --commands="config discard-changes true"
+    ynh_composer_exec --phpversion="7.3" --workdir=$final_path --commands="config discard-changes true"
-    ynh_composer_exec --commands="update --prefer-source --no-interaction --no-dev"
+    ynh_composer_exec --phpversion="7.3" --workdir=$final_path --commands="update --prefer-source --no-interaction --no-dev"
 fi
 
 #=================================================