Merge pull request #17 from YunoHost-Apps/is_public_was_a_lie

`is_public` was a lie

check_process

@@ -7,35 +7,21 @@
 	; Manifest
 		domain="domain.tld"	(DOMAIN)
 		path="/path"	(PATH)
-		is_public=1	(PUBLIC|public=1|private=0)
+		redirect_type="public_302"
-		redirect_type="visible_302"
 		redirect_path="http://127.0.0.1"
 	; Checks
 		pkg_linter=1
 		setup_sub_dir=1
 		setup_root=1
 		setup_nourl=0
-		setup_private=1
+		setup_private=0
 		setup_public=1
 		upgrade=1
 		backup_restore=1
 		multi_instance=1
-		incorrect_path=1
+		incorrect_path=0
 		port_already_use=0
 		change_url=0
-;;; Levels
-	Level 1=auto
-	Level 2=auto
-	Level 3=auto
-# Level 4:
-	Level 4=0
-# Level 5:
-	Level 5=auto
-	Level 6=auto
-	Level 7=auto
-	Level 8=0
-	Level 9=0
-	Level 10=0
 ;;; Options
 Email=
 Notification=none

manifest.json

@@ -9,7 +9,7 @@
         "en": "Create a redirection or a proxy to another path.",
         "fr": "Créer une redirection ou un proxy vers un autre emplacement"
     },
-    "version": "1.0.0~ynh3",
+    "version": "1.0.0~ynh4",
     "license": "AGPL-3.0-or-later",
     "url": "https://github.com/YunoHost-Apps/redirect_ynh",
     "maintainer": {
@@ -51,19 +51,6 @@
                 "example": "http://127.0.0.1:8080/app/",
                 "default": "http://127.0.0.1"
             },
-            {
-                "name": "is_public",
-                "type": "boolean",
-                "ask": {
-                    "en": "Is it a public redirect?",
-                    "fr": "Est-ce une redirection publique ?"
-                },
-                "help": {
-                    "en": "A private redirection will only be effective for logged-in users.",
-                    "fr": "Une redirection privée ne fonctionnera que pour les utilisateurs identifiés."
-                },
-                "default": false
-            },
             {
                 "name": "redirect_type",
                 "ask": {
@@ -71,11 +58,12 @@
                     "fr": "Type de redirection"
                 },
                 "choices": {
-                  "visible_302" : "Visible (302, temporary redirect)",
+                  "public_302" : "Visible redirect (302, temporary). Everybody will be able to access it.",
-                  "visible_301" : "Visible (301, permanent redirect)",
+                  "public_301" : "Visible redirect (301, permanent). Everybody will be able to access it.",
-                  "proxy": "Proxy, invisible (Nginx proxy_pass)"
+                  "public_proxy": "Proxy, invisible (nginx proxy_pass). Everybody will be able to access it.",
+                  "private_proxy": "Proxy, invisible (nginx proxy_pass). Only accessible for allowed users."
                 },
-                "default": "visible_302"
+                "default": "public_302"
             }
         ]
     }

scripts/backup

@@ -6,12 +6,6 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# if [ ! -e _common.sh ]; then
-	# Get the _common.sh file if it's not in the current directory
-# 	cp ../settings/scripts/_common.sh ./_common.sh
-# 	chmod a+rx _common.sh
-# fi
-# source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -25,21 +19,9 @@ ynh_abort_if_errors
 # LOAD SETTINGS
 #=================================================
 
-# This is a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
-app=$YNH_APP_INSTANCE_NAME
-
 # Retrieve arguments
+app=$YNH_APP_INSTANCE_NAME
 domain=$(ynh_app_setting_get $app domain)
 
 # Copy the conf files
-mkdir -p ./conf
+ynh_backup "/etc/nginx/conf.d/${domain}.d/${app}.conf"
-cp -a "/etc/nginx/conf.d/${domain}.d/${app}.conf" ./conf/nginx.conf

scripts/install

@@ -6,7 +6,6 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -20,22 +19,10 @@ ynh_abort_if_errors
 # RETRIEVE ARGUMENTS FROM THE MANIFEST
 #=================================================
 
-# This is a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
-app=$YNH_APP_INSTANCE_NAME
-
 # Retrieve arguments
+app=$YNH_APP_INSTANCE_NAME
 domain=$YNH_APP_ARG_DOMAIN
 path_url=$YNH_APP_ARG_PATH
-is_public=$YNH_APP_ARG_IS_PUBLIC
 redirect_type=$YNH_APP_ARG_REDIRECT_TYPE
 redirect_path=$YNH_APP_ARG_REDIRECT_PATH
 
@@ -47,44 +34,42 @@ url_regex='(https?|ftp|file)://[-A-Za-z0-9\+&@#/%?=~_|!:,.;]*[-A-Za-z0-9\+&@#/%=
 [[ ! $redirect_path =~ $url_regex ]] && ynh_die "Invalid destination: $redirect_path" 1
 
 # Save extra settings
