|
|
@@ -52,210 +52,6 @@ bool_to_true_false () {
|
|
|
# FUTUR OFFICIAL HELPERS
|
|
|
#=================================================
|
|
|
|
|
|
-# Internal helper design to allow helpers to use getopts to manage their arguments
|
|
|
-#
|
|
|
-# [internal]
|
|
|
-#
|
|
|
-# example: function my_helper()
|
|
|
-# {
|
|
|
-# declare -Ar 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:
|
|
|
-# declare -Ar 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
|
|
|
-# declare -Ar 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.
|
|
|
-ynh_handle_getopts_args () {
|
|
|
- # Manage arguments only if there's some provided
|
|
|
- set +x
|
|
|
- if [ $# -ne 0 ]
|
|
|
- then
|
|
|
- # 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=""
|
|
|
- for option_flag in "${!args_array[@]}"
|
|
|
- do
|
|
|
- # 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
|
|
|
- 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
|
|
|
- # Check each argument given to the function
|
|
|
- local arg=""
|
|
|
- # ${#arguments[@]} is the size of the array
|
|
|
- for arg in `seq 0 $(( ${#arguments[@]} - 1 ))`
|
|
|
- do
|
|
|
- # And replace long option (value of the option_flag) by the short option, the option_flag itself
|
|
|
- # (e.g. for [u]=user, --user will be -u)
|
|
|
- # Replace long option with =
|
|
|
- arguments[arg]="${arguments[arg]//--${args_array[$option_flag]}/-${option_flag} }"
|
|
|
- # And long option without =
|
|
|
- arguments[arg]="${arguments[arg]//--${args_array[$option_flag]%=}/-${option_flag}}"
|
|
|
- done
|
|
|
- done
|
|
|
-
|
|
|
- # Read and parse all the arguments
|
|
|
- # Use a function here, to use standart arguments $@ and be able to use shift.
|
|
|
- parse_arg () {
|
|
|
- # Read all arguments, until no arguments are left
|
|
|
- while [ $# -ne 0 ]
|
|
|
- do
|
|
|
- # Initialize the index of getopts
|
|
|
- OPTIND=1
|
|
|
- # Parse with getopts only if the argument begin by -, that means the argument is an option
|
|
|
- # getopts will fill $parameter with the letter of the option it has read.
|
|
|
- local parameter=""
|
|
|
- getopts ":$getopts_parameters" parameter || true
|
|
|
-
|
|
|
- if [ "$parameter" = "?" ]
|
|
|
- then
|
|
|
- ynh_die --message="Invalid argument: -${OPTARG:-}"
|
|
|
- elif [ "$parameter" = ":" ]
|
|
|
- then
|
|
|
- ynh_die --message="-$OPTARG parameter requires an argument."
|
|
|
- else
|
|
|
- local shift_value=1
|
|
|
- # 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'
|
|
|
- local option_var="${args_array[$parameter]%=}"
|
|
|
- # If this option doesn't take values
|
|
|
- # if there's a '=' at the end of the long option name, this option takes values
|
|
|
- if [ "${args_array[$parameter]: -1}" != "=" ]
|
|
|
- then
|
|
|
- # 'eval ${option_var}' will use the content of 'option_var'
|
|
|
- eval ${option_var}=1
|
|
|
- else
|
|
|
- # Read all other arguments to find multiple value for this option.
|
|
|
- # Load args in a array
|
|
|
- local all_args=("$@")
|
|
|
-
|
|
|
- # If the first argument is longer than 2 characters,
|
|
|
- # There's a value attached to the option, in the same array cell
|
|
|
- if [ ${#all_args[0]} -gt 2 ]; then
|
|
|
- # Remove the option and the space, so keep only the value itself.
|
|
|
- all_args[0]="${all_args[0]#-${parameter} }"
|
|
|
- # Reduce the value of shift, because the option has been removed manually
|
|
|
- shift_value=$(( shift_value - 1 ))
|
|
|
- fi
|
|
|
-
|
|
|
- # Declare the content of option_var as a variable.
|
|
|
- eval ${option_var}=""
|
|
|
- # Then read the array value per value
|
|
|
- local i
|
|
|
- for i in `seq 0 $(( ${#all_args[@]} - 1 ))`
|
|
|
- do
|
|
|
- # If this argument is an option, end here.
|
|
|
- if [ "${all_args[$i]:0:1}" == "-" ]
|
|
|
- then
|
|
|
- # Ignore the first value of the array, which is the option itself
|
|
|
- if [ "$i" -ne 0 ]; then
|
|
|
- break
|
|
|
- fi
|
|
|
- else
|
|
|
- # Else, add this value to this option
|
|
|
- # Each value will be separated by ';'
|
|
|
- if [ -n "${!option_var}" ]
|
|
|
- then
|
|
|
- # If there's already another value for this option, add a ; before adding the new value
|
|
|
- eval ${option_var}+="\;"
|
|
|
- fi
|
|
|
- eval ${option_var}+=\"${all_args[$i]}\"
|
|
|
- shift_value=$(( shift_value + 1 ))
|
|
|
- fi
|
|
|
- done
|
|
|
- fi
|
|
|
- fi
|
|
|
-
|
|
|
- # Shift the parameter and its argument(s)
|
|
|
- shift $shift_value
|
|
|
- done
|
|
|
- }
|
|
|
-
|
|
|
- # LEGACY MODE
|
|
|
- # Check if there's getopts arguments
|
|
|
- if [ "${arguments[0]:0:1}" != "-" ]
|
|
|
- then
|
|
|
- # 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.
|
|
|
- set -x; echo "! Helper used in legacy mode !" > /dev/null; set +x
|
|
|
- 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
|
|
|
- else
|
|
|
- # END LEGACY MODE
|
|
|
- # Call parse_arg and pass the modified list of args as an array of arguments.
|
|
|
- parse_arg "${arguments[@]}"
|
|
|
- fi
|
|
|
- fi
|
|
|
- set -x
|
|
|
-}
|
|
|
-
|
|
|
-#=================================================
|
|
|
-
|
|
|
# Install or update the main directory yunohost.multimedia
|
|
|
#
|
|
|
# usage: ynh_multimedia_build_main_dir
|
|
|
@@ -517,27 +313,6 @@ ynh_check_app_version_changed () {
|
|
|
|
|
|
#=================================================
|
|
|
|
|
|
-# Delete a file checksum from the app settings
|
|
|
-#
|
|
|
-# $app should be defined when calling this helper
|
|
|
-#
|
|
|
-# usage: ynh_remove_file_checksum file
|
|
|
-# | arg: -f, --file= - The file for which the checksum will be deleted
|
|
|
-ynh_delete_file_checksum () {
|
|
|
- # Declare an array to define the options of this helper.
|
|
|
- declare -Ar args_array=( [f]=file= )
|
|
|
- local file
|
|
|
- # Manage arguments with getopts
|
|
|
- ynh_handle_getopts_args "$@"
|
|
|
-
|
|
|
- local checksum_setting_name=checksum_${file//[\/ ]/_} # Replace all '/' and ' ' by '_'
|
|
|
- ynh_app_setting_delete $app $checksum_setting_name
|
|
|
-}
|
|
|
-
|
|
|
-#=================================================
|
|
|
-# EXPERIMENTAL HELPERS
|
|
|
-#=================================================
|
|
|
-
|
|
|
# Start (or other actions) a service, print a log in case of failure and optionnaly wait until the service is completely started
|
|
|
#
|
|
|
# usage: ynh_systemd_action [-n service_name] [-a action] [ [-l "line to match"] [-p log_path] [-t timeout] [-e length] ]
|
|
|
@@ -629,10 +404,92 @@ ynh_clean_check_starting () {
|
|
|
|
|
|
#=================================================
|
|
|
|
|
|
+# Print a message as INFO and show progression during an app script
|
|
|
+#
|
|
|
+# usage: ynh_script_progression --message=message [--weight=weight] [--time]
|
|
|
+# | arg: -m, --message= - The text to print
|
|
|
+# | arg: -w, --weight= - The weight for this progression. This value is 1 by default. Use a bigger value for a longer part of the script.
|
|
|
+# | arg: -t, --time= - Print the execution time since the last call to this helper. Especially usefull to define weights.
|
|
|
+# | arg: -l, --last= - Use for the last call of the helper, to fill te progression bar.
|
|
|
+increment_progression=0
|
|
|
+previous_weight=0
|
|
|
+# Define base_time when the file is sourced
|
|
|
+base_time=$(date +%s)
|
|
|
+ynh_script_progression () {
|
|
|
+ # Declare an array to define the options of this helper.
|
|
|
+ declare -Ar args_array=( [m]=message= [w]=weight= [t]=time [l]=last )
|
|
|
+ local message
|
|
|
+ local weight
|
|
|
+ local time
|
|
|
+ local last
|
|
|
+ # Manage arguments with getopts
|
|
|
+ ynh_handle_getopts_args "$@"
|
|
|
+ weight=${weight:-1}
|
|
|
+ time=${time:-0}
|
|
|
+ last=${last:-0}
|
|
|
+
|
|
|
+ # Get execution time since the last $base_time
|
|
|
+ local exec_time=$(( $(date +%s) - $base_time ))
|
|
|
+ base_time=$(date +%s)
|
|
|
+
|
|
|
+ # Get the number of occurrences of 'ynh_script_progression' in the script. Except those are commented.
|
|
|
+ local helper_calls="$(grep --count "^[^#]*ynh_script_progression" $0)"
|
|
|
+ # Get the number of call with a weight value
|
|
|
+ local weight_calls=$(grep --perl-regexp --count "^[^#]*ynh_script_progression.*(--weight|-w )" $0)
|
|
|
+
|
|
|
+ # Get the weight of each occurrences of 'ynh_script_progression' in the script using --weight
|
|
|
+ local weight_valuesA="$(grep --perl-regexp "^[^#]*ynh_script_progression.*--weight" $0 | sed 's/.*--weight[= ]\([[:digit:]].*\)/\1/g')"
|
|
|
+ # Get the weight of each occurrences of 'ynh_script_progression' in the script using -w
|
|
|
+ local weight_valuesB="$(grep --perl-regexp "^[^#]*ynh_script_progression.*-w " $0 | sed 's/.*-w[= ]\([[:digit:]].*\)/\1/g')"
|
|
|
+ # Each value will be on a different line.
|
|
|
+ # Remove each 'end of line' and replace it by a '+' to sum the values.
|
|
|
+ local weight_values=$(( $(echo "$weight_valuesA" | tr '\n' '+') + $(echo "$weight_valuesB" | tr '\n' '+') 0 ))
|
|
|
+
|
|
|
+ # max_progression is a total number of calls to this helper.
|
|
|
+ # Less the number of calls with a weight value.
|
|
|
+ # Plus the total of weight values
|
|
|
+ local max_progression=$(( $helper_calls - $weight_calls + $weight_values ))
|
|
|
+
|
|
|
+ # Increment each execution of ynh_script_progression in this script by the weight of the previous call.
|
|
|
+ increment_progression=$(( $increment_progression + $previous_weight ))
|
|
|
+ # Store the weight of the current call in $previous_weight for next call
|
|
|
+ previous_weight=$weight
|
|
|
+
|
|
|
+ # Set the scale of the progression bar
|
|
|
+ local scale=20
|
|
|
+ # progress_string(1,2) should have the size of the scale.
|
|
|
+ local progress_string1="####################"
|
|
|
+ local progress_string0="...................."
|
|
|
+
|
|
|
+ # Reduce $increment_progression to the size of the scale
|
|
|
+ if [ $last -eq 0 ]
|
|
|
+ then
|
|
|
+ local effective_progression=$(( $increment_progression * $scale / $max_progression ))
|
|
|
+ # If last is specified, fill immediately the progression_bar
|
|
|
+ else
|
|
|
+ local effective_progression=$scale
|
|
|
+ fi
|
|
|
+
|
|
|
+ # Build $progression_bar from progress_string(1,2) according to $effective_progression
|
|
|
+ local progression_bar="${progress_string1:0:$effective_progression}${progress_string0:0:$(( $scale - $effective_progression ))}"
|
|
|
+
|
|
|
+ local print_exec_time=""
|
|
|
+ if [ $time -eq 1 ]
|
|
|
+ then
|
|
|
+ print_exec_time=" [$(date +%Hh%Mm,%Ss --date="0 + $exec_time sec")]"
|
|
|
+ fi
|
|
|
+
|
|
|
+ ynh_print_info "[$progression_bar] > ${message}${print_exec_time}"
|
|
|
+}
|
|
|
+
|
|
|
+#=================================================
|
|
|
+# EXPERIMENTAL HELPERS
|
|
|
+#=================================================
|
|
|
+
|
|
|
# Send an email to inform the administrator
|
|
|
#
|
|
|
# usage: ynh_send_readme_to_admin --app_message=app_message [--recipients=recipients] [--type=type]
|
|
|
-# | arg: -m --app_message= - The message to send to the administrator.
|
|
|
+# | arg: -m --app_message= - The file with the content to send to the administrator.
|
|
|
# | arg: -r, --recipients= - The recipients of this email. Use spaces to separate multiples recipients. - default: root
|
|
|
# example: "root admin@domain"
|
|
|
# If you give the name of a YunoHost user, ynh_send_readme_to_admin will find its email adress for you
|
|
|
@@ -645,11 +502,16 @@ ynh_send_readme_to_admin() {
|
|
|
local recipients
|
|
|
local type
|
|
|
# Manage arguments with getopts
|
|
|
+
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
- app_message="${app_message:-...No specific information...}"
|
|
|
+ app_message="${app_message:-}"
|
|
|
recipients="${recipients:-root}"
|
|
|
type="${type:-install}"
|
|
|
|
|
|
+ # Get the value of admin_mail_html
|
|
|
+ admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
|
|
|
+ admin_mail_html="${admin_mail_html:-0}"
|
|
|
+
|
|
|
# Retrieve the email of users
|
|
|
find_mails () {
|
|
|
local list_mails="$1"
|
|
|
@@ -696,12 +558,53 @@ ynh_send_readme_to_admin() {
|
|
|
|
|
|
Specific information for the application $app.
|
|
|
|
|
|
-$app_message
|
|
|
+$(if [ -n "$app_message" ]
|
|
|
+then
|
|
|
+ cat "$app_message"
|
|
|
+else
|
|
|
+ echo "...No specific information..."
|
|
|
+fi)
|
|
|
|
|
|
---
|
|
|
Automatic diagnosis data from YunoHost
|
|
|
|
|
|
-$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
|
|
|
+__PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')__PRE_TAG2__"
|
|
|
+
|
|
|
+ # Store the message into a file for further modifications.
|
|
|
+ echo "$mail_message" > mail_to_send
|
|
|
+
|
|
|
+ # If a html email is required. Apply html tags to the message.
|
|
|
+ if [ "$admin_mail_html" -eq 1 ]
|
|
|
+ then
|
|
|
+ # Insert 'br' tags at each ending of lines.
|
|
|
+ ynh_replace_string "$" "<br>" mail_to_send
|
|
|
+
|
|
|
+ # Insert starting HTML tags
|
|
|
+ sed --in-place '1s@^@<!DOCTYPE html>\n<html>\n<head></head>\n<body>\n@' mail_to_send
|
|
|
+
|
|
|
+ # Keep tabulations
|
|
|
+ ynh_replace_string " " "\ \ " mail_to_send
|
|
|
+ ynh_replace_string "\t" "\ \ " mail_to_send
|
|
|
+
|
|
|
+ # Insert url links tags
|
|
|
+ ynh_replace_string "__URL_TAG1__\(.*\)__URL_TAG2__\(.*\)__URL_TAG3__" "<a href=\"\2\">\1</a>" mail_to_send
|
|
|
+
|
|
|
+ # Insert pre tags
|
|
|
+ ynh_replace_string "__PRE_TAG1__" "<pre>" mail_to_send
|
|
|
+ ynh_replace_string "__PRE_TAG2__" "<\pre>" mail_to_send
|
|
|
+
|
|
|
+ # Insert finishing HTML tags
|
|
|
+ echo -e "\n</body>\n</html>" >> mail_to_send
|
|
|
+
|
|
|
+ # Otherwise, remove tags to keep a plain text.
|
|
|
+ else
|
|
|
+ # Remove URL tags
|
|
|
+ ynh_replace_string "__URL_TAG[1,3]__" "" mail_to_send
|
|
|
+ ynh_replace_string "__URL_TAG2__" ": " mail_to_send
|
|
|
+
|
|
|
+ # Remove PRE tags
|
|
|
+ ynh_replace_string "__PRE_TAG[1-2]__" "" mail_to_send
|
|
|
+ fi
|
|
|
|
|
|
# Define binary to use for mail command
|
|
|
if [ -e /usr/bin/bsd-mailx ]
|
|
|
@@ -711,8 +614,15 @@ $(yunohost tools diagnosis | grep -B 100 "services:" | sed '/services:/d')"
|
|
|
local mail_bin=/usr/bin/mail.mailutils
|
|
|
fi
|
|
|
|
|
|
+ if [ "$admin_mail_html" -eq 1 ]
|
|
|
+ then
|
|
|
+ content_type="text/html"
|
|
|
+ else
|
|
|
+ content_type="text/plain"
|
|
|
+ fi
|
|
|
+
|
|
|
# Send the email to the recipients
|
|
|
- echo "$mail_message" | $mail_bin -a "Content-Type: text/plain; charset=UTF-8" -s "$mail_subject" "$recipients"
|
|
|
+ cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients"
|
|
|
}
|
|
|
|
|
|
#=================================================
|
|
|
@@ -883,3 +793,65 @@ ynh_download_file () {
|
|
|
# Move the file to its destination
|
|
|
mv $filename $dest_dir
|
|
|
}
|
|
|
+
|
|
|
+#=================================================
|
|
|
+
|
|
|
+# Create a changelog for an app after an upgrade.
|
|
|
+#
|
|
|
+# The changelog is printed into the file ./changelog for the time of the upgrade.
|
|
|
+#
|
|
|
+# In order to create a changelog, ynh_app_changelog will get info from /etc/yunohost/apps/$app/status.json
|
|
|
+# In order to find the current commit use by the app.
|
|
|
+# The remote repository, and the branch.
|
|
|
+# The changelog will be only the commits since the current revision.
|
|
|
+#
|
|
|
+# Because of the need of those info, ynh_app_changelog works only
|
|
|
+# with apps that have been installed from a list.
|
|
|
+#
|
|
|
+# usage: ynh_app_changelog
|
|
|
+ynh_app_changelog () {
|
|
|
+ get_value_from_settings ()
|
|
|
+ {
|
|
|
+ local value="$1"
|
|
|
+ # Extract a value from the status.json file of an installed app.
|
|
|
+
|
|
|
+ grep "$value\": \"" /etc/yunohost/apps/$app/status.json | sed "s/.*$value\": \"\([^\"]*\).*/\1/"
|
|
|
+ }
|
|
|
+
|
|
|
+ local current_revision="$(get_value_from_settings revision)"
|
|
|
+ local repo="$(get_value_from_settings url)"
|
|
|
+ local branch="$(get_value_from_settings branch)"
|
|
|
+ # ynh_app_changelog works only with an app installed from a list.
|
|
|
+ if [ -z "$current_revision" ] || [ -z "$repo" ] || [ -z "$branch" ]
|
|
|
+ then
|
|
|
+ ynh_print_warn "Unable to build the changelog..."
|
|
|
+ touch changelog
|
|
|
+ return 0
|
|
|
+ fi
|
|
|
+
|
|
|
+ # Fetch the history of the repository, without cloning it
|
|
|
+ mkdir git_history
|
|
|
+ (cd git_history
|
|
|
+ ynh_exec_warn_less git init
|
|
|
+ ynh_exec_warn_less git remote add -f origin $repo
|
|
|
+ # Get the line of the current commit of the installed app in the history.
|
|
|
+ local line_to_head=$(git log origin/$branch --pretty=oneline | grep --line-number "$current_revision" | cut -d':' -f1)
|
|
|
+ # Cut the history before the current commit, to keep only newer commits.
|
|
|
+ # Then use sed to reorganise each lines and have a nice list of commits since the last upgrade.
|
|
|
+ # This list is redirected into the file changelog
|
|
|
+ git log origin/$branch --pretty=oneline | head --lines=$(($line_to_head-1)) | sed 's/^\([[:alnum:]]*\)\(.*\)/*(\1) -> \2/g' > ../changelog)
|
|
|
+ # Remove 'Merge pull request' commits
|
|
|
+ sed -i '/Merge pull request #[[:digit:]]* from/d' changelog
|
|
|
+ # As well as conflict resolving commits
|
|
|
+ sed -i '/Merge branch .* into/d' changelog
|
|
|
+
|
|
|
+ # Get the value of admin_mail_html
|
|
|
+ admin_mail_html=$(ynh_app_setting_get $app admin_mail_html)
|
|
|
+ admin_mail_html="${admin_mail_html:-0}"
|
|
|
+
|
|
|
+ # If a html email is required. Apply html to the changelog.
|
|
|
+ if [ "$admin_mail_html" -eq 1 ]
|
|
|
+ then
|
|
|
+ sed -in-place "s@\*(\([[:alnum:]]*\)) -> \(.*\)@* __URL_TAG1__\2__URL_TAG2__${repo}/commit/\1__URL_TAG3__@g" changelog
|
|
|
+ fi
|
|
|
+}
|
Maniack Crudelis