Shibboleth role assignment rule. More...

Collaboration diagram for ilShibbolethRoleAssignmentRule:

Public Member Functions
	__construct (int $a_rule_id=0)

	setRuleId (int $a_id)

	getRuleId ()

	setRoleId (int $a_id)

	getRoleId ()

	setName (string $a_name)

	getName ()

	setValue (string $a_value)

	getValue ()

	enablePlugin (bool $a_status)

	isPluginActive ()

	enableAddOnUpdate (bool $a_status)

	isAddOnUpdateEnabled ()

	enableRemoveOnUpdate (bool $a_status)

	isRemoveOnUpdateEnabled ()

	setPluginId (?string $a_id)

	getPluginId ()

	conditionToString ()

	validate ()

	delete ()

	add ()

	update ()

	matches (array $a_data)

	doesMatch (array $a_data)

Protected Member Functions
	wildcardCompare (string $a_str1, string $a_str2)

Private Member Functions
	read ()

Private Attributes
const	ERR_MISSING_NAME = 'shib_missing_attr_name'

const	ERR_MISSING_VALUE = 'shib_missing_attr_value'

const	ERR_MISSING_ROLE = 'shib_missing_role'

const	ERR_MISSING_PLUGIN_ID = 'shib_missing_plugin_id'

const	TABLE_NAME = 'shib_role_assignment'

ilDBInterface	$db

int	$rule_id

int	$role_id = 0

string	$attribute_name = ''

string	$attribute_value = ''

bool	$plugin_active = false

bool	$add_on_update = false

bool	$remove_on_update = false

string	$plugin_id = null

Detailed Description

Shibboleth role assignment rule.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Fabian Schmid fabia.nosp@m.n.sc.nosp@m.hmid@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$

Definition at line 25 of file class.ilShibbolethRoleAssignmentRule.php.

Constructor & Destructor Documentation

◆ __construct()

ilShibbolethRoleAssignmentRule::__construct ( int $a_rule_id = 0 )

Definition at line 43 of file class.ilShibbolethRoleAssignmentRule.php.

References $DIC, $ilDB, and read().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $this->db = $ilDB;
         $this->rule_id = $a_rule_id;
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ add()

ilShibbolethRoleAssignmentRule::add ( )

Definition at line 173 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, getName(), getPluginId(), getRoleId(), getValue(), isAddOnUpdateEnabled(), isPluginActive(), isRemoveOnUpdateEnabled(), and setRuleId().

                          : bool
     {
         $next_id = $this->db->nextId(self::TABLE_NAME);
         $query = 'INSERT INTO ' . self::TABLE_NAME . ' (rule_id,role_id,name,value,plugin,plugin_id,add_on_update,remove_on_update ) ' . 'VALUES( '
             . $this->db->quote($next_id, 'integer') . ', ' . $this->db->quote($this->getRoleId(), 'integer') . ', '
             . $this->db->quote($this->getName(), 'text') . ', ' . $this->db->quote($this->getValue(), 'text') . ', '
             . $this->db->quote((int) $this->isPluginActive(), 'integer') . ', ' . $this->db->quote(
                 $this->getPluginId() ?? 0,
                 'integer'
             ) . ', '
             . $this->db->quote((int) $this->isAddOnUpdateEnabled(), 'integer') . ', '
             . $this->db->quote((int) $this->isRemoveOnUpdateEnabled(), 'integer') . ') ';
         $this->db->manipulate($query);
         $this->setRuleId($this->db->getLastInsertId());
 
         return true;
     }

Here is the call graph for this function:

◆ conditionToString()

ilShibbolethRoleAssignmentRule::conditionToString ( )

Definition at line 132 of file class.ilShibbolethRoleAssignmentRule.php.

References $DIC, $lng, getName(), getPluginId(), getValue(), and isPluginActive().