-ynh_app_setting_set $app is_public "$is_public"
 ynh_app_setting_set $app redirect_type "$redirect_type"
 ynh_app_setting_set $app redirect_path "$redirect_path"
 
+#=================================================
+# CONFIGURE NGINX
+#=================================================
+
 # Nginx configuration
 for FILE in $(ls ../conf/nginx-*.conf)
 do
     ynh_replace_string "YNH_LOCATION" "$path_url" $FILE
 done
-if [ "$redirect_type" = "visible_302" ];
+if [ "$redirect_type" = "public_302" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-visible-302.conf
     cp ../conf/nginx-visible-302.conf /etc/nginx/conf.d/$domain.d/$app.conf
-elif [ "$redirect_type" = "visible_301" ];
+elif [ "$redirect_type" = "public_301" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-visible-301.conf
     cp ../conf/nginx-visible-301.conf /etc/nginx/conf.d/$domain.d/$app.conf
-elif [ "$redirect_type" = "proxy" ];
+elif [ "$redirect_type" = "public_proxy" ] || [ "$redirect_type" = "private_proxy" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-proxy.conf
     cp ../conf/nginx-proxy.conf /etc/nginx/conf.d/$domain.d/$app.conf
 fi
 
 #=================================================
-# SETUP SSOWAT
+# CONFIGURE SSOWAT
 #=================================================
 
-if [ $is_public -eq 0 ]
-then	# Remove the public access
-	ynh_app_setting_delete "$app" skipped_uris
-fi
 # Make app public if necessary
-if [ $is_public -eq 1 ]
+if [ "$redirect_type" != "private_proxy" ]
 then
 	# unprotected_uris allows SSO credentials to be passed anyway.
 	ynh_app_setting_set "$app" unprotected_uris "/"
 fi
 
-
 # Reload Nginx and regenerate SSOwat conf
-service nginx reload
+systemctl reload nginx

scripts/remove

@@ -6,30 +6,18 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
 
-# This is a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
-app=$YNH_APP_INSTANCE_NAME
-
 # Retrieve arguments
+app=$YNH_APP_INSTANCE_NAME
 domain=$(ynh_app_setting_get $app domain)
 
 # Remove configuration files
 ynh_secure_remove /etc/nginx/conf.d/$domain.d/$app.conf
 
 # Restart services
-service nginx reload
+systemctl reload nginx

scripts/restore

@@ -6,12 +6,6 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# if [ ! -e _common.sh ]; then
-	# Get the _common.sh file if it's not in the current directory
-# 	cp ../settings/scripts/_common.sh ./_common.sh
-# 	chmod a+rx _common.sh
-# fi
-# source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
@@ -25,22 +19,10 @@ ynh_abort_if_errors
 # LOAD SETTINGS
 #=================================================
 
-# This is a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
-app=$YNH_APP_INSTANCE_NAME
-
 # Retrieve arguments
+app=$YNH_APP_INSTANCE_NAME
 domain=$(ynh_app_setting_get "$app" domain)
 path_url=$(ynh_app_setting_get "$app" path)
-is_public=$(ynh_app_setting_get "$app" is_public)
 redirect_type=$(ynh_app_setting_get "$app" redirect_type)
 redirect_path=$(ynh_app_setting_get "$app" redirect_path)
 
@@ -53,22 +35,18 @@ NGINX_CONF="/etc/nginx/conf.d/${domain}.d/${app}.conf"
 [[ -f $NGINX_CONF ]] && ynh_die "The NGINX configuration already exists at '${NGINX_CONF}'. You should safely delete it before restoring this app."
 
 # Restore configuration files
-cp -a ./conf/nginx.conf "$NGINX_CONF"
+ynh_restore_file "$NGINX_CONF"
 
 #=================================================
-# SETUP SSOWAT
+# CONFIGURE SSOWAT
 #=================================================
 
-if [ "$is_public" -eq 0 ]
-then	# Remove the public access
-	ynh_app_setting_delete "$app" skipped_uris
-fi
 # Make app public if necessary
-if [ "$is_public" -eq 1 ]
+if [ "$redirect_type" != "private_proxy" ]
 then
 	# unprotected_uris allows SSO credentials to be passed anyway.
 	ynh_app_setting_set "$app" unprotected_uris "/"
 fi
 
 # Reload Nginx and regenerate SSOwat conf
-service nginx reload
+systemctl reload nginx

scripts/upgrade

@@ -7,32 +7,16 @@
 # IMPORT GENERIC HELPERS
 #=================================================
 
-# source _common.sh
 source /usr/share/yunohost/helpers
 
 #=================================================
 # LOAD SETTINGS
 #=================================================
 
-# This is a multi-instance app, meaning it can be installed several times independently
-# The id of the app as stated in the manifest is available as $YNH_APP_ID
-# The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...)
-# The app instance name is available as $YNH_APP_INSTANCE_NAME
-#    - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample
-#    - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2
-#    - ynhexample__{N} for the subsequent installations, with N=3,4, ...
-# The app instance name is probably what you are interested the most, since this is
-# guaranteed to be unique. This is a good unique identifier to define installation path,
-# db names, ...
-app=$YNH_APP_INSTANCE_NAME
-
-# Source app helpers
-. /usr/share/yunohost/helpers
-
 # Retrieve arguments
+app=$YNH_APP_INSTANCE_NAME
 domain=$(ynh_app_setting_get "$app" domain)
 path_url=$(ynh_app_setting_get "$app" path)
-is_public=$(ynh_app_setting_get "$app" is_public)
 redirect_type=$(ynh_app_setting_get "$app" redirect_type)
 redirect_path=$(ynh_app_setting_get "$app" redirect_path)
 
@@ -41,14 +25,6 @@ redirect_path=$(ynh_app_setting_get "$app" redirect_path)
 #=================================================
 
 # Fix is_public as a boolean value
-if [ "$is_public" = "Yes" ]; then
-	ynh_app_setting_set $app is_public 1
-	is_public=1
-elif [ "$is_public" = "No" ]; then
-	ynh_app_setting_set $app is_public 0
-	is_public=0
-fi
-
 # Default value for redirect_type if upgrading from https://github.com/scith/redirect_ynh
 if [ -z "$redirect_type" ];
 then
@@ -56,6 +32,40 @@ then
     ynh_app_setting_set $app 'redirect_type' $redirect_type
 fi
 
+# Migrate away from old stuff with 'is_public' and old redirect type names
+is_public=$(ynh_app_setting_get "$app" is_public)
+if [ -n "$is_public" ]
+then
+    if [ "$is_public" = "Yes" ]; then
+        is_public=1
+    elif [ "$is_public" = "No" ]; then
+        is_public=0
+    fi
+
+    if [ "$is_public" = "0" ] && [ "$redirect_type" != "proxy" ]; then
+       echo "WARNING: You previously had a 'supposedly' private 301 or 302 redirection ... but it was found that it was public all along and it is not easy to create such a private redirection. Your 301 or 302 redirection will be re-flagged as public..." >&2
+       is_public=1
+    fi
+
+    if [ "$redirect_type" == "proxy" ] && [ "$is_public" = "1" ]
+    then
+        redirect_type="public_proxy"
+    elif [ "$redirect_type" == "proxy" ] && [ "$is_public" = "0" ]
+    then
+        redirect_type="private_proxy"
+    elif [ "$redirect_type" == "visible_302" ]
+    then
+        redirect_type="public_302"
+    elif [ "$redirect_type" == "visible_301" ]
+    then
+        redirect_type="public_301"
+    fi
+    
+    ynh_app_setting_set $app 'redirect_type' $redirect_type
+    ynh_app_setting_set $app 'is_public'
+fi
+
+
 #=================================================
 # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP
 #=================================================
@@ -73,39 +83,39 @@ ynh_abort_if_errors
 url_regex='(https?|ftp|file)://[-A-Za-z0-9\+&@#/%?=~_|!:,.;]*[-A-Za-z0-9\+&@#/%=~_|]'
 [[ ! $redirect_path =~ $url_regex ]] && ynh_die "Invalid destination: $redirect_path" 1
 
+#=================================================
+# CONFIGURE NGINX
+#=================================================
+
 # Nginx configuration
 for FILE in $(ls ../conf/nginx-*.conf)
 do
     ynh_replace_string "YNH_LOCATION" "$path_url" $FILE
 done
-if [ "$redirect_type" = "visible_302" ];
+if [ "$redirect_type" = "public_302" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-visible-302.conf
     cp ../conf/nginx-visible-302.conf /etc/nginx/conf.d/$domain.d/$app.conf
-elif [ "$redirect_type" = "visible_301" ];
+elif [ "$redirect_type" = "public_301" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-visible-301.conf
     cp ../conf/nginx-visible-301.conf /etc/nginx/conf.d/$domain.d/$app.conf
-elif [ "$redirect_type" = "proxy" ];
+elif [ "$redirect_type" = "public_proxy" ] || [ "$redirect_type" = "private_proxy" ];
 then
     ynh_replace_string "YNH_REDIRECT_PATH" "$redirect_path" ../conf/nginx-proxy.conf
     cp ../conf/nginx-proxy.conf /etc/nginx/conf.d/$domain.d/$app.conf
 fi
 
 #=================================================
-# SETUP SSOWAT
+# CONFIGURE SSOWAT
 #=================================================
 
-if [ "$is_public" -eq 0 ]
-then	# Remove the public access
-	ynh_app_setting_delete "$app" skipped_uris
-fi
 # Make app public if necessary
-if [ "$is_public" -eq 1 ]
+if [ "$redirect_type" != "private_proxy" ]
 then
 	# unprotected_uris allows SSO credentials to be passed anyway.
-	ynh_app_setting_set "$app" unprotected_uris -v "/"
+	ynh_app_setting_set "$app" unprotected_uris "/"
 fi
 
 # Reload Nginx and regenerate SSOwat conf
-service nginx reload
+systemctl reload nginx