NZBget: update package for DSM 7 (#4996)

hgy59 · web-flow · commit a1aa165e187b · 2021-12-20T14:46:46.000+01:00
diff --git a/spk/nzbget/Makefile b/spk/nzbget/Makefile
@@ -1,6 +1,6 @@
 SPK_NAME = nzbget
 SPK_VERS = $(shell date +%Y%m%d)
-SPK_REV = 27
+SPK_REV = 28
 SPK_ICON = src/nzbget.png
 
 DEPENDS = cross/p7zip cross/unrar
@@ -11,18 +11,19 @@ DESCRIPTION_FRE = NZBGet est un récupérateur de news en ligne de commande écr
 DESCRIPTION_SPN = NZBGet es una aplicación de linea de comandos escrita en C++ para descargar binarios, desde servidores de noticias, utilizando archivos nzb. Soporta modo cliente y servidor, verificación y descompresión automática y una interfaz web. NZBGet utiliza pocos recursos de sistema.
 STARTABLE = yes
 DISPLAY_NAME = NZBGet
-CHANGELOG = "1. Remove DSM5 -> DSM6 migration.<br/>2. Support for DS-x20 models."
+CHANGELOG = "Update for DSM 7 and DSM 7 compatible shared folders."
 
 HOMEPAGE = https://nzbget.net
 LICENSE  = GPLv2
 
-WIZARDS_DIR = src/wizard/
+WIZARDS_DIR = src/wizard
 
 SERVICE_USER = auto
-SERVICE_WIZARD_SHARE = wizard_download_dir
+SERVICE_WIZARD_SHARE = wizard_download_folder
+USE_DATA_SHARE_WORKER = yes
 SERVICE_SETUP = src/service-setup.sh
 SERVICE_PORT = 6789
-SERVICE_PORT_TITLE = $(DISPLAY_NAME)
+SERVICE_PORT_TITLE = NZBGet (HTTP)
 
 # Admin link for in DSM UI
 ADMIN_PORT = $(SERVICE_PORT)
diff --git a/spk/nzbget/src/service-setup.sh b/spk/nzbget/src/service-setup.sh
@@ -1,3 +1,4 @@
+
 PATH="${SYNOPKG_PKGDEST}/bin:${PATH}"
 NZBGET="${SYNOPKG_PKGDEST}/bin/nzbget"
 CFG_FILE="${SYNOPKG_PKGVAR}/nzbget.conf"
@@ -12,7 +13,7 @@ SERVICE_COMMAND="${NZBGET} -c ${CFG_FILE} -o WebDir=${WEBDIR} -o LockFile=${PID_
 
 service_postinst ()
 {
-    # Download latest NZBGet
+    # Download current NZBGet (stable or testing)
     if [ -n "${wizard_stable_release}" ] && [ "${wizard_stable_release}" = true ]; then
         echo "Download nzbget installer: latest"
         wget --quiet --output-document="${NZBGET_INSTALLER}" "https://nzbget.net/download/nzbget-latest-bin-linux.run"
@@ -22,23 +23,20 @@ service_postinst ()
         wget --quiet --output-document="${NZBGET_INSTALLER}" "https://nzbget.net/download/nzbget-latest-testing-bin-linux.run"
     fi
 
-    # Stop if download failed
+    # Abort if download failed
     if [ ! -r "${NZBGET_INSTALLER}" ]; then
         echo "Failed to download installer, please check the internet connection of your device."
         exit 1
     fi
     echo "Download completed"
 
-    if [ $SYNOPKG_DSM_VERSION_MAJOR -lt 6 ]; then
-        # On DSM5 the lib-dir is not owned by the package-user
-        set_unix_permissions "${SYNOPKG_PKGDEST}/bin"
+    chmod +x "${NZBGET_INSTALLER}"
+    ${NZBGET_INSTALLER} --destdir ${SYNOPKG_PKGDEST}/bin
 
-        # Install as nzbget user, for correct permissions
-        chmod +x "${NZBGET_INSTALLER}"
-        su ${EFF_USER} -s /bin/sh -c "${NZBGET_INSTALLER} --destdir ${SYNOPKG_PKGDEST}/bin"
-    else
-        chmod +x "${NZBGET_INSTALLER}"
-        ${NZBGET_INSTALLER} --destdir ${SYNOPKG_PKGDEST}/bin
+    if [ $SYNOPKG_DSM_VERSION_MAJOR -lt 7 ]; then
+        # On DSM 5 and 6 the nzbget archive is extracted with the internal build owner (id 1001).
+        # Overwrite with the package owner
+        set_unix_permissions "${SYNOPKG_PKGDEST}/bin"
     fi
 
     # Make sure installation worked
@@ -48,30 +46,30 @@ service_postinst ()
         exit 1
     fi
 
-    # Copy the new template config file created by installer
+    # Make a copy of the config file created by the current installer
     cp -f ${SYNOPKG_PKGDEST}/bin/nzbget.conf ${TEMPLATE_CFG_FILE}
 
     # Remove installer
     rm -f "${NZBGET_INSTALLER}"
 
-    # Create config file if not exists
+    # Create the config file on demand
     if [ ! -e "${CFG_FILE}" ]; then
-        echo "create config file"
+        echo "Create initial config file"
 
         # Use whatever the installer found best
         # It does optimizations based on the current system
         cp -f ${TEMPLATE_CFG_FILE} ${CFG_FILE}
 
         # Edit the configuration according to the wizard
-        sed -i -e "s|MainDir=.*$|MainDir=${wizard_download_dir:=/volume1/downloads}|g" \
-               -e "s/ControlUsername=.*$/ControlUsername=${wizard_control_username:=nzbget}/g" \
-               -e "s/ControlPassword=.*$/ControlPassword=${wizard_control_password:=nzbget}/g" \
-               ${CFG_FILE}
+        sed -e "s|MainDir=.*$|MainDir=${wizard_download_volume}/${wizard_download_folder}|g" \
+            -e "s/ControlUsername=.*$/ControlUsername=${wizard_control_username:=nzbget}/g" \
+            -e "s/ControlPassword=.*$/ControlPassword=${wizard_control_password:=nzbget}/g" \
+            -i ${CFG_FILE}
 
         # Update to match our paths
-        sed -i -e "s|ScriptDir=.*$|ScriptDir=${SYNOPKG_PKGDEST}/share/nzbget/scripts|g" \
-               -e "s|LogFile=.*$|LogFile=${SYNOPKG_PKGDEST}/var/nzbget.log|g" \
-               -e "s|ConfigTemplate=.*$|ConfigTemplate=${TEMPLATE_CFG_FILE}|g" \
-               ${CFG_FILE}
+        sed -e "s|ScriptDir=.*$|ScriptDir=${SYNOPKG_PKGDEST}/share/nzbget/scripts|g" \
+            -e "s|LogFile=.*$|LogFile=${SYNOPKG_PKGVAR}/nzbget.log|g" \
+            -e "s|ConfigTemplate=.*$|ConfigTemplate=${TEMPLATE_CFG_FILE}|g" \
+            -i ${CFG_FILE}
     fi
 }
diff --git a/spk/nzbget/src/wizard/install_uifile b/spk/nzbget/src/wizard/install_uifile
@@ -1,66 +1,106 @@
 [{
-    "step_title": "Basic configuration",
+    "step_title": "Shared folder configuration",
     "items": [{
+        "desc": "Shared folder of downloaded files. If the specified share does not exist, it will be created."
+      }, {
+        "type": "combobox",
+        "desc": "Please select a volume and a folder to use for the download files",
+        "subitems": [{
+            "key": "wizard_download_volume",
+            "desc": "Volume name",
+            "displayField": "display_name",
+            "valueField": "volume_path",
+            "editable": false,
+            "mode": "remote",
+            "api_store": {
+              "api": "SYNO.Core.Storage.Volume",
+              "method": "list",
+              "version": 1,
+              "baseParams": {
+                "limit": -1,
+                "offset": 0,
+                "location": "internal"
+              },
+              "root": "volumes",
+              "idProperty": "volume_path",
+              "fields": [
+                "display_name",
+                "volume_path"
+              ]
+            },
+            "validator": {
+              "fn": "{console.log(arguments);return true;}"
+            }
+          }
+        ]
+      }, {
         "type": "textfield",
-        "desc": "Download location",
+        "desc": "Specify the name of the shared folder.",
         "subitems": [{
-            "key": "wizard_download_dir",
+            "key": "wizard_download_folder",
             "desc": "Download directory",
-            "defaultValue": "/volume1/downloads",
+            "defaultValue": "downloads",
             "validator": {
-                "allowBlank": false,
-                "regex": {
-                    "expr": "/^\\\/volume\\w*[0-9]{1,2}\\\/[^<>: */?\"]*/",
-                    "errorText": "Path should begin with /volumename?/ where volumename can be 'volume' or also 'volumeUSB' and ? is the volume number (1-99)."
-                }
+              "allowBlank": false,
+              "regex": {
+                "expr": "/^[^<>: */?\"]*/",
+                "errorText": "Share name must be a folder name only. Path separators, spaces and other special chars are not allowed."
+              }
             }
-        }]
-    },
-    {
-        "desc": "If the specified share does not exist, it will be created. You can use an existing share by specifying the full path to the folder. Make sure to specify paths to existing shares correctly, for example external USB-drive paths are of the form <em>/volumeUSB1/usbshare</em>."
-    },
-    {
+          }
+        ]
+      }, {
+        "desc": "Permissions for download-related packages are managed with the group <b>'synocommunity'</b> in DSM. Please read <a target=\"_blank\" href=\"https://github.com/SynoCommunity/spksrc/wiki/Permission-Management\">Permission Management</a> for further information."
+      }
+    ]
+  }, {
+    "step_title": "User configuration",
+    "items": [{
+        "desc": "Define the User Credentials for the web interface."
+      }, {
         "type": "textfield",
-        "desc": "Control username. Defaults to nzbget",
+        "desc": "Username for web interface Control.",
         "subitems": [{
             "key": "wizard_control_username",
-            "desc": "Control username",
+            "desc": "Username. Defaults to nzbget",
             "defaultValue": "nzbget",
             "validator": {
-                "allowBlank": false
+              "allowBlank": false
             }
-        }]
-    }, {
+          }
+        ]
+      }, {
         "type": "password",
-        "desc": "Control password. Defaults to nzbget",
+        "desc": "Password for web interface Control.",
         "subitems": [{
             "key": "wizard_control_password",
-            "desc": "Control password",
+            "desc": "Password. Defaults to nzbget",
             "defaultValue": "nzbget",
             "validator": {
-                "allowBlank": false
+              "allowBlank": false
             }
-        }]
-    },
-    {
-        "desc": "Permissions for all download-related packages are managed with the group <b>'sc-download'</b> in DSM.<br>The group 'users' is no longer used as of DSM 6.<br>Package user will not appear on most UI settings.<br>Please read <a target=\"_blank\" href=\"https://github.com/SynoCommunity/spksrc/wiki/Permission-Management\">Permission Management</a> for details."
-    }]
-}, {
+          }
+        ]
+      }
+    ]
+  }, {
     "step_title": "NZBGet installation",
     "items": [{
-        "desc": "The installer will now download the desired version of NZBGet from NZBget.net and install it. <br>In the future you should update from within NZBGet (Config > System)."
-    },
-    {
+        "desc": "The installer will now download and install the specified version of NZBGet from NZBget.net.<br>In the future you should update from within NZBGet (Config > System)."
+      }, {
         "type": "singleselect",
         "desc": "Version to install:",
         "subitems": [{
             "key": "wizard_stable_release",
             "desc": "Latest stable NZBGet version",
             "defaultValue": true
-        }, {
+          }, {
             "key": "wizard_testing_release",
             "desc": "Latest testing (beta) NZBGet version",
             "defaultValue": false
-        }]
-    }]
-}]
+          }
+        ]
+      }
+    ]
+  }
+]
diff --git a/spk/nzbget/src/wizard/install_uifile_fre b/spk/nzbget/src/wizard/install_uifile_fre
@@ -1,66 +1,106 @@
 [{
-    "step_title": "Configuration du service",
+    "step_title": "Shared folder configuration",
     "items": [{
+        "desc": "Shared folder of downloaded files. If the specified share does not exist, it will be created."
+      }, {
+        "type": "combobox",
+        "desc": "Please select a volume and a folder to use for the download files",
+        "subitems": [{
+            "key": "wizard_download_volume",
+            "desc": "Volume name",
+            "displayField": "display_name",
+            "valueField": "volume_path",
+            "editable": false,
+            "mode": "remote",
+            "api_store": {
+              "api": "SYNO.Core.Storage.Volume",
+              "method": "list",
+              "version": 1,
+              "baseParams": {
+                "limit": -1,
+                "offset": 0,
+                "location": "internal"
+              },
+              "root": "volumes",
+              "idProperty": "volume_path",
+              "fields": [
+                "display_name",
+                "volume_path"
+              ]
+            },
+            "validator": {
+              "fn": "{console.log(arguments);return true;}"
+            }
+          }
+        ]
+      }, {
         "type": "textfield",
         "desc": "Configuration de téléchargement",
         "subitems": [{
-            "key": "wizard_download_dir",
+            "key": "wizard_download_folder",
             "desc": "Répertoire cible",
-            "defaultValue": "/volume1/downloads",
+            "defaultValue": "downloads",
             "validator": {
-                "allowBlank": false,
-                "regex": {
-                    "expr": "/^\\\/volume\\w*[0-9]{1,2}\\\/[^<>: */?\"]*/",
-                    "errorText": "Le chemin doit commencer par /volume?/ ou /volumeUSB?/ avec ? le numéro du volume (1-99)."
-                }
+              "allowBlank": false,
+              "regex": {
+                "expr": "/^[^<>: */?\"]*/",
+                "errorText": "Share name must be a folder name only. Path separators, spaces and other special chars are not allowed."
+              }
             }
-        }]
-    },
-    {
-        "desc": "Si le partage saisi n'existe pas, il sera créé. Vous pouvez indiquer un partage existant en précisant le chemin absolu du répertoire. Vérifiez que votre saisie soit correcte, par exemple un disque USB externe est pointé par <em>/volumeUSB1/usbshare</em>."
-    },
-    {
+          }
+        ]
+      }, {
+        "desc": "Permissions for download-related packages are managed with the group <b>'synocommunity'</b> in DSM. Please read <a target=\"_blank\" href=\"https://github.com/SynoCommunity/spksrc/wiki/Permission-Management\">Permission Management</a> for further information."
+      }
+    ]
+  }, {
+    "step_title": "User configuration",
+    "items": [{
+        "desc": "Define the User Credentials for the web interface."
+      }, {
         "type": "textfield",
         "desc": "Utilisateur d'administration. Par défaut nzbget",
         "subitems": [{
             "key": "wizard_control_username",
             "desc": "Utilisateur d'administration",
             "defaultValue": "nzbget",
             "validator": {
-                "allowBlank": false
+              "allowBlank": false
             }
-        }]
-    }, {
+          }
+        ]
+      }, {
         "type": "password",
         "desc": "Mot de passe d'administration. Par défaut nzbget",
         "subitems": [{
             "key": "wizard_control_password",
             "desc": "Mot de passe d'administration",
             "defaultValue": "nzbget",
             "validator": {
-                "allowBlank": false
+              "allowBlank": false
             }
-        }]
-    },
-    {
-        "desc": "Les permissions de toutes les applications de téléchargement sont gérées par le groupe <b>'sc-download'</b> dans DSM.<br>Le groupe 'users' n'est plus utilisé depuis DSM 6.<br>L'utilisateur spécifique à l'application n'apparaît plus dans la plupart des interfaces de configuration.<br>Merci de lire <a target=\"_blank\" href=\"https://github.com/SynoCommunity/spksrc/wiki/Permission-Management\">Permission Management</a> pour plus de détails."
-    }]
-}, {
+          }
+        ]
+      }
+    ]
+  }, {
     "step_title": "Installation de NZBGet",
     "items": [{
         "desc": "L'installateur va maintenant télécharger la version voulue de NZBGet depuis NZBget.net et l'installer. Vous pouvez ensuite mettre à jour depuis NZBGet (Config > System)."
-    },
-    {
+      }, {
         "type": "singleselect",
         "desc": "Version à installer:",
         "subitems": [{
             "key": "wizard_stable_release",
             "desc": "Dernière version stable de NZBGet",
             "defaultValue": true
-        }, {
+          }, {
             "key": "wizard_testing_release",
             "desc": "Dernière version de test (beta) de NZBGet",
             "defaultValue": false
-        }]
-    }]
-}]
+          }
+        ]
+      }
+    ]
+  }
+]
diff --git a/spk/nzbget/src/wizard/upgrade_uifile b/spk/nzbget/src/wizard/upgrade_uifile
diff --git a/spk/nzbget/src/wizard/upgrade_uifile_fre b/spk/nzbget/src/wizard/upgrade_uifile_fre
