Merge pull request #1 from YunoHost-Apps/upgrade

Upgrade

LICENSE

@@ -1,4 +1,14 @@
-File containing the license of your package.
 
-More information here:
+
-https://yunohost.org/packaging_apps_guidelines#yep-1-3
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+Version 2, December 2004
+
+Copyright (C) 2004 Sam Hocevar <sam@hocevar.net>
+
+Everyone is permitted to copy and distribute verbatim or modified copies of this license document, and changing it is allowed as long as the name is changed.
+
+DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
+TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+    0. You just DO WHAT THE FUCK YOU WANT TO.
+

README.md

@@ -23,7 +23,7 @@ Package to create a Time Machine Backup Source
 - Integrated with YunoHost's Backups
 - Supports multiple installs
 
-**Shipped version:** 1.0~ynh3
+**Shipped version:** 1.0~ynh4
 
 ## Screenshots
 

README_fr.md

@@ -23,7 +23,7 @@ Package to create a Time Machine Backup Source
 - Integrated with YunoHost's Backups
 - Supports multiple installs
 
-**Version incluse :** 1.0~ynh3
+**Version incluse :** 1.0~ynh4
 
 ## Captures d'écran
 

check_process

@@ -1,21 +1,18 @@
-# See here for more information
-# https://github.com/YunoHost/package_check#syntax-check_process-file
-
-# Move this file from check_process.default to check_process when you have filled it.
-
 ;; Test complet
 	; Manifest
 		admin="john"
 		password="1Strong-Password"
+		port="445"
 	; Checks
 		pkg_linter=1
-		setup_sub_dir=1
+		setup_sub_dir=0
-		setup_root=1
+		setup_root=0
-		setup_nourl=0
+		setup_nourl=1
-		setup_private=1
+		setup_private=0
-		setup_public=1
+		setup_public=0
 		upgrade=1
-		upgrade=1	from_commit=CommitHash
+		# 1.0~ynh4
+		upgrade=1	from_commit=82615dff18a961b126acea94a5b74bfaecc29f93
 		backup_restore=1
 		multi_instance=1
 		port_already_use=0
@@ -23,7 +20,3 @@
 ;;; Options
 Email=
 Notification=none
-;;; Upgrade options
-	; commit=CommitHash
-		name=Name and date of the commit.
-		manifest_arg=domain=DOMAIN&path=PATH&is_public=1&language=fr&admin=USER&password=pass&port=666&

manifest.json

@@ -6,14 +6,14 @@
         "en": "App to setup the server as a Time Machine backup target",
         "fr": "Expliquez en *quelques* (10~15) mots l'utilité de l'app ou ce qu'elle fait (l'objectif est de donner une idée grossière pour des utilisateurs qui naviguent dans un catalogue de 100+ apps)"
     },
-    "version": "1.0~ynh3",
+    "version": "1.0~ynh4",
     "url": "https://support.apple.com/en-us/HT201250",
     "upstream": {
-        "license": "free",
+        "license": "WTFPL",
         "website": "https://support.apple.com/en-us/HT201250",
         "code": "https://github.com/YunoHost-Apps/timemachine_ynh"
     },
-    "license": "free",
+    "license": "WTFPL",
     "maintainer": {
         "name": "Navan Chauhan",
         "email": "timemachine@navan.email"
@@ -28,18 +28,13 @@
         "install": [
             {
                 "name": "admin",
-                "type": "string",
+                "type": "user"
-                "help": {
-                    "en": "User to whom the usage details will be sent",
-                    "fr": ""
-                }
             },
             {
                 "name": "password",
                 "type": "password",
                 "help": {
-                    "en": "Password to access the Time Machine",
+                    "en": "Password to access the Time Machine"
-                    "fr": "Utilisez le champ aide pour ajouter une information à l'intention de l'administrateur à propos de cette question."
                 }
             }
         ]

scripts/_common.sh

@@ -5,7 +5,7 @@
 #=================================================
 
 # dependencies used by the app
-pkg_dependencies="samba avahi-daemon"
+pkg_dependencies="samba samba-common-bin avahi-daemon"
 
 #=================================================
 # PERSONAL HELPERS

scripts/backup

@@ -15,7 +15,6 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
 	true
 }
 # Exit if an error occurs during the execution of the script
