class ilRbacLog Log changes in Rbac-related settings More...

Collaboration diagram for ilRbacLog:

Public Member Functions
	__construct (private readonly ilDBInterface $db)

	getLogItems (int $ref_id, Range $range, Order $order, ?array $filter)

	getLogItemsCount (int $ref_id, array $filter)

Static Public Member Functions
static	isActive ()

static	gatherFaPa (int $ref_id, array $role_ids, bool $add_action=false)

static	diffFaPa (array $old, array $new)

static	gatherTemplate (int $role_ref_id, int $role_id)

static	diffTemplate (array $old, array $new)

static	add (int $action, int $ref_id, array $diff, bool $source_ref_id=false)

static	delete (int $ref_id)

static	garbageCollection ()

Data Fields
const	EDIT_PERMISSIONS = 1

const	MOVE_OBJECT = 2

const	LINK_OBJECT = 3

const	COPY_OBJECT = 4

const	CREATE_OBJECT = 5

const	EDIT_TEMPLATE = 6

const	EDIT_TEMPLATE_EXISTING = 7

const	CHANGE_OWNER = 8

Static Protected Member Functions
static	isValidAction (int $action)

Private Member Functions
	getWhereForFilter (?array $filter)

Private Attributes
const	LOG_TABLE_NAME = 'rbac_log'

Detailed Description

class ilRbacLog Log changes in Rbac-related settings

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 30 of file class.ilRbacLog.php.

Constructor & Destructor Documentation

◆ __construct()

ilRbacLog::__construct ( private readonly ilDBInterface $db )

Definition at line 42 of file class.ilRbacLog.php.

44 {

45 }

Member Function Documentation

◆ add()

static ilRbacLog::add	(	int	$action,
		int	$ref_id,
		array	$diff,
		bool	$source_ref_id = `false`
	)

static

Definition at line 226 of file class.ilRbacLog.php.

References $DIC, $id, and $ilDB.

