push sheeet

pkgs/build-support/php/builders/v2/build-composer-project.nix

@@ -0,0 +1,119 @@
+{
+  nix-update-script,
+  stdenvNoCC,
+  lib,
+  php,
+}@toplevel:
+
+let
+  buildComposerProjectOverride =
+    finalAttrs:
+    {
+      php ? finalAttrs.php or toplevel.php,
+      composer ? finalAttrs.php.packages.composer or toplevel.php.packages.composer,
+      composerLock ? finalAttrs.composerLock or null,
+      vendorHash ? finalAttrs.vendorHash or "",
+      composerNoDev ? finalAttrs.composerNoDev or true,
+      composerNoPlugins ? finalAttrs.composerNoPlugins or true,
+      composerNoScripts ? finalAttrs.composerNoScripts or true,
+      composerStrictValidation ? finalAttrs.composerStrictValidation or true,
+      buildInputs ? [ ],
+      nativeBuildInputs ? [ ],
+      strictDeps ? true,
+      patches ? [ ],
+      doCheck ? true,
+      doInstallCheck ? true,
+      dontCheckForBrokenSymlinks ? true,
+      passthru ? { },
+      meta ? { },
+      ...
+    }@args:
+    {
+      inherit
+        patches
+        strictDeps
+        doCheck
+        doInstallCheck
+        dontCheckForBrokenSymlinks
+        ;
+
+      nativeBuildInputs = nativeBuildInputs ++ [
+        composer
+        php
+        php.composerHooks2.composerInstallHook
+      ];
+
+      buildInputs = buildInputs ++ [ php ];
+
+      # Should we keep these empty phases?
+      configurePhase =
+        args.configurePhase or ''
+          runHook preConfigure
+
+          runHook postConfigure
+        '';
+
+      buildPhase =
+        args.buildPhase or ''
+          runHook preBuild
+
+          runHook postBuild
+        '';
+
+      checkPhase =
+        args.checkPhase or ''
+          runHook preCheck
+
+          runHook postCheck
+        '';
+
+      installPhase =
+        args.installPhase or ''
+          runHook preInstall
+
+          runHook postInstall
+        '';
+
+      installCheckPhase =
+        args.installCheckPhase or ''
+          runHook preInstallCheck
+
+          runHook postInstallCheck
+        '';
+
+      composerVendor =
+        args.composerVendor or (php.mkComposerVendor {
+          inherit (finalAttrs)
+            pname
+            src
+            vendorHash
+            version
+            ;
+          inherit
+            php
+            composer
+            composerLock
+            composerNoDev
+            composerNoPlugins
+            composerNoScripts
+            composerStrictValidation
+            dontCheckForBrokenSymlinks
+            ;
+        });
+
+      # Projects providing a lockfile from upstream can be automatically updated.
+      passthru = passthru // {
+        updateScript =
+          args.passthru.updateScript
+            or (if finalAttrs.composerVendor.composerLock == null then nix-update-script { } else null);
+      };
+
+      meta = meta // {
+        platforms = lib.platforms.all;
+      };
+    };
+in
+lib.extendMkDerivation {
+  constructDrv = stdenvNoCC.mkDerivation;
+  extendDrvArgs = buildComposerProjectOverride;
+}

pkgs/build-support/php/builders/v2/build-composer-vendor.nix

