classes/class.ilConditionHandler.php

Go to the documentation of this file.

<?php

/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
        +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2001 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 ilConditionHandler
{
        const UNIQUE_CONDITIONS = 1;
        const SHARED_CONDITIONS = 0;
        
        var $db;
        var $lng;
        

        var $error_message;

        var $target_obj_id;
        var $target_ref_id;
        var $target_type;
        var $trigger_obj_id;
        var $trigger_ref_id;
        var $trigger_type;
        var $operator;
        var $value;
        var $validation;

        var $conditions;


        function ilConditionHandler()
        {
                global $ilDB,$lng;

                $this->db =& $ilDB;
                $this->lng =& $lng;
                $this->validation = true;
        }

        public static function _isReferenceHandlingOptional($a_type)
        {
                switch($a_type)
                {
                        case 'st':
                                return true;
                        
                        default:
                                return false;
                }
        }
        
        public static function _adjustMovedObjectConditions($a_ref_id)
        {
                global $tree;
                
                if($tree->checkForParentType($a_ref_id,'crs'))
                {
                        // Nothing to do
                        return true;
                }
                
                // Need another implementation that has better performance
                $childs = $tree->getSubTree($tree->getNodeData($a_ref_id),false);
                $conditions = self::_getDistinctTargetRefIds();
                
                foreach(array_intersect($conditions,$childs) as $target_ref)
                {
                        if(!$tree->checkForParentType($target_ref,'crs'))
                        {
                                self::_deleteTargetConditionsByRefId($target_ref);
                        }
                }
                return true;
        }
        
        public static function _getDistinctTargetRefIds()
        {
                global $ilDB;
                
                $query = "SELECT DISTINCT target_ref_id AS ref FROM conditions ";
                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $ref_ids[] = $row->ref;
                }
                return $ref_ids ? $ref_ids : array();
        }
        
        public static function _deleteTargetConditionsByRefId($a_target_ref_id)
        {
                global $ilDB;
                
                $query = "DELETE FROM conditions ".
                        "WHERE target_ref_id = ".$ilDB->quote($a_target_ref_id)." ".
                        "AND target_type != 'st' ";
                $ilDB->query($query);
                return true;
        }

        public function setReferenceHandlingType($a_type)
        {
                return $this->condition_reference_type = $a_type;               
        }
        
        public function getReferenceHandlingType()
        {
                return $this->condition_reference_type;
        }

        // SET GET
        function setErrorMessage($a_msg)
        {
                $this->error_message = $a_msg;
        }
        function getErrorMessage()
        {
                return $this->error_message;
        }

        function setTargetRefId($a_target_ref_id)
        {
                return $this->target_ref_id = $a_target_ref_id;
        }
        
        function getTargetRefId()
        {
                return $this->target_ref_id;
        }
        
        function setTargetObjId($a_target_obj_id)
        {
                return $this->target_obj_id = $a_target_obj_id;
        }
        
        function getTargetObjId()
        {
                return $this->target_obj_id;
        }

        function setTargetType($a_target_type)
        {
                return $this->target_type = $a_target_type;
        }
        
        function getTargetType()
        {
                return $this->target_type;
        }
        
        function setTriggerRefId($a_trigger_ref_id)
        {
                return $this->trigger_ref_id = $a_trigger_ref_id;
        }
        
        function getTriggerRefId()
        {
                return $this->trigger_ref_id;
        }

        function setTriggerObjId($a_trigger_obj_id)
        {
                return $this->trigger_obj_id = $a_trigger_obj_id;
        }
        
        function getTriggerObjId()
        {
                return $this->trigger_obj_id;
        }

        function setTriggerType($a_trigger_type)
        {
                return $this->trigger_type = $a_trigger_type;
        }
        
        function getTriggerType()
        {
                return $this->trigger_type;
        }
        
        function setOperator($a_operator)
        {
                return $this->operator = $a_operator;
        }
        
        function getOperator()
        {
                return $this->operator;
        }
        
        function setValue($a_value)
        {
                return $this->value = $a_value;
        }
        
        function getValue()
        {
                return $this->value;
        }
        
        function enableAutomaticValidation($a_validate = true)
        {
                $this->validation = $a_validate;
        }

        function getTriggerTypes()
        {
                return array('crs','exc','tst','sahs', 'svy');
        }


        function getOperatorsByTargetType($a_type)
        {
                switch($a_type)
                {
                        case 'crs':
                        case 'exc':
                                return array('passed');

                        case 'tst':
                                return array('passed','finished','not_finished');

                        case 'crsg':
                                return array('not_member');

                        case 'sahs':
                                return array('finished');

                        case 'svy':
                                return array('finished');

                        default:
                                return array();
                }
        }

        function storeCondition()
        {
                global $ilDB;
                
                // first insert, then validate: it's easier to check for circles if the new condition is in the db table
                $query = 'INSERT INTO conditions '.
                        "VALUES('0',".$ilDB->quote($this->getTargetRefId()).",".
                        $ilDB->quote($this->getTargetObjId()).",".$ilDB->quote($this->getTargetType()).",".
                        $ilDB->quote($this->getTriggerRefId()).",".$ilDB->quote($this->getTriggerObjId()).",".
                        $ilDB->quote($this->getTriggerType()).",".
                        $ilDB->quote($this->getOperator()).",".$ilDB->quote($this->getValue()).", ".
                        $ilDB->quote($this->getReferenceHandlingType()).')';

                $res = $this->db->query($query);

                $query = "SELECT LAST_INSERT_ID() AS last FROM conditions";
                $res = $this->db->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $last_id = $row->last;
                }
                
                if ($this->validation && !$this->validate())
                {
                        $this->deleteCondition($last_id);
                        return false;
                }
                return true;
        }

        function checkExists()
        {
                global $ilDB;
                
                $query = "SELECT * FROM conditions ".
                        "WHERE target_ref_id = ".$ilDB->quote($this->getTargetRefId())." ".
                        "AND target_obj_id = ".$ilDB->quote($this->getTargetObjId())." ".
                        "AND trigger_ref_id = ".$ilDB->quote($this->getTriggerRefId())." ".
                        "AND trigger_obj_id = ".$ilDB->quote($this->getTriggerObjId())." ".
                        "AND operator = ".$ilDB->quote($this->getOperator());

                $res = $this->db->query($query);

                return $res->numRows() ? true : false;
        }
        function updateCondition($a_id)
        {
                global $ilDB;
                
                $query = "UPDATE conditions SET ".
                        "target_ref_id = ".$ilDB->quote($this->getTargetRefId()).", ".
                        "operator = ".$ilDB->quote($this->getOperator()).", ".
                        "value = ".$ilDB->quote($this->getValue()).", ".
                        "ref_handling = ".$this->db->quote($this->getReferenceHandlingType())." ".
                        "WHERE id = ".$ilDB->quote($a_id);

                $res = $this->db->query($query);

                return true;
        }


        function delete($a_ref_id)
        {
                global $ilDB;
                
                $query = "DELETE FROM conditions WHERE ".
                        "target_ref_id = ".$ilDB->quote($a_ref_id)." ".
                        "OR trigger_ref_id = ".$ilDB->quote($a_ref_id);

                $res = $this->db->query($query);

                return true;
        }
        function deleteByObjId($a_obj_id)
        {
                global $ilDB;
                
                $query = "DELETE FROM conditions WHERE ".
                        "target_obj_id = ".$ilDB->quote($a_obj_id)." ".
                        "OR trigger_obj_id = ".$ilDB->quote($a_obj_id);

                $res = $this->db->query($query);

                return true;
        }

        function deleteCondition($a_id)
        {
                global $ilDB;

                $query = "DELETE FROM conditions ".
                        "WHERE id = ".$ilDB->quote($a_id);

                $res = $ilDB->query($query);

                return true;
        }
        
        function _getConditionsOfTrigger($a_trigger_obj_type, $a_trigger_id)
        {
                global $ilDB;

                $query = "SELECT * FROM conditions ".
                        "WHERE trigger_obj_id = ".$ilDB->quote($a_trigger_id)." ".
                        " AND trigger_type = ".$ilDB->quote($a_trigger_obj_type)." ";

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $tmp_array['id']                        = $row->id;
                        $tmp_array['target_ref_id'] = $row->target_ref_id;
                        $tmp_array['target_obj_id'] = $row->target_obj_id;
                        $tmp_array['target_type']       = $row->target_type;
                        $tmp_array['trigger_ref_id'] = $row->trigger_ref_id;
                        $tmp_array['trigger_obj_id'] = $row->trigger_obj_id;
                        $tmp_array['trigger_type']      = $row->trigger_type;
                        $tmp_array['operator']          = $row->operator;
                        $tmp_array['value']                     = $row->value;
                        $tmp_array['ref_handling']  = $row->ref_handling;

                        $conditions[] = $tmp_array;
                        unset($tmp_array);
                }

                return $conditions ? $conditions : array();
        }

        function _getConditionsOfTarget($a_target_ref_id,$a_target_obj_id, $a_target_type = "")
        {
                global $ilDB, $ilBench;

                $ilBench->start("ilConditionHandler", "getConditionsOfTarget");

                if ($a_target_type == "")
                {
                        $a_target_type = ilObject::_lookupType($a_target_obj_id);
                }

                $query = "SELECT * FROM conditions ".
                        "WHERE target_obj_id = ".$ilDB->quote($a_target_obj_id)." ".
                        " AND target_type = ".$ilDB->quote($a_target_type);

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        if($row->ref_handling == self::UNIQUE_CONDITIONS)
                        {
                                if($row->target_ref_id != $a_target_ref_id)
                                {
                                        continue;
                                }
                        }
                        
                        $tmp_array['id']                        = $row->id;
                        $tmp_array['target_ref_id'] = $row->target_ref_id;
                        $tmp_array['target_obj_id'] = $row->target_obj_id;
                        $tmp_array['target_type']       = $row->target_type;
                        $tmp_array['trigger_ref_id'] = $row->trigger_ref_id;
                        $tmp_array['trigger_obj_id'] = $row->trigger_obj_id;
                        $tmp_array['trigger_type']      = $row->trigger_type;
                        $tmp_array['operator']          = $row->operator;
                        $tmp_array['value']                     = $row->value;
                        $tmp_array['ref_handling']  = $row->ref_handling;

                        $conditions[] = $tmp_array;
                        unset($tmp_array);
                }

                $ilBench->stop("ilConditionHandler", "getConditionsOfTarget");

                return $conditions ? $conditions : array();
        }

        function _getCondition($a_id)
        {
                global $ilDB;

                $query = "SELECT * FROM conditions ".
                        "WHERE id = ".$ilDB->quote($a_id);

                $res = $ilDB->query($query);
                while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                {
                        $tmp_array['id']                        = $row->id;
                        $tmp_array['target_ref_id'] = $row->target_ref_id;
                        $tmp_array['target_obj_id'] = $row->target_obj_id;
                        $tmp_array['target_type']       = $row->target_type;
                        $tmp_array['trigger_ref_id'] = $row->trigger_ref_id;
                        $tmp_array['trigger_obj_id'] = $row->trigger_obj_id;
                        $tmp_array['trigger_type']      = $row->trigger_type;
                        $tmp_array['operator']          = $row->operator;
                        $tmp_array['value']                     = $row->value;
                        $tmp_array['ref_handling']  = $row->ref_handling;

                        return $tmp_array;
                }
                return false;
        }



        function _checkCondition($a_id)
        {
                $condition = ilConditionHandler::_getCondition($a_id);

                switch($condition['trigger_type'])
                {
                        case "tst":
                                include_once './Modules/Test/classes/class.ilObjTestAccess.php';
                                return ilObjTestAccess::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value']);

                        case "crs":
                                include_once './Modules/Course/classes/class.ilObjCourse.php';
                                return ilObjCourse::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value']);

                        case 'exc':
                                include_once './Modules/Exercise/classes/class.ilObjExercise.php';
                                return ilObjExercise::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value']);

                        case 'crsg':
                                include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
                                return ilObjCourseGrouping::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value']);

                        case 'sahs':
                                global $ilUser;

                                include_once './Services/Tracking/classes/class.ilLPStatusWrapper.php';
                                return in_array($ilUser->getId(),$completed = ilLPStatusWrapper::_getCompleted($condition['trigger_obj_id']));

                        case 'svy':
                                include_once './Modules/Survey/classes/class.ilObjSurvey.php';
                                return ilObjSurvey::_checkCondition($condition['trigger_obj_id'],$condition['operator'],$condition['value']);

                        default:
                                return false;

                }

        }

        function _checkAllConditionsOfTarget($a_target_ref_id,$a_target_id, $a_target_type = "")
        {
                global $ilBench;

                foreach(ilConditionHandler::_getConditionsOfTarget($a_target_ref_id,$a_target_id, $a_target_type) as $condition)
                {
                        $ilBench->start("ilConditionHandler", "checkCondition");
                        $check = ilConditionHandler::_checkCondition($condition['id']);
                        $ilBench->stop("ilConditionHandler", "checkCondition");

                        if(!$check)
                        {
                                return false;
                        }
                }
                return true;
        }

        // PRIVATE
        function validate()
        {
                global $ilDB;
                
                // check if obj_id is already assigned
                $trigger_obj =& ilObjectFactory::getInstanceByRefId($this->getTriggerRefId());
                $target_obj =& ilObjectFactory::getInstanceByRefId($this->getTargetRefId());


                $query = "SELECT * FROM conditions WHERE ".
                        "trigger_ref_id = ".$ilDB->quote($trigger_obj->getId())." ".
                        "AND target_ref_id = ".$ilDB->quote($target_obj->getId());

                $res = $this->db->query($query);
                if($res->numRows() > 1)
                {
                        $this->setErrorMessage($this->lng->txt('condition_already_assigned'));

                        unset($trigger_obj);
                        unset($target_obj);
                        return false;
                }

                // check for circle
                $this->target_obj_id = $target_obj->getId();
                if($this->checkCircle($this->getTargetRefId(),$target_obj->getId()))
                {
                        $this->setErrorMessage($this->lng->txt('condition_circle_created'));
                        
                        unset($trigger_obj);
                        unset($target_obj);
                        return false;
                }                       
                return true;
        }

        function checkCircle($a_ref_id,$a_obj_id)
        {
                foreach(ilConditionHandler::_getConditionsOfTarget($a_ref_id,$a_obj_id) as $condition)
                {
                        if($condition['trigger_obj_id'] == $this->target_obj_id and $condition['operator'] == $this->getOperator())
                        {
                                $this->circle = true;
                                break;
                        }
                        else
                        {
                                $this->checkCircle($condition['trigger_ref_id'],$condition['trigger_obj_id']);
                        }
                }
                return $this->circle;
        }
}

?>