Gecko [ italicatiles.com ]

Name	Size	Permission
apache	[ DIR ]	drwxr-xr-x
apache-lamp	[ DIR ]	drwxr-xr-x
apache-php-fpm	[ DIR ]	drwxr-xr-x
init	[ DIR ]	drwxr-xr-x
mariadb	[ DIR ]	drwxr-xr-x
php	[ DIR ]	drwxr-xr-x
php-mysql	[ DIR ]	drwxr-xr-x
phpmyadmin	[ DIR ]	drwxr-xr-x
varnish	[ DIR ]	drwxr-xr-x
apache-env.sh	3.48 KB	-rw-r--r--
bitnami-env.sh	414 B	-rw-r--r--
libapache.sh	32.36 KB	-rw-r--r--
libfile.sh	4.29 KB	-rw-r--r--
libfs.sh	4.66 KB	-rw-r--r--
liblog.sh	2.61 KB	-rw-r--r--
libmariadb.sh	46.25 KB	-rw-r--r--
libnet.sh	4.71 KB	-rw-r--r--
libos.sh	15.69 KB	-rw-r--r--
libpersistence.sh	4.6 KB	-rw-r--r--
libphp.sh	7.48 KB	-rw-r--r--
libphpmyadmin.sh	8.94 KB	-rw-r--r--
libservice.sh	14.13 KB	-rw-r--r--
libvalidations.sh	6.62 KB	-rw-r--r--
libvarnish.sh	5.75 KB	-rw-r--r--
libversion.sh	1.42 KB	-rw-r--r--
libwebserver.sh	15.05 KB	-rw-r--r--
mariadb-env.sh	8.47 KB	-rw-r--r--
php-env.sh	3.61 KB	-rw-r--r--
phpmyadmin-env.sh	5.43 KB	-rw-r--r--
varnish-env.sh	3.48 KB	-rw-r--r--

Code Editor : libapache.sh

#!/bin/bash
# Copyright Broadcom, Inc. All Rights Reserved.
# SPDX-License-Identifier: APACHE-2.0
#
# Bitnami Apache library

# shellcheck disable=SC1091

# Load Generic Libraries
. /opt/bitnami/scripts/libfs.sh
. /opt/bitnami/scripts/libfile.sh
. /opt/bitnami/scripts/liblog.sh
. /opt/bitnami/scripts/libos.sh
. /opt/bitnami/scripts/libvalidations.sh
. /opt/bitnami/scripts/libservice.sh

########################
# Validate settings in APACHE_* env vars
# Globals:
#   APACHE_*
# Arguments:
#   None
# Returns:
#   None
#########################
apache_validate() {
    debug "Validating settings in APACHE_* environment variables"
    local error_code=0

# Auxiliary functions
    print_validation_error() {
        error "$1"
        error_code=1
    }

check_allowed_port() {
        local port_var="${1:?missing port variable}"
        local -a validate_port_args=()
        ! am_i_root && validate_port_args+=("-unprivileged")
        validate_port_args+=("${!port_var}")
        if ! err=$(validate_port "${validate_port_args[@]}"); then
            print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}."
        fi
    }

[[ -w "$APACHE_CONF_FILE" ]] || warn "The Apache configuration file '${APACHE_CONF_FILE}' is not writable. Configurations based on environment variables will not be applied."

if [[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]]; then
        if [[ "$APACHE_HTTP_PORT_NUMBER" -eq "$APACHE_HTTPS_PORT_NUMBER" ]]; then
            print_validation_error "APACHE_HTTP_PORT_NUMBER and APACHE_HTTPS_PORT_NUMBER are bound to the same port!"
        fi
    fi

