Docman_ItemFactory

Complexity

Total Complexity

238

Size/Duplication

Total Lines	1389
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	25

67 Methods

Rating	Name	Duplication	Size	Complexity
A	setInstance()	0	3	1
A	clearInstance()	0	3	1
A	setGroupId()	0	3	1
A	getGroupId()	0	3	1
A	getWikiPageReferencers()	0	16	4
A	getChildrenFromParent()	0	19	4
A	getItemTree()	0	3	1
A	_getVersionFactory()	0	3	1
A	_getUserManager()	0	3	1
A	_getEventManager()	0	3	1
A	massUpdate()	0	4	1
A	isMoveable()	0	10	4
A	isRoot()	0	4	1
A	rawCreate()	0	4	1
A	setCutPreference()	0	4	1
A	setCopyPreference()	0	4	1
A	delCutPreference()	0	3	1
A	delCopyPreference()	0	3	1
A	delCutPreferenceForAllUsers()	0	4	1
A	delCopyPreferenceForAllUsers()	0	4	1
A	listPendingItems()	0	4	1
A	purgeDeletedItems()	0	12	4
A	purgeDeletedItem()	0	4	1
A	Docman_ItemFactory()	0	10	1
A	instance()	0	6	2
C	getItemFromRow()	0	60	11
C	getItemTypeAsText()	0	24	7
C	getItemTypeForItem()	0	26	7
A	getIdInWikiOfWikiPageItem()	0	9	2
A	deleteWikiPage()	0	5	1
A	getWikiPage()	0	19	2
A	getItemFromDb()	0	12	3
B	getAllChildrenFromParent()	0	23	5
A	_getExpandedUserPrefs()	0	17	3
A	preloadItemPerms()	0	14	2
A	isInSubTree()	0	12	3
A	getParents()	0	10	2
C	getItemSubTree()	0	56	13
F	getItemSubTreeAsList()	0	130	27
A	getItemList()	0	7	2
B	getDocumentsIterator()	0	22	4
A	searchPaginatedWithVersionByGroupId()	0	12	2
B	findByTitle()	0	25	4
A	findFuturObsoleteItems()	0	18	2
A	_getItemDao()	0	6	2
A	update()	0	12	3
A	updateLink()	0	18	2
A	create()	0	9	2
B	isItemTheOnlyChildOfRoot()	0	17	6
A	setNewParent()	0	5	3
B	breathFirst()	0	18	6
C	getItemTreeFromLeaves()	0	60	14
C	connectOrphansToParents()	0	29	8
A	getItemMapping()	0	5	1
A	getRoot()	0	8	2
A	createRoot()	0	7	1
B	cloneItems()	0	31	4
A	preferrencesExist()	0	5	1
B	getCutPreference()	0	14	5
A	getCopyPreference()	0	6	2
A	getCurrentWikiVersion()	0	11	3
A	getFolderStats()	0	8	3
D	getFolderTreeStats()	0	38	10
A	delete()	0	20	2
B	deleteProjectTree()	0	20	5
B	deleteSubTree()	0	20	6
C	restore()	0	28	7

<?php
/*
 * Copyright (c) Enalean, 2015. All Rights Reserved.
 * Copyright (c) STMicroelectronics, 2006. All Rights Reserved.
 *
 * Originally written by Manuel Vacelet, 2006
 * 
 * This file is a part of Tuleap.
 *
 * Tuleap is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * Tuleap is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with Tuleap. If not, see <http://www.gnu.org/licenses/>.
 */
require_once('common/dao/CodendiDataAccess.class.php');
require_once('common/reference/ReferenceManager.class.php');

require_once('DocmanConstants.class.php');
require_once('Docman_Item.class.php');
require_once('Docman_ItemDao.class.php');
require_once('Docman_Folder.class.php');
require_once('Docman_File.class.php');
require_once('Docman_Link.class.php');
require_once('Docman_EmbeddedFile.class.php');
require_once('Docman_Wiki.class.php');
require_once('Docman_Empty.class.php');
require_once('Docman_Version.class.php');
require_once('Docman_CloneItemsVisitor.class.php');
require_once('Docman_SubItemsRemovalVisitor.class.php');
require_once('Docman_PermissionsManager.class.php');
require_once('Docman_BuildItemMappingVisitor.class.php');
require_once('Docman_ActionsDeleteVisitor.class.php');

/**
 * 
 */
class Docman_ItemFactory {
    var $rootItems;
    var $onlyOneChildForRoot;
    var $copiedItem;
    var $groupId;

    private static $instance;
    
    function Docman_ItemFactory($groupId=null) {
        // Cache highly used info
        $this->rootItems[] = array();
        $this->onlyOneChildForRoot[] = array();
        $this->copiedItem = array();
        $this->cutItem = array();

        // Parameter
        $this->groupId = $groupId;
    }

    /**
     * Return a single instance of Docman_ItemFactory per group.
     * 
     * This is useful when you need to cache information across method calls
     * 
     * @param Integer $group_id Project id
     * 
     * @return Docman_ItemFactory
     */
    public static function instance($group_id) {
        if(!isset(self::$instance[$group_id])) {
            self::$instance[$group_id] = new Docman_ItemFactory($group_id);
        }
        return self::$instance[$group_id];
    }

    /**
     * Return a single instance of Docman_ItemFactory per group.
     * 
     * This is useful when you need to cache information across method calls
     * 
     * @param Integer $group_id Project id
     * 
     * @return Docman_ItemFactory
     */
    public static function setInstance($group_id, $instance) {
        self::$instance[$group_id] = $instance;
    }

    /**
     * Return a single instance of Docman_ItemFactory per group.
     * 
     * This is useful when you need to cache information across method calls
     * 
     * @param Integer $group_id Project id
     * 
     * @return Docman_ItemFactory
     */
    public static function clearInstance($group_id) {
        self::$instance[$group_id] = null;
    }

    function setGroupId($id) {
        $this->groupId = $id;
    }
    function getGroupId() {
        return $this->groupId;
    }

