heroku-php-nginx

#!/usr/bin/env bash

# fail hard
set -o pipefail
# fail harder
set -eu
# for ${DOCUMENT_ROOT%%*(/)} pattern further down
shopt -s extglob
# for detecting when -l 'logs/*.log' matches nothing
shopt -s nullglob

verbose=

php_passthrough() {
    local dir=$(dirname "$1")
    local file=$(basename "$1")
    local out=$(basename "$file" .php)
    if [[ "$out" != "$file" ]]; then
        [[ $verbose ]] && echo "Interpreting ${1#$HEROKU_APP_DIR/} to $out" >&2
        out="$dir/$out"
        php "$1" > "$out"
        echo "$out"
    else
        echo "$1"
    fi
}

check_exists() {
    if [[ ! -f "$HEROKU_APP_DIR/$1" ]]; then
        echo "Cannot read -$2 '$1' (relative to '$HEROKU_APP_DIR')" >&2
        exit 1
    else
        echo "$HEROKU_APP_DIR/$1"
    fi
}

touch_log() {
    mkdir -p $(dirname "$1") && touch "$1"
}

print_help() {
echo "\
${1:-Boots PHP-FPM together with Nginx on Heroku and for local development.}

Usage:
  heroku-php-nginx [options] [<DOCUMENT_ROOT>]

Options:
  -C <nginx.inc.conf>     The path to the configuration file to include inside
                          the Nginx server config (see option -c below). Will
                          be included inside the 'server { ... }' block just
                          after the 'listen', 'root' etc directives.
                          Recommended approach when customizing Nginx's config
                          in most cases, unless you need to set http or
                          fundamental server level options.
                          [default: \$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/nginx/default_include.conf.php]
  -c <nginx.conf>         The path to the full configuration file that is
                          included after Heroku's (or your local) Nginx config
                          is loaded. It must contain an 'http { ... }' block
                          with a 'server { ... }' inside that contains 'listen'
                          and 'root' (see option -C above), but no global,
                          directives (globals are read from the system's default
                          Nginx configuration files).
                          [default: \$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/nginx/heroku.conf.php]
  -F <php-fpm.inc.conf>   The path to the configuration file to include at the  
                          end of php-fpm.conf (see option -f below), in the
                          '[www]' pool section. Recommended approach when
                          customizing PHP-FPM's configuration in most cases,
                          unless you need to set global options.
  -f <php-fpm.conf>       The path to the full PHP-FPM configuration file.
                          [default: \$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/php/php-fpm.conf]
  -h, --help              Display this help screen and exit.
  -i <php.ini>            The path to the php.ini file to use.
                          [default: \$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/php/php.ini]
  -l <tailme.log>         Path to additional log file to tail to STDERR so its
                          contents appear in 'heroku logs'. If the file does not
                          exist, it will be created. Wildcards are allowed, but
                          must be quoted and must match already existing files.
                          Note: this option can be repeated multiple times.
  -p <PORT>               Port to listen on for HTTP traffic. If this argument
                          is not given, then the port number to use is read from
                          the \$PORT environment variable, or a random port is
                          chosen if that variable does not exist.
  -v, --verbose           Be more verbose during startup.

All file paths must be relative to '$HEROKU_APP_DIR'.

Any file name that ends in '.php' will be run through the PHP interpreter first.
You may use this for templating; this is, for instance, necessary for Nginx,
where environment variables cannot be referenced in configuration files.

If you would like to use the -C and -c or -F and -f options together, make sure
you retain the appropriate include mechanisms (see default configs for details).
" >&2
}

# we need this in configs
export HEROKU_APP_DIR=$(pwd)
export DOCUMENT_ROOT="$HEROKU_APP_DIR"
# set a default port if none is given
export PORT=${PORT:-$(( $RANDOM+1024 ))}

# init logs array here as empty before parsing options; -l could append to it, but the default list gets added later since we use $PORT in there and that can be set using -p
declare -a logs

optstring=":-:C:c:F:f:i:l:p:vh"

# process flags first
while getopts "$optstring" opt; do
    case $opt in
        -)
            case "$OPTARG" in
                verbose)
                    verbose=1
                    ;;
                help)
                    print_help 2>&1
                    exit
                    ;;
                *)
                    echo "Invalid option: --$OPTARG" >&2
                    exit
                    ;;
            esac
            ;;
        v)
            verbose=1
            ;;
        h)
            print_help 2>&1
            exit
            ;;
    esac
done

OPTIND=1 # start over with options parsing
while getopts "$optstring" opt; do
    case $opt in
        C)
            nginx_config_include=$(check_exists "$OPTARG" "C")
            ;;
        c)
            nginx_config=$(check_exists "$OPTARG" "c")
            ;;
        F)
            fpm_config_include=$(check_exists "$OPTARG" "F")
            ;;
        f)
            fpm_config=$(check_exists "$OPTARG" "f")
            ;;
        i)
            php_config=$(check_exists "$OPTARG" "i")
            ;;
        l)
            logarg=( $OPTARG ) # must not quote this or wildcards won't get expanded into individual values
            if [[ ${#logarg[@]} -eq 0 ]]; then # we set nullglob to detect if a pattern matched nothing (then the array is empty)
                echo "Pattern '$OPTARG' passed to option -l matched no files" >&2
                exit 1
            fi
            for logfile in "${logarg[@]}"; do
                if [[ -d "$logfile" ]]; then
                    echo "-l '$logfile': is a directory" >&2
                    exit 1
                fi
                touch_log "$logfile" || { echo "Could not touch '$logfile'; permissions problem?" >&2; exit 1; }
                [[ $verbose ]] && echo "Tailing '$logfile' to stderr" >&2
                logs+=("$logfile") # must quote here in case a wildcard matched a file with a space in the name
            done
            ;;
        p)
            PORT="$OPTARG"
            ;;
        \?)
            echo "Invalid option: -$OPTARG" >&2
            exit 2
            ;;
        :)
            echo "Option -$OPTARG requires an argument" >&2
            exit 2
            ;;
    esac
done
# clear processed arguments
shift $((OPTIND-1))

if [[ "$#" -gt "1" ]]; then
    print_help "$0: too many arguments. If you're using options,
make sure to list them before any document root argument you're providing."
    exit 2
fi

# our standard logs
logs+=( "/tmp/heroku.php-fpm.$PORT.log" "/tmp/heroku.php-fpm.www.$PORT.log" "/tmp/heroku.php-fpm.$PORT.www.slowlog" "/tmp/heroku.nginx_access.$PORT.log" )

php() {
    # the newrelic extension logs to stderr which would pollute boot output with each invocation of PHP, and each call to PHP would be logged to NR as non-web traffic, so we disable it for the next few CLI calls
    `which php` -dnewrelic.enabled=0 -dnewrelic.loglevel=error -dnewrelic.daemon.dont_launch=3 -dnewrelic.daemon.loglevel=error "$@"
}
php-fpm() {
    # the newrelic extension logs to stderr which would pollute boot output with each invocation of php-fpm, and each call to php-fpm would be logged to NR as non-web traffic, so we disable it for the next version check call
    `which php-fpm` -dnewrelic.enabled=0 -dnewrelic.loglevel=error -dnewrelic.daemon.dont_launch=3 -dnewrelic.daemon.loglevel=error "$@"
}
php -r 'exit((int)version_compare(PHP_VERSION, "5.5.11", "<"));' || { echo "This program requires PHP 5.5.11 or newer; check your 'php' command." >&2; exit 1; }
{ php-fpm -v | php -r 'exit((int)version_compare(preg_replace("#PHP (\S+) \(fpm-fcgi\).+$#sm", "\\1", file_get_contents("php://stdin")), "5.5.11", "<"));'; } || { echo "This program requires PHP 5.5.11 or newer; check your 'php-fpm' command." >&2; exit 1; }
unset -f php-fpm # remove the alias we made earlier that would prevent newrelic from starting on php-fpm -v

# make sure we run a local composer.phar if present, or global composer if not
composer() {
    local composer_bin=$(which ./composer.phar composer | head -n1)
    # check if we the composer binary is executable by PHP
    if file --brief --dereference $composer_bin | grep "bash" > /dev/null ; then # newer versions of file return "data" for .phar
        # run it directly; it's probably a bash script or similar (homebrew-php does this)
        $composer_bin "$@"
    else
        php $composer_bin "$@"
    fi
}
COMPOSER_VENDOR_DIR=$(composer config vendor-dir 2> /dev/null | tail -n 1) && export COMPOSER_VENDOR_DIR || { echo "Unable to determine Composer vendor-dir setting; is 'composer' executable on path or 'composer.phar' in current working directory?" >&2; exit 1; } # tail, as composer echos outdated version warnings to STDOUT; export after the assignment or exit status will that be of 'export
COMPOSER_BIN_DIR=$(composer config bin-dir 2> /dev/null | tail -n 1) && export COMPOSER_BIN_DIR || { echo "Unable to determine Composer vendor-dir setting; is 'composer' executable on path or 'composer.phar' in current working directory?" >&2; exit 1; } # tail, as composer echos outdated version warnings to STDOUT; export after the assignment or exit status will that be of 'export

[[ -z ${DYNO:-} || $verbose ]] && echo "Booting on port $PORT..." >&2

if [[ "$#" == "1" ]]; then
    DOCUMENT_ROOT="$HEROKU_APP_DIR/$1"
    if [[ ! -d "$DOCUMENT_ROOT" ]]; then
        echo "DOCUMENT_ROOT '$1' does not exist" >&2
        exit 1
    else
        # strip trailing slashes if present
        DOCUMENT_ROOT=${DOCUMENT_ROOT%%*(/)} # powered by extglob
        if [[ $verbose ]]; then
            echo "DOCUMENT_ROOT changed to '$DOCUMENT_ROOT'" >&2
        else
            echo "DOCUMENT_ROOT changed to '${1%%*(/)}/'" >&2
        fi
    fi
fi

if [[ -n ${fpm_config_include:-} ]]; then
    echo "Using PHP-FPM configuration include '${fpm_config_include#$HEROKU_APP_DIR/}'" >&2
    fpm_config_include=$(php_passthrough "$fpm_config_include")
    export HEROKU_PHP_FPM_CONFIG_INCLUDE="$fpm_config_include"
fi

if [[ -n ${fpm_config:-} || ( ${fpm_config:="$HEROKU_APP_DIR/$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/php/php-fpm.conf"} && $verbose ) ]]; then
    echo "Using PHP-FPM configuration file '${fpm_config#$HEROKU_APP_DIR/}'" >&2
fi
fpm_config=$(php_passthrough "$fpm_config")

if [[ -n ${php_config:-} || ( ${php_config:="$HEROKU_APP_DIR/$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/php/php.ini"} && $verbose ) ]]; then
    echo "Using PHP configuration (php.ini) file '${php_config#$HEROKU_APP_DIR/}'" >&2
fi
php_config=$(php_passthrough "$php_config")

if [[ -n ${nginx_config_include:-} || ( ${nginx_config_include:="$HEROKU_APP_DIR/$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/nginx/default_include.conf.php"} && $verbose ) ]]; then
    echo "Using Nginx server-level configuration include '${nginx_config_include#$HEROKU_APP_DIR/}'" >&2
fi
nginx_config_include=$(php_passthrough "$nginx_config_include")
export HEROKU_PHP_NGINX_CONFIG_INCLUDE="$nginx_config_include"

if [[ -n ${nginx_config:-} || ( ${nginx_config:="$HEROKU_APP_DIR/$COMPOSER_VENDOR_DIR/heroku/heroku-buildpack-php/conf/nginx/heroku.conf.php"} && $verbose) ]]; then
    echo "Using Nginx configuration file '${nginx_config#$HEROKU_APP_DIR/}'" >&2
fi
nginx_config=$(php_passthrough "$nginx_config")

if [[ -z ${WEB_CONCURRENCY:-} ]]; then
    maxprocs=$(ulimit -u)
    ram="512M"
    if [[ -z ${DYNO:-} ]]; then
        # not on a dyno
        [[ $verbose ]] && echo "Assuming settings for 1X dyno..." >&2
    elif [[ "$maxprocs" == "32768" ]]; then
        echo "Optimizing settings for PX dyno..." >&2
        ram="6G"
    elif [[ "$maxprocs" == "512" ]]; then
        echo "Optimizing settings for 2X dyno..." >&2
        ram="1G"
    else
        if [[ "$maxprocs" == "256" ]]; then
            echo "Optimizing settings for 1X dyno..." >&2
        else
            echo "Falling back to settings for 1X dyno..." >&2
        fi
    fi

    # determine number of FPM processes to run
    read WEB_CONCURRENCY php_memory_limit <<<$(hhvm "${php_configs[@]}" $(composer config vendor-dir 2> /dev/null | tail -n 1)/heroku/heroku-buildpack-php/bin/util/autotune.php "$ram") # tail, as composer echos outdated version warnings to STDOUT
    [[ $WEB_CONCURRENCY -lt 1 ]] && WEB_CONCURRENCY=1
    export WEB_CONCURRENCY
    
    echo "Running ${WEB_CONCURRENCY} workers at ${php_memory_limit}B memory limit."
else
    echo "Running ${WEB_CONCURRENCY} workers as per \$WEB_CONCURRENCY"
fi

# make a shared pipe; we'll write the name of the process that exits to it once that happens, and wait for that event below
# this particular call works on Linux and Mac OS (will create a literal ".XXXXXX" on Mac, but that doesn't matter).
wait_pipe=$(mktemp -t "heroku.waitpipe-$PORT.XXXXXX" -u)
rm -f $wait_pipe
mkfifo $wait_pipe
exec 3<> $wait_pipe

pids=()