@@ -0,0 +1,94 @@
+{
+  stdenvNoCC,
+  lib,
+  php,
+}@toplevel:
+
+let
+  mkComposerVendorOverride =
+    finalAttrs:
+    {
+      php ? finalAttrs.php or toplevel.php,
+      composer ? finalAttrs.php.packages.composer or toplevel.php.packages.composer,
+      composerLock ? finalAttrs.composerLock or null,
+      vendorHash ? finalAttrs.vendorHash or "",
+      composerNoDev ? finalAttrs.composerNoDev or true,
+      composerNoPlugins ? finalAttrs.composerNoPlugins or true,
+      composerNoScripts ? finalAttrs.composerNoScripts or true,
+      composerStrictValidation ? finalAttrs.composerStrictValidation or true,
+      buildInputs ? [ ],
+      nativeBuildInputs ? [ ],
+      dontPatchShebangs ? true,
+      strictDeps ? true,
+      doCheck ? true,
+      doInstallCheck ? false,
+      dontCheckForBrokenSymlinks ? true,
+      ...
+    }@args:
+    assert (lib.assertMsg (args ? pname) "mkComposerVendor expects pname argument.");
+    assert (lib.assertMsg (args ? version) "mkComposerVendor expects version argument.");
+    assert (lib.assertMsg (args ? src) "mkComposerVendor expects src argument.");
+    {
+      name = "${args.pname}-composer-vendor-${args.version}";
+
+      # See https://github.com/NixOS/nix/issues/6660
+      inherit dontPatchShebangs;
+
+      inherit
+        buildInputs
+        strictDeps
+        doCheck
+        ;
+
+      nativeBuildInputs = nativeBuildInputs ++ [
+        composer
+        php
+        php.composerHooks2.composerVendorHook
+      ];
+
+      # Should we keep these empty phases?
+      configurePhase =
+        args.configurePhase or ''
+          runHook preConfigure
+
+          runHook postConfigure
+        '';
+
+      buildPhase =
+        args.buildPhase or ''
+          runHook preBuild
+
+          runHook postBuild
+        '';
+
+      checkPhase =
+        args.checkPhase or ''
+          runHook preCheck
+
+          runHook postCheck
+        '';
+
+      installPhase =
+        args.installPhase or ''
+          runHook preInstall
+
+          runHook postInstall
+        '';
+
+      installCheckPhase =
+        args.installCheckPhase or ''
+          runHook preInstallCheck
+
+          runHook postInstallCheck
+        '';
+
+      outputHashMode = "recursive";
+      outputHashAlgo =
+        if (finalAttrs ? vendorHash && finalAttrs.vendorHash != "") then null else "sha256";
+      outputHash = vendorHash;
+    };
+in
+lib.extendMkDerivation {
+  constructDrv = stdenvNoCC.mkDerivation;
+  extendDrvArgs = mkComposerVendorOverride;
+}

pkgs/build-support/php/builders/v2/hooks/composer-install-hook.sh