Referenced by ilRbacAdmin\adjustMovedObjectPermissions(), ilObjRole\adjustPermissions(), ilPermissionGUI\changeOwner(), ilSoapUtils\cloneNode(), ilObjChatroom\cloneObject(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapUtils\internalLinkNode(), ilSoapUtils\linkNode(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObjRoleGUI\permSaveObject(), ilObject2GUI\putObjectInTree(), ilObjectGUI\putObjectInTree(), and ilPermissionGUI\savePermissions().

                                                                                                   : bool
     {
         global $DIC;
 
         $ilUser = $DIC->user();
         $ilDB = $DIC->database();
 
         if (self::isValidAction($action) && count($diff)) {
             if ($source_ref_id) {
                 $diff["src"] = $source_ref_id;
             }
             $id = $ilDB->nextId(self::LOG_TABLE_NAME);
 
             $ilDB->query('INSERT INTO ' . self::LOG_TABLE_NAME . ' (log_id, user_id, created, ref_id, action, data)' .
                 " VALUES (" . $ilDB->quote($id, "integer") . "," . $ilDB->quote($ilUser->getId(), "integer") .
                 "," . $ilDB->quote(time(), "integer") .
                 "," . $ilDB->quote($ref_id, "integer") . "," . $ilDB->quote($action, "integer") .
                 "," . $ilDB->quote(serialize($diff), "text") . ")");
             return true;
         }
         return false;
     }

Here is the caller graph for this function:

◆ delete()

static ilRbacLog::delete ( int $ref_id )

static

Definition at line 269 of file class.ilRbacLog.php.

References $DIC, $ilDB, and $ref_id.

Referenced by ilObject\delete().

                                               : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilDB->query('DELETE FROM ' . self::LOG_TABLE_NAME . ' WHERE ref_id = ' . $ilDB->quote($ref_id, 'integer'));
         self::garbageCollection();
     }

Here is the caller graph for this function:

◆ diffFaPa()

static ilRbacLog::diffFaPa	(	array	$old,
		array	$new
	)

static

Definition at line 160 of file class.ilRbacLog.php.

Referenced by ilRbacAdmin\adjustMovedObjectPermissions(), ilObjRole\adjustPermissions(), and ilPermissionGUI\savePermissions().

                                                            : array
     {
         $result = [];
 
         // roles
         foreach ((array) $old["ops"] as $role_id => $ops) {
             $diff = array_diff($ops, $new["ops"][$role_id]);
             if ($diff !== []) {
                 $result["ops"][$role_id]["rmv"] = array_values($diff);
             }
             $diff = array_diff($new["ops"][$role_id], $ops);
             if ($diff !== []) {
                 $result["ops"][$role_id]["add"] = array_values($diff);
             }
         }
 
         if (isset($old["inht"]) || isset($new["inht"])) {
             if (isset($old["inht"]) && !isset($new["inht"])) {
                 $result["inht"]["rmv"] = $old["inht"];
             } elseif (!isset($old["inht"]) && isset($new["inht"])) {
                 $result["inht"]["add"] = $new["inht"];
             } else {
                 $diff = array_diff($old["inht"], $new["inht"]);
                 if ($diff !== []) {
                     $result["inht"]["rmv"] = array_values($diff);
                 }
                 $diff = array_diff($new["inht"], $old["inht"]);
                 if ($diff !== []) {
                     $result["inht"]["add"] = array_values($diff);
                 }
             }
         }
         return $result;
     }

Here is the caller graph for this function:

◆ diffTemplate()

static ilRbacLog::diffTemplate	(	array	$old,
		array	$new
	)

static

Definition at line 203 of file class.ilRbacLog.php.

Referenced by ilObjRoleGUI\permSaveObject().

                                                                : array
     {
         $result = [];
         $types = array_unique(array_merge(array_keys($old), array_keys($new)));
         foreach ($types as $type) {
             if (!isset($old[$type])) {
                 $result[$type]["add"] = $new[$type];
             } elseif (!isset($new[$type])) {
                 $result[$type]["rmv"] = $old[$type];
             } else {
                 $diff = array_diff($old[$type], $new[$type]);
                 if ($diff !== []) {
                     $result[$type]["rmv"] = array_values($diff);
                 }
                 $diff = array_diff($new[$type], $old[$type]);
                 if ($diff !== []) {
                     $result[$type]["add"] = array_values($diff);
                 }
             }
         }
         return $result;
     }

Here is the caller graph for this function:

◆ garbageCollection()

static ilRbacLog::garbageCollection ( )

static

Definition at line 278 of file class.ilRbacLog.php.

References $DIC, $ilDB, and ilPrivacySettings\getInstance().

                                               : void
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $settings = ilPrivacySettings::getInstance();
         $max = $settings->getRbacLogAge();
 
         $ilDB->query('DELETE FROM ' . self::LOG_TABLE_NAME . ' WHERE created < ' . $ilDB->quote(
             strtotime("-" . $max . "months"),
             "integer"
         ));
     }

Here is the call graph for this function:

◆ gatherFaPa()

static ilRbacLog::gatherFaPa	(	int	$ref_id,
		array	$role_ids,
		bool	$add_action = `false`
	)

static

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

References $DIC, ROLE_FOLDER_ID, and SYSTEM_ROLE_ID.

Referenced by ilRbacAdmin\adjustMovedObjectPermissions(), ilObjRole\adjustPermissions(), ilSoapUtils\cloneNode(), ilObjChatroom\cloneObject(), ilObjectCopyGUI\copyMultipleNonContainer(), ilSoapUtils\internalLinkNode(), ilSoapUtils\linkNode(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), ilObject2GUI\putObjectInTree(), ilObjectGUI\putObjectInTree(), and ilPermissionGUI\savePermissions().

                                                                                              : array
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         $result = [];
 
         // #10946 - if result is written to log directly we need to add an "action" dimension
         // if result is used as input to diffFaPa() we need "raw" data
 
         // roles
         foreach ($role_ids as $role_id) {
             if ($role_id != SYSTEM_ROLE_ID) {
                 if ($add_action) {
                     $result["ops"][$role_id]["add"] = $rbacreview->getRoleOperationsOnObject($role_id, $ref_id);
                 } else {
                     $result["ops"][$role_id] = $rbacreview->getRoleOperationsOnObject($role_id, $ref_id);
                 }
             }
         }
 
         // inheritance
         if ($ref_id && $ref_id != ROLE_FOLDER_ID) {
             if ($add_action) {
                 $result["inht"]["add"] = $rbacreview->getRolesOfRoleFolder($ref_id);
             } else {
                 $result["inht"] = $rbacreview->getRolesOfRoleFolder($ref_id);
             }
         }
 
         return $result;
     }