[[ -n "$APACHE_HTTP_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTP_PORT_NUMBER
    [[ -n "$APACHE_HTTPS_PORT_NUMBER" ]] && check_allowed_port APACHE_HTTPS_PORT_NUMBER

[[ "$error_code" -eq 0 ]] || exit "$error_code"
}

########################
# Configure Apache's HTTP port
# Globals:
#   APACHE_CONF_FILE, APACHE_CONF_DIR
# Arguments:
#   None
# Returns:
#   None
#########################
apache_configure_http_port() {
    local -r port=${1:?missing port}
    local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|"
    local -r server_name_exp="s|^\s*#?\s*ServerName\s+([^:\s]+)(:[0-9]+)?$|ServerName \1:${port}|"
    local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|"
    local apache_configuration

if [[ -w "$APACHE_CONF_FILE" ]]; then
        debug "Configuring port ${port} on file ${APACHE_CONF_FILE}"
        apache_configuration="$(sed -E -e "$listen_exp" -e "$server_name_exp" "$APACHE_CONF_FILE")"
        echo "$apache_configuration" > "$APACHE_CONF_FILE"
    fi

if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami.conf" ]]; then
        debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami.conf"
        apache_configuration="$(sed -E "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami.conf")"
        echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami.conf"
    fi

if [[ -w "${APACHE_VHOSTS_DIR}/00_status-vhost.conf" ]]; then
        debug "Configuring port ${port} on file ${APACHE_VHOSTS_DIR}/00_status-vhost.conf"
        apache_configuration="$(sed -E "$vhost_exp" "${APACHE_VHOSTS_DIR}/00_status-vhost.conf")"
        echo "$apache_configuration" > "${APACHE_VHOSTS_DIR}/00_status-vhost.conf"
    fi
}

########################
# Configure Apache's HTTPS port
# Globals:
#   APACHE_CONF_DIR
# Arguments:
#   None
# Returns:
#   None
#########################
apache_configure_https_port() {
    local -r port=${1:?missing port}
    local -r listen_exp="s|^\s*Listen\s+([^:]*:)?[0-9]+\s*$|Listen ${port}|"
    local -r vhost_exp="s|VirtualHost\s+([^:>]+)(:[0-9]+)|VirtualHost \1:${port}|"
    local apache_configuration

if [[ -w "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf" ]]; then
        debug "Configuring port ${port} on file ${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf"
        apache_configuration="$(sed -E -e "$listen_exp" -e "$vhost_exp" "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf")"
        echo "$apache_configuration" > "${APACHE_CONF_DIR}/bitnami/bitnami-ssl.conf"
    fi
}

########################
# Configure Apache's ServerTokens directive
# Globals:
#   APACHE_CONF_DIR
# Arguments:
#   $1 - Value for ServerTokens directive
# Returns:
#   None
#########################
apache_configure_server_tokens() {
    local -r value=${1:?missing value}
    local -r server_tokens_exp="s|^\s*ServerTokens\s+\w+\s*$|ServerTokens ${value}|"
    local apache_configuration

if [[ -w "$APACHE_CONF_FILE" ]]; then
        debug "Configuring ServerTokens ${value} on file ${APACHE_CONF_FILE}"
        apache_configuration="$(sed -E -e "$server_tokens_exp" "$APACHE_CONF_FILE")"
        echo "$apache_configuration" > "$APACHE_CONF_FILE"
    fi
}

########################
# Enable a module in the Apache configuration file
# Globals:
#   APACHE_CONF_FILE
# Arguments:
#   $1 - Module to enable
#   $2 - Path to module .so file (optional if already defined in httpd.conf)
# Returns:
#   None
#########################
apache_enable_module() {
    local -r name="${1:?missing name}"
    local -r file="${2:-}"
    local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$"
    local apache_configuration

if [[ -w "$APACHE_CONF_FILE" ]]; then
        debug "Enabling module '${name}'"
        if grep -q -E "$regex" "$APACHE_CONF_FILE"; then
            # Uncomment line if the module was already defined
            replace_in_file "$APACHE_CONF_FILE" "$regex" "\1"
        elif [[ -n "$file" ]]; then
            # Add right after the last LoadModule, so all Apache modules are organized in the same section of the file
            append_file_after_last_match "$APACHE_CONF_FILE" "^[#\s]*LoadModule" "LoadModule ${name} ${file}"
        else
            error "Module ${name} was not defined in ${APACHE_CONF_FILE}. Please specify the 'file' parameter for 'apache_enable_module'."
        fi
    fi
}

########################
# Disable a module in the Apache configuration file
# Globals:
#   APACHE_CONF_FILE
# Arguments:
#   $1 - Module to disable
# Returns:
#   None
#########################
apache_disable_module() {
    local -r name="${1:?missing name}"
    local -r file="${2:-}"
    local -r regex="[#\s]*(LoadModule\s+${name}\s+.*)$"
    local apache_configuration

if [[ -w "$APACHE_CONF_FILE" ]]; then
        debug "Disabling module '${name}'"
        replace_in_file "$APACHE_CONF_FILE" "$regex" "#\1"
    fi
}

########################
# Stop Apache
# Globals:
#   APACHE_*
# Arguments:
#   None
# Returns:
#   None
#########################
apache_stop() {
    is_apache_not_running && return
    stop_service_using_pid "$APACHE_PID_FILE"
}

########################
# Check if Apache is running
# Globals:
#   APACHE_PID_FILE
# Arguments:
#   None
# Returns:
#   Whether Apache is running
########################
is_apache_running() {
    local pid
    pid="$(get_pid_from_file "$APACHE_PID_FILE")"
    if [[ -n "$pid" ]]; then
        is_service_running "$pid"
    else
        false
    fi
}

########################
# Check if Apache is running
# Globals:
#   APACHE_PID_FILE
# Arguments:
#   None
# Returns:
#   Whether Apache is not running
########################
is_apache_not_running() {
    ! is_apache_running
}

########################
# Ensure configuration gets added to the main Apache configuration file
# Globals:
#   APACHE_*
# Arguments:
#   $1 - configuration string
#   $2 - pattern to use for checking if the configuration already exists (default: $1)
#   $3 - Apache configuration file (default: $APACHE_CONF_FILE)
# Returns:
#   None
########################
ensure_apache_configuration_exists() {
    local -r conf="${1:?conf missing}"
    local -r pattern="${2:-"$conf"}"
    local -r conf_file="${3:-"$APACHE_CONF_FILE"}"
    # Enable configuration by appending to httpd.conf
    if ! grep -E -q "$pattern" "$conf_file"; then
        if is_file_writable "$conf_file"; then
            cat >> "$conf_file" <<< "$conf"
        else
            error "Could not add the following configuration to '${conf_file}:"
            error ""
            error "$(indent "$conf" 4)"
            error ""
            error "Include the configuration manually and try again."
            return 1
        fi
    fi
}

########################
# Collect all the .htaccess files from /opt/bitnami/$name and write the result in the 'htaccess' directory
# Globals:
#   APACHE_*
# Arguments:
#   $1 - App name
#   $2 - Overwrite the original .htaccess with the explanation text (defaults to 'yes')
# Flags:
#   --document-root - Path to document root directory
# Returns:
#   None
########################
apache_replace_htaccess_files() {
    local -r app="${1:?missing app}"
    local -r result_file="${APACHE_HTACCESS_DIR}/${app}-htaccess.conf"
    # Default options
    local document_root="${BITNAMI_ROOT_DIR}/${app}"
    local overwrite="yes"
    local -a htaccess_files
    local htaccess_dir
    local htaccess_contents
    # Validate arguments
    shift
    while [[ "$#" -gt 0 ]]; do
        case "$1" in
            --document-root)
                shift
                document_root="$1"
                ;;
            --overwrite)
                shift
                overwrite="$1"
                ;;
            *)
                echo "Invalid command line flag ${1}" >&2
                return 1
                ;;
        esac
        shift
    done
    if is_file_writable "$result_file"; then
        # Locate all .htaccess files inside the document root
        read -r -a htaccess_files <<< "$(find "$document_root" -name .htaccess -print0 | xargs -0)"
        [[ "${#htaccess_files[@]}" = 0 ]] && return
        # Create file with root group write privileges, so it can be modified in non-root containers
        [[ ! -f "$result_file" ]] && touch "$result_file" && chmod g+rw "$result_file"
        for htaccess_file in "${htaccess_files[@]}"; do
            htaccess_dir="$(dirname "$htaccess_file")"
            htaccess_contents="$(indent "$(< "$htaccess_file")" 2)"
            # Skip if it was already included to the resulting htaccess file
            if grep -q "^<Directory \"$htaccess_dir\">" <<< "$htaccess_contents"; then
                continue
            fi
            # Add to the htaccess file
            cat >> "$result_file" <<EOF
