Defines a system check task. More...

Collaboration diagram for ilSCTreeTasks:

Public Member Functions
	__construct (ilSCTask $task)

	getDB ()

	getTask ()

	validateStructure ()
	validate tree structure base on parent relation More...

	checkStructure ()

	validateDuplicates ()

	checkDuplicates ()
	Check for duplicates. More...

	findMissingTreeEntries ()

	findMissing ()
	Find missing objects. More...

	repairMissing ()
	Repair missing objects. More...

	repairMissingTreeEntries ()
	repair missing tree entries @global type $ilDB More...

Static Public Member Functions
static	findDeepestDuplicate ()
	find duplicates @global type $ilDB More...

static	repairPK ()

static	getNodeInfo ($a_tree_id, $a_child)

static	getChilds ($a_tree_id, $a_childs)

static	findDuplicates ($a_duplicate_id)
	find duplicates @global type $ilDB More...

static	hasDuplicate ($a_child)

static	deleteDuplicateFromTree ($a_duplicate_id, $a_delete_trash)

Protected Member Functions
	repairMissingObject ($a_parent_ref, $a_ref_id)
	Repair missing object. More...

	readMissing ()
	Read missing objects in tree Entry in oject_reference but no entry in tree @global type $ilDB. More...

	deleteMissingTreeEntry ($a_tree_id, $a_ref_id)
	Delete missing tree entries from tree table. More...

	readMissingTreeEntries ()
	Read missing tree entries for referenced objects Entry in tree but no entry in object reference @global type $ilDB. More...

	createRecoveryContainer ()
	Create a reccovery folder. More...

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

Private Attributes
	$db = null

	$task = null

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 9 of file class.ilSCTreeTasks.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCTreeTasks::__construct ( ilSCTask $task )

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

        {
                $this->db = $GLOBALS['ilDB'];
                $this->task = $task;
        }

References $GLOBALS, and $task.

Member Function Documentation

◆ checkDuplicates()

ilSCTreeTasks::checkDuplicates ( )

Check for duplicates.

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

        {
                $query = 'SELECT child, count(child) num FROM tree '.
                                'GROUP BY child '.
                                'HAVING count(child) > 1';
                $res = $this->getDB()->query($query);
                
                $GLOBALS['ilLog']->write($query);
                
                $failures = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $failures[] = $row->child;
                }
                return $failures;
        }

References $GLOBALS, $query, $res, $row, DB_FETCHMODE_OBJECT, and getDB().

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 225 of file class.ilSCTreeTasks.php.

        {
                return $GLOBALS['tree']->validateParentRelations();
                global $ilDB;
                
                $query = 'select child from tree child where not exists '.
                                '( '.
                                'select child from tree parent where child.parent = parent.child and (parent.lft < child.lft) and (parent.rgt > child.rgt) '.
                                ')'.
                                'and tree = 1 and child <> 1';
                $res = $ilDB->query($query);
                
                $failures = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $failures[] = $row->child;
                }
                return $failures;
        }

References $GLOBALS, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by validateStructure().

Here is the caller graph for this function:

◆ createRecoveryContainer()

ilSCTreeTasks::createRecoveryContainer ( )

protected

