Use getopts for sql's helpers

data/helpers.d/mysql

@@ -5,32 +5,57 @@ MYSQL_ROOT_PWD_FILE=/etc/yunohost/mysql
 # example: ynh_mysql_connect_as 'user' 'pass' <<< "UPDATE ...;"
 # example: ynh_mysql_connect_as 'user' 'pass' < /path/to/file.sql
 #
-# usage: ynh_mysql_connect_as user pwd [db]
+# usage: ynh_mysql_connect_as --user=user --password=password [--database=database]
-# | arg: user - the user name to connect as
+# | arg: -u, --user - the user name to connect as
-# | arg: pwd - the user password
+# | arg: -p, --password - the user password
-# | arg: db - the database to connect to
+# | arg: -d, --database - the database to connect to
 ynh_mysql_connect_as() {
-    mysql -u "$1" --password="$2" -B "${3:-}"
+    # Declare an array to define the options of this helper.
+    declare -Ar args_array=( [u]=user= [p]=password= [d]=database= )
+    local user
+    local password
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
+    mysql -u "$user" --password="$password" -B "$database"
 }
 
 # Execute a command as root user
 #
-# usage: ynh_mysql_execute_as_root sql [db]
+# usage: ynh_mysql_execute_as_root --sql=sql [--database=database]
-# | arg: sql - the SQL command to execute
+# | arg: -s, --sql - the SQL command to execute
-# | arg: db - the database to connect to
+# | arg: -d, --database - the database to connect to
 ynh_mysql_execute_as_root() {
+    # Declare an array to define the options of this helper.
+    declare -Ar args_array=( [s]=sql= [d]=database= )
+    local sql
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
     ynh_mysql_connect_as "root" "$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
-        "${2:-}" <<< "$1"
+        "$database" <<< "$sql"
 }
 
 # Execute a command from a file as root user
 #
-# usage: ynh_mysql_execute_file_as_root file [db]
+# usage: ynh_mysql_execute_file_as_root --file=file [--database=database]
-# | arg: file - the file containing SQL commands
+# | arg: -f, --file - the file containing SQL commands
-# | arg: db - the database to connect to
+# | arg: -d, --database - the database to connect to
 ynh_mysql_execute_file_as_root() {
+    # Declare an array to define the options of this helper.
+    declare -Ar args_array=( [f]=file= [d]=database= )
+    local file
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+    database="${database:-}"
+
     ynh_mysql_connect_as "root" "$(sudo cat $MYSQL_ROOT_PWD_FILE)" \
-        "${2:-}" < "$1"
+        "$database" < "$file"
 }
 
 # Create a database and grant optionnaly privilegies to a user
