Fix PEAR installation and add various improvements

petk · petk · commit 8181567ffcc5 · 2024-10-05T20:29:05.000+02:00
- Configure log now also lists always-enabled PHP extensions and makes
  it more clear what is being enabled
- Added missing "php" libdir prefix (will be refactored further)
- PEAR temporary directory is now customizable and is created inside the
  DESTDIR when it is defined
- Removed non-existent 'detect_unicode' INI directive in PEAR
- Added fixes for the Windows installation and its absolute path format
diff --git a/cmake/cmake/Configuration.cmake b/cmake/cmake/Configuration.cmake
@@ -62,7 +62,7 @@ mark_as_advanced(PHP_INCLUDE_PREFIX)
 set(
   PHP_CONFIG_FILE_SCAN_DIR ""
   CACHE PATH "The path where to scan for additional INI configuration files; By\
-  default it is empty value; Pass it as a relative string inside the install\
+  default it is empty value; Pass it as a relative path inside the install\
   prefix, which will be automatically prepended; If given as an absolute path,\
   prefix is not prepended."
 )
diff --git a/cmake/cmake/modules/PHP/FeatureSummary.cmake b/cmake/cmake/modules/PHP/FeatureSummary.cmake
@@ -62,11 +62,11 @@ block()
   endforeach()
 
   if(sapis)
-    message(STATUS "Enabled SAPIs:\n\n${sapis}")
+    message(STATUS "Enabled PHP SAPIs:\n\n${sapis}")
   endif()
 
   if(extensions)
-    message(STATUS "Enabled extensions:\n\n${extensions}")
+    message(STATUS "Enabled PHP extensions:\n\n${extensions}")
   endif()
 
   if(php)
diff --git a/cmake/ext/date/CMakeLists.txt b/cmake/ext/date/CMakeLists.txt
@@ -1,4 +1,11 @@
 include(CheckIncludeFile)
+include(FeatureSummary)
+
+add_feature_info(
+  "ext/date"
+  ON
+  "Date and time"
+)
 
 # Check for headers needed by timelib.
 check_include_file(io.h HAVE_IO_H)
diff --git a/cmake/ext/hash/CMakeLists.txt b/cmake/ext/hash/CMakeLists.txt
@@ -1,6 +1,12 @@
 include(FeatureSummary)
 include(PHP/CheckCompilerFlag)
 
