SimpleSAML\Store\SQL Class Reference

Inheritance diagram for SimpleSAML\Store\SQL:

Collaboration diagram for SimpleSAML\Store\SQL:

Public Member Functions
	getTableVersion ($name)
	Get table version. More...
	setTableVersion ($name, $version)
	Set table version. More...
	insertOrUpdate ($table, array $keys, array $data)
	Insert or update a key-value in the store. More...
	get ($type, $key)
	Retrieve a value from the data store. More...
	set ($type, $key, $value, $expire=null)
	Save a value in the data store. More...
	delete ($type, $key)
	Delete an entry from the data store. More...
Public Member Functions inherited from SimpleSAML\Store
	get ($type, $key)
	Retrieve a value from the data store. More...
	set ($type, $key, $value, $expire=null)
	Save a value to the data store. More...
	delete ($type, $key)
	Delete a value from the data store. More...

Data Fields
	$pdo
	$driver
	$prefix

Protected Member Functions
	__construct ()
	Initialize the SQL data store. More...

Private Member Functions
	initTableVersionTable ()
	Initialize the table-version table. More...
	initKVTable ()
	Initialize key-value table. More...
	cleanKVStore ()
	Clean the key-value table of expired entries. More...

Private Attributes
	$tableVersions

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\Store
static	getInstance ()
	Retrieve our singleton instance. More...

Detailed Description

Definition at line 14 of file SQL.php.

Constructor & Destructor Documentation

__construct()

SimpleSAML\Store\SQL::__construct ( )

protected

Initialize the SQL data store.

Definition at line 51 of file SQL.php.

References $config, $password, SimpleSAML\Store\SQL\initKVTable(), and SimpleSAML\Store\SQL\initTableVersionTable().

    {
        $config = Configuration::getInstance();

        $dsn = $config->getString('store.sql.dsn');
        $username = $config->getString('store.sql.username', null);
        $password = $config->getString('store.sql.password', null);
        $this->prefix = $config->getString('store.sql.prefix', 'simpleSAMLphp');

        $this->pdo = new \PDO($dsn, $username, $password);
        $this->pdo->setAttribute(\PDO::ATTR_ERRMODE, \PDO::ERRMODE_EXCEPTION);

        $this->driver = $this->pdo->getAttribute(\PDO::ATTR_DRIVER_NAME);

        if ($this->driver === 'mysql') {
            $this->pdo->exec('SET time_zone = "+00:00"');
        }

        $this->initTableVersionTable();
        $this->initKVTable();
    }

Here is the call graph for this function:

Member Function Documentation

cleanKVStore()

SimpleSAML\Store\SQL::cleanKVStore ( )

private

Clean the key-value table of expired entries.

Definition at line 230 of file SQL.php.

References $params, $query, array, and SimpleSAML\Logger\debug().

