sspmod_consent_Consent_Store_Database Class Reference

Inheritance diagram for sspmod_consent_Consent_Store_Database:

Collaboration diagram for sspmod_consent_Consent_Store_Database:

Public Member Functions
	__construct ($config)
	Parse configuration. More...
	__sleep ()
	Called before serialization. More...
	hasConsent ($userId, $destinationId, $attributeSet)
	Check for consent. More...
	saveConsent ($userId, $destinationId, $attributeSet)
	Save consent. More...
	deleteConsent ($userId, $destinationId)
	Delete consent. More...
	deleteAllConsents ($userId)
	Delete all consents. More...
	getConsents ($userId)
	Retrieve consents. More...
	getStatistics ()
	Get statistics from the database. More...
	selftest ()
	A quick selftest of the consent database. More...
Public Member Functions inherited from sspmod_consent_Store
	hasConsent ($userId, $destinationId, $attributeSet)
	Check for consent. More...
	saveConsent ($userId, $destinationId, $attributeSet)
	Save consent. More...
	deleteConsent ($userId, $destinationId)
	Delete consent. More...
	deleteAllConsents ($userId)
	Delete all consents. More...
	getStatistics ()
	Get statistics for all consent given in the consent store. More...
	getConsents ($userId)
	Retrieve consents. More...

Private Member Functions
	_execute ($statement, $parameters)
	Prepare and execute statement. More...
	_createTable ()
	Create consent table. More...
	_getDB ()
	Get database handle. More...

Static Private Member Functions
static	_formatError ($error)
	Format PDO error. More...

Private Attributes
	$_dsn
	DSN for the database. More...
	$_dateTime
	The DATETIME SQL function to use. More...
	$_username
	Username for the database. More...
	$_password
	Password for the database;. More...
	$_table
	Table with consent. More...
	$_timeout = NULL
	$_db
	Database handle. More...

Additional Inherited Members
Static Public Member Functions inherited from sspmod_consent_Store
static	parseStoreConfig ($config)
	Parse consent storage configuration. More...
Protected Member Functions inherited from sspmod_consent_Store
	__construct (&$config)
	Constructor for the base class. More...

Detailed Description

Definition at line 18 of file Database.php.

Constructor & Destructor Documentation

__construct()

sspmod_consent_Consent_Store_Database::__construct

(

$config

)

Parse configuration.

This constructor parses the configuration.

Parameters

array

$config

Configuration for database consent store.

Exceptions

Exception

in case of a configuration error.

Definition at line 69 of file Database.php.

References $config.

    {
        parent::__construct($config);


        if (!array_key_exists('dsn', $config)) {
            throw new Exception('consent:Database - Missing required option \'dsn\'.');
        }
        if (!is_string($config['dsn'])) {
            throw new Exception('consent:Database - \'dsn\' is supposed to be a string.');
        }

        $this->_dsn = $config['dsn'];
        $this->_dateTime = (0 === strpos($this->_dsn, 'sqlite:')) ? 'DATETIME("NOW")' : 'NOW()';

        if (array_key_exists('username', $config)) {
            if (!is_string($config['username'])) {
                throw new Exception('consent:Database - \'username\' is supposed to be a string.');
            }
            $this->_username = $config['username'];
        } else {
            $this->_username = null;
        }

        if (array_key_exists('password', $config)) {
            if (!is_string($config['password'])) {
                throw new Exception('consent:Database - \'password\' is supposed to be a string.');
            }
            $this->_password = $config['password'];
        } else {
            $this->_password = null;
        }

        if (array_key_exists('table', $config)) {
            if (!is_string($config['table'])) {
                throw new Exception('consent:Database - \'table\' is supposed to be a string.');
            }
            $this->_table = $config['table'];
        } else {
            $this->_table = 'consent';
        }

        if (isset($config['timeout'])) {
            if (!is_int($config['timeout'])) {
                throw new Exception('consent:Database - \'timeout\' is supposed to be an integer.');
            }
            $this->_timeout = $config['timeout'];
        }
    }

Member Function Documentation

__sleep()

sspmod_consent_Consent_Store_Database::__sleep

(

)