@@ -0,0 +1,73 @@
+# shellcheck shell=bash
+
+declare -g out
+declare -g pname
+declare -g composerVendor
+declare -g -i composerStrictValidation="${composerStrictValidation:-0}"
+
+preConfigureHooks+=(composerInstallConfigureHook)
+preBuildHooks+=(composerInstallBuildHook)
+preCheckHooks+=(composerInstallCheckHook)
+preInstallHooks+=(composerInstallInstallHook)
+
+# shellcheck source=/dev/null
+source @phpScriptUtils@
+
+composerInstallConfigureHook() {
+  echo "Executing composerInstallConfigureHook"
+
+  setComposerRootVersion
+
+  if [[ ! -e "${composerVendor}" ]]; then
+    echo "No local composer vendor found." >&2
+    exit 1
+  fi
+
+  install -Dm644 "${composerVendor}"/composer.json .
+
+  if [[ -f "${composerVendor}/composer.lock" ]]; then
+    install -Dm644 "${composerVendor}"/composer.lock .
+  fi
+
+  if [[ -f "composer.lock" ]]; then
+    chmod +w composer.lock
+  fi
+
+  chmod +w composer.json
+
+  echo "Finished composerInstallConfigureHook"
+}
+
+composerInstallBuildHook() {
+  echo "Executing composerInstallBuildHook"
+
+  echo "Finished composerInstallBuildHook"
+}
+
+composerInstallCheckHook() {
+  echo "Executing composerInstallCheckHook"
+
+  checkComposerValidate
+
+  echo "Finished composerInstallCheckHook"
+}
+
+composerInstallInstallHook() {
+  echo "Executing composerInstallInstallHook"
+
+  cp -ar "${composerVendor}"/* .
+
+  # Copy the relevant files only in the store.
+  mkdir -p "$out"/share/php/"${pname}"
+  cp -r . "$out"/share/php/"${pname}"/
+
+  # Create symlinks for the binaries.
+  mapfile -t BINS < <(jq -r -c 'try (.bin[] | select(test(".bat$")? | not) )' composer.json)
+  for bin in "${BINS[@]}"; do
+    echo -e "\e[32mCreating symlink ${bin}...\e[0m"
+    mkdir -p "$out/bin"
+    ln -s "$out/share/php/${pname}/${bin}" "$out/bin/$(basename "$bin")"
+  done
+
+  echo "Finished composerInstallInstallHook"
+}

pkgs/build-support/php/builders/v2/hooks/composer-vendor-hook.sh

@@ -0,0 +1,126 @@
+# shellcheck shell=bash
+
+# shellcheck source=/dev/null
+source @phpScriptUtils@
+
+declare -g out
+declare -g composerLock
+declare -g composerNoDev
+declare -g composerNoPlugins
+declare -g composerNoScripts
+
+declare -ga composerFlags=()
+[[ -n "$composerNoDev" ]] && composerFlags+=(--no-dev)
+[[ -n "$composerNoPlugins" ]] && composerFlags+=(--no-plugins)
+[[ -n "$composerNoScripts" ]] && composerFlags+=(--no-scripts)
+
+preConfigureHooks+=(composerVendorConfigureHook)
+preBuildHooks+=(composerVendorBuildHook)
+preCheckHooks+=(composerVendorCheckHook)
+preInstallHooks+=(composerVendorInstallHook)
+
+composerVendorConfigureHook() {
+  echo "Executing composerVendorConfigureHook"
+
+  setComposerRootVersion
+
+  if [[ -f "composer.lock" ]]; then
+    echo -e "\e[32mUsing \`composer.lock\` file from the source package\e[0m"
+  fi
+
+  if [[ -e "$composerLock" ]]; then
+    echo -e "\e[32mUsing user provided \`composer.lock\` file from \`$composerLock\`\e[0m"
+    install -Dm644 "$composerLock" ./composer.lock
+  fi
+
+  if [[ ! -f "composer.lock" ]]; then
+    composer \
+      --no-cache \
+      --no-install \
+      --no-interaction \
+      --no-progress \
+      --optimize-autoloader \
+      "${composerFlags[@]}" \
+      update
+
+    if [[ -f "composer.lock" ]]; then
+      install -Dm644 composer.lock -t "$out"/
+
+      echo
+      echo -e "\e[31mERROR: No composer.lock found\e[0m"
+      echo
+      echo -e '\e[31mNo composer.lock file found, consider adding one to your repository to ensure reproducible builds.\e[0m'
+      echo -e "\e[31mIn the meantime, a composer.lock file has been generated for you in $out/composer.lock\e[0m"
+      echo
+      echo -e '\e[31mTo fix the issue:\e[0m'
+      echo -e "\e[31m1. Copy the composer.lock file from $out/composer.lock to the project's source:\e[0m"
+      echo -e "\e[31m  cp $out/composer.lock <path>\e[0m"
+      echo -e '\e[31m2. Add the composerLock attribute, pointing to the copied composer.lock file:\e[0m'
+      echo -e '\e[31m  composerLock = ./composer.lock;\e[0m'
+      echo
+
+      exit 1
+    fi
+  fi
+
+  if [[ -f "composer.lock" ]]; then
+    chmod +w composer.lock
+  fi
+
+  chmod +w composer.json
+
+  echo "Finished composerVendorConfigureHook"
+}
+
+composerVendorBuildHook() {
+  echo "Executing composerVendorBuildHook"
+
+  setComposerEnvVariables
+
+  composer \
+    --no-cache \
+    --no-interaction \
+    --no-progress \
+    --optimize-autoloader \
+    "${composerFlags[@]}" \
+    install
+
+  echo "Finished composerVendorBuildHook"
+}
+
+composerVendorCheckHook() {
+  echo "Executing composerVendorCheckHook"
+
+  checkComposerValidate
+
+  echo "Finished composerVendorCheckHook"
+}
+
+composerVendorInstallHook() {
+  echo "Executing composerVendorInstallHook"
+
+  mkdir -p "$out"
+
+  cp -ar composer.json "$(composer config vendor-dir)" "$out"/
+  mapfile -t installer_paths < <(jq -r -c 'try((.extra."installer-paths") | keys[])' composer.json)
+
+  for installer_path in "${installer_paths[@]}"; do
+    # Remove everything after {$name} placeholder
+    installer_path="${installer_path/\{\$name\}*/}"
+    out_installer_path="$out/${installer_path/\{\$name\}*/}"
+    # Copy the installer path if it exists
+    if [[ -d "$installer_path" ]]; then
+      mkdir -p "$(dirname "$out_installer_path")"
+      echo -e "\e[32mCopying installer path $installer_path to $out_installer_path\e[0m"
+      cp -ar "$installer_path" "$out_installer_path"
+      # Strip out the git repositories
+      find "$out_installer_path" -name .git -type d -prune -print -exec rm -rf {} ";"
+    fi
+  done
+
+  if [[ -f "composer.lock" ]]; then
+    cp -ar composer.lock "$out"/
+  fi
+
+  echo "Finished composerVendorInstallHook"
+}

pkgs/build-support/php/builders/v2/hooks/default.nix

