sync with Joomla

joomla-entrypoint.sh

@@ -31,30 +31,30 @@ joomla_log_error() {
 }
 
 # Function to set a line
-joomla_line() {
+joomla_echo_line() {
     echo >&2 "========================================================================"
 }
 
 # Function to set a line at end
-joomla_line_start() {
+joomla_echo_line_start() {
-    joomla_line
+    joomla_echo_line
     echo >&2
 }
 
 # Function to set a line at end
-joomla_line_end() {
+joomla_echo_line_end() {
     echo >&2
-    joomla_line
+    joomla_echo_line
 }
 
 # Function to give final success message (1)
-joomla_success() {
+joomla_log_configured_success_message() {
     joomla_log "This server is now configured to run Joomla!"
 }
 
 # Function to give final success message (2)
-joomla_success_need_db() {
+joomla_log_success_and_need_db_message() {
-    joomla_success
+    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."
@@ -69,7 +69,7 @@ joomla_validate_url() {
     fi
 }
 
-# Function to validate paths
+# Function to validate file path
 joomla_validate_path() {
     if [[ -f $1 ]]; then
         return 0
@@ -79,14 +79,30 @@ joomla_validate_path() {
 }
 
 # Function to split values by semicolon
-joomla_split_values() {
+joomla_get_array_by_semicolon() {
-    local input=$1
+    local input=$1   # The input string to be split
-    local -n arr=$2
+    local -n arr=$2  # The array to store the split values (passed by reference)
-    IFS=';' read -ra arr <<< "$input"
+    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_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
@@ -100,7 +116,7 @@ joomla_install_from_url() {
 }
 
 # Function to install extension from path
-joomla_install_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
@@ -175,8 +191,9 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
             group="${APACHE_RUN_GROUP:-www-data}"
 
             # strip off any '#' symbol ('#1000' is valid syntax for Apache)
-            user="${user#'#'}"
+            pound='#'
-            group="${group#'#'}"
+            user="${user#"$pound"}"
+            group="${group#"$pound"}"
 
             # set user if not exist
             if ! id "$user" &>/dev/null; then
@@ -184,8 +201,8 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
                 : "${USER_NAME:=www-data}"
                 # change the user name
                 [[ "$USER_NAME" != "www-data" ]] &&
-                        usermod -l "$USER_NAME" www-data &&
+                    usermod -l "$USER_NAME" www-data &&
-                        groupmod -n "$USER_NAME" www-data
+                    groupmod -n "$USER_NAME" www-data
                 # update the user ID
                 groupmod -o -g "$user" "$USER_NAME"
                 # update the user-group ID
@@ -203,7 +220,7 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
     fi
 
     # start Joomla message block
-    joomla_line_start
+    joomla_echo_line_start
     if [ -n "$MYSQL_PORT_3306_TCP" ]; then
         if [ -z "$JOOMLA_DB_HOST" ]; then
             JOOMLA_DB_HOST='mysql'
@@ -219,21 +236,23 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
         joomla_log "Did you forget to --link some_mysql_container:mysql or set an external db"
         joomla_log "with -e JOOMLA_DB_HOST=hostname:port?"
         # end Joomla message block
-        joomla_line_end
+        joomla_echo_line_end
         exit 1
     fi
 
     # If the DB user is 'root' then use the MySQL root password env var
     : "${JOOMLA_DB_USER:=root}"
     if [ "$JOOMLA_DB_USER" = 'root' ]; then
-        : ${JOOMLA_DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD}
+        : "${JOOMLA_DB_PASSWORD:=$MYSQL_ENV_MYSQL_ROOT_PASSWORD}"
     fi
     : "${JOOMLA_DB_NAME:=joomla}"
 
     if [ -z "$JOOMLA_DB_PASSWORD" ] && [ "$JOOMLA_DB_PASSWORD_ALLOW_EMPTY" != 'yes' ]; then
-        joomla_log_error "Missing required JOOMLA_DB_PASSWORD environment variable. Did you forget to -e JOOMLA_DB_PASSWORD=... ?"
+        joomla_log_error "Missing required JOOMLA_DB_PASSWORD environment variable."
+        joomla_log "Did you forget to -e JOOMLA_DB_PASSWORD=... ?"
+        joomla_log "(Also of interest might be JOOMLA_DB_USER and JOOMLA_DB_NAME.)"
         # end Joomla message block
-        joomla_line_end
+        joomla_echo_line_end
         exit 1
     fi
 
@@ -252,7 +271,8 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
                 sleep 10
             )
         fi
-
+        # use full commands
+        # for clearer intent
         sourceTarArgs=(
             --create
             --file -
@@ -285,6 +305,8 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
 
     # if the (installation) directory exists and we can auto deploy
     if [ -d installation ] && [ -e installation/joomla.php ] && joomla_can_auto_deploy; then
+        # use full commands
+        # for clearer intent
         installJoomlaArgs=(
             --site-name="${JOOMLA_SITE_NAME}"
             --admin-email="${JOOMLA_ADMIN_EMAIL}"
@@ -305,57 +327,59 @@ if [[ "$1" == apache2* ]] || [ "$1" == php-fpm ]; then
             # The PHP command succeeded (so we remove the installation folder)
             rm -rf installation
 
-            joomla_success
+            joomla_log_configured_success_message
 
             # Install any extensions found in the extensions urls env
             if [[ -n "${JOOMLA_EXTENSIONS_URLS}" && "${#JOOMLA_EXTENSIONS_URLS}" -gt 2 ]]; then
-                joomla_split_values "$JOOMLA_EXTENSIONS_URLS" JURLS
+                joomla_get_array_by_semicolon "$JOOMLA_EXTENSIONS_URLS" J_E_URLS
-                for extension_url in "${JURLS[@]}"; do
+                for extension_url in "${J_E_URLS[@]}"; do
-                    joomla_install_from_url "$extension_url"
+                    joomla_install_extension_via_url "$extension_url"
                 done
             fi
 
             # Install any extensions found in the extensions paths env
             if [[ -n "${JOOMLA_EXTENSIONS_PATHS}" && "${#JOOMLA_EXTENSIONS_PATHS}" -gt 2 ]]; then
-                joomla_split_values "$JOOMLA_EXTENSIONS_PATHS" JPATHS
+                joomla_get_array_by_semicolon "$JOOMLA_EXTENSIONS_PATHS" J_E_PATHS
-                for extension_path in "${JPATHS[@]}"; do
+                for extension_path in "${J_E_PATHS[@]}"; do
-                    joomla_install_from_path "$extension_path"
+                    joomla_install_extension_via_path "$extension_path"
                 done
             fi
 
             if [[ -n "${JOOMLA_SMTP_HOST}" && "${JOOMLA_SMTP_HOST}" == *:* ]]; then
-                IFS=':' read -r hostname port <<< "${JOOMLA_SMTP_HOST}"
+                joomla_get_host_port_by_colon "$JOOMLA_SMTP_HOST" JOOMLA_SMTP_HOST JOOMLA_SMTP_HOST_PORT
-                JOOMLA_SMTP_HOST=$hostname
-                JOOMLA_SMTP_HOST_PORT=$port
             fi
 
+            # add the smtp host to configuration file
             if [[ -n "${JOOMLA_SMTP_HOST}" && "${#JOOMLA_SMTP_HOST}" -gt 2 ]]; then
                 chmod +w 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
             fi
 
+            # add the smtp port to configuration file
             if [[ -n "${JOOMLA_SMTP_HOST_PORT}" ]]; then
                 sed -i "s/public \$smtpport = 25;/public \$smtpport = ${JOOMLA_SMTP_HOST_PORT};/g" configuration.php
             fi
 
+            # fix the configuration.php ownership
             if [ "$uid" = '0' ] && [ "$(stat -c '%u:%g' configuration.php)" != "$user:$group" ]; then
+                # Set the correct ownership of all files touched during installation
                 if ! chown -R "$user:$group" .; then
-                    joomla_log_error "Ownership of configuration.php failed to be corrected."
+                    joomla_log_error "Ownership of all files touched during installation failed to be corrected."
                 fi
+                # Set configuration to correct permissions
                 if ! chmod 444 configuration.php; then
                     joomla_log_error "Permissions of configuration.php failed to be corrected."
                 fi
             fi
         else
-            joomla_success_need_db
+            joomla_log_success_and_need_db_message
         fi
     else
-        joomla_success_need_db
+        joomla_log_success_and_need_db_message
     fi
     # end Joomla message block
-    joomla_line_end
+    joomla_echo_line_end
 fi
 
 exec "$@"
-