Called before serialization.

Returns

array The variables which should be serialized.

Definition at line 125 of file Database.php.

References array.

    {
        return array(
            '_dsn',
            '_dateTime',
            '_username',
            '_password',
            '_table',
            '_timeout',
        );
    }

_createTable()

sspmod_consent_Consent_Store_Database::_createTable ( )

private

Create consent table.

This function creates the table with consent data.

Returns

True if successful, false if not.

Remove this function since it is not used

Definition at line 436 of file Database.php.

    {
        $db = $this->_getDB();
        if ($db === false) {
            return false;
        }

        $res = $this->db->exec(
            'CREATE TABLE ' . $this->_table . ' (consent_date TIMESTAMP NOT null, usage_date TIMESTAMP NOT null,' .
            'hashed_user_id VARCHAR(80) NOT null, service_id VARCHAR(255) NOT null, attribute VARCHAR(80) NOT null,' .
            'UNIQUE (hashed_user_id, service_id)'
        );
        if ($res === false) {
            SimpleSAML\Logger::error('consent:Database - Failed to create table \'' . $this->_table . '\'.');
            return false;
        }

        return true;
    }

_execute()

sspmod_consent_Consent_Store_Database::_execute (   $statement,   $parameters  )

private

Prepare and execute statement.

This function prepares and executes a statement. On error, false will be returned.

Parameters

string	$statement	The statement which should be executed.
array	$parameters	Parameters for the statement.

Returns

PDOStatement|false The statement, or false if execution failed.

Definition at line 337 of file Database.php.

References _getDB(), and SimpleSAML\Logger\error().

Referenced by deleteAllConsents(), deleteConsent(), getConsents(), hasConsent(), and saveConsent().

    {
        assert('is_string($statement)');
        assert('is_array($parameters)');

        $db = $this->_getDB();
        if ($db === false) {
            return false;
        }

        $st = $db->prepare($statement);
        if ($st === false) {
            SimpleSAML\Logger::error(
                'consent:Database - Error preparing statement \'' .
                $statement . '\': ' . self::_formatError($db->errorInfo())
            );
            return false;
        }

        if ($st->execute($parameters) !== true) {
            SimpleSAML\Logger::error(
                'consent:Database - Error executing statement \'' .
                $statement . '\': ' . self::_formatError($st->errorInfo())
            );
            return false;
        }

        return $st;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_formatError()

static sspmod_consent_Consent_Store_Database::_formatError (   $error )

staticprivate

Format PDO error.

This function formats a PDO error, as returned from errorInfo.

Parameters

array

$error

The error information.

Returns

string Error text.

Definition at line 488 of file Database.php.

    {
        assert('is_array($error)');
        assert('count($error) >= 3');

        return $error[0] . ' - ' . $error[2] . ' (' . $error[1] . ')';
    }

_getDB()

sspmod_consent_Consent_Store_Database::_getDB ( )

private

Get database handle.

Returns

PDO|false Database handle, or false if we fail to connect.

Definition at line 462 of file Database.php.

Referenced by _execute().

    {
        if ($this->_db !== null) {
            return $this->_db;
        }

        $driver_options = array();
        if (isset($this->_timeout)) {
            $driver_options[PDO::ATTR_TIMEOUT] = $this->_timeout;
        }

        $this->_db = new PDO($this->_dsn, $this->_username, $this->_password, $driver_options);

        return $this->_db;
    }

Here is the caller graph for this function:

deleteAllConsents()

sspmod_consent_Consent_Store_Database::deleteAllConsents

(

$userId

)

Delete all consents.

Parameters

string

$userId

The hash identifying the user at an IdP.

Returns

int Number of consents deleted

Definition at line 271 of file Database.php.

References _execute(), array, SimpleSAML\Logger\debug(), and SimpleSAML\Logger\warning().

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

        $st = $this->_execute(
            'DELETE FROM ' . $this->_table . ' WHERE hashed_user_id = ?',
            array($userId)
        );

        if ($st === false) {
            return;
        }

        if ($st->rowCount() > 0) {
            SimpleSAML\Logger::debug('consent:Database - Deleted (' . $st->rowCount() . ') consent(s).');
            return $st->rowCount();
        } else {
            SimpleSAML\Logger::warning('consent:Database - Attempted to delete nonexistent consent');
        }
    }

