ladybird/Ports/.port_include.sh
Ali Mohammad Pur e79a766901 Ports: Make 'package.sh dev' a bit more friendly when importing patches
When a git patch that doesn't apply is encountered, start a git am
session and _then_ drop the user in it instead of expeting the user to
start the session on their own.
Also prompt for leftover files and delete them if the user does not want
them.
2022-01-27 23:01:05 +01:00

802 lines
23 KiB
Bash
Executable file

#!/usr/bin/env bash
set -eu
SCRIPT="$(dirname "${0}")"
export SERENITY_ARCH="${SERENITY_ARCH:-i686}"
export SERENITY_TOOLCHAIN="${SERENITY_TOOLCHAIN:-GCC}"
if [ -z "${HOST_CC:=}" ]; then
export HOST_CC="${CC:=cc}"
export HOST_CXX="${CXX:=c++}"
export HOST_AR="${AR:=ar}"
export HOST_RANLIB="${RANLIB:=ranlib}"
export HOST_PATH="${PATH:=}"
export HOST_READELF="${READELF:=readelf}"
export HOST_PKG_CONFIG_DIR="${PKG_CONFIG_DIR:=}"
export HOST_PKG_CONFIG_SYSROOT_DIR="${PKG_CONFIG_SYSROOT_DIR:=}"
export HOST_PKG_CONFIG_LIBDIR="${PKG_CONFIG_LIBDIR:=}"
fi
DESTDIR="/"
maybe_source() {
if [ -f "$1" ]; then
. "$1"
fi
}
enable_ccache() {
if command -v ccache &>/dev/null; then
ccache_tooldir="${SERENITY_BUILD_DIR}/ccache"
mkdir -p "$ccache_tooldir"
for tool in gcc g++ c++; do
ln -sf "$(command -v ccache)" "${ccache_tooldir}/${SERENITY_ARCH}-pc-serenity-${tool}"
done
export PATH="${ccache_tooldir}:$PATH"
fi
}
target_env() {
maybe_source "${SCRIPT}/.hosted_defs.sh"
}
target_env
host_env() {
export CC="${HOST_CC}"
export CXX="${HOST_CXX}"
export AR="${HOST_AR}"
export RANLIB="${HOST_RANLIB}"
export PATH="${HOST_PATH}"
export READELF="${HOST_READELF}"
export PKG_CONFIG_DIR="${HOST_PKG_CONFIG_DIR}"
export PKG_CONFIG_SYSROOT_DIR="${HOST_PKG_CONFIG_SYSROOT_DIR}"
export PKG_CONFIG_LIBDIR="${HOST_PKG_CONFIG_LIBDIR}"
enable_ccache
}
packagesdb="${DESTDIR}/usr/Ports/packages.db"
makeopts=("-j$(nproc)")
installopts=()
configscript=configure
configopts=()
useconfigure=false
config_sub_path=config.sub
use_fresh_config_sub=false
depends=()
patchlevel=1
auth_type=
auth_import_key=
auth_opts=()
launcher_name=
launcher_category=
launcher_command=
launcher_run_in_terminal=false
icon_file=
. "$@"
shift
: "${workdir:=$port-$version}"
cleanup_git() {
echo "WARNING: Reverting changes to $workdir as we are in dev mode!"
run git clean -xffd >/dev/null 2>&1
}
# Use the local git target repo as the workdir
# Make sure to clean it up afterwards
if [ -n "${IN_SERENITY_PORT_DEV:-}" ]; then
echo "WARNING: All changes to the workdir in the current state (inside ./package.sh dev) are temporary!"
echo " They will be reverted once the command exits!"
nongit_workdir="$workdir"
workdir=".$workdir-git"
trap "run cleanup_git" EXIT
fi
run_nocd() {
echo "+ $@ (nocd)" >&2
("$@")
}
run() {
echo "+ $@"
(cd "$workdir" && "$@")
}
run_replace_in_file() {
run perl -p -i -e "$1" $2
}
get_new_config_sub() {
config_sub="${1:-config.sub}"
if ! run grep -q serenity "$config_sub"; then
run do_download_file "https://git.savannah.gnu.org/gitweb/?p=config.git;a=blob_plain;f=config.sub" "${1:-config.sub}" false
fi
}
ensure_new_config_sub() {
get_new_config_sub "$config_sub_path"
}
ensure_build() {
# Sanity check.
if [ ! -f "${DESTDIR}/usr/lib/libc.so" ]; then
echo "libc.so could not be found. This likely means that SerenityOS:"
echo "- has not been built and/or installed yet"
echo "- has been installed in an unexpected location"
echo "The currently configured build directory is ${SERENITY_BUILD_DIR}. Resolve this issue and try again."
exit 1
fi
}
install_main_icon() {
if [ -n "$icon_file" ] && [ -n "$launcher_command" ]; then
local launcher_binary="${launcher_command%% *}"
install_icon "$icon_file" "${launcher_binary}"
fi
}
install_icon() {
if [ "$#" -lt 2 ]; then
echo "Syntax: install_icon <icon> <launcher>"
exit 1
fi
local icon="$1"
local launcher="$2"
command -v convert >/dev/null || true
local convert_exists=$?
command -v identify >/dev/null || true
local identify_exists=$?
if [ "${convert_exists}" != "0" ] || [ "${identify_exists}" != 0 ]; then
echo 'Unable to install icon: missing convert or identify, did you install ImageMagick?'
return
fi
for icon_size in "16x16" "32x32"; do
index=$(run identify "$icon" | grep "$icon_size" | grep -oE "\[[0-9]+\]" | tr -d "[]" | head -n1)
if [ -n "$index" ]; then
run convert "${icon}[${index}]" "app-${icon_size}.png"
else
run convert "$icon[0]" -resize $icon_size "app-${icon_size}.png"
fi
done
run objcopy --add-section serenity_icon_s="app-16x16.png" "${DESTDIR}${launcher}"
run objcopy --add-section serenity_icon_m="app-32x32.png" "${DESTDIR}${launcher}"
}
install_main_launcher() {
if [ -n "$launcher_name" ] && [ -n "$launcher_category" ] && [ -n "$launcher_command" ]; then
install_launcher "$launcher_name" "$launcher_category" "$launcher_command"
fi
}
install_launcher() {
if [ "$#" -lt 3 ]; then
echo "Syntax: install_launcher <name> <category> <command>"
exit 1
fi
local launcher_name="$1"
local launcher_category="$2"
local launcher_command="$3"
local launcher_filename="${launcher_name,,}"
launcher_filename="${launcher_filename// /}"
local icon_override=""
case "$launcher_command" in
*\ *)
mkdir -p $DESTDIR/usr/local/libexec
launcher_executable="/usr/local/libexec/$launcher_filename"
cat >"$DESTDIR/$launcher_executable" <<SCRIPT
#!/bin/sh
exec $(printf '%q ' $launcher_command)
SCRIPT
chmod +x "$DESTDIR/$launcher_executable"
icon_override="IconPath=${launcher_command%% *}"
;;
*)
launcher_executable="$launcher_command"
;;
esac
mkdir -p $DESTDIR/res/apps
cat >$DESTDIR/res/apps/$launcher_filename.af <<CONFIG
[App]
Name=$launcher_name
Executable=$launcher_executable
Category=$launcher_category
RunInTerminal=$launcher_run_in_terminal
${icon_override}
CONFIG
}
# Checks if a function is defined. In this case, if the function is not defined in the port's script, then we will use our defaults. This way, ports don't need to include these functions every time, but they can override our defaults if needed.
func_defined() {
PATH= command -V "$1" > /dev/null 2>&1
}
func_defined pre_fetch || pre_fetch() {
:
}
func_defined post_fetch || post_fetch() {
:
}
do_download_file() {
local url="$1"
local filename="$2"
local accept_existing="${3:-true}"
echo "Downloading URL: ${url}"
# FIXME: Serenity's curl port does not support https, even with openssl installed.
if which curl >/dev/null 2>&1 && ! curl https://example.com -so /dev/null; then
url=$(echo "$url" | sed "s/^https:\/\//http:\/\//")
fi
# download files
if $accept_existing && [ -f "$filename" ]; then
echo "$filename already exists"
else
if which curl; then
run_nocd curl ${curlopts:-} "$url" -L -o "$filename"
else
run_nocd pro "$url" > "$filename"
fi
fi
}
fetch() {
pre_fetch
if [ "$auth_type" = "sig" ] && [ ! -z "${auth_import_key}" ]; then
# import gpg key if not existing locally
# The default keyserver keys.openpgp.org prints "new key but contains no user ID - skipped"
# and fails. Use a different key server.
gpg --list-keys $auth_import_key || gpg --keyserver hkps://keyserver.ubuntu.com --recv-key $auth_import_key
fi
tried_download_again=0
while true; do
OLDIFS=$IFS
IFS=$'\n'
for f in $files; do
IFS=$OLDIFS
read url filename auth_sum<<< $(echo "$f")
do_download_file "$url" "$filename"
done
verification_failed=0
OLDIFS=$IFS
IFS=$'\n'
for f in $files; do
IFS=$OLDIFS
read url filename auth_sum<<< $(echo "$f")
# check sha256sum if given
if [ "$auth_type" = "sha256" ]; then
echo "Expecting ${auth_type}sum: $auth_sum"
calc_sum="$(sha256sum $filename | cut -f1 -d' ')"
echo "${auth_type}sum($filename) = '$calc_sum'"
if [ "$calc_sum" != "$auth_sum" ]; then
# remove downloaded file to re-download on next run
rm -f $filename
echo "${auth_type}sums mismatching, removed erronous download."
if [ $tried_download_again -eq 1 ]; then
echo "Please run script again."
exit 1
fi
echo "Trying to download the files again."
tried_download_again=1
verification_failed=1
fi
fi
done
# check signature
if [ "$auth_type" = "sig" ]; then
if $NO_GPG; then
echo "WARNING: gpg signature check was disabled by --no-gpg-verification"
else
if $(gpg --verify "${auth_opts[@]}"); then
echo "- Signature check OK."
else
echo "- Signature check NOT OK"
for f in $files; do
rm -f $f
done
rm -rf "$workdir"
echo " Signature mismatching, removed erronous download."
if [ $tried_download_again -eq 1 ]; then
echo "Please run script again."
exit 1
fi
echo "Trying to download the files again."
tried_download_again=1
verification_failed=1
fi
fi
fi
if [ $verification_failed -ne 1 ]; then
break
fi
done
# extract
OLDIFS=$IFS
IFS=$'\n'
for f in $files; do
IFS=$OLDIFS
read url filename auth_sum<<< $(echo "$f")
if [ ! -f "$workdir"/.${filename}_extracted ]; then
case "$filename" in
*.tar.gz|*.tgz)
run_nocd tar -xzf "$filename"
run touch .${filename}_extracted
;;
*.tar.gz|*.tar.bz|*.tar.bz2|*.tar.xz|*.tar.lz|.tbz*|*.txz|*.tgz)
run_nocd tar -xf "$filename"
run touch .${filename}_extracted
;;
*.gz)
run_nocd gunzip "$filename"
run touch .${filename}_extracted
;;
*.zip)
run_nocd bsdtar xf "$filename" || run_nocd unzip -qo "$filename"
run touch .${filename}_extracted
;;
*.asc)
run_nocd gpg --import "$filename" || true
;;
*)
echo "Note: no case for file $filename."
;;
esac
fi
done
post_fetch
}
func_defined pre_patch || pre_patch() {
:
}
func_defined patch_internal || patch_internal() {
# patch if it was not yet patched (applying patches multiple times doesn't work!)
if [ -z "${IN_SERENITY_PORT_DEV:-}" ] && [ -d patches ]; then
for filepath in patches/*.patch; do
filename=$(basename $filepath)
if [ ! -f "$workdir"/.${filename}_applied ]; then
run patch -p"$patchlevel" < "$filepath"
run touch .${filename}_applied
fi
done
fi
}
func_defined pre_configure || pre_configure() {
:
}
func_defined configure || configure() {
chmod +x "${workdir}"/"$configscript"
run ./"$configscript" --host="${SERENITY_ARCH}-pc-serenity" "${configopts[@]}"
}
func_defined post_configure || post_configure() {
:
}
func_defined build || build() {
run make "${makeopts[@]}"
}
func_defined install || install() {
run make DESTDIR=$DESTDIR "${installopts[@]}" install
}
func_defined post_install || post_install() {
echo
}
func_defined clean || clean() {
if [ -z "${IN_SERENITY_PORT_DEV:-}" ]; then
rm -rf "$workdir" *.out
else
rm -rf "$nongit_workdir" *.out
fi
}
func_defined clean_dist || clean_dist() {
OLDIFS=$IFS
IFS=$'\n'
for f in $files; do
IFS=$OLDIFS
read url filename hash <<< $(echo "$f")
rm -f "$filename"
done
}
func_defined clean_all || clean_all() {
if [ -z "${IN_SERENITY_PORT_DEV:-}" ]; then
rm -rf "$workdir" *.out
else
rm -rf "$nongit_workdir" *.out
fi
OLDIFS=$IFS
IFS=$'\n'
for f in $files; do
IFS=$OLDIFS
read url filename hash <<< $(echo "$f")
rm -f "$filename"
done
}
addtodb() {
if [ -n "$(package_install_state $port $version)" ]; then
echo "Note: $port $version already installed."
return
fi
echo "Adding $port $version to database of installed ports..."
if [ "${1:-}" = "--auto" ]; then
echo "auto $port $version" >> "$packagesdb"
else
echo "manual $port $version" >> "$packagesdb"
fi
if [ "${#depends[@]}" -gt 0 ]; then
echo "dependency $port ${depends[@]}" >> "$packagesdb"
fi
echo "Successfully installed $port $version."
}
ensure_packagesdb() {
if [ ! -f "$packagesdb" ]; then
mkdir -p "$(dirname $packagesdb)"
touch "$packagesdb"
fi
}
package_install_state() {
local port=$1
local version=${2:-}
ensure_packagesdb
grep -E "^(auto|manual) $port $version" "$packagesdb" | cut -d' ' -f1
}
installdepends() {
for depend in "${depends[@]}"; do
if [ -z "$(package_install_state $depend)" ]; then
(cd "../$depend" && ./package.sh --auto)
fi
done
}
uninstall() {
if [ "$(package_install_state $port)" != "manual" ]; then
>&2 echo "Error: $port is not installed. Cannot uninstall."
return
elif [ ! -f plist ]; then
>&2 echo "Error: This port does not have a plist yet. Cannot uninstall."
return
fi
for f in `cat plist`; do
case $f in
*/)
run rmdir "${DESTDIR}/$f" || true
;;
*)
run rm -rf "${DESTDIR}/$f"
;;
esac
done
# Without || true, mv will not be executed if you are uninstalling your only remaining port.
grep -v "^manual $port " "$packagesdb" > packages.db.tmp || true
mv packages.db.tmp "$packagesdb"
}
do_installdepends() {
echo "Installing dependencies of $port..."
installdepends
}
do_fetch() {
echo "Fetching $port..."
fetch
}
do_patch() {
echo "Patching $port..."
pre_patch
patch_internal
}
do_configure() {
ensure_build
if [ "$useconfigure" = "true" ]; then
echo "Configuring $port..."
if "$use_fresh_config_sub"; then
ensure_new_config_sub
fi
pre_configure
configure
post_configure
else
echo "This port does not use a configure script. Skipping configure step."
fi
}
do_build() {
ensure_build
echo "Building $port..."
build
}
do_install() {
ensure_build
echo "Installing $port..."
install
install_main_launcher
install_main_icon
post_install
addtodb "${1:-}"
}
do_clean() {
echo "Cleaning workdir and .out files in $port..."
clean
}
do_clean_dist() {
echo "Cleaning dist in $port..."
clean_dist
}
do_clean_all() {
echo "Cleaning all in $port..."
clean_all
}
do_uninstall() {
echo "Uninstalling $port..."
uninstall
}
do_showproperty() {
while [ $# -gt 0 ]; do
if ! declare -p "${1}" > /dev/null 2>&1; then
echo "Property '$1' is not set." >&2
exit 1
fi
property_declaration="$(declare -p "${1}")"
if [[ "$property_declaration" =~ "declare -a" ]]; then
prop_array="${1}[@]"
# Some magic to avoid empty arrays being considered unset.
echo "${!prop_array+"${!prop_array}"}"
else
echo ${!1}
fi
printf '\n'
shift
done
}
do_all() {
do_installdepends
do_fetch
do_patch
do_configure
do_build
do_install "${1:-}"
}
do_shell() {
do_installdepends
do_fetch
do_patch
cd "$workdir"
bash
echo "End of package shell. Back to the User shell."
}
do_generate_patch_readme() {
if [ ! -d patches ]; then
>&2 echo "Error: Port $port does not have any patches"
exit 1
fi
if [ -f patches/ReadMe.md ]; then
read -N1 -rp \
"A ReadMe.md already exists, overwrite? (N/y) " should_overwrite
echo
if [ "${should_overwrite,,}" != y ]; then
>&2 echo "Not overwriting Ports/$port/patches/ReadMe.md"
exit 0
fi
fi
rm -fr .patches.tmp
mkdir .patches.tmp
echo "# Patches for $port on SerenityOS" > patches/ReadMe.md
echo >> patches/ReadMe.md
pushd patches
local tempdir="../.patches.tmp"
local count=0
for patch in *.patch; do
git mailinfo \
"$tempdir/$patch.msg" \
/dev/null \
< "$patch" \
> "$tempdir/$patch.info" \
2> "$tempdir/$patch.error" \
|| {
rc=$?
>&2 echo "Failed to extract patch info from $patch"
>&2 echo "git returned $rc and said:"
>&2 cat "$tempdir/$patch.error"
exit 1
}
(
grep 'Subject: ' "$tempdir/$patch.info" | sed -e 's/Subject: \(.*\)$/\1/'
echo
cat "$tempdir/$patch.msg"
) > "$tempdir/$patch.desc"
if [ ! -s "$tempdir/$patch.desc" ]; then
>&2 echo "WARNING: $patch does not contain a valid git patch or is missing a commit message, and is going to be skipped!"
continue
fi
{
echo "## \`$patch\`"
echo
cat "$tempdir/$patch.desc"
echo
} >> ReadMe.md
count=$((count + 1))
done
popd
>&2 echo "Successfully generated entries for $count patch(es) in patches/ReadMe.md."
}
launch_user_shell() {
env \
IN_SERENITY_PORT_DEV="$port" \
"${SHELL:-bash}" || \
true
}
prompt_yes_no() {
read -N1 -rp \
"$1 (N/y) " result
2>&1 echo
if [ "${result,,}" == y ]; then
return 0
else
return 1
fi
}
do_dev() {
if [ -n "${IN_SERENITY_PORT_DEV:-}" ]; then
>&2 echo "Error: Already in dev environment for $IN_SERENITY_PORT_DEV"
exit 1
fi
git_repo=".$workdir-git"
[ -d "$git_repo" ] || (
mv "$workdir" "$git_repo"
pushd "$git_repo"
if [ ! -d "$git_repo/.git" ]; then
git init .
git add .
git commit -a -m 'Initial import'
fi
# Make it allow pushes from other local checkouts
git config receive.denyCurrentBranch ignore
# Import patches as commits, or ask the user to commit them
# if they're not git patches already.
if [ -d ../patches ] && [ -n "$(find ../patches -maxdepth 1 -name '*.patch' -print -quit)" ]; then
for patch in ../patches/*.patch; do
if [ -f "$workdir/.$(basename $patch).applied" ]; then
continue
fi
echo "Importing patch $patch..."
git am "$patch" >/dev/null 2>&1 || {
git am --abort >/dev/null 2>&1 || true
if git apply < $patch; then
git add -A
if prompt_yes_no "- This patch does not appear to be a git patch, would you like to modify its changes before continuing?"; then
>&2 echo "Apply any changes you want, commit them into the current repo and quit this shell to continue."
launch_user_shell
fi
git commit --verbose
else
# The patch didn't apply, oh no!
# Ask the user to figure it out :shrug:
git am "$patch" || true
>&2 echo "- This patch does not apply, you'll be dropped into a shell to investigate and fix this, quit the shell when the problem is resolved."
>&2 echo "Note that the patch needs to be committed into the current repository!"
launch_user_shell
fi
if ! git diff --quiet >/dev/null 2>&1; then
>&2 echo "- It appears that there are uncommitted changes from applying the previous patch:"
for line in $(git diff --color=always); do
echo "| $line"
done
if prompt_yes_no "- Would you like to drop them before moving on to the next patch?"; then
git clean -xf
else
>&2 echo "- The uncommitted changes will be committed with the next patch or left in the tree."
fi
fi
}
done
fi
popd
)
[ -d "$git_repo" ] && [ ! -d "$workdir" ] && {
git clone "$git_repo" "$workdir"
}
[ -d "$workdir/.git" ] || {
>&2 echo "$workdir does not appear to be a git repository, if you did this manually, you're on your own"
if prompt_yes_no "Otherwise, press 'y' to remove that directory and clone it again"; then
rm -fr "$workdir"
git clone "$git_repo" "$workdir"
else
exit 1
fi
}
local first_hash="$(git -C "$git_repo" rev-list --max-parents=0 HEAD)"
launch_user_shell
local current_hash="$(git -C "$git_repo" rev-parse HEAD)"
# If the hashes are the same, we have no patches, otherwise generate patches
if [ "$first_hash" != "$current_hash" ]; then
>&2 echo "Note: Regenerating patches as there are some commits in the port repo (started at $first_hash, now is $current_hash)"
rm -fr patches/*.patch
git -C "$git_repo" format-patch "$first_hash" -o "$(realpath patches)"
do_generate_patch_readme
fi
}
NO_GPG=false
parse_arguments() {
if [ -z "${1:-}" ]; then
do_all
return
fi
case "$1" in
fetch|patch|shell|configure|build|install|installdepends|clean|clean_dist|clean_all|uninstall|showproperty|generate_patch_readme)
method=$1
shift
do_${method} "$@"
;;
--auto)
do_all $1
;;
--no-gpg-verification)
NO_GPG=true
shift
parse_arguments $@
;;
interactive)
export PS1="(serenity):\w$ "
bash --norc
;;
dev)
shift
if [ "${1:-}" != "--no-depends" ]; then
do_installdepends
fi
if [ -d "$workdir" ] && [ ! -d "$workdir/.git" ]; then
if prompt_yes_no "- Would you like to clean the working direcory (i.e. ./package.sh clean)?"; then
do_clean
fi
fi
do_fetch
do_dev
;;
*)
>&2 echo "I don't understand $1! Supported arguments: fetch, patch, configure, build, install, installdepends, interactive, clean, clean_dist, clean_all, uninstall, showproperty, generate_patch_readme, dev."
exit 1
;;
esac
}
parse_arguments $@