Rename SAPI_<SAPI_NAME> variables to PHP_SAPI_<SAPI_NAME>

This is a first mitigation step to start taking care of the global state
annoyances.

All cache variables of some project should be scoped inside some
namespace. In CMake's case, at the time of writing, this can be taken
care of prefixing all variable names. For example, with 'PHP_'.

Specifically, this issue is noticed when using the CMake's
`FetchContent` module, where concerns with cache variables overrides
from one project to the other can happen as the same CMakeCache.txt
file is used for the entire build.

Author: petk

cmake/cmake/presets/all-disabled.json

@@ -28,8 +28,8 @@
         "EXT_XMLREADER": false,
         "EXT_XMLWRITER": false,
 
-        "SAPI_CGI": false,
-        "SAPI_PHPDBG": false
+        "PHP_SAPI_CGI": false,
+        "PHP_SAPI_PHPDBG": false
       }
     },
     {

cmake/cmake/presets/all-enabled.json

@@ -70,13 +70,13 @@
         "EXT_ZIP": true,
         "EXT_ZLIB": true,
 
-        "SAPI_EMBED": true,
-        "SAPI_FPM": true,
-        "SAPI_FPM_ACL": true,
-        "SAPI_FPM_APPARMOR": true,
-        "SAPI_FPM_SELINUX": true,
-        "SAPI_FPM_SYSTEMD": true,
-        "SAPI_LITESPEED": true
+        "PHP_SAPI_EMBED": true,
+        "PHP_SAPI_FPM": true,
+        "PHP_SAPI_FPM_ACL": true,
+        "PHP_SAPI_FPM_APPARMOR": true,
+        "PHP_SAPI_FPM_SELINUX": true,
+        "PHP_SAPI_FPM_SYSTEMD": true,
+        "PHP_SAPI_LITESPEED": true
       }
     },
     {

cmake/pear/CMakeLists.txt

@@ -100,8 +100,8 @@ block()
   if(NOT TARGET PHP::SAPI::cli)
     message(
       FATAL_ERROR
-      "The 'PHP_PEAR' option requires PHP CLI SAPI. Please, set 'SAPI_CLI' to "
-      "'ON'."
+      "The 'PHP_PEAR' option requires PHP CLI SAPI. Please, set 'PHP_SAPI_CLI' "
+      "to 'ON'."
     )
   endif()
 

cmake/sapi/apache2handler/CMakeLists.txt

@@ -3,7 +3,7 @@
 
 Configure the `apache2handler` PHP SAPI.
 
-## SAPI_APACHE2HANDLER
+## PHP_SAPI_APACHE2HANDLER
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -30,15 +30,15 @@ cmake -B php-build -DAPACHE2HANDLER=ON -DApache_EXECUTABLE=/opt/apache2/bin/apxs
 
 include(FeatureSummary)
 
-option(SAPI_APACHE2HANDLER "Enable the shared Apache 2 handler SAPI module")
+option(PHP_SAPI_APACHE2HANDLER "Enable the shared Apache 2 handler SAPI module")
 
 add_feature_info(
   "sapi/apache2handler"
-  SAPI_APACHE2HANDLER
+  PHP_SAPI_APACHE2HANDLER
   "Apache HTTP server module"
 )
 
-if(NOT SAPI_APACHE2HANDLER)
+if(NOT PHP_SAPI_APACHE2HANDLER)
   return()
 endif()
 

cmake/sapi/cgi/CMakeLists.txt

@@ -3,7 +3,7 @@
 
 Configure the `cgi` PHP SAPI.
 
-## SAPI_CGI
+## PHP_SAPI_CGI
 
 * Default: `ON`
 * Values: `ON|OFF`
@@ -14,15 +14,15 @@ Enable the PHP CGI (Common Gateway Interface) SAPI executable module.
 include(CheckStructHasMember)
 include(FeatureSummary)
 
-option(SAPI_CGI "Enable the CGI (Common Gateway Interface) SAPI" ON)
+option(PHP_SAPI_CGI "Enable the CGI (Common Gateway Interface) SAPI" ON)
 
 add_feature_info(
   "sapi/cgi"
-  SAPI_CGI
+  PHP_SAPI_CGI
   "Common Gateway Interface executable"
 )
 
-if(NOT SAPI_CGI)
+if(NOT PHP_SAPI_CGI)
   return()
 endif()
 

cmake/sapi/cli/CMakeLists.txt

@@ -3,14 +3,14 @@
 
 Configure the `cli` PHP SAPI.
 
-## SAPI_CLI
+## PHP_SAPI_CLI
 
 * Default: `ON`
 * Values: `ON|OFF`
 
 Enable the PHP CLI (Command-Line Interpreter/Interface) SAPI executable module.
 
-## SAPI_CLI_WIN_NO_CONSOLE
+## PHP_SAPI_CLI_WIN_NO_CONSOLE
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -28,27 +28,27 @@ include(CheckSymbolExists)
 include(CMakeDependentOption)
 include(FeatureSummary)
 
-option(SAPI_CLI "Enable the CLI SAPI module" ON)
+option(PHP_SAPI_CLI "Enable the CLI SAPI module" ON)
 add_feature_info(
   "sapi/cli"
-  SAPI_CLI
+  PHP_SAPI_CLI
   "Command-Line Interpreter/Interface executable"
 )
 
 cmake_dependent_option(
-  SAPI_CLI_WIN_NO_CONSOLE
+  PHP_SAPI_CLI_WIN_NO_CONSOLE
   "Build additional CLI SAPI without console (no output is given)"
   OFF
-  [[SAPI_CLI AND CMAKE_SYSTEM_NAME STREQUAL "Windows"]]
+  [[PHP_SAPI_CLI AND CMAKE_SYSTEM_NAME STREQUAL "Windows"]]
   OFF
 )
 add_feature_info(
   "sapi/cli console-less"
-  SAPI_CLI_WIN_NO_CONSOLE
+  PHP_SAPI_CLI_WIN_NO_CONSOLE
   "additional executable without console output"
 )
 
-if(NOT SAPI_CLI)
+if(NOT PHP_SAPI_CLI)
   return()
 endif()
 
@@ -130,7 +130,7 @@ if(CMAKE_SYSTEM_NAME STREQUAL "Windows")
   )
 endif()
 