<Directory "${htaccess_dir}">
${htaccess_contents}
</Directory>
EOF
            # Overwrite the original .htaccess with the explanation text
            if is_boolean_yes "$overwrite"; then
                echo "# This configuration has been moved to the ${result_file} config file for performance and security reasons" > "$htaccess_file"
            fi
        done
    elif [[ ! -f "$result_file" ]]; then
        error "Could not create htaccess for ${app} at '${result_file}'. Check permissions and ownership for parent directories."
        return 1
    else
        warn "The ${app} htaccess file '${result_file}' is not writable. Configurations based on environment variables will not be applied for this file."
        return
    fi
}

########################
# Ensure an Apache application configuration exists (in virtual host format)
# Globals:
#   APACHE_*
# Arguments:
#   $1 - App name
# Flags:
#   --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty)
#   --hosts - Host listen addresses
#   --server-name - Server name
#   --server-aliases - Server aliases (defaults to '*')
#   --allow-remote-connections - Whether to allow remote connections or to require local connections
#   --disable - Whether to render the app's virtual hosts with a .disabled prefix
#   --disable-http - Whether to render the app's HTTP virtual host with a .disabled prefix
#   --disable-https - Whether to render the app's HTTPS virtual host with a .disabled prefix
#   --http-port - HTTP port number
#   --https-port - HTTPS port number
#   --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined)
#   --additional-configuration - Additional vhost configuration (no default)
#   --additional-http-configuration - Additional HTTP vhost configuration (no default)
#   --additional-https-configuration - Additional HTTPS vhost configuration (no default)
#   --before-vhost-configuration - Configuration to add before the <VirtualHost> directive (no default)
#   --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined)
#   --document-root - Path to document root directory
#   --extra-directory-configuration - Extra configuration for the document root directory
#   --proxy-address - Address where to proxy requests
#   --proxy-configuration - Extra configuration for the proxy
#   --proxy-http-configuration - Extra configuration for the proxy HTTP vhost
#   --proxy-https-configuration - Extra configuration for the proxy HTTPS vhost
# Returns:
#   true if the configuration was enabled, false otherwise
########################
ensure_apache_app_configuration_exists() {
    local -r app="${1:?missing app}"
    # Default options
    local type=""
    local -a hosts=("127.0.0.1" "_default_")
    local server_name="www.example.com" # Default ServerName in httpd.conf
    local -a server_aliases=("*")
    local allow_remote_connections="yes"
    local disable="no"
    local disable_http="no"
    local disable_https="no"
    local move_htaccess="yes"
    # Template variables defaults
    export additional_configuration=""
    export additional_http_configuration=""
    export additional_https_configuration=""
    export before_vhost_configuration=""
    export allow_override="All"
    export document_root="${BITNAMI_ROOT_DIR}/${app}"
    export extra_directory_configuration=""
    export default_http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}"
    export default_https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}"
    export http_port="$default_http_port"
    export https_port="$default_https_port"
    export proxy_address=""
    export proxy_configuration=""
    export proxy_http_configuration=""
    export proxy_https_configuration=""
    # Validate arguments
    local var_name
    shift
    while [[ "$#" -gt 0 ]]; do
        case "$1" in
            --hosts \
            | --server-aliases)
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                shift
                read -r -a "${var_name?}" <<< "$1"
                ;;
            --disable \
            | --disable-http \
            | --disable-https \
            )
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                export "${var_name}=yes"
                ;;
            --type \
            | --server-name \
            | --allow-remote-connections \
            | --http-port \
            | --https-port \
            | --move-htaccess \
            | --additional-configuration \
            | --additional-http-configuration \
            | --additional-https-configuration \
            | --before-vhost-configuration \
            | --allow-override \
            | --document-root \
            | --extra-directory-configuration \
            | --proxy-address \
            | --proxy-configuration \
            | --proxy-http-configuration \
            | --proxy-https-configuration \
            )
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                shift
                export "${var_name}=${1}"
                ;;
            *)
                echo "Invalid command line flag $1" >&2
                return 1
                ;;
        esac
        shift
    done
    # Construct listen ports configuration (only to add when using non-standard ports)
    export http_listen_configuration=""
    export https_listen_configuration=""
    [[ "$http_port" != "$default_http_port" ]] && http_listen_configuration="Listen ${http_port}"
    [[ "$https_port" != "$default_https_port" ]] && https_listen_configuration="Listen ${https_port}"
    # Construct host string in the format of "host1:port1[ host2:port2[ ...]]"
    export http_listen_addresses=""
    export https_listen_addresses=""
    for host in "${hosts[@]}"; do
        http_listen="${host}:${http_port}"
        https_listen="${host}:${https_port}"
        [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}"
        [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}"
    done
    # Construct ServerName/ServerAlias block
    export server_name_configuration=""
    if ! is_empty_value "${server_name:-}"; then
        server_name_configuration="ServerName ${server_name}"
    fi
    if [[ "${#server_aliases[@]}" -gt 0 ]]; then
        server_name_configuration+=$'\n'"ServerAlias ${server_aliases[*]}"
    fi
    # App .htaccess support (only when type is not defined)
    export htaccess_include
    [[ -z "$type" || "$type" = "php" ]] && is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root"
    if [[ -z "$type" || "$type" = "php" ]] && [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then
        allow_override="None"
        htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\""
    else
        # allow_override is already set to the expected value
        htaccess_include=""
    fi
    # ACL configuration
    export acl_configuration
    if is_boolean_yes "$allow_remote_connections"; then
        acl_configuration="Require all granted"
    else
        acl_configuration="$(cat <<EOF
Require local
ErrorDocument 403 "For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname."
# AuthType Basic
# AuthName ${app}
# AuthUserFile "${APACHE_BASE_DIR}/users"
# Require valid-user
EOF
)"
    fi
    # Indent configurations
    server_name_configuration="$(indent $'\n'"$server_name_configuration" 2)"
    additional_configuration="$(indent $'\n'"$additional_configuration" 2)"
    additional_http_configuration="$(indent $'\n'"$additional_http_configuration" 2)"
    additional_https_configuration="$(indent $'\n'"$additional_https_configuration" 2)"
    htaccess_include="$(indent $'\n'"$htaccess_include" 2)"
    acl_configuration=""$(indent $'\n'"$acl_configuration" 4)
    extra_directory_configuration="$(indent $'\n'"$extra_directory_configuration" 4)"
    proxy_configuration="$(indent $'\n'"$proxy_configuration" 2)"
    proxy_http_configuration="$(indent $'\n'"$proxy_http_configuration" 2)"
    proxy_https_configuration="$(indent $'\n'"$proxy_https_configuration" 2)"
    # Render templates
    # We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better
    local template_name="app"
    [[ -n "$type" && "$type" != "php" ]] && template_name="app-${type}"
    local -r template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates"
    local http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf"
    local https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf"
    local -r disable_suffix=".disabled"
    ( is_boolean_yes "$disable" || is_boolean_yes "$disable_http" ) && http_vhost+="$disable_suffix"
    ( is_boolean_yes "$disable" || is_boolean_yes "$disable_https" ) && https_vhost+="$disable_suffix"
    if is_file_writable "$http_vhost"; then
        # Create file with root group write privileges, so it can be modified in non-root containers
        [[ ! -f "$http_vhost" ]] && touch "$http_vhost" && chmod g+rw "$http_vhost"
        render-template "${template_dir}/${template_name}-http-vhost.conf.tpl" | sed '/^\s*$/d' > "$http_vhost"
    elif [[ ! -f "$http_vhost" ]]; then
        error "Could not create virtual host for ${app} at '${http_vhost}'. Check permissions and ownership for parent directories."
        return 1
    else
        warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file."
    fi
    if is_file_writable "$https_vhost"; then
        # Create file with root group write privileges, so it can be modified in non-root containers
        [[ ! -f "$https_vhost" ]] && touch "$https_vhost" && chmod g+rw "$https_vhost"
        render-template "${template_dir}/${template_name}-https-vhost.conf.tpl" | sed '/^\s*$/d' > "$https_vhost"
    elif [[ ! -f "$https_vhost" ]]; then
        error "Could not create virtual host for ${app} at '${https_vhost}'. Check permissions and ownership for parent directories."
        return 1
    else
        warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file."
    fi
}

