Defines a system check task. More...

Collaboration diagram for ilSCTreeTasks:

Public Member Functions
	__construct (ilSCTask $task)

	getTask ()

	validateStructure ()

	checkStructure ()

	validateDuplicates ()

	checkDuplicates ()

	findMissingTreeEntries ()

	findMissing ()

	repairMissing ()

	repairMissingTreeEntries ()

Static Public Member Functions
static	findDeepestDuplicate ()

static	repairPK ()

static	getNodeInfo (int $a_tree_id, int $a_child)

static	getChilds (int $a_tree_id, int $a_childs)

static	findDuplicates (int $a_duplicate_id)

static	hasDuplicate (int $a_child)

static	deleteDuplicateFromTree (int $a_duplicate_id, bool $a_delete_trash)

Protected Member Functions
	getDB ()

	repairMissingObject (int $a_parent_ref, int $a_ref_id)

	readMissing ()

	deleteMissingTreeEntry (int $a_tree_id, int $a_ref_id)

	readMissingTreeEntries ()
	Read missing tree entries for referenced objects Entry in tree but no entry in object reference. More...

	createRecoveryContainer ()

Static Protected Member Functions
static	deleteDuplicate (int $tree_id, int $dup_id)

Protected Attributes
ilTree	$tree

ilDBInterface	$db

Private Attributes
ilSCTask	$task

Detailed Description

Defines a system check task.

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

Definition at line 24 of file class.ilSCTreeTasks.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCTreeTasks::__construct ( ilSCTask $task )

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

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->task = $task;
    }

References $DIC, and $task.

Member Function Documentation

◆ checkDuplicates()

ilSCTreeTasks::checkDuplicates ( )

Definition at line 242 of file class.ilSCTreeTasks.php.

                                     : array
    {
        $query = 'SELECT child, count(child) num FROM tree ' .
            'GROUP BY child ' .
            'HAVING count(child) > 1';
        $res = $this->db->query($query);
 
        $failures = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $failures[] = (int) $row->child;
        }
        return $failures;
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by validateDuplicates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkStructure()

ilSCTreeTasks::checkStructure ( )

Definition at line 223 of file class.ilSCTreeTasks.php.

                                    : array
    {
        return $this->tree->validateParentRelations();
    }

Referenced by validateStructure().

Here is the caller graph for this function:

◆ createRecoveryContainer()

ilSCTreeTasks::createRecoveryContainer ( )

protected

Definition at line 416 of file class.ilSCTreeTasks.php.

                                                : int
    {
        $now = new ilDateTime(time(), IL_CAL_UNIX);
 
        $folder = new ilObjFolder();
        $folder->setTitle('__System check recovery: ' . $now->get(IL_CAL_DATETIME));
        $folder->create();
        $folder->createReference();
        $folder->putInTree(RECOVERY_FOLDER_ID);
 
        return $folder->getRefId();
    }

References IL_CAL_DATETIME, IL_CAL_UNIX, and RECOVERY_FOLDER_ID.

Referenced by repairMissing().

Here is the caller graph for this function:

◆ deleteDuplicate()

static ilSCTreeTasks::deleteDuplicate	(	int	$tree_id,
		int	$dup_id
	)

staticprotected

Definition at line 176 of file class.ilSCTreeTasks.php.

                                                                        : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = 'SELECT child FROM tree ' .
            'WHERE parent = ' . $ilDB->quote($dup_id, ilDBConstants::T_INTEGER) . ' ' .
            'AND tree = ' . $ilDB->quote($tree_id, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            // start recursion
            self::deleteDuplicate($tree_id, (int) $row->child);
        }
        // now delete node
        if (self::hasDuplicate($dup_id)) {
            $query = 'DELETE FROM tree ' .
                'WHERE child = ' . $ilDB->quote($dup_id, ilDBConstants::T_INTEGER) . ' ' .
                'AND tree = ' . $ilDB->quote($tree_id, ilDBConstants::T_INTEGER);
            $ilDB->manipulate($query);
        }
    }

References $DIC, $ilDB, $res, deleteDuplicate(), ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_INTEGER.

Referenced by deleteDuplicate(), and deleteDuplicateFromTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteDuplicateFromTree()

static ilSCTreeTasks::deleteDuplicateFromTree	(	int	$a_duplicate_id,
		bool	$a_delete_trash
	)

static

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

                                                                                             : bool
    {
        $dups = self::findDuplicates($a_duplicate_id);
        foreach ($dups as $dup) {
            if ($a_delete_trash && $dup['tree'] < 1) {
                self::deleteDuplicate($dup['tree'], $dup['child']);
            }
            if (!$a_delete_trash && $dup['tree'] == 1) {
                self::deleteDuplicate($dup['tree'], $dup['child']);
            }
        }
        return true;
    }

