2
3
mirror of https://github.com/octoleo/docker-joomla.git synced 2024-11-08 05:45:22 +00:00

Refactor the whole entrypoint template file to a better code standard.

This commit is contained in:
Llewellyn van der Merwe 2024-06-13 13:10:55 +02:00
parent 9b1db2a810
commit 4d6ee3a682
Signed by: Llewellyn
GPG Key ID: A9201372263741E7

View File

@ -1,10 +1,186 @@
#!/bin/bash #!/bin/bash
set -e set -e
# Load database password from file if specified
if [ -n "$JOOMLA_DB_PASSWORD_FILE" ] && [ -f "$JOOMLA_DB_PASSWORD_FILE" ]; then if [ -n "$JOOMLA_DB_PASSWORD_FILE" ] && [ -f "$JOOMLA_DB_PASSWORD_FILE" ]; then
JOOMLA_DB_PASSWORD=$(cat "$JOOMLA_DB_PASSWORD_FILE") JOOMLA_DB_PASSWORD=$(cat "$JOOMLA_DB_PASSWORD_FILE")
fi fi
# Function to log messages
joomla_log() {
local msg="$1"
echo >&2 " $msg"
}
# Function to log info messages
joomla_log_info() {
local msg="$1"
echo >&2 "[INFO] $msg"
}
# Function to log warning messages
joomla_log_warning() {
local msg="$1"
echo >&2 "[WARNING] $msg"
}
# Function to log error messages
joomla_log_error() {
local msg="$1"
echo >&2 "[ERROR] $msg"
}
# Function to set a line
joomla_echo_line() {
echo >&2 "========================================================================"
}
# Function to set a line at end
joomla_echo_line_start() {
joomla_echo_line
echo >&2
}
# Function to set a line at end
joomla_echo_line_end() {
echo >&2
joomla_echo_line
}
# Function to give final success message (1)
joomla_log_configured_success_message() {
joomla_log "This server is now configured to run Joomla!"
}
# Function to give final success message (2)
joomla_log_success_and_need_db_message() {
joomla_log_configured_success_message
echo >&2
joomla_log " NOTE: You will need your database server address, database name,"
joomla_log " and database user credentials to install Joomla."
}
# Function to validate URLs
joomla_validate_url() {
if [[ $1 =~ ^http(s)?://[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(/.*)?$ ]]; then
return 0
else
return 1
fi
}
# Function to validate file path
joomla_validate_path() {
if [[ -f $1 ]]; then
return 0
else
return 1
fi
}
# Function to split values by semicolon
joomla_get_array_by_semicolon() {
local input=$1 # The input string to be split
local -n arr=$2 # The array to store the split values (passed by reference)
local old_IFS=$IFS # Save the original IFS value
# shellcheck disable=SC2034
# passed by reference
IFS=';' read -ra arr <<< "$input" # Split the input by semicolon and store in array
IFS=$old_IFS # Restore the original IFS value
}
# Function to split values by colon to get host and port
joomla_get_host_port_by_colon() {
local input=$1 # The input string to be split
local -n hostname=$2 # The variable to store the hostname (passed by reference)
local -n port=$3 # The variable to store the port (passed by reference)
local old_IFS=$IFS # Save the original IFS value
# shellcheck disable=SC2034
# passed by reference
IFS=':' read -r hostname port <<< "$input" # Split the input by colon and store in hostname and port
IFS=$old_IFS # Restore the original IFS value
}
# Function to install extension from URL
joomla_install_extension_via_url() {
local url=$1
if joomla_validate_url "$url"; then
if php cli/joomla.php extension:install --url "$url" --no-interaction; then
joomla_log_info "Successfully installed $url"
else
joomla_log_error "Failed to install $url"
fi
else
joomla_log_error "Invalid URL: $url"
fi
}
# Function to install extension from path
joomla_install_extension_via_path() {
local path=$1
if joomla_validate_path "$path"; then
if php cli/joomla.php extension:install --path "$path" --no-interaction; then
joomla_log_info "Successfully installed $path"
else
joomla_log_error "Failed to install $path"
fi
else
joomla_log_error "Invalid Path: $path"
fi
}
# Function to validate necessary environment variables
joomla_validate_vars() {
# Basic email regex for validation
local email_regex="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$"
# Check if JOOMLA_SITE_NAME is longer than 2 characters
if [[ "${#JOOMLA_SITE_NAME}" -le 2 ]]; then
joomla_log_error "JOOMLA_SITE_NAME must be longer than 2 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_USER is longer than 2 characters
if [[ "${#JOOMLA_ADMIN_USER}" -le 2 ]]; then
joomla_log_error "JOOMLA_ADMIN_USER must be longer than 2 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_USERNAME has no spaces, and is only alphabetical
if [[ "${JOOMLA_ADMIN_USERNAME}" =~ [^a-zA-Z] ]]; then
joomla_log_error "JOOMLA_ADMIN_USERNAME must contain no spaces and be only alphabetical!"
return 1
fi
# Check if JOOMLA_ADMIN_PASSWORD is longer than 12 characters
if [[ "${#JOOMLA_ADMIN_PASSWORD}" -le 12 ]]; then
joomla_log_error "JOOMLA_ADMIN_PASSWORD must be longer than 12 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_EMAIL is a valid email
if [[ ! "${JOOMLA_ADMIN_EMAIL}" =~ $email_regex ]]; then
joomla_log_error "JOOMLA_ADMIN_EMAIL must be a valid email address!"
return 1
fi
return 0
}
# Function to check if auto deploy can be done
joomla_can_auto_deploy() {
if [[ -n "${JOOMLA_SITE_NAME}" && -n "${JOOMLA_ADMIN_USER}" &&
-n "${JOOMLA_ADMIN_USERNAME}" && -n "${JOOMLA_ADMIN_PASSWORD}" &&
-n "${JOOMLA_ADMIN_EMAIL}" ]]; then
if joomla_validate_vars; then
return 0
fi
fi
return 1
}
if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
uid="$(id -u)" uid="$(id -u)"
gid="$(id -g)" gid="$(id -g)"
@ -16,8 +192,8 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
# strip off any '#' symbol ('#1000' is valid syntax for Apache) # strip off any '#' symbol ('#1000' is valid syntax for Apache)
pound='#' pound='#'
user="${user#$pound}" user="${user#"$pound"}"
group="${group#$pound}" group="${group#"$pound"}"
# set user if not exist # set user if not exist
if ! id "$user" &>/dev/null; then if ! id "$user" &>/dev/null; then
@ -43,35 +219,40 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
group="$gid" group="$gid"
fi fi
# start Joomla message block
joomla_echo_line_start
if [ -n "$MYSQL_PORT_3306_TCP" ]; then if [ -n "$MYSQL_PORT_3306_TCP" ]; then
if [ -z "$JOOMLA_DB_HOST" ]; then if [ -z "$JOOMLA_DB_HOST" ]; then
JOOMLA_DB_HOST='mysql' JOOMLA_DB_HOST='mysql'
else else
echo >&2 "warning: both JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP found" joomla_log_warning "both JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP found"
echo >&2 " Connecting to JOOMLA_DB_HOST ($JOOMLA_DB_HOST)" joomla_log "Connecting to JOOMLA_DB_HOST ($JOOMLA_DB_HOST)"
echo >&2 " instead of the linked mysql container" joomla_log "instead of the linked mysql container"
fi fi
fi fi
if [ -z "$JOOMLA_DB_HOST" ]; then if [ -z "$JOOMLA_DB_HOST" ]; then
echo >&2 "error: missing JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP environment variables" joomla_log_error "Missing JOOMLA_DB_HOST and MYSQL_PORT_3306_TCP environment variables."
echo >&2 " Did you forget to --link some_mysql_container:mysql or set an external db" joomla_log "Did you forget to --link some_mysql_container:mysql or set an external db"
echo >&2 " with -e JOOMLA_DB_HOST=hostname:port?" joomla_log "with -e JOOMLA_DB_HOST=hostname:port?"
# end Joomla message block
joomla_echo_line_end
exit 1 exit 1
fi fi
# If the DB user is 'root' then use the MySQL root password env var # If the DB user is 'root' then use the MySQL root password env var
: "${JOOMLA_DB_USER:=root}" : "${JOOMLA_DB_USER:=root}"
if [ "$JOOMLA_DB_USER" = 'root' ]; then if [ "$JOOMLA_DB_USER" = 'root' ]; then
: ${JOOMLA_DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD} : "${JOOMLA_DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD}"
fi fi
: "${JOOMLA_DB_NAME:=joomla}" : "${JOOMLA_DB_NAME:=joomla}"
if [ -z "$JOOMLA_DB_PASSWORD" ] && [ "$JOOMLA_DB_PASSWORD_ALLOW_EMPTY" != 'yes' ]; then if [ -z "$JOOMLA_DB_PASSWORD" ] && [ "$JOOMLA_DB_PASSWORD_ALLOW_EMPTY" != 'yes' ]; then
echo >&2 "error: missing required JOOMLA_DB_PASSWORD environment variable" joomla_log_error "Missing required JOOMLA_DB_PASSWORD environment variable."
echo >&2 " Did you forget to -e JOOMLA_DB_PASSWORD=... ?" joomla_log "Did you forget to -e JOOMLA_DB_PASSWORD=... ?"
echo >&2 joomla_log "(Also of interest might be JOOMLA_DB_USER and JOOMLA_DB_NAME.)"
echo >&2 " (Also of interest might be JOOMLA_DB_USER and JOOMLA_DB_NAME.)" # end Joomla message block
joomla_echo_line_end
exit 1 exit 1
fi fi
@ -81,9 +262,9 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
chown "$user:$group" . chown "$user:$group" .
fi fi
echo >&2 "Joomla not found in $PWD - copying now..." joomla_log_info "Joomla not found in $PWD - copying now..."
if [ "$(ls -A)" ]; then if [ "$(ls -A)" ]; then
echo >&2 "WARNING: $PWD is not empty - press Ctrl+C now if this is an error!" joomla_log_warning "$PWD is not empty - press Ctrl+C now if this is an error!"
( (
set -x set -x
ls -A ls -A
@ -112,144 +293,18 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
if [ ! -e .htaccess ]; then if [ ! -e .htaccess ]; then
# NOTE: The "Indexes" option is disabled in the php:apache base image so remove it as we enable .htaccess # NOTE: The "Indexes" option is disabled in the php:apache base image so remove it as we enable .htaccess
sed -r 's/^(Options -Indexes.*)$/#\1/' htaccess.txt >.htaccess sed -r 's/^(Options -Indexes.*)$/#\1/' htaccess.txt > .htaccess
chown "$user":"$group" .htaccess chown "$user:$group" .htaccess
fi fi
echo >&2 "Complete! Joomla has been successfully copied to $PWD" joomla_log "Complete! Joomla has been successfully copied to $PWD"
fi fi
# Ensure the MySQL Database is created # Ensure the MySQL Database is created
php /makedb.php "$JOOMLA_DB_HOST" "$JOOMLA_DB_USER" "$JOOMLA_DB_PASSWORD" "$JOOMLA_DB_NAME" "${JOOMLA_DB_TYPE:-mysqli}" php /makedb.php "$JOOMLA_DB_HOST" "$JOOMLA_DB_USER" "$JOOMLA_DB_PASSWORD" "$JOOMLA_DB_NAME" "${JOOMLA_DB_TYPE:-mysqli}"
# Basic email regex for validation # if the (installation) directory exists and we can auto deploy
email_regex="^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$" if [ -d installation ] && [ -e installation/joomla.php ] && joomla_can_auto_deploy; then
# Function to validate environment variables
validate_vars() {
# Check if JOOMLA_SITE_NAME is longer than 2 characters
if [[ "${#JOOMLA_SITE_NAME}" -le 2 ]]; then
echo >&2 "Error: JOOMLA_SITE_NAME must be longer than 2 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_USER is longer than 2 characters
if [[ "${#JOOMLA_ADMIN_USER}" -le 2 ]]; then
echo >&2 "Error: JOOMLA_ADMIN_USER must be longer than 2 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_USERNAME has no spaces, and is only alphabetical
if [[ "${JOOMLA_ADMIN_USERNAME}" =~ [^a-zA-Z] ]]; then
echo >&2 "Error: JOOMLA_ADMIN_USERNAME must contain no spaces and be only alphabetical!"
return 1
fi
# Check if JOOMLA_ADMIN_PASSWORD is longer than 12 characters
if [[ "${#JOOMLA_ADMIN_PASSWORD}" -le 12 ]]; then
echo >&2 "Error: JOOMLA_ADMIN_PASSWORD must be longer than 12 characters!"
return 1
fi
# Check if JOOMLA_ADMIN_EMAIL is a valid email
if [[ ! "${JOOMLA_ADMIN_EMAIL}" =~ $email_regex ]]; then
echo >&2 "Error: JOOMLA_ADMIN_EMAIL must be a valid email address!"
return 1
fi
# If all checks passed, return 0
return 0
}
# Function to check that auto deploy can be done
can_auto_deploy() {
# Check if all NEEDED variables exist
if [[ -n "${JOOMLA_SITE_NAME}" && -n "${JOOMLA_ADMIN_USER}" &&
-n "${JOOMLA_ADMIN_USERNAME}" && -n "${JOOMLA_ADMIN_PASSWORD}" &&
-n "${JOOMLA_ADMIN_EMAIL}" ]]; then
# All variables exist. Now validate them.
if validate_vars; then
# If all checks passed, return 0
return 0
fi
fi
# If any needed variables does not exist fail, return 1
return 1
}
# Function to validate URLs
joomla_validate_url() {
if [[ $1 =~ ^http(s)?://[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}(/.*)?$ ]]; then
return 0
else
return 1
fi
}
# Function to validate file path
joomla_validate_path() {
if [[ -f $1 ]]; then
return 0
else
return 1
fi
}
# Function to split values by semicolon
joomla_get_array_by_semicolon() {
local input=$1 # The input string to be split
local -n arr=$2 # The array to store the split values (passed by reference)
local old_IFS=$IFS # Save the original IFS value
# shellcheck disable=SC2034
# passed by reference
IFS=';' read -ra arr <<< "$input" # Split the input by semicolon and store in array
IFS=$old_IFS # Restore the original IFS value
}
# Function to split values by colon to get host and port
joomla_get_host_port_by_colon() {
local input=$1 # The input string to be split
local -n hostname=$2 # The variable to store the hostname (passed by reference)
local -n port=$3 # The variable to store the port (passed by reference)
local old_IFS=$IFS # Save the original IFS value
# shellcheck disable=SC2034
# passed by reference
IFS=':' read -r hostname port <<< "$input" # Split the input by colon and store in hostname and port
IFS=$old_IFS # Restore the original IFS value
}
# Function to install extension from URL
joomla_install_extension_via_url() {
local url=$1
if joomla_validate_url "$url"; then
if php cli/joomla.php extension:install --url "$url" --no-interaction; then
echo >&2 "Info: Successfully installed $url"
else
echo >&2 "Error: Failed to install $url"
fi
else
echo >&2 "Error: Invalid URL: $url"
fi
}
# Function to install extension from path
joomla_install_extension_via_path() {
local path=$1
if joomla_validate_path "$path"; then
if php cli/joomla.php extension:install --path "$path" --no-interaction; then
echo >&2 "Info: Successfully installed $path"
else
echo >&2 "Error: Failed to install $path"
fi
else
echo >&2 "Error: Invalid Path: $path"
fi
}
# if the directory exists and we can auto deploy
if [ -d installation ] && [ -e installation/joomla.php ] && can_auto_deploy; then
# use full commands # use full commands
# for clearer intent # for clearer intent
installJoomlaArgs=( installJoomlaArgs=(
@ -269,13 +324,10 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
# Run the auto deploy (install) # Run the auto deploy (install)
if php installation/joomla.php install "${installJoomlaArgs[@]}"; then if php installation/joomla.php install "${installJoomlaArgs[@]}"; then
# The PHP command succeeded (so we remove the installation folder) # The PHP command succeeded (so we remove the installation folder)
rm -rf installation rm -rf installation
echo >&2 "========================================================================" joomla_log_configured_success_message
echo >&2
echo >&2 "This server is now configured to run Joomla!"
# Install any extensions found in the extensions urls env # Install any extensions found in the extensions urls env
if [[ -n "${JOOMLA_EXTENSIONS_URLS}" && "${#JOOMLA_EXTENSIONS_URLS}" -gt 2 ]]; then if [[ -n "${JOOMLA_EXTENSIONS_URLS}" && "${#JOOMLA_EXTENSIONS_URLS}" -gt 2 ]]; then
@ -297,52 +349,37 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
joomla_get_host_port_by_colon "$JOOMLA_SMTP_HOST" JOOMLA_SMTP_HOST JOOMLA_SMTP_HOST_PORT joomla_get_host_port_by_colon "$JOOMLA_SMTP_HOST" JOOMLA_SMTP_HOST JOOMLA_SMTP_HOST_PORT
fi fi
# add the smtp host to configuration file
if [[ -n "${JOOMLA_SMTP_HOST}" && "${#JOOMLA_SMTP_HOST}" -gt 2 ]]; then if [[ -n "${JOOMLA_SMTP_HOST}" && "${#JOOMLA_SMTP_HOST}" -gt 2 ]]; then
chmod +w configuration.php chmod +w configuration.php
sed -i "s/public \$mailer = 'mail';/public \$mailer = 'smtp';/g" configuration.php sed -i "s/public \$mailer = 'mail';/public \$mailer = 'smtp';/g" configuration.php
sed -i "s/public \$smtphost = 'localhost';/public \$smtphost = '${JOOMLA_SMTP_HOST}';/g" configuration.php sed -i "s/public \$smtphost = 'localhost';/public \$smtphost = '${JOOMLA_SMTP_HOST}';/g" configuration.php
fi fi
# add the smtp port to configuration file
if [[ -n "${JOOMLA_SMTP_HOST_PORT}" ]]; then if [[ -n "${JOOMLA_SMTP_HOST_PORT}" ]]; then
sed -i "s/public \$smtpport = 25;/public \$smtpport = ${JOOMLA_SMTP_HOST_PORT};/g" configuration.php sed -i "s/public \$smtpport = 25;/public \$smtpport = ${JOOMLA_SMTP_HOST_PORT};/g" configuration.php
fi fi
# fix the configuration.php ownership # fix the configuration.php ownership
if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' configuration.php)" != "$user:$group" ]; then if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' configuration.php)" != "$user:$group" ]; then
# Set configuration to correct owner # Set the correct ownership of all files touched during installation
if ! chown "$user:$group" configuration.php; then if ! chown -R "$user:$group" .; then
echo >&2 joomla_log_error "Ownership of all files touched during installation failed to be corrected."
echo >&2 "Error: Ownership of configuration.php failed to be corrected."
fi fi
# Set configuration to correct permissions # Set configuration to correct permissions
if ! chmod 444 configuration.php; then if ! chmod 444 configuration.php; then
echo >&2 joomla_log_error "Permissions of configuration.php failed to be corrected."
echo >&2 "Error: Permissions of configuration.php failed to be corrected."
fi fi
fi fi
echo >&2
echo >&2 "========================================================================"
else
echo >&2 "========================================================================"
echo >&2
echo >&2 "This server is now configured to run Joomla!"
echo >&2
echo >&2 "NOTE: You will need your database server address, database name,"
echo >&2 "and database user credentials to install Joomla."
echo >&2
echo >&2 "========================================================================"
fi
else else
echo >&2 "========================================================================" joomla_log_success_and_need_db_message
echo >&2
echo >&2 "This server is now configured to run Joomla!"
echo >&2
echo >&2 "NOTE: You will need your database server address, database name,"
echo >&2 "and database user credentials to install Joomla."
echo >&2
echo >&2 "========================================================================"
fi fi
else
joomla_log_success_and_need_db_message
fi
# end Joomla message block
joomla_echo_line_end
fi fi
exec "$@" exec "$@"