SimpleSAML\Module Class Reference

Collaboration diagram for SimpleSAML\Module:

Static Public Member Functions
static	autoloadPSR0 ($className)
	Autoload function for SimpleSAMLphp modules following PSR-0. More...
static	autoloadPSR4 ($className)
	Autoload function for SimpleSAMLphp modules following PSR-4. More...
static	getModuleDir ($module)
	Retrieve the base directory for a module. More...
static	isModuleEnabled ($module)
	Determine whether a module is enabled. More...
static	getModules ()
	Get available modules. More...
static	resolveClass ($id, $type, $subclass=null)
	Resolve module class. More...
static	getModuleURL ($resource, array $parameters=array())
	Get absolute URL to a specified module resource. More...
static	getModuleHooks ($module)
	Get the available hooks for a given module. More...
static	callHooks ($hook, &$data=null)
	Call a hook in all enabled modules. More...

Static Public Attributes
static	$modules = array()
static	$module_info = array()

Static Private Member Functions
static	isModuleEnabledWithConf ($module, $mod_config)

Detailed Description

Definition at line 12 of file Module.php.

Member Function Documentation

autoloadPSR0()

static SimpleSAML\Module::autoloadPSR0 (   $className )

static

Autoload function for SimpleSAMLphp modules following PSR-0.

Parameters

string

$className

Name of the class.

Deprecated:

This method will be removed in SSP 2.0.

TODO: this autoloader should be removed once everything has been migrated to namespaces.

Definition at line 39 of file Module.php.

    {
        $modulePrefixLength = strlen('sspmod_');
        $classPrefix = substr($className, 0, $modulePrefixLength);
        if ($classPrefix !== 'sspmod_') {
            return;
        }
 
        $modNameEnd = strpos($className, '_', $modulePrefixLength);
        $module = substr($className, $modulePrefixLength, $modNameEnd - $modulePrefixLength);
        $path = explode('_', substr($className, $modNameEnd + 1));
 
        if (!self::isModuleEnabled($module)) {
            return;
        }
 
        $file = self::getModuleDir($module).'/lib/'.join('/', $path).'.php';
        if (!file_exists($file)) {
            return;
        }
        require_once($file);
 
        if (!class_exists($className, false) && !interface_exists($className, false)) {
            // the file exists, but the class is not defined. Is it using namespaces?
            $nspath = join('\\', $path);
            if (class_exists('SimpleSAML\Module\\'.$module.'\\'.$nspath) ||
                interface_exists('SimpleSAML\Module\\'.$module.'\\'.$nspath)
            ) {
                // the class has been migrated, create an alias and warn about it
                \SimpleSAML\Logger::warning(
                    "The class or interface '$className' is now using namespaces, please use 'SimpleSAML\\Module\\".
                    $module."\\".$nspath."' instead."
                );
                class_alias("SimpleSAML\\Module\\$module\\$nspath", $className);
            }
        }
    }

References $file, $module, $path, and SimpleSAML\Logger\warning().

Here is the call graph for this function:

autoloadPSR4()

static SimpleSAML\Module::autoloadPSR4 (   $className )

static

Autoload function for SimpleSAMLphp modules following PSR-4.

Parameters

string

$className

Name of the class.

Definition at line 83 of file Module.php.

    {
        $elements = explode('\\', $className);
        if ($elements[0] === '') { // class name starting with /, ignore
            array_shift($elements);
        }
        if (count($elements) < 4) {
            return; // it can't be a module
        }
        if (array_shift($elements) !== 'SimpleSAML') {
            return; // the first element is not "SimpleSAML"
        }
        if (array_shift($elements) !== 'Module') {
            return; // the second element is not "module"
        }
 
        // this is a SimpleSAMLphp module following PSR-4
        $module = array_shift($elements);
        if (!self::isModuleEnabled($module)) {
            return; // module not enabled, avoid giving out any information at all
        }
 
        $file = self::getModuleDir($module).'/lib/'.implode('/', $elements).'.php';
 
        if (file_exists($file)) {
            require_once($file);
        }
    }

References $file, and $module.

callHooks()

static SimpleSAML\Module::callHooks (   $hook, &  $data = null  )

static