Referenced by ilAuthShibbolethSettingsGUI\confirmDeleteRules().

                                        : ?string
     {
         global $DIC;
         $lng = $DIC['lng'];
         if ($this->isPluginActive()) {
             return $lng->txt('shib_plugin_id') . ': ' . $this->getPluginId();
         }
 
         return $this->getName() . '=' . $this->getValue();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilShibbolethRoleAssignmentRule::delete ( )

Definition at line 162 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, and getRuleId().

Referenced by ilAuthShibbolethSettingsGUI\deleteRules().

                             : bool
     {
         $query = 'DELETE FROM ' . self::TABLE_NAME . ' ' . 'WHERE rule_id = ' . $this->db->quote(
             $this->getRuleId(),
             'integer'
         );
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doesMatch()

ilShibbolethRoleAssignmentRule::doesMatch ( array $a_data )

Definition at line 241 of file class.ilShibbolethRoleAssignmentRule.php.

References ilShibbolethRoleAssignmentRules\callPlugin(), getName(), getPluginId(), getValue(), and isPluginActive().

                                             : bool
     {
         if ($this->isPluginActive()) {
             return ilShibbolethRoleAssignmentRules::callPlugin($this->getPluginId(), $a_data);
         }
 
         if (!isset($a_data[$this->getName()])) {
             return false;
         }
 
         $values = $a_data[$this->getName()];
         if (is_array($values)) {
             return in_array($this->getValue(), $values);
         }
 
         $pattern = str_replace('*', '.*?', $this->getValue());
 
         return (bool) preg_match('/^' . $pattern . '$/us', $values);
     }

Here is the call graph for this function:

◆ enableAddOnUpdate()

ilShibbolethRoleAssignmentRule::enableAddOnUpdate ( bool $a_status )

Definition at line 102 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                                      : void
     {
         $this->add_on_update = $a_status;
     }

Here is the caller graph for this function:

◆ enablePlugin()

ilShibbolethRoleAssignmentRule::enablePlugin ( bool $a_status )

Definition at line 92 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                                 : void
     {
         $this->plugin_active = $a_status;
     }

Here is the caller graph for this function:

◆ enableRemoveOnUpdate()

ilShibbolethRoleAssignmentRule::enableRemoveOnUpdate ( bool $a_status )

Definition at line 112 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                                         : void
     {
         $this->remove_on_update = $a_status;
     }

Here is the caller graph for this function:

◆ getName()

ilShibbolethRoleAssignmentRule::getName ( )

Definition at line 77 of file class.ilShibbolethRoleAssignmentRule.php.

References $attribute_name.

Referenced by add(), conditionToString(), doesMatch(), ilAuthShibbolethSettingsGUI\getRuleValues(), matches(), update(), and validate().

                              : string
     {
         return $this->attribute_name;
     }

Here is the caller graph for this function:

◆ getPluginId()

ilShibbolethRoleAssignmentRule::getPluginId ( )

Definition at line 127 of file class.ilShibbolethRoleAssignmentRule.php.

References $plugin_id.

Referenced by add(), conditionToString(), doesMatch(), ilAuthShibbolethSettingsGUI\getRuleValues(), matches(), update(), and validate().

                                  : ?string
     {
         return $this->plugin_id;
     }

Here is the caller graph for this function:

◆ getRoleId()

ilShibbolethRoleAssignmentRule::getRoleId ( )

Definition at line 67 of file class.ilShibbolethRoleAssignmentRule.php.

References $role_id.

Referenced by add(), ilAuthShibbolethSettingsGUI\confirmDeleteRules(), ilAuthShibbolethSettingsGUI\getRuleValues(), update(), and validate().

                                : int
     {
         return $this->role_id;
     }

Here is the caller graph for this function:

◆ getRuleId()

ilShibbolethRoleAssignmentRule::getRuleId ( )

Definition at line 57 of file class.ilShibbolethRoleAssignmentRule.php.

References $rule_id.

Referenced by delete(), read(), and update().

                                : int
     {
         return $this->rule_id;
     }

Here is the caller graph for this function:

◆ getValue()

ilShibbolethRoleAssignmentRule::getValue ( )

Definition at line 87 of file class.ilShibbolethRoleAssignmentRule.php.

References $attribute_value.

Referenced by add(), conditionToString(), doesMatch(), ilAuthShibbolethSettingsGUI\getRuleValues(), matches(), update(), and validate().

                               : string
     {
         return $this->attribute_value;
     }

Here is the caller graph for this function:

◆ isAddOnUpdateEnabled()

ilShibbolethRoleAssignmentRule::isAddOnUpdateEnabled ( )

Definition at line 107 of file class.ilShibbolethRoleAssignmentRule.php.

References $add_on_update.

Referenced by add(), ilAuthShibbolethSettingsGUI\getRuleValues(), and update().

                                           : bool
     {
         return $this->add_on_update;
     }

Here is the caller graph for this function:

◆ isPluginActive()

ilShibbolethRoleAssignmentRule::isPluginActive ( )

Definition at line 97 of file class.ilShibbolethRoleAssignmentRule.php.

References $plugin_active.

Referenced by add(), conditionToString(), doesMatch(), ilAuthShibbolethSettingsGUI\getRuleValues(), matches(), update(), and validate().

                                     : bool
     {
         return $this->plugin_active;
     }

Here is the caller graph for this function:

◆ isRemoveOnUpdateEnabled()

ilShibbolethRoleAssignmentRule::isRemoveOnUpdateEnabled ( )

Definition at line 117 of file class.ilShibbolethRoleAssignmentRule.php.

References $remove_on_update.

Referenced by add(), ilAuthShibbolethSettingsGUI\getRuleValues(), and update().

                                              : bool
     {
         return $this->remove_on_update;
     }

Here is the caller graph for this function:

◆ matches()

ilShibbolethRoleAssignmentRule::matches ( array $a_data )

Deprecated:

Definition at line 214 of file class.ilShibbolethRoleAssignmentRule.php.

References ilShibbolethRoleAssignmentRules\callPlugin(), getName(), getPluginId(), getValue(), isPluginActive(), and wildcardCompare().

                                           : bool
     {
         if ($this->isPluginActive()) {
             return ilShibbolethRoleAssignmentRules::callPlugin($this->getPluginId(), $a_data);
         }
         // No value
         if (!isset($a_data[$this->getName()])) {
             return false;
         }
         $values = $a_data[$this->getName()];
         if (is_array($values)) {
             return in_array($this->getValue(), $values);
         }
 
         return $this->wildcardCompare($this->getValue(), $values);
     }

Here is the call graph for this function:

◆ read()

ilShibbolethRoleAssignmentRule::read ( )

private

Definition at line 261 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, $res, enableAddOnUpdate(), enablePlugin(), enableRemoveOnUpdate(), ilDBConstants\FETCHMODE_OBJECT, getRuleId(), setName(), setPluginId(), setRoleId(), and setValue().

Referenced by __construct().

                            : void
     {
         if ($this->getRuleId() === 0) {
             return;
         }
 
         $query = 'SELECT * FROM ' . self::TABLE_NAME . ' ' . 'WHERE rule_id = ' . $this->db->quote(
             $this->getRuleId(),
             'integer'
         );
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setRoleId((int) $row->role_id);
             $this->setName((string) $row->name);
             $this->setValue((string) $row->value);
             $this->enablePlugin((bool) $row->plugin);
             $this->setPluginId($row->plugin_id);
             $this->enableAddOnUpdate((bool) $row->add_on_update);
             $this->enableRemoveOnUpdate((bool) $row->remove_on_update);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setName()

ilShibbolethRoleAssignmentRule::setName ( string $a_name )

Definition at line 72 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                            : void
     {
         $this->attribute_name = $a_name;
     }

Here is the caller graph for this function:

◆ setPluginId()

ilShibbolethRoleAssignmentRule::setPluginId ( ?string $a_id )

Definition at line 122 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                               : void
     {
         $this->plugin_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRoleId()

ilShibbolethRoleAssignmentRule::setRoleId ( int $a_id )

Definition at line 62 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                         : void
     {
         $this->role_id = $a_id;
     }

Here is the caller graph for this function:

◆ setRuleId()

ilShibbolethRoleAssignmentRule::setRuleId ( int $a_id )

Definition at line 52 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by add().

                                         : void
     {
         $this->rule_id = $a_id;
     }

Here is the caller graph for this function:

◆ setValue()

ilShibbolethRoleAssignmentRule::setValue ( string $a_value )

Definition at line 82 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by read().

                                              : void
     {
         $this->attribute_value = $a_value;
     }

Here is the caller graph for this function:

◆ update()

ilShibbolethRoleAssignmentRule::update ( )

Definition at line 191 of file class.ilShibbolethRoleAssignmentRule.php.

References $query, getName(), getPluginId(), getRoleId(), getRuleId(), getValue(), isAddOnUpdateEnabled(), isPluginActive(), and isRemoveOnUpdateEnabled().

                             : bool
     {
         $query = 'UPDATE ' . self::TABLE_NAME . ' ' . 'SET role_id = ' . $this->db->quote(
             $this->getRoleId(),
             'integer'
         ) . ', ' . 'name = '
             . $this->db->quote($this->getName(), 'text') . ', ' . 'value = ' . $this->db->quote(
                 $this->getValue(),
                 'text'
             ) . ', ' . 'plugin = '
             . $this->db->quote((int) $this->isPluginActive(), 'integer') . ', ' . 'plugin_id = '
             . $this->db->quote($this->getPluginId() ?? 0, 'integer') . ', ' . 'add_on_update = '
             . $this->db->quote((int) $this->isAddOnUpdateEnabled(), 'integer') . ', ' . 'remove_on_update = '
             . $this->db->quote((int) $this->isRemoveOnUpdateEnabled(), 'integer') . ' '
             . 'WHERE rule_id = ' . $this->db->quote($this->getRuleId(), 'integer');
         $this->db->manipulate($query);
 
         return true;
     }

Here is the call graph for this function:

◆ validate()

ilShibbolethRoleAssignmentRule::validate ( )

Definition at line 143 of file class.ilShibbolethRoleAssignmentRule.php.

References getName(), getPluginId(), getRoleId(), getValue(), and isPluginActive().

                               : string
     {
         if ($this->getRoleId() === 0) {
             return self::ERR_MISSING_ROLE;
         }
         if (!$this->isPluginActive()) {
             if ($this->getName() === '' || $this->getName() === '0') {
                 return self::ERR_MISSING_NAME;
             }
             if ($this->getValue() === '' || $this->getValue() === '0') {
                 return self::ERR_MISSING_VALUE;
             }
         } elseif ($this->getPluginId() === 0) {
             return self::ERR_MISSING_PLUGIN_ID;
         }
 
         return '';
     }

Here is the call graph for this function:

◆ wildcardCompare()

ilShibbolethRoleAssignmentRule::wildcardCompare	(	string	$a_str1,
		string	$a_str2
	)

protected

Deprecated:

Definition at line 234 of file class.ilShibbolethRoleAssignmentRule.php.

Referenced by matches().

                                                                       : bool
     {
         $pattern = str_replace('*', '.*?', $a_str1);
 
         return (bool) preg_match("/" . $pattern . "/us", $a_str2);
     }