@@ -27,6 +26,7 @@ ynh_abort_if_errors
 ynh_print_info --message="Loading installation settings..."
 
 app=$YNH_APP_INSTANCE_NAME
+
 datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 
 #=================================================

scripts/install

@@ -15,8 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	### Remove this function if there's nothing to clean before calling the remove script.
+	ynh_clean_check_starting
-	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@@ -28,14 +27,14 @@ ynh_abort_if_errors
 admin=$YNH_APP_ARG_ADMIN
 password=$YNH_APP_ARG_PASSWORD
 
-admin_mail=$(ynh_user_get_info --username=$admin --key=mail)
-
 app=$YNH_APP_INSTANCE_NAME
 
+admin_mail=$(ynh_user_get_info --username=$admin --key=mail)
+
 #=================================================
 # STORE SETTINGS FROM MANIFEST
 #=================================================
-ynh_script_progression --message="Storing installation settings..." --time --weight=1
+ynh_script_progression --message="Storing installation settings..." --weight=1
 
 ynh_app_setting_set --app=$app --key=admin --value=$admin
 ynh_app_setting_set --app=$app --key=password --value=$password
@@ -46,45 +45,36 @@ ynh_app_setting_set --app=$app --key=password --value=$password
 # OPEN PORT 445
 #=================================================
 
-ynh_script_progression --message="Configuring firewall..." --time --weight=1
+ynh_script_progression --message="Configuring firewall..." --weight=1
 ynh_exec_warn_less yunohost firewall allow --no-upnp TCP 445 # Allow SMB access
 
 #=================================================
 # INSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Installing dependencies..." --time --weight=1
+ynh_script_progression --message="Installing dependencies..." --weight=1
 
 ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Configuring system user..." --time --weight=1
+ynh_script_progression --message="Configuring system user..." --weight=1
 
 # Create a system user
 ynh_system_user_create --username=$app
 
-# Createa samba user
-(echo "$password"; echo "$password") | ynh_exec_warn_less smbpasswd -s -a "$app"
-
 #=================================================
 # SPECIFIC SETUP
 #=================================================
 # CREATE DATA DIRECTORY
 #=================================================
-ynh_script_progression --message="Creating a data directory..." --time --weight=1
+ynh_script_progression --message="Creating a data directory..." --weight=1
 
 datadir=/home/yunohost.app/$app
 ynh_app_setting_set --app=$app --key=datadir --value=$datadir
 
 mkdir -p $datadir
 
-# FIXME: this should be managed by the core in the future
-# Here, as a packager, you may have to tweak the ownerhsip/permissions
-# such that the appropriate users (e.g. maybe www-data) can access
-# files in some cases.
-# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
-# this will be treated as a security issue.
 chmod 750 "$datadir"
 chmod -R o-rwx "$datadir"
 chown -R $app: "$datadir"
@@ -92,27 +82,36 @@ chown -R $app: "$datadir"
 #=================================================
 # ADD A CONFIGURATION
 #=================================================
-ynh_script_progression --message="Adding a configuration file..." --time --weight=1
+ynh_script_progression --message="Adding a configuration file..." --weight=1
 
 samba_sysadmin_setup
 ynh_add_config --template="../conf/smb.conf" --destination="/etc/smb/smb.d/$app.conf"
 ynh_add_config --template="../conf/avahi-samba.service" --destination="/etc/avahi/services/$app.service"
 
+# Create a samba user
+(echo "$password"; echo "$password") | ynh_exec_warn_less smbpasswd -s -a "$app"
+
 # Update samba configuration
 samba_sysadmin_update
 
 # Check and Add
 samba_sysadmin_add
 
+#=================================================
+# INTEGRATE SERVICE IN YUNOHOST
+#=================================================
+ynh_script_progression --message="Integrating service in YunoHost..."
+
+yunohost service add smbd --needs_exposed_ports 445
+
 #=================================================
 # START SYSTEMD SERVICE
 #=================================================