Here is the call graph for this function:

deleteConsent()

sspmod_consent_Consent_Store_Database::deleteConsent	(		$userId,
			$destinationId
	)

Delete consent.

Called when a user revokes consent for a given destination.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifies the destination.

Returns

int Number of consents deleted

Definition at line 239 of file Database.php.

References _execute(), array, SimpleSAML\Logger\debug(), and SimpleSAML\Logger\warning().

    {
        assert('is_string($userId)');
        assert('is_string($destinationId)');

        $st = $this->_execute(
            'DELETE FROM ' . $this->_table . ' WHERE hashed_user_id = ? AND service_id = ?;',
            array($userId, $destinationId)
        );

        if ($st === false) {
            return;
        }

        if ($st->rowCount() > 0) {
            SimpleSAML\Logger::debug('consent:Database - Deleted consent.');
            return $st->rowCount();
        } else {
            SimpleSAML\Logger::warning(
                'consent:Database - Attempted to delete nonexistent consent'
            );
        }
    }

Here is the call graph for this function:

getConsents()

sspmod_consent_Consent_Store_Database::getConsents

(

$userId

)

Retrieve consents.

This function should return a list of consents the user has saved.

Parameters

string

$userId

The hash identifying the user at an IdP.

Returns

array Array of all destination ids the user has given consent for.

Definition at line 302 of file Database.php.

References $ret, $row, _execute(), and array.

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

        $ret = array();

        $st = $this->_execute(
            'SELECT service_id, attribute, consent_date, usage_date FROM ' . $this->_table .
            ' WHERE hashed_user_id = ?',
            array($userId)
        );

        if ($st === false) {
            return array();
        }

        while ($row = $st->fetch(PDO::FETCH_NUM)) {
            $ret[] = $row;
        }

        return $ret;
    }

Here is the call graph for this function:

getStatistics()

sspmod_consent_Consent_Store_Database::getStatistics

(

)

Get statistics from the database.

The returned array contains 3 entries

• total: The total number of consents
• users: Total number of uses that have given consent ' services: Total number of services that has been given consent to

Returns

array Array containing the statistics Change fixed table name to config option

Definition at line 379 of file Database.php.

    {
        $ret = array();

        // Get total number of consents
        $st = $this->_execute('SELECT COUNT(*) AS no FROM consent', array());
        
        if ($st === false) {
            return array();
        }

        if ($row = $st->fetch(PDO::FETCH_NUM)) {
            $ret['total'] = $row[0];
        }

        // Get total number of users that has given consent
        $st = $this->_execute(
            'SELECT COUNT(*) AS no ' .
            'FROM (SELECT DISTINCT hashed_user_id FROM consent ) AS foo',
            array()
        );
        
        if ($st === false) {
            return array();
        }

        if ($row = $st->fetch(PDO::FETCH_NUM)) {
            $ret['users'] = $row[0];
        }

        // Get total number of services that has been given consent to
        $st = $this->_execute(
            'SELECT COUNT(*) AS no FROM (SELECT DISTINCT service_id FROM consent) AS foo',
            array()
        );
        
        if ($st === false) {
            return array();
        }

        if ($row = $st->fetch(PDO::FETCH_NUM)) {
            $ret['services'] = $row[0];
        }

        return $ret;
    }

hasConsent()

sspmod_consent_Consent_Store_Database::hasConsent	(		$userId,
			$destinationId,
			$attributeSet
	)

Check for consent.

This function checks whether a given user has authorized the release of the attributes identified by $attributeSet from $source to $destination.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifies the destination.
string	$attributeSet	A hash which identifies the attributes.

Returns

bool True if the user has given consent earlier, false if not (or on error).

Definition at line 151 of file Database.php.

