2016-06-15 23:56:45 +02:00
#!/bin/bash
2020-01-02 18:44:20 +01:00
#=================================================
2020-10-05 22:02:46 +02:00
# COMMON VARIABLES
2020-01-02 18:44:20 +01:00
#=================================================
2017-03-19 19:16:10 +01:00
#=================================================
2021-05-16 16:48:58 +02:00
# PERSONAL HELPERS
2017-03-19 19:16:10 +01:00
#=================================================
2019-01-30 19:58:36 +01:00
#=================================================
# EXPERIMENTAL HELPERS
#=================================================
2018-05-20 20:55:15 +02:00
ynh_maintenance_mode_ON ( ) {
2023-04-16 17:12:12 +02:00
# Load value of $path and $domain from the config if their not set
if [ -z $path ] ; then
path = $( ynh_app_setting_get $app path)
2018-07-13 17:33:54 +02:00
fi
if [ -z $domain ] ; then
domain = $( ynh_app_setting_get $app domain)
fi
2020-01-02 18:44:20 +01:00
mkdir -p /var/www/html/
2018-05-20 20:55:15 +02:00
# Create an html to serve as maintenance notice
echo " <!DOCTYPE html>
<html>
<head>
<meta http-equiv= "refresh" content = "3" >
<title>Your app $app is currently under maintenance!</title>
<style>
body {
width: 70em;
margin: 0 auto;
}
</style>
</head>
<body>
<h1>Your app $app is currently under maintenance!</h1>
<p>This app has been put under maintenance by your administrator at $( date) </p>
<p>Please wait until the maintenance operation is done . This page will be reloaded as soon as your app will be back.</p>
</body>
</html>" > " /var/www/html/maintenance.$app .html"
# Create a new nginx config file to redirect all access to the app to the maintenance notice instead.
2023-04-16 17:12:12 +02:00
echo " # All request to the app will be redirected to ${ path } _maintenance and fall on the maintenance notice
rewrite ^${ path } /( .*) $ ${ path } _maintenance/? redirect;
2018-05-20 20:55:15 +02:00
# Use another location, to not be in conflict with the original config file
2023-04-16 17:12:12 +02:00
location ${ path } _maintenance/ {
2018-05-20 20:55:15 +02:00
alias /var/www/html/ ;
try_files maintenance.$app .html = 503;
# Include SSOWAT user panel.
include conf.d/yunohost_panel.conf.inc;
} " > " /etc/nginx/conf.d/$domain .d/maintenance.$app .conf"
# The current config file will redirect all requests to the root of the app.
# To keep the full path, we can use the following rewrite rule:
2023-04-16 17:12:12 +02:00
# rewrite ^${path}/(.*)$ ${path}_maintenance/\$1? redirect;
2018-05-20 20:55:15 +02:00
# The difference will be in the $1 at the end, which keep the following queries.
# But, if it works perfectly for a html request, there's an issue with any php files.
# This files are treated as simple files, and will be downloaded by the browser.
# Would be really be nice to be able to fix that issue. So that, when the page is reloaded after the maintenance, the user will be redirected to the real page he was.
systemctl reload nginx
}
ynh_maintenance_mode_OFF ( ) {
2023-04-16 17:12:12 +02:00
# Load value of $path and $domain from the config if their not set
if [ -z $path ] ; then
path = $( ynh_app_setting_get $app path)
2018-07-13 17:33:54 +02:00
fi
if [ -z $domain ] ; then
domain = $( ynh_app_setting_get $app domain)
fi
2023-04-16 17:12:12 +02:00
# Rewrite the nginx config file to redirect from ${path}_maintenance to the real url of the app.
echo " rewrite ^ ${ path } _maintenance/(.*) $ ${ path } /\$1 redirect; " > " /etc/nginx/conf.d/ $domain .d/maintenance. $app .conf "
2018-05-20 20:55:15 +02:00
systemctl reload nginx
# Sleep 4 seconds to let the browser reload the pages and redirect the user to the app.
sleep 4
# Then remove the temporary files used for the maintenance.
rm " /var/www/html/maintenance. $app .html "
rm " /etc/nginx/conf.d/ $domain .d/maintenance. $app .conf "
systemctl reload nginx
}
2019-01-13 19:10:28 +01:00
2020-01-02 18:44:20 +01:00
#=================================================
# Check the amount of available RAM
2019-01-13 19:10:28 +01:00
#
2020-01-02 18:44:20 +01:00
# usage: ynh_check_ram [--required=RAM required in Mb] [--no_swap|--only_swap] [--free_ram]
# | arg: -r, --required= - Amount of RAM required in Mb. The helper will return 0 is there's enough RAM, or 1 otherwise.
# If --required isn't set, the helper will print the amount of RAM, in Mb.
# | arg: -s, --no_swap - Ignore swap
# | arg: -o, --only_swap - Ignore real RAM, consider only swap.
# | arg: -f, --free_ram - Count only free RAM, not the total amount of RAM available.
ynh_check_ram ( ) {
2019-01-13 19:10:28 +01:00
# Declare an array to define the options of this helper.
2020-01-02 18:44:20 +01:00
declare -Ar args_array = ( [ r] = required = [ s] = no_swap [ o] = only_swap [ f] = free_ram )
local required
local no_swap
local only_swap
2019-01-13 19:10:28 +01:00
# Manage arguments with getopts
ynh_handle_getopts_args " $@ "
2020-01-02 18:44:20 +01:00
required = ${ required :- }
no_swap = ${ no_swap :- 0 }
only_swap = ${ only_swap :- 0 }
2019-01-13 19:10:28 +01:00
2020-01-02 18:44:20 +01:00
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 ))
2019-01-13 19:10:28 +01:00
2020-01-02 18:44:20 +01:00
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 ))
2019-01-13 19:10:28 +01:00
2020-01-02 18:44:20 +01:00
# Use the total amount of ram
local ram = $total_ram_swap
if [ $free_ram -eq 1 ]
then
# Use the total amount of free ram
ram = $free_ram_swap
if [ $no_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
else
if [ $no_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
2019-01-13 19:10:28 +01:00
fi
2020-01-02 18:44:20 +01:00
if [ -n " $required " ]
then
# Return 1 if the amount of ram isn't enough.
if [ $ram -lt $required ]
then
return 1
else
return 0
fi
2019-01-20 17:44:06 +01:00
2020-01-02 18:44:20 +01:00
# If no RAM is required, return the amount of available ram.
else
echo $ram
fi
2019-01-13 19:10:28 +01:00
}