    function &getItemFromRow(&$row) {
        $item = null;
        switch($row['item_type']) {
        case PLUGIN_DOCMAN_ITEM_TYPE_FOLDER:
            $item = new Docman_Folder($row);
            break;
        case PLUGIN_DOCMAN_ITEM_TYPE_FILE:
            $item = new Docman_File($row);
            break;
        case PLUGIN_DOCMAN_ITEM_TYPE_LINK:
            $item = new Docman_Link($row);
            if (isset($row['link_version_id'])) {
                $item->setCurrentVersion(
                    new Docman_LinkVersion(
                        array(
                            'id'        => $row['link_version_id'],
                            'user_id'   => $row['link_version_user_id'],
                            'item_id'   => $item->getId(),
                            'number'    => $row['link_version_number'],
                            'label'     => $row['link_version_label'],
                            'changelog' => $row['link_version_changelog'],
                            'date'      => $row['link_version_date'],
                            'link_url'      => $row['link_version_link_url']
                        )
                    )
                );
            }
            break;
        case PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE:
            $item = new Docman_EmbeddedFile($row);
            break;
        case PLUGIN_DOCMAN_ITEM_TYPE_WIKI:
            $item = new Docman_Wiki($row);
            break;
        case PLUGIN_DOCMAN_ITEM_TYPE_EMPTY:
            $item = new Docman_Empty($row);
            break;
        default:
            return;
        }
        if ($row['item_type'] == PLUGIN_DOCMAN_ITEM_TYPE_FILE || $row['item_type'] == PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE) {
            if (isset($row['version_id'])) {
                $version = array(
                    'id'        => $row['version_id'],
                    'user_id'   => $row['version_user_id'],
                    'item_id'   => $item->getId(),
                    'number'    => $row['version_number'],
                    'label'     => $row['version_label'],
                    'changelog' => $row['version_changelog'],
                    'date'      => $row['version_date'],
                    'filename'  => $row['version_filename'],
                    'filesize'  => $row['version_filesize'],
                    'filetype'  => $row['version_filetype'],
                    'path'      => $row['version_path']
                );
                $item->setCurrentVersion(new Docman_Version($version));

The method setCurrentVersion does only exist in Docman_File and Docman_Link, but not in Docman_Empty and Docman_Folder and Docman_Wiki.

            }
        }
        return $item;
    }

    function getItemTypeAsText($itemTypeId) {
        switch($itemTypeId) {
        case PLUGIN_DOCMAN_ITEM_TYPE_FOLDER:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_folder');
            break;

break is not strictly necessary here and could be removed.

        case PLUGIN_DOCMAN_ITEM_TYPE_FILE:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_file');
            break;

break is not strictly necessary here and could be removed.

        case PLUGIN_DOCMAN_ITEM_TYPE_LINK:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_link');
            break;

break is not strictly necessary here and could be removed.

        case PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_embeddedfile');
            break;

break is not strictly necessary here and could be removed.

        case PLUGIN_DOCMAN_ITEM_TYPE_WIKI:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_wiki');
            break;

break is not strictly necessary here and could be removed.

        case PLUGIN_DOCMAN_ITEM_TYPE_EMPTY:
            return $GLOBALS['Language']->getText('plugin_docman','filters_item_type_empty');
            break;

break is not strictly necessary here and could be removed.

        default:
            return $GLOBALS['Language']->getText('include_html','unknown_value');
        }
    }

    function getItemTypeForItem(&$item) {
        $type = false;
        switch(strtolower(get_class($item))) {
            case 'docman_folder':
                $type = PLUGIN_DOCMAN_ITEM_TYPE_FOLDER;
                break;
            case 'docman_link':
                $type = PLUGIN_DOCMAN_ITEM_TYPE_LINK;
                break;
            case 'docman_wiki':
               $type = PLUGIN_DOCMAN_ITEM_TYPE_WIKI;
                break;
            case 'docman_file':
                $type = PLUGIN_DOCMAN_ITEM_TYPE_FILE;
                break;
            case 'docman_embeddedfile':
                $type = PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE;
                break;
            case 'docman_empty':
                $type = PLUGIN_DOCMAN_ITEM_TYPE_EMPTY;
                break;
            default:
                break;
        }
        return $type;
    }
	
    /**   
    * @return wiki page id or null if the page is not yet created in wiki.
    */   
    function getIdInWikiOfWikiPageItem($pagename, $group_id) {
        $wiki_page = $this->getWikiPage($group_id, $pagename);

        if ($wiki_page->exist()) {
            return $wiki_page->getId();
        } else {
            return null;
        }
    }

    /**
    * This looks for possible references of a wiki page from docman
    *
    * @param string $wiki_page
    * @param string $group_id
    *
    * @return Array items that reference the same given wiki page.
    */
    function getWikiPageReferencers($wiki_page, $group_id) {
        $items = array();
        $item_dao =& $this->_getItemDao();
        if($item_dao->isWikiPageReferenced($wiki_page, $group_id)) {
            $items_ids = $item_dao->getItemIdByWikiPageAndGroupId($wiki_page, $group_id);
            if(is_array($items_ids)){
                foreach($items_ids as $key => $id) {
                    $items[] = $this->getItemFromDb($id);
                }
            }
            else {
                $items[] =& $this->getItemFromDb($items_ids);
            }
        }
        return $items;
    }

    /**
    * This deletes an existant wiki page and all its stored data and infos from codendi db.
    *
    * @param string $wiki_page_name name of the wiki page
    * @param int $group_id project id.
    *
    * @return true if there was no error.
    */
    function deleteWikiPage($wiki_page_name, $group_id) {
        $wiki_page = $this->getWikiPage($group_id, $wiki_page_name);

        return $wiki_page->delete();
    }

    private function getWikiPage($project_id, $pagename) {
        $wiki_page = null;

        $event_manager = EventManager::instance();
        $event_manager->processEvent(
            PLUGIN_DOCMAN_EVENT_GET_PHPWIKI_PAGE,
            array(
                'phpwiki_page_name' => $pagename,
                'project_id'        => $project_id,
                'phpwiki_page'      => $wiki_page
            )
        );

        if ($wiki_page === null) {
            $wiki_page = new WikiPage($project_id, $pagename);
        }

        return $wiki_page;
    }