Call a hook in all enabled modules.

This function iterates over all enabled modules and calls a hook in each module.

Parameters

string	$hook	The name of the hook.
mixed	&$data	The data which should be passed to each hook. Will be passed as a reference.

Exceptions

SimpleSAML_Error_Exception If an invalid hook is found in a module.

Definition at line 364 of file Module.php.

    {
        assert('is_string($hook)');
 
        $modules = self::getModules();
        $config = \SimpleSAML_Configuration::getOptionalConfig()->getArray('module.enable', array());
        sort($modules);
        foreach ($modules as $module) {
            if (!self::isModuleEnabledWithConf($module, $config)) {
                continue;
            }
 
            if (!isset(self::$module_info[$module]['hooks'])) {
                self::$module_info[$module]['hooks'] = self::getModuleHooks($module);
            }
 
            if (!isset(self::$module_info[$module]['hooks'][$hook])) {
                continue;
            }
 
            require_once(self::$module_info[$module]['hooks'][$hook]['file']);
 
            if (!is_callable(self::$module_info[$module]['hooks'][$hook]['func'])) {
                throw new \SimpleSAML_Error_Exception('Invalid hook \''.$hook.'\' for module \''.$module.'\'.');
            }
 
            $fn = self::$module_info[$module]['hooks'][$hook]['func'];
            $fn($data);
        }
    }

Referenced by core_hook_sanitycheck(), sspmod_portal_Portal\getLoginInfo(), portal_hook_htmlinject(), SimpleSAML\Module\cron\Cron\runTag(), sanitycheck_hook_cron(), and SimpleSAML_exception_handler().

Here is the caller graph for this function:

getModuleDir()

static SimpleSAML\Module::getModuleDir (   $module )

static

Retrieve the base directory for a module.

The returned path name will be an absolute path.

Parameters

string

$module

Name of the module

Returns

string The base directory of a module.

Definition at line 122 of file Module.php.

    {
        $baseDir = dirname(dirname(dirname(__FILE__))).'/modules';
        $moduleDir = $baseDir.'/'.$module;
 
        return $moduleDir;
    }

References $baseDir, $module, and $moduleDir.

Referenced by SimpleSAML_XHTML_Template\findThemeTemplateDirs(), SimpleSAML\Locale\Translate\getDictionary(), and sspmod_core_Auth_Process_AttributeMap\loadMapFile().

Here is the caller graph for this function:

getModuleHooks()

static SimpleSAML\Module::getModuleHooks (   $module )

static

Get the available hooks for a given module.

Parameters

string

$module

The module where we should look for hooks.

Returns

array An array with the hooks available for this module. Each element is an array with two keys: 'file' points to the file that contains the hook, and 'func' contains the name of the function implementing that hook. When there are no hooks defined, an empty array is returned.

Definition at line 325 of file Module.php.

    {
        if (isset(self::$modules[$module]['hooks'])) {
            return self::$modules[$module]['hooks'];
        }
 
        $hook_dir = self::getModuleDir($module).'/hooks';
        if (!is_dir($hook_dir)) {
            return array();
        }
 
        $hooks = array();
        $files = scandir($hook_dir);
        foreach ($files as $file) {
            if ($file[0] === '.') {
                continue;
            }
 
            if (!preg_match('/hook_(\w+)\.php/', $file, $matches)) {
                continue;
            }
            $hook_name = $matches[1];
            $hook_func = $module.'_hook_'.$hook_name;
            $hooks[$hook_name] = array('file' => $hook_dir.'/'.$file, 'func' => $hook_func);
        }
        return $hooks;
    }

getModules()

static SimpleSAML\Module::getModules ( )

static

Get available modules.

Returns

array One string for each module.

Exceptions

Exception If we cannot open the module's directory.

Definition at line 204 of file Module.php.

    {
        if (!empty(self::$modules)) {
            return self::$modules;
        }
 
        $path = self::getModuleDir('.');
 
        $dh = scandir($path);
        if ($dh === false) {
            throw new \Exception('Unable to open module directory "'.$path.'".');
        }
 
        foreach ($dh as $f) {
            if ($f[0] === '.') {
                continue;
            }
 
            if (!is_dir($path.'/'.$f)) {
                continue;
            }
 
            self::$modules[] = $f;
        }
 
        return self::$modules;
    }

