SimpleSAML_Metadata_MetaDataStorageHandlerSerialize Class Reference

Inheritance diagram for SimpleSAML_Metadata_MetaDataStorageHandlerSerialize:

Collaboration diagram for SimpleSAML_Metadata_MetaDataStorageHandlerSerialize:

Public Member Functions
	__construct ($config)
	Constructor for this metadata handler. More...
	getMetadataSets ()
	Retrieve a list of all available metadata sets. More...
	getMetadataSet ($set)
	Retrieve a list of all available metadata for a given set. More...
	getMetaData ($entityId, $set)
	Retrieve a metadata entry. More...
	saveMetadata ($entityId, $set, $metadata)
	Save a metadata entry. More...
	deleteMetadata ($entityId, $set)
	Delete a metadata entry. More...
Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
	getMetadataSet ($set)
	This function attempts to generate an associative array with metadata for all entities in the given set. More...
	getEntityIdFromHostPath ($hostPath, $set, $type='entityid')
	This function resolves an host/path combination to an entity id. More...
	getPreferredEntityIdFromCIDRhint ($set, $ip, $type='entityid')
	This function will go through all the metadata, and check the DiscoHints->IPHint parameter, which defines a network space (ip range) for each remote entry. More...
	getMetaData ($index, $set)
	This function retrieves metadata for the given entity id in the given set of metadata. More...

Data Fields
const	EXTENSION = '.serialized'

Private Member Functions
	getMetadataPath ($entityId, $set)
	Helper function for retrieving the path of a metadata file. More...

Private Attributes
	$directory

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML_Metadata_MetaDataStorageSource
static	parseSources ($sourcesConfig)
	Parse array with metadata sources. More...
static	getSource ($sourceConfig)
	This function creates a metadata source based on the given configuration. More...

Detailed Description

Definition at line 9 of file MetaDataStorageHandlerSerialize.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::__construct

(

$config

)

Constructor for this metadata handler.

Parses configuration.

Parameters

array

$config

The configuration for this metadata handler.

Definition at line 35 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_array($config));
 
        $globalConfig = SimpleSAML_Configuration::getInstance();
 
        $cfgHelp = SimpleSAML_Configuration::loadFromArray($config, 'serialize metadata source');
 
        $this->directory = $cfgHelp->getString('directory');
 
        /* Resolve this directory relative to the SimpleSAMLphp directory (unless it is
         * an absolute path).
         */
        $this->directory = $globalConfig->resolvePath($this->directory);
    }

References $config, $globalConfig, SimpleSAML_Configuration\getInstance(), and SimpleSAML_Configuration\loadFromArray().

Here is the call graph for this function:

Member Function Documentation

deleteMetadata()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::deleteMetadata	(		$entityId,
			$set
	)

Delete a metadata entry.

Parameters

string	$entityId	The entityId of the metadata entry.
string	$set	The metadata set this metadata entry belongs to.

Definition at line 262 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_string($entityId));
        assert(is_string($set));
 
        $filePath = $this->getMetadataPath($entityId, $set);
 
        if (!file_exists($filePath)) {
            SimpleSAML\Logger::warning(
                'Attempted to erase nonexistent metadata entry '.
                var_export($entityId, true).' in set '.var_export($set, true).'.'
            );
            return;
        }
 
        $res = unlink($filePath);
        if ($res === false) {
            $error = error_get_last();
            SimpleSAML\Logger::error(
                'Failed to delete file '.$filePath.
                ': '.$error['message']
            );
        }
    }

References $entityId, $res, SimpleSAML\Logger\error(), getMetadataPath(), and SimpleSAML\Logger\warning().

Here is the call graph for this function:

getMetaData()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::getMetaData	(		$entityId,
			$set
	)

Retrieve a metadata entry.

Parameters

string	$entityId	The entityId we are looking up.
string	$set	The set we are looking for metadata in.

Returns

array An associative array with metadata for the given entity, or NULL if we are unable to locate the entity.

Reimplemented from SimpleSAML_Metadata_MetaDataStorageSource.

Definition at line 171 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_string($entityId));
        assert(is_string($set));
 
        $filePath = $this->getMetadataPath($entityId, $set);
 
        if (!file_exists($filePath)) {
            return null;
        }
 
        $data = @file_get_contents($filePath);
        if ($data === false) {
            $error = error_get_last();
            SimpleSAML\Logger::warning(
                'Error reading file '.$filePath.': '.$error['message']
            );
            return null;
        }
 
        $data = @unserialize($data);
        if ($data === false) {
            SimpleSAML\Logger::warning('Error unserializing file: '.$filePath);
            return null;
        }
 
        if (!array_key_exists('entityid', $data)) {
            $data['entityid'] = $entityId;
        }
 
        return $data;
    }

References $data, $entityId, getMetadataPath(), and SimpleSAML\Logger\warning().

Referenced by getMetadataSet().

Here is the call graph for this function:

Here is the caller graph for this function:

getMetadataPath()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::getMetadataPath (   $entityId,   $set  )

private

Helper function for retrieving the path of a metadata file.

Parameters