References deleteDuplicate(), and findDuplicates().

Referenced by ilSCTreeTasksGUI\deleteDuplicatesFromRepository(), and ilSCTreeTasksGUI\deleteDuplicatesFromTrash().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMissingTreeEntry()

ilSCTreeTasks::deleteMissingTreeEntry	(	int	$a_tree_id,
		int	$a_ref_id
	)

protected

Definition at line 365 of file class.ilSCTreeTasks.php.

                                                                            : void
    {
        $query = 'SELECT child FROM tree ' .
            'WHERE parent = ' . $this->db->quote($a_ref_id, ilDBConstants::T_INTEGER) . ' ' .
            'AND tree = ' . $this->db->quote($a_tree_id, ilDBConstants::T_INTEGER);
 
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            // check for duplicates
            $query = 'SELECT tree, child FROM tree ' .
                'WHERE child = ' . $this->db->quote($row->child, ilDBConstants::T_INTEGER);
            $resd = $this->db->query($query);
            while ($rowd = $resd->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->deleteMissingTreeEntry((int) $rowd->tree, (int) $rowd->child);
            }
        }
 
        // finally delete
 
        $factory = new ilObjectFactory();
        $ref_obj = $factory->getInstanceByRefId($a_ref_id, false);
 
        if (($ref_obj instanceof ilObject) && $ref_obj->getType()) {
            $ref_obj->delete();
        }
 
        $query = 'DELETE from tree ' .
            'WHERE tree = ' . $this->db->quote($a_tree_id, ilDBConstants::T_INTEGER) . ' ' .
            'AND child = ' . $this->db->quote($a_ref_id, ilDBConstants::T_INTEGER);
        $this->db->manipulate($query);
    }

References $res, deleteMissingTreeEntry(), ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_INTEGER.

Referenced by deleteMissingTreeEntry(), and repairMissingTreeEntries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findDeepestDuplicate()

static ilSCTreeTasks::findDeepestDuplicate ( )

static

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

                                                 : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = 'SELECT child FROM tree first  ' .
            'WHERE EXISTS ( ' .
            'SELECT child FROM tree second WHERE first.child = second.child ' .
            'GROUP BY child HAVING COUNT(child)  >  1 ) ' .
            'ORDER BY depth DESC';
 
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->child;
        }
        return 0;
    }

References $DIC, $ilDB, $res, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSCTreeTasksGUI\repairDuplicates().

Here is the caller graph for this function:

◆ findDuplicates()

static ilSCTreeTasks::findDuplicates ( int $a_duplicate_id )

static

Definition at line 126 of file class.ilSCTreeTasks.php.

                                                              : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = 'SELECT * FROM tree first  ' .
            'WHERE EXISTS ( ' .
            'SELECT child FROM tree second WHERE first.child = second.child ' .
            'GROUP BY child HAVING COUNT(child)  >  1 ) ' .
            'AND child = ' . $ilDB->quote($a_duplicate_id, ilDBConstants::T_INTEGER) . ' ' .
            'ORDER BY depth DESC';
        $res = $ilDB->query($query);
 
        $nodes = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $node = array();
            $node['tree'] = (int) $row->tree;
            $node['child'] = (int) $row->child;
            $node['depth'] = (int) $row->depth;
 
            $nodes[] = $node;
        }
 
        return $nodes;
    }

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by deleteDuplicateFromTree(), and ilSCTreeDuplicatesTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findMissing()

ilSCTreeTasks::findMissing ( )

Definition at line 271 of file class.ilSCTreeTasks.php.

                                 : int
    {
        $failures = $this->readMissing();
 
        if (count($failures)) {
            $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
        } else {
            $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
        }
 
        $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
        $this->getTask()->update();
        return count($failures);
    }

References getTask(), IL_CAL_UNIX, readMissing(), ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

Here is the call graph for this function:

◆ findMissingTreeEntries()

ilSCTreeTasks::findMissingTreeEntries ( )

Definition at line 256 of file class.ilSCTreeTasks.php.

                                            : int
    {
        $failures = $this->readMissingTreeEntries();
 
        if (count($failures)) {
            $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
        } else {
            $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
        }
 
        $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
        $this->getTask()->update();
        return count($failures);
    }

References getTask(), IL_CAL_UNIX, readMissingTreeEntries(), ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

Here is the call graph for this function:

◆ getChilds()

static ilSCTreeTasks::getChilds	(	int	$a_tree_id,
		int	$a_childs
	)