-ynh_script_progression --message="Starting a systemd service..." --time --weight=1
+ynh_script_progression --message="Starting a systemd service..." --weight=1
 
 ynh_exec_warn_less testparm -s
 
 ynh_systemd_action --service_name=smbd --action="reload"
-
 ynh_systemd_action --service_name=avahi-daemon --action="restart"
 
 #=================================================
@@ -126,4 +125,4 @@ ynh_send_readme_to_admin --app_message="../conf/msg_install" --recipients="$admi
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Installation of $app completed" --time --last
+ynh_script_progression --message="Installation of $app completed" --last

scripts/remove

@@ -12,16 +12,36 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --time --weight=1
+ynh_script_progression --message="Loading installation settings..." --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
 
 datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 
+#=================================================
+# STANDARD REMOVE
+#=================================================
+# REMOVE SERVICE INTEGRATION IN YUNOHOST
+#=================================================
+
+# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
+if ynh_exec_warn_less yunohost service status smbd >/dev/null
+then
+	ynh_script_progression --message="Removing smbd service integration..."
+	yunohost service remove smbd
+fi
+
+# Remove the service from the list of services known by YunoHost (added from `yunohost service add`)
+if ynh_exec_warn_less yunohost service status avahi-daemon >/dev/null
+then
+	ynh_script_progression --message="Removing avahi-daemon service integration..."
+	yunohost service remove avahi-daemon
+fi
+
 #=================================================
 # REMOVE APP MAIN DIR
 #=================================================
-ynh_script_progression --message="Removing app main directory..." --time --weight=1
+ynh_script_progression --message="Removing app main directory..." --weight=1
 
 #=================================================
 # REMOVE DATA DIR
@@ -30,7 +50,7 @@ ynh_script_progression --message="Removing app main directory..." --time --weigh
 # Remove the data directory if --purge option is used
 if [ "${YNH_APP_PURGE:-0}" -eq 1 ]
 then
-	ynh_script_progression --message="Removing app data directory..." --time --weight=1
+	ynh_script_progression --message="Removing app data directory..." --weight=1
 	ynh_secure_remove --file="$datadir"
 fi
 
@@ -38,7 +58,7 @@ fi
 #=================================================
 # REMOVE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Removing dependencies..." --time --weight=1
+ynh_script_progression --message="Removing dependencies..." --weight=1
 
 # Delete User from Samba
 ynh_exec_warn_less smbpasswd -x $app
@@ -46,12 +66,22 @@ ynh_exec_warn_less smbpasswd -x $app
 # Remove metapackage and its dependencies
 ynh_remove_app_dependencies
 
+#=================================================
+# CLOSE A PORT
+#=================================================
+
+if yunohost firewall list | grep -q "\- 445$"
+then
+	ynh_script_progression --message="Closing port 445..."
+	ynh_exec_warn_less yunohost firewall disallow TCP 445
+fi
+
 #=================================================
 # SPECIFIC REMOVE
 #=================================================
 # REMOVE VARIOUS FILES
 #=================================================
-ynh_script_progression --message="Removing various files..." --time --weight=1
+ynh_script_progression --message="Removing various files..." --weight=1
 
 # Remove the log files
 ynh_secure_remove --file="/etc/smb/smb.d/$app.conf"
@@ -64,14 +94,13 @@ samba_sysadmin_update
 #=================================================
 # REMOVE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Removing the dedicated system user..." --time --weight=1
+ynh_script_progression --message="Removing the dedicated system user..." --weight=1
 
 # Delete a system user
 ynh_system_user_delete --username=$app
 
-
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Removal of $app completed" --time --last
+ynh_script_progression --message="Removal of $app completed" --last

scripts/restore

@@ -15,8 +15,7 @@ source /usr/share/yunohost/helpers
 #=================================================
 
 ynh_clean_setup () {
-	#### Remove this function if there's nothing to clean before calling the remove script.
+	ynh_clean_check_starting
-	true
 }
 # Exit if an error occurs during the execution of the script
 ynh_abort_if_errors
@@ -24,7 +23,7 @@ ynh_abort_if_errors
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --time --weight=1
+ynh_script_progression --message="Loading installation settings..." --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
 
@@ -36,39 +35,30 @@ password=$(ynh_app_setting_get --app=$app --key=password)
 #=================================================
 # RECREATE THE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Recreating the dedicated system user..." --time --weight=1
