Rename PHPSystem

This renames the weird PHPSystem to simply PHP, however it may clash
with variables set by `project(PHP)`, so the `find_package()` is wrapped
in the `block()` and propagates PHP_FOUND. The PHP_EXECUTABLE is cache
variable, so it's available outside of the block as expected.

Author: petk

cmake/CMakeLists.txt

@@ -62,7 +62,7 @@ block()
 endblock()
 
 # Rebuild all targets as needed.
-if(NOT PHPSystem_EXECUTABLE)
+if(NOT PHP_FOUND)
   include(PHP/Rebuild)
 endif()
 

cmake/cmake/Requirements.cmake

@@ -50,9 +50,12 @@ endif()
 find_package(Sendmail)
 
 ################################################################################
-# Find PHP installed on the system for generating stub files (*_arginfo.h),
-# Zend/zend_vm_gen.php, ext/tokenizer/tokenizer_data_gen.php and similar where
-# it can be used. Otherwise the built cli sapi is used at the build phase.
-# Minimum supported version for gen_stub.php is PHP 7.4.
-################################################################################
-find_package(PHPSystem 7.4)
+# Find PHP installed on the system and set PHP_EXECUTABLE for development such
+# as generating stubs (*_arginfo.h) with build/gen_stub.php, running PHP scripts
+# Zend/zend_vm_gen.php and similar. Otherwise the sapi/cli executable will be
+# used at the build phase, where possible. The minimum version should match the
+# version required to run these PHP scripts.
+################################################################################
+block(PROPAGATE PHP_FOUND)
+  find_package(PHP 7.4)
+endblock()

cmake/cmake/modules/FindPHP.cmake

@@ -0,0 +1,78 @@
+#[=============================================================================[
+# FindPHP
+
+Find PHP on the system, if installed.
+
+## Result variables
+
+* `PHP_FOUND` - Whether the package has been found.
+* `PHP_VERSION` - Package version, if found.
+
+## Cache variables
+
+* `PHP_EXECUTABLE` - PHP command-line executable, if available.
+#]=============================================================================]
+
+include(FeatureSummary)
+include(FindPackageHandleStandardArgs)
+
+set_package_properties(
+  PHP
+  PROPERTIES
+    URL "https://www.php.net"
+    DESCRIPTION "PHP: Hypertext Preprocessor"
+)
+
+set(_phpRequiredVars PHP_EXECUTABLE)
+set(_reason "")
+
+find_program(
+  PHP_EXECUTABLE
+  NAMES php
+  DOC "The path to the PHP executable"
+)
+mark_as_advanced(PHP_EXECUTABLE)
+
+if(NOT PHP_EXECUTABLE)
+  string(APPEND _reason "The php command-line executable could not be found. ")
+endif()
+
+unset(PHP_VERSION)
+block(PROPAGATE PHP_VERSION _reason _phpRequiredVars)
+  if(CMAKE_VERSION VERSION_GREATER_EQUAL 3.29)
+    set(test IS_EXECUTABLE)
+  else()
+    set(test EXISTS)
+  endif()
+
+  if(${test} ${PHP_EXECUTABLE})
+    list(APPEND _phpRequiredVars PHP_VERSION)
+
+    execute_process(
+      COMMAND ${PHP_EXECUTABLE} --version
+      OUTPUT_VARIABLE version
+      RESULT_VARIABLE result
+      OUTPUT_STRIP_TRAILING_WHITESPACE
+      ERROR_QUIET
+    )
+
+    if(NOT result EQUAL 0)
+      string(APPEND _reason "Command '${PHP_EXECUTABLE} --version' failed. ")
+    elseif(version MATCHES "PHP ([0-9]+[0-9.]+[^ ]+) \\(cli\\)")
+      set(PHP_VERSION "${CMAKE_MATCH_1}")
+    else()
+      string(APPEND _reason "Invalid version format. ")
+    endif()
+  endif()
+endblock()
+
+find_package_handle_standard_args(
+  PHP
+  REQUIRED_VARS ${_phpRequiredVars}
+  VERSION_VAR PHP_VERSION
+  HANDLE_VERSION_RANGE
+  REASON_FAILURE_MESSAGE "${_reason}"
+)
+
+unset(_phpRequiredVars)
+unset(_reason)

cmake/cmake/modules/FindPHPSystem.cmake

@@ -82,10 +82,10 @@ function(php_add_custom_command)
     set(verbatim "")
   endif()
 