    /**
     * @return Docman_Item
     */
    function &getItemFromDb($id, $params = array()) {
        $_id = (int) $id;
        $dao =& $this->_getItemDao();
        $dar = $dao->searchById($id, $params);

        $item = null;
        if(!$dar->isError() && $dar->valid()) {
            $row =& $dar->current();
            $item =& Docman_ItemFactory::getItemFromRow($row);
        }
        return $item;
    }

    function &getChildrenFromParent($item) {
        $dao =& $this->_getItemDao();
        
        $itemArray = array();

        $dar = $dao->searchByParentsId(array($item->getId()));
        if ($dar && !$dar->isError()) {
            while($dar->valid()) {
                $row = $dar->current();

                $itemArray[] = Docman_ItemFactory::getItemFromRow($row);

                $dar->next();
            }
        }

        $iIter = new ArrayIterator($itemArray);
        return $iIter;
    }

    public function getAllChildrenFromParent(Docman_Item $item) {
        $children      = array();
        $item_iterator = $this->getChildrenFromParent($item);

        foreach($item_iterator as $child) {
            $item_type = $this->getItemTypeForItem($child);

            if ($item_type === PLUGIN_DOCMAN_ITEM_TYPE_FILE || $item_type === PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE) {
                $docman_version_factory = new Docman_VersionFactory();
                $item_current_version   = $docman_version_factory->getCurrentVersionForItem($child);

                $child->setCurrentVersion($item_current_version);
            }

            $children[] = $child;

            if ($item_type === PLUGIN_DOCMAN_ITEM_TYPE_FOLDER) {
                $children = array_merge($children, $this->getAllChildrenFromParent($child));
            }
        }

        return $children;
    }
    
    /**
     * Retreive list of collapsed items for given user
     *
     * This function retreive collapsed folders from user preferences 
     *
     * @param $parentId Id of the "current" root node (cannot be excluded).
     * @param $userId Id of current user.
     * @return Array List of items to exclude for a search
     **/
    function &_getExpandedUserPrefs($parentId, $userId) {           
        $collapsedItems = array();     
        // Retreive the list of collapsed folders in prefs
        $dao =& $this->_getItemDao();
        $dar = $dao->searchExpandedUserPrefs($this->groupId, 
                                                   $userId);
        while($dar->valid()) {
            $row =& $dar->current();
            $tmp = explode('_', $row['preference_name']);
            if ($tmp[4] != $parentId) {
                $collapsedItems[] = (int) $tmp[4];
            }
            $dar->next();
        }               
        
        return $collapsedItems;
    }
    
    /**
     * Preload item perms from a item result set
     */
    function preloadItemPerms($dar, $user, $groupId) {
        // Preload perms
        $objectsIds = array();
        $dar->rewind();
        while($dar->valid()) {
            $row = $dar->current();
            $objectsIds[] = $row['item_id'];
            $dar->next();
        }
        $dar->rewind();

        $dPm = Docman_PermissionsManager::instance($groupId);
        $dPm->retreiveReadPermissionsForItems($objectsIds, $user);
    }

    /**
     * Check if a given item is into the subtree of another given item or not.
     *
     * @param Integer $childId  Id of the potential child.
     * @param Integer $parentId Id of the potential parent.
     *
     * @return Boolean
     */
    function isInSubTree($childId, $parentId) {
        $child = $this->getItemFromDb($childId);
        if ($this->isRoot($child)) {
            return false;
        }
        $directParentId = $child->getParentId();
        if ($parentId == $directParentId) {
            return true;
        } else {
            return $this->isInSubTree($directParentId, $parentId);
        }
    }

    /**
     * Give the list of parents of an item
     *
     * @param Integer $childId  Id of the child.
     *
     * @return Array
     */
    function getParents($childId) {
        $child = $this->getItemFromDb($childId);
        if ($this->isRoot($child)) {
            return array();
        }
        $directParentId = $child->getParentId();
        $parents = $this->getParents($directParentId);
        $parents[$directParentId] = true;
        return $parents;
    }

    /**
     * Build a subtree from the given item id.
     *
     * Build the list in depth, level per level, from root to leaves.
     * 
     * @param Docman_Item $rootItem
     * @param PFUser $user
     * @param boolean $ignorePerms
     * @param boolean $expandAll
     * @param boolean $ignoreObsolete
     * @return Docman_Item
     */
    function &getItemSubTree(&$rootItem, &$user, $ignorePerms=false, $expandAll=false, $ignoreObsolete=true) {
        // {{1}} Exclude collapsed items
        $expandedFolders = array();
        if(!$expandAll) {
            $fld = $this->_getExpandedUserPrefs($rootItem->getId(), user_getid());
            foreach($fld as $v) {
                $expandedFolders[$v] = true;
            }
        }

        $searchItemsParams = array('ignore_obsolete' => $ignoreObsolete);

        //
        // Treatment
        //
        $dao =& $this->_getItemDao();
        $dPm = Docman_PermissionsManager::instance($rootItem->getGroupId());
        
        $itemList = array($rootItem->getId() => &$rootItem);
        $parentIds = array($rootItem->getId());
        do {
            // Fetch all children for the given level.
            $dar = $dao->searchChildren($parentIds, $searchItemsParams);
            $parentIds = array();
            $itemIds = array();
            $itemRows = array();
            if($dar && !$dar->isError()) {
                $dar->rewind();
                while($dar->valid()) {
                    $row = $dar->current();
                    $itemRows[$row['item_id']] = $row;
                    $itemIds[] = $row['item_id'];
                    if($row['item_type'] == PLUGIN_DOCMAN_ITEM_TYPE_FOLDER
                        && ($expandAll || isset($expandedFolders[$row['item_id']]))) {
                        $parentIds[$row['item_id']] = $row['item_id'];
                    }
                    $dar->next();
                }
                
                // Fetch all the permissions at the same time
                $dPm->retreiveReadPermissionsForItems($itemIds, $user);

                // Build hierarchy: only keep displayable items
                foreach($itemIds as $id) {
                    if($ignorePerms || $dPm->userCanRead($user, $id)) {
                        $itemList[$id] =& $this->getItemFromRow($itemRows[$id]);
                        $itemList[$itemList[$id]->getParentId()]->addItem($itemList[$id]);
                    } else {
                       unset($parentIds[$id]);
                    }
                }
            }
        } while(count($parentIds) > 0);

        return $itemList[$rootItem->getId()];
    }
    
