1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/spip_ynh.git synced 2024-09-03 20:25:59 +02:00

Commentaire en Anglais

This commit is contained in:
magikcypress 2017-03-08 00:26:58 +01:00
parent 4edbb03bed
commit f7f7d168ec
5 changed files with 79 additions and 88 deletions

View file

@ -2,30 +2,30 @@
ynh_version="2.4"
YNH_VERSION () { # Renvoi le numéro de version de la moulinette Yunohost
YNH_VERSION () { # Returns the version number of the Yunohost moulinette
ynh_version=$(sudo yunohost -v | grep "moulinette:" | cut -d' ' -f2 | cut -d'.' -f1,2)
}
CHECK_VAR () { # Vérifie que la variable n'est pas vide.
# $1 = Variable à vérifier
# $2 = Texte à afficher en cas d'erreur
CHECK_VAR () { # Verifies that the variable is not empty.
# $1 = Variable to be checked
# $2 = Display text on error
test -n "$1" || (echo "$2" >&2 && false)
}
EXIT_PROPERLY () { # Provoque l'arrêt du script en cas d'erreur. Et nettoye les résidus.
EXIT_PROPERLY () { # Causes the script to stop in the event of an error. And clean the residue.
trap '' ERR
echo -e "\e[91m \e[1m" # Shell in light red bold
echo -e "!!\n $app install's script has encountered an error. Installation was cancelled.\n!!" >&2
if type -t CLEAN_SETUP > /dev/null; then # Vérifie l'existance de la fonction avant de l'exécuter.
CLEAN_SETUP # Appel la fonction de nettoyage spécifique du script install.
if type -t CLEAN_SETUP > /dev/null; then # Checks the existence of the function before executing it.
CLEAN_SETUP # Call the specific cleanup function of the install script.
fi
# Compense le bug de ssowat qui ne supprime pas l'entrée de l'app en cas d'erreur d'installation.
# Compensates the ssowat bug that does not remove the app's input in case of installation error.
sudo sed -i "\@\"$domain$path/\":@d" /etc/ssowat/conf.json
if [ "$ynh_version" = "2.2" ]; then
/bin/bash $script_dir/remove # Appel le script remove. En 2.2, ce comportement n'est pas automatique.
/bin/bash $script_dir/remove
fi
ynh_die
@ -36,31 +36,28 @@ TRAP_ON () { # Activate signal capture
}
TRAP_OFF () { # Ignoring signal capture until TRAP_ON
# Pour une raison que j'ignore, la fonction TRAP_ON fonctionne très bien.
# Mais pas la fonction TRAP_OFF...
# Utiliser directement `trap '' ERR` dans le code pour l'utiliser, à la place de la fonction.
trap '' ERR # Ignoring exit signals
}
CHECK_USER () { # Vérifie la validité de l'user admin
# $1 = Variable de l'user admin.
CHECK_USER () { # Check the validity of the user admin
# $1 = User admin variable
ynh_user_exists "$1" || (echo "Wrong admin" >&2 && false)
}
CHECK_PATH () { # Vérifie la présence du / en début de path. Et son absence à la fin.
if [ "${path:0:1}" != "/" ]; then # Si le premier caractère n'est pas un /
path="/$path" # Ajoute un / en début de path
CHECK_PATH () { # Checks / at the beginning of the path. And his absence at the end.
if [ "${path:0:1}" != "/" ]; then # If the first character is not /
path="/$path" # Add / at the beginning of path
fi
if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # Si le dernier caractère est un / et que ce n'est pas le seul caractère.
path="${path:0:${#path}-1}" # Supprime le dernier caractère
if [ "${path:${#path}-1}" == "/" ] && [ ${#path} -gt 1 ]; then # If the last character is a / and it is not the only character.
path="${path:0:${#path}-1}" # Delete last character
fi
}
CHECK_DOMAINPATH () { # Vérifie la disponibilité du path et du domaine.
CHECK_DOMAINPATH () { # Checks the availability of the path and domain.
sudo yunohost app checkurl $domain$path -a $app
}
CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà utilisé.
CHECK_FINALPATH () { # Checks that the destination folder is not already in use.
final_path=/var/www/$app
if [ -e "$final_path" ]
then
@ -69,40 +66,40 @@ CHECK_FINALPATH () { # Vérifie que le dossier de destination n'est pas déjà u
fi
}
GENERATE_DB () { # Créer une base de données et un utilisateur dédié au nom de l'app.
# $1 = Nom de la base de donnée
# Génère un mot de passe aléatoire.
GENERATE_DB () { # Create a database and a dedicated user in the name of the app
# $1 = Database name
# Generates a random password.
db_user=$1
db_pwd=$(head -n20 /dev/urandom | tr -c -d 'A-Za-z0-9' | head -c20)
CHECK_VAR "$db_pwd" "db_pwd empty"
# Utilise '$app' comme nom d'utilisateur et de base de donnée
# Initialise la base de donnée et stocke le mot de passe mysql.
# Uses '$ app' as user name and database
# Initializes the database and stores the mysql password.
ynh_mysql_create_db "$db_user" "$db_user" $db_pwd
ynh_app_setting_set $app mysqlpwd $db_pwd
}
SETUP_SOURCE () { # Télécharge la source, décompresse et copie dans $final_path
# $1 = Nom de l'archive téléchargée.
SETUP_SOURCE () { # Download source, decompress and copu into $final_path
# $1 = Nom de l'archive téléchargée.
wget -nv --show-progress -i ../sources/source_url -O $1
# Vérifie la somme de contrôle de la source téléchargée.
# Checks the checksum of the downloaded source.
md5sum -c ../sources/source_md5 --status
# Décompresse la source
if [ "$(echo ${1##*.})" == "gz" ]; then
# Decompress source
if [ "$(echo ${1##*.})" == "tgz" ]; then
tar -x -f $1
elif [ "$(echo ${1##*.})" == "zip" ]; then
unzip -q $1
else
false # Format d'archive non pris en charge.
false # Unsupported archive format.
fi
# Copie les fichiers sources
# Copy file source
sudo cp -a $(cat ../sources/source_dir)/. "$final_path"
# Copie les fichiers additionnels ou modifiés.
# Copy additional file and modified
if test -e "../sources/ajouts"; then
sudo cp -a ../sources/ajouts/. "$final_path"
fi
}
POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configure.
POOL_FPM () { # Create the php-fpm pool configuration file and configure it.
sed -i "s@__NAMETOCHANGE__@$app@g" ../conf/php-fpm.conf
sed -i "s@__FINALPATH__@$final_path@g" ../conf/php-fpm.conf
finalphpconf=/etc/php5/fpm/pool.d/$app.conf
@ -114,22 +111,22 @@ POOL_FPM () { # Créer le fichier de configuration du pool php-fpm et le configu
sudo service php5-fpm reload
}
STORE_MD5_CONFIG () { # Enregistre la somme de contrôle du fichier de config
# $1 = Nom du fichier de conf pour le stockage dans settings.yml
# $2 = Nom complet et chemin du fichier de conf.
STORE_MD5_CONFIG () { # Saves the checksum of the config file
# $1 = Name of the conf file for storage in settings.yml
# $2 = Full name and path of the conf file.
ynh_app_setting_set $app $1_file_md5 $(sudo md5sum "$2" | cut -d' ' -f1)
}
CHECK_MD5_CONFIG () { # Créé un backup du fichier de config si il a été modifié.
# $1 = Nom du fichier de conf pour le stockage dans settings.yml
# $2 = Nom complet et chemin du fichier de conf.
CHECK_MD5_CONFIG () { # Created a backup of the config file if it was changed.
# $1 = Name of the conf file for storage in settings.yml
# $2 = Full name and path of the conf file.onf.
if [ "$(ynh_app_setting_get $app $1_file_md5)" != $(sudo md5sum "$2" | cut -d' ' -f1) ]; then
sudo cp -a "$2" "$2.backup.$(date '+%d.%m.%y_%Hh%M,%Ss')" # Si le fichier de config a été modifié, créer un backup.
fi
}
FIND_PORT () { # Cherche un port libre.
# $1 = Numéro de port pour débuter la recherche.
FIND_PORT () { # Search free port
# $1 = Port number to start the search.
port=$1
while ! sudo yunohost app checkport $port ; do
port=$((port+1))
@ -140,7 +137,7 @@ FIND_PORT () { # Cherche un port libre.
### REMOVE SCRIPT
REMOVE_NGINX_CONF () { # Suppression de la configuration nginx
REMOVE_NGINX_CONF () { # Delete nginx configuration
if [ -e "/etc/nginx/conf.d/$domain.d/$app.conf" ]; then # Delete nginx config
echo "Delete nginx config"
sudo rm "/etc/nginx/conf.d/$domain.d/$app.conf"
@ -148,7 +145,7 @@ REMOVE_NGINX_CONF () { # Suppression de la configuration nginx
fi
}
REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm
REMOVE_FPM_CONF () { # Delete pool php-fpm configuration
if [ -e "/etc/php5/fpm/pool.d/$app.conf" ]; then # Delete fpm config
echo "Delete fpm config"
sudo rm "/etc/php5/fpm/pool.d/$app.conf"
@ -160,27 +157,27 @@ REMOVE_FPM_CONF () { # Suppression de la configuration du pool php-fpm
sudo service php5-fpm reload
}
REMOVE_LOGROTATE_CONF () { # Suppression de la configuration de logrotate
REMOVE_LOGROTATE_CONF () { # Delete logrotate configuration
if [ -e "/etc/logrotate.d/$app" ]; then
echo "Delete logrotate config"
sudo rm "/etc/logrotate.d/$app"
fi
}
SECURE_REMOVE () { # Suppression de dossier avec vérification des variables
chaine="$1" # L'argument doit être donné entre quotes simple '', pour éviter d'interpréter les variables.
SECURE_REMOVE () { # Deleting a folder with variable verification
chaine="$1" # The argument must be given between simple quotes '', to avoid interpreting the variables.
no_var=0
while (echo "$chaine" | grep -q '\$') # Boucle tant qu'il y a des $ dans la chaine
while (echo "$chaine" | grep -q '\$') # Loop as long as there are $ in the string
do
no_var=1
global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole la première variable trouvée.
only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole complètement la variable en ajoutant le $ au début et en gardant uniquement le nom de la variable. Se débarrasse surtout du / et d'un éventuel chemin derrière.
real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` permet d'interpréter une variable contenue dans une variable.
global_var=$(echo "$chaine" | cut -d '$' -f 2) # Isole the first variable found.
only_var=\$$(expr "$global_var" : '\([A-Za-z0-9_]*\)') # Isole completely the variable by adding the $ at the beginning and keeping only the name of the variable. Mostly gets rid of / and a possible path behind.
real_var=$(eval "echo ${only_var}") # `eval "echo ${var}` Allows to interpret a variable contained in a variable.
if test -z "$real_var" || [ "$real_var" = "/" ]; then
echo "Variable $only_var is empty, suppression of $chaine cancelled." >&2
return 1
fi
chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # remplace la variable par sa valeur dans la chaine.
chaine=$(echo "$chaine" | sed "s@$only_var@$real_var@") # Replaces variable with its value in the string.
done
if [ "$no_var" -eq 1 ]
then
@ -195,9 +192,9 @@ SECURE_REMOVE () { # Suppression de dossier avec vérification des variable
fi
}
REMOVE_BDD () { # Suppression de la base de donnée et de l'utilisateur associé.
# $1 = Nom de la base de donnée
# Utilise '$app' comme nom d'utilisateur et de base de donnée
REMOVE_BDD () { # Delete database and users
# $1 = Database name
# Uses '$app' as user name and database
db_user=$1
if mysqlshow -u root -p$(sudo cat $MYSQL_ROOT_PWD_FILE) | grep -q "^| $db_user"; then
echo "Delete db"

View file

@ -3,16 +3,15 @@
# Exit on command errors and treat unset variables as an error
set -eu
source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script
# Source app helpers
source /usr/share/yunohost/helpers
source .fonctions # Loads the generic functions usually used in the script
source /usr/share/yunohost/helpers # Source app helpers
CLEAN_SETUP () {
# Nettoyage des résidus d'installation non pris en charge par le script remove.
# Clean installation residues that are not supported by the remove script.
# Clean hosts
sudo sed -i '/#SPIP/d' /etc/hosts
}
TRAP_ON # Active trap pour arrêter le script si une erreur est détectée.
TRAP_ON # Active trap to stop the script if an error is detected.
domain=$YNH_APP_ARG_DOMAIN
path=$YNH_APP_ARG_PATH
@ -42,23 +41,23 @@ ynh_app_setting_set $app language $language
ynh_app_setting_set $app ldap $ldap
#ynh_app_setting_set $app multisite $multisite
GENERATE_DB $app # Créer une base de données et un utilisateur dédié au nom de l'app.
GENERATE_DB $app # Create a database and a dedicated user in the app name
# Crée le repertoire de destination et stocke son emplacement.
# Creates the destination directory and stores its location.
sudo mkdir "$final_path"
ynh_app_setting_set $app final_path $final_path
SETUP_SOURCE "spip-3.1.zip"
# Set permissions du répertoire spip
# Set permissions spip directory
sudo chown -R www-data: $final_path
echo -e "127.0.0.1 $domain #SPIP" | sudo tee -a /etc/hosts
# Et copie le fichier de config nginx
# Copy nginx configuration
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/$app.conf
# Modifie les variables dans le fichier de configuration nginx
# Modif the variables in the nginx configuration file
sudo sed -i "s@__PATHTOCHANGE__@$path@g" /etc/nginx/conf.d/$domain.d/$app.conf
sudo sed -i "s@__FINALPATH__@$final_path@g" /etc/nginx/conf.d/$domain.d/$app.conf
sudo sed -i "s@__NAMETOCHANGE__@$app@g" /etc/nginx/conf.d/$domain.d/$app.conf
@ -73,7 +72,7 @@ POOL_FPM
sudo cp ../conf/connect.php $final_path/config/connect.php
sudo cp ../conf/mes_options.php $final_path/config/mes_options.php
# Changer les variables du fichier de configuration de SPIP
# Change SPIP configuration file variables
sudo sed -i "s@__DB_USER__@$db_user@g" $final_path/config/connect.php
sudo sed -i "s@__DB_PWD__@$db_pwd@g" $final_path/config/connect.php
@ -81,7 +80,7 @@ db_md5=$(echo $db_pwd | md5sum | awk '{print $1}')
db_sha=$(echo $db_pwd | openssl dgst -sha1 -hmac "key" | awk -F'= ' {'print $2'})
language="$(echo $language | head -c 2)"
# Changer les informations de la tables spip_auteurs
# Change spip_auteurs table informations
sudo sed -i "s@__ADMIN_SPIP__@$admin_spip@g" ../conf/sql/spip.sql
sudo sed -i "s@__PATH__@$path@g" ../conf/sql/spip.sql
sudo sed -i "s@__DB_USER__@$db_user@g" ../conf/sql/spip.sql
@ -103,10 +102,10 @@ do
sudo sed -i "s/__ALEA_FUTUR__/$j/g" ../conf/sql/spip.sql
done
# Charger la structure des tables dans la base.
# Load the tables structure into the database.
mysql --debug-check -u $db_user -p$db_pwd $db_user < ../conf/sql/spip.sql
# Utilisation de LDAP pour SPIP
# Use LDAP for SPIP
if [ "$ldap" = "Yes" ];
then
sudo cp ../conf/ldap.php $final_path/config/ldap.php
@ -124,12 +123,12 @@ then
ynh_app_setting_set "$app" unprotected_uris "/"
fi
# Régénère la configuration de SSOwat
# Reload SSOwat configuration
sudo yunohost app ssowatconf
# Reload Nginx and regenerate SSOwat conf
sudo service php5-fpm restart
sudo service nginx reload
# Nettoyer hosts
# clean hosts
sudo sed -i '/#SPIP/d' /etc/hosts

View file

@ -3,24 +3,22 @@
# Exit on command errors and treat unset variables as an error
set -u
source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script
source .fonctions # Loads the generic functions usually used in the script
source /usr/share/yunohost/helpers # Source app helpers
# Source app helpers
source /usr/share/yunohost/helpers
# Récupère les infos de l'application.
# Retrieves application info.
app=$YNH_APP_INSTANCE_NAME
domain=$(ynh_app_setting_get $app domain)
REMOVE_BDD $app # Suppression de la base de donnée et de l'utilisateur associé.
REMOVE_BDD $app # Deleting the database and the associated user.
SECURE_REMOVE '/var/www/$app' # Suppression du dossier de l'application
SECURE_REMOVE '/var/www/$app' # Removing the application folder
REMOVE_NGINX_CONF # Suppression de la configuration nginx
REMOVE_NGINX_CONF # Deleting the nginx configuration
REMOVE_FPM_CONF # Suppression de la configuration du pool php-fpm
REMOVE_FPM_CONF # Deleting the php-fpm pool configuration
# Régénère la configuration de SSOwat
# Reload SSOwat configuration
sudo yunohost app ssowatconf
echo -e "\e[0m" # Restore normal color

View file

@ -44,10 +44,7 @@ sudo sed -i -e "s/'DB_USER', *'[^']*'/'DB_USER', '$app'/g" $final_path/config/co
sudo sed -i -e "s/'DB_NAME', *'[^']*'/'DB_NAME', '$app'/g" $final_path/config/connect.php
# Set permissions
# Les fichiers appartiennent à www-data, pour permettre les mises à jour.
sudo chown -R www-data: $final_path
# Sauf le fichier de config connect.php qui appartient à root
sudo chown root: $final_path/config/connect.php
# Copy dedicated php-fpm process from backup folder to the right location
sudo cp -a $backup_dir/conf/php-fpm.conf /etc/php5/fpm/pool.d/$app.conf

View file

@ -3,7 +3,7 @@
# Exit on command errors and treat unset variables as an error
set -eu
source .fonctions # Charge les fonctions génériques habituellement utilisées dans le script
source .fonctions # Loads the generic functions usually used in the script
# See comments in install script
app=$YNH_APP_INSTANCE_NAME
@ -18,7 +18,7 @@ admin=$(ynh_app_setting_get "$app" admin)
is_public=$(ynh_app_setting_get "$app" is_public)
language=$(ynh_app_setting_get "$app" language)
CHECK_PATH # Vérifie et corrige la syntaxe du path.
CHECK_PATH # Checks and corrects the syntax of the path.
# Check if admin is not null
if [[ "$admin" = "" || "$is_public" = "" || "$language" = "" ]]; then
@ -32,7 +32,7 @@ final_path=/var/www/$app
db_name=$app
CHECK_MD5_CONFIG "connect.php" "$final_path/config/connect.php" # Créé un backup du fichier de config si il a été modifié.
CHECK_MD5_CONFIG "connect.php" "$final_path/config/connect.php" # Created a backup of the config file if it was changed.
# Modify Nginx configuration file and copy it to Nginx conf directory
sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf*