Adds a PHP feature (#22)

* add php

* add test

* fix test

* add to workflow

* fix test

* fix bug

* test composer

Co-authored-by: Josh Spicer <joshspicer@github.com>

5 files changed, 219 insertions, 1 deletions

diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml
index fc35c76..2a40a8c 100644
--- a/.github/workflows/test.yaml
+++ b/.github/workflows/test.yaml
@@ -27,7 +27,8 @@ jobs:
               "go", 
               "gradle", 
               "hugo", 
-              "java", 
+              "java",
+              "php",
               "python jupyterlab", # Install 'python', then 'jupyterlab'
               "kubectl-helm-minikube", 
               "maven", 
diff --git a/src/php/feature.json b/src/php/feature.json
new file mode 100644
index 0000000..e5bfd24
--- /dev/null
+++ b/src/php/feature.json
@@ -0,0 +1,31 @@
+{
+    "id": "php",
+    "name": "PHP",
+    "options": {
+        "version": {
+            "type": "string",
+            "proposals": ["latest", "8.0.16"],
+            "default": "latest",
+            "description": "Select or enter a PHP version"
+        },
+        "installComposer": {
+            "type": "boolean",
+            "default": true,
+            "description": "Install PHP Composer?"
+        }
+    },
+    "extensions": [
+        "xdebug.php-debug",
+        "bmewburn.vscode-intelephense-client",
+        "xdebug.php-pack",
+        "devsense.phptools-vscode"
+    ],
+    "containerEnv": {
+        "PHP_PATH": "/usr/local/php",
+        "PATH":"${PHP_PATH}:${PHP_PATH}/bin:${PATH}"
+    },
+    "install": {
+        "app": "",
+        "file": "install.sh"
+    }
+}
\ No newline at end of file
diff --git a/src/php/install.sh b/src/php/install.sh
new file mode 100644
index 0000000..4d4d211
--- /dev/null
+++ b/src/php/install.sh
@@ -0,0 +1,173 @@
+#!/usr/bin/env bash
+#-------------------------------------------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
+#-------------------------------------------------------------------------------------------------------------
+#
+# Maintainer: The VS Code and Codespaces Teams
+#
+# Syntax: ./php-debian.sh [PHP version] [PHP_DIR] [Add Composer flag] [Non-root user] [Add rc files flag]
+
+VERSION=${1:-"latest"}
+export PHP_DIR=${2:-"/usr/local/php"}
+INSTALL_COMPOSER=${3:-"true"}
+USERNAME=${4:-"automatic"}
+UPDATE_RC=${5:-"true"}
+
+set -eux
+export DEBIAN_FRONTEND=noninteractive
+
+if [ "$(id -u)" -ne 0 ]; then
+    echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.'
+    exit 1
+fi
+
+
+# Ensure that login shells get the correct path if the user updated the PATH using ENV.
+rm -f /etc/profile.d/00-restore-env.sh
+echo "export PATH=${PATH//$(sh -lc 'echo $PATH')/\$PATH}" > /etc/profile.d/00-restore-env.sh
+chmod +x /etc/profile.d/00-restore-env.sh
+
+# Determine the appropriate non-root user
+if [ "${USERNAME}" = "auto" ] || [ "${USERNAME}" = "automatic" ]; then
+    USERNAME=""
+    POSSIBLE_USERS=("vscode" "node" "codespace" "$(awk -v val=1000 -F ":" '$3==val{print $1}' /etc/passwd)")
+    for CURRENT_USER in ${POSSIBLE_USERS[@]}; do
+        if id -u ${CURRENT_USER} > /dev/null 2>&1; then
+            USERNAME=${CURRENT_USER}
+            break
+        fi
+    done
+    if [ "${USERNAME}" = "" ]; then
+        USERNAME=root
+    fi
+elif [ "${USERNAME}" = "none" ] || ! id -u ${USERNAME} > /dev/null 2>&1; then
+    USERNAME=root
+fi
+
+architecture="$(uname -m)"
+if [ "${architecture}" != "amd64" ] && [ "${architecture}" != "x86_64" ] && [ "${architecture}" != "arm64" ] && [ "${architecture}" != "aarch64" ]; then
+    echo "(!) Architecture $architecture unsupported"
+    exit 1
+fi
+
+updaterc() {
+    if [ "${UPDATE_RC}" = "true" ]; then
+        echo "Updating /etc/bash.bashrc and /etc/zsh/zshrc..."
+        if [[ "$(cat /etc/bash.bashrc)" != *"$1"* ]]; then
+            echo -e "$1" >> /etc/bash.bashrc
+        fi
+        if [ -f "/etc/zsh/zshrc" ] && [[ "$(cat /etc/zsh/zshrc)" != *"$1"* ]]; then
+            echo -e "$1" >> /etc/zsh/zshrc
+        fi
+    fi
+}
+
+# Checks if packages are installed and installs them if not
+check_packages() {
+    if ! dpkg -s "$@" > /dev/null 2>&1; then
+        apt-get update
+        apt-get -y install --no-install-recommends "$@"
+    fi
+}
+
+# Figure out correct version of PHP
+find_version_from_git_tags() {
+    local repository="https://github.com/php/php-src"
+    local separator="."
+    local escaped_separator=${separator//./\\.}
+    local last_part="${escaped_separator}[0-9]+"
+    local regex="\\K[0-9]+${escaped_separator}[0-9]+${last_part}$"
+    local version_list="$(git ls-remote --tags ${repository} | grep -oP "${regex}" | tr -d ' ' | tr "${separator}" "." | sort -rV)"
+    VERSION="$(echo "${version_list}" | head -n 1)"
+}
+
+# Install PHP Composer
+addcomposer() {
+    php -r "copy('https://getcomposer.org/installer', 'composer-setup.php');"
+    HASH="$(wget -q -O - https://composer.github.io/installer.sig)"
+    php -r "if (hash_file('sha384', 'composer-setup.php') === '$HASH') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
+    php composer-setup.php
+    php -r "unlink('composer-setup.php');"
+
+    mv composer.phar $PHP_DIR/composer
+    updaterc "export PHP_DIR=${PHP_DIR}"
+}
+
+# Install PHP if it's missing
+if ! php --version &> /dev/null ; then
+    # Persistent / runtime dependencies
+    RUNTIME_DEPS="wget ca-certificates git build-essential xz-utils"
+
+    # PHP dependencies
+    PHP_DEPS="libssl-dev libcurl4-openssl-dev libedit-dev libsqlite3-dev libxml2-dev zlib1g-dev libsodium-dev libargon2-dev libonig-dev"
+
+    # Dependencies required for running "phpize"
+    PHPIZE_DEPS="autoconf dpkg-dev file g++ gcc libc-dev make pkg-config re2c"
+
+    # Install dependencies
+    check_packages $RUNTIME_DEPS $PHP_DEPS $PHPIZE_DEPS
+
+    # Fetch latest version of PHP if needed
+    if [ "${VERSION}" = "latest" ] || [ "${VERSION}" = "lts" ]; then
+        find_version_from_git_tags
+    fi
+
+    PHP_URL="https://www.php.net/distributions/php-${VERSION}.tar.gz"
+
+    PHP_INI_DIR="$PHP_DIR/ini"
+    CONF_DIR="$PHP_INI_DIR/conf.d"
+    mkdir -p $CONF_DIR;
+
+    PHP_EXT_DIR="$PHP_DIR/extensions"
+    mkdir -p $PHP_EXT_DIR
+
+    PHP_SRC_DIR="/usr/src/php"
+    mkdir -p $PHP_SRC_DIR
+    cd $PHP_SRC_DIR
+    wget -O php.tar.xz "$PHP_URL"
+
+    tar -xf $PHP_SRC_DIR/php.tar.xz -C "$PHP_SRC_DIR" --strip-components=1
+    cd $PHP_SRC_DIR;
+
+    # PHP 7.4+, the pecl/pear installers are officially deprecated and are removed in PHP 8+
+    # Thus, requiring an explicit "--with-pear"
+    IFS="."
+    read -a versions <<< "$VERSION"
+    PHP_MAJOR_VERSION=${versions[0]}
+    PHP_MINOR_VERSION=${versions[1]}
+
+    VERSION_CONFIG=""
+    if (( $(($PHP_MAJOR_VERSION)) >= 8 )) || (( $(($PHP_MAJOR_VERSION)) == 7 && $(($PHP_MINOR_VERSION)) >= 4 )); then 
+        VERSION_CONFIG="--with-pear"
+    fi
+
+    ./configure --prefix="$PHP_DIR" --with-config-file-path="$PHP_INI_DIR" --with-config-file-scan-dir="$CONF_DIR" --enable-option-checking=fatal --with-curl --with-libedit --with-openssl --with-zlib --with-password-argon2 --with-sodium=shared "$VERSION_CONFIG" EXTENSION_DIR="$PHP_EXT_DIR";
+
+    make -j "$(nproc)"
+    find -type f -name '*.a' -delete
+    make install
+    find $PHP_DIR -type f -executable -exec strip --strip-all '{}' + || true
+    make clean
+
+    cp -v $PHP_SRC_DIR/php.ini-* "$PHP_INI_DIR/";
+    cp "$PHP_INI_DIR/php.ini-production" "$PHP_INI_DIR/php.ini"
+    PATH=$PATH:${PHP_DIR}/bin
+
+    # Install xdebug
+    pecl install xdebug
+    XDEBUG_INI="$CONF_DIR/xdebug.ini"
+    echo "zend_extension=$(find PHP_EXT_DIR -name xdebug.so)" > XDEBUG_INI
+    echo "xdebug.mode = debug" >> XDEBUG_INI
+    echo "xdebug.start_with_request = yes" >> XDEBUG_INI
+    echo "xdebug.client_port = 9003" >> XDEBUG_INI
+
+    # Install PHP Composer if needed
+    if [ "${INSTALL_COMPOSER}" = "true" ]; then
+        addcomposer
+    fi
+
+    updaterc "export PHP_DIR=${PHP_DIR}/bin"
+fi
+
+echo "Done!"
diff --git a/test/php/test.sh b/test/php/test.sh
new file mode 100644
index 0000000..3e4e722
--- /dev/null
+++ b/test/php/test.sh
@@ -0,0 +1,12 @@
+#!/bin/bash
+
+set -e
+
+# Optional: Import test library
+source dev-container-features-test-lib
+
+check "PHP version" php --version
+check "Composer version" composer --version
+
+# Report result
+reportResults
\ No newline at end of file
diff --git a/v1/feature-scripts.env b/v1/feature-scripts.env
index 8b7f734..68573da 100644
--- a/v1/feature-scripts.env
+++ b/v1/feature-scripts.env
@@ -21,3 +21,4 @@ _BUILD_ARG_POWERSHELL="./powershell/install.sh                              ${_B
 _BUILD_ARG_DESKTOP_LITE="./desktop-lite/install.sh                          automatic ${_BUILD_ARG_DESKTOP_LITE_PASSWORD:-vscode} true ${_BUILD_ARG_DESKTOP_LITE_VNCPORT:-5901} ${_BUILD_ARG_DESKTOP_LITE_WEBPORT:-6080}"
 _BUILD_ARG_DOTNET="./dotnet/install.sh                                      ${_BUILD_ARG_DOTNET_VERSION:-latest} ${_BUILD_ARG_DOTNET_RUNTIMEONLY:-false} automatic true /usr/local/dotnet dotnet"
 _BUILD_ARG_JUPYTERLAB="./jupyterlab/install.sh                              ${_BUILD_ARG_JUPYTERLAB_VERSION:-latest}" automatic ${_BUILD_ARG_JUPYTERLAB_PYTHONBINARY:-python}" true
+_BUILD_ARG_PHP="./php/install.sh                                            ${_BUILD_ARG_PHP_VERSION:-latest} /usr/local/php ${_BUILD_ARG_PHP_INSTALLCOMPOSER:-true} true automatic true"