From f258865ca7ffb4f19de9f6c656ba64748d1e6072 Mon Sep 17 00:00:00 2001
From: pdontthink <pdontthink@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Date: Mon, 7 May 2007 05:43:56 +0000
Subject: [PATCH] Use constant instead of hard-coded string for plugin
 incompatibility indicator

git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@12369 7612ce4b-ef26-0410-bec9-ea0150e637f0
---
 functions/plugin.php  | 16 ++++++++--------
 include/constants.php |  6 ++++++
 src/configtest.php    |  2 +-
 3 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/functions/plugin.php b/functions/plugin.php
index dfaefd72..9deb5917 100644
--- a/functions/plugin.php
+++ b/functions/plugin.php
@@ -562,7 +562,7 @@ function check_plugin_version($plugin_name,
   *
   * @return mixed NULL is returned if the plugin could not be 
   *               found or does not include the given requirement,
-  *               the string "INCOMPATIBLE" is returned if the
+  *               the constant SQ_INCOMPATIBLE is returned if the
   *               given plugin is entirely incompatible with the
   *               current SquirrelMail version, otherwise the 
   *               value of the requirement is returned, whatever 
@@ -668,7 +668,7 @@ function get_plugin_requirement($plugin_name, $requirement,
          $c = $version_array[2];
 
          if (check_sm_version($a, $b, $c) 
-          && ( !empty($requirement_overrides['INCOMPATIBLE']) 
+          && ( !empty($requirement_overrides[SQ_INCOMPATIBLE]) 
           || (isset($requirement_overrides[$requirement])
           && !is_null($requirement_overrides[$requirement]))))
          {
@@ -682,8 +682,8 @@ function get_plugin_requirement($plugin_name, $requirement,
              && $highest_version_array[2] < $c))
             {
                $highest_version_array = $version_array;
-               if (!empty($requirement_overrides['INCOMPATIBLE']))
-                  $requirement_value_override = 'INCOMPATIBLE';
+               if (!empty($requirement_overrides[SQ_INCOMPATIBLE]))
+                  $requirement_value_override = SQ_INCOMPATIBLE;
                else
                   $requirement_value_override = $requirement_overrides[$requirement];
             }
@@ -746,7 +746,7 @@ function get_plugin_requirement($plugin_name, $requirement,
   * @return mixed Boolean FALSE is returned if the plugin
   *               could not be found or does not indicate
   *               whether it has other plugin dependencies, 
-  *               the string "INCOMPATIBLE" is returned if 
+  *               the constant SQ_INCOMPATIBLE is returned if 
   *               the given plugin is entirely incompatible 
   *               with the current SquirrelMail version, 
   *               otherwise an array is returned where keys 
@@ -775,7 +775,7 @@ function get_plugin_dependencies($plugin_name, $force_inclusion = FALSE,
 
    // the plugin is simply incompatible, no need to continue here
    //
-   if ($plugin_dependencies === 'INCOMPATIBLE')
+   if ($plugin_dependencies === SQ_INCOMPATIBLE)
       return $plugin_dependencies;
 
 
@@ -886,7 +886,7 @@ function get_plugin_dependencies($plugin_name, $force_inclusion = FALSE,
   *
   * @return mixed Boolean TRUE if all of the plugin's 
   *               required plugins are correctly installed,
-  *               the string "INCOMPATIBLE" is returned if 
+  *               the constant SQ_INCOMPATIBLE is returned if 
   *               the given plugin is entirely incompatible 
   *               with the current SquirrelMail version, 
   *               otherwise an array of the required plugins
@@ -908,7 +908,7 @@ function check_plugin_dependencies($plugin_name, $force_inclusion = FALSE)
 
    $dependencies = get_plugin_dependencies($plugin_name, $force_inclusion);
    if (!$dependencies) return TRUE;
-   if ($dependencies === 'INCOMPATIBLE') return $dependencies;
+   if ($dependencies === SQ_INCOMPATIBLE) return $dependencies;
    $missing_or_bad = array();
 
    foreach ($dependencies as $depend_name => $depend_requirements)
diff --git a/include/constants.php b/include/constants.php
index 5fc115c0..62e50752 100644
--- a/include/constants.php
+++ b/include/constants.php
@@ -173,3 +173,9 @@ define('SQ_TYPE_ARRAY', 'array');
 define('SQ_PHP_TEMPLATE', 'PHP_');
 define('SQ_SMARTY_TEMPLATE', 'Smarty_');
 
+/**
+ * Used by plugins to indicate an incompatibility with a SM version
+ * @since 1.5.2
+ */
+define('SQ_INCOMPATIBLE', 'INCOMPATIBLE');
+
diff --git a/src/configtest.php b/src/configtest.php
index 92afb375..274f9c98 100644
--- a/src/configtest.php
+++ b/src/configtest.php
@@ -410,7 +410,7 @@ if (isset($plugins[0])) {
         // dependencies and if they are satisfied
         //
         $failed_dependencies = check_plugin_dependencies($name);
-        if ($failed_dependencies === 'INCOMPATIBLE') {
+        if ($failed_dependencies === SQ_INCOMPATIBLE) {
             do_err($name . ' is NOT COMPATIBLE with this version of SquirrelMail', FALSE);
         }
         else if (is_array($failed_dependencies)) {
-- 
2.25.1