string	$entityId	The entity ID.
string	$set	The metadata set.

Returns

string The path to the metadata file.

Definition at line 60 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_string($entityId));
        assert(is_string($set));
 
        return $this->directory.'/'.rawurlencode($set).'/'.rawurlencode($entityId).self::EXTENSION;
    }

References $entityId.

Referenced by deleteMetadata(), getMetaData(), and saveMetadata().

Here is the caller graph for this function:

getMetadataSet()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::getMetadataSet

(

$set

)

Retrieve a list of all available metadata for a given set.

Parameters

string

$set

The set we are looking for metadata in.

Returns

array An associative array with all the metadata for the given set.

Reimplemented from SimpleSAML_Metadata_MetaDataStorageSource.

Definition at line 118 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_string($set));
 
        $ret = array();
 
        $dir = $this->directory.'/'.rawurlencode($set);
        if (!is_dir($dir)) {
            // probably some code asked for a metadata set which wasn't available
            return $ret;
        }
 
        $dh = @opendir($dir);
        if ($dh === false) {
            SimpleSAML\Logger::warning('Serialize metadata handler: Unable to open directory: '.var_export($dir, true));
            return $ret;
        }
 
        $extLen = strlen(self::EXTENSION);
 
        while (($file = readdir($dh)) !== false) {
            if (strlen($file) <= $extLen) {
                continue;
            }
 
            if (substr($file, -$extLen) !== self::EXTENSION) {
                continue;
            }
 
            $entityId = substr($file, 0, -$extLen);
            $entityId = rawurldecode($entityId);
 
            $md = $this->getMetaData($entityId, $set);
            if ($md !== null) {
                $ret[$entityId] = $md;
            }
        }
 
        closedir($dh);
 
        return $ret;
    }

References $entityId, $ret, getMetaData(), and SimpleSAML\Logger\warning().

Here is the call graph for this function:

getMetadataSets()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::getMetadataSets

(

)

Retrieve a list of all available metadata sets.

Returns

array An array with the available sets.

Definition at line 74 of file MetaDataStorageHandlerSerialize.php.

    {
        $ret = array();
 
        $dh = @opendir($this->directory);
        if ($dh === false) {
            SimpleSAML\Logger::warning(
                'Serialize metadata handler: Unable to open directory: '.var_export($this->directory, true)
            );
            return $ret;
        }
 
        while (($entry = readdir($dh)) !== false) {
            if ($entry[0] === '.') {
                // skip '..', '.' and hidden files
                continue;
            }
 
            $path = $this->directory.'/'.$entry;
 
            if (!is_dir($path)) {
                SimpleSAML\Logger::warning(
                    'Serialize metadata handler: Metadata directory contained a file where only directories should '.
                    'exist: '.var_export($path, true)
                );
                continue;
            }
 
            $ret[] = rawurldecode($entry);
        }
 
        closedir($dh);
 
        return $ret;
    }

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

Here is the call graph for this function:

saveMetadata()

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::saveMetadata	(		$entityId,
			$set,
			$metadata
	)

Save a metadata entry.

Parameters

string	$entityId	The entityId of the metadata entry.
string	$set	The metadata set this metadata entry belongs to.
array	$metadata	The metadata.

Returns

boolean True if successfully saved, false otherwise.

Definition at line 214 of file MetaDataStorageHandlerSerialize.php.

    {
        assert(is_string($entityId));
        assert(is_string($set));
        assert(is_array($metadata));
 
        $filePath = $this->getMetadataPath($entityId, $set);
        $newPath = $filePath.'.new';
 
        $dir = dirname($filePath);
        if (!is_dir($dir)) {
            SimpleSAML\Logger::info('Creating directory: '.$dir);
            $res = @mkdir($dir, 0777, true);
            if ($res === false) {
                $error = error_get_last();
                SimpleSAML\Logger::error('Failed to create directory '.$dir.': '.$error['message']);
                return false;
            }
        }
 
        $data = serialize($metadata);
 
        SimpleSAML\Logger::debug('Writing: '.$newPath);
 
        $res = file_put_contents($newPath, $data);
        if ($res === false) {
            $error = error_get_last();
            SimpleSAML\Logger::error('Error saving file '.$newPath.': '.$error['message']);
            return false;
        }
 
        $res = rename($newPath, $filePath);
        if ($res === false) {
            $error = error_get_last();
            SimpleSAML\Logger::error('Error renaming '.$newPath.' to '.$filePath.': '.$error['message']);
            return false;
        }
 
        return true;
    }

References $data, $entityId, $metadata, $res, SimpleSAML\Logger\debug(), SimpleSAML\Logger\error(), getMetadataPath(), and SimpleSAML\Logger\info().

Here is the call graph for this function:

Field Documentation

$directory

SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::$directory

private

Definition at line 25 of file MetaDataStorageHandlerSerialize.php.

EXTENSION

const SimpleSAML_Metadata_MetaDataStorageHandlerSerialize::EXTENSION = '.serialized'

Definition at line 17 of file MetaDataStorageHandlerSerialize.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Metadata/MetaDataStorageHandlerSerialize.php