-if(SAPI_CLI_WIN_NO_CONSOLE)
+if(PHP_SAPI_CLI_WIN_NO_CONSOLE)
   add_executable(php_sapi_cli_win_no_console)
   add_executable(PHP::SAPI::cli_win_no_console ALIAS php_sapi_cli_win_no_console)
 

cmake/sapi/embed/CMakeLists.txt

@@ -3,7 +3,7 @@
 
 Configure the `embed` PHP SAPI.
 
-## SAPI_EMBED
+## PHP_SAPI_EMBED
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -19,15 +19,15 @@ to use PHP.
 
 include(FeatureSummary)
 
-option(SAPI_EMBED "Enable the Embed SAPI module")
+option(PHP_SAPI_EMBED "Enable the Embed SAPI module")
 
 add_feature_info(
   "sapi/embed"
-  SAPI_EMBED
+  PHP_SAPI_EMBED
   "module for embedding PHP into application"
 )
 
-if(NOT SAPI_EMBED)
+if(NOT PHP_SAPI_EMBED)
   return()
 endif()
 

cmake/sapi/fpm/CMakeLists.txt

@@ -6,27 +6,27 @@ Configure the `fpm` PHP SAPI.
 > [!NOTE]
 > PHP FPM is not available when the target system is Windows.
 
-## SAPI_FPM
+## PHP_SAPI_FPM
 
 * Default: `OFF`
 * Values: `ON|OFF`
 
 Enable the FastCGI Process Manager (FPM) SAPI module.
 
-## SAPI_FPM_USER
+## PHP_SAPI_FPM_USER
 
 * Default: `nobody`
 
 Set the user for running PHP FPM.
 
-## SAPI_FPM_GROUP
+## PHP_SAPI_FPM_GROUP
 
 * Default: `nobody`
 
 Set the group for running PHP FPM. For a system user, this should usually be set
 in a way to match the FPM username.
 
-## SAPI_FPM_ACL
+## PHP_SAPI_FPM_ACL
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -40,7 +40,7 @@ Where to find ACL installation on the system, can be customized with the
 > This option is not available when the target system is Darwin (macOS) as this
 > system doesn't have ACL.
 
-## SAPI_FPM_APPARMOR
+## PHP_SAPI_FPM_APPARMOR
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -54,7 +54,7 @@ Where to find AppArmor installation on the system, can be customized with the
 > This option is not available when the target system is Darwin (macOS) as this
 > system doesn't have AppArmor.
 
-## SAPI_FPM_SELINUX
+## PHP_SAPI_FPM_SELINUX
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -68,7 +68,7 @@ Where to find SELinux installation on the system, can be customized with the
 > This option is not available when the target system is Darwin (macOS) as this
 > system doesn't have SELinux.
 
-## SAPI_FPM_SYSTEMD
+## PHP_SAPI_FPM_SYSTEMD
 
 * Default: `OFF`
 * Values: `ON|OFF`
@@ -102,84 +102,84 @@ include(PHP/Set)
 # FPM configuration.
 ################################################################################
 
