|
|
|
|
@ -1,343 +1,11 @@
|
|
|
|
|
#!/bin/bash
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# FUTUR OFFICIAL HELPERS
|
|
|
|
|
# COMMON VARIABLES
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Install or update the main directory yunohost.multimedia
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_multimedia_build_main_dir
|
|
|
|
|
ynh_multimedia_build_main_dir () {
|
|
|
|
|
local ynh_media_release="v1.2"
|
|
|
|
|
local checksum="806a827ba1902d6911095602a9221181"
|
|
|
|
|
|
|
|
|
|
# Download yunohost.multimedia scripts
|
|
|
|
|
wget -nv https://github.com/YunoHost-Apps/yunohost.multimedia/archive/${ynh_media_release}.tar.gz
|
|
|
|
|
|
|
|
|
|
# Check the control sum
|
|
|
|
|
echo "${checksum} ${ynh_media_release}.tar.gz" | md5sum -c --status \
|
|
|
|
|
|| ynh_die "Corrupt source"
|
|
|
|
|
|
|
|
|
|
# Check if the package acl is installed. Or install it.
|
|
|
|
|
ynh_package_is_installed 'acl' \
|
|
|
|
|
|| ynh_package_install acl
|
|
|
|
|
|
|
|
|
|
# Extract
|
|
|
|
|
mkdir yunohost.multimedia-master
|
|
|
|
|
tar -xf ${ynh_media_release}.tar.gz -C yunohost.multimedia-master --strip-components 1
|
|
|
|
|
./yunohost.multimedia-master/script/ynh_media_build.sh
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Add a directory in yunohost.multimedia
|
|
|
|
|
# This "directory" will be a symbolic link to a existing directory.
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_multimedia_addfolder "Source directory" "Destination directory"
|
|
|
|
|
#
|
|
|
|
|
# | arg: -s, --source_dir= - Source directory - The real directory which contains your medias.
|
|
|
|
|
# | arg: -d, --dest_dir= - Destination directory - The name and the place of the symbolic link, relative to "/home/yunohost.multimedia"
|
|
|
|
|
ynh_multimedia_addfolder () {
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
declare -Ar args_array=( [s]=source_dir= [d]=dest_dir= )
|
|
|
|
|
local source_dir
|
|
|
|
|
local dest_dir
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
|
|
|
|
|
./yunohost.multimedia-master/script/ynh_media_addfolder.sh --source="$source_dir" --dest="$dest_dir"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Move a directory in yunohost.multimedia, and replace by a symbolic link
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_multimedia_movefolder "Source directory" "Destination directory"
|
|
|
|
|
#
|
|
|
|
|
# | arg: -s, --source_dir= - Source directory - The real directory which contains your medias.
|
|
|
|
|
# It will be moved to "Destination directory"
|
|
|
|
|
# A symbolic link will replace it.
|
|
|
|
|
# | arg: -d, --dest_dir= - Destination directory - The new name and place of the directory, relative to "/home/yunohost.multimedia"
|
|
|
|
|
ynh_multimedia_movefolder () {
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
declare -Ar args_array=( [s]=source_dir= [d]=dest_dir= )
|
|
|
|
|
local source_dir
|
|
|
|
|
local dest_dir
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
|
|
|
|
|
./yunohost.multimedia-master/script/ynh_media_addfolder.sh --inv --source="$source_dir" --dest="$dest_dir"
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Allow an user to have an write authorisation in multimedia directories
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_multimedia_addaccess user_name
|
|
|
|
|
#
|
|
|
|
|
# | arg: -u, --user_name= - The name of the user which gain this access.
|
|
|
|
|
ynh_multimedia_addaccess () {
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
declare -Ar args_array=( [u]=user_name=)
|
|
|
|
|
local user_name
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
|
|
|
|
|
groupadd -f multimedia
|
|
|
|
|
usermod -a -G multimedia $user_name
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Get the total or free amount of RAM+swap on the system
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_get_ram [--free|--total] [--ignore_swap|--only_swap]
|
|
|
|
|
# | arg: -f, --free - Count free RAM+swap
|
|
|
|
|
# | arg: -t, --total - Count total RAM+swap
|
|
|
|
|
# | arg: -s, --ignore_swap - Ignore swap, consider only real RAM
|
|
|
|
|
# | arg: -o, --only_swap - Ignore real RAM, consider only swap
|
|
|
|
|
ynh_get_ram () {
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
local legacy_args=ftso
|
|
|
|
|
declare -Ar args_array=( [f]=free [t]=total [s]=ignore_swap [o]=only_swap )
|
|
|
|
|
local free
|
|
|
|
|
local total
|
|
|
|
|
local ignore_swap
|
|
|
|
|
local only_swap
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
ignore_swap=${ignore_swap:-0}
|
|
|
|
|
only_swap=${only_swap:-0}
|
|
|
|
|
free=${free:-0}
|
|
|
|
|
total=${total:-0}
|
|
|
|
|
|
|
|
|
|
local total_ram=$(vmstat --stats --unit M | grep "total memory" | awk '{print $1}')
|
|
|
|
|
local total_swap=$(vmstat --stats --unit M | grep "total swap" | awk '{print $1}')
|
|
|
|
|
local total_ram_swap=$(( total_ram + total_swap ))
|
|
|
|
|
|
|
|
|
|
local free_ram=$(vmstat --stats --unit M | grep "free memory" | awk '{print $1}')
|
|
|
|
|
local free_swap=$(vmstat --stats --unit M | grep "free swap" | awk '{print $1}')
|
|
|
|
|
local free_ram_swap=$(( free_ram + free_swap ))
|
|
|
|
|
|
|
|
|
|
# Use the total amount of ram
|
|
|
|
|
if [ $free -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# Use the total amount of free ram
|
|
|
|
|
local ram=$free_ram_swap
|
|
|
|
|
if [ $ignore_swap -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# Use only the amount of free ram
|
|
|
|
|
ram=$free_ram
|
|
|
|
|
elif [ $only_swap -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# Use only the amount of free swap
|
|
|
|
|
ram=$free_swap
|
|
|
|
|
fi
|
|
|
|
|
elif [ $total -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
local ram=$total_ram_swap
|
|
|
|
|
if [ $ignore_swap -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# Use only the amount of free ram
|
|
|
|
|
ram=$total_ram
|
|
|
|
|
elif [ $only_swap -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
# Use only the amount of free swap
|
|
|
|
|
ram=$total_swap
|
|
|
|
|
fi
|
|
|
|
|
else
|
|
|
|
|
ynh_print_warn --message="You have to choose --free or --total when using ynh_get_ram"
|
|
|
|
|
ram=0
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
echo $ram
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Return 0 or 1 depending if the system has a given amount of RAM+swap free or total
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_require_ram --required=RAM required in Mb [--free|--total] [--ignore_swap|--only_swap]
|
|
|
|
|
# | arg: -r, --required - The amount to require, in Mb
|
|
|
|
|
# | arg: -f, --free - Count free RAM+swap
|
|
|
|
|
# | arg: -t, --total - Count total RAM+swap
|
|
|
|
|
# | arg: -s, --ignore_swap - Ignore swap, consider only real RAM
|
|
|
|
|
# | arg: -o, --only_swap - Ignore real RAM, consider only swap
|
|
|
|
|
ynh_require_ram () {
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
local legacy_args=rftso
|
|
|
|
|
declare -Ar args_array=( [r]=required= [f]=free [t]=total [s]=ignore_swap [o]=only_swap )
|
|
|
|
|
local required
|
|
|
|
|
local free
|
|
|
|
|
local total
|
|
|
|
|
local ignore_swap
|
|
|
|
|
local only_swap
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
# Dunno if that's the right way to do, but that's some black magic to be able to
|
|
|
|
|
# forward the bool args to ynh_get_ram easily?
|
|
|
|
|
# If the variable $free is not empty, set it to '--free'
|
|
|
|
|
free=${free:+--free}
|
|
|
|
|
total=${total:+--total}
|
|
|
|
|
ignore_swap=${ignore_swap:+--ignore_swap}
|
|
|
|
|
only_swap=${only_swap:+--only_swap}
|
|
|
|
|
|
|
|
|
|
local ram=$(ynh_get_ram $free $total $ignore_swap $only_swap)
|
|
|
|
|
|
|
|
|
|
if [ $ram -lt $required ]
|
|
|
|
|
then
|
|
|
|
|
return 1
|
|
|
|
|
else
|
|
|
|
|
return 0
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Define the values to configure php-fpm
|
|
|
|
|
#
|
|
|
|
|
# usage: ynh_get_scalable_phpfpm --usage=usage --footprint=footprint [--print]
|
|
|
|
|
# | arg: -f, --footprint - Memory footprint of the service (low/medium/high).
|
|
|
|
|
# low - Less than 20Mb of ram by pool.
|
|
|
|
|
# medium - Between 20Mb and 40Mb of ram by pool.
|
|
|
|
|
# high - More than 40Mb of ram by pool.
|
|
|
|
|
# Or specify exactly the footprint, the load of the service as Mb by pool instead of having a standard value.
|
|
|
|
|
# To have this value, use the following command and stress the service.
|
|
|
|
|
# watch -n0.5 ps -o user,cmd,%cpu,rss -u APP
|
|
|
|
|
#
|
|
|
|
|
# | arg: -u, --usage - Expected usage of the service (low/medium/high).
|
|
|
|
|
# low - Personal usage, behind the sso.
|
|
|
|
|
# medium - Low usage, few people or/and publicly accessible.
|
|
|
|
|
# high - High usage, frequently visited website.
|
|
|
|
|
#
|
|
|
|
|
# | arg: -p, --print - Print the result
|
|
|
|
|
#
|
|
|
|
|
#
|
|
|
|
|
#
|
|
|
|
|
# The footprint of the service will be used to defined the maximum footprint we can allow, which is half the maximum RAM.
|
|
|
|
|
# So it will be used to defined 'pm.max_children'
|
|
|
|
|
# A lower value for the footprint will allow more children for 'pm.max_children'. And so for
|
|
|
|
|
# 'pm.start_servers', 'pm.min_spare_servers' and 'pm.max_spare_servers' which are defined from the
|
|
|
|
|
# value of 'pm.max_children'
|
|
|
|
|
# NOTE: 'pm.max_children' can't exceed 4 times the number of processor's cores.
|
|
|
|
|
#
|
|
|
|
|
# The usage value will defined the way php will handle the children for the pool.
|
|
|
|
|
# A value set as 'low' will set the process manager to 'ondemand'. Children will start only if the
|
|
|
|
|
# service is used, otherwise no child will stay alive. This config gives the lower footprint when the
|
|
|
|
|
# service is idle. But will use more proc since it has to start a child as soon it's used.
|
|
|
|
|
# Set as 'medium', the process manager will be at dynamic. If the service is idle, a number of children
|
|
|
|
|
# equal to pm.min_spare_servers will stay alive. So the service can be quick to answer to any request.
|
|
|
|
|
# The number of children can grow if needed. The footprint can stay low if the service is idle, but
|
|
|
|
|
# not null. The impact on the proc is a little bit less than 'ondemand' as there's always a few
|
|
|
|
|
# children already available.
|
|
|
|
|
# Set as 'high', the process manager will be set at 'static'. There will be always as many children as
|
|
|
|
|
# 'pm.max_children', the footprint is important (but will be set as maximum a quarter of the maximum
|
|
|
|
|
# RAM) but the impact on the proc is lower. The service will be quick to answer as there's always many
|
|
|
|
|
# children ready to answer.
|
|
|
|
|
ynh_get_scalable_phpfpm () {
|
|
|
|
|
local legacy_args=ufp
|
|
|
|
|
# Declare an array to define the options of this helper.
|
|
|
|
|
declare -Ar args_array=( [u]=usage= [f]=footprint= [p]=print )
|
|
|
|
|
local usage
|
|
|
|
|
local footprint
|
|
|
|
|
local print
|
|
|
|
|
# Manage arguments with getopts
|
|
|
|
|
ynh_handle_getopts_args "$@"
|
|
|
|
|
# Set all characters as lowercase
|
|
|
|
|
footprint=${footprint,,}
|
|
|
|
|
usage=${usage,,}
|
|
|
|
|
print=${print:-0}
|
|
|
|
|
|
|
|
|
|
if [ "$footprint" = "low" ]
|
|
|
|
|
then
|
|
|
|
|
footprint=20
|
|
|
|
|
elif [ "$footprint" = "medium" ]
|
|
|
|
|
then
|
|
|
|
|
footprint=35
|
|
|
|
|
elif [ "$footprint" = "high" ]
|
|
|
|
|
then
|
|
|
|
|
footprint=50
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
# Define the way the process manager handle child processes.
|
|
|
|
|
if [ "$usage" = "low" ]
|
|
|
|
|
then
|
|
|
|
|
php_pm=ondemand
|
|
|
|
|
elif [ "$usage" = "medium" ]
|
|
|
|
|
then
|
|
|
|
|
php_pm=dynamic
|
|
|
|
|
elif [ "$usage" = "high" ]
|
|
|
|
|
then
|
|
|
|
|
php_pm=static
|
|
|
|
|
else
|
|
|
|
|
ynh_die --message="Does not recognize '$usage' as an usage value."
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
# Get the total of RAM available, except swap.
|
|
|
|
|
local max_ram=$(ynh_get_ram --total --ignore_swap)
|
|
|
|
|
|
|
|
|
|
at_least_one() {
|
|
|
|
|
# Do not allow value below 1
|
|
|
|
|
if [ $1 -le 0 ]
|
|
|
|
|
then
|
|
|
|
|
echo 1
|
|
|
|
|
else
|
|
|
|
|
echo $1
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
# Define pm.max_children
|
|
|
|
|
# The value of pm.max_children is the total amount of ram divide by 2 and divide again by the footprint of a pool for this app.
|
|
|
|
|
# So if php-fpm start the maximum of children, it won't exceed half of the ram.
|
|
|
|
|
php_max_children=$(( $max_ram / 2 / $footprint ))
|
|
|
|
|
# If process manager is set as static, use half less children.
|
|
|
|
|
# Used as static, there's always as many children as the value of pm.max_children
|
|
|
|
|
if [ "$php_pm" = "static" ]
|
|
|
|
|
then
|
|
|
|
|
php_max_children=$(( $php_max_children / 2 ))
|
|
|
|
|
fi
|
|
|
|
|
php_max_children=$(at_least_one $php_max_children)
|
|
|
|
|
|
|
|
|
|
# To not overload the proc, limit the number of children to 4 times the number of cores.
|
|
|
|
|
local core_number=$(nproc)
|
|
|
|
|
local max_proc=$(( $core_number * 4 ))
|
|
|
|
|
if [ $php_max_children -gt $max_proc ]
|
|
|
|
|
then
|
|
|
|
|
php_max_children=$max_proc
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
if [ "$php_pm" = "dynamic" ]
|
|
|
|
|
then
|
|
|
|
|
# Define pm.start_servers, pm.min_spare_servers and pm.max_spare_servers for a dynamic process manager
|
|
|
|
|
php_min_spare_servers=$(( $php_max_children / 8 ))
|
|
|
|
|
php_min_spare_servers=$(at_least_one $php_min_spare_servers)
|
|
|
|
|
|
|
|
|
|
php_max_spare_servers=$(( $php_max_children / 2 ))
|
|
|
|
|
php_max_spare_servers=$(at_least_one $php_max_spare_servers)
|
|
|
|
|
|
|
|
|
|
php_start_servers=$(( $php_min_spare_servers + ( $php_max_spare_servers - $php_min_spare_servers ) /2 ))
|
|
|
|
|
php_start_servers=$(at_least_one $php_start_servers)
|
|
|
|
|
else
|
|
|
|
|
php_min_spare_servers=0
|
|
|
|
|
php_max_spare_servers=0
|
|
|
|
|
php_start_servers=0
|
|
|
|
|
fi
|
|
|
|
|
|
|
|
|
|
if [ $print -eq 1 ]
|
|
|
|
|
then
|
|
|
|
|
ynh_debug --message="Footprint=${footprint}Mb by pool."
|
|
|
|
|
ynh_debug --message="Process manager=$php_pm"
|
|
|
|
|
ynh_debug --message="Max RAM=${max_ram}Mb"
|
|
|
|
|
if [ "$php_pm" != "static" ]; then
|
|
|
|
|
ynh_debug --message="\nMax estimated footprint=$(( $php_max_children * $footprint ))"
|
|
|
|
|
ynh_debug --message="Min estimated footprint=$(( $php_min_spare_servers * $footprint ))"
|
|
|
|
|
fi
|
|
|
|
|
if [ "$php_pm" = "dynamic" ]; then
|
|
|
|
|
ynh_debug --message="Estimated average footprint=$(( $php_max_spare_servers * $footprint ))"
|
|
|
|
|
elif [ "$php_pm" = "static" ]; then
|
|
|
|
|
ynh_debug --message="Estimated footprint=$(( $php_max_children * $footprint ))"
|
|
|
|
|
fi
|
|
|
|
|
ynh_debug --message="\nRaw php-fpm values:"
|
|
|
|
|
ynh_debug --message="pm.max_children = $php_max_children"
|
|
|
|
|
if [ "$php_pm" = "dynamic" ]; then
|
|
|
|
|
ynh_debug --message="pm.start_servers = $php_start_servers"
|
|
|
|
|
ynh_debug --message="pm.min_spare_servers = $php_min_spare_servers"
|
|
|
|
|
ynh_debug --message="pm.max_spare_servers = $php_max_spare_servers"
|
|
|
|
|
fi
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
# Dependencies
|
|
|
|
|
app_depencencies="rsync encfs sshpass ccrypt lzop zstd lzip"
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
# EXPERIMENTAL HELPERS
|
|
|
|
|
@ -700,18 +368,3 @@ ynh_app_changelog () {
|
|
|
|
|
echo "No significative changes from the changelog..." > "${final_changelog}_lite"
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
#=================================================
|
|
|
|
|
|
|
|
|
|
# Execute a command as another user
|
|
|
|
|
# usage: exec_as USER COMMAND [ARG ...]
|
|
|
|
|
ynh_exec_as() {
|
|
|
|
|
local USER=$1
|
|
|
|
|
shift 1
|
|
|
|
|
|
|
|
|
|
if [[ $USER = $(whoami) ]]; then
|
|
|
|
|
eval "$@"
|
|
|
|
|
else
|
|
|
|
|
sudo -u "$USER" "$@"
|
|
|
|
|
fi
|
|
|
|
|
}
|
|
|
|
|
|
ericgaspar