class.SurveyQuestion.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 SurveyQuestion
{
        var $id;

        var $title;
        var $description;
        var $owner;

        var $author;

        var $materials;

        var $survey_id;

        var $obj_id;

        var $questiontext;

        var $obligatory;
        
        var $ilias;

        var $tpl;

        var $lng;

        var $orientation;
        
        var $material;
        var $complete;

        protected $cumulated;

        private $arrData;

        protected $log;

        function __construct($title = "", $description = "", $author = "", $questiontext = "",  $owner = -1)
        {
                global $ilias, $lng, $tpl;

                $this->ilias = $ilias;
                $this->lng = $lng;
                $this->tpl = $tpl;
                $this->complete = 0; 
                $this->title = $title;
                $this->description = $description;
                $this->questiontext = $questiontext;
                $this->author = $author;
                $this->cumulated = array();
                if (!$this->author) 
                {
                        $this->author = $this->ilias->account->fullname;
                }
                $this->owner = $owner;
                if ($this->owner == -1) 
                {
                        $this->owner = $this->ilias->account->id;
                }
                $this->id = -1;
                $this->survey_id = -1;
                $this->obligatory = 1;
                $this->orientation = 0;
                $this->materials = array();
                $this->material = array();
                $this->arrData = array();

                $this->log = ilLoggerFactory::getLogger('svy');
        }

        function setComplete($a_complete)
        {
                $this->complete = ($a_complete) ? 1 : 0;
        }
        
        function isComplete()
        {
                return 0;
        }

        function questionTitleExists($title, $questionpool_object = "") 
        {
                global $ilDB;
                
                $refwhere = "";
                if (strcmp($questionpool_object, "") != 0)
                {
                        $refwhere = sprintf(" AND obj_fi = %s",
                                $ilDB->quote($questionpool_object, 'integer')
                        );
                }
                $result = $ilDB->queryF("SELECT question_id FROM svy_question WHERE title = %s$refwhere",
                        array('text'),
                        array($title)
                );
                return ($result->numRows() > 0) ? true : false;
        }

        function setTitle($title = "") 
        {
                $this->title = $title;
        }

        function setObligatory($obligatory = 1) 
        {
                $this->obligatory = ($obligatory) ? 1 : 0;
        }

        function setOrientation($orientation = 0) 
        {
                $this->orientation = ($orientation) ? $orientation : 0;
        }

        function setId($id = -1) 
        {
                $this->id = $id;
        }

        function setSurveyId($id = -1) 
        {
                $this->survey_id = $id;
        }

        function setDescription($description = "") 
        {
                $this->description = $description;
        }

        function addMaterials($materials_file, $materials_name="") 
        {
                if (empty($materials_name)) 
                {
                        $materials_name = $materials_file;
                }
                if ((!empty($materials_name))&&(!array_key_exists($materials_name, $this->materials))) 
                {
                        $this->materials[$materials_name] = $materials_file;
                }
        }

        function setMaterialsfile($materials_filename, $materials_tempfilename="", $materials_name="")
        {
                if (!empty($materials_filename))
                {
                        $materialspath = $this->getMaterialsPath();
                        if (!file_exists($materialspath))
                        {
                                ilUtil::makeDirParents($materialspath);
                        }
                        if (ilUtil::moveUploadedFile($materials_tempfilename, $materials_filename,
                                $materialspath.$materials_filename))
                        {
                                print "image not uploaded!!!! ";
                        }
                        else
                        {
                                $this->addMaterials($materials_filename, $materials_name);
                        }
                }
        }

        function deleteMaterial($materials_name = "") 
        {
                foreach ($this->materials as $key => $value) 
                {
                        if (strcmp($key, $materials_name)==0) 
                        {
                                if (file_exists($this->getMaterialsPath().$value)) 
                                {
                                        unlink($this->getMaterialsPath().$value);
                                }
                                unset($this->materials[$key]);
                        }
                }
        }

        function flushMaterials() 
        {
                $this->materials = array();
        }

        function setAuthor($author = "") 
        {
                if (!$author) 
                {
                        $author = $this->ilias->account->fullname;
                }
                $this->author = $author;
        }

        function setQuestiontext($questiontext = "") 
        {
                $this->questiontext = $questiontext;
        }

        function setOwner($owner = "") 
        {
                $this->owner = $owner;
        }

        function getTitle() 
        {
                return $this->title;
        }
        
        function getLabel()
        {
                return $this->label;
        }

        function getId() 
        {
                return $this->id;
        }

        public function getObligatory($survey_id = "") 
        {
                return ($this->obligatory) ? 1 : 0;
        }

        function getSurveyId() 
        {
                return $this->survey_id;
        }

        function getOrientation() 
        {
                switch ($this->orientation)
                {
                        case 0:
                        case 1:
                        case 2:
                                break;
                        default:
                                $this->orientation = 0;
                                break;
                }
        return $this->orientation;
        }


        function getDescription() 
        {
                return (strlen($this->description)) ? $this->description : NULL;
        }

        function getAuthor() 
        {
                return (strlen($this->author)) ? $this->author : NULL;
        }

        function getOwner() 
        {
                return $this->owner;
        }

        function getQuestiontext() 
        {
                return (strlen($this->questiontext)) ? $this->questiontext : NULL;
        }

        function getObjId() {
                return $this->obj_id;
        }

        function setObjId($obj_id = 0) 
        {
                $this->obj_id = $obj_id;
        }