Here is the caller graph for this function:

◆ gatherTemplate()

static ilRbacLog::gatherTemplate	(	int	$role_ref_id,
		int	$role_id
	)

static

Definition at line 195 of file class.ilRbacLog.php.

References $DIC.

Referenced by ilObjRoleGUI\permSaveObject().

                                                                          : array
     {
         global $DIC;
 
         $rbacreview = $DIC->rbac()->review();
         return $rbacreview->getAllOperationsOfRole($role_id, $role_ref_id);
     }

Here is the caller graph for this function:

◆ getLogItems()

ilRbacLog::getLogItems	(	int	$ref_id,
		Range	$range,
		Order	$order,
		?array	$filter
	)

Definition at line 47 of file class.ilRbacLog.php.

References ILIAS\Data\Range\getLength(), ILIAS\Data\Range\getStart(), getWhereForFilter(), ILIAS\Data\Order\join(), and ilDBConstants\T_INTEGER.

      : array {
         $this->db->setLimit($range->getLength(), $range->getStart());
         $set = $this->db->query(
             'SELECT * FROM ' . self::LOG_TABLE_NAME
             . ' WHERE ref_id = ' . $this->db->quote($ref_id, ilDBConstants::T_INTEGER)
             . $this->getWhereForFilter($filter)
             . $order->join(
                 ' ORDER BY ',
                 static fn(string $ret, string $key, string $value): string =>
                     $ret === ' ORDER BY ' ? "{$ret} {$key} {$value}" : "{$ret}, {$key} {$value} "
             )
         );
         $result = [];
         while ($row = $this->db->fetchAssoc($set)) {
             $row['data'] = unserialize($row['data'], [false]);
             $result[] = $row;
         }
         return $result;
     }

Here is the call graph for this function:

◆ getLogItemsCount()

ilRbacLog::getLogItemsCount	(	int	$ref_id,
		array	$filter
	)

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

References getWhereForFilter(), and ilDBConstants\T_INTEGER.

      : int {
         $result = $this->db->fetchObject(
             $this->db->query(
                 'SELECT COUNT(*) as cnt FROM ' . self::LOG_TABLE_NAME . ' WHERE ref_id = '
                 . $this->db->quote(
                     $ref_id,
                     ilDBConstants::T_INTEGER
                 ) . $this->getWhereForFilter($filter)
             )
         );
         return $result->cnt;
     }

Here is the call graph for this function:

◆ getWhereForFilter()

ilRbacLog::getWhereForFilter ( ?array $filter )

private

Definition at line 88 of file class.ilRbacLog.php.

References null, and ilDBConstants\T_INTEGER.

Referenced by getLogItems(), and getLogItemsCount().

                                                       : string
     {
         if ($filter === null) {
             return '';
         }
 
         $where = [];
         if (isset($filter['action'])) {
             $where[] = ' ' . $this->db->in(
                 'action',
                 $filter['action'],
                 false,
                 ilDBConstants::T_INTEGER
             );
         }
         if (isset($filter['from'])) {
             $where[] = ' created >= ' . $this->db->quote(
                 $filter['from'],
                 ilDBConstants::T_INTEGER
             );
         }
         if (isset($filter['to'])) {
             $where[] = ' created <= ' . $this->db->quote(
                 $filter['to'],
                 ilDBConstants::T_INTEGER
             );
         }
 
         if (count($where) > 0) {
             $where = array_merge([' AND '], [implode(' AND ', $where)]);
         }
         return implode('', $where);
     }