    /**
     * This function return an iterator on a list of documents (no folders).
     *
     * How it works:
     * 1. Get the list of all documents that match the criteria (if
     *    any!). (permissions apply).
     *    Note: the final list of documents is a subset of this result.
     * 2. Get the list of folders behind $parentId (permissions apply).
     * 3. Check that each document in list 1. is in a folder of list 2.
     * 5. Apply limits ($start, $offset) is only a subset of the list is required.
     * 6. If needed, add the metadata to the items. 
     */
    function &getItemSubTreeAsList($parentId, &$nbItemsFound, $params = null) {
        $_parentId = (int) $parentId;
         
        $user =& $params['user'];

        // Prepare filters if any
        $filter = null;
        if(isset($params['filter'])) {
            $filter =& $params['filter'];
        }

        // Obsolescence
        $searchItemsParams = array();
        if(isset($params['ignore_obsolete'])) {
            $searchItemsParams['ignore_obsolete'] = $params['ignore_obsolete'];
        }

        // Range of documents to return
        $start = 0;
        if(isset($params['start'])) {
            $start = $params['start'];
        }
        $end = 25;
        if(isset($params['offset'])) {
            $end = $start + $params['offset'];
        }

        $dao =& $this->_getItemDao();
        
        //
        // Build Folder List
        //
        $parentItem = $this->getItemFromDb($parentId);
        $dPm = Docman_PermissionsManager::instance($parentItem->getGroupId());
        $folderList = array($parentId => &$parentItem);
        $pathIdArray = array($parentId => array());
        $pathTitleArray = array($parentId => array());
        $parentIds = array($parentId);
        $folderIds = array($parentId);
        $i = 0;
        do {
            $i++;
            $dar = $dao->searchSubFolders($parentIds);
            $parentIds = array();
            $itemIds   = array();
            $itemRows = array();
            if($dar && !$dar->isError()) {
                $dar->rewind();
                while($dar->valid()) {
                    $row = $dar->current();
                    $itemRows[$row['item_id']] = $row;
                    $itemIds[] = $row['item_id'];
                    $parentIds[$row['item_id']] = $row['item_id'];
                    $dar->next();
                }

                // Fetch all the permissions at the same time
                $dPm->retreiveReadPermissionsForItems($itemIds, $user);

                // Build hierarchy: only keep displayable items
                foreach($itemIds as $id) {
                    if($dPm->userCanRead($user, $id)) {
                        $folderList[$id] =& $this->getItemFromRow($itemRows[$id]);
                        // Update path
                        $pathIdArray[$id] = array_merge($pathIdArray[$folderList[$id]->getParentId()], array($id));
                        $pathTitleArray[$id] = array_merge($pathTitleArray[$folderList[$id]->getParentId()], array($folderList[$id]->getTitle()));
                    } else {
                        unset($parentIds[$id]);
                    }
                }
            }
        } while(count($parentIds) > 0);

        //
        // Keep only documents in allowed subfolders
        //
        $mdFactory  = new Docman_MetadataFactory($this->groupId);
        $ci = null;
        if($filter !== null) {
            $ci = $filter->getColumnIterator();
        }

        //
        // Build Document list
        //
        $itemArray = array();
        if(isset($params['obsolete_only']) && $params['obsolete_only']) {
            $dar = $dao->searchObsoleteByGroupId($this->groupId);
        } else {
            $dar = $dao->searchByGroupId($this->groupId, $filter, $searchItemsParams);
        }

        $nbItemsFound = 0;
        if($dar && !$dar->isError()) {
            $this->preloadItemPerms($dar, $user, $this->groupId);
            $dar->rewind();
            while($dar->valid()) {
                $row = $dar->current();
                // The document is not is one of the allowed subfolder so we
                // can delete it. As a side effect decrease the number of
                // document found.
                if($dPm->userCanRead($user, $row['item_id']) && isset($folderList[$row['parent_id']])) {
                    if($nbItemsFound >= $start && $nbItemsFound < $end || (isset($params['getall']) && $params['getall'])) {
                        $itemArray[$row['item_id']] =& $this->getItemFromRow($row);

                        // Append Path
                        $itemArray[$row['item_id']]->setPathTitle($pathTitleArray[$row['parent_id']]);
                        $itemArray[$row['item_id']]->setPathId($pathIdArray[$row['parent_id']]);

                        // Append metadata
                        if($ci !== null) {
                            $ci->rewind();
                            while($ci->valid()) {
                                $c = $ci->current();
                                if($c->md !== null && $mdFactory->isRealMetadata($c->md->getLabel())) {
                                    $mdFactory->addMetadataValueToItem($itemArray[$row['item_id']], $c->md);
                                }
                                $ci->next();
                            }
                        }
                    }
                    $nbItemsFound++;
                }
                $dar->next();
            }
        }

        $docIter =& new ArrayIterator($itemArray);
        return $docIter;
    }

    /**
     * Build a tree from with the list of items
     *
     * @return Docman_Item
     */
    function &getItemTree(&$rootItem, &$user, $ignorePerms=false, $expandAll=false, $ignoreObsolete=true) {
        return $this->getItemSubTree($rootItem, $user, $ignorePerms, $expandAll, $ignoreObsolete);
    }

    /**
     * Build a list of items
     *
     * @return ItemNode
     */
    function &getItemList($id = 0, &$nbItemsFound, $params = null) {
        if (!$id) {
            $dao =& $this->_getItemDao();
            $id = $dao->searchRootIdForGroupId($this->groupId);
        }
        return $this->getItemSubTreeAsList($id, $nbItemsFound, $params);
    } 