@@ -0,0 +1,46 @@
+{
+  lib,
+  makeSetupHook,
+  jq,
+  writeShellApplication,
+  cacert,
+  buildPackages,
+}:
+
+let
+  php-script-utils = writeShellApplication {
+    name = "php-script-utils";
+    runtimeInputs = [ jq ];
+    text = builtins.readFile ./php-script-utils.bash;
+  };
+in
+{
+  composerVendorHook = makeSetupHook {
+    name = "composer-vendor-hook.sh";
+    propagatedNativeBuildInputs = [
+      jq
+    ];
+    propagatedBuildInputs = [
+      cacert
+    ];
+    substitutions = {
+      phpScriptUtils = lib.getExe php-script-utils;
+    };
+  } ./composer-vendor-hook.sh;
+
+  composerInstallHook = makeSetupHook {
+    name = "composer-install-hook.sh";
+    propagatedNativeBuildInputs = [
+      jq
+    ];
+    propagatedBuildInputs = [
+      cacert
+    ];
+    substitutions = {
+      # Specify the stdenv's `diff` by abspath to ensure that the user's build
+      # inputs do not cause us to find the wrong `diff`.
+      cmp = "${lib.getBin buildPackages.diffutils}/bin/cmp";
+      phpScriptUtils = lib.getExe php-script-utils;
+    };
+  } ./composer-install-hook.sh;
+}

pkgs/build-support/php/builders/v2/hooks/php-script-utils.bash

@@ -0,0 +1,72 @@
+# shellcheck shell=bash
+
+declare -g version
+declare -g -i composerStrictValidation="${composerStrictValidation:-0}"
+
+setComposerRootVersion() {
+  if [[ -n $version ]]; then
+    echo -e "\e[32mSetting COMPOSER_ROOT_VERSION to $version\e[0m"
+    export COMPOSER_ROOT_VERSION="$version"
+  fi
+}
+
+setComposerEnvVariables() {
+  echo -e "\e[32mSetting some required environment variables for Composer...\e[0m"
+  export COMPOSER_MIRROR_PATH_REPOS=1
+  export COMPOSER_HTACCESS_PROTECT=0
+  export COMPOSER_FUND=0
+}
+
+checkComposerValidate() {
+  command="composer validate --strict --quiet --no-interaction --no-check-all --no-check-lock"
+  if ! $command; then
+    echo
+    echo -e "\e[31mERROR: composer files validation failed\e[0m"
+    echo
+    echo -e '\e[31mThe validation of the composer.json failed.\e[0m'
+    echo -e '\e[31mMake sure that the file composer.json is valid.\e[0m'
+    echo
+    echo -e '\e[31mTo address the issue efficiently, follow one of these steps:\e[0m'
+    echo -e '\e[31m  1. File an issue in the project'\''s issue tracker with detailed information, and apply any available remote patches as a temporary solution '\('with fetchpatch'\)'.\e[0m'
+    echo -e '\e[31m  2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
+    echo
+
+    if [[ "${composerStrictValidation}" == "1" ]]; then
+      echo
+      echo -e '\e[33mThis check is blocking, set the attribute composerStrictValidation to false to make it not blocking.\e[0m'
+      echo
+      exit 1
+    else
+      echo
+      echo -e '\e[33mThis check is not blocking, but it is recommended to fix the issue.\e[0m'
+      echo
+    fi
+  fi
+
+  command="composer validate --strict --no-ansi --no-interaction --quiet --no-check-all --check-lock"
+  if ! $command; then
+    echo
+    echo -e "\e[31mERROR: composer files validation failed\e[0m"
+    echo
+    echo -e '\e[31mThe validation of the composer.json and composer.lock failed.\e[0m'
+    echo -e '\e[31mMake sure that the file composer.lock is consistent with composer.json.\e[0m'
+    echo
+    echo -e '\e[31mThis often indicates an issue with the upstream project, which can typically be resolved by reporting the issue to the relevant project maintainers.\e[0m'
+    echo
+    echo -e '\e[31mTo address the issue efficiently, follow one of these steps:\e[0m'
+    echo -e '\e[31m  1. File an issue in the project'\''s issue tracker with detailed information '\('run '\''composer update --lock --no-install'\'' to fix the issue'\)', and apply any available remote patches as a temporary solution with '\('with fetchpatch'\)'.\e[0m'
+    echo -e '\e[31m  2. If an immediate fix is needed or if reporting upstream isn'\''t suitable, develop a temporary local patch.\e[0m'
+    echo
+
+    if [[ "${composerStrictValidation}" == "1" ]]; then
+      echo
+      echo -e '\e[33mThis check is blocking, set the attribute composerStrictValidation to false to make it not blocking.\e[0m'
+      echo
+      exit 1
+    else
+      echo
+      echo -e '\e[33mThis check is not blocking, but it is recommended to fix the issue.\e[0m'
+      echo
+    fi
+  fi
+}