diff --git a/scripts/_common.sh b/scripts/_common.sh index 57fcaba..05a786e 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -46,25 +46,288 @@ flohmarkt_old_service="flohmarkt" # PERSONAL HELPERS #================================================= +# Redesign: +# Internal helper design to allow helpers to use getopts to manage their arguments +# +# [internal] +# +# example: function my_helper() +# { +# local -A args_array=( [a]=arg1= [b]=arg2= [c]=arg3 ) +# local arg1 +# local arg2 +# local arg3 +# ynh_handle_getopts_args "$@" +# +# [...] +# } +# my_helper --arg1 "val1" -b val2 -c +# +# usage: ynh_handle_getopts_args "$@" +# | arg: $@ - Simply "$@" to tranfert all the positionnal arguments to the function +# +# This helper need an array, named "args_array" with all the arguments used by the helper +# that want to use ynh_handle_getopts_args +# Be carreful, this array has to be an associative array, as the following example: +# local -A args_array=( [a]=arg1 [b]=arg2= [c]=arg3 ) +# Let's explain this array: +# a, b and c are short options, -a, -b and -c +# arg1, arg2 and arg3 are the long options associated to the previous short ones. --arg1, --arg2 and --arg3 +# For each option, a short and long version has to be defined. +# Let's see something more significant +# local -A args_array=( [u]=user [f]=finalpath= [d]=database ) +# +# NB: Because we're using 'declare' without -g, the array will be declared as a local variable. +# +# Please keep in mind that the long option will be used as a variable to store the values for this option. +# For the previous example, that means that $finalpath will be fill with the value given as argument for this option. +# +# Also, in the previous example, finalpath has a '=' at the end. That means this option need a value. +# So, the helper has to be call with --finalpath /final/path, --finalpath=/final/path or -f /final/path, +# the variable $finalpath will get the value /final/path +# If there's many values for an option, -f /final /path, the value will be separated by a ';' $finalpath=/final;/path +# For an option without value, like --user in the example, the helper can be called only with --user or -u. $user +# will then get the value 1. +# +# To keep a retrocompatibility, a package can still call a helper, using getopts, with positional arguments. +# The "legacy mode" will manage the positional arguments and fill the variable in the same order than they are given +# in $args_array. e.g. for `my_helper "val1" val2`, arg1 will be filled with val1, and arg2 with val2. +# +# @@ TODO: explain $legacy_args and '--' +# @@ '--' start processing the rest of the arguments as positional parameters in legacy mode +# @@ $legacy_args the arguments positional parameters will be assign to +# +# Requires YunoHost version 3.2.2 or higher. +ynh_handle_getopts_args() { + # Manage arguments only if there's some provided + set +o xtrace # set +x + if [ $# -eq 0 ]; then + ynh_print_warn --message="ynh_handle_getopts_args called without arguments" + return + fi + + # Store arguments in an array to keep each argument separated + local arguments=("$@") + + # For each option in the array, reduce to short options for getopts (e.g. for [u]=user, --user will be -u) + # And built parameters string for getopts + # ${!args_array[@]} is the list of all option_flags in the array (An option_flag is 'u' in [u]=user, user is a value) + local getopts_parameters="" + local option_flag="" + ## go through all possible options and replace arguments with short versions + echo "debug: arguments = '${arguments[@]}" + echo "debug: args_array = '${!args_array[@]}'" + for option_flag in "${!args_array[@]}"; do + echo "debug: option_flag = $option_flag" + # Concatenate each option_flags of the array to build the string of arguments for getopts + # Will looks like 'abcd' for -a -b -c -d + # If the value of an option_flag finish by =, it's an option with additionnal values. (e.g. --user bob or -u bob) + # Check the last character of the value associate to the option_flag + echo "debug: compare to '${args_array[$option_flag]: -1}'" + if [ "${args_array[$option_flag]: -1}" = "=" ]; then + # For an option with additionnal values, add a ':' after the letter for getopts. + getopts_parameters="${getopts_parameters}${option_flag}:" + else + getopts_parameters="${getopts_parameters}${option_flag}" + fi + echo "debug: getopts_parameters = ${getopts_parameters}" + # Check each argument given to the function + local arg="" + # ${#arguments[@]} is the size of the array + ## for one possible option: look at each argument supplied: + for arg in $(seq 0 $((${#arguments[@]} - 1))); do + echo "debug: arg = '$arg', argument = '${arguments[arg]}'" + # Replace long option with = (match the beginning of the argument) + arguments[arg]="$(printf '%s\n' "${arguments[arg]}" | sed "s/^--${args_array[$option_flag]}/-${option_flag}/")" + echo "debug: sed - printf '%s\n' \"${arguments[arg]}\" | sed \"s/^--${args_array[$option_flag]}/-${option_flag} /\"" + echo "debug: arg = '$arg', argument = '${arguments[arg]}'" + # And long option without = (match the whole line) + arguments[arg]="$(printf '%s\n' "${arguments[arg]}" | sed "s/^--${args_array[$option_flag]%=}$/-${option_flag}/")" + echo "debug: sed - printf '%s\n' \"${arguments[arg]}\" | sed \"s/^--${args_array[$option_flag]%=}$/-${option_flag} /\"" + echo "debug: arg = '$arg', argument = '${arguments[arg]}'" + done + echo "debug: arguments = '${arguments[@]}'" + done + echo 'debug: ================= end first loop =================' + + # Parse the first argument, return the number of arguments to be shifted off the arguments array + # The function call is necessary here to allow `getopts` to use $@ + parse_arg() { + echo "debug: parse_arg started, arguments='$@', getopts_parameters: '$getopts_parameters'" + for ME in "$@"; do + echo "debug: '$ME'" + done + # Initialize the index of getopts + OPTIND=1 + # getopts will fill $parameter with the letter of the option it has read. + local parameter="" + getopts ":$getopts_parameters" parameter || true + echo "debug: after getopts - parameter='$parameter', OPTIND='$OPTIND', OPTARG='$OPTARG'" + + if [ "$parameter" = "?" ]; then + ynh_die --message="Invalid argument: -${OPTARG:-}" + echo "debug: Invalid argument: -${OPTARG:-}" + exit 255 + elif [ "$parameter" = ":" ]; then + ynh_die --message="-$OPTARG parameter requires an argument." + echo "-$OPTARG parameter requires an argument." + exit 255 + else + # Use the long option, corresponding to the short option read by getopts, as a variable + # (e.g. for [u]=user, 'user' will be used as a variable) + # Also, remove '=' at the end of the long option + # The variable name will be stored in 'option_var' + option_var="${args_array[$parameter]%=}" + # if there's a '=' at the end of the long option name, this option takes values + if [ "${args_array[$parameter]: -1}" != "=" ]; then + # no argument expected for option - set option variable to '1' + # 'eval ${option_var}' will use the content of 'option_var' + echo "debug: option_var='${option_var}', option_value='1'" + option_value=1 + return 1 + else + # remove leading and trailing spaces from OPTARG + OPTARG="$( printf '%s' ${OPTARG} | sed -e 's/^[[:space:]]*//' -e 's/[[:space:]]*$//')" + echo "debug: option_var='${option_var}', OPTARG='${OPTARG}'" + option_value="${OPTARG}" + return 2 + fi + fi + } + + # iterate over the arguments: if first argument starts with a '-' feed arguments to getopts + # if first argument doesn't start with a '-' enter legacy mode and read positional parameters + local argument + local legacy_mode=0 # state is getopts mode, not legacy mode at the beginning + # for arg in $(seq 0 $((${#arguments[@]} - 1))); do + while [ ${#arguments} -ne 0 ]; do + local shift_value=0 + local option_var='' # the variable name to be filled + local option_value='' # the value to be filled into ${!option_value} + echo "debug: arg = '$arg', argument = '${arguments[arg]}'" + argument=${arguments[0]} + echo "debug: argument='$argument'" + # if state once changed to legacy mode, all the rest of the arguments will + # be interpreted in legacy mode even if they start with a '-' + if [ "${argument}" == '--' ];then + echo "debug: found '--', start legacy mode" + legacy_mode=1 + shift_value=1 + elif ! [ $legacy_mode == 1 ] && [ "${argument:0:1}" == '-' ]; then + echo "debug: getopts, arguments='${arguments[@]}', starting parse_arg" + parse_arg "${arguments[@]}" + shift_value=$? + else + legacy_mode=1 # set state for legacy_mode + # @@ set -x + echo "! Helper used in legacy mode !" >/dev/null + # @@ set +x + echo "debug: legacy, argument='$argument'" + # @@ TODO + # put positional parameters into variable - see below + shift_value=1 + fi + # bash shi(f)t + echo "debug: shifting '$shift_value' off arguments" + arguments=("${arguments[@]:${shift_value}}") + # @@ TODO fill values to ${option_var} here + # if ${option_var} is an array, fill mutiple values as array cells + # otherwise concatenate them seperated by ';' + echo "debug: fill option_var '$option_var' with option_value '$option_value'" + # But... ${!option_var} can't be used as left part of an assignation. + eval ${option_var}+='"${option_value};"' + done + + return + + + # If not, enter in legacy mode and manage the arguments as positionnal ones.. + # Dot not echo, to prevent to go through a helper output. But print only in the log. + local i + for i in $(seq 0 $((${#arguments[@]} - 1))); do + # Try to use legacy_args as a list of option_flag of the array args_array + # Otherwise, fallback to getopts_parameters to get the option_flag. But an associative arrays + # isn't always sorted in the correct order... + # Remove all ':' in getopts_parameters + getopts_parameters=${legacy_args:-${getopts_parameters//:/}} + # Get the option_flag from getopts_parameters, by using the option_flag according to the position of the argument. + option_flag=${getopts_parameters:$i:1} + if [ -z "$option_flag" ]; then + ynh_print_warn --message="Too many arguments ! \"${arguments[$i]}\" will be ignored." + continue + fi + # Use the long option, corresponding to the option_flag, as a variable + # (e.g. for [u]=user, 'user' will be used as a variable) + # Also, remove '=' at the end of the long option + # The variable name will be stored in 'option_var' + local option_var="${args_array[$option_flag]%=}" + + # Store each value given as argument in the corresponding variable + # The values will be stored in the same order than $args_array + eval ${option_var}+='"${arguments[$i]}"' + done + unset legacy_args + set -o xtrace # set -x +} + # local copy of ynh_local_curl() to test some improvement # https://github.com/YunoHost/issues/issues/2396 # https://codeberg.org/flohmarkt/flohmarkt_ynh/issues/51 flohmarkt_ynh_local_curl() { # Curl abstraction to help with POST requests to local pages (such as installation forms) # -# usage: ynh_local_curl "page_uri" "key1=value1" "key2=value2" ... -# | arg: page_uri - Path (relative to `$path_url`) of the page where POST data will be sent -# | arg: key1=value1 - (Optionnal) POST key and corresponding value -# | arg: key2=value2 - (Optionnal) Another POST key and corresponding value -# | arg: ... - (Optionnal) More POST keys and values +# usage: ynh_local_curl "page" "key1=value1" "key2=value2" ... +# | arg: -l --line_match: check answer for a regex to return true +# | arg: -P --put: PUT instead of POST, requires --data (see below) +# | arg: -H --header: add a header to the request (can be used multiple times) +# | arg: -n --no_sleep: don't sleep 2 seconds https://github.com/YunoHost/yunohost/pull/547 +# | arg: -d --data: data to be used with PUT: one long string +# | arg: or to be POSTed: multiple 'key=value' +# | arg: -p --page: either the PAGE part in 'https://$domain/$path/PAGE' or an a +# | arg: URL like 'http://doma.in/path/file.ext' +# | arg: page - positional parameter legacy version of '--page' +# | arg: key1=value1 - (Optional, POST only) legacy version of '--data' as positional parameter +# | arg: key2=value2 - (Optional, POST only) Another POST key and corresponding value +# | arg: ... - (Optional, POST only) More POST keys and values # # example: ynh_local_curl "/install.php?installButton" "foo=$var1" "bar=$var2" +# → will open a POST request to "https://$domain/$path/install.php?installButton" posting "foo=$var1" and "bar=$var2" +# example: ynh_local_curl -P --header "Accept: application/json" -H "Content-Type: application/json" \ +# --data "{\"members\":{\"names\": [\"${app}\"],\"roles\": [\"editor\"]}}" -l '"ok":true' \ +# "http://localhost:5984/" +# → will open a POST request to "http://localhost:5984/" adding headers with "Accept: application/json" +# and "Content-Type: application/json" sending the data from the "--data" argument. ynh_local_curl will +# return with an error if the servers response does not match the extended regex '"ok":true'. # -# For multiple calls, cookies are persisted between each call for the same app +# For multiple calls, cookies are persisted between each call for the same app. # -# `$domain` and `$path_url` should be defined externally (and correspond to the domain.tld and the /path (of the app?)) +# `$domain` and `$path_url` need to be defined externally if the first form for the 'page' argument is used. # # Requires YunoHost version 2.6.4 or higher. + + # Declare an array to define the options of this helper. + local legacy_args=pd + local -A args_array=( [l]=line_match= [P]=put [H]=header= [n]=no_sleep [p]=page= [d]=data= ) + local line_match + local put + # @@ todo if the headers contain ';' somewhere it might be a problem to split them + # apart correctly later, because all values are stored in $header seperated by + # ';' like 'header1: value;header2: value'. + # might be a good improvement to 'ynh_handle_getopts_args' to act differently if + # e.g. $header had been defined as an array: https://stackoverflow.com/questions/14525296/how-do-i-check-if-variable-is-an-array + local header + local no_sleep + local data + # Manage arguments with getopts + ynh_handle_getopts_args "$@" + + # @@ debug + local V + for V in line_match put header no_sleep data; do + echo "---> debug $V = ${!V}" + done + +return # Define url of page to curl local local_page=$(ynh_normalize_url_path $1) local full_path=$path_url$local_page @@ -86,26 +349,31 @@ flohmarkt_ynh_local_curl() { POST_data="--data ${POST_data::-1}" fi - # Wait untils nginx has fully reloaded (avoid curl fail with http2) - sleep 2 + # https://github.com/YunoHost/yunohost/pull/547 + # Wait untils nginx has fully reloaded (avoid curl fail with http2) unless disabled + if ! [[ $no_sleep == 1 ]]; then + sleep 2 + fi local cookiefile=/tmp/ynh-$app-cookie.txt touch $cookiefile chown root $cookiefile chmod 700 $cookiefile - # Temporarily enable visitors if needed... - local visitors_enabled=$(ynh_permission_has_user "main" "visitors" && echo yes || echo no) - if [[ $visitors_enabled == "no" ]]; then - ynh_permission_update --permission "main" --add "visitors" - fi +# @@ debug disabled +# # Temporarily enable visitors if needed... +# local visitors_enabled=$(ynh_permission_has_user "main" "visitors" && echo yes || echo no) +# if [[ $visitors_enabled == "no" ]]; then +# ynh_permission_update --permission "main" --add "visitors" +# fi # Curl the URL curl --silent --show-error --insecure --location --header "Host: $domain" --resolve $domain:443:127.0.0.1 $POST_data "$full_page_url" --cookie-jar $cookiefile --cookie $cookiefile - if [[ $visitors_enabled == "no" ]]; then - ynh_permission_update --permission "main" --remove "visitors" - fi +# @@ debug disabled +# if [[ $visitors_enabled == "no" ]]; then +# ynh_permission_update --permission "main" --remove "visitors" +# fi } # create symlinks containing domain and path for install, data and log directories @@ -218,7 +486,7 @@ flohmarkt_ynh_exists_couchdb_user() { } flohmarkt_ynh_exists_couchdb_db() { - if [[ $( curl -sX GET "http://127.0.0.1:5984/flohmarkt__22" --user "admin:${password_couchdb_admin}" \ + if [[ $( curl -sX GET "http://127.0.0.1:5984/${app}" --user "admin:${password_couchdb_admin}" \ | jq .error ) == '"not_found"' ]] then false