+add_feature_info(
+  "ext/hash"
+  ON
+  "HASH message digest framework"
+)
+
 option(EXT_HASH_MHASH "Enable the mhash support (deprecated as of PHP 8.1)" OFF)
 
 add_feature_info(
diff --git a/cmake/ext/json/CMakeLists.txt b/cmake/ext/json/CMakeLists.txt
@@ -1,3 +1,11 @@
+include(FeatureSummary)
+
+add_feature_info(
+  "ext/json"
+  ON
+  "JavaScript Object Notation"
+)
+
 add_library(php_json STATIC)
 
 target_sources(
diff --git a/cmake/ext/pcre/CMakeLists.txt b/cmake/ext/pcre/CMakeLists.txt
@@ -4,6 +4,12 @@ include(CMakePushCheckState)
 include(FeatureSummary)
 include(PHP/CheckCompilerFlag)
 
+add_feature_info(
+  "ext/pcre"
+  ON
+  "(Perl-compatible) regular expressions"
+)
+
 option(
   EXT_PCRE_EXTERNAL
   "Use external (system) PCRE library in pcre extension instead of the bundled\
diff --git a/cmake/ext/random/CMakeLists.txt b/cmake/ext/random/CMakeLists.txt
@@ -1,5 +1,12 @@
 include(CheckIncludeFiles)
 include(CheckSymbolExists)
+include(FeatureSummary)
+
+add_feature_info(
+  "ext/random"
+  ON
+  "Random number generators and functions related to randomness"
+)
 
 add_library(php_random STATIC)
 
diff --git a/cmake/ext/reflection/CMakeLists.txt b/cmake/ext/reflection/CMakeLists.txt
@@ -1,3 +1,11 @@
+include(FeatureSummary)
+
+add_feature_info(
+  "ext/reflection"
+  ON
+  "Reflection API to introspect PHP code"
+)
+
 add_library(php_reflection STATIC php_reflection.c)
 
 target_compile_definitions(
diff --git a/cmake/ext/spl/CMakeLists.txt b/cmake/ext/spl/CMakeLists.txt
@@ -1,3 +1,11 @@
+include(FeatureSummary)
+
+add_feature_info(
+  "ext/spl"
+  ON
+  "Standard PHP library"
+)
+
 add_library(php_spl STATIC)
 
 target_sources(
diff --git a/cmake/ext/standard/CMakeLists.txt b/cmake/ext/standard/CMakeLists.txt
@@ -6,6 +6,12 @@ include(CMakePushCheckState)
 include(FeatureSummary)
 include(PHP/SearchLibraries)
 
+add_feature_info(
+  "ext/standard"
+  ON
+  "PHP core extension"
+)
+
 option(EXT_STANDARD_ARGON2 "Include the Argon2 support in password_*" OFF)
 
 add_feature_info(
diff --git a/cmake/pear/CMakeLists.txt b/cmake/pear/CMakeLists.txt
@@ -1,7 +1,7 @@
 include(FeatureSummary)
 include(PHP/Install)
 
-option(PHP_PEAR "Whether to install PEAR" OFF)
+option(PHP_PEAR "Install PEAR" OFF)
 
 add_feature_info(
   "PEAR"
@@ -25,17 +25,20 @@ endif()
 mark_as_advanced(PHP_PEAR_DIR)
 
 if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
-  set(tmpDir "C:/temp/pear")
+  set(tmpDir "temp/pear")
 else()
-  set(tmpDir "/tmp/pear")
+  set(tmpDir "tmp/pear")
 endif()
 if(PHP_PEAR)
   set(
     PHP_PEAR_TEMP_DIR "${tmpDir}"
     CACHE FILEPATH
     "The PEAR temporary directory where PEAR writes temporary files, such as\
-    cache, downloaded packages artifacts and similar. Must be absolute path.\
-    Default: ${tmpDir}."
+    cache, downloaded packages artifacts and similar. Pass it as a relative\
+    path inside the top level system directory, which will be automatically\
+    prepended. If given as an absolute path, top level directory is not\
+    prepended. Relative path is added to the top root system directory (/ on\
+    *nix, or c:/ on Windows). Default: ${tmpDir}."
   )
   # Change from INTERNAL type to show variable on consecutive configuration run.
   set_property(CACHE PHP_PEAR_TEMP_DIR PROPERTY TYPE FILEPATH)
@@ -64,11 +67,22 @@ if(NOT SAPI_CLI)
 endif()
 
 # Check PEAR dependencies.
-if(NOT EXT_XML)
-  message(
-    FATAL_ERROR
-    "PEAR requires the xml extension to be enabled. Set EXT_XML to 'ON'.")
-endif()
+block()
+  foreach(
+    extension
+      openssl # For pecl command to download packages over https
+      xml     # For installer, pear and pecl commands to work
+  )
+    string(TOUPPER ${extension} extensionUpper)
+    if(NOT EXT_${extensionUpper})
+      message(
+        FATAL_ERROR
+        "PEAR requires PHP extension ${extension}. Set EXT_${extensionUpper} "
+        "to 'ON'."
+      )
+    endif()
+  endforeach()
+endblock()
 
 set(PHP_EXECUTABLE)
 if(NOT CMAKE_CROSSCOMPILING)
@@ -84,12 +98,11 @@ php_install(CODE "
   set(phpPearCurrentBinaryDir \"${CMAKE_CURRENT_BINARY_DIR}\")
   set(phpPearPhpExecutable \"${PHP_EXECUTABLE}\")
   set(phpExtensionDir \"$<PATH:ABSOLUTE_PATH,NORMALIZE,${PHP_EXTENSION_DIR},\${CMAKE_INSTALL_PREFIX}>\")
-  # When the xml extension is shared, it must be loaded for the PHP_EXECUTABLE.
+  set(EXT_OPENSSL_SHARED ${EXT_OPENSSL_SHARED})
   set(EXT_XML_SHARED ${EXT_XML_SHARED})
-  if(EXT_XML_SHARED)
-    set(phpPearOptions -d extension_dir=${PHP_BINARY_DIR}/modules -d extension=xml)
-  endif()
-  set(phpPearTempDir \"${PHP_PEAR_TEMP_DIR}\")
+  set(PHP_BINARY_DIR ${PHP_BINARY_DIR})
+  set(CMAKE_SYSTEM_NAME ${CMAKE_SYSTEM_NAME})
+  set(PHP_PEAR_TEMP_DIR \"${PHP_PEAR_TEMP_DIR}\")
   set(phpPearInstalledPhpBin \"\${phpPearInstallBinDir}/$<TARGET_FILE_NAME:php_cli>\")
   set(phpPearPhpProgramPrefix \"${PHP_PROGRAM_PREFIX}\")
   set(phpPearPhpProgramSuffix \"${PHP_PROGRAM_SUFFIX}\")
diff --git a/cmake/pear/InstallPear.cmake b/cmake/pear/InstallPear.cmake
@@ -8,7 +8,41 @@ running it via the install(CODE) as done in the PEAR's CMakeLists.txt.
 
 set(phpPearInstallerUrl "https://pear.php.net/install-pear-nozlib.phar")
 
-message(STATUS "Installing PEAR to $ENV{DESTDIR}${phpPearInstallDir}")
+# Helper to normalize path with DESTDIR on Windows and *nix systems.
+#
+# php_pear_path_with_destdir(
+#   <path-to-normalize-for-install>
+#   <result-variable-name>
+# )
+function(php_pear_path_with_destdir)
+  cmake_parse_arguments(
+    PARSE_ARGV
+    2
+    parsed # prefix
+    ""     # options
+    ""     # one-value keywords
+    ""     # multi-value keywords
+  )
+
+  if(
+    CMAKE_SYSTEM_NAME STREQUAL "Windows"
+    AND DEFINED ENV{DESTDIR}
+    AND IS_ABSOLUTE "${ARGV0}"
+  )
+    string(REGEX REPLACE "^.:" "" path "${ARGV0}")
+    set(path "$ENV{DESTDIR}/${path}")
+  elseif(DEFINED ENV{DESTDIR} AND IS_ABSOLUTE "${ARGV0}")
+    set(path "$ENV{DESTDIR}/${ARGV0}")
+  else()
+    set(path "${ARGV0}")
+  endif()
+
+  cmake_path(SET path NORMALIZE "${path}")
+  set(${ARGV1} "${path}" PARENT_SCOPE)
+endfunction()
+
+php_pear_path_with_destdir(${phpPearInstallDir} phpPearInstallStageDir)
+message(STATUS "Installing PEAR to ${phpPearInstallStageDir}")
 
 # If PEAR installer is packaged in the PHP release archive.
 if(
@@ -83,34 +117,57 @@ endif()
 # the environment variable for the installation time.
 set(ENV{PHP_PEAR_SYSCONF_DIR} ${phpPearInstallSysconfDir})
 
-# Set temporary directory for the PEAR installation.
-set(localPearTempDir ${phpPearCurrentBinaryDir}/CMakeFiles/pear)
-
 # Set the PHP extensions directory.
 set(ENV{PHP_PEAR_EXTENSION_DIR} "${phpExtensionDir}")
 
+# Set PEAR temporary directory for the DESTDIR and system top level directory.
+php_pear_path_with_destdir(${PHP_PEAR_TEMP_DIR} phpPearStageTempDir)
+
+if(IS_ABSOLUTE ${PHP_PEAR_TEMP_DIR})
+  cmake_path(SET phpPearTempDir NORMALIZE "${PHP_PEAR_TEMP_DIR}")
+else()
+  if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
+    cmake_path(SET phpPearTempDir NORMALIZE "c:/${PHP_PEAR_TEMP_DIR}")
+  else()
+    cmake_path(SET phpPearTempDir NORMALIZE "/${PHP_PEAR_TEMP_DIR}")
+  endif()
+endif()
+
 file(
   MAKE_DIRECTORY
-    "$ENV{DESTDIR}${phpPearInstallDir}"
-    ${localPearTempDir}
+    ${phpPearInstallStageDir}
+    ${phpPearStageTempDir}/cache
+    ${phpPearStageTempDir}/download
+    ${phpPearStageTempDir}/temp
 )
 
-# Run the PEAR phar installer.
+# Add options for PHP executable, when dependent extensions are shared, they
+# need to be loaded for the PHP_EXECUTABLE.
+set(phpPearOptions -d extension_dir=${PHP_BINARY_DIR}/modules)
+
+if(EXT_OPENSSL_SHARED)
+  list(APPEND phpPearOptions -d extension=openssl)
+endif()
+
+if(EXT_XML_SHARED)
+  list(APPEND phpPearOptions -d extension=xml)
+endif()
+
+# Run the PEAR installer.
 execute_process(
   COMMAND ${phpPearPhpExecutable}
   -n
   -dshort_open_tag=0
   -dopen_basedir=
   -derror_reporting=1803
   -dmemory_limit=-1
-  -ddetect_unicode=0
   ${phpPearOptions}
   ${phpPearCurrentBinaryDir}/install-pear-nozlib.phar
     --dir "${phpPearInstallDir}"
     --bin "${phpPearInstallBinDir}"
     --metadata "${phpPearInstallDir}"
     --data "${phpPearInstallDir}"
-    --temp "${localPearTempDir}"
+    --temp "${phpPearStageTempDir}"
     --cache "${phpPearTempDir}/cache"
     --download "${phpPearTempDir}/download"
     --php ${phpPearInstalledPhpBin}
@@ -130,21 +187,26 @@ if(NOT result EQUAL 0)
   return()
 endif()
 
-# Patch the pear.conf file because it contains the temporary CMakeFiles path.
-set(pearConf $ENV{DESTDIR}$ENV{PHP_PEAR_SYSCONF_DIR}/pear.conf)
+# When installing with DESTDIR, patch the pear.conf file as it contains the
+# temporary path with DESTDIR path.
+if(NOT DEFINED ENV{DESTDIR})
+  return()
+endif()
+
+php_pear_path_with_destdir($ENV{PHP_PEAR_SYSCONF_DIR}/pear.conf pearConf)
+
 if(NOT EXISTS "${pearConf}")
   return()
 endif()
 
-message(STATUS "Patching pear.conf")
+message(STATUS "Patching ${pearConf}")
 
 file(READ "${pearConf}" content)
-file(WRITE ${localPearTempDir}/pear.conf "${content}")
 string(LENGTH "${phpPearTempDir}/temp" length)
 string(
   REGEX REPLACE
-  "s:[0-9]+:\"${localPearTempDir}"
-  "s:${length}:\"${phpPearTempDir}/temp"
+  "s:8:\"temp_dir\";s:[0-9]+:\"${phpPearStageTempDir}\""
+  "s:8:\"temp_dir\";s:${length}:\"${phpPearTempDir}/temp\""
   content
   "${content}"
 )
diff --git a/cmake/scripts/CMakeLists.txt b/cmake/scripts/CMakeLists.txt
@@ -118,7 +118,7 @@ block()
       prefix "$<INSTALL_PREFIX>"
       datarootdir "$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_DATAROOTDIR},$<INSTALL_PREFIX>>"
       exec_prefix "$<INSTALL_PREFIX>"
-      libdir "$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_LIBDIR},$<INSTALL_PREFIX>>"
+      libdir "$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_LIBDIR}/php,$<INSTALL_PREFIX>>"
       includedir "$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_INCLUDEDIR}/${PHP_INCLUDE_PREFIX},$<INSTALL_PREFIX>>"
       SED "${SED}"
   )

Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ mark_as_advanced(PHP_INCLUDE_PREFIX)`
`62`	`62`	`set(`
`63`	`63`	`PHP_CONFIG_FILE_SCAN_DIR ""`
`64`	`64`	`CACHE PATH "The path where to scan for additional INI configuration files; By\`
`65`		`- default it is empty value; Pass it as a relative string inside the install\`
	`65`	`+ default it is empty value; Pass it as a relative path inside the install\`
`66`	`66`	`prefix, which will be automatically prepended; If given as an absolute path,\`
`67`	`67`	`prefix is not prepended."`
`68`	`68`	`)`