From 7c62a0f6cb568a1fda40a5de2e1fe538efb05511 Mon Sep 17 00:00:00 2001 From: tituspijean Date: Sat, 27 Mar 2021 12:08:11 +0100 Subject: [PATCH] Overhaul of package installation Moving away from unreliable debian repo and use deb files WIP, YunoHost does not encourage directly using apt --- conf/ffmpeg.src.default | 7 ++ conf/ldap.src | 1 - conf/server.src.default | 7 ++ conf/web.src.default | 7 ++ manifest.json | 20 +---- scripts/_common.sh | 166 ++++++++++++++++++++++++++++++++++++++++ scripts/install | 23 +++++- scripts/remove | 4 + scripts/restore | 30 ++++++-- scripts/upgrade | 23 +++++- 10 files changed, 262 insertions(+), 26 deletions(-) create mode 100644 conf/ffmpeg.src.default create mode 100644 conf/server.src.default create mode 100644 conf/web.src.default diff --git a/conf/ffmpeg.src.default b/conf/ffmpeg.src.default new file mode 100644 index 0000000..5c0349b --- /dev/null +++ b/conf/ffmpeg.src.default @@ -0,0 +1,7 @@ +SOURCE_URL=https://repo.jellyfin.org/releases/server/debian/versions/jellyfin-ffmpeg/__FFMPEG_PKG_VERSION__/jellyfin-ffmpeg___FFMPEG_PKG_VERSION__-__DEBIAN___amd64.deb +SOURCE_SUM=https://repo.jellyfin.org/releases/server/debian/versions/jellyfin-ffmpeg/__FFMPEG_PKG_VERSION__/jellyfin-ffmpeg___FFMPEG_PKG_VERSION__-__DEBIAN___amd64.deb.sha256sum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=deb +SOURCE_IN_SUBDIR=false +SOURCE_EXTRACT=false +SOURCE_FILENAME=jellyfin-ffmpeg.deb diff --git a/conf/ldap.src b/conf/ldap.src index 7ddae3c..618a43c 100644 --- a/conf/ldap.src +++ b/conf/ldap.src @@ -5,4 +5,3 @@ SOURCE_FORMAT=zip SOURCE_IN_SUBDIR=false SOURCE_FILENAME= SOURCE_EXTRACT=true - diff --git a/conf/server.src.default b/conf/server.src.default new file mode 100644 index 0000000..fa7d4ba --- /dev/null +++ b/conf/server.src.default @@ -0,0 +1,7 @@ +SOURCE_URL=https://repo.jellyfin.org/releases/server/debian/versions/stable/server/__VERSION__/jellyfin-server___PKG_VERSION_____ARCHITECTURE__.deb +SOURCE_SUM=https://repo.jellyfin.org/releases/server/debian/versions/stable/server/__VERSION__/jellyfin-server___PKG_VERSION_____ARCHITECTURE__.deb.sha256sum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=deb +SOURCE_IN_SUBDIR=false +SOURCE_EXTRACT=false +SOURCE_FILENAME=jellyfin-server.deb diff --git a/conf/web.src.default b/conf/web.src.default new file mode 100644 index 0000000..9a3a1fc --- /dev/null +++ b/conf/web.src.default @@ -0,0 +1,7 @@ +SOURCE_URL=https://repo.jellyfin.org/releases/server/debian/versions/stable/web/__VERSION__/jellyfin-web___PKG_VERSION___all.deb +SOURCE_SUM=https://repo.jellyfin.org/releases/server/debian/versions/stable/web/__VERSION__/jellyfin-web___PKG_VERSION___all.deb.sha256sum +SOURCE_SUM_PRG=sha256sum +SOURCE_FORMAT=deb +SOURCE_IN_SUBDIR=false +SOURCE_EXTRACT=false +SOURCE_FILENAME=jellyfin-web.deb diff --git a/manifest.json b/manifest.json index f12a6dd..bb49b67 100644 --- a/manifest.json +++ b/manifest.json @@ -6,7 +6,7 @@ "en": "Media System that manage and stream your media.", "fr": "Système multimédia qui gère et diffuse vos médias." }, - "version": "10.7.0~ynh1", + "version": "10.7.0~ynh2", "url": "https://github.com/jellyfin/jellyfin", "license": "GPL-2.0-only", "maintainer": { @@ -14,7 +14,7 @@ "email": "liberodark@gmail.com" }, "requirements": { - "yunohost": ">= 3.8.1" + "yunohost": ">= 4.1.0" }, "multi_instance": false, "services": [ @@ -24,38 +24,22 @@ "install": [{ "name": "domain", "type": "domain", - "ask": { - "en": "Choose a domain name for Jellyfin", - "fr": "Choisissez un nom de domaine pour Jellyfin" - }, "example": "example.com" }, { "name": "path", "type": "path", - "ask": { - "en": "Choose a path for Jellyfin", - "fr": "Choisissez un chemin pour Jellyfin" - }, "example": "/jellyfin", "default": "/jellyfin" }, { "name": "admin", "type": "user", - "ask": { - "en": "Choose an admin user", - "fr": "Choisissez l'administrateur" - }, "example": "johndoe" }, { "name": "is_public", "type": "boolean", - "ask": { - "en": "Is it a public application?", - "fr": "Est-ce une application publique ?" - }, "default": true, "help": { "en": "Jellyfin has its own login system, you should make it public to let external clients access it (mobile app, etc.).", diff --git a/scripts/_common.sh b/scripts/_common.sh index c0e6516..b9feff8 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,12 +4,178 @@ # COMMON VARIABLES #================================================= +debian=$(lsb_release --codename --short) pkg_version="10.7.0-1" +version=$(echo "$pkg_version" | cut -d '-' -f 1) + +ffmpeg_pkg_version="4.3.1-4" #================================================= # PERSONAL HELPERS #================================================= +# +# usage: ynh_setup_source_2 --dest_dir=dest_dir [--source_id=source_id] +# | arg: -d, --dest_dir= - Directory where to setup sources +# | arg: -s, --source_id= - Name of the app, if the package contains more than one app +# +# The file conf/app.src need to contains: +# +# SOURCE_URL=Address to download the app archive +# SOURCE_SUM can either be the SUM string, or a URL to a file containing the SUM. +# If a URL is provided, the contents of the file will be cut to the first space. +# SOURCE_SUM=Control sum +# # (Optional) Program to check the integrity (sha256sum, md5sum...) +# # default: sha256 +# SOURCE_SUM_PRG=sha256 +# # (Optional) Archive format +# # default: tar.gz +# SOURCE_FORMAT=tar.gz +# # (Optional) Put false if sources are directly in the archive root +# # default: true +# # Instead of true, SOURCE_IN_SUBDIR could be the number of sub directories +# # to remove. +# SOURCE_IN_SUBDIR=false +# # (Optionnal) Name of the local archive (offline setup support) +# # default: ${src_id}.${src_format} +# SOURCE_FILENAME=example.tar.gz +# # (Optional) If it set as false don't extract the source. +# # (Useful to get a debian package or a python wheel.) +# # default: true +# SOURCE_EXTRACT=(true|false) +# +# Details: +# This helper downloads sources from SOURCE_URL if there is no local source +# archive in /opt/yunohost-apps-src/APP_ID/SOURCE_FILENAME +# +# Next, it checks the integrity with "SOURCE_SUM_PRG -c --status" command. +# +# If it's ok, the source archive will be uncompressed in $dest_dir. If the +# SOURCE_IN_SUBDIR is true, the first level directory of the archive will be +# removed. +# If SOURCE_IN_SUBDIR is a numeric value, 2 for example, the 2 first level +# directories will be removed +# +# Finally, patches named sources/patches/${src_id}-*.patch and extra files in +# sources/extra_files/$src_id will be applied to dest_dir +# +# Requires YunoHost version 2.6.4 or higher. +ynh_setup_source_2 () { + # Declare an array to define the options of this helper. + local legacy_args=ds + local -A args_array=( [d]=dest_dir= [s]=source_id= ) + local dest_dir + local source_id + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + source_id="${source_id:-app}" # If the argument is not given, source_id equals "app" + + local src_file_path="$YNH_CWD/../conf/${source_id}.src" + # In case of restore script the src file is in an other path. + # So try to use the restore path if the general path point to no file. + if [ ! -e "$src_file_path" ]; then + src_file_path="$YNH_CWD/../settings/conf/${source_id}.src" + fi + + # Load value from configuration file (see above for a small doc about this file + # format) + local src_url=$(grep 'SOURCE_URL=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_sum=$(grep 'SOURCE_SUM=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_sumprg=$(grep 'SOURCE_SUM_PRG=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_format=$(grep 'SOURCE_FORMAT=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_extract=$(grep 'SOURCE_EXTRACT=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_in_subdir=$(grep 'SOURCE_IN_SUBDIR=' "$src_file_path" | cut --delimiter='=' --fields=2-) + local src_filename=$(grep 'SOURCE_FILENAME=' "$src_file_path" | cut --delimiter='=' --fields=2-) + + # Default value + src_sumprg=${src_sumprg:-sha256sum} + src_in_subdir=${src_in_subdir:-true} + src_format=${src_format:-tar.gz} + src_format=$(echo "$src_format" | tr '[:upper:]' '[:lower:]') + src_extract=${src_extract:-true} + if [ "$src_filename" = "" ]; then + src_filename="${source_id}.${src_format}" + fi + local local_src="/opt/yunohost-apps-src/${YNH_APP_ID}/${src_filename}" + + if test -e "$local_src" + then # Use the local source file if it is present + cp $local_src $src_filename + else # If not, download the source + # NB. we have to declare the var as local first, + # otherwise 'local foo=$(false) || echo 'pwet'" does'nt work + # because local always return 0 ... + local out + # Timeout option is here to enforce the timeout on dns query and tcp connect (c.f. man wget) + out=$(wget --tries 3 --no-dns-cache --timeout 900 --no-verbose --output-document=$src_filename $src_url 2>&1) \ + || ynh_die --message="$out" + fi + + # Get the control sum if a URL was provided + # Only retain the part before the first space + if [[ "${src_sum}" =~ ^http[s+]:// ]]; then + src_sum=$(curl -L -s "${src_sum}" | cut -d ' ' -f 1) + fi + + # Check the control sum + echo "${src_sum} ${src_filename}" | ${src_sumprg} --check --status \ + || ynh_die --message="Corrupt source" + + # Extract source into the app dir + mkdir --parents "$dest_dir" + + if ! "$src_extract" + then + mv $src_filename $dest_dir + elif [ "$src_format" = "zip" ] + then + # Zip format + # Using of a temp directory, because unzip doesn't manage --strip-components + if $src_in_subdir + then + local tmp_dir=$(mktemp --directory) + unzip -quo $src_filename -d "$tmp_dir" + cp --archive $tmp_dir/*/. "$dest_dir" + ynh_secure_remove --file="$tmp_dir" + else + unzip -quo $src_filename -d "$dest_dir" + fi + else + local strip="" + if [ "$src_in_subdir" != "false" ] + then + if [ "$src_in_subdir" == "true" ] + then + local sub_dirs=1 + else + local sub_dirs="$src_in_subdir" + fi + strip="--strip-components $sub_dirs" + fi + if [[ "$src_format" =~ ^tar.gz|tar.bz2|tar.xz$ ]] + then + tar --extract --file=$src_filename --directory="$dest_dir" $strip + else + ynh_die --message="Archive format unrecognized." + fi + fi + + # Apply patches + if (( $(find $YNH_CWD/../sources/patches/ -type f -name "${source_id}-*.patch" 2> /dev/null | wc --lines) > "0" )) + then + (cd "$dest_dir" + for p in $YNH_CWD/../sources/patches/${source_id}-*.patch + do + patch --strip=1 < $p + done) || ynh_die --message="Unable to apply patches" + fi + + # Add supplementary files + if test -e "$YNH_CWD/../sources/extra_files/${source_id}"; then + cp --archive $YNH_CWD/../sources/extra_files/$source_id/. "$dest_dir" + fi +} + #================================================= # EXPERIMENTAL HELPERS #================================================= diff --git a/scripts/install b/scripts/install index 01a3bac..604bb64 100644 --- a/scripts/install +++ b/scripts/install @@ -40,6 +40,11 @@ final_path=/etc/jellyfin test ! -e "$final_path" || ynh_die --message="There is already a directory: $final_path " test ! -e "/var/lib/jellyfin" || ynh_die --message="There is already a directory: /var/lib/jellyfin " +architecture=$(dpkg --print-architecture) +if [[ ! "$architecture" =~ ^(amd64|arm64|armhf)$ ]]; then + ynh_die "Jellyfin is not compatible with your architecture, $architecture, which is neither amd64, arm64, or armhf." 1 +fi + # Register (book) web path ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url @@ -69,7 +74,23 @@ ynh_app_setting_set --app=$app --key=port --value=$port #================================================= ynh_script_progression --message="Installing dependencies..." --weight=1 -ynh_install_extra_app_dependencies --repo="https://repo.jellyfin.org/$( awk -F'=' '/^ID=/{ print $NF }' /etc/os-release ) $( awk -F'=' '/^VERSION_CODENAME=/{ print $NF }' /etc/os-release ) main" --key="https://repo.jellyfin.org/jellyfin_team.gpg.key" --package="jellyfin=$pkg_version jellyfin-server=$pkg_version jellyfin-web=$pkg_version" +# Prepare the source files (replace the placeholders with version, architecture, etc. +ynh_add_config --template="../conf/ffmpeg.src.default" --destination="../conf/ffmpeg.src" +ynh_add_config --template="../conf/server.src.default" --destination="../conf/server.src" +ynh_add_config --template="../conf/web.src.default" --destination="../conf/web.src" + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download the deb files +ynh_setup_source_2 --dest_dir=$tempdir --source_id=ffmpeg +ynh_setup_source_2 --dest_dir=$tempdir --source_id=server +ynh_setup_source_2 --dest_dir=$tempdir --source_id=web + +# Install the packages +ynh_exec_warn_less apt install $tempdir/jellyfin-ffmpeg.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-server.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-web.deb #================================================= # NGINX CONFIGURATION diff --git a/scripts/remove b/scripts/remove index 2fefac4..184168a 100644 --- a/scripts/remove +++ b/scripts/remove @@ -46,6 +46,10 @@ ynh_remove_systemd_config #================================================= ynh_script_progression --message="Removing dependencies..." --weight=1 +apt remove jellyfin-web +apt remove jellyfin-server +apt remove jellyfin-ffmpeg + # Remove metapackage and its dependencies ynh_remove_app_dependencies diff --git a/scripts/restore b/scripts/restore index bcb597f..79d1605 100644 --- a/scripts/restore +++ b/scripts/restore @@ -44,6 +44,11 @@ test ! -d "$final_path" \ test ! -d "/var/lib/jellyfin" \ || ynh_die --message="There is already a directory: /var/lib/jellyfin " +architecture=$(dpkg --print-architecture) +if [[ ! "$architecture" =~ ^(amd64|arm64|armhf)$ ]]; then + ynh_die "Jellyfin is not compatible with your architecture, $architecture, which is neither amd64, arm64, or armhf." 1 +fi + #================================================= # STANDARD RESTORATION STEPS #================================================= @@ -83,17 +88,32 @@ chown -R $app: /var/lib/jellyfin #================================================= ynh_script_progression --message="Reinstalling dependencies..." --weight=7 -# Define and install dependencies -ynh_install_extra_app_dependencies --repo="https://repo.jellyfin.org/debian $( lsb_release -c -s ) main" --package="jellyfin=$pkg_version jellyfin-server=$pkg_version jellyfin-web=$pkg_version" --key="https://repo.jellyfin.org/debian/jellyfin_team.gpg.key" +# Prepare the source files (replace the placeholders with version, architecture, etc. +ynh_add_config --template="../conf/ffmpeg.src.default" --destination="../conf/ffmpeg.src" +ynh_add_config --template="../conf/server.src.default" --destination="../conf/server.src" +ynh_add_config --template="../conf/web.src.default" --destination="../conf/web.src" + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download the deb files +ynh_setup_source_2 --dest_dir=$tempdir --source_id=ffmpeg +ynh_setup_source_2 --dest_dir=$tempdir --source_id=server +ynh_setup_source_2 --dest_dir=$tempdir --source_id=web + +# Install the packages +ynh_exec_warn_less apt install $tempdir/jellyfin-ffmpeg.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-server.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-web.deb #================================================= # RESTORE SYSTEMD #================================================= ynh_script_progression --message="Restoring the systemd configuration..." --weight=2 -ynh_restore_file --origin_path="/lib/systemd/system/jellyfin.service" --not_mandatory 2>/dev/null -ynh_restore_file --origin_path="/usr/lib/systemd/system/jellyfin.service" --not_mandatory 2>/dev/null -ynh_restore_file --origin_path="/etc/systemd/system/jellyfin.service.d" 2>/dev/null +ynh_restore_file --origin_path="/lib/systemd/system/jellyfin.service" --not_mandatory +ynh_restore_file --origin_path="/usr/lib/systemd/system/jellyfin.service" --not_mandatory +ynh_restore_file --origin_path="/etc/systemd/system/jellyfin.service.d" systemctl enable $app.service --quiet #================================================= diff --git a/scripts/upgrade b/scripts/upgrade index fcf5486..6b2c2ab 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -32,6 +32,11 @@ upgrade_type=$(ynh_check_app_version_changed) #================================================= ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 +architecture=$(dpkg --print-architecture) +if [[ ! "$architecture" =~ ^(amd64|arm64|armhf)$ ]]; then + ynh_die "Jellyfin is not compatible with your architecture, $architecture, which is neither amd64, arm64, or armhf." 1 +fi + # Cleaning legacy permissions if ynh_legacy_permissions_exists; then ynh_legacy_permissions_delete_all @@ -80,7 +85,23 @@ ynh_add_nginx_config #================================================= ynh_script_progression --message="Upgrading dependencies..." --weight=3 -ynh_install_extra_app_dependencies --repo="https://repo.jellyfin.org/$( awk -F'=' '/^ID=/{ print $NF }' /etc/os-release ) $( awk -F'=' '/^VERSION_CODENAME=/{ print $NF }' /etc/os-release ) main" --key="https://repo.jellyfin.org/jellyfin_team.gpg.key" --package="jellyfin=$pkg_version jellyfin-server=$pkg_version jellyfin-web=$pkg_version" +# Prepare the source files (replace the placeholders with version, architecture, etc. +ynh_add_config --template="../conf/ffmpeg.src.default" --destination="../conf/ffmpeg.src" +ynh_add_config --template="../conf/server.src.default" --destination="../conf/server.src" +ynh_add_config --template="../conf/web.src.default" --destination="../conf/web.src" + +# Create the temporary directory +tempdir="$(mktemp -d)" + +# Download the deb files +ynh_setup_source_2 --dest_dir=$tempdir --source_id=ffmpeg +ynh_setup_source_2 --dest_dir=$tempdir --source_id=server +ynh_setup_source_2 --dest_dir=$tempdir --source_id=web + +# Install the packages +ynh_exec_warn_less apt install $tempdir/jellyfin-ffmpeg.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-server.deb +ynh_exec_warn_less apt install $tempdir/jellyfin-web.deb #================================================= # CREATE DEDICATED USER