########################
# Ensure an Apache application configuration does not exist anymore (in virtual hosts format)
# Globals:
#   *
# Arguments:
#   $1 - App name
# Returns:
#   true if the configuration was disabled, false otherwise
########################
ensure_apache_app_configuration_not_exists() {
    local -r app="${1:?missing app}"
    local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf"
    local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf"
    local -r disable_suffix=".disabled"
    # Note that 'rm -f' will not fail if the files don't exist
    # However if we lack permissions to remove the file, it will result in a non-zero exit code, as expected by this function
    rm -f "$http_vhost" "$https_vhost" "${http_vhost}${disable_suffix}" "${https_vhost}${disable_suffix}"
}

########################
# Ensure Apache loads the configuration for an application in a URL prefix
# Globals:
#   APACHE_*
# Arguments:
#   $1 - App name
# Flags:
#   --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty)
#   --allow-remote-connections - Whether to allow remote connections or to require local connections
#   --move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined)
#   --prefix - URL prefix from where it will be accessible (i.e. /myapp)
#   --additional-configuration - Additional vhost configuration (no default)
#   --allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined)
#   --document-root - Path to document root directory
#   --extra-directory-configuration - Extra configuration for the document root directory
# Returns:
#   true if the configuration was enabled, false otherwise
########################
ensure_apache_prefix_configuration_exists() {
    local -r app="${1:?missing app}"
    # Default options
    local type=""
    local allow_remote_connections="yes"
    local move_htaccess="yes"
    local prefix="/${app}"
    # Template variables defaults
    export additional_configuration=""
    export allow_override="All"
    export document_root="${BITNAMI_ROOT_DIR}/${app}"
    export extra_directory_configuration=""
    # Validate arguments
    local var_name
    shift
    while [[ "$#" -gt 0 ]]; do
        case "$1" in
            --type \
            | --allow-remote-connections \
            | --move-htaccess \
            | --prefix \
            | --additional-configuration \
            | --allow-override \
            | --document-root \
            | --extra-directory-configuration \
            )
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                shift
                declare "${var_name}=${1}"
                ;;
            *)
                echo "Invalid command line flag $1" >&2
                return 1
                ;;
        esac
        shift
    done
    # App .htaccess support (only when type is not defined)
    export htaccess_include
    [[ -z "$type" || "$type" = "php" ]] && is_boolean_yes "$move_htaccess" && apache_replace_htaccess_files "$app" --document-root "$document_root"
    if [[ -z "$type" || "$type" = "php" ]] && [[ -f "${APACHE_HTACCESS_DIR}/${app}-htaccess.conf" ]]; then
        allow_override="None"
        htaccess_include="Include \"${APACHE_HTACCESS_DIR}/${app}-htaccess.conf\""
    else
        # allow_override is already set to the expected value
        htaccess_include=""
    fi
    # ACL configuration
    export acl_configuration
    if is_boolean_yes "$allow_remote_connections"; then
        acl_configuration="Require all granted"
    else
        acl_configuration="$(cat <<EOF