References $path.

Referenced by core_hook_sanitycheck().

Here is the caller graph for this function:

getModuleURL()

static SimpleSAML\Module::getModuleURL (   $resource, array  $parameters = array()  )

static

Get absolute URL to a specified module resource.

This function creates an absolute URL to a resource stored under ".../modules/<module>/www/".

Parameters

string	$resource	Resource path, on the form "<module name>/<resource>"
array	$parameters	Extra parameters which should be added to the URL. Optional.

Returns

string The absolute URL to the given resource.

Definition at line 303 of file Module.php.

    {
        assert('is_string($resource)');
        assert('$resource[0] !== "/"');
 
        $url = Utils\HTTP::getBaseURL().'module.php/'.$resource;
        if (!empty($parameters)) {
            $url = Utils\HTTP::addURLParameters($url, $parameters);
        }
        return $url;
    }

Referenced by sspmod_saml_Auth_Source_SP\__construct(), sspmod_saml_Auth_Source_SP\askForIdPChange(), sspmod_authfacebook_Auth_Source_Facebook\authenticate(), sspmod_authtwitter_Auth_Source_Twitter\authenticate(), sspmod_authYubiKey_Auth_Source_YubiKey\authenticate(), sspmod_cas_Auth_Source_CAS\authenticate(), sspmod_core_Auth_UserPassBase\authenticate(), sspmod_core_Auth_UserPassOrgBase\authenticate(), sspmod_exampleauth_Auth_Source_External\authenticate(), sspmod_multiauth_Auth_Source_MultiAuth\authenticate(), SimpleSAML_Utilities\createHttpPostRedirectLink(), sspmod_cas_Auth_Source_CAS\finalStep(), SimpleSAML\Utils\Auth\getAdminLoginURL(), getBaseURL(), SimpleSAML\Auth\Simple\getLoginURL(), SimpleSAML\Auth\Simple\getLogoutURL(), sspmod_adfs_IdP_ADFS\getLogoutURL(), sspmod_saml_IdP_SAML2\getLogoutURL(), sspmod_saml_Auth_Source_SP\getMetadataURL(), SimpleSAML\Utils\HTTP\getSecurePOSTRedirectURL(), SimpleSAML_IdP\handleLogoutRequest(), sspmod_consent_Logout\postLogout(), sspmod_authX509_Auth_Process_ExpiryWarning\process(), sspmod_cdc_Auth_Process_CDC\process(), sspmod_consent_Auth_Process_Consent\process(), sspmod_core_Auth_Process_WarnShortSSOInterval\process(), sspmod_exampleauth_Auth_Process_RedirectTest\process(), sspmod_expirycheck_Auth_Process_ExpiryDate\process(), sspmod_preprodwarning_Auth_Process_Warning\process(), sspmod_saml_Auth_Source_SP\startDisco(), SimpleSAML\IdP\IFrameLogoutHandler\startLogout(), sspmod_saml_Auth_Source_SP\startSSO1(), sspmod_authorize_Auth_Process_Authorize\unauthorized(), and sspmod_saml_Auth_Process_ExpectedAuthnContextClassRef\unauthorized().

Here is the caller graph for this function:

isModuleEnabled()

static SimpleSAML\Module::isModuleEnabled (   $module )

static

Determine whether a module is enabled.

Will return false if the given module doesn't exist.

Parameters

string

$module

Name of the module

Returns

bool True if the given module is enabled, false otherwise.

Exceptions

Exception If module.enable is set and is not boolean.

Definition at line 142 of file Module.php.

    {
        $config = \SimpleSAML_Configuration::getOptionalConfig();
        return self::isModuleEnabledWithConf($module, $config->getArray('module.enable', array()));
    }

References $config, $module, and SimpleSAML_Configuration\getOptionalConfig().

Here is the call graph for this function:

isModuleEnabledWithConf()

static SimpleSAML\Module::isModuleEnabledWithConf (   $module,   $mod_config  )

staticprivate