    /**
     *
     */
    function &getDocumentsIterator() {
        $dao =& $this->_getItemDao();
        $filters = null;
        $dar = $dao->searchByGroupId($this->groupId, $filters, array());
        $itemList = array();
        while($dar->valid()) {
            $row = $dar->current();

            $item =& $this->getItemFromRow($row);
            $type = $this->getItemTypeForItem($item);
            if($type != PLUGIN_DOCMAN_ITEM_TYPE_FOLDER) {
                if(!isset($itemList[$item->getId()])) {
                    $itemList[$item->getId()] =& $item;
                }
            }

            $dar->next();
        }

        $i = new ArrayIterator($itemList);
        return $i;
    }

    /**
     * @param int $limit
     * @param int $offset
     * @return Docman_File[]
     */
    public function searchPaginatedWithVersionByGroupId($limit, $offset) {
        $result = $this->_getItemDao()->searchPaginatedWithVersionByGroupId($this->groupId, $limit, $offset);

        $items = array();
        foreach ($result as $row) {
            $items[] = $this->getItemFromRow($row);
        }

        $result->freeMemory();

        return $items;
    }

    /**
     *
     */
    function findByTitle($user, $title, $groupId) {
        $ia = array();

        $dao =& $this->_getItemDao();
        $dPm = Docman_PermissionsManager::instance($groupId);
        $dar = $dao->searchByTitle($title);
        $dar->rewind();
        while($dar->valid()) {
            $row = $dar->current();

            $item = $this->getItemFromRow($row);
            if($dPm->userCanRead($user, $item->getId())) {
                $parentItem = $this->getItemFromDb($item->getParentId());
                if($dPm->userCanRead($user, $parentItem->getId())) {
                    $ia[] = $item;
                }
            }

            $dar->next();
        }

        $ii = new ArrayIterator($ia);

        return $ii;
    }

    /*
     * Give the list of documents obsolete that have an obsolescence date in
     * one month.
     * It means that the obso date of the document is between 00:00:00 and
     * 23:59:59 in on month from today.
     */
    function findFuturObsoleteItems() {
        // Compute the timescale for the day in one month
        $today = getdate();
        $tsStart = mktime(0,0,0, $today['mon']+1, $today['mday'], $today['year']);
        $tsEnd   = mktime(23,59,59, $today['mon']+1, $today['mday'], $today['year']);

        $ia = array();
        $dao =& $this->_getItemDao();
        $dar = $dao->searchObsoleteAcrossProjects($tsStart, $tsEnd);
        while($dar->valid()) {
            $row = $dar->current();
            $ia[] = $this->getItemFromRow($row);
            $dar->next();
        }

        $ii = new ArrayIterator($ia);
        return $ii;
    }

    var $dao;
    /**
     * @return Docman_ItemDao
     */
    function _getItemDao() {
        if (! $this->dao) {
            $this->dao = new Docman_ItemDao(CodendiDataAccess::instance());
        }
        return $this->dao;
    }

    protected function _getVersionFactory() {
        return new Docman_VersionFactory();
    }

    protected function _getUserManager() {
        return UserManager::instance();
    }

    protected function _getEventManager() {
        return EventManager::instance();
    }

    function update($row) {
        // extract cross references
        $reference_manager = ReferenceManager::instance();
        if (isset($row['title'])) {
            $reference_manager->extractCrossRef($row['title'], $row['id'], ReferenceManager::REFERENCE_NATURE_DOCUMENT, $this->groupId);
        }
        if (isset($row['description'])) {
            $reference_manager->extractCrossRef($row['description'], $row['id'], ReferenceManager::REFERENCE_NATURE_DOCUMENT, $this->groupId);
        }
        $dao = $this->_getItemDao();
        return $dao->updateFromRow($row);
    }

    public function updateLink(Docman_Link $link, array $version_data) {
        $update = $this->update(
            array(
                'id'        => $link->getId(),
                'group_id'  => $link->getGroupId(),
                'title'     => $link->getTitle(),
                'user_id'   => $link->getOwnerId(),
                'item_type' => PLUGIN_DOCMAN_ITEM_TYPE_LINK,
                'link_url'  => $link->getUrl(),
            )
        );

        $link_version_factory = new Docman_LinkVersionFactory();

        $create = $link_version_factory->create($link, $version_data['label'], $version_data['changelog'], $_SERVER['REQUEST_TIME']);

        return ($update && $create);
    }

    function massUpdate($srcItemId, $mdLabel, $itemIdArray) {
        $dao =& $this->_getItemDao();
        $dao->massUpdate($srcItemId, $mdLabel, $itemIdArray);
    }

    public function create($row, $ordering) {
        $dao =& $this->_getItemDao();
        $id = $dao->createFromRow($row);
        if ($id) {
            $this->setNewParent($id, $row['parent_id'], $ordering);
        }

        return $id;
    }

    /**
     * Find root unique child if exists.
     *
     * @param $groupId Project id of the docman.
     * @return int/boolean false if there is more than one children for root.

The doc-type int/boolean could not be parsed: Unknown type name "int/boolean" at position 0. (view supported doc-types)

     *                     true if there is no child for root.
     *                     item_id of the unique child of root if any.
     */
    function isItemTheOnlyChildOfRoot($groupId) {
        if(!isset($this->onlyOneChildForRoot[$groupId])) {
            $dao = $this->_getItemDao();
            $dar = $dao->hasRootOnlyOneChild($groupId);
            if($dar && !$dar->isError()) {
                if($dar->rowCount() > 1) {
                    $this->onlyOneChildForRoot[$groupId] = false;
                } elseif($dar->rowCount() == 0) {
                    $this->onlyOneChildForRoot[$groupId] = true;
                } else {
                    $row = $dar->getRow();
                    $this->onlyOneChildForRoot[$groupId] = (int) $row['item_id'];
                }
            }
        }
        return $this->onlyOneChildForRoot[$groupId];
    }