Require local
ErrorDocument 403 "For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname."
# AuthType Basic
# AuthName ${app}
# AuthUserFile "${APACHE_BASE_DIR}/users"
# Require valid-user
EOF
)"
    fi
    # Prefix configuration
    export prefix_conf="Alias ${prefix} \"${document_root}\""
    # Indent configurations
    acl_configuration="$(indent $'\n'"$acl_configuration" 2)"
    extra_directory_configuration="$(indent $'\n'"$extra_directory_configuration" 2)"
    # Render templates
    # We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better
    local template_name="app"
    [[ -n "$type" && "$type" != "php" ]] && template_name="app-${type}"
    local -r template_dir="${BITNAMI_ROOT_DIR}/scripts/apache/bitnami-templates"
    local -r prefix_file="${APACHE_CONF_DIR}/bitnami/${app}.conf"
    if is_file_writable "$prefix_file"; then
        # Create file with root group write privileges, so it can be modified in non-root containers
        [[ ! -f "$prefix_file" ]] && touch "$prefix_file" && chmod g+rw "$prefix_file"
        render-template "${template_dir}/${template_name}-prefix.conf.tpl" | sed '/^\s*$/d' > "$prefix_file"
        ensure_apache_configuration_exists "Include \"$prefix_file\""
    elif [[ ! -f "$prefix_file" ]]; then
        error "Could not create web server configuration file for ${app} at '${prefix_file}'. Check permissions and ownership for parent directories."
        return 1
    else
        warn "The ${app} web server configuration file '${prefix_file}' is not writable. Configurations based on environment variables will not be applied for this file."
    fi
}