Here is the caller graph for this function:

◆ isActive()

static ilRbacLog::isActive ( )

static

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

References ilPrivacySettings\getInstance().

Referenced by ilPermissionGUI\__initSubTabs(), ilRbacAdmin\adjustMovedObjectPermissions(), ilObjRole\adjustPermissions(), ilPermissionGUI\changeOwner(), ilObjectCopyGUI\copyMultipleNonContainer(), ilPermissionGUI\log(), ilContainerGUI\performPasteIntoMultipleObjectsObject(), and ilObjRoleGUI\permSaveObject().

                                      : bool
     {
         return ilPrivacySettings::getInstance()->enabledRbacLog();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidAction()

static ilRbacLog::isValidAction ( int $action )

staticprotected

Definition at line 249 of file class.ilRbacLog.php.

                                                         : bool
     {
         if (in_array(
             $action,
             [
                 self::EDIT_PERMISSIONS,
                 self::MOVE_OBJECT,
                 self::LINK_OBJECT,
                 self::COPY_OBJECT,
                 self::CREATE_OBJECT,
                 self::EDIT_TEMPLATE,
                 self::EDIT_TEMPLATE_EXISTING,
                 self::CHANGE_OWNER
             ]
         )) {
             return true;
         }
         return false;
     }

Field Documentation

◆ CHANGE_OWNER

const ilRbacLog::CHANGE_OWNER = 8

Definition at line 40 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), ILIAS\AccessControl\Log\Table\buildChangeColumn(), and ilPermissionGUI\changeOwner().

◆ COPY_OBJECT

const ilRbacLog::COPY_OBJECT = 4

Definition at line 36 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), ilSoapUtils\cloneNode(), and ilObjectCopyGUI\copyMultipleNonContainer().

◆ CREATE_OBJECT

const ilRbacLog::CREATE_OBJECT = 5

Definition at line 37 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), ilObjChatroom\cloneObject(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

◆ EDIT_PERMISSIONS

const ilRbacLog::EDIT_PERMISSIONS = 1

Definition at line 33 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), and ilPermissionGUI\savePermissions().

◆ EDIT_TEMPLATE

const ilRbacLog::EDIT_TEMPLATE = 6

Definition at line 38 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), ILIAS\AccessControl\Log\Table\buildChangeColumn(), and ilObjRoleGUI\permSaveObject().

◆ EDIT_TEMPLATE_EXISTING

const ilRbacLog::EDIT_TEMPLATE_EXISTING = 7

Definition at line 39 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), and ilObjRole\adjustPermissions().

◆ LINK_OBJECT

const ilRbacLog::LINK_OBJECT = 3

Definition at line 35 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), ilSoapUtils\internalLinkNode(), ilSoapUtils\linkNode(), and ilContainerGUI\performPasteIntoMultipleObjectsObject().

◆ LOG_TABLE_NAME

const ilRbacLog::LOG_TABLE_NAME = 'rbac_log'

private

Definition at line 32 of file class.ilRbacLog.php.

◆ MOVE_OBJECT

const ilRbacLog::MOVE_OBJECT = 2

Definition at line 34 of file class.ilRbacLog.php.

Referenced by ILIAS\AccessControl\Log\Table\__construct(), and ilRbacAdmin\adjustMovedObjectPermissions().

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

components/ILIAS/AccessControl/classes/class.ilRbacLog.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ delete()

◆ diffFaPa()

◆ diffTemplate()

◆ garbageCollection()

◆ gatherFaPa()

◆ gatherTemplate()

◆ getLogItems()

◆ getLogItemsCount()

◆ getWhereForFilter()

◆ isActive()

◆ isValidAction()

Field Documentation

◆ CHANGE_OWNER

◆ COPY_OBJECT

◆ CREATE_OBJECT

◆ EDIT_PERMISSIONS

◆ EDIT_TEMPLATE

◆ EDIT_TEMPLATE_EXISTING

◆ LINK_OBJECT

◆ LOG_TABLE_NAME

◆ MOVE_OBJECT