Create a reccovery folder.

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

        {
                $now = new ilDateTime(time(),IL_CAL_UNIX);
                
                include_once './Modules/Folder/classes/class.ilObjFolder.php';
                $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, and IL_CAL_UNIX.

Referenced by repairMissing().

Here is the caller graph for this function:

◆ deleteDuplicate()

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

staticprotected

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

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

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and deleteDuplicate().

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	(	$a_duplicate_id,
		$a_delete_trash
	)

static

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

        {
                $dups = self::findDuplicates($a_duplicate_id);
                foreach($dups as $dup)
                {
                        if($a_delete_trash and $dup['tree'] < 1)
                        {
                                self::deleteDuplicate($dup['tree'],$dup['child']);
                        }
                        if(!$a_delete_trash and $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	(	$a_tree_id,
		$a_ref_id
	)

protected

Delete missing tree entries from tree table.

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

        {
                global $ilDB;
                
                $query = 'SELECT child FROM tree '.
                                'WHERE parent = '.$ilDB->quote($a_ref_id,'integer').' '.
                                'AND tree = '.$ilDB->quote($a_tree_id,'integer');
 
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        // check for duplicates
                        $query = 'SELECT tree, child FROM tree '.
                                        'WHERE child = '.$ilDB->quote($row->child);
                        $resd = $ilDB->query($query);
                        while($rowd = $resd->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                $this->deleteMissingTreeEntry($rowd->tree,$rowd->child);
                        }
                }
                
                // finally delete
                include_once './Services/Object/classes/class.ilObjectFactory.php';
                $factory = new ilObjectFactory();
                $ref_obj = $factory->getInstanceByRefId($a_ref_id,FALSE);
                                
                if(($ref_obj instanceof ilObject) and $ref_obj->getType())
                {
                        $ref_obj->delete();
                }
                
                $query = 'DELETE from tree '.
                                'WHERE tree = '.$ilDB->quote($a_tree_id).' '.
                                'AND child = '.$ilDB->quote($a_ref_id);
                $ilDB->manipulate($query);
        }

References $ilDB, $query, $res, $row, DB_FETCHMODE_OBJECT, and deleteMissingTreeEntry().

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

find duplicates @global type $ilDB

Returns: int

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

        {
                global $ilDB;
                
                $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';
                
                $GLOBALS['ilLog']->write($query);
                
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        return $row->child;
                }
                return 0;
        }

References $GLOBALS, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilSCTreeTasksGUI\repairDuplicates().

Here is the caller graph for this function:

◆ findDuplicates()

static ilSCTreeTasks::findDuplicates ( $a_duplicate_id )

static

find duplicates @global type $ilDB

Returns: type

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

        {
                global $ilDB;
                
                $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,'integer').' '.
                                'ORDER BY depth DESC';
                $res = $ilDB->query($query);
                
                $GLOBALS['ilLog']->write($query);
                
                $nodes = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $node = array();
                        $node['tree'] = $row->tree;
                        $node['child'] = $row->child;
                        $node['depth'] = $row->depth;
                        
                        $nodes[] = $node;
                }
                
                return $nodes;
        }

References $GLOBALS, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

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

Here is the caller graph for this function:

◆ findMissing()

ilSCTreeTasks::findMissing ( )

