class.ilTreeTrashQueries.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */


class ilTreeTrashQueries
{
    protected const QUERY_LIMIT = 10;

    private $ref_id = 0;


    private $tree = null;

    private $logger;

    private $db;

    public function __construct()
    {
        global $DIC;


        $this->db = $DIC->database();
        $this->logger = $DIC->logger()->tree();

        $this->tree = $DIC->repositoryTree();
    }

    public function isTrashedTrash(array $ref_ids)
    {
        global $DIC;

        $tree = $DIC->repositoryTree();

        $query = 'select tree,child,parent from tree ' .
            'where ' . $this->db->in('child', $ref_ids, false, \ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
        $trashed_trash = false;
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            if ((int) $row->child != ((int) $row->tree * -1)) {
                $trashed_trash = true;
            }
            if ($tree->isDeleted($row->parent)) {
                $trashed_trash = true;
            }
        }
        return $trashed_trash;
    }

    public function findRepositoryLocationForDeletedNode(int $deleted_node)
    {
        $query = 'select parent from tree ' .
            'where child = ' . $this->db->quote($deleted_node, \ilDBConstants::T_INTEGER) . ' ' .
            'and tree = ' . $this->db->quote($deleted_node * -1, \ilDBConstants::T_INTEGER);
        $this->logger->info($query);
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->parent;
        }
        $this->logger->warning('Invalid node given for restoring to original location: deleted node id: ' . $deleted_node);
        throw new \ilRepositoryException('Invalid node given for restoring to original location');
    }

    public function getTrashedNodeTypesForContainer(int $ref_id)
    {
        $subtreequery = $this->tree->getTrashSubTreeQuery($ref_id, ['child']);

        $query = 'select distinct(type) obj_type from object_data obd ' .
            'join object_reference obr on obd.obj_id = obr.obj_id ' .
            'where ref_id in (' .
            $subtreequery . ' ' .
            ') ';

        $this->logger->dump($query);

        $res = $this->db->query($query);
        $obj_types = [];
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $obj_types[] = $row->obj_type;
        }
        return $obj_types;
    }

    public function getNumberOfTrashedNodesForTrashedContainer(int $ref_id)
    {
        $res = $this->db->query($this->tree->getTrashSubTreeQuery($ref_id, ['child']));
        return (int) $res->numRows();
    }

    public function getTrashNodeForContainer(
        int $ref_id,
        array $filter,
        int &$max_entries,
        string $order_field,
        string $order_direction,
        int $limit = self::QUERY_LIMIT,
        int $offset = 0
    ) {
        $subtreequery = $this->tree->getTrashSubTreeQuery($ref_id, ['child']);

        $select = 'select ref_id, obd.obj_id, type, title, description, deleted, deleted_by ';
        $select_count = 'select count(ref_id) max_entries ';

        $from = 'from object_data obd ' .
            'join object_reference obr on obd.obj_id = obr.obj_id ' .
            'where ref_id in (' .
            $subtreequery . ' ' .
            ') ';

        $order = ' ';
        if ($order_field) {
            $order = 'ORDER BY ' . $order_field . ' ' . $order_direction;
        }

        $query = $select . $from . $this->appendTrashNodeForContainerQueryFilter($filter) . $order;
        $query_count = $select_count . $from . $this->appendTrashNodeForContainerQueryFilter($filter);


        $this->logger->dump($query);

        $res_max_entries = $this->db->query($query_count);
        while ($max_entries_row = $res_max_entries->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $max_entries = $max_entries_row->max_entries;
        }

        $this->db->setLimit($limit, $offset);
        $res = $this->db->query($query);


        $items = [];
        while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
            $item = new \ilTreeTrashItem();
            $item->setObjId($row->obj_id);
            $item->setRefId($row->ref_id);
            $item->setTitle($row->title);
            $item->setDescription($row->description);
            $item->setType($row->type);
            $item->setDeleted($row->deleted);
            $item->setDeletedBy($row->deleted_by);

            $items[] = $item;
        }
        return $items;
    }



    public function getTrashedNodesForContainerUsingRecursion(int $ref_id)
    {
        $query = 'with recursive trash (child,tree) as ' .
            '( select child, tree from tree where child = ' . $this->db->quote($ref_id, \ilDBConstants::T_INTEGER) . ' ' .
            'union select tc.child,tc.tree from tree tc join tree tp on tp.child = tc.parent ) ' .
            'select * from trash where tree < 1 ';

        $trash_ids = [];

        try {
            $res = $this->db->query($query);
            while ($row = $res->fetchRow(\ilDBConstants::FETCHMODE_OBJECT)) {
                $trash_ids[] = $row->child;
            }
        } catch (\ilDatabaseException $e) {
            $this->logger->warning($query . ' is not supported');
        }
    }

    protected function appendTrashNodeForContainerQueryFilter(array $filter) : string
    {
        $query = '';
        if (isset($filter['type'])) {
            $query .= 'and ' . $this->db->like(
                'type',
                \ilDBConstants::T_TEXT,
                $filter['type'] . '%'
                ) . ' ';
        }
        if (isset($filter['title'])) {
            $query .= 'and ' . $this->db->like(
                'title',
                \ilDBConstants::T_TEXT,
                '%' . $filter['title'] . '%'
                ) . ' ';
        }
        if (
            $filter['deleted']['from'] instanceof \ilDate &&
            $filter['deleted']['to'] instanceof  \ilDate) {
            $query .= ('and deleted between ' .
                $this->db->quote($filter['deleted']['from']->get(\IL_CAL_DATE), \ilDBConstants::T_TEXT) . ' and ' .
                $this->db->quote($filter['deleted']['to']->get(IL_CAL_DATE), \ilDBConstants::T_TEXT) . ' ');
        } elseif ($filter['deleted']['from'] instanceof \ilDate) {
            $query .= 'and deleted >= ' . $this->db->quote($filter['deleted']['from']->get(IL_CAL_DATE), \ilDBConstants::T_TEXT) . ' ';
        } elseif ($filter['deleted']['to'] instanceof \ilDate) {
            $query .= 'and deleted <= ' . $this->db->quote($filter['deleted']['to']->get(IL_CAL_DATE), \ilDBConstants::T_TEXT) . ' ';
        }

        if (isset($filter['deleted_by']) && !empty($filter['deleted_by'])) {
            $usr_id = \ilObjUser::_lookupId($filter['deleted_by']);
            if ($usr_id > 0) {
                $query .= 'and deleted_by = ' . $this->db->quote($usr_id, \ilDBConstants::T_INTEGER) . ' ';
            }
        }

        return $query;
    }
}