static

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

                                                                   : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = 'SELECT * FROM tree WHERE tree = ' . $ilDB->quote(
            $a_tree_id,
            ilDBConstants::T_INTEGER
        ) . ' ' . 'AND child = ' . $ilDB->quote($a_childs, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);
 
        $childs = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $childs[] = (int) $row->child;
        }
        return $childs;
    }

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by ilSCTreeDuplicatesTableGUI\fillRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDB()

ilSCTreeTasks::getDB ( )

protected

Definition at line 199 of file class.ilSCTreeTasks.php.

                              : ilDBInterface
    {
        return $this->db;
    }

References $db.

◆ getNodeInfo()

static ilSCTreeTasks::getNodeInfo	(	int	$a_tree_id,
		int	$a_child
	)

static

Definition at line 66 of file class.ilSCTreeTasks.php.

                                                                    : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = 'SELECT * FROM tree WHERE child = ' . $ilDB->quote(
            $a_child,
            ilDBConstants::T_INTEGER
        ) . ' AND tree = ' . $ilDB->quote($a_tree_id, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);
 
        $node = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $node['child'] = (int) $row->child;
            $node['tree'] = (int) $row->tree;
            $node['depth'] = (int) $row->depth;
 
            // read obj_id
            $query = 'SELECT obj_id FROM object_reference WHERE ref_id = ' . $ilDB->quote(
                $a_child,
                ilDBConstants::T_INTEGER
            );
            $ref_res = $ilDB->query($query);
            while ($ref_row = $ref_res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $node['obj_id'] = (int) $ref_row->obj_id;
 
                // read object info
                $query = 'SELECT title, description, type FROM object_data ' .
                    'WHERE obj_id = ' . $ilDB->quote($ref_row->obj_id, ilDBConstants::T_INTEGER);
                $obj_res = $ilDB->query($query);
                while ($obj_row = $obj_res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                    $node['title'] = (string) $obj_row->title;
                    $node['description'] = (string) $obj_row->description;
                    $node['type'] = (string) $obj_row->type;
                }
            }
        }
        return $node;
    }

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by ilSCTreeDuplicatesTableGUI\fillObjectRow().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTask()

ilSCTreeTasks::getTask ( )

Definition at line 204 of file class.ilSCTreeTasks.php.

                             : ilSCTask
    {
        return $this->task;
    }

References $task.

Referenced by findMissing(), findMissingTreeEntries(), validateDuplicates(), and validateStructure().

Here is the caller graph for this function:

◆ hasDuplicate()

static ilSCTreeTasks::hasDuplicate ( int $a_child )

static

Definition at line 153 of file class.ilSCTreeTasks.php.

                                                     : int
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        return count(self::findDuplicates($a_child));
    }

References $DIC, and $ilDB.

◆ readMissing()

ilSCTreeTasks::readMissing ( )

protected

Returns: int[]

Definition at line 337 of file class.ilSCTreeTasks.php.

                                    : array
    {
        $query = 'SELECT ref_id FROM object_reference ' .
            'LEFT JOIN tree ON ref_id = child ' .
            'WHERE child IS NULL';
        $res = $this->db->query($query);
 
        $failures = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $failures[] = (int) $row->ref_id;
        }
        return $failures;
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by findMissing(), and repairMissing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readMissingTreeEntries()

ilSCTreeTasks::readMissingTreeEntries ( )

protected

Read missing tree entries for referenced objects Entry in tree but no entry in object reference.

Definition at line 401 of file class.ilSCTreeTasks.php.

                                               : array
    {
        $query = 'SELECT child FROM tree ' .
            'LEFT JOIN object_reference ON child = ref_id ' .
            'WHERE ref_id IS NULL';
 
        $res = $this->db->query($query);
 
        $failures = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $failures[] = (int) $row->child;
        }
        return $failures;
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by findMissingTreeEntries(), and repairMissingTreeEntries().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ repairMissing()

ilSCTreeTasks::repairMissing ( )

Definition at line 286 of file class.ilSCTreeTasks.php.

                                   : void
    {
        $failures = $this->readMissing();
        $recf_ref_id = $this->createRecoveryContainer();
        foreach ($failures as $ref_id) {
            $this->repairMissingObject($recf_ref_id, $ref_id);
        }
    }

References $ref_id, createRecoveryContainer(), readMissing(), and repairMissingObject().

Here is the call graph for this function:

◆ repairMissingObject()

ilSCTreeTasks::repairMissingObject	(	int	$a_parent_ref,
		int	$a_ref_id
	)

protected