Find missing objects.

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

        {
                global $ilDB;
                
                $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 $ilDB, 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 287 of file class.ilSCTreeTasks.php.

        {
                global $ilDB;
                
                $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 $ilDB, getTask(), IL_CAL_UNIX, readMissingTreeEntries(), ilSCTask\STATUS_COMPLETED, and ilSCTask\STATUS_FAILED.

Here is the call graph for this function:

◆ getChilds()

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

static

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

        {
                global $ilDB;
                
                $query = 'SELECT * FROM tree WHERE tree = '.$ilDB->quote($a_tree_id,'integer').' '.'AND child = '.$ilDB->quote($a_childs,'integer');
                $res = $ilDB->query($query);
                
                $childs = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $childs[] = $row->child;
                }
                return $childs;
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilSCTreeDuplicatesTableGUI\fillRow().

Here is the caller graph for this function:

◆ getDB()

ilSCTreeTasks::getDB ( )

Returns: ilDB

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

        {
                return $this->db;
        }

References $db.

Referenced by checkDuplicates().

Here is the caller graph for this function:

◆ getNodeInfo()

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

static

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

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

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by ilSCTreeDuplicatesTableGUI\fillObjectRow().

Here is the caller graph for this function:

◆ getTask()

ilSCTreeTasks::getTask ( )

Returns: ilSCTask

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

        {
                return $this->task;
        }

References $task.

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

Here is the caller graph for this function:

◆ hasDuplicate()

static ilSCTreeTasks::hasDuplicate ( $a_child )

static

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

        {
                global $ilDB;
                
                return count(self::findDuplicates($a_child));
        }

References $ilDB.

◆ readMissing()

ilSCTreeTasks::readMissing ( )

protected

Read missing objects in tree Entry in oject_reference but no entry in tree @global type $ilDB.

Returns: type

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

        {
                global $ilDB;
                
                $query = 'SELECT ref_id FROM object_reference '.
                                'LEFT JOIN tree ON ref_id = child '.
                                'WHERE child IS NULL';
                $res = $ilDB->query($query);
                
                $failures = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $failures[] = $row->ref_id;
                }
                return $failures;
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by findMissing(), and repairMissing().

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 @global type $ilDB.

Returns: type

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

        {
                global $ilDB;
                
                $query = 'SELECT child FROM tree '.
                                'LEFT JOIN object_reference ON child = ref_id '.
                                'WHERE ref_id IS NULL';
                
                $res = $ilDB->query($query);
                
                $failures = array();
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $failures[] = $row->child;
                }
                return $failures;
        }

References $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by findMissingTreeEntries(), and repairMissingTreeEntries().

Here is the caller graph for this function:

◆ repairMissing()

ilSCTreeTasks::repairMissing ( )

Repair missing objects.

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

        {
                $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	(	$a_parent_ref,
		$a_ref_id
	)

protected

Repair missing object.

Parameters

type $a_parent_ref

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

        {
                global $ilDB;
                
                // check if object entry exist
                $query = 'SELECT obj_id FROM object_reference '.
                                'WHERE ref_id = '.$ilDB->quote($a_ref_id,'integer');
                
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $query = 'SELECT type, title FROM object_data '.
                                        'WHERE obj_id = '.$ilDB->quote($row->obj_id,'integer');
                        $ores = $ilDB->query($query);
                        
                        $done = FALSE;
                        while($orow = $ores->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                $GLOBALS['ilLog']->write(__METHOD__.': Moving to recovery folder: '.$orow->type.': '.$orow->title);
                                $done = TRUE;
                                
                                include_once './Services/Object/classes/class.ilObjectFactory.php';
                                $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);
                                        $GLOBALS['ilLog']->write(__METHOD__.': Moving finished');
                                        break;
                                }
                        }
                        if(!$done)
                        {
                                // delete reference value
                                $query = 'DELETE FROM object_reference WHERE ref_id = '.$ilDB->quote($a_ref_id,'integer');
                                $ilDB->manipulate($query);
                                $GLOBALS['ilLog']->write(__METHOD__.': Delete reference for "object" without tree and object_data entry: ref_id= '.$a_ref_id );
                        }
                }
                
        }

References $GLOBALS, $ilDB, $query, $res, $row, and DB_FETCHMODE_OBJECT.

Referenced by repairMissing().

Here is the caller graph for this function:

◆ repairMissingTreeEntries()

ilSCTreeTasks::repairMissingTreeEntries ( )

repair missing tree entries @global type $ilDB

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

        {
                global $ilDB;
                
                $missing = $this->readMissingTreeEntries();
                $GLOBALS['ilLog']->write(__METHOD__.': '.print_r($missing,TRUE));
                
                foreach($missing as $ref_id)
                {
                        // check for duplicates
                        $query = 'SELECT tree, child FROM tree '.
                                        'WHERE child = '.$ilDB->quote($ref_id);
                        $res = $ilDB->query($query);
                        while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                $GLOBALS['ilLog']->write(__METHOD__.': '.$row->tree.': '.$ref_id);
                                
                                $this->deleteMissingTreeEntry($row->tree,$ref_id);
                        }
                }
        }

References $GLOBALS, $ilDB, $query, $ref_id, $res, $row, DB_FETCHMODE_OBJECT, deleteMissingTreeEntry(), and readMissingTreeEntries().

Here is the call graph for this function:

◆ repairPK()

static ilSCTreeTasks::repairPK ( )

static

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

        {
                #$GLOBALS['ilDB']->dropPrimaryKey('tree');
                $GLOBALS['ilDB']->addPrimaryKey('tree', array('child'));
        }

References $GLOBALS.

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

Here is the caller graph for this function:

◆ validateDuplicates()

ilSCTreeTasks::validateDuplicates ( )

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

        {
                $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 ( )

validate tree structure base on parent relation

Returns: type

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

        {
                $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

ilSCTreeTasks::$db = null

private

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

Referenced by getDB().

◆ $task

ilSCTreeTasks::$task = null

private

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

Referenced by __construct(), and getTask().

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

Services/Tree/classes/class.ilSCTreeTasks.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

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