        function duplicate($for_survey = true, $title = "", $author = "", $owner = "", $a_survey_id = 0)
        {
                if ($this->getId() <= 0)
                {
                        // The question has not been saved. It cannot be duplicated
                        return;
                }
                // duplicate the question in database
                $clone = $this;
                $original_id = $this->getId();
                $clone->setId(-1);
                if ($a_survey_id > 0)
                {
                        $clone->setObjId($a_survey_id);
                }
                if ($title)
                {
                        $clone->setTitle($title);
                }
                if ($author)
                {
                        $clone->setAuthor($author);
                }
                if ($owner)
                {
                        $clone->setOwner($owner);
                }
                if ($for_survey)
                {
                        $clone->saveToDb($original_id);
                }
                else
                {
                        $clone->saveToDb();
                }
                // duplicate the materials
                $clone->duplicateMaterials($original_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
                return $clone->getId();
        }

        function copyObject($target_questionpool, $title = "")
        {
                if ($this->getId() <= 0)
                {
                        // The question has not been saved. It cannot be copied
                        return;
                }
                $clone = $this;
                $original_id = self::_getOriginalId($this->getId(), false);
                $clone->setId(-1);
                $source_questionpool = $this->getObjId();
                $clone->setObjId($target_questionpool);
                if ($title)
                {
                        $clone->setTitle($title);
                }
                
                $clone->saveToDb();

                // duplicate the materials
                $clone->duplicateMaterials($original_id);
                // copy XHTML media objects
                $clone->copyXHTMLMediaObjectsOfQuestion($original_id);
                return $clone->getId();
        }
        
        function copyXHTMLMediaObjectsOfQuestion($a_q_id)
        {
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $a_q_id);
                foreach ($mobs as $mob)
                {
                        ilObjMediaObject::_saveUsage($mob, "spl:html", $this->getId());
                }
        }
        
        function loadFromDb($question_id)
        {
                global $ilDB;
                
                $result = $ilDB->queryF("SELECT * FROM svy_material WHERE question_fi = %s",
                        array('integer'),
                        array($this->getId())
                );
                $this->material = array();
                if ($result->numRows())
                {
                        include_once "./Modules/SurveyQuestionPool/classes/class.ilSurveyMaterial.php";
                        while ($row = $ilDB->fetchAssoc($result))
                        {
                                $mat = new ilSurveyMaterial();
                                $mat->type = $row['material_type'];
                                $mat->internal_link = $row['internal_link'];
                                $mat->title = $row['material_title'];
                                $mat->import_id = $row['import_id'];
                                $mat->text_material = $row['text_material'];
                                $mat->external_link = $row['external_link'];
                                $mat->file_material = $row['file_material'];
                                array_push($this->material, $mat);
                        }
                }
        }

        static function _isComplete($question_id)
        {
                global $ilDB;

                $result = $ilDB->queryF("SELECT complete FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows())
                {
                        $row = $ilDB->fetchAssoc($result);
                        if ($row["complete"] == 1)
                        {
                                return TRUE;
                        }
                }
                return FALSE;
        }
        
        function saveCompletionStatus($original_id = "")
        {
                global $ilDB;
                
                $question_id = $this->getId();
                if (strlen($original_id))
                {
                        $question_id = $original_id;
                }

                if ($this->getId() > 0) 
                {
                        $this->log->debug("UPDATE svy_question question_id=".$question_id);

                        // update existing dataset
                        $affectedRows = $ilDB->manipulateF("UPDATE svy_question SET complete = %s, tstamp = %s WHERE question_id = %s",
                                array('text', 'integer', 'integer'),
                                array($this->isComplete(), time(), $question_id)
                        );
                }
        }

        function saveToDb($original_id = "")
        {
                global $ilDB;
                
                // cleanup RTE images which are not inserted into the question text
                include_once("./Services/RTE/classes/class.ilRTE.php");
                ilRTE::_cleanupMediaObjectUsage($this->getQuestiontext(), "spl:html", $this->getId());
                $affectedRows = 0;
                if ($this->getId() == -1) 
                {
            // Write new dataset
                        $next_id = $ilDB->nextId('svy_question');
                        $affectedRows = $ilDB->insert("svy_question", array(
                                "question_id" => array("integer", $next_id),
                                "questiontype_fi" => array("integer", $this->getQuestionTypeID()),
                                "obj_fi" => array("integer", $this->getObjId()),
                                "owner_fi" => array("integer", $this->getOwner()),
                                "title" => array("text", $this->getTitle()),
                                "label" => array("text", (strlen($this->label)) ? $this->label : null),
                                "description" => array("text", $this->getDescription()),
                                "author" => array("text", $this->getAuthor()),
                                "questiontext" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getQuestiontext(), 0)),
                                "obligatory" => array("text", $this->getObligatory()),
                                "complete" => array("text", $this->isComplete()),
                                "created" => array("integer", time()),
                                "original_id" => array("integer", ($original_id) ? $original_id : NULL),
                                "tstamp" => array("integer", time())
                        ));

                        //$this->log->debug("INSERT: svy_question id=".$next_id." questiontype_fi=".$this->getQuestionTypeID()." obj_fi".$this->getObjId()." title=".$this->getTitle()." ...");

                        $this->setId($next_id);
                } 
                else 
                {
                        // update existing dataset
                        $affectedRows = $ilDB->update("svy_question", array(
                                "title" => array("text", $this->getTitle()),
                                "label" => array("text", (strlen($this->label)) ? $this->label : null),
                                "description" => array("text", $this->getDescription()),
                                "author" => array("text", $this->getAuthor()),
                                "questiontext" => array("clob", ilRTE::_replaceMediaObjectImageSrc($this->getQuestiontext(), 0)),
                                "obligatory" => array("text", $this->getObligatory()),
                                "complete" => array("text", $this->isComplete()),
                                "tstamp" => array("integer", time())
                        ), array(
                        "question_id" => array("integer", $this->getId())
                        ));

                        $this->log->debug("UPDATE svy_question id=".$this->getId()." SET: title=".$this->getTitle()." ...");
                }
                