@@ -73,11 +98,17 @@ ynh_mysql_drop_db() {
 #
 # example: ynh_mysql_dump_db 'roundcube' > ./dump.sql
 #
-# usage: ynh_mysql_dump_db db
+# usage: ynh_mysql_dump_db --database=database
-# | arg: db - the database name to dump
+# | arg: -d, --database - the database name to dump
 # | ret: the mysqldump output
 ynh_mysql_dump_db() {
-    mysqldump -u "root" -p"$(sudo cat $MYSQL_ROOT_PWD_FILE)" --single-transaction --skip-dump-date "$1"
+    # Declare an array to define the options of this helper.
+    declare -Ar args_array=( [d]=database= )
+    local database
+    # Manage arguments with getopts
+    ynh_handle_getopts_args "$@"
+
+    mysqldump -u "root" -p"$(sudo cat $MYSQL_ROOT_PWD_FILE)" --single-transaction --skip-dump-date "$database"
 }
 
 # Create a user
@@ -94,11 +125,16 @@ ynh_mysql_create_user() {
 
 # Check if a mysql user exists
 #
-# usage: ynh_mysql_user_exists user
+# usage: ynh_mysql_user_exists --user=user
-# | arg: user - the user for which to check existence
+# | arg: -u, --user - the user for which to check existence
 ynh_mysql_user_exists()
 {
-   local user=$1
+   # Declare an array to define the options of this helper.
+   declare -Ar args_array=( [u]=user= )
+   local user
+   # Manage arguments with getopts
+   ynh_handle_getopts_args "$@"
+
    if [[ -z $(ynh_mysql_execute_as_root "SELECT User from mysql.user WHERE User = '$user';") ]]
    then
       return 1
@@ -122,28 +158,40 @@ ynh_mysql_drop_user() {
 # After executing this helper, the password of the created database will be available in $db_pwd
 # It will also be stored as "mysqlpwd" into the app settings.
 #
-# usage: ynh_mysql_setup_db user name [pwd]
+# usage: ynh_mysql_setup_db --db_user=user --db_name=name [--db_password=pwd]
-# | arg: user - Owner of the database
+# | arg: -u, --db_user - Owner of the database
-# | arg: name - Name of the database
+# | arg: -n, --db_name - Name of the database
-# | arg: pwd - Password of the database. If not given, a password will be generated
+# | arg: -p, --db_password - Password of the database. If not given, a password will be generated
 ynh_mysql_setup_db () {
-	local db_user="$1"
+	# Declare an array to define the options of this helper.
-	local db_name="$2"
+	declare -Ar args_array=( [u]=db_user= [n]=db_name= [p]=db_password= )
+	local db_user
+	local db_name
+	local db_password
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local new_db_pwd=$(ynh_string_random)	# Generate a random password
-	# If $3 is not given, use new_db_pwd instead for db_pwd.
+	# If $db_password is not given, use new_db_pwd instead for db_password.
-	db_pwd="${3:-$new_db_pwd}"
+	db_password="${db_password:-$new_db_pwd}"
-	ynh_mysql_create_db "$db_name" "$db_user" "$db_pwd"	# Create the database
+
-	ynh_app_setting_set $app mysqlpwd $db_pwd	# Store the password in the app's config
+	ynh_mysql_create_db "$db_name" "$db_user" "$db_password"	# Create the database
+	ynh_app_setting_set $app mysqlpwd $db_password	# Store the password in the app's config
 }
 
 # Remove a database if it exists, and the associated user
 #
-# usage: ynh_mysql_remove_db user name
+# usage: ynh_mysql_remove_db --db_user=user --db_name=name
-# | arg: user - Owner of the database
+# | arg: -u, --db_user - Owner of the database
-# | arg: name - Name of the database
+# | arg: -n, --db_name - Name of the database
 ynh_mysql_remove_db () {
-	local db_user="$1"
+	# Declare an array to define the options of this helper.
-	local db_name="$2"
+	declare -Ar args_array=( [u]=db_user= [n]=db_name= )
+	local db_user
+	local db_name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
 	local mysql_root_password=$(sudo cat $MYSQL_ROOT_PWD_FILE)
 	if mysqlshow -u root -p$mysql_root_password | grep -q "^| $db_name"; then	# Check if the database exists
 		echo "Removing database $db_name" >&2
@@ -163,10 +211,16 @@ ynh_mysql_remove_db () {
 #
 # example: dbname=$(ynh_sanitize_dbid $app)
 #
-# usage: ynh_sanitize_dbid name
+# usage: ynh_sanitize_dbid --db_name=name
-# | arg: name - name to correct/sanitize
+# | arg: -n, --db_name - name to correct/sanitize
 # | ret: the corrected name
 ynh_sanitize_dbid () {
-	local dbid=${1//[-.]/_}	# We should avoid having - and . in the name of databases. They are replaced by _
+	# Declare an array to define the options of this helper.
-	echo $dbid
+	declare -Ar args_array=( [n]=db_name= )
+	local db_name
+	# Manage arguments with getopts
+	ynh_handle_getopts_args "$@"
+
+	# We should avoid having - and . in the name of databases. They are replaced by _
+	echo ${db_name//[-.]/_}
 }