*
* Documentation on how to write plugins might show up some time.
*
- * @copyright © 1999-2007 The SquirrelMail Project Team
+ * @copyright 1999-2010 The SquirrelMail Project Team
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
* @version $Id$
* @package squirrelmail
* independent of) the return value for this hook.
*
* @param string $name Name of hook being executed
- * @param mixed $args A single value or an array of arguments
+ * @param mixed &$args A single value or an array of arguments
* that are to be passed to all plugins
* operating off the hook being called.
* Note that this argument is passed by
* independent of) the return value for this hook.
*
* @param string $name Name of hook being executed
- * @param mixed $args A single value or an array of arguments
+ * @param mixed &$args A single value or an array of arguments
* that are to be passed to all plugins
* operating off the hook being called.
* Note that this argument is passed by
* independent of) the return value for this hook.
*
* @param string $name The hook name
- * @param mixed $args A single value or an array of arguments
+ * @param mixed &$args A single value or an array of arguments
* that are to be passed to all plugins
* operating off the hook being called.
* Note that this argument is passed by
*
* @since 1.5.2
*
- * @param string plugin_name Name of the plugin to
- * check; must precisely
- * match the plugin
- * directory name
- * @param string requirement The desired requirement name
- * @param bool force_inclusion Try to get requirement info
- * for plugins not activated?
- * (default FALSE)
+ * @param string $plugin_name Name of the plugin to
+ * check; must precisely
+ * match the plugin
+ * directory name
+ * @param string $requirement The desired requirement name
+ * @param boolean $ignore_incompatible When TRUE, version incompatibility
+ * information will NOT be returned
+ * if found; when FALSE, it will be
+ * (OPTIONAL; default TRUE)
+ * @param boolean $force_inclusion Try to get requirement info
+ * for plugins not activated?
+ * (OPTIONAL; default FALSE)
*
* @return mixed NULL is returned if the plugin could not be
* found or does not include the given requirement,
* the constant SQ_INCOMPATIBLE is returned if the
* given plugin is entirely incompatible with the
- * current SquirrelMail version, otherwise the
+ * current SquirrelMail version (unless
+ * $ignore_incompatible is TRUE), otherwise the
* value of the requirement is returned, whatever
* that may be (varies per requirement type).
*
*/
function get_plugin_requirement($plugin_name, $requirement,
+ $ignore_incompatible = TRUE,
$force_inclusion = FALSE)
{
$b = $version_array[1];
$c = $version_array[2];
+ // complicated way to say we are interested in these overrides
+ // if the version is applicable to us and if the overrides include
+ // the requirement we are looking for, or if the plugin is not
+ // compatible with this version of SquirrelMail (unless we are
+ // told to ignore such)
+ //
if (check_sm_version($a, $b, $c)
- && ( !empty($requirement_overrides[SQ_INCOMPATIBLE])
- || (isset($requirement_overrides[$requirement])
- && !is_null($requirement_overrides[$requirement]))))
+ && ((!$ignore_incompatible
+ && (!empty($requirement_overrides[SQ_INCOMPATIBLE])
+ || $requirement_overrides === SQ_INCOMPATIBLE))
+ || (is_array($requirement_overrides)
+ && isset($requirement_overrides[$requirement])
+ && !is_null($requirement_overrides[$requirement]))))
{
if (empty($highest_version_array)
&& $highest_version_array[2] < $c))
{
$highest_version_array = $version_array;
- if (!empty($requirement_overrides[SQ_INCOMPATIBLE]))
+ if (!empty($requirement_overrides[SQ_INCOMPATIBLE])
+ || $requirement_overrides === SQ_INCOMPATIBLE)
$requirement_value_override = SQ_INCOMPATIBLE;
else
$requirement_value_override = $requirement_overrides[$requirement];
* which might vary per the value of $do_parse
* as well as if the plugin requires a SquirrelMail
* core plugin, in which case it is "CORE" or
- * "CORE:1.5.2" or similar), 'activate' - value is
- * boolean: TRUE indicates that the plugin must
- * also be activated, FALSE means that it only
- * needs to be present, but does not need to be
- * activated. Note that the return value might
- * be an empty array, indicating that the plugin
- * has no dependencies.
+ * "CORE:1.5.2" or similar, or, if the plugin is
+ * actually incompatible (not required) with this
+ * one, the constant SQ_INCOMPATIBLE will be found
+ * here), 'activate' - value is boolean: TRUE
+ * indicates that the plugin must also be activated,
+ * FALSE means that it only needs to be present,
+ * but does not need to be activated. Note that
+ * the return value might be an empty array,
+ * indicating that the plugin has no dependencies.
*
*/
function get_plugin_dependencies($plugin_name, $force_inclusion = FALSE,
$plugin_dependencies = get_plugin_requirement($plugin_name,
'required_plugins',
+ FALSE,
$force_inclusion);
// the plugin is simply incompatible, no need to continue here
// parse version into something we understand?
//
- if ($do_parse)
+ if ($do_parse && $plugin_requirements['version'] != SQ_INCOMPATIBLE)
{
// massage version number into something we understand
* corresponding values) will be available:
* 'version' - value is the minimum version
* required for that plugin (in printable, non-
- * parsed format), 'activate' - value is boolean:
- * TRUE indicates that the plugin must also be
- * activated, FALSE means that it only needs to
- * be present, but does not need to be activated.
+ * parsed format) or the constant SQ_INCOMPATIBLE,
+ * which indicates that the plugin is actually
+ * incompatible (not required), 'activate' - value
+ * is boolean: TRUE indicates that the plugin must
+ * also be activated, FALSE means that it only needs
+ * to be present, but does not need to be activated.
*
*/
function check_plugin_dependencies($plugin_name, $force_inclusion = FALSE)
{
$version = explode('.', substr($depend_requirements['version'], strpos($depend_requirements['version'], ':') + 1), 3);
$version[0] = intval($version[0]);
- $version[1] = intval($version[1]);
- $version[2] = intval($version[2]);
+ if (isset($version[1])) $version[1] = intval($version[1]);
+ else $version[1] = 0;
+ if (isset($version[2])) $version[2] = intval($version[2]);
+ else $version[2] = 0;
if (!check_sm_version($version[0], $version[1], $version[2]))
$missing_or_bad[$depend_name] = $depend_requirements;
}
+ // if the plugin is actually incompatible; check that it
+ // is not activated
+ //
+ if ($depend_requirements['version'] == SQ_INCOMPATIBLE)
+ {
+
+ if (is_plugin_enabled($depend_name))
+ $missing_or_bad[$depend_name] = $depend_requirements;
+
+ continue;
+
+ }
+
// check for normal plugins
//
$version = explode('.', $depend_requirements['version'], 3);
$version[0] = intval($version[0]);
- $version[1] = intval($version[1]);
- $version[2] = intval($version[2]);
+ if (isset($version[1])) $version[1] = intval($version[1]);
+ else $version[1] = 0;
+ if (isset($version[2])) $version[2] = intval($version[2]);
+ else $version[2] = 0;
$force_dependency_inclusion = !$depend_requirements['activate'];
projects / squirrelmail.git / blobdiff