Referenced by SimpleSAML\Store\SQL\set().

    {
        Logger::debug('store.sql: Cleaning key-value store.');

        $query = 'DELETE FROM '.$this->prefix.'_kvstore WHERE _expire < :now';
        $params = array('now' => gmdate('Y-m-d H:i:s'));

        $query = $this->pdo->prepare($query);
        $query->execute($params);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

SimpleSAML\Store\SQL::delete	(		$type,
			$key
	)

Delete an entry from the data store.

Parameters

string	$type	The type of the data
string	$key	The key to delete.

Definition at line 331 of file SQL.php.

References $data, $query, $type, and array.

    {
        assert('is_string($type)');
        assert('is_string($key)');

        if (strlen($key) > 50) {
            $key = sha1($key);
        }

        $data = array(
            '_type' => $type,
            '_key'  => $key,
        );

        $query = 'DELETE FROM '.$this->prefix.'_kvstore WHERE _type=:_type AND _key=:_key';
        $query = $this->pdo->prepare($query);
        $query->execute($data);
    }

get()

SimpleSAML\Store\SQL::get	(		$type,
			$key
	)

Retrieve a value from the data store.

Parameters

string	$type	The type of the data.
string	$key	The key to retrieve.

Returns

mixed|null The value associated with that key, or null if there's no such key.

Definition at line 250 of file SQL.php.

References $key, $params, $query, $row, $type, and array.

    {
        assert('is_string($type)');
        assert('is_string($key)');

        if (strlen($key) > 50) {
            $key = sha1($key);
        }

        $query = 'SELECT _value FROM '.$this->prefix.
                 '_kvstore WHERE _type = :type AND _key = :key AND (_expire IS NULL OR _expire > :now)';
        $params = array('type' => $type, 'key' => $key, 'now' => gmdate('Y-m-d H:i:s'));

        $query = $this->pdo->prepare($query);
        $query->execute($params);

        $row = $query->fetch(\PDO::FETCH_ASSOC);
        if ($row === false) {
            return null;
        }

        $value = $row['_value'];
        if (is_resource($value)) {
            $value = stream_get_contents($value);
        }
        $value = urldecode($value);
        $value = unserialize($value);

        if ($value === false) {
            return null;
        }
        return $value;
    }

getTableVersion()

SimpleSAML\Store\SQL::getTableVersion

(

$name

)

Get table version.

Parameters

string

$name

Table name.

Returns

int The table version, or 0 if the table doesn't exist.

Definition at line 131 of file SQL.php.

References $name.

Referenced by SimpleSAML\Store\SQL\initKVTable().

    {
        assert('is_string($name)');

        if (!isset($this->tableVersions[$name])) {
            return 0;
        }

        return $this->tableVersions[$name];
    }

Here is the caller graph for this function:

initKVTable()

SimpleSAML\Store\SQL::initKVTable ( )

private

Initialize key-value table.

Definition at line 100 of file SQL.php.

References $query, SimpleSAML\Store\SQL\getTableVersion(), and SimpleSAML\Store\SQL\setTableVersion().

Referenced by SimpleSAML\Store\SQL\__construct().

    {
        if ($this->getTableVersion('kvstore') === 1) {
            // Table initialized
            return;
        }

        $text_t = 'TEXT';
        if ($this->driver === 'mysql') {
            // TEXT data type has size constraints that can be hit at some point, so we use LONGTEXT instead
            $text_t = 'LONGTEXT';
        }
        $query = 'CREATE TABLE '.$this->prefix.
                 '_kvstore (_type VARCHAR(30) NOT NULL, _key VARCHAR(50) NOT NULL, _value '.$text_t.
                 ' NOT NULL, _expire TIMESTAMP, PRIMARY KEY (_key, _type))';
        $this->pdo->exec($query);

        $query = 'CREATE INDEX '.$this->prefix.'_kvstore_expire ON '.$this->prefix.'_kvstore (_expire)';
        $this->pdo->exec($query);

        $this->setTableVersion('kvstore', 1);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initTableVersionTable()

SimpleSAML\Store\SQL::initTableVersionTable ( )

private

Initialize the table-version table.

Definition at line 77 of file SQL.php.

References $row, and array.

Referenced by SimpleSAML\Store\SQL\__construct().

    {
        $this->tableVersions = array();

        try {
            $fetchTableVersion = $this->pdo->query('SELECT _name, _version FROM '.$this->prefix.'_tableVersion');
        } catch (\PDOException $e) {
            $this->pdo->exec(
                'CREATE TABLE '.$this->prefix.
                '_tableVersion (_name VARCHAR(30) NOT NULL UNIQUE, _version INTEGER NOT NULL)'
            );
            return;
        }

        while (($row = $fetchTableVersion->fetch(\PDO::FETCH_ASSOC)) !== false) {
            $this->tableVersions[$row['_name']] = (int) $row['_version'];
        }
    }

Here is the caller graph for this function:

insertOrUpdate()

SimpleSAML\Store\SQL::insertOrUpdate	(		$table,
		array	$keys,
		array	$data
	)

Insert or update a key-value in the store.

Since various databases implement different methods for doing this, we abstract it away here.

Parameters

string	$table	The table we should update.
array	$keys	The key columns.
array	$data	Associative array with columns.

Definition at line 172 of file SQL.php.

References $query, array, SimpleSAML\Logger\error(), and string.

Referenced by SimpleSAML\Store\SQL\set(), and SimpleSAML\Store\SQL\setTableVersion().

    {
        assert('is_string($table)');

        $colNames = '('.implode(', ', array_keys($data)).')';
        $values = 'VALUES(:'.implode(', :', array_keys($data)).')';

        switch ($this->driver) {
            case 'mysql':
                $query = 'REPLACE INTO '.$table.' '.$colNames.' '.$values;
                $query = $this->pdo->prepare($query);
                $query->execute($data);
                return;
            case 'sqlite':
                $query = 'INSERT OR REPLACE INTO '.$table.' '.$colNames.' '.$values;
                $query = $this->pdo->prepare($query);
                $query->execute($data);
                return;
        }

        // default implementation, try INSERT, and UPDATE if that fails.
        $insertQuery = 'INSERT INTO '.$table.' '.$colNames.' '.$values;
        $insertQuery = $this->pdo->prepare($insertQuery);
        try {
            $insertQuery->execute($data);
            return;
        } catch (\PDOException $e) {
            $ecode = (string) $e->getCode();
            switch ($ecode) {
                case '23505': // PostgreSQL
                    break;
                default:
                    Logger::error('Error while saving data: '.$e->getMessage());
                    throw $e;
            }
        }

        $updateCols = array();
        $condCols = array();
        foreach ($data as $col => $value) {
            $tmp = $col.' = :'.$col;

            if (in_array($col, $keys, true)) {
                $condCols[] = $tmp;
            } else {
                $updateCols[] = $tmp;
            }
        }

        $updateQuery = 'UPDATE '.$table.' SET '.implode(',', $updateCols).' WHERE '.implode(' AND ', $condCols);
        $updateQuery = $this->pdo->prepare($updateQuery);
        $updateQuery->execute($data);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

set()

SimpleSAML\Store\SQL::set	(		$type,
			$key,
			$value,
			$expire = null
	)

Save a value in the data store.

Parameters

string	$type	The type of the data.
string	$key	The key to insert.
mixed	$value	The value itself.
int | null	$expire	The expiration time (unix timestamp), or null if it never expires.

Definition at line 293 of file SQL.php.

References $data, $type, array, SimpleSAML\Store\SQL\cleanKVStore(), and SimpleSAML\Store\SQL\insertOrUpdate().

    {
        assert('is_string($type)');
        assert('is_string($key)');
        assert('is_null($expire) || (is_int($expire) && $expire > 2592000)');

        if (rand(0, 1000) < 10) {
            $this->cleanKVStore();
        }

        if (strlen($key) > 50) {
            $key = sha1($key);
        }

        if ($expire !== null) {
            $expire = gmdate('Y-m-d H:i:s', $expire);
        }

        $value = serialize($value);
        $value = rawurlencode($value);

        $data = array(
            '_type'   => $type,
            '_key'    => $key,
            '_value'  => $value,
            '_expire' => $expire,
        );

        $this->insertOrUpdate($this->prefix.'_kvstore', array('_type', '_key'), $data);
    }

Here is the call graph for this function:

setTableVersion()

SimpleSAML\Store\SQL::setTableVersion	(		$name,
			$version
	)

Set table version.

Parameters

string	$name	Table name.
int	$version	Table version.

Definition at line 149 of file SQL.php.

References $name, $version, array, and SimpleSAML\Store\SQL\insertOrUpdate().

Referenced by SimpleSAML\Store\SQL\initKVTable().

    {
        assert('is_string($name)');
        assert('is_int($version)');

        $this->insertOrUpdate(
            $this->prefix.'_tableVersion',
            array('_name'),
            array('_name' => $name, '_version' => $version)
        );
        $this->tableVersions[$name] = $version;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$driver

SimpleSAML\Store\SQL::$driver

Definition at line 29 of file SQL.php.

$pdo

SimpleSAML\Store\SQL::$pdo

Definition at line 21 of file SQL.php.

$prefix

SimpleSAML\Store\SQL::$prefix

Definition at line 37 of file SQL.php.

$tableVersions

SimpleSAML\Store\SQL::$tableVersions

private

Definition at line 45 of file SQL.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/Store/SQL.php