mirror of
https://github.com/shivammathur/setup-php.git
synced 2026-07-24 18:10:52 -03:00
8ca9579834
Tools in the tools input can now be pinned to a checksum using the tool:version@sha256:<hash> or tool:version@sha512:<hash> syntax. The downloaded tool is verified against the checksum on all platforms, including when it is served from the tools cache, and it is removed along with its cache entry if the verification fails. Checksum verification is supported for tools downloaded as phar archives. Specifying a checksum for tools set up using composer packages or custom package scripts results in an error. Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
296 lines
8.8 KiB
Bash
296 lines
8.8 KiB
Bash
# Variables
|
|
export tick="✓"
|
|
export cross="✗"
|
|
export curl_opts=(-sL)
|
|
export old_versions="5.[3-5]"
|
|
export jit_versions="8.[0-9]"
|
|
export php_builder_versions="8.[3-9]"
|
|
export nightly_versions="8.[6-9]"
|
|
export xdebug3_versions="7.[2-4]|8.[0-9]"
|
|
export latest="releases/latest/download"
|
|
export github="https://github.com/shivammathur"
|
|
export jsdeliver="https://cdn.jsdelivr.net/gh/shivammathur"
|
|
export setup_php="https://setup-php.com"
|
|
|
|
if [ -n "${GITHUB_ACTIONS}" ]; then
|
|
export GROUP='::group::'
|
|
export END_GROUP='::endgroup::'
|
|
else
|
|
export GROUP=''
|
|
export END_GROUP=''
|
|
fi
|
|
|
|
# Function to log start of a operation.
|
|
step_log() {
|
|
local message=$1
|
|
printf "\n\033[90;1m==> \033[0m\033[37;1m%s\033[0m\n" "$message"
|
|
}
|
|
|
|
# Function to log result of a operation.
|
|
add_log() {
|
|
local mark=$1
|
|
local subject=$2
|
|
local message=$3
|
|
if [ "$mark" = "$tick" ]; then
|
|
printf "\033[32;1m%s \033[0m\033[34;1m%s \033[0m\033[90;1m%s\033[0m\n" "$mark" "$subject" "$message"
|
|
else
|
|
printf "\033[31;1m%s \033[0m\033[34;1m%s \033[0m\033[90;1m%s\033[0m\n" "$mark" "$subject" "$message"
|
|
[ "$fail_fast" = "true" ] && exit 1
|
|
fi
|
|
}
|
|
|
|
# Function to set output on GitHub Actions.
|
|
set_output() {
|
|
name=$1
|
|
value=$2
|
|
if [ "${GITHUB_ACTIONS}" = "true" ]; then
|
|
echo "${name}=${value}" | tee -a "$GITHUB_OUTPUT" >/dev/null 2>&1
|
|
fi
|
|
}
|
|
|
|
# Function to read env inputs.
|
|
read_env() {
|
|
update="${update:-${UPDATE:-false}}"
|
|
[ "${debug:-${DEBUG:-false}}" = "true" ] && debug=debug && update=true || debug=release
|
|
[[ "${phpts:-${PHPTS:-nts}}" = "ts" || "${phpts:-${PHPTS:-nts}}" = "zts" ]] && ts=zts && update=true || ts=nts
|
|
fail_fast="${fail_fast:-${FAIL_FAST:-false}}"
|
|
[[ ( -z "$ImageOS" && -z "$ImageVersion" ) ||
|
|
( -n "$RUNNER_ENVIRONMENT" && "$RUNNER_ENVIRONMENT" = "self-hosted" ) ||
|
|
-n "$ACT" || -n "$CONTAINER" ]] && _runner=self-hosted || _runner=github
|
|
runner="${runner:-${RUNNER:-$_runner}}"
|
|
tool_path_dir="${setup_php_tools_dir:-${SETUP_PHP_TOOLS_DIR:-/usr/local/bin}}"
|
|
tool_cache_path_dir="${setup_php_tool_cache_dir:-${SETUP_PHP_TOOL_CACHE_DIR:-${RUNNER_TOOL_CACHE:-/opt/hostedtoolcache}/setup-php/tools}}"
|
|
|
|
if [[ "$runner" = "github" && $_runner = "self-hosted" ]]; then
|
|
fail_fast=true
|
|
add_log "$cross" "Runner" "Runner set as github in self-hosted environment"
|
|
fi
|
|
|
|
# Set Update to true if the ubuntu github image does not have PHP PPA.
|
|
if [[ "$runner" = "github" && "${ImageOS}" =~ ubuntu.* ]]; then
|
|
if ! check_ppa ondrej/php; then
|
|
update=true
|
|
echo '' | sudo tee /tmp/sp_update >/dev/null 2>&1
|
|
elif [ -e /tmp/sp_update ]; then
|
|
update=true
|
|
fi
|
|
fi
|
|
|
|
export fail_fast
|
|
export runner
|
|
export update
|
|
export ts
|
|
export tool_path_dir
|
|
export tool_cache_path_dir
|
|
}
|
|
|
|
# Function to create a lock.
|
|
acquire_lock() {
|
|
lock_path="$1"
|
|
while true; do
|
|
if sudo mkdir "$lock_path" 2>/dev/null; then
|
|
echo $$ | sudo tee "$lock_path/pid" >/dev/null
|
|
return 0
|
|
else
|
|
if sudo test -f "$lock_path/pid"; then
|
|
lock_pid=$(sudo cat "$lock_path/pid")
|
|
if ! ps -p "$lock_pid" >/dev/null 2>&1; then
|
|
sudo rm -rf "$lock_path"
|
|
continue
|
|
fi
|
|
fi
|
|
sleep 1
|
|
fi
|
|
done
|
|
}
|
|
|
|
# Function to release the lock.
|
|
release_lock() {
|
|
lock_path="$1"
|
|
sudo rm -rf "$lock_path"
|
|
}
|
|
|
|
# Function to get the SHA256 hash of a string.
|
|
get_sha256() {
|
|
local input=$1
|
|
if command -v sha256sum >/dev/null; then
|
|
printf '%s' "$input" | sha256sum | cut -d' ' -f1
|
|
elif command -v shasum >/dev/null; then
|
|
printf '%s' "$input" | shasum -a 256 | cut -d' ' -f1
|
|
elif command -v openssl >/dev/null; then
|
|
printf '%s' "$input" | openssl dgst -sha256 | cut -d' ' -f2
|
|
fi
|
|
}
|
|
|
|
# Function to verify the checksum of a file.
|
|
# checksum format: sha256:<hash> or sha512:<hash>
|
|
verify_checksum() {
|
|
local file_path=$1
|
|
local checksum=$2
|
|
local algo="${checksum%%:*}"
|
|
local expected="${checksum#*:}"
|
|
local actual=
|
|
if command -v "${algo}sum" >/dev/null; then
|
|
actual="$(sudo "${algo}sum" "$file_path" | cut -d' ' -f1)"
|
|
elif command -v shasum >/dev/null; then
|
|
actual="$(sudo shasum -a "${algo#sha}" "$file_path" | cut -d' ' -f1)"
|
|
elif command -v openssl >/dev/null; then
|
|
actual="$(sudo openssl dgst -"$algo" "$file_path" | awk '{print $NF}')"
|
|
fi
|
|
[ -n "$actual" ] && [ "$(echo "$actual" | tr '[:upper:]' '[:lower:]')" = "$(echo "$expected" | tr '[:upper:]' '[:lower:]')" ]
|
|
}
|
|
|
|
# Function to download a file using cURL.
|
|
# mode: -s pipe to stdout, -v save file and return status code
|
|
# execute: -e save file as executable
|
|
get() {
|
|
mode=$1
|
|
execute=$2
|
|
file_path=$3
|
|
shift 3
|
|
links=("$@")
|
|
if [ "$mode" = "-s" ]; then
|
|
sudo curl "${curl_opts[@]}" "${links[0]}"
|
|
else
|
|
if [ "$runner" = "self-hosted" ]; then
|
|
lock_path="/tmp/sp-lck-$(get_sha256 "$file_path")"
|
|
acquire_lock "$lock_path"
|
|
if [ "$execute" = "-e" ]; then
|
|
until [ -z "$(fuser "$file_path" 2>/dev/null)" ]; do
|
|
sleep 1
|
|
done
|
|
fi
|
|
trap 'release_lock "$lock_path"' EXIT SIGINT SIGTERM
|
|
fi
|
|
for link in "${links[@]}"; do
|
|
status_code=$(sudo curl -w "%{http_code}" -o "$file_path" "${curl_opts[@]}" "$link")
|
|
[ "$status_code" = "200" ] && break
|
|
done
|
|
[[ "$execute" = "-e" && -e "$file_path" ]] && sudo chmod a+x "$file_path"
|
|
[ "$mode" = "-v" ] && echo "$status_code"
|
|
[ "$runner" = "self-hosted" ] && release_lock "$lock_path"
|
|
fi
|
|
}
|
|
|
|
# Function to get shell profile.
|
|
get_shell_profile() {
|
|
case "$SHELL" in
|
|
*bash*)
|
|
echo "${HOME}/.bashrc"
|
|
;;
|
|
*zsh*)
|
|
echo "${HOME}/.zshrc"
|
|
;;
|
|
*)
|
|
echo "${HOME}/.profile"
|
|
;;
|
|
esac
|
|
}
|
|
|
|
# Function to add a path to the PATH variable.
|
|
add_path() {
|
|
path_to_add=$1
|
|
action=$2
|
|
[[ "$action" == "verify" && ":$PATH:" == *":$path_to_add:"* ]] && return
|
|
if [[ -n "$GITHUB_PATH" ]]; then
|
|
printf '%s\n%s' "$path_to_add" "$(grep -v "^${path_to_add}$" "$GITHUB_PATH" 2>/dev/null)" > "$GITHUB_PATH"
|
|
else
|
|
profile=$(get_shell_profile)
|
|
([ -e "$profile" ] && grep -q ":$path_to_add\"" "$profile" 2>/dev/null) || echo "export PATH=\"\${PATH:+\${PATH}:}\"$path_to_add" | sudo tee -a "$profile" >/dev/null 2>&1
|
|
fi
|
|
[[ ":$PATH:" == *":$path_to_add:"* ]] || export PATH="${PATH:+${PATH}:}$path_to_add"
|
|
}
|
|
|
|
# Function to add environment variables using a PATH.
|
|
add_env_path() {
|
|
env_path=$1
|
|
[ -e "$env_path" ] || return
|
|
if [[ -n "$GITHUB_ENV" ]]; then
|
|
cat "$env_path" >> "$GITHUB_ENV"
|
|
else
|
|
profile=$(get_shell_profile)
|
|
cat "$env_path" >> "$profile"
|
|
fi
|
|
}
|
|
|
|
# Function to add an environment variable.
|
|
add_env() {
|
|
env_name=$1
|
|
env_value=$2
|
|
if [[ -n "$GITHUB_ENV" ]]; then
|
|
echo "$env_name=$env_value" | tee -a "$GITHUB_ENV" >/dev/null 2>&1
|
|
else
|
|
profile=$(get_shell_profile)
|
|
echo "export $env_name=\"$env_value\"" | sudo tee -a "$profile" >/dev/null 2>&1
|
|
fi
|
|
export "$env_name"="$env_value"
|
|
}
|
|
|
|
# Function to download and run scripts from GitHub releases with jsdeliver fallback.
|
|
run_script() {
|
|
repo=$1
|
|
shift
|
|
args=("$@")
|
|
get -q -e /tmp/install.sh "$github/$repo/$latest/install.sh" "$jsdeliver/$repo@main/scripts/install.sh" "$setup_php/$repo/install.sh"
|
|
bash /tmp/install.sh "${args[@]}"
|
|
}
|
|
|
|
# Function to install required packages on self-hosted runners.
|
|
self_hosted_setup() {
|
|
if [ "$runner" = "self-hosted" ]; then
|
|
if [[ "${version:?}" =~ $old_versions ]]; then
|
|
add_log "$cross" "PHP" "PHP $version is not supported on self-hosted runner"
|
|
exit 1
|
|
else
|
|
self_hosted_helper >/dev/null 2>&1
|
|
add_env RUNNER_TOOL_CACHE /opt/hostedtoolcache
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# Function to check pre-installed PHP
|
|
check_pre_installed() {
|
|
if [ "$version" = "pre" ]; then
|
|
if [ -n "$php_config" ]; then
|
|
version="$(php_semver | cut -c 1-3)"
|
|
update=false
|
|
else
|
|
fail_fast=true
|
|
add_log "$cross" "PHP" "No pre-installed PHP version found"
|
|
fi
|
|
fi
|
|
}
|
|
|
|
# Function to configure PHP
|
|
configure_php() {
|
|
add_php_config
|
|
ini_config_dir="${src:?}"/configs/ini
|
|
ini_config_files=("$ini_config_dir"/php.ini)
|
|
arch="$(uname -m)"
|
|
[[ "$arch" = "arm64" || "$arch" = "aarch64" ]] && jit_ini="$ini_config_dir"/jit_aarch64.ini || jit_ini="$ini_config_dir"/jit.ini
|
|
jit_config_files=("$jit_ini")
|
|
[[ "$version" =~ $xdebug3_versions ]] && ini_config_files+=("$ini_config_dir"/xdebug.ini)
|
|
cat "${ini_config_files[@]}" | sudo tee -a "${ini_file[@]:?}" >/dev/null 2>&1
|
|
[[ "$version" =~ $jit_versions ]] && cat "${jit_config_files[@]}" | sudo tee -a "${pecl_file:-${ini_file[@]}}" >/dev/null 2>&1
|
|
}
|
|
|
|
# Function to get PHP version in semver format.
|
|
php_semver() {
|
|
grep -Eo 'version="[0-9]+(\.[0-9]+){2}((-?[a-zA-Z]+([0-9]+)?)?){2}' "${php_config:?}" | cut -d '"' -f 2
|
|
}
|
|
|
|
# Function to get ini_path.
|
|
php_ini_path() {
|
|
cut -d '"' -f 2 < <(grep "ini_path=" "$php_config" || php --ini | grep '(php.ini)' | sed -e "s|.*: s*||")
|
|
}
|
|
|
|
# Function to get the tag for a php version.
|
|
php_src_tag() {
|
|
commit=$(php_extra_version | grep -Eo "[0-9a-zA-Z]+")
|
|
if [[ -n "${commit}" ]]; then
|
|
echo "$commit"
|
|
else
|
|
echo "php-${semver:?}"
|
|
fi
|
|
}
|