+ynh_script_progression --message="Recreating the dedicated system user..." --weight=1
 
 # Create the dedicated user (if not existing)
 ynh_system_user_create --username=$app
 
-# Create the samba user
-(echo "$password"; echo "$password") | ynh_exec_warn_less smbpasswd -s -a "$app"
-
 #=================================================
 # RESTORE THE DATA DIRECTORY
 #=================================================
-ynh_script_progression --message="Restoring the data directory..." --time --weight=1
+ynh_script_progression --message="Restoring the data directory..." --weight=1
 
 ynh_restore_file --origin_path="$datadir" --not_mandatory
 
 mkdir -p $datadir
 
-# FIXME: this should be managed by the core in the future
-# Here, as a packager, you may have to tweak the ownerhsip/permissions
-# such that the appropriate users (e.g. maybe www-data) can access
-# files in some cases.
-# But FOR THE LOVE OF GOD, do not allow r/x for "others" on the entire folder -
-# this will be treated as a security issue.
 chmod 750 "$datadir"
 chmod -R o-rwx "$datadir"
-chown -R $app:www-data "$datadir"
+chown -R $app: "$datadir"
 
 #=================================================
 # SPECIFIC RESTORATION
 #=================================================
 # REINSTALL DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Reinstalling dependencies..." --time --weight=1
+ynh_script_progression --message="Reinstalling dependencies..." --weight=1
 
 # Define and install dependencies
 ynh_install_app_dependencies $pkg_dependencies
@@ -76,7 +66,10 @@ ynh_install_app_dependencies $pkg_dependencies
 #=================================================
 # RESTORE VARIOUS FILES
 #=================================================
-ynh_script_progression --message="Restoring various files..." --time --weight=1
+ynh_script_progression --message="Restoring various files..." --weight=1
+
+# Create the samba user
+(echo "$password"; echo "$password") | ynh_exec_warn_less smbpasswd -s -a "$app"
 
 samba_sysadmin_setup
 
@@ -88,13 +81,22 @@ samba_sysadmin_update
 samba_sysadmin_add
 
 #=================================================
-# GENERIC FINALIZATION
+# INTEGRATE SERVICE IN YUNOHOST
 #=================================================
-ynh_systemd_action --service_name=smbd --action="reload"
+ynh_script_progression --message="Integrating service in YunoHost..."
 
+yunohost service add smbd --needs_exposed_ports 445
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..."
+
+ynh_systemd_action --service_name=smbd --action="reload"
 ynh_systemd_action --service_name=avahi-daemon --action="restart"
+
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Restoration completed for $app" --time --last
+ynh_script_progression --message="Restoration completed for $app" --last

scripts/upgrade

@@ -12,32 +12,29 @@ source /usr/share/yunohost/helpers
 #=================================================
 # LOAD SETTINGS
 #=================================================
-ynh_script_progression --message="Loading installation settings..." --time --weight=1
+ynh_script_progression --message="Loading installation settings..." --weight=1
 
 app=$YNH_APP_INSTANCE_NAME
 
 admin=$(ynh_app_setting_get --app=$app --key=admin)
+datadir=$(ynh_app_setting_get --app=$app --key=datadir)
 
 #=================================================
 # CHECK VERSION
 #=================================================
+ynh_script_progression --message="Checking version..."
 
-### This helper will compare the version of the currently installed app and the version of the upstream package.
-### $upgrade_type can have 2 different values
-### - UPGRADE_APP if the upstream app version has changed
-### - UPGRADE_PACKAGE if only the YunoHost package has changed
-### ynh_check_app_version_changed will stop the upgrade if the app is up to date.
-### UPGRADE_APP should be used to upgrade the core app only if there's an upgrade to do.
 upgrade_type=$(ynh_check_app_version_changed)
 
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
-ynh_script_progression --message="Backing up the app before upgrading (may take a while)..." --time --weight=1
+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 () {
+	ynh_clean_check_starting
 	# Restore it if the upgrade fails
 	ynh_restore_upgradebackup
 }
