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

Collaboration diagram for ilSystemCheckTrash:

Public Member Functions
	__construct ()

	setNumberLimit (int $a_limit)

	getNumberLimit ()

	setAgeLimit (ilDateTime $dt)

	getAgeLimit ()

	setTypesLimit (array $a_types)

	getTypesLimit ()

	setMode (int $a_mode)

	getMode ()

	start ()

Data Fields
const	MODE_TRASH_RESTORE = 1

const	MODE_TRASH_REMOVE = 2

Protected Member Functions
	restore ()

	removeSelectedFromSystem ()

	readSelectedDeleted ()

	readDeleted (?int $tree_id=null)

Protected Attributes
ilLogger	$logger

ilDBInterface	$db

ilTree	$tree

ilRbacAdmin	$admin

Private Attributes
int	$limit_number = 0

ilDateTime	$limit_age

array	$limit_types = array()

int	$mode

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

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 23 of file class.ilSystemCheckTrash.php.

Constructor & Destructor Documentation

◆ __construct()

ilSystemCheckTrash::__construct ( )

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

References $DIC, IL_CAL_UNIX, and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->logger = $DIC->logger()->sysc();
         $this->db = $DIC->database();
         $this->tree = $DIC->repositoryTree();
         $this->admin = $DIC->rbac()->admin();
 
         $this->limit_age = new ilDate(0, IL_CAL_UNIX);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getAgeLimit()

ilSystemCheckTrash::getAgeLimit ( )

Definition at line 65 of file class.ilSystemCheckTrash.php.

References $limit_age.

Referenced by readSelectedDeleted(), and start().

                                  : ilDateTime
     {
         return $this->limit_age;
     }

Here is the caller graph for this function:

◆ getMode()

ilSystemCheckTrash::getMode ( )

Definition at line 85 of file class.ilSystemCheckTrash.php.

References $mode.

Referenced by start().

                              : int
     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getNumberLimit()

ilSystemCheckTrash::getNumberLimit ( )

Definition at line 55 of file class.ilSystemCheckTrash.php.

References $limit_number.

Referenced by readSelectedDeleted(), and start().

                                     : int
     {
         return $this->limit_number;
     }

Here is the caller graph for this function:

◆ getTypesLimit()

ilSystemCheckTrash::getTypesLimit ( )

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

References $limit_types.

Referenced by readSelectedDeleted(), and start().

                                    : array
     {
         return $this->limit_types;
     }

Here is the caller graph for this function:

◆ readDeleted()

ilSystemCheckTrash::readDeleted ( ?int $tree_id = null )

protected

Definition at line 207 of file class.ilSystemCheckTrash.php.

References $query, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by removeSelectedFromSystem(), and restore().

                                                         : array
     {
         $query = 'SELECT child,tree FROM tree t JOIN object_reference r ON child = r.ref_id ' .
             'JOIN object_data o on r.obj_id = o.obj_id ';
 
         if ($tree_id === null) {
             $query .= 'WHERE tree < ' . $this->db->quote(0, 'integer') . ' ';
         } else {
             $query .= 'WHERE tree = ' . $this->db->quote($tree_id, 'integer') . ' ';
         }
         $query .= 'ORDER BY depth desc';
 
         $res = $this->db->query($query);
 
         $deleted = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $deleted[] = array(
                 'tree' => $row->tree,
                 'child' => $row->child
             );
         }
         return $deleted;
     }

Here is the caller graph for this function:

◆ readSelectedDeleted()

ilSystemCheckTrash::readSelectedDeleted ( )

protected

Definition at line 156 of file class.ilSystemCheckTrash.php.

