This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilRbacLog:

Static Public Member Functions
static	isActive ()

static	gatherFaPa (int $a_ref_id, array $a_role_ids, bool $a_add_action=false)

static	diffFaPa (array $a_old, array $a_new)

static	gatherTemplate (int $a_role_ref_id, int $a_role_id)

static	diffTemplate (array $a_old, array $a_new)

static	add (int $a_action, int $a_ref_id, array $a_diff, bool $a_source_ref_id=false)

static	getLogItems (int $a_ref_id, int $a_limit, int $a_offset, array $a_filter=null)

static	delete (int $a_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 $a_action)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 26 of file class.ilRbacLog.php.

Member Function Documentation

◆ add()

static ilRbacLog::add	(	int	$a_action,
		int	$a_ref_id,
		array	$a_diff,
		bool	$a_source_ref_id = `false`
	)

static

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

                                                                                                          : bool
    {
        global $DIC;
 
        $ilUser = $DIC->user();
        $ilDB = $DIC->database();
 
        if (self::isValidAction($a_action) && count($a_diff)) {
            if ($a_source_ref_id) {
                $a_diff["src"] = $a_source_ref_id;
            }
            $id = $ilDB->nextId('rbac_log');
 
            $ilDB->query("INSERT INTO rbac_log (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($a_ref_id, "integer") . "," . $ilDB->quote($a_action, "integer") .
                "," . $ilDB->quote(serialize($a_diff), "text") . ")");
            return true;
        }
        return false;
    }

References $DIC, $id, $ilDB, and $ilUser.

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

Here is the caller graph for this function:

◆ delete()

static ilRbacLog::delete ( int $a_ref_id )

static

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

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

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

Referenced by ilObject\delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ diffFaPa()

static ilRbacLog::diffFaPa	(	array	$a_old,
		array	$a_new
	)

static

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

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

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

Here is the caller graph for this function:

◆ diffTemplate()

static ilRbacLog::diffTemplate	(	array	$a_old,
		array	$a_new
	)

static

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

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

References $type.

Referenced by ilObjRoleGUI\permSaveObject().

Here is the caller graph for this function:

◆ garbageCollection()

static ilRbacLog::garbageCollection ( )

static

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

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$settings, and ilPrivacySettings\getInstance().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherFaPa()

static ilRbacLog::gatherFaPa	(	int	$a_ref_id,
		array	$a_role_ids,
		bool	$a_add_action = `false`
	)

static

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

                                                                                                   : array
    {
        global $DIC;
 
        $rbacreview = $DIC->rbac()->review();
        $result = array();
 
        // #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 ($a_role_ids as $role_id) {
            if ($role_id != SYSTEM_ROLE_ID) {
                if ($a_add_action) {
                    $result["ops"][$role_id]["add"] = $rbacreview->getRoleOperationsOnObject($role_id, $a_ref_id);
                } else {
                    $result["ops"][$role_id] = $rbacreview->getRoleOperationsOnObject($role_id, $a_ref_id);
                }
            }
        }
 
        // inheritance
        if ($a_ref_id && $a_ref_id != ROLE_FOLDER_ID) {
            if ($a_add_action) {
                $result["inht"]["add"] = $rbacreview->getRolesOfRoleFolder($a_ref_id);
            } else {
                $result["inht"] = $rbacreview->getRolesOfRoleFolder($a_ref_id);
            }
        }
 
        return $result;
    }

References $DIC, ROLE_FOLDER_ID, and SYSTEM_ROLE_ID.

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

Here is the caller graph for this function:

◆ gatherTemplate()

static ilRbacLog::gatherTemplate	(	int	$a_role_ref_id,
		int	$a_role_id
	)

static

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

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

References $DIC.

Referenced by ilObjRoleGUI\permSaveObject().

Here is the caller graph for this function:

◆ getLogItems()

static ilRbacLog::getLogItems	(	int	$a_ref_id,
		int	$a_limit,
		int	$a_offset,
		array	$a_filter = `null`
	)