References _execute(), array, and SimpleSAML\Logger\debug().

    {
        assert('is_string($userId)');
        assert('is_string($destinationId)');
        assert('is_string($attributeSet)');

        $st = $this->_execute(
            'UPDATE ' . $this->_table . ' ' .
            'SET usage_date = ' . $this->_dateTime . ' ' .
            'WHERE hashed_user_id = ? AND service_id = ? AND attribute = ?',
            array($userId, $destinationId, $attributeSet)
        );

        if ($st === false) {
            return false;
        }

        $rowCount = $st->rowCount();
        if ($rowCount === 0) {
            SimpleSAML\Logger::debug('consent:Database - No consent found.');
            return false;
        } else {
            SimpleSAML\Logger::debug('consent:Database - Consent found.');
            return true;
        }
    }

Here is the call graph for this function:

saveConsent()

sspmod_consent_Consent_Store_Database::saveConsent	(		$userId,
			$destinationId,
			$attributeSet
	)

Save consent.

Called when the user asks for the consent to be saved. If consent information for the given user and destination already exists, it should be overwritten.

Parameters

string	$userId	The hash identifying the user at an IdP.
string	$destinationId	A string which identifies the destination.
string	$attributeSet	A hash which identifies the attributes.

Returns

void|true True if consent is deleted.

Definition at line 191 of file Database.php.

References _execute(), array, and SimpleSAML\Logger\debug().

    {
        assert('is_string($userId)');
        assert('is_string($destinationId)');
        assert('is_string($attributeSet)');

        // Check for old consent (with different attribute set)
        $st = $this->_execute(
            'UPDATE ' . $this->_table . ' ' .
            'SET consent_date = ' . $this->_dateTime . ', usage_date = ' . $this->_dateTime . ', attribute = ? ' .
            'WHERE hashed_user_id = ? AND service_id = ?',
            array($attributeSet, $userId, $destinationId)
        );

        if ($st === false) {
            return;
        }

        if ($st->rowCount() > 0) {
            // Consent has already been stored in the database
            SimpleSAML\Logger::debug('consent:Database - Updated old consent.');
            return;
        }

        // Add new consent
        $st = $this->_execute(
            'INSERT INTO ' . $this->_table . ' (' . 'consent_date, usage_date, hashed_user_id, service_id, attribute' .
            ') ' . 'VALUES (' . $this->_dateTime . ', ' . $this->_dateTime . ', ?, ?, ?)',
            array($userId, $destinationId, $attributeSet)
        );

        if ($st !== false) {
            SimpleSAML\Logger::debug('consent:Database - Saved new consent.');
        }
        return true;
    }

Here is the call graph for this function:

selftest()

sspmod_consent_Consent_Store_Database::selftest

(

)

A quick selftest of the consent database.

Returns

boolean True if OK, false if not. Will throw an exception on connection errors.

Definition at line 502 of file Database.php.

    {
        $st = $this->_execute(
            'SELECT * FROM ' . $this->_table . ' WHERE hashed_user_id = ? AND service_id = ? AND attribute = ?',
            array('test', 'test', 'test')
        );

        if ($st === false) {
            // normally, the test will fail by an exception, so we won't reach this code
            return false;
        }
        return true;
    }

Field Documentation

$_dateTime

sspmod_consent_Consent_Store_Database::$_dateTime

private

The DATETIME SQL function to use.

Definition at line 28 of file Database.php.

$_db

sspmod_consent_Consent_Store_Database::$_db

private

Database handle.

This variable can't be serialized.

Definition at line 57 of file Database.php.

$_dsn

sspmod_consent_Consent_Store_Database::$_dsn

private

DSN for the database.

Definition at line 23 of file Database.php.

$_password

sspmod_consent_Consent_Store_Database::$_password

private

Password for the database;.

Definition at line 38 of file Database.php.

$_table

sspmod_consent_Consent_Store_Database::$_table

private

Table with consent.

Definition at line 43 of file Database.php.

$_timeout

sspmod_consent_Consent_Store_Database::$_timeout = NULL

private

Definition at line 50 of file Database.php.

$_username

sspmod_consent_Consent_Store_Database::$_username

private

Username for the database.

Definition at line 33 of file Database.php.

---

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

• libs/composer/vendor/simplesamlphp/simplesamlphp/modules/consent/lib/Consent/Store/Database.php