@@ -51,28 +48,7 @@ ynh_abort_if_errors
 #=================================================
 # ENSURE DOWNWARD COMPATIBILITY
 #=================================================
-ynh_script_progression --message="Ensuring downward compatibility..." --time --weight=1
+ynh_script_progression --message="Ensuring downward compatibility..." --weight=1
-
-#
-# N.B. : the followings setting migrations snippets are provided as *EXAMPLES*
-# of what you may want to do in some cases (e.g. a setting was not defined on
-# some legacy installs and you therefore want to initiaze stuff during upgrade)
-#
-
-# If db_name doesn't exist, create it
-#if [ -z "$db_name" ]; then
-#	db_name=$(ynh_sanitize_dbid --db_name=$app)
-#	ynh_app_setting_set --app=$app --key=db_name --value=$db_name
-#fi
-
-# 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
-#fi
-
-### If nobody installed your app before 4.1,
-### then you may safely remove these lines
 
 # Cleaning legacy permissions
 if ynh_legacy_permissions_exists; then
@@ -85,45 +61,24 @@ fi
 #=================================================
 # CREATE DEDICATED USER
 #=================================================
-ynh_script_progression --message="Making sure dedicated system user exists..." --time --weight=1
+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
 
-#=================================================
-# DOWNLOAD, CHECK AND UNPACK SOURCE
-#=================================================
-
-if [ "$upgrade_type" == "UPGRADE_APP" ]
-then
-	ynh_script_progression --message="Upgrading source files..." --time --weight=1
-
-	# Download, check integrity, uncompress and patch the source from app.src
-	# ynh_setup_source --dest_dir="$final_path"
-fi
-
 #=================================================
 # UPGRADE DEPENDENCIES
 #=================================================
-ynh_script_progression --message="Upgrading dependencies..." --time --weight=1
+ynh_script_progression --message="Upgrading dependencies..." --weight=1
 
 ynh_install_app_dependencies $pkg_dependencies
 
 #=================================================
 # SPECIFIC UPGRADE
-#=================================================
-# ...
-#=================================================
-
 #=================================================
 # UPDATE A CONFIG FILE
 #=================================================
-ynh_script_progression --message="Updating a configuration file..." --time --weight=1
+ynh_script_progression --message="Updating a configuration file..." --weight=1
-
-### Same as during install
-###
-### The file will automatically be backed-up if it's found to be manually modified (because
-### ynh_add_config keeps track of the file's checksum)
 
 ynh_add_config --template="../conf/smb.conf" --destination="/etc/smb/smb.d/$app.conf"
 ynh_add_config --template="../conf/avahi-samba.service" --destination="/etc/avahi/services/$app.service"
@@ -131,15 +86,25 @@ ynh_add_config --template="../conf/avahi-samba.service" --destination="/etc/avah
 samba_sysadmin_update
 samba_sysadmin_add
 
-### For more complex cases where you want to replace stuff using regexes,
+#=================================================
-### you shoud rely on ynh_replace_string (which is basically a wrapper for sed)
+# GENERIC FINALIZATION
-### When doing so, you also need to manually call ynh_store_file_checksum
+#=================================================
-###
+# INTEGRATE SERVICE IN YUNOHOST
-### ynh_replace_string --match_string="match_string" --replace_string="replace_string" --target_file="$final_path/some_config_file"
+#=================================================
-### ynh_store_file_checksum --file="$final_path/some_config_file"
+ynh_script_progression --message="Integrating service in YunoHost..."
+
+yunohost service add smbd --needs_exposed_ports 445
+
+#=================================================
+# START SYSTEMD SERVICE
+#=================================================
+ynh_script_progression --message="Starting a systemd service..."
+
+ynh_systemd_action --service_name=smbd --action="reload"
+ynh_systemd_action --service_name=avahi-daemon --action="restart"
 
 #=================================================
 # END OF SCRIPT
 #=================================================
 
-ynh_script_progression --message="Upgrade of $app completed" --time --last
+ynh_script_progression --message="Upgrade of $app completed" --last

sources/extra_files/app/.gitignore

@@ -1,2 +0,0 @@
-*~
-*.sw[op]

sources/patches/.gitignore

@@ -1,2 +0,0 @@
-*~
-*.sw[op]