nixpkgs/pkgs/development/interpreters/php/default.nix

# We have tests for PCRE and PHP-FPM in nixos/tests/php/ or
# both in the same attribute named nixosTests.php

{ callPackage, config, fetchurl, lib, makeWrapper, stdenv, symlinkJoin
, writeText , autoconf, automake, bison, flex, libtool, pkgconfig, re2c
, apacheHttpd, libargon2, libxml2, pcre, pcre2 , systemd, valgrind
}:

let
  generic =
  { version
  , sha256
  , extraPatches ? []

  # Sapi flags
  , cgiSupport ? config.php.cgi or true
  , cliSupport ? config.php.cli or true
  , fpmSupport ? config.php.fpm or true
  , pearSupport ? config.php.pear or true
  , pharSupport ? config.php.phar or true
  , phpdbgSupport ? config.php.phpdbg or true


  # Misc flags
  , apxs2Support ? config.php.apxs2 or (!stdenv.isDarwin)
  , argon2Support ? config.php.argon2 or true
  , cgotoSupport ? config.php.cgoto or false
  , embedSupport ? config.php.embed or false
  , ipv6Support ? config.php.ipv6 or true
  , systemdSupport ? config.php.systemd or stdenv.isLinux
  , valgrindSupport ? config.php.valgrind or true
  , ztsSupport ? (config.php.zts or false) || (apxs2Support)
  }: let
    pcre' = if (lib.versionAtLeast version "7.3") then pcre2 else pcre;
  in stdenv.mkDerivation {
    pname = "php";

    inherit version;

    enableParallelBuilding = true;

    nativeBuildInputs = [ autoconf automake bison flex libtool pkgconfig re2c ];

    buildInputs =
      # PCRE extension
      [ pcre' ]

      # Enable sapis
      ++ lib.optional pearSupport [ libxml2.dev ]

      # Misc deps
      ++ lib.optional apxs2Support apacheHttpd
      ++ lib.optional argon2Support libargon2
      ++ lib.optional systemdSupport systemd
      ++ lib.optional valgrindSupport valgrind
    ;

    CXXFLAGS = lib.optionalString stdenv.cc.isClang "-std=c++11";

    configureFlags =
      # Disable all extensions
      [ "--disable-all" ]

      # PCRE
      ++ lib.optionals (lib.versionAtLeast version "7.4") [ "--with-external-pcre=${pcre'.dev}" ]
      ++ lib.optionals (lib.versions.majorMinor version == "7.3") [ "--with-pcre-regex=${pcre'.dev}" ]
      ++ lib.optionals (lib.versionOlder version "7.3") [ "--with-pcre-regex=${pcre'.dev}" ]
      ++ [ "PCRE_LIBDIR=${pcre'}" ]


      # Enable sapis
      ++ lib.optional (!cgiSupport) "--disable-cgi"
      ++ lib.optional (!cliSupport) "--disable-cli"
      ++ lib.optional fpmSupport    "--enable-fpm"
      ++ lib.optional pearSupport [ "--with-pear=$(out)/lib/php/pear" "--enable-xml" "--with-libxml" ]
      ++ lib.optional (pearSupport && (lib.versionOlder version "7.4")) "--enable-libxml"
      ++ lib.optional pharSupport   "--enable-phar"
      ++ lib.optional phpdbgSupport "--enable-phpdbg"


      # Misc flags
      ++ lib.optional apxs2Support "--with-apxs2=${apacheHttpd.dev}/bin/apxs"
      ++ lib.optional argon2Support "--with-password-argon2=${libargon2}"
      ++ lib.optional cgotoSupport "--enable-re2c-cgoto"
      ++ lib.optional embedSupport "--enable-embed"
      ++ lib.optional (!ipv6Support) "--disable-ipv6"
      ++ lib.optional systemdSupport "--with-fpm-systemd"
      ++ lib.optional valgrindSupport "--with-valgrind=${valgrind.dev}"
      ++ lib.optional ztsSupport "--enable-maintainer-zts"
    ;

    hardeningDisable = [ "bindnow" ];

    preConfigure = ''
      # Don't record the configure flags since this causes unnecessary
      # runtime dependencies
      for i in main/build-defs.h.in scripts/php-config.in; do
        substituteInPlace $i \
          --replace '@CONFIGURE_COMMAND@' '(omitted)' \
          --replace '@CONFIGURE_OPTIONS@' "" \
          --replace '@PHP_LDFLAGS@' ""
      done

      export EXTENSION_DIR=$out/lib/php/extensions

      ./buildconf --copy --force

      if test -f $src/genfiles; then
        ./genfiles
      fi
    '' + lib.optionalString stdenv.isDarwin ''
      substituteInPlace configure --replace "-lstdc++" "-lc++"
    '';

    postInstall = ''
      test -d $out/etc || mkdir $out/etc
      cp php.ini-production $out/etc/php.ini
    '';

    postFixup = ''
      mkdir -p $dev/bin $dev/share/man/man1
      mv $out/bin/phpize $out/bin/php-config $dev/bin/
      mv $out/share/man/man1/phpize.1.gz \
         $out/share/man/man1/php-config.1.gz \
         $dev/share/man/man1/
    '';

    src = fetchurl {
      url = "https://www.php.net/distributions/php-${version}.tar.bz2";
      inherit sha256;
    };

    patches = [ ./fix-paths-php7.patch ] ++ extraPatches;

    separateDebugInfo = true;

    outputs = [ "out" "dev" ];

    meta = with stdenv.lib; {
      description = "An HTML-embedded scripting language";
      homepage = "https://www.php.net/";
      license = licenses.php301;
      maintainers = with maintainers; [ globin etu ma27 ];
      platforms = platforms.all;
      outputsToInstall = [ "out" "dev" ];
    };
  };

  generic' = { version, sha256, self, selfWithExtensions, ... }@args:
    let
      filteredArgs = builtins.removeAttrs args [ "self" "selfWithExtensions" ];
      php = generic filteredArgs;

      php-packages = (callPackage ../../../top-level/php-packages.nix {
        php = self;
        phpWithExtensions = selfWithExtensions;
      });

      buildEnv = lib.makeOverridable (
        { extensions ? (_: []), extraConfig ? "", ... }@innerArgs:
          let
            filteredInnerArgs = builtins.removeAttrs innerArgs [ "extensions" "extraConfig" ];
            allArgs = filteredArgs // filteredInnerArgs;
            php = generic allArgs;

            getExtName = ext: lib.removePrefix "php-" (builtins.parseDrvName ext.name).name;
            enabledExtensions = extensions php-packages.extensions;

            # Generate extension load configuration snippets from the
            # extension parameter. This is an attrset suitable for use
            # with textClosureList, which is used to put the strings in
            # the right order - if a plugin which is dependent on
            # another plugin is placed before its dependency, it will
            # fail to load.
            extensionTexts =
              lib.listToAttrs
                (map (ext:
                  let
                    extName = getExtName ext;
                    type = "${lib.optionalString (ext.zendExtension or false) "zend_"}extension";
                  in
                    lib.nameValuePair extName {
                      text = "${type}=${ext}/lib/php/extensions/${extName}.so";
                      deps = lib.optionals (ext ? internalDeps)
                        (map getExtName ext.internalDeps);
                    })
                  enabledExtensions);

            extNames = map getExtName enabledExtensions;
            extraInit = writeText "custom-php.ini" ''
            ${lib.concatStringsSep "\n"
              (lib.textClosureList extensionTexts extNames)}
            ${extraConfig}
          '';
          in
            symlinkJoin {
              name = "php-with-extensions-${version}";
              inherit (php) version;
              nativeBuildInputs = [ makeWrapper ];
              passthru = {
                inherit buildEnv withExtensions enabledExtensions;
                inherit (php-packages) packages extensions;
              };
              paths = [ php ];
              postBuild = ''
              cp ${extraInit} $out/lib/custom-php.ini

              wrapProgram $out/bin/php --set PHP_INI_SCAN_DIR $out/lib

              if test -e $out/bin/php-fpm; then
                 wrapProgram $out/bin/php-fpm --set PHP_INI_SCAN_DIR $out/lib
              fi
            '';
            });

      withExtensions = extensions: buildEnv { inherit extensions; };
    in
      php.overrideAttrs (_: {
        passthru = {
          enabledExtensions = [];
          inherit buildEnv withExtensions;
          inherit (php-packages) packages extensions;
        };
      });

  php72base = generic' {
    version = "7.2.29";
    sha256 = "08xry2fgqgg8s0ym1hh11wkbr36av3zq1bn4krbciw1b7x8gb8ga";
    self = php72base;
    selfWithExtensions = php72;

    # https://bugs.php.net/bug.php?id=76826
    extraPatches = lib.optional stdenv.isDarwin ./php72-darwin-isfinite.patch;
  };

  php73base = generic' {
    version = "7.3.16";
    sha256 = "0bh499v9dfgh9k51w4rird1slb9rh9whp5h37fb84c98d992s1xq";
    self = php73base;
    selfWithExtensions = php73;

    # https://bugs.php.net/bug.php?id=76826
    extraPatches = lib.optional stdenv.isDarwin ./php73-darwin-isfinite.patch;
  };

  php74base = generic' {
    version = "7.4.4";
    sha256 = "17w2m4phhpj76x5fx67vgjrlkcczqvky3f5in1kjg2pch90qz3ih";
    self = php74base;
    selfWithExtensions = php74;
  };

  defaultPhpExtensions = extensions: with extensions; ([
    bcmath calendar curl ctype dom exif fileinfo filter ftp gd
    gettext gmp iconv intl json ldap mbstring mysqli mysqlnd opcache
    openssl pcntl pdo pdo_mysql pdo_odbc pdo_pgsql pdo_sqlite pgsql
    posix readline session simplexml sockets soap sodium sqlite3
    tokenizer xmlreader xmlwriter zip zlib
  ] ++ lib.optionals (!stdenv.isDarwin) [ imap ]);

  defaultPhpExtensionsWithHash = extensions:
    (defaultPhpExtensions extensions) ++ [ extensions.hash ];

  php74 = php74base.withExtensions defaultPhpExtensions;
  php73 = php73base.withExtensions defaultPhpExtensionsWithHash;
  php72 = php72base.withExtensions defaultPhpExtensionsWithHash;

in {
  inherit php72base php73base php74base php72 php73 php74;
}