Definition at line 149 of file Module.php.

    {
        if (isset(self::$module_info[$module]['enabled'])) {
            return self::$module_info[$module]['enabled'];
        }
 
        if (!empty(self::$modules) && !in_array($module, self::$modules, true)) {
            return false;
        }
 
        $moduleDir = self::getModuleDir($module);
 
        if (!is_dir($moduleDir)) {
            self::$module_info[$module]['enabled'] = false;
            return false;
        }
 
        if (isset($mod_config[$module])) {
            if (is_bool($mod_config[$module])) {
                self::$module_info[$module]['enabled'] = $mod_config[$module];
                return $mod_config[$module];
            }
 
            throw new \Exception("Invalid module.enable value for the '$module' module.");
        }
 
        if (assert_options(ASSERT_ACTIVE) &&
            !file_exists($moduleDir.'/default-enable') &&
            !file_exists($moduleDir.'/default-disable')
        ) {
            \SimpleSAML\Logger::error("Missing default-enable or default-disable file for the module $module");
        }
 
        if (file_exists($moduleDir.'/enable')) {
            self::$module_info[$module]['enabled'] = true;
            return true;
        }
 
        if (!file_exists($moduleDir.'/disable') && file_exists($moduleDir.'/default-enable')) {
            self::$module_info[$module]['enabled'] = true;
            return true;
        }
 
        self::$module_info[$module]['enabled'] = false;
        return false;
    }

References $module, $moduleDir, and SimpleSAML\Logger\error().

Here is the call graph for this function:

resolveClass()

static SimpleSAML\Module::resolveClass (   $id,   $type,   $subclass = null  )

static

Resolve module class.

This function takes a string on the form "<module>:<class>" and converts it to a class name. It can also check that the given class is a subclass of a specific class. The resolved classname will be "sspmod_<module>_<$type>_<class>.

It is also possible to specify a full classname instead of <module>:<class>.

An exception will be thrown if the class can't be resolved.

Parameters

string	$id	The string we should resolve.
string	$type	The type of the class.
string | null	$subclass	The class should be a subclass of this class. Optional.

Returns

string The classname.

Exceptions

Exception If the class cannot be resolved.

Definition at line 252 of file Module.php.

    {
        assert('is_string($id)');
        assert('is_string($type)');
        assert('is_string($subclass) || is_null($subclass)');
 
        $tmp = explode(':', $id, 2);
        if (count($tmp) === 1) { // no module involved
            $className = $tmp[0];
            if (!class_exists($className)) {
                throw new \Exception("Could not resolve '$id': no class named '$className'.");
            }
        } else { // should be a module
            // make sure empty types are handled correctly
            $type = (empty($type)) ? '_' : '_'.$type.'_';
 
            // check for the old-style class names
            $className = 'sspmod_'.$tmp[0].$type.$tmp[1];
 
            if (!class_exists($className)) {
                // check for the new-style class names, using namespaces
                $type = str_replace('_', '\\', $type);
                $newClassName = 'SimpleSAML\Module\\'.$tmp[0].$type.$tmp[1];
 
                if (!class_exists($newClassName)) {
                    throw new \Exception("Could not resolve '$id': no class named '$className' or '$newClassName'.");
                }
                $className = $newClassName;
            }
        }
 
        if ($subclass !== null && !is_subclass_of($className, $subclass)) {
            throw new \Exception(
                'Could not resolve \''.$id.'\': The class \''.$className.'\' isn\'t a subclass of \''.$subclass.'\'.'
            );
        }
 
        return $className;
    }

References $id, and $type.

Referenced by SimpleSAML_Stats\createOutput(), sspmod_statistics_StatDataset\getDelimiterPresentation(), sspmod_statistics_Ruleset\getRule(), SimpleSAML_Metadata_MetaDataStorageSource\getSource(), SimpleSAML_Auth_Source\parseAuthSource(), SimpleSAML_Auth_ProcessingChain\parseFilter(), and sspmod_consent_Store\parseStoreConfig().

Here is the caller graph for this function:

Field Documentation

$module_info

SimpleSAML\Module::$module_info = array()

static

Definition at line 27 of file Module.php.

$modules

SimpleSAML\Module::$modules = array()

static

Definition at line 20 of file Module.php.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Module.php