# trap SIGQUIT (ctrl+\ on the console), SIGTERM (when we get killed) and EXIT (upon failure of any command due to set -e, or because of the exit 1 at the very end), we then
# 1) restore the EXIT trap so it doesn't fire again a loop due to the exit at the end (if we're handling SIGQUIT or SIGTERM)
# 2) remove our FIFO from above
# 3) kill all the subshells we've spawned - they in turn have their own traps to kill their respective subprocesses
# 3a) send STDERR to /dev/null so we don't see "no such process" errors - after all, one of the subshells may be gone
# 3b) || true so that set -e doesn't cause a mess if the kill returns 1 on "no such process" cases (which is likely)
# 4) exit in case we're handling SIGQUIT or SIGTERM
trap 'trap - EXIT; echo "Going down, terminating child processes..." >&2; rm -f ${wait_pipe} || true; kill -TERM "${pids[@]}" 2> /dev/null || true; exit' QUIT TERM EXIT
# trap SIGINT (ctrl+c on the console)
# 1) restore the INT trap so it doesn't fire in a loop due to 2)
# 2) be nice to the caller and send SIGINT to ourselves (http://mywiki.wooledge.org/SignalTrap#Special_Note_On_SIGINT)
# 3) *do* exit after all to run the cleanup code from above (avoids duplication)
trap 'trap - INT; kill -INT $$; exit' INT

# we are now launching a subshell for each of the tasks (log tail, app server, web server)
# 1) each subshell has a trap on EXIT that echos the command name to FD 3 (see the FIFO set up above)
# 1a) a 'read' at the end of the script will block on reading from that FD and then trigger the exit trap above, which does the cleanup
# 2) each subshell also has a trap on TERM that
# 2a) kills $! (the last process executed)
# 2b) ... which in turn will unblock the 'wait' in 4)
# 3) execute the command in the background
# 4) 'wait' on the command (wait is interrupted by an incoming TERM to the subshell, whereas running 3) in the foreground would wait for that 3) to finish before triggering the trap)
# 5) add the PID of the subshell to the array that the EXIT trap further above uses to clean everything up

[[ $verbose ]] && echo "Starting log redirection..." >&2
(
    # the TERM trap here is special, because
    # 1) there is a pipeline from tail to sed
    # 2) we thus need to kill several children
    # 3) kill $! will no longer do the job in that case
    # 4) job control (set -m, where we could then kill %% instead) has weird side effects e.g. on ctrl+c (kills the parent terminal after that too)
    # 5) so we try to kill all currently running jobs
    # 5a) gracefully, by redirecting STDERR to /dev/null - one of the children will already be gone
    # 6) the sed with the Darwin/GNU sed arg case used to be a function, but that was even worse with an extra wrapping subshell for sed
    # FIXME: fires when the subshell or the tail is killed, but not when the sed is killed, because... pipes :(
    trap 'echo "tail" >&3;' EXIT
    trap 'jobs -p | xargs -n1 kill -TERM 2> /dev/null' TERM
    touch "${logs[@]}"
    if [[ $(uname) == "Darwin" ]]; then
        sedbufarg="-l" # mac/bsd sed: -l buffers on line boundaries
    else
        sedbufarg="-u" # unix/gnu sed: -u unbuffered (arbitrary) chunks of data
    fi
    tail -qF -n 0 "${logs[@]}" | sed $sedbufarg -E 's/^\[[^]]+\] WARNING: \[pool [^]]+\] child [0-9]+ said into std(err|out): "(.*)"$/\2/' 1>&2 &
    wait
) & pids+=($!)

echo "Starting php-fpm..." >&2
(
    trap 'echo "php-fpm" >&3;' EXIT
    trap 'kill -TERM $! 2> /dev/null' TERM
    php-fpm --nodaemonize -y "$fpm_config" -c "$php_config" &
    wait
) & pids+=($!)

# wait a few seconds for FPM to finish initializing; otherwise an early request might break Apache with the FastCGI pipe not being ready
sleep 2

echo "Starting nginx..." >&2
(
    trap 'echo "nginx" >&3;' EXIT
    trap 'kill -TERM $! 2> /dev/null' TERM
    nginx -g "daemon off; include $nginx_config;" &
    wait
) & pids+=($!)

# wait for something to come from the FIFO attached to FD 3, which means that the given process was killed or has failed
# this will be interrupted by a SIGTERM or SIGINT in the traps further up
# if the pipe unblocks and this executes, then we won't read it again, so if the traps further up kill the remaining subshells above, their writing to FD 3 will have no effect
read exitproc <&3
# we'll only reach this if one of the processes above has terminated
echo "Process exited unexpectedly: $exitproc" >&2

# this will trigger the EXIT trap further up and kill all remaining children
exit 1