Definition at line 295 of file class.ilSCTreeTasks.php.

                                                                            : void
    {
        // check if object entry exist
        $query = 'SELECT obj_id FROM object_reference ' .
            'WHERE ref_id = ' . $this->db->quote($a_ref_id, ilDBConstants::T_INTEGER);
 
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $query = 'SELECT type, title FROM object_data ' .
                'WHERE obj_id = ' . $this->db->quote($row->obj_id, ilDBConstants::T_INTEGER);
            $ores = $this->db->query($query);
 
            $done = false;
            while ($orow = $ores->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $done = true;
 
                $factory = new ilObjectFactory();
                $ref_obj = $factory->getInstanceByRefId($a_ref_id, false);
 
                if ($ref_obj instanceof ilObjRoleFolder) {
                    $ref_obj->delete();
                } elseif ($ref_obj instanceof ilObject) {
                    $ref_obj->putInTree($a_parent_ref);
                    $ref_obj->setPermissions($a_parent_ref);
 
                    break;
                }
            }
            if (!$done) {
                // delete reference value
                $query = 'DELETE FROM object_reference WHERE ref_id = ' . $this->db->quote(
                    $a_ref_id,
                    ilDBConstants::T_INTEGER
                );
                $this->db->manipulate($query);
            }
        }
    }

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

Referenced by repairMissing().

Here is the caller graph for this function:

◆ repairMissingTreeEntries()

ilSCTreeTasks::repairMissingTreeEntries ( )

Definition at line 351 of file class.ilSCTreeTasks.php.

                                              : void
    {
        $missing = $this->readMissingTreeEntries();
        foreach ($missing as $ref_id) {
            // check for duplicates
            $query = 'SELECT tree, child FROM tree ' .
                'WHERE child = ' . $this->db->quote($ref_id, ilDBConstants::T_INTEGER);
            $res = $this->db->query($query);
            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                $this->deleteMissingTreeEntry((int) $row->tree, $ref_id);
            }
        }
    }

References $ref_id, $res, deleteMissingTreeEntry(), ilDBConstants\FETCHMODE_OBJECT, readMissingTreeEntries(), and ilDBConstants\T_INTEGER.

Here is the call graph for this function:

◆ repairPK()

static ilSCTreeTasks::repairPK ( )

static

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

                                     : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $ilDB->addPrimaryKey('tree', array('child'));
    }

References $DIC, and $ilDB.

Referenced by ilSCTreeTasksGUI\deleteDuplicatesFromRepository(), and ilSCTreeTasksGUI\deleteDuplicatesFromTrash().

Here is the caller graph for this function:

◆ validateDuplicates()

ilSCTreeTasks::validateDuplicates ( )

Definition at line 228 of file class.ilSCTreeTasks.php.

                                        : int
    {
        $failures = $this->checkDuplicates();
 
        if (count($failures)) {
            $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
        } else {
            $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
        }
        $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
        $this->getTask()->update();
        return count($failures);
    }

References checkDuplicates(), getTask(), IL_CAL_UNIX, ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

Here is the call graph for this function:

◆ validateStructure()

ilSCTreeTasks::validateStructure ( )

Definition at line 209 of file class.ilSCTreeTasks.php.

                                       : int
    {
        $failures = $this->checkStructure();
 
        if (count($failures)) {
            $this->getTask()->setStatus(ilSCTask::STATUS_FAILED);
        } else {
            $this->getTask()->setStatus(ilSCTask::STATUS_COMPLETED);
        }
        $this->getTask()->setLastUpdate(new ilDateTime(time(), IL_CAL_UNIX));
        $this->getTask()->update();
        return count($failures);
    }

References checkStructure(), getTask(), IL_CAL_UNIX, ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilSCTreeTasks::$db

protected

Definition at line 27 of file class.ilSCTreeTasks.php.

Referenced by getDB().

◆ $task

ilSCTask ilSCTreeTasks::$task

private

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

Referenced by __construct(), and getTask().

◆ $tree

ilTree ilSCTreeTasks::$tree

protected

Definition at line 26 of file class.ilSCTreeTasks.php.

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

components/ILIAS/Tree/classes/SystemCheck/class.ilSCTreeTasks.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ checkDuplicates()

◆ checkStructure()

◆ createRecoveryContainer()

◆ deleteDuplicate()

◆ deleteDuplicateFromTree()

◆ deleteMissingTreeEntry()

◆ findDeepestDuplicate()

◆ findDuplicates()

◆ findMissing()

◆ findMissingTreeEntries()

◆ getChilds()

◆ getDB()

◆ getNodeInfo()

◆ getTask()

◆ hasDuplicate()

◆ readMissing()

◆ readMissingTreeEntries()

◆ repairMissing()

◆ repairMissingObject()

◆ repairMissingTreeEntries()

◆ repairPK()

◆ validateDuplicates()

◆ validateStructure()

Field Documentation

◆ $db

◆ $task

◆ $tree