static

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

                                                                                                          : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $rbacreview = $DIC->rbac()->review();
 
        $where = [];
        if ($a_filter) {
            if ($a_filter["action"]) {
                $where[] = "action = " . $ilDB->quote($a_filter["action"], "integer");
            }
            if ($a_filter["date"]["from"]) {
                $from = $a_filter["date"]["from"]->get(IL_CAL_UNIX);
                $from = strtotime("00:00:00", $from);
                $where[] = "created >= " . $ilDB->quote($from, "integer");
            }
            if ($a_filter["date"]["to"]) {
                $to = $a_filter["date"]["to"]->get(IL_CAL_UNIX);
                $to = strtotime("23:59:59", $to);
                $where[] = "created <= " . $ilDB->quote($to, "integer");
            }
 
            if (count($where) > 0) {
                $where = array_merge([' AND '], [implode(' AND ', $where)]);
            }
        }
 
        $set = $ilDB->query("SELECT COUNT(*) FROM rbac_log WHERE ref_id = " . $ilDB->quote(
            $a_ref_id,
            "integer"
        ) . implode('', $where));
        $res = $ilDB->fetchAssoc($set);
        $count = array_pop($res);
 
        $ilDB->setLimit($a_limit, $a_offset);
        $set = $ilDB->query("SELECT * FROM rbac_log WHERE ref_id = " . $ilDB->quote($a_ref_id, "integer") .
            implode('', $where) . " ORDER BY created DESC");
        $result = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $row["data"] = unserialize($row["data"]);
            $result[] = $row;
        }
        return ["cnt" => $count, "set" => $result];
    }

References $DIC, $ilDB, $res, and IL_CAL_UNIX.

Referenced by ilRbacLogTableGUI\getItems().

Here is the caller graph for this function:

◆ isActive()

static ilRbacLog::isActive ( )

static

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

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

References ilPrivacySettings\getInstance().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isValidAction()

static ilRbacLog::isValidAction ( int $a_action )

staticprotected

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

                                                          : bool
    {
        if (in_array(
            $a_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 35 of file class.ilRbacLog.php.

Referenced by ilRbacLogTableGUI\__construct(), ilPermission2GUI\changeOwner(), and ilRbacLogTableGUI\fillRow().

◆ COPY_OBJECT

const ilRbacLog::COPY_OBJECT = 4

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

Referenced by ilRbacLogTableGUI\__construct(), ilSoapUtils\cloneNode(), and ilObjectCopyGUI\copyMultipleNonContainer().

◆ CREATE_OBJECT

const ilRbacLog::CREATE_OBJECT = 5

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

Referenced by ilRbacLogTableGUI\__construct(), ilObjChatroom\cloneObject(), ilObjChatroomGUI\insertObject(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

◆ EDIT_PERMISSIONS

const ilRbacLog::EDIT_PERMISSIONS = 1

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

Referenced by ilRbacLogTableGUI\__construct(), and ilPermissionGUI\savePermissions().

◆ EDIT_TEMPLATE

const ilRbacLog::EDIT_TEMPLATE = 6

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

Referenced by ilRbacLogTableGUI\__construct(), ilRbacLogTableGUI\fillRow(), and ilObjRoleGUI\permSaveObject().

◆ EDIT_TEMPLATE_EXISTING

const ilRbacLog::EDIT_TEMPLATE_EXISTING = 7

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

Referenced by ilRbacLogTableGUI\__construct().

◆ LINK_OBJECT

const ilRbacLog::LINK_OBJECT = 3

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

Referenced by ilRbacLogTableGUI\__construct(), ilSoapUtils\internalLinkNode(), ilSoapUtils\linkNode(), and ilContainerGUI\performPasteIntoMultipleObjectsObject().

◆ MOVE_OBJECT

const ilRbacLog::MOVE_OBJECT = 2

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

Referenced by ilRbacLogTableGUI\__construct(), and ilRbacAdmin\adjustMovedObjectPermissions().

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

Services/AccessControl/classes/class.ilRbacLog.php

Static Public Member Functions

Data Fields

Static Protected Member Functions

Detailed Description

Member Function Documentation

◆ add()

◆ delete()

◆ diffFaPa()

◆ diffTemplate()

◆ garbageCollection()

◆ gatherFaPa()

◆ gatherTemplate()

◆ getLogItems()

◆ isActive()

◆ isValidAction()

Field Documentation

◆ CHANGE_OWNER

◆ COPY_OBJECT

◆ CREATE_OBJECT

◆ EDIT_PERMISSIONS

◆ EDIT_TEMPLATE

◆ EDIT_TEMPLATE_EXISTING

◆ LINK_OBJECT

◆ MOVE_OBJECT