class.ilCopyWizardOptions.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program 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.                      |
    |                                                                             |
    | This program 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 this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

class ilCopyWizardOptions
{
    private static $instances = null;

    const COPY_WIZARD_UNDEFINED = 0;
    const COPY_WIZARD_OMIT = 1;
    const COPY_WIZARD_COPY = 2;
    const COPY_WIZARD_LINK = 3;
    const COPY_WIZARD_LINK_TO_TARGET = 4;
    
    const OWNER_KEY = -3;
    const DISABLE_SOAP = -4;
    const ROOT_NODE = -5;
    const DISABLE_TREE_COPY = -6;
    
    private $db;
    
    private $copy_id;
    private $source_id;
    private $options = array();
    
    private function __construct($a_copy_id = 0)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->db = $ilDB;
        $this->copy_id = $a_copy_id;
        
        if ($this->copy_id) {
            $this->read();
        }
    }
    
    public static function _getInstance($a_copy_id)
    {
        if (is_array(self::$instances) and isset(self::$instances[$a_copy_id])) {
            return self::$instances[$a_copy_id];
        }
        return self::$instances[$a_copy_id] = new ilCopyWizardOptions($a_copy_id);
    }
    

    public function getRequiredSteps()
    {
        $steps = 0;
        if (is_array($this->options) && array_key_exists(0, $this->options) && is_array($this->options[0])) {
            $steps += count($this->options[0]);
        }
        if (is_array($this->options) && array_key_exists(-1, $this->options) && is_array($this->options[-1])) {
            $steps += count($this->options[-1]);
        }
        return $steps;
    }
    
    
    public static function _isFinished($a_copy_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM copy_wizard_options " .
            "WHERE copy_id  = " . $ilDB->quote($a_copy_id, 'integer') . " ";
        $res = $ilDB->query($query);
        return $res->numRows() ? false : true;
    }
    
    public static function _allocateCopyId()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT MAX(copy_id) latest FROM copy_wizard_options ";
        $res = $ilDB->query($query);
        $row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
        
        $ilDB->insert("copy_wizard_options", array(
            "copy_id" => array("integer", ((int) $row->latest) + 1),
            "source_id" => array("integer", 0)
            ));
        return ((int) $row->latest) + 1;
    }
    
    public function saveOwner($a_user_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->insert("copy_wizard_options", array(
            "copy_id" => array("integer", $this->getCopyId()),
            "source_id" => array("integer", self::OWNER_KEY),
            "options" => array('clob',serialize(array($a_user_id)))
            ));

        return true;
    }
    
    public function saveRoot($a_root)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $ilDB->insert("copy_wizard_options", array(
            "copy_id" => array("integer", $this->getCopyId()),
            "source_id" => array("integer", self::ROOT_NODE),
            "options" => array('clob',serialize(array($a_root)))
            ));

        return true;
    }
    
    public function isRootNode($a_root)
    {
        return in_array($a_root, $this->getOptions(self::ROOT_NODE));
    }

    public function getRootNode()
    {
        $options = $this->getOptions(self::ROOT_NODE);
        if (!is_array($options) || !array_key_exists(0, $options)) {
            return null;
        }
        return (int) $options[0];
    }
    
    public function disableSOAP()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->options[self::DISABLE_SOAP] = 1;
        
        $ilDB->insert("copy_wizard_options", array(
            "copy_id" => array("integer", $this->getCopyId()),
            "source_id" => array("integer", self::DISABLE_SOAP),
            "options" => array('clob',serialize(array(1)))
            ));
    }
    
    public function disableTreeCopy()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->options[self::DISABLE_TREE_COPY] = 1;
        
        $ilDB->insert("copy_wizard_options", array(
            "copy_id" => array("integer", $this->getCopyId()),
            "source_id" => array("integer", self::DISABLE_TREE_COPY),
            "options" => array('clob',serialize(array(1)))
            ));
    }

    public function isTreeCopyDisabled()
    {
        if (isset($this->options[self::DISABLE_TREE_COPY]) and $this->options[self::DISABLE_TREE_COPY]) {
            return true;
        }
        return false;
    }
    
    public function isSOAPEnabled()
    {
        if (isset($this->options[self::DISABLE_SOAP]) and $this->options[self::DISABLE_SOAP]) {
            return false;
        }
        return true;
    }
    
    

    public function checkOwner($a_user_id)
    {
        return in_array($a_user_id, $this->getOptions(self::OWNER_KEY));
    }
    
    public function getCopyId()
    {
        return $this->copy_id;
    }
    
    
    public function initContainer($a_source_id, $a_target_id)
    {
        global $DIC;

        $tree = $DIC['tree'];
        
        $mapping_source = $tree->getParentId($a_source_id);
        $this->addEntry($a_source_id, array('type' => ilCopyWizardOptions::COPY_WIZARD_COPY));
        $this->appendMapping($mapping_source, $a_target_id);
    }
    
    public function storeTree($a_source_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->tmp_tree = array();
        $this->readTree($a_source_id);
        $a_tree_structure = $this->tmp_tree;
        
        $ilDB->update("copy_wizard_options", array(
            "options" => array('clob',serialize($a_tree_structure))
            ), array(
            "copy_id" => array('integer',$this->getCopyId()),
            "source_id" => array('integer',0
        )));

        $ilDB->insert('copy_wizard_options', array(
            'copy_id' => array('integer',$this->getCopyId()),
            'source_id' => array('integer',-1),
            'options' => array('clob',serialize($a_tree_structure))
            ));

        return true;
    }
    
    private function fetchFirstNodeById($a_id)
    {
        $tree = $this->getOptions($a_id);
        if (isset($tree[0]) and is_array($tree[0])) {
            return $tree[0];
        }
        return false;
    }
    
    public function fetchFirstNode()
    {
        return $this->fetchFirstNodeById(0);
    }
    
    public function fetchFirstDependenciesNode()
    {
        return $this->fetchFirstNodeById(-1);
    }
    
    public function dropFirstNodeById($a_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!isset($this->options[$a_id]) or !is_array($this->options[$a_id])) {
            return false;
        }
        
        $this->options[$a_id] = array_slice($this->options[$a_id], 1);
        
        $ilDB->update('copy_wizard_options', array(
            'options' => array('clob',serialize($this->options[$a_id]))
            ), array(
            'copy_id' => array('integer',$this->getCopyId()),
            'source_id' => array('integer',$a_id)));
        
        $this->read();
        // check for role_folder
        if (($node = $this->fetchFirstNodeById($a_id)) === false) {
            return true;
        }
        if ($node['type'] == 'rolf') {
            $this->dropFirstNodeById($a_id);
        }
        return true;
    }
    
    public function dropFirstNode()
    {
        return $this->dropFirstNodeById(0);
    }
    
    public function dropFirstDependenciesNode()
    {
        return $this->dropFirstNodeById(-1);
    }
    
    public function getOptions($a_source_id)
    {
        if (isset($this->options[$a_source_id]) and is_array($this->options[$a_source_id])) {
            return $this->options[$a_source_id];
        }
        return array();
    }
    
    public function addEntry($a_source_id, $a_options)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (!is_array($a_options)) {
            return false;
        }
        
        $query = "DELETE FROM copy_wizard_options " .
            "WHERE copy_id = " . $this->db->quote($this->copy_id, 'integer') . " " .
            "AND source_id = " . $this->db->quote($a_source_id, 'integer');
        $res = $ilDB->manipulate($query);

        $ilDB->insert('copy_wizard_options', array(
            'copy_id' => array('integer',$this->copy_id),
            'source_id' => array('integer',$a_source_id),
            'options' => array('clob',serialize($a_options))
        ));
        return true;
    }
    
    public function appendMapping($a_source_id, $a_target_id)
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM copy_wizard_options " .
            "WHERE copy_id = " . $this->db->quote($this->copy_id, 'integer') . " " .
            "AND source_id = -2 ";
        $res = $this->db->query($query);
        $mappings = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $mappings = unserialize($row->options);
        }
        $mappings[$a_source_id] = $a_target_id;
        
        $query = "DELETE FROM copy_wizard_options " .
            "WHERE copy_id = " . $ilDB->quote($this->getCopyId(), 'integer') . " " .
            "AND source_id = -2 ";
        $res = $ilDB->manipulate($query);
        
        
        $ilDB->insert('copy_wizard_options', array(
            'copy_id' => array('integer',$this->getCopyId()),
            'source_id' => array('integer',-2),
            'options' => array('clob',serialize($mappings))
        ));
        
        return true;
    }
    
    public function getMappings()
    {
        if (isset($this->options[-2]) and is_array($this->options[-2])) {
            return $this->options[-2];
        }
        return array();
    }
    
    public function deleteAll()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        if (isset(self::$instances[$this->copy_id])) {
            unset(self::$instances[$this->copy_id]);
        }
        
        $query = "DELETE FROM copy_wizard_options " .
            "WHERE copy_id = " . $this->db->quote($this->copy_id, 'integer');
        $res = $ilDB->manipulate($query);
    }
    
    public function read()
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM copy_wizard_options " .
            "WHERE copy_id = " . $this->db->quote($this->copy_id, 'integer');
        $res = $this->db->query($query);
        
        $this->options = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->options[$row->source_id] = unserialize($row->options);
        }

        return true;
    }
    
    private function readTree($a_source_id)
    {
        global $DIC;

        $tree = $DIC['tree'];
        
        $this->tmp_tree[] = $tree->getNodeData($a_source_id);
        
        
        foreach ($tree->getChilds($a_source_id) as $sub_nodes) {
            $sub_node_ref_id = $sub_nodes['child'];
            // check ommited, linked ...
            $options = $this->options[$sub_node_ref_id];
            if ($options['type'] == self::COPY_WIZARD_COPY or
                $options['type'] == self::COPY_WIZARD_LINK) {
                $this->readTree($sub_node_ref_id);
            }
        }
    }
}