    /**
     * Check if given item is movable or not.
     *
     * An item is movable if:
     * - it's not root of the project.
     * - there is more than one children for root.
     * - or if the item is not the unique children of root.
     */
    function isMoveable($item) {
        $movable = false;
        if($item->getParentId() != 0) {
            $onlyOneChild = $this->isItemTheOnlyChildOfRoot($item->getGroupId());
            if($onlyOneChild === false || $onlyOneChild !== $item->getId()) {
                $movable = true;
            }
        }
        return $movable;
    }
 
   function setNewParent($item_id, $new_parent_id, $ordering) {
        $item =& $this->getItemFromDb($item_id);
        $dao =& $this->_getItemDao();
        return $item && $this->isMoveable($item) && $dao->setNewParent($item_id, $new_parent_id, $ordering);
    }

    /**
    * Walk through a item hierarchy and for each subitem apply callback method
    * in parameter.
    *
    * The callback method (or function) will be applied for each sub-item of
    * $item_id with following paramters:
    * - A plugin_docman_item table row that correspond to the child node.
    * - $params
    *
    * @see call_user_func_array for details on $callback forms.
    *
    * @param int   $item_id  Id of the parent item.
    * @param mixed $callback Callback function or method.
    * @param array $params   Parameters for the callback function
    * @return void
    */
    function breathFirst($item_id, $callback, $params) {
        $dao =& $this->_getItemDao();
        $parents = array($item_id);
        do {
            $dar = $dao->searchByParentsId($parents);
            if ($dar && !$dar->isError()) {
                $parents = array();
                while ($dar->valid()) {
                    $row = $dar->current();
                    call_user_func_array($callback, array($row, $params));
                    if (PLUGIN_DOCMAN_ITEM_TYPE_FOLDER == $row['item_type']) {
                        $parents[] = $row['item_id'];
                    }
                    $dar->next();
                }
            }
        } while (count($parents) > 0);
    }

    /**
     * Returns an item tree build from leaves to root ("bottom -> top").
     *
     * @param  Array of items.
     * @return Item_Folder A sub tree or null if root node was not found.
     */
    function &getItemTreeFromLeaves($itemArray, $user) {
        $null = null;
        if(is_array($itemArray)) {
            foreach($itemArray as $item) {
                $itemList[$item->getId()] = $item;
                $orphans[$item->getId()] = $item->getId();
                $itemIds[] = $item->getId();
            }
        } else {
            return $null;
        }

        // Check permissions on submitted item array
        $dpm =& Docman_PermissionsManager::instance($this->groupId);
        $dpm->retreiveReadPermissionsForItems($itemIds, $user);
        foreach($itemArray as $item) {
             if(!$dpm->userCanRead($user, $item->getId())) {
                 unset($itemList[$item->getId()]);
                 unset($orphans[$item->getId()]);
             }
        }

        // Now, here we go
        $paths = array();
        $dao =& $this->_getItemDao();
        $rootId = false;
        do {
            // Try to build the connections between childrens and parents in itemList
            $wantedItems = array();
            $rootInfo = $this->connectOrphansToParents($itemList, $orphans, $wantedItems);
            if($rootInfo !== false) {
                $rootId = $rootInfo;
            }

            // If some items are missing, look for them in the DB.
            if(is_array($wantedItems) && count($wantedItems) > 0) {
                $dar = $dao->searchByIdList($wantedItems);
                if($dar && !$dar->isError()) {
                    $this->preloadItemPerms($dar, $user, $this->groupId);
                    while ($dar->valid()) {
                        $row = $dar->current();
                        $item = $this->getItemFromRow($row);
                        if($dpm->userCanRead($user, $item->getId())) {
                            $itemList[$item->getId()] = $item;
                            $orphans[$item->getId()] = $item->getId();
                        } else {
                            $itemList[$item->getId()] = false;
                        }
                        $dar->next();
                    }
                }
            }
        } while (count($wantedItems) > 0);

        if($rootId !== false) {
            return $itemList[$rootId];
        } else {
            return $null;
        }
    }

    /**
     * Build the connexions between the different nodes in item list and
     * identify the missing nodes.
     *
     * This method iterates on $orphans list that indicates the item in
     * $itemList that are not yet connected to their father node.
     * The function returns the nodes in $itemList that are still orphans and
     * the list of item Ids needed to continue to build the tree
     * ($wantedItems).
     *
     * See UnitTests
     * @param $itemList    Array of Docma_Item.
     * @param $orphan      Hashmap of item ids. Items (in ItemList) without
     *                     parent node
     * @param $wantedItems Items needed to continue to build the tree.
     * @return Integer Id of root item if found, false otherwise.
     */
    function connectOrphansToParents(&$itemList, &$orphans, &$wantedItems) {
        $rootId = false;
        foreach($orphans as $itemId) {
            // Check if orphan belong to the item list and is available.
            // As orphans should always be parts of $itemList, it means that
            // this orphan is not readable by user.
            if(isset($itemList[$itemId]) && $itemList[$itemId] !== false) {
                // Check if current item parents is in the list
                $pid = $itemList[$itemId]->getParentId();
                if($pid != 0) {
                    if(isset($itemList[$pid])) {
                        if($itemList[$pid] !== false) {
                            $itemList[$pid]->addItem($itemList[$itemId]);
                            unset($orphans[$itemId]);
                        }
                    } else {
                        if(!isset($orphans[$itemId])) {
                            $orphans[$itemId] = $itemId;
                        }
                        $wantedItems[] = $pid;
                    }
                } else {
                    $rootId = $itemId;
                    unset($orphans[$itemId]);
                }
            }
        }
        return $rootId;
    }

    /**
     * Returns a hashmap with the mapping between items in $item tree and items
     * that belongs to this group.
     */
    function getItemMapping($item) {
        $v =& new Docman_BuildItemMappingVisitor($this->groupId);
        $item->accept($v);
        return $v->getItemMapping();
    }