########################
# Ensure Apache application configuration is updated with the runtime configuration (i.e. ports)
# Globals:
#   *
# Arguments:
#   $1 - App name
# Flags:
#   --hosts - Host listen addresses
#   --server-name - Server name
#   --server-aliases - Server aliases
#   --enable-http - Enable HTTP app configuration (if not enabled already)
#   --enable-https - Enable HTTPS app configuration (if not enabled already)
#   --disable-http - Disable HTTP app configuration (if not disabled already)
#   --disable-https - Disable HTTPS app configuration (if not disabled already)
#   --http-port - HTTP port number
#   --https-port - HTTPS port number
# Returns:
#   true if the configuration was updated, false otherwise
########################
apache_update_app_configuration() {
    local -r app="${1:?missing app}"
    # Default options
    local -a hosts=("127.0.0.1" "_default_")
    local server_name="www.example.com" # Default ServerName in httpd.conf
    local -a server_aliases=()
    local enable_http="no"
    local enable_https="no"
    local disable_http="no"
    local disable_https="no"
    export default_http_port="${APACHE_HTTP_PORT_NUMBER:-"$APACHE_DEFAULT_HTTP_PORT_NUMBER"}"
    export default_https_port="${APACHE_HTTPS_PORT_NUMBER:-"$APACHE_DEFAULT_HTTPS_PORT_NUMBER"}"
    export http_port="$default_http_port"
    export https_port="$default_https_port"
    local var_name
    # Validate arguments
    local var_name
    shift
    while [[ "$#" -gt 0 ]]; do
        case "$1" in
            --hosts \
            | --server-aliases)
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                shift
                read -r -a "${var_name?}" <<< "$1"
                ;;
            # Common flags
            --enable-http \
            | --enable-https \
            | --disable-http \
            | --disable-https \
            )
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                declare "${var_name}=yes"
                ;;
            --server-name \
            | --http-port \
            | --https-port \
            )
                var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")"
                shift
                declare "${var_name}=${1}"
                ;;