-  if(PHPSystem_EXECUTABLE)
+  if(PHP_FOUND)
     add_custom_command(
       OUTPUT ${parsed_OUTPUT}
-      COMMAND ${PHPSystem_EXECUTABLE} ${parsed_PHP_COMMAND}
+      COMMAND ${PHP_EXECUTABLE} ${parsed_PHP_COMMAND}
       DEPENDS ${parsed_DEPENDS}
       COMMENT "${parsed_COMMENT}"
       ${verbatim}
@@ -99,9 +99,12 @@ function(php_add_custom_command)
   endif()
 
   if(NOT CMAKE_CROSSCOMPILING)
-    set(PHP_EXECUTABLE "$<TARGET_FILE:PHP::sapi::cli>")
+    set(phpExecutable "$<TARGET_FILE:PHP::sapi::cli>")
   elseif(CMAKE_CROSSCOMPILING AND CMAKE_CROSSCOMPILING_EMULATOR)
-    set(PHP_EXECUTABLE "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>")
+    set(
+      phpExecutable
+      "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>"
+    )
   else()
     return()
   endif()
@@ -111,11 +114,10 @@ function(php_add_custom_command)
   add_custom_target(
     ${targetName} ALL
     COMMAND ${CMAKE_COMMAND}
-      -D "PHP_EXECUTABLE=${PHP_EXECUTABLE}"
-      -D "OUTPUT=${parsed_OUTPUT}"
-      -D "PHP_COMMAND=${parsed_PHP_COMMAND}"
-      -D "DEPENDS=${parsed_DEPENDS}"
+      -D "PHP_COMMAND=${phpExecutable};${parsed_PHP_COMMAND}"
       -D "COMMENT=${parsed_COMMENT}"
+      -D "DEPENDS=${parsed_DEPENDS}"
+      -D "OUTPUT=${parsed_OUTPUT}"
       -P ${CMAKE_CURRENT_FUNCTION_LIST_DIR}/AddCustomCommand/RunCommand.cmake
     ${verbatim}
   )

cmake/cmake/modules/PHP/AddCustomCommand.cmake

@@ -4,14 +4,13 @@ dependent input source files and runs the command inside the execute_process().
 
 Expected variables:
 
-* PHP_EXECUTABLE
-* PHP_COMMAND
-* DEPENDS
-* OUTPUT
-* COMMENT
+* COMMENT - String printed in the build output log.
+* DEPENDS - A list of dependent files.
+* OUTPUT - A list of output files to be produced.
+* PHP_COMMAND - A list of command and its arguments.
 #]=============================================================================]
 
-if(NOT CMAKE_SCRIPT_MODE_FILE OR NOT PHP_EXECUTABLE OR NOT PHP_COMMAND)
+if(NOT CMAKE_SCRIPT_MODE_FILE OR NOT PHP_COMMAND)
   return()
 endif()
 
@@ -45,7 +44,16 @@ if(COMMENT)
   )
 endif()
 
-execute_process(COMMAND ${PHP_EXECUTABLE} ${PHP_COMMAND})
+execute_process(
+  COMMAND ${PHP_COMMAND}
+  RESULT_VARIABLE result
+  ERROR_VARIABLE error
+)
+
+if(NOT result EQUAL 0)
+  list(JOIN PHP_COMMAND " " command)
+  message(NOTICE "Command ended with non-zero status:\n  ${command}\n${error}")
+endif()
 
 # Update modification times of output files to not re-run the command on the
 # consecutive build runs.

cmake/cmake/modules/PHP/AddCustomCommand/RunCommand.cmake

@@ -15,7 +15,7 @@ function(_php_stubs_get_php_command result)
   # If PHP is not found on the system, the PHP cli SAPI will be used with the
   # tokenizer extension.
   if(
-    NOT PHPSystem_EXECUTABLE
+    NOT PHP_FOUND
     AND (
       NOT TARGET PHP::sapi::cli
       OR (TARGET PHP::sapi::cli AND NOT TARGET PHP::ext::tokenizer)
@@ -25,16 +25,16 @@ function(_php_stubs_get_php_command result)
   endif()
 
   # If external PHP is available, check for the required tokenizer extension.
-  if(PHPSystem_EXECUTABLE)
+  if(PHP_FOUND)
     execute_process(
-      COMMAND ${PHPSystem_EXECUTABLE} --ri tokenizer
+      COMMAND ${PHP_EXECUTABLE} --ri tokenizer
       RESULT_VARIABLE code
       OUTPUT_QUIET
       ERROR_QUIET
     )
 
     if(code EQUAL 0)
-      set(${result} ${PHPSystem_EXECUTABLE})
+      set(${result} ${PHP_EXECUTABLE})
       return(PROPAGATE ${result})
     endif()
   endif()
@@ -113,7 +113,7 @@ block()
       $<PATH:ABSOLUTE_PATH,NORMALIZE,$<LIST:FILTER,$<TARGET_PROPERTY:${target},SOURCES>,INCLUDE,\.stub\.php$>,$<TARGET_PROPERTY:${target},SOURCE_DIR>>
     )
 
-    if(PHPSystem_EXECUTABLE)
+    if(PHP_FOUND)
       add_dependencies(${target} php_stubs)
     endif()
   endforeach()
@@ -128,7 +128,7 @@ block()
   )
 
   set(targetOptions "")