    function &getRoot($group_id) {
        if(!isset($this->rootItems[$group_id])) {
            $dao =& $this->_getItemDao();
            $id = $dao->searchRootIdForGroupId($group_id);
            $this->rootItems[$group_id] = $this->getItemFromDb($id);
        }
        return $this->rootItems[$group_id];
    }
    function isRoot(&$item) {
        $root = $this->getRoot($item->getGroupId());
        return $item->getId() == $root->getId();
    }
    function &createRoot($group_id, $title) {
        $dao =& $this->_getItemDao();
        $root =& new Docman_Folder();
        $root->setGroupId($group_id);
        $root->setTitle($title);
        return $dao->createFromRow($root->toRow());
    }

    function rawCreate($item) {
        $dao = $this->_getItemDao();
        return $dao->createFromRow($item->toRow());
    }

    /**
     * Copy a subtree.
     */
    function cloneItems($srcGroupId, $dstGroupId, $user, $metadataMapping, $ugroupsMapping, $dataRoot, $srcItemId = 0, $dstItemId = 0, $ordering = null) {
        $itemMapping = array();

        $itemFactory = new Docman_ItemFactory($srcGroupId);
        if($srcItemId == 0) {
            $srcItem = $this->getRoot($srcGroupId);
        } else {
            $srcItem = $this->getItemFromDb($srcItemId);
        }
        $itemTree = $itemFactory->getItemTree($srcItem, $user, false, true);
        
        if ($itemTree) {
            $rank = null;
            if($ordering !== null) {
                $dao  =& $this->_getItemDao();
                $rank = $dao->_changeSiblingRanking($dstItemId, $ordering);
            }

            $cloneItemsVisitor = new Docman_CloneItemsVisitor($dstGroupId);
            $visitorParams = array('parentId' => $dstItemId,
                               'user' => $user,
                               'metadataMapping' => $metadataMapping,
                               'ugroupsMapping'  => $ugroupsMapping,
                               'data_root' => $dataRoot,
                               'newRank' => $rank,
                               'srcRootId' => $srcItemId);
            $itemTree->accept($cloneItemsVisitor, $visitorParams);
            $itemMapping = $cloneItemsVisitor->getItemMapping();
        }
        return $itemMapping;
    }
    
    function preferrencesExist($group_id, $user_id) {
        $dao =& $this->_getItemDao();
        $dar = $dao->searchExpandedUserPrefs($group_id, $user_id);
        return $dar->valid();
    }

    function setCutPreference($item) {
        user_set_preference(PLUGIN_DOCMAN_PREF.'_item_cut',
                            $item->getId());
    }

    function setCopyPreference($item) {
        user_set_preference(PLUGIN_DOCMAN_PREF.'_item_copy',
                            $item->getId());
    }

    /**
     * Get the item_id that was cut by the user.
     * 
     * If groupId is given, only items that belongs to this groupId will be
     * returned.
     * If no item match, returns false.
     * 
     * @param PFUser    $user
     * @param Integer $groupId
     * 
     * @return Integer or false.
     */
    function getCutPreference($user, $groupId=null) {
        if(!isset($this->cutItem[$user->getId()])) {
            $cutId = false;
            $id = user_get_preference(PLUGIN_DOCMAN_PREF.'_item_cut');
            if ($groupId !== null && $id !== false) {
                $item = $this->getItemFromDb($id);
                if ($item->getGroupId() == $groupId) {
                    $cutId = $id;
                }
            }
            $this->cutItem[$user->getId()] = $cutId;
        }
        return $this->cutItem[$user->getId()];
    }

    function getCopyPreference($user) {
        if(!isset($this->copiedItem[$user->getId()])) {
            $this->copiedItem[$user->getId()] = user_get_preference(PLUGIN_DOCMAN_PREF.'_item_copy');
        }
        return $this->copiedItem[$user->getId()];
    }

    function delCutPreference() {
        user_del_preference(PLUGIN_DOCMAN_PREF.'_item_cut');
    }

    function delCopyPreference() {
        user_del_preference(PLUGIN_DOCMAN_PREF.'_item_copy');
    }

    /**
    * This order deletion of cut preferences of all users set on item identified by $item_id.
    *
    * @param int $item_id identifier of docman item that has been marked as deleted.
    * @return void.

The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

    *
    */
    function delCutPreferenceForAllUsers($item_id) {
        $dao =& $this->_getItemDao();
        $dao->deleteCutPreferenceForAllUsers($item_id);
    }

    /**
    * This order deletion of copy preferences of all users set on item identified by $item_id.
    *
    * @param int $item_id identifier of docman item that has been marked as deleted.
    * @return void.

The doc-type void. could not be parsed: Unknown type name "void." at position 0. (view supported doc-types)

    *
    */
    function delCopyPreferenceForAllUsers($item_id) {
        $dao =& $this->_getItemDao();
        $dao->deleteCopyPreferenceForAllUsers($item_id);
    }

    function getCurrentWikiVersion($item) {
        $version = null;
        if($this->getItemTypeForItem($item) == PLUGIN_DOCMAN_ITEM_TYPE_WIKI) {
            $wiki_page = $this->getWikiPage($item->getGroupId(), $item->getPagename());

            if ($wiki_page->exist()) {
                $version = $wiki_page->getCurrentVersion();
            }
        }
        return $version;
    }
    
    /**
     * Returns the folder stats (count + size)
     */
    public function getFolderStats($folder, $user) {
        if(is_a($folder, 'Docman_Folder') && $folder->getId() !== null) {
            $folderSubTree = $this->getItemSubTree($folder, $user, false, true);
            return $this->getFolderTreeStats($folderSubTree);
        } else {
            return null;
        }
    }
    