                return $affectedRows;
        }
        
        public function saveMaterial()
        {
                global $ilDB;
                
                include_once "./Services/Link/classes/class.ilInternalLink.php";

                $this->log->debug("DELETE: svy_material question_fi=".$this->getId());

                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_material WHERE question_fi = %s",
                        array('integer'),
                        array($this->getId())
                );
                ilInternalLink::_deleteAllLinksOfSource("sqst", $this->getId());

                foreach ($this->material as $material)
                {
                        $next_id = $ilDB->nextId('svy_material');

                        $this->log->debug("INSERT: svy_material question_fi=".$this->getId());

                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_material " .
                                "(material_id, question_fi, internal_link, import_id, material_title, tstamp," .
                                "text_material, external_link, file_material, material_type) ".
                                "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                                array('integer','integer','text','text','text','integer','text','text','text','integer'),
                                array(
                                        $next_id, $this->getId(), $material->internal_link, $material->import_id, 
                                        $material->title, time(), $material->text_material, $material->external_link,
                                        $material->file_material, $material->type)
                        );
                        if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $material->internal_link, $matches))
                        {
                                ilInternalLink::_saveLink("sqst", $this->getId(), $matches[2], $matches[3], $matches[1]);
                        }
                }
        }
        
        public function createNewQuestion()
        {
                global $ilDB;
                                
                $obj_id = $this->getObjId();
                if ($obj_id > 0)
                {
                        $next_id = $ilDB->nextId('svy_question');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_question (question_id, questiontype_fi, " .
                                "obj_fi, owner_fi, title, description, author, questiontext, obligatory, complete, " .
                                "created, original_id, tstamp) VALUES " .
                                "(%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                                array('integer', 'integer', 'integer', 'integer', 'text', 'text', 'text', 'text', 
                                        'text', 'text', 'integer', 'integer', 'integer'),
                                array(
                                        $next_id,
                                        $this->getQuestionTypeID(),
                                        $obj_id,
                                        $this->getOwner(),
                                        NULL,
                                        NULL,
                                        $this->getAuthor(),
                                        NULL,
                                        "1",
                                        "0",
                                        time(),
                                        NULL,
                                        0
                                )
                        );
                        $this->log->debug("INSERT INTO svy_question question_id= ".$next_id." questiontype_fi= ".$this->getQuestionTypeID());

                        $this->setId($next_id);
                }
                return $this->getId();
        }

        function saveWorkingData($limit_to = LIMIT_NO_LIMIT) 
        {
        }

        function getImagePath() 
        {
                return CLIENT_WEB_DIR . "/survey/$this->obj_id/$this->id/images/";
        }

        function getMaterialsPath() 
        {
                return CLIENT_WEB_DIR . "/survey/$this->obj_id/$this->id/materials/";
        }

        function getImagePathWeb() 
        {
                $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/survey/$this->obj_id/$this->id/images/";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
        }

        function getMaterialsPathWeb() 
        {
                $webdir = ilUtil::removeTrailingPathSeparators(CLIENT_WEB_DIR) . "/survey/$this->obj_id/$this->id/materials/";
                return str_replace(ilUtil::removeTrailingPathSeparators(ILIAS_ABSOLUTE_PATH), ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH), $webdir);
        }

        function saveCategoryToDb($categorytext, $neutral = 0)
        {
                global $ilUser, $ilDB;
                
                $result = $ilDB->queryF("SELECT title, category_id FROM svy_category WHERE title = %s AND neutral = %s AND owner_fi = %s",
                        array('text','text','integer'),
                        array($categorytext, $neutral, $ilUser->getId())
                );
                $insert = FALSE;
                $returnvalue = "";
                if ($result->numRows()) 
                {
                        $insert = TRUE;
                        while ($row = $ilDB->fetchAssoc($result))
                        {
                                if (strcmp($row["title"], $categorytext) == 0)
                                {
                                        $returnvalue = $row["category_id"];
                                        $insert = FALSE;
                                }
                        }
                }
                else
                {
                        $insert = TRUE;
                }
                if ($insert)
                {
                        $next_id = $ilDB->nextId('svy_category');
                        $affectedRows = $ilDB->manipulateF("INSERT INTO svy_category (category_id, title, neutral, owner_fi, tstamp) VALUES (%s, %s, %s, %s, %s)",
                                array('integer','text','text','integer','integer'),
                                array($next_id, $categorytext, $neutral, $ilUser->getId(), time())
                        );

                        $this->log->debug("INSERT INTO svy_category id=".$next_id);

                        $returnvalue = $next_id;
                }
                return $returnvalue;
        }

        function deleteAdditionalTableData($question_id)
        {
                global $ilDB;

        $this->log->debug("DELETE FROM ".$this->getAdditionalTableName());

                $affectedRows = $ilDB->manipulateF("DELETE FROM " . $this->getAdditionalTableName() . " WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
        }

        function delete($question_id) 
        {
                global $ilDB;
                
                if ($question_id < 1) return;

                $result = $ilDB->queryF("SELECT obj_fi FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        $obj_id = $row["obj_fi"];
                }
                else
                {
                        return;
                }
                
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_answer WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );

                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_constraint WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );

                $result = $ilDB->queryF("SELECT constraint_fi FROM svy_qst_constraint WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                while ($row = $ilDB->fetchObject($result))
                {
                        $affectedRows = $ilDB->manipulateF("DELETE FROM svy_constraint WHERE constraint_id = %s",
                                array('integer'),
                                array($row->constraint_fi)
                        );
                }
        
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_qst_constraint WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_qblk_qst WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_svy_qst WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_variable WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );

                $this->deleteAdditionalTableData($question_id);
                
                $affectedRows = $ilDB->manipulateF("DELETE FROM svy_material WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );

                $this->log->debug("SET OF DELETES svy_answer, svy_constraint, svy_qst_constraint, svy_qblk_qst, svy_qst_oblig, svy_svy_qst, svy_variable, svy_question, svy_material WHERE question_fi = ".$question_id);

                include_once "./Services/Link/classes/class.ilInternalLink.php";
                ilInternalLink::_deleteAllLinksOfSource("sqst", $question_id);

                $directory = CLIENT_WEB_DIR . "/survey/" . $obj_id . "/$question_id";
                if (preg_match("/\d+/", $obj_id) and preg_match("/\d+/", $question_id) and is_dir($directory))
                {
                        ilUtil::delDir($directory);
                }

                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $question_id);
                // remaining usages are not in text anymore -> delete them
                // and media objects (note: delete method of ilObjMediaObject
                // checks whether object is used in another context; if yes,
                // the object is not deleted!)
                foreach($mobs as $mob)
                {
                        ilObjMediaObject::_removeUsage($mob, "spl:html", $question_id);
                        $mob_obj = new ilObjMediaObject($mob);
                        $mob_obj->delete();
                }
                
                include_once("./Modules/Survey/classes/class.ilSurveySkill.php");
                ilSurveySkill::handleQuestionDeletion($question_id, $obj_id);

                $this->log->debug("UPDATE svy_question");

                // #12772 - untie question copies from pool question
                $ilDB->manipulate("UPDATE svy_question".
                        " SET original_id = NULL".
                        " WHERE original_id  = ".$ilDB->quote($question_id, "integer"));                
        }

        static function _getQuestionType($question_id) 
        {
                global $ilDB;

                if ($question_id < 1) return "";

                $result = $ilDB->queryF("SELECT type_tag FROM svy_question, svy_qtype WHERE svy_question.question_id = %s AND svy_question.questiontype_fi = svy_qtype.questiontype_id",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows() == 1) 
                {
                        $data = $ilDB->fetchAssoc($result);
                        return $data["type_tag"];
                } 
                else 
                {
                        return "";
                }
        }

        static function _getTitle($question_id) 
        {
                global $ilDB;

                if ($question_id < 1) return "";

                $result = $ilDB->queryF("SELECT title FROM svy_question WHERE svy_question.question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows() == 1) 
                {
                        $data = $ilDB->fetchAssoc($result);
                        return $data["title"];
                } 
                else 
                {
                        return "";
                }
        }

        static function _getOriginalId($question_id, $a_return_question_id_if_no_original = true)
        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT * FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows() > 0)
                {
                        $row = $ilDB->fetchAssoc($result);
                        if ($row["original_id"] > 0)
                        {
                                return $row["original_id"];
                        }
                        else if((bool)$a_return_question_id_if_no_original) // #12419
                        {
                                return $row["question_id"];
                        }
                }
                else
                {
                        return "";
                }
        }
        
        function syncWithOriginal()
        {
                global $ilDB;
                
                if ($this->getOriginalId())
                {
                        $id = $this->getId();
                        $original = $this->getOriginalId();

                        $this->setId($this->getOriginalId());
                        $this->setOriginalId(NULL);
                        $this->saveToDb();

                        $this->setId($id);
                        $this->setOriginalId($original);

                        $this->log->debug("DELETE FROM svy_material WHERE question_fi = ".$this->getOriginalId());

                        include_once "./Services/Link/classes/class.ilInternalLink.php";
                        $affectedRows = $ilDB->manipulateF("DELETE FROM svy_material WHERE question_fi = %s",
                                array('integer'),
                                array($this->getOriginalId())
                        );
                        ilInternalLink::_deleteAllLinksOfSource("sqst", $this->original_id);
                        if (strlen($this->material["internal_link"]))
                        {
                                $next_id = $ilDB->nextId('svy_material');
                                $affectedRows = $ilDB->manipulateF("INSERT INTO svy_material (material_id, question_fi, internal_link, import_id, material_title, tstamp) VALUES (%s, %s, %s, %s, %s, %s)",
                                        array('integer', 'integer', 'text', 'text', 'text', 'integer'),
                                        array($next_id, $this->getOriginalId(), $this->material["internal_link"], $this->material["import_id"], $this->material["title"], time())
                                );

                                $this->log->debug("INSERT svy_material material_id=".$next_id." question_fi=".$this->getOriginalId());

                                if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $this->material["internal_link"], $matches))
                                {
                                        ilInternalLink::_saveLink("sqst", $this->getOriginalId(), $matches[2], $matches[3], $matches[1]);
                                }
                        }
                }
        }

        function getPhrase($phrase_id)
        {
                global $ilDB;
                
                $result = $ilDB->queryF("SELECT title FROM svy_phrase WHERE phrase_id = %s",
                        array('integer'),
                        array($phrase_id)
                );
                if ($row = $ilDB->fetchAssoc($result))
                {
                        return $row["title"];
                }
                return "";
        }

        function phraseExists($title)
        {
                global $ilUser, $ilDB;
                
                $result = $ilDB->queryF("SELECT phrase_id FROM svy_phrase WHERE title = %s AND owner_fi = %s",
                        array('text', 'integer'),
                        array($title, $ilUser->getId())
                );
                return ($result->numRows() == 0) ? false : true;
        }

        static function _questionExists($question_id)
        {
                global $ilDB;

                if ($question_id < 1)
                {
                        return false;
                }
                
                $result = $ilDB->queryF("SELECT question_id FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                return ($result->numRows() == 1) ? true : false;
        }

        function addInternalLink($material_id, $title = "")
        {
                if (strlen($material_id))
                {
                        if (strcmp($material_title, "") == 0)
                        {
                                if (preg_match("/il__(\w+)_(\d+)/", $material_id, $matches))
                                {
                                        $type = $matches[1];
                                        $target_id = $matches[2];
                                        $material_title = $this->lng->txt("obj_$type") . ": ";
                                        switch ($type)
                                        {
                                                case "lm":
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $target_id, true);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $material_title .= $cont_obj->getTitle();
                                                        break;
                                                case "pg":
                                                        include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                                                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                                        $lm_id = ilLMObject::_lookupContObjID($target_id);
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, FALSE);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $pg_obj = new ilLMPageObject($cont_obj, $target_id);
                                                        $material_title .= $pg_obj->getTitle();
                                                        break;
                                                case "st":
                                                        include_once("./Modules/LearningModule/classes/class.ilStructureObject.php");
                                                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                                        $lm_id = ilLMObject::_lookupContObjID($target_id);
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, FALSE);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $st_obj = new ilStructureObject($cont_obj, $target_id);
                                                        $material_title .= $st_obj->getTitle();
                                                        break;
                                                case "git":
                                                        include_once "./Modules/Glossary/classes/class.ilGlossaryTerm.php";
                                                        $material_title = $this->lng->txt("glossary_term") . ": " . ilGlossaryTerm::_lookGlossaryTerm($target_id);
                                                        break;
                                                case "mob":
                                                        break;
                                        }
                                }
                        }
                        include_once "./Modules/SurveyQuestionPool/classes/class.ilSurveyMaterial.php";
                        $mat = new ilSurveyMaterial();
                        $mat->type = 0;
                        $mat->internal_link = $material_id;
                        $mat->title = $material_title;
                        $this->addMaterial($mat);
                        $this->saveMaterial();
                }
        }
        
        public function deleteMaterials($a_array) 
        {
                foreach ($a_array as $idx)
                {
                        unset($this->material[$idx]);
                }
                $this->material = array_values($this->material);
                $this->saveMaterial();
        }

        function duplicateMaterials($question_id)
        {
                foreach ($this->materials as $filename)
                {
                        $materialspath = $this->getMaterialsPath();
                        $materialspath_original = preg_replace("/([^\d])$this->id([^\d])/", "\${1}$question_id\${2}", $materialspath);
                        if (!file_exists($materialspath)) 
                        {
                                ilUtil::makeDirParents($materialspath);
                        }
                        if (!copy($materialspath_original . $filename, $materialspath . $filename)) 
                        {
                                print "material could not be duplicated!!!! ";
                        }
                }
        }
        
        public function addMaterial($obj_material)
        {
                array_push($this->material, $obj_material);
        }
        
        function setMaterial($material_id = "", $is_import = false, $material_title = "")
        {
                if (strcmp($material_id, "") != 0)
                {
                        $import_id = "";
                        if ($is_import)
                        {
                                $import_id = $material_id;
                                $material_id = self::_resolveInternalLink($import_id);
                        }
                        if (strcmp($material_title, "") == 0)
                        {
                                if (preg_match("/il__(\w+)_(\d+)/", $material_id, $matches))
                                {
                                        $type = $matches[1];
                                        $target_id = $matches[2];
                                        $material_title = $this->lng->txt("obj_$type") . ": ";
                                        switch ($type)
                                        {
                                                case "lm":
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $target_id, true);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $material_title .= $cont_obj->getTitle();
                                                        break;
                                                case "pg":
                                                        include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                                                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                                        $lm_id = ilLMObject::_lookupContObjID($target_id);
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, FALSE);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $pg_obj = new ilLMPageObject($cont_obj, $target_id);
                                                        $material_title .= $pg_obj->getTitle();
                                                        break;
                                                case "st":
                                                        include_once("./Modules/LearningModule/classes/class.ilStructureObject.php");
                                                        include_once("./Modules/LearningModule/classes/class.ilLMObject.php");
                                                        $lm_id = ilLMObject::_lookupContObjID($target_id);
                                                        include_once("./Modules/LearningModule/classes/class.ilObjContentObjectGUI.php");
                                                        $cont_obj_gui = new ilObjContentObjectGUI("", $lm_id, FALSE);
                                                        $cont_obj = $cont_obj_gui->object;
                                                        $st_obj = new ilStructureObject($cont_obj, $target_id);
                                                        $material_title .= $st_obj->getTitle();
                                                        break;
                                                case "git":
                                                        include_once "./Modules/Glossary/classes/class.ilGlossaryTerm.php";
                                                        $material_title = $this->lng->txt("glossary_term") . ": " . ilGlossaryTerm::_lookGlossaryTerm($target_id);
                                                        break;
                                                case "mob":
                                                        break;
                                        }
                                }
                        }
                        $this->material = array(
                                "internal_link" => $material_id,
                                "import_id" => $import_id,
                                "title" => $material_title
                        );
                }
                $this->saveMaterial();
        }
        
        static function _resolveInternalLink($internal_link)
        {
                if (preg_match("/il_(\d+)_(\w+)_(\d+)/", $internal_link, $matches))
                {
                        include_once "./Services/Link/classes/class.ilInternalLink.php";
                        include_once "./Modules/LearningModule/classes/class.ilLMObject.php";
                        include_once "./Modules/Glossary/classes/class.ilGlossaryTerm.php";
                        switch ($matches[2])
                        {
                                case "lm":
                                        $resolved_link = ilLMObject::_getIdForImportId($internal_link);
                                        break;
                                case "pg":
                                        $resolved_link = ilInternalLink::_getIdForImportId("PageObject", $internal_link);
                                        break;
                                case "st":
                                        $resolved_link = ilInternalLink::_getIdForImportId("StructureObject", $internal_link);
                                        break;
                                case "git":
                                        $resolved_link = ilInternalLink::_getIdForImportId("GlossaryItem", $internal_link);
                                        break;
                                case "mob":
                                        $resolved_link = ilInternalLink::_getIdForImportId("MediaObject", $internal_link);
                                        break;
                        }
                        if (strcmp($resolved_link, "") == 0)
                        {
                                $resolved_link = $internal_link;
                        }
                }
                else
                {
                        $resolved_link = $internal_link;
                }
                return $resolved_link;
        }
        
        static function _resolveIntLinks($question_id)
        {
                global $ilDB;
                $resolvedlinks = 0;
                $result = $ilDB->queryF("SELECT * FROM svy_material WHERE question_fi = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows())
                {
                        while ($row = $ilDB->fetchAssoc($result))
                        {
                                $internal_link = $row["internal_link"];
                                include_once "./Modules/SurveyQuestionPool/classes/class.SurveyQuestion.php";
                                $resolved_link = self::_resolveInternalLink($internal_link);
                                if (strcmp($internal_link, $resolved_link) != 0)
                                {
                                        // internal link was resolved successfully
                                        $affectedRows = $ilDB->manipulateF("UPDATE svy_material SET internal_link = %s, tstamp = %s WHERE material_id = %s",
                                                array('text', 'integer', 'integer'),
                                                array($resolved_link, time(), $row["material_id"])
                                        );
                                        $resolvedlinks++;
                                }
                        }
                }
                if ($resolvedlinks)
                {
                        // there are resolved links -> reenter theses links to the database

                        // delete all internal links from the database
                        include_once "./Services/Link/classes/class.ilInternalLink.php";
                        ilInternalLink::_deleteAllLinksOfSource("sqst", $question_id);

                        $result = $ilDB->queryF("SELECT * FROM svy_material WHERE question_fi = %s",
                                array('integer'),
                                array($question_id)
                        );
                        if ($result->numRows())
                        {
                                while ($row = $ilDB->fetchAssoc($result))
                                {
                                        if (preg_match("/il_(\d*?)_(\w+)_(\d+)/", $row["internal_link"], $matches))
                                        {
                                                ilInternalLink::_saveLink("sqst", $question_id, $matches[2], $matches[3], $matches[1]);
                                        }
                                }
                        }
                }
        }
        
        static function _getInternalLinkHref($target = "", $a_parent_ref_id = null)
        {
                global $ilDB;
                $linktypes = array(
                        "lm" => "LearningModule",
                        "pg" => "PageObject",
                        "st" => "StructureObject",
                        "git" => "GlossaryItem",
                        "mob" => "MediaObject"
                );
                $href = "";
                if (preg_match("/il__(\w+)_(\d+)/", $target, $matches))
                {
                        $type = $matches[1];
                        $target_id = $matches[2];
                        switch($linktypes[$matches[1]])
                        {
                                case "LearningModule":
                                        $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) ."/goto.php?target=" . $type . "_" . $target_id;
                                        break;
                                case "PageObject":
                                case "StructureObject":
                                        $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) ."/goto.php?target=" . $type . "_" . $target_id;
                                        break;
                                case "GlossaryItem":
                                        $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) ."/goto.php?target=" . $type . "_" . $target_id;
                                        break;
                                case "MediaObject":
                                        $href = ilUtil::removeTrailingPathSeparators(ILIAS_HTTP_PATH) . "/ilias.php?baseClass=ilLMPresentationGUI&obj_type=" . $linktypes[$type] . "&cmd=media&ref_id=".$a_parent_ref_id."&mob_id=".$target_id;
                                        break;
                        }
                }
                return $href;
        }
        
        static function _isWriteable($question_id, $user_id)
        {
                global $ilDB;

                if (($question_id < 1) || ($user_id < 1))
                {
                        return false;
                }
                
                $result = $ilDB->queryF("SELECT obj_fi FROM svy_question WHERE question_id = %s",
                        array('integer'),
                        array($question_id)
                );
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        $qpl_object_id = $row["obj_fi"];
                        include_once "./Modules/SurveyQuestionPool/classes/class.ilObjSurveyQuestionPool.php";
                        return ilObjSurveyQuestionPool::_isWriteable($qpl_object_id, $user_id);
                }
                else
                {
                        return false;
                }
        }

        function getQuestionTypeID()
        {
                global $ilDB;
                $result = $ilDB->queryF("SELECT questiontype_id FROM svy_qtype WHERE type_tag = %s",
                        array('text'),
                        array($this->getQuestionType())
                );
                if ($result->numRows() == 1)
                {
                        $row = $ilDB->fetchAssoc($result);
                        return $row["questiontype_id"];
                }
                else
                {
                        return 0;
                }
        }

        function getQuestionType()
        {
                return "";
        }

        static function _includeClass($question_type, $gui = 0)
        {
                $type = $question_type;
                if ($gui == 1) $type .= "GUI";
                else if ($gui == 2) $type .= "Evaluation";
                if (file_exists("./Modules/SurveyQuestionPool/classes/class.".$type.".php"))
                {
                        include_once "./Modules/SurveyQuestionPool/classes/class.".$type.".php";
                        return true;
                }
                else
                {
                        global $ilPluginAdmin;
                        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
                        foreach ($pl_names as $pl_name)
                        {
                                $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                                if (strcmp($pl->getQuestionType(), $question_type) == 0)
                                {
                                        $pl->includeClass("class.".$type.".php");
                                        return true;
                                }
                        }
                }
                return false;
        }

        static function _getQuestionTypeName($type_tag)
        {
                if (file_exists("./Modules/SurveyQuestionPool/classes/class.".$type_tag.".php"))
                {
                        global $lng;
                        return $lng->txt($type_tag);
                }
                else
                {
                        global $ilPluginAdmin;
                        $pl_names = $ilPluginAdmin->getActivePluginsForSlot(IL_COMP_MODULE, "SurveyQuestionPool", "svyq");
                        foreach ($pl_names as $pl_name)
                        {
                                $pl = ilPlugin::getPluginObject(IL_COMP_MODULE, "SurveyQuestionPool", "svyq", $pl_name);
                                if (strcmp($pl->getQuestionType(), $type_tag) == 0)
                                {
                                        return $pl->getQuestionTypeTranslation();
                                }
                        }
                }
                return "";
        }

        
        static function _instanciateQuestion($question_id) 
        {
                $question_type = self::_getQuestionType($question_id);
                if($question_type)
                {
                        self::_includeClass($question_type);
                        $question = new $question_type();
                        $question->loadFromDb($question_id);
                        return $question;
                }
        }
        
        static function _instanciateQuestionGUI($question_id) 
        {
                $question_type = self::_getQuestionType($question_id);
                if($question_type)
                {
                        self::_includeClass($question_type, 1);
                        $guitype = $question_type . "GUI";
                        $question = new $guitype($question_id);
                        return $question;
                }
        }
        
        static function _instanciateQuestionEvaluation($question_id, array $a_finished_ids = null) 
        {
                $question = self::_instanciateQuestion($question_id);
                if($question)
                {
                        $question_type = self::_getQuestionType($question_id);                                          
                        self::_includeClass($question_type, 2);
                        $class = $question_type . "Evaluation";
                        $ev = new $class($question, $a_finished_ids);
                        return $ev;                     
                }
        }

        function isHTML($a_text)
        {
                if (preg_match("/<[^>]*?>/", $a_text))
                {
                        return TRUE;
                }
                else
                {
                        return FALSE; 
                }
        }
        
        function QTIMaterialToString($a_material)
        {
                $svy_log = ilLoggerFactory::getLogger("svy");
                $svy_log->debug("material count: ".$a_material->getMaterialCount());

                $result = "";
                for ($i = 0; $i < $a_material->getMaterialCount(); $i++)
                {
                        $material = $a_material->getMaterial($i);
                        if (strcmp($material["type"], "mattext") == 0)
                        {
                                $result .= $material["material"]->getContent();
                        }
                        if (strcmp($material["type"], "matimage") == 0)
                        {
                                $matimage = $material["material"];
                                if (preg_match("/(il_([0-9]+)_mob_([0-9]+))/", $matimage->getLabel(), $matches))
                                {
                                        // import an mediaobject which was inserted using tiny mce
                                        if (!is_array($_SESSION["import_mob_xhtml"])) $_SESSION["import_mob_xhtml"] = array();
                                        array_push($_SESSION["import_mob_xhtml"], array("mob" => $matimage->getLabel(), "uri" => $matimage->getUri()));
                                }
                        }
                }
                return $result;
        }
        
        function addMaterialTag(&$a_xml_writer, $a_material, $close_material_tag = TRUE, $add_mobs = TRUE, $a_attrs = null)
        {
                include_once "./Services/RTE/classes/class.ilRTE.php";
                include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");

                $a_xml_writer->xmlStartTag("material");
                $attrs = array(
                        "type" => "text/plain"
                );
                if ($this->isHTML($a_material))
                {
                        $attrs["type"] = "text/xhtml";
                }
                if (is_array($a_attrs))
                {
                        $attrs = array_merge($attrs, $a_attrs);
                }
                $a_xml_writer->xmlElement("mattext", $attrs, ilRTE::_replaceMediaObjectImageSrc($a_material, 0));

                if ($add_mobs)
                {
                        $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $this->getId());
                        foreach ($mobs as $mob)
                        {
                                $mob_obj = new ilObjMediaObject($mob);
                                $imgattrs = array(
                                        "label" => "il_" . IL_INST_ID . "_mob_" . $mob,
                                        "uri" => "objects/" . "il_" . IL_INST_ID . "_mob_" . $mob . "/" . $mob_obj->getTitle(),
                                        "type" => "spl:html",
                                        "id" => $this->getId()
                                );
                                $a_xml_writer->xmlElement("matimage", $imgattrs, NULL);
                        }
                }               
                if ($close_material_tag) $a_xml_writer->xmlEndTag("material");
        }

        function prepareTextareaOutput($txt_output, $prepare_for_latex_output = FALSE)
        {
                return ilUtil::prepareTextareaOutput($txt_output, $prepare_for_latex_output);
        }

        function getQuestionDataArray($id)
        {
                return array();
        }

        function &getWorkingDataFromUserInput($post_data)
        {
                // overwrite in inherited classes
                $data = array();
                return $data;
        }
        
        function importAdditionalMetadata($a_meta)
        {
                // overwrite in inherited classes
        }
        
        function importResponses($a_data)
        {
                // overwrite in inherited classes
        }

        function importAdjectives($a_data)
        {
                // overwrite in inherited classes
        }

        function importMatrix($a_data)
        {
                // overwrite in inherited classes
        }

        function usableForPrecondition()
        {
                // overwrite in inherited classes
                return FALSE;
        }

        function getAvailableRelations()
        {
                // overwrite in inherited classes
                return array();
        }

        public function getPreconditionOptions()
        {
                // overwrite in inherited classes
        }
        
        function getPreconditionValueOutput($value)
        {
                // overwrite in inherited classes
                return $value;
        }

        public function getPreconditionSelectValue($default = "", $title, $variable)
        {
                // overwrite in inherited classes
                return null;
        }

        function setOriginalId($original_id)
        {
                $this->original_id = $original_id;
        }
        
        function getOriginalId()
        {
                return $this->original_id;
        }
        
        public function getMaterial()
        {
                return $this->material;
        }
        
        public function setSubtype($a_subtype) 
        {
                // do nothing
        }

        public function getSubtype() 
        {
                // do nothing
                return null;
        }

        public function __get($value)
        {
                switch ($value)
                {
                        default:
                                if (array_key_exists($value, $this->arrData))
                                {
                                        return $this->arrData[$value];
                                }
                                else
                                {
                                        return null;
                                }
                                break;
                }
        }

        public function __set($key, $value)
        {
                switch ($key)
                {
                        default:
                                $this->arrData[$key] = $value;
                                break;
                }
        }

        public static function _changeOriginalId($a_question_id, $a_original_id, $a_object_id)
        {
                global $ilDB;

                $ilDB->manipulate("UPDATE svy_question".
                        " SET original_id = ".$ilDB->quote($a_original_id, "integer").",".
                        " obj_fi = ".$ilDB->quote($a_object_id, "integer").
                        " WHERE question_id = ".$ilDB->quote($a_question_id, "integer"));
        }
        
        public function getCopyIds($a_group_by_survey = false)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT q.question_id,s.obj_fi".
                        " FROM svy_question q".
                        " JOIN svy_svy_qst sq ON (sq.question_fi = q.question_id)".
                        " JOIN svy_svy s ON (s.survey_id = sq.survey_fi)".
                        " WHERE original_id = ".$ilDB->quote($this->getId(), "integer"));
                $res = array();
                while($row = $ilDB->fetchAssoc($set))
                {
                        if(!$a_group_by_survey)
                        {
                                $res[] = $row["question_id"];
                        }
                        else
                        {
                                $res[$row["obj_fi"]][] = $row["question_id"];
                        }
                }
                return $res;
        }
        
        public function hasCopies()
        {
                return (bool)sizeof($this->getCopyIds());                                               
        }
        
        public static function _lookupSurveyObjId($a_question_id)
        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT svy_svy.obj_fi FROM svy_svy_qst".
                        " JOIN svy_svy ON (svy_svy.survey_id = svy_svy_qst.survey_fi)".
                        " WHERE svy_svy_qst.question_fi = ".$ilDB->quote($a_question_id, "integer"));
                $row = $ilDB->fetchAssoc($set);
                if($ilDB->numRows($set))
                {
                        return $row["obj_fi"];
                }
        }

        static function lookupObjFi($a_qid)
        {
                global $ilDB;

                $set = $ilDB->query("SELECT obj_fi FROM svy_question ".
                        " WHERE question_id = ".$ilDB->quote($a_qid, "integer")
                        );
                $rec = $ilDB->fetchAssoc($set);
                return $rec["obj_fi"];
        }

        function stripSlashesAddSpaceFallback($a_str)
        {
                $str = ilUtil::stripSlashes($a_str);
                if ($str != $a_str)
                {
                        $str = ilUtil::stripSlashes(str_replace("<", "< ", $a_str));
                }
                return $str;
        }


}
?>