-  if(NOT PHPSystem_EXECUTABLE)
+  if(NOT PHP_FOUND)
     set(targetOptions ALL DEPENDS ${targets})
   endif()
 

cmake/cmake/modules/PHP/Stubs.cmake

@@ -122,9 +122,12 @@ if(NOT TARGET PHP::sapi::cli)
 endif()
 
 if(NOT CMAKE_CROSSCOMPILING)
-  set(PHP_EXECUTABLE "$<TARGET_FILE:PHP::sapi::cli>")
+  set(phpExecutable "$<TARGET_FILE:PHP::sapi::cli>")
 elseif(CMAKE_CROSSCOMPILING AND CMAKE_CROSSCOMPILING_EMULATOR)
-  set(PHP_EXECUTABLE "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>")
+  set(
+    phpExecutable
+    "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>"
+  )
 else()
   return()
 endif()
@@ -148,7 +151,7 @@ cmake_path(
 add_custom_command(
   OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/phar.php
   COMMAND
-    ${PHP_EXECUTABLE}
+    ${phpExecutable}
       -n
       ${pharSharedOptions}
       -d open_basedir=
@@ -164,7 +167,7 @@ add_custom_command(
 add_custom_command(
   OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/phar.phar
   COMMAND
-    ${PHP_EXECUTABLE}
+    ${phpExecutable}
       -n
       ${pharSharedOptions}
       -d open_basedir=
@@ -240,7 +243,7 @@ set_property(SOURCE php_ext_phar_generated_phar PROPERTY SYMBOLIC TRUE)
 install(CODE "
   execute_process(
     COMMAND
-      ${PHP_EXECUTABLE}
+      ${phpExecutable}
         -n
         ${pharSharedOptions}
         -d open_basedir=

cmake/ext/phar/CMakeLists.txt

@@ -121,19 +121,22 @@ block()
   endforeach()
 endblock()
 
-set(PHP_EXECUTABLE "")
+set(phpExecutable "")
 if(NOT CMAKE_CROSSCOMPILING)
-  set(PHP_EXECUTABLE "$<TARGET_FILE:PHP::sapi::cli>")
+  set(phpExecutable "$<TARGET_FILE:PHP::sapi::cli>")
 elseif(CMAKE_CROSSCOMPILING AND CMAKE_CROSSCOMPILING_EMULATOR)
-  set(PHP_EXECUTABLE "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>")
+  set(
+    phpExecutable
+    "${CMAKE_CROSSCOMPILING_EMULATOR};$<TARGET_FILE:PHP::sapi::cli>"
+  )
 endif()
 
 php_install(CODE "
   set(phpPearInstallDir \"$<PATH:ABSOLUTE_PATH,NORMALIZE,${PHP_PEAR_DIR},\${CMAKE_INSTALL_PREFIX}>\")
   set(phpPearInstallBinDir \"$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_BINDIR},\${CMAKE_INSTALL_PREFIX}>\")
   set(phpPearCurrentSourceDir \"${CMAKE_CURRENT_SOURCE_DIR}\")
   set(phpPearCurrentBinaryDir \"${CMAKE_CURRENT_BINARY_DIR}\")
-  set(phpPearPhpExecutable \"${PHP_EXECUTABLE}\")
+  set(phpPearPhpExecutable \"${phpExecutable}\")
   set(phpExtensionDir \"$<PATH:ABSOLUTE_PATH,NORMALIZE,${PHP_EXTENSION_DIR},\${CMAKE_INSTALL_PREFIX}>\")
   set(PHP_EXT_OPENSSL_SHARED ${PHP_EXT_OPENSSL_SHARED})
   set(PHP_EXT_XML_SHARED ${PHP_EXT_XML_SHARED})