    /**
     * Recursive method that takes a subtree and
     * returns the corresponding stats (count + size)
     */
    private function getFolderTreeStats($folder) {
        $stats['count'] = 0;
        $stats['size'] = 0;
        $stats['types'] = array();
        
        if(is_a($folder, 'Docman_Folder')) {
            $items = $folder->getAllItems();
            foreach ($items->iterator() as $item) {
                $class = get_class($item);
                $type = strtolower(substr(strrchr($class, '_'), 1));
                
                if (!isset($stats['types'][$type])) {
                    $stats['types'][$type] = 0;
                }
                
                $stats['types'][$type]++;
                $stats['count']++;
                if ($type == 'file' || $type == 'embeddedfile') {
                    $currentVersion = $item->getCurrentVersion();
                    if ($currentVersion !== null) {
                        $stats['size'] += $currentVersion->getFilesize();
                    }
                } else if ($type == 'folder') {
                    $childStats = $this->getFolderTreeStats($item);
                    foreach ($childStats['types'] as $k => $v) {
                        if (!isset($stats['types'][$k])) {
                            $stats['types'][$k] = 0;
                        }
                        $stats['types'][$k] += $v;
                    }
                    $stats['count'] += $childStats['count'];
                    $stats['size'] += $childStats['size'];
                }
            }
        }
        
        return $stats;
    }

    /**
     * Mark item as deleted
     *
     * @param Docman_Item $item 
     *
     * @return void
     */
    function delete($item) {
        // The event must be processed before the item is deleted
        $um         = UserManager::instance();
        $user       = $um->getCurrentUser();
        $itemParent = $this->getItemFromDb($item->getParentId());
        $item->fireEvent('plugin_docman_event_del', $user, $itemParent);
        
        // Delete Lock if any
        $lF = new Docman_LockFactory();
        if($lF->itemIsLocked($item)) {
            $lF->unlock($item);
        }

        $item->setDeleteDate(time());
        $this->delCutPreferenceForAllUsers($item->getId());
        $this->delCopyPreferenceForAllUsers($item->getId());
        $dao = $this->_getItemDao();
        $dao->updateFromRow($item->toRow());
        $dao->storeDeletedItem($item->getId());
    }

    /**
     * Delete Docman hierarchy for a given project
     *
     * @param Integer $groupId The project id
     *
     * @return Boolean success
     */
    public function deleteProjectTree($groupId) {
        $deleteStatus = true;
        $root = $this->getRoot($groupId);
        if ($root) {
            $dPm = Docman_PermissionsManager::instance($groupId);
            $subItemsWritable = $dPm->currentUserCanWriteSubItems($root->getId());
            if($subItemsWritable) {
                $rootChildren = $this->getChildrenFromParent($root);
                $user = $this->_getUserManager()->getCurrentUser();
                foreach ($rootChildren as $children) {
                    if (!$this->deleteSubTree($children, $user, true)) {
                        $deleteStatus = false;
                    }
                }
            } else {
                $deleteStatus = false;
            }
        }
        return $deleteStatus;
    }

    /**
     * Manage deletion of a entire item hierarchy.
     * 
     * It's the recommended and official way to delete a file in the docman
     *
     * @param Docman_Item $item        Item to delete
     * @param PFUser        $user        User who performs the delete
     * @param Boolean     $cascadeWiki If there are wiki documents, do we delete corresponding in wiki page too ?
     * 
     * @return Boolean success
     */
    public function deleteSubTree(Docman_Item $item, PFUser $user, $cascadeWiki) {
        if($item && !$this->isRoot($item)) {
            // Cannot delete one folder if at least on of the document inside
            // cannot be deleted
            $dPm = Docman_PermissionsManager::instance($item->getGroupId());
            $subItemsWritable = $dPm->currentUserCanWriteSubItems($item->getId());
            if($subItemsWritable) {
                $itemSubTree = $this->getItemSubTree($item, $user, false, true);
                if ($itemSubTree) {
                    $deletor = new Docman_ActionsDeleteVisitor();
                    if ($itemSubTree->accept($deletor, array('user'  => $user, 'cascadeWikiPageDeletion' => $cascadeWiki))) {
                        return true;
                    }
                }
            } else {
                throw new RuntimeException($GLOBALS['Language']->getText('plugin_docman', 'error_item_not_deleted_no_w'));
            }
        }
        return false;
    }
    
    /**
     * List pending items
     *
     * @param Integer $groupId
     * @param Integer $offset
     * @param Integer $limit
     *
     * @return Array
     */
    function listPendingItems($groupId, $offset, $limit) {
        $dao = $this->_getItemDao();
        return $dao->listPendingItems($groupId, $offset, $limit);
    }

    /**
     * Purge deleted items with delete date lower than the given time
     *
     * @param Integer $time
     *
     * @return Boolean
     */
    function purgeDeletedItems($time) {
        $dao = $this->_getItemDao();
        $dar = $dao->listItemsToPurge($time);
        if ($dar && !$dar->isError()) {
            foreach ($dar as $row) {
                $item = new Docman_Item($row);
                $this->purgeDeletedItem($item);
            }
            return true;
        }
        return false;
    }

    /**
     * Mark the deleted item as purged
     *
     * @param Docman_Item $item
     *
     * @return Boolean
     */
    public function purgeDeletedItem($item) {
        $dao = $this->_getItemDao();
        return $dao->setPurgeDate($item->getId(), time());
    }

    /**
     * Restore on item
     * 
     * @param Docman_Item $item
     * 
     * @return Boolean
     */
    public function restore($item) {
        $dao         = $this->_getItemDao();
        $type        = $this->getItemTypeForItem($item);
        $oneRestored = false;
        $isFile      = false;
        if ($type == PLUGIN_DOCMAN_ITEM_TYPE_FILE || $type == PLUGIN_DOCMAN_ITEM_TYPE_EMBEDDEDFILE) {
            $isFile      = true;
            $vf          = $this->_getVersionFactory();
            $versions    = $vf->listVersionsToPurgeForItem($item);
            if ($versions) {
                foreach ($versions as $version) {
                    $oneRestored |= $vf->restore($version);
                }
            }
        }

        if (!$isFile || $oneRestored) {
            // Log the event
            $user = $this->_getUserManager()->getCurrentUser();
            $this->_getEventManager()->processEvent('plugin_docman_event_restore', array(
                    'group_id'   => $item->getGroupId(),
                    'item'       => $item,
                    'user'       => $user)
            );
            return $dao->restore($item->getId());
        }
        return false;
    }
}

?>