References $id, $query, $res, $type, ilDBConstants\FETCHMODE_OBJECT, getAgeLimit(), getNumberLimit(), getTypesLimit(), IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\logger(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Referenced by removeSelectedFromSystem().

                                             : array
     {
         $and_types = '';
         $this->logger->dump($this->getTypesLimit());
 
         $types = array();
         foreach ($this->getTypesLimit() as $id => $type) {
             if ($type) {
                 $types[] = $type;
             }
         }
         if (count($types)) {
             $and_types = 'AND ' . $this->db->in('o.type', $this->getTypesLimit(), false, ilDBConstants::T_TEXT) . ' ';
         }
 
         $and_age = '';
         $age_limit = $this->getAgeLimit()->get(IL_CAL_UNIX);
         if ($age_limit > 0) {
             $and_age = 'AND r.deleted < ' . $this->db->quote(
                 $this->getAgeLimit()->get(IL_CAL_DATETIME),
                 ilDBConstants::T_TEXT
             ) . ' ';
         }
         $limit = '';
         if ($this->getNumberLimit()) {
             $limit = 'LIMIT ' . $this->getNumberLimit();
         }
 
         $query = 'SELECT child,tree FROM tree t JOIN object_reference r ON child = r.ref_id ' .
             'JOIN object_data o on r.obj_id = o.obj_id ' .
             'WHERE tree < ' . $this->db->quote(0, ilDBConstants::T_INTEGER) . ' ' .
             'AND child = -tree ';
 
         $query .= $and_age;
         $query .= $and_types;
         $query .= 'ORDER BY depth desc ';
         $query .= $limit;
 
         $this->logger->info($query);
 
         $deleted = array();
         $res = $this->db->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $deleted[] = array(
                 'tree' => $row->tree,
                 'child' => $row->child
             );
         }
         return $deleted;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeSelectedFromSystem()

ilSystemCheckTrash::removeSelectedFromSystem ( )

protected

Definition at line 138 of file class.ilSystemCheckTrash.php.

References ilTree\_removeEntry(), ilObjectFactory\getInstanceByRefId(), readDeleted(), and readSelectedDeleted().

Referenced by start().

                                                  : void
     {
         $deleted = $this->readSelectedDeleted();
         foreach ($deleted as $del_num => $deleted_info) {
             $sub_nodes = $this->readDeleted((int) ($deleted_info['tree'] ?? 0));
 
             foreach ($sub_nodes as $sub_num => $subnode_info) {
                 $ref_obj = ilObjectFactory::getInstanceByRefId((int) ($subnode_info['child'] ?? 0), false);
                 if (!$ref_obj instanceof ilObject) {
                     continue;
                 }
 
                 $ref_obj->delete();
                 ilTree::_removeEntry((int) ($subnode_info['tree'] ?? 0), (int) ($subnode_info['child'] ?? 0));
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restore()

ilSystemCheckTrash::restore ( )

protected

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

References ilObjectFactory\getInstanceByRefId(), ILIAS\Repository\int(), ILIAS\Repository\logger(), readDeleted(), and RECOVERY_FOLDER_ID.

Referenced by start().

                                 : void
     {
         $deleted = $this->readDeleted();
 
         $this->logger->info('Found deleted : ' . print_r($deleted, true));
 
 
         foreach ($deleted as $tmp_num => $deleted_info) {
             $child_id = (int) ($deleted_info['child'] ?? 0);
             $ref_obj = ilObjectFactory::getInstanceByRefId($child_id, false);
             if (!$ref_obj instanceof ilObject) {
                 continue;
             }
 
             $this->tree->deleteNode((int) ($deleted_info['tree'] ?? 0), $child_id);
             $this->logger->info('Object tree entry deleted');
 
             if ($ref_obj->getType() !== 'rolf') {
                 $this->admin->revokePermission($child_id);
                 $ref_obj->putInTree(RECOVERY_FOLDER_ID);
                 $ref_obj->setPermissions(RECOVERY_FOLDER_ID);
                 $this->logger->info('Object moved to recovery folder');
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setAgeLimit()

ilSystemCheckTrash::setAgeLimit ( ilDateTime $dt )

Definition at line 60 of file class.ilSystemCheckTrash.php.

                                                : void
     {
         $this->limit_age = $dt;
     }

◆ setMode()

ilSystemCheckTrash::setMode ( int $a_mode )

Definition at line 80 of file class.ilSystemCheckTrash.php.

                                         : void
     {
         $this->mode = $a_mode;
     }

◆ setNumberLimit()

ilSystemCheckTrash::setNumberLimit ( int $a_limit )

Definition at line 50 of file class.ilSystemCheckTrash.php.

                                                 : void
     {
         $this->limit_number = $a_limit;
     }

◆ setTypesLimit()

ilSystemCheckTrash::setTypesLimit ( array $a_types )

Definition at line 70 of file class.ilSystemCheckTrash.php.

                                                  : void
     {
         $this->limit_types = $a_types;
     }

◆ start()

ilSystemCheckTrash::start ( )

Definition at line 90 of file class.ilSystemCheckTrash.php.

References getAgeLimit(), getMode(), getNumberLimit(), getTypesLimit(), ILIAS\Repository\logger(), removeSelectedFromSystem(), and restore().

                            : bool
     {
         $this->logger->info('Handling delete');
         switch ($this->getMode()) {
             case self::MODE_TRASH_RESTORE:
                 $this->logger->info('Restore trash to recovery folder');
                 $this->restore();
                 return true;
                 break;
 
             case self::MODE_TRASH_REMOVE:
                 $this->logger->info('Remove selected from system.');
                 $this->logger->info('Type limit: ' . print_r($this->getTypesLimit(), true));
                 $this->logger->info('Age limit: ' . $this->getAgeLimit());
                 $this->logger->info('Number limit: ' . $this->getNumberLimit());
                 $this->removeSelectedFromSystem();
                 return true;
                 break;
         }
         return false;
     }