-option(SAPI_FPM "Enable the FPM SAPI module")
+option(PHP_SAPI_FPM "Enable the FPM SAPI module")
 add_feature_info(
   "sapi/fpm"
-  SAPI_FPM
+  PHP_SAPI_FPM
   "FastCGI Process Manager"
 )
 
 php_set(
-  SAPI_FPM_USER
+  PHP_SAPI_FPM_USER
   TYPE STRING
-  IF SAPI_FPM
+  IF PHP_SAPI_FPM
   VALUE "nobody"
   DOC "Set the user for running PHP FPM (default: nobody)"
 )
 
 php_set(
-  SAPI_FPM_GROUP
+  PHP_SAPI_FPM_GROUP
   TYPE STRING
-  IF SAPI_FPM
+  IF PHP_SAPI_FPM
   VALUE "nobody"
   DOC
     "Set the group for running PHP FPM. For a system user, this should usually "
     "be set to match the FPM username (default: nobody)"
 )
 
 php_set(
-  SAPI_FPM_ACL
+  PHP_SAPI_FPM_ACL
   TYPE BOOL
-  IF [[SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
+  IF [[PHP_SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
   VALUE OFF
   DOC "Use POSIX Access Control Lists"
 )
 add_feature_info(
   "sapi/fpm ACL"
-  SAPI_FPM_ACL
+  PHP_SAPI_FPM_ACL
   "POSIX Access Control Lists integration"
 )
 
 php_set(
-  SAPI_FPM_APPARMOR
+  PHP_SAPI_FPM_APPARMOR
   TYPE BOOL
-  IF [[SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
+  IF [[PHP_SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
   VALUE OFF
   DOC "Enable the AppArmor confinement through libapparmor"
 )
 add_feature_info(
   "sapi/fpm AppArmor"
-  SAPI_FPM_APPARMOR
+  PHP_SAPI_FPM_APPARMOR
   "application confinement integration"
 )
 
 php_set(
-  SAPI_FPM_SELINUX
+  PHP_SAPI_FPM_SELINUX
   TYPE BOOL
-  IF [[SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
+  IF [[PHP_SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
   VALUE OFF
   DOC "Enable the SELinux policy library support"
 )
 add_feature_info(
   "sapi/fpm SELinux"
-  SAPI_FPM_SELINUX
+  PHP_SAPI_FPM_SELINUX
   "security policy integration"
 )
 
 php_set(
-  SAPI_FPM_SYSTEMD
+  PHP_SAPI_FPM_SYSTEMD
   TYPE BOOL
-  IF [[SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
+  IF [[PHP_SAPI_FPM AND NOT CMAKE_SYSTEM_NAME STREQUAL "Darwin"]]
   VALUE OFF
   DOC "Enable the systemd integration"
 )
 add_feature_info(
   "sapi/fpm systemd"
-  SAPI_FPM_SYSTEMD
+  PHP_SAPI_FPM_SYSTEMD
   "system and service manager integration"
 )
 
-if(NOT SAPI_FPM)
+if(NOT PHP_SAPI_FPM)
   return()
 endif()
 
@@ -458,7 +458,7 @@ endif()
 # Configure FPM from configuration options.
 ################################################################################
 
-if(SAPI_FPM_SYSTEMD)
+if(PHP_SAPI_FPM_SYSTEMD)
   find_package(Systemd 209)
   set_package_properties(
     Systemd
@@ -480,7 +480,7 @@ else()
   set(PHP_FPM_SYSTEMD "simple")
 endif()
 
-if(SAPI_FPM_ACL)
+if(PHP_SAPI_FPM_ACL)
   set(ACL_USE_USER_GROUP TRUE)
   find_package(ACL)
   set_package_properties(
@@ -502,7 +502,7 @@ if(SAPI_FPM_ACL)
   endif()
 endif()
 
-if(SAPI_FPM_APPARMOR)
+if(PHP_SAPI_FPM_APPARMOR)
   find_package(AppArmor)
   set_package_properties(
     AppArmor
@@ -518,7 +518,7 @@ if(SAPI_FPM_APPARMOR)
   endif()
 endif()
 
-if(SAPI_FPM_SELINUX)
+if(PHP_SAPI_FPM_SELINUX)
   find_package(SELinux)
   set_package_properties(
     SELinux
@@ -581,8 +581,8 @@ php_configure_file(
   VARIABLES
     prefix "$<INSTALL_PREFIX>"
     php_fpm_prefix "$<INSTALL_PREFIX>"
-    php_fpm_user "${SAPI_FPM_USER}"
-    php_fpm_group "${SAPI_FPM_GROUP}"
+    php_fpm_user "${PHP_SAPI_FPM_USER}"
+    php_fpm_group "${PHP_SAPI_FPM_GROUP}"
     EXPANDED_DATADIR "$<PATH:ABSOLUTE_PATH,NORMALIZE,${CMAKE_INSTALL_DATADIR},$<INSTALL_PREFIX>>"
 )