*)
                echo "Invalid command line flag $1" >&2
                return 1
                ;;
        esac
        shift
    done
    # Construct host string in the format of "host1:port1[ host2:port2[ ...]]"
    export http_listen_addresses=""
    export https_listen_addresses=""
    for host in "${hosts[@]}"; do
        http_listen="${host}:${http_port}"
        https_listen="${host}:${https_port}"
        [[ -z "${http_listen_addresses:-}" ]] && http_listen_addresses="$http_listen" || http_listen_addresses="${http_listen_addresses} ${http_listen}"
        [[ -z "${https_listen_addresses:-}" ]] && https_listen_addresses="$https_listen" || https_listen_addresses="${https_listen_addresses} ${https_listen}"
    done
    # Update configuration
    local -r http_vhost="${APACHE_VHOSTS_DIR}/${app}-vhost.conf"
    local -r https_vhost="${APACHE_VHOSTS_DIR}/${app}-https-vhost.conf"
    local -r disable_suffix=".disabled"
    # Helper function to avoid duplicating code
    update_common_vhost_config() {
        local -r vhost_file="${1:?missing virtual host}"
        # Update ServerName
        if ! is_empty_value "${server_name:-}"; then
            replace_in_file "$vhost_file" "^(\s*ServerName\s+).*" "\1${server_name}"
        fi
        # Update ServerAlias
        if [[ "${#server_aliases[@]}" -gt 0 ]]; then
            replace_in_file "$vhost_file" "^(\s*ServerAlias\s+).*" "\1${server_aliases[*]}"
        fi
    }
    # Disable and enable configuration files
    rename_conf_file() {
        local -r origin="$1"
        local -r destination="$2"
        if is_file_writable "$origin" && is_file_writable "$destination"; then
            warn "Could not rename virtual host file '${origin}' to '${destination}' due to lack of permissions."
        else
            mv "$origin" "$destination"
        fi
    }
    is_boolean_yes "$disable_http" && [[ -e "$http_vhost" ]] && rename_conf_file "${http_vhost}${disable_suffix}" "$http_vhost"
    is_boolean_yes "$disable_https" && [[ -e "$https_vhost" ]] && rename_conf_file "${https_vhost}${disable_suffix}" "$https_vhost"
    is_boolean_yes "$enable_http" && [[ -e "${http_vhost}${disable_suffix}" ]] && rename_conf_file "${http_vhost}${disable_suffix}" "$http_vhost"
    is_boolean_yes "$enable_https" && [[ -e "${https_vhost}${disable_suffix}" ]] && rename_conf_file "${https_vhost}${disable_suffix}" "$https_vhost"
    # Update only configuration files without the '.disabled' suffix
    if [[ -e "$http_vhost" ]]; then
        if is_file_writable "$http_vhost"; then
            update_common_vhost_config "$http_vhost"
            # Update vhost-specific config (listen port and addresses)
            replace_in_file "$http_vhost" "^Listen .*" "Listen ${http_port}"
            replace_in_file "$http_vhost" "^<VirtualHost\s.*>$" "<VirtualHost ${http_listen_addresses}>"
        else
            warn "The ${app} virtual host file '${http_vhost}' is not writable. Configurations based on environment variables will not be applied for this file."
        fi
    fi
    if [[ -e "$https_vhost" ]]; then
        if is_file_writable "$https_vhost"; then
            update_common_vhost_config "$https_vhost"
            # Update vhost-specific config (listen port and addresses)
            replace_in_file "$https_vhost" "^Listen .*" "Listen ${https_port}"
            replace_in_file "$https_vhost" "^<VirtualHost\s.*>$" "<VirtualHost ${https_listen_addresses}>"
        else
            warn "The ${app} virtual host file '${https_vhost}' is not writable. Configurations based on environment variables will not be applied for this file."
        fi
    fi
}

########################
# Create a password file for basic authentication and restrict its permissions
# Globals:
#   *
# Arguments:
#   $1 - file
#   $2 - username
#   $3 - password
# Returns:
#   true if the configuration was updated, false otherwise
########################
apache_create_password_file() {
    local -r file="${1:?missing file}"
    local -r username="${2:?missing username}"
    local -r password="${3:?missing password}"

"${APACHE_BIN_DIR}/htpasswd" -bc "$file" "$username" "$password"
    am_i_root && configure_permissions_ownership "$file" --file-mode "600" --user "$APACHE_DAEMON_USER" --group "$APACHE_DAEMON_GROUP"
}

${this.title}

Code Editor : libapache.sh