class.assFileUploadGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */

require_once './Modules/TestQuestionPool/classes/class.assQuestionGUI.php';
require_once './Modules/Test/classes/inc.AssessmentConstants.php';
require_once './Modules/TestQuestionPool/interfaces/interface.ilGuiQuestionScoringAdjustable.php';

class assFileUploadGUI extends assQuestionGUI implements ilGuiQuestionScoringAdjustable
{
        const REUSE_FILES_TBL_POSTVAR = 'reusefiles';
        const DELETE_FILES_TBL_POSTVAR = 'deletefiles';
        
        public function __construct($id = -1)
        {
                parent::__construct();
                include_once "./Modules/TestQuestionPool/classes/class.assFileUpload.php";
                $this->object = new assFileUpload();
                $this->setErrorMessage($this->lng->txt("msg_form_save_error"));
                if ($id >= 0)
                {
                        $this->object->loadFromDb($id);
                }
        }

        protected function writePostData($always = false)
        {
                $hasErrors = (!$always) ? $this->editQuestion(true) : false;
                if (!$hasErrors)
                {
                        require_once 'Services/Form/classes/class.ilPropertyFormGUI.php';
                        $this->writeQuestionGenericPostData();
                        $this->writeQuestionSpecificPostData(new ilPropertyFormGUI());
                        $this->saveTaxonomyAssignments();
                        return 0;
                }
                return 1;
        }

        public function writeQuestionSpecificPostData(ilPropertyFormGUI $form)
        {
                $this->object->setPoints( $_POST["points"] );
                $this->object->setMaxSize( $_POST["maxsize"] );
                $this->object->setAllowedExtensions( $_POST["allowedextensions"] );
                $this->object->setCompletionBySubmission( $_POST['completion_by_submission'] == 1 ? true : false );
        }

        public function editQuestion($checkonly = FALSE)
        {
                $save = $this->isSaveCommand();
                $this->getQuestionTemplate();

                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
                $this->editForm = $form;

                $form->setFormAction($this->ctrl->getFormAction($this));
                $form->setTitle($this->outQuestionType());
                $form->setMultipart(false);
                $form->setTableWidth("100%");
                $form->setId("assfileupload");

                $this->addBasicQuestionFormProperties($form);
                $this->populateQuestionSpecificFormPart( $form );

                $this->populateTaxonomyFormSection($form);
                $this->addQuestionFormCommandButtons($form);
                
                $errors = false;
        
                if ($save)
                {
                        $form->setValuesByPost();
                        $errors = !$form->checkInput();
                        $form->setValuesByPost(); // again, because checkInput now performs the whole stripSlashes handling and 
                                                                          // we need this if we don't want to have duplication of backslashes
                        if ($errors) $checkonly = false;
                }

                if (!$checkonly) $this->tpl->setVariable("QUESTION_DATA", $form->getHTML());
                return $errors;
        }

        public function populateQuestionSpecificFormPart(ilPropertyFormGUI $form)
        {
                // maxsize
                $maxsize = new ilNumberInputGUI($this->lng->txt( "maxsize" ), "maxsize");
                $maxsize->setValue( $this->object->getMaxSize() );
                $maxsize->setInfo( $this->lng->txt( "maxsize_info" ) );
                $maxsize->setSize( 10 );
                $maxsize->setMinValue( 0 );
                $maxsize->setMaxValue( $this->determineMaxFilesize() );
                $maxsize->setRequired( FALSE );
                $form->addItem( $maxsize );

                // allowedextensions
                $allowedextensions = new ilTextInputGUI($this->lng->txt( "allowedextensions" ), "allowedextensions");
                $allowedextensions->setInfo( $this->lng->txt( "allowedextensions_info" ) );
                $allowedextensions->setValue( $this->object->getAllowedExtensions() );
                $allowedextensions->setRequired( FALSE );
                $form->addItem( $allowedextensions );

                // points
                $points = new ilNumberInputGUI($this->lng->txt( "points" ), "points");
                $points->allowDecimals(true);
                $points->setValue( is_numeric( $this->object->getPoints() ) && $this->object->getPoints(
                                                   ) >= 0 ? $this->object->getPoints() : ''
                );
                $points->setRequired( TRUE );
                $points->setSize( 3 );
                $points->setMinValue( 0.0 );
                $points->setMinvalueShouldBeGreater( false );
                $form->addItem( $points );

                $subcompl = new ilCheckboxInputGUI($this->lng->txt( 'ass_completion_by_submission'
                                                                                   ), 'completion_by_submission');
                $subcompl->setInfo( $this->lng->txt( 'ass_completion_by_submission_info' ) );
                $subcompl->setValue( 1 );
                $subcompl->setChecked( $this->object->isCompletionBySubmissionEnabled() );
                $form->addItem( $subcompl );
                return $form;
        }

        public function determineMaxFilesize()
        {
                //mbecker: Quick fix for mantis bug 8595: Change size file
                $upload_max_filesize = get_cfg_var( "upload_max_filesize" );
                // get the value for the maximal post data from the php.ini (if available)
                $post_max_size = get_cfg_var( "post_max_size" );

                //convert from short-string representation to "real" bytes
                $multiplier_a = array( "K" => 1024, "M" => 1024 * 1024, "G" => 1024 * 1024 * 1024 );
                $umf_parts    = preg_split( "/(\d+)([K|G|M])/",
                                                                        $upload_max_filesize,
                                                                        -1,
                                                                        PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
                );
                $pms_parts    = preg_split( "/(\d+)([K|G|M])/",
                                                                        $post_max_size,
                                                                        -1,
                                                                        PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY
                );

                if (count( $umf_parts ) == 2)
                {
                        $upload_max_filesize = $umf_parts[0] * $multiplier_a[$umf_parts[1]];
                }

                if (count( $pms_parts ) == 2)
                {
                        $post_max_size = $pms_parts[0] * $multiplier_a[$pms_parts[1]];
                }

                // use the smaller one as limit
                $max_filesize = min( $upload_max_filesize, $post_max_size );

                if (!$max_filesize)
                {
                        $max_filesize = max( $upload_max_filesize, $post_max_size );
                        return $max_filesize;
                }
                return $max_filesize;
        }

        function getSolutionOutput(
                $active_id,
                $pass = NULL,
                $graphicalOutput = FALSE,
                $result_output = FALSE,
                $show_question_only = TRUE,
                $show_feedback = FALSE,
                $show_correct_solution = FALSE,
                $show_manual_scoring = FALSE,
                $show_question_text = TRUE
        )
        {
                // get the solution of the user for the active pass or from the last pass if allowed
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output_solution.html", TRUE, TRUE, "Modules/TestQuestionPool");

                $solutionvalue = "";
                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);
                        include_once "./Modules/Test/classes/class.ilObjTest.php";
                        if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        {
                                if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        }
                        $solutions =& $this->object->getSolutionValues($active_id, $pass);

                        $files = ($show_manual_scoring) ? $this->object->getUploadedFilesForWeb($active_id, $pass) : $this->object->getUploadedFiles($active_id, $pass);
                        include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
                        $table_gui = new assFileUploadFileTableGUI($this->getTargetGuiClass(), 'gotoquestion');
                        $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
                        $table_gui->setData($files);
                        // hey: prevPassSolutions - table refactored
                        #$table_gui->initCommand(
                        #$this->buildFileTableDeleteButtonInstance(), assFileUploadGUI::DELETE_FILES_TBL_POSTVAR
                        #);
                        // hey.
                        $table_gui->setRowTemplate("tpl.il_as_qpl_fileupload_file_view_row.html", "Modules/TestQuestionPool");
                        $table_gui->setSelectAllCheckbox("");
                        // hey: prevPassSolutions - table refactored
                        #$table_gui->clearCommandButtons();
                        #$table_gui->disable('select_all');
                        // hey.
                        $table_gui->disable('numinfo');
                        $template->setCurrentBlock("files");
                        $template->setVariable('FILES', $table_gui->getHTML());
                        $template->parseCurrentBlock();
                }

                if (strlen($this->object->getAllowedExtensions()))
                {
                        $template->setCurrentBlock("allowed_extensions");
                        $template->setVariable("TXT_ALLOWED_EXTENSIONS", $this->object->prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("CMD_UPLOAD", $this->getQuestionActionCmd());
                $template->setVariable("TEXT_UPLOAD", $this->object->prepareTextareaOutput($this->lng->txt('upload')));
                $template->setVariable("TXT_UPLOAD_FILE", $this->object->prepareTextareaOutput($this->lng->txt('file_add')));
                $template->setVariable("TXT_MAX_SIZE", $this->object->prepareTextareaOutput($this->lng->txt('file_notice') . " " . $this->object->getMaxFilesizeAsString()));

                if (($active_id > 0) && (!$show_correct_solution))
                {
                        $reached_points = $this->object->getReachedPoints($active_id, $pass);
                        if ($graphicalOutput)
                        {
                                // output of ok/not ok icons for user entered solutions
                                if ($reached_points == $this->object->getMaximumPoints())
                                {
                                        $template->setCurrentBlock("icon_ok");
                                        $template->setVariable("ICON_OK", ilUtil::getImagePath("icon_ok.svg"));
                                        $template->setVariable("TEXT_OK", $this->lng->txt("answer_is_right"));
                                        $template->parseCurrentBlock();
                                }
                                else
                                {
                                        $template->setCurrentBlock("icon_ok");
                                        if ($reached_points > 0)
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_mostly_ok.svg"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_not_correct_but_positive"));
                                        }
                                        else
                                        {
                                                $template->setVariable("ICON_NOT_OK", ilUtil::getImagePath("icon_not_ok.svg"));
                                                $template->setVariable("TEXT_NOT_OK", $this->lng->txt("answer_is_wrong"));
                                        }
                                        $template->parseCurrentBlock();
                                }
                        }
                }
                else
                {
                        $reached_points = $this->object->getPoints();
                }

                if ($result_output)
                {
                        $resulttext = ($reached_points == 1) ? "(%s " . $this->lng->txt("point") . ")" : "(%s " . $this->lng->txt("points") . ")"; 
                        $template->setVariable("RESULT_OUTPUT", sprintf($resulttext, $reached_points));
                }
                if ($show_question_text==true)
                {
                        $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->getQuestion(), TRUE));
                }
                $questionoutput = $template->get();
                $solutiontemplate = new ilTemplate("tpl.il_as_tst_solution_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
                $feedback = ($show_feedback && !$this->isTestPresentationContext()) ? $this->getAnswerFeedbackOutput($active_id, $pass) : "";
                if (strlen($feedback))
                {
                        $cssClass = ( $this->hasCorrectSolution($active_id, $pass) ?
                                ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_CORRECT : ilAssQuestionFeedback::CSS_CLASS_FEEDBACK_WRONG
                        );
                        
                        $solutiontemplate->setVariable("ILC_FB_CSS_CLASS", $cssClass);
                        $solutiontemplate->setVariable("FEEDBACK", $this->object->prepareTextareaOutput( $feedback, true ));
                }
                $solutiontemplate->setVariable("SOLUTION_OUTPUT", $questionoutput);
                $solutionoutput = $solutiontemplate->get(); 
                if (!$show_question_only)
                {
                        // get page object output
                        $solutionoutput = $this->getILIASPage($solutionoutput);
                }
                return $solutionoutput;
        }
        
        function getPreview($show_question_only = FALSE, $showInlineFeedback = false)
        {
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html",TRUE, TRUE, "Modules/TestQuestionPool");

                if( is_object($this->getPreviewSession()) )
                {
                        $files = $this->object->getPreviewFileUploads($this->getPreviewSession());
                        include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
                        $table_gui = new assFileUploadFileTableGUI(null , $this->getQuestionActionCmd(), 'ilAssQuestionPreview');
                        $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
                        $table_gui->setData($files);
                        // hey: prevPassSolutions - support file reuse with table
                        $table_gui->initCommand(
                                $this->buildFileTableDeleteButtonInstance(),
                                assFileUpload::DELETE_FILES_TBL_POSTVAR
                        );
                        // hey.
                        $template->setCurrentBlock("files");
                        $template->setVariable('FILES', $table_gui->getHTML());
                        $template->parseCurrentBlock();
                }
                
                if (strlen($this->object->getAllowedExtensions()))
                {
                        $template->setCurrentBlock("allowed_extensions");
                        $template->setVariable("TXT_ALLOWED_EXTENSIONS", $this->object->prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->question, TRUE));
                $template->setVariable("CMD_UPLOAD", $this->getQuestionActionCmd());
                $template->setVariable("TEXT_UPLOAD", $this->object->prepareTextareaOutput($this->lng->txt('upload')));
                $template->setVariable("TXT_UPLOAD_FILE", $this->object->prepareTextareaOutput($this->lng->txt('file_add')));
                $template->setVariable("TXT_MAX_SIZE", $this->object->prepareTextareaOutput($this->lng->txt('file_notice') . " " . $this->object->getMaxFilesizeAsString()));

                $questionoutput = $template->get();
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                return $questionoutput;
        }

        // hey: prevPassSolutions - pass will be always available from now on
        function getTestOutput($active_id, $pass, $is_postponed = FALSE, $use_post_solutions = FALSE, $show_feedback = FALSE)
        // hey.
        {
                // generate the question output
                $template = new ilTemplate("tpl.il_as_qpl_fileupload_output.html",TRUE, TRUE, "Modules/TestQuestionPool");
                
                if ($active_id)
                {
                        // hey: prevPassSolutions - obsolete due to central check
                        #$solutions = NULL;
                        #include_once "./Modules/Test/classes/class.ilObjTest.php";
                        #if (!ilObjTest::_getUsePreviousAnswers($active_id, true))
                        #{
                        #       if (is_null($pass)) $pass = ilObjTest::_getPass($active_id);
                        #}
                        $files = $this->object->getTestOutputSolutions($active_id, $pass);
                        // hey.
                        include_once "./Modules/TestQuestionPool/classes/tables/class.assFileUploadFileTableGUI.php";
                        $table_gui = new assFileUploadFileTableGUI(null , $this->getQuestionActionCmd());
                        $table_gui->setTitle($this->lng->txt('already_delivered_files'), 'icon_file.svg', $this->lng->txt('already_delivered_files'));
                        $table_gui->setData($files);
                        // hey: prevPassSolutions - support file reuse with table
                        $table_gui->initCommand(
                                $this->buildTestPresentationFileTableCommandButtonInstance(),
                                $this->getTestPresentationFileTablePostVar()
                        );
                        // hey.
                        $template->setCurrentBlock("files");
                        $template->setVariable('FILES', $table_gui->getHTML());
                        $template->parseCurrentBlock();
                }
                
                if (strlen($this->object->getAllowedExtensions()))
                {
                        $template->setCurrentBlock("allowed_extensions");
                        $template->setVariable("TXT_ALLOWED_EXTENSIONS", $this->object->prepareTextareaOutput($this->lng->txt("allowedextensions") . ": " . $this->object->getAllowedExtensions()));
                        $template->parseCurrentBlock();
                }
                $template->setVariable("QUESTIONTEXT", $this->object->prepareTextareaOutput($this->object->question, TRUE));
                $template->setVariable("CMD_UPLOAD", $this->getQuestionActionCmd());
                $template->setVariable("TEXT_UPLOAD", $this->object->prepareTextareaOutput($this->lng->txt('upload')));
                $template->setVariable("TXT_UPLOAD_FILE", $this->object->prepareTextareaOutput($this->lng->txt('file_add')));
                $template->setVariable("TXT_MAX_SIZE", $this->object->prepareTextareaOutput($this->lng->txt('file_notice') . " " . $this->object->getMaxFilesizeAsString()));

                $questionoutput = $template->get();
                if (!$show_question_only)
                {
                        // get page object output
                        $questionoutput = $this->getILIASPage($questionoutput);
                }
                $questionoutput = $template->get();
                $pageoutput = $this->outQuestionPage("", $is_postponed, $active_id, $questionoutput);
                return $pageoutput;
        }

        function setQuestionTabs()
        {
                global $rbacsystem, $ilTabs;

                $ilTabs->clearTargets();
                
                $this->ctrl->setParameterByClass("ilAssQuestionPageGUI", "q_id", $_GET["q_id"]);
                include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
                $q_type = $this->object->getQuestionType();

                if (strlen($q_type))
                {
                        $classname = $q_type . "GUI";
                        $this->ctrl->setParameterByClass(strtolower($classname), "sel_question_types", $q_type);
                        $this->ctrl->setParameterByClass(strtolower($classname), "q_id", $_GET["q_id"]);
                }

                if ($_GET["q_id"])
                {
                        if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
                        {
                                // edit page
                                $ilTabs->addTarget("edit_page",
                                        $this->ctrl->getLinkTargetByClass("ilAssQuestionPageGUI", "edit"),
                                        array("edit", "insert", "exec_pg"),
                                        "", "", $force_active);
                        }

                        $this->addTab_QuestionPreview($ilTabs);
                }

                $force_active = false;
                if ($rbacsystem->checkAccess('write', $_GET["ref_id"]))
                {
                        $url = "";
                        if ($classname) $url = $this->ctrl->getLinkTargetByClass($classname, "editQuestion");
                        // edit question properties
                        $ilTabs->addTarget("edit_question",
                                $url,
                                array("editQuestion", "save", "cancel", "saveEdit"),
                                $classname, "");
                }

                // add tab for question feedback within common class assQuestionGUI
                $this->addTab_QuestionFeedback($ilTabs);

                // add tab for question hint within common class assQuestionGUI
                $this->addTab_QuestionHints($ilTabs);

                // add tab for question's suggested solution within common class assQuestionGUI
                $this->addTab_SuggestedSolution($ilTabs, $classname);

                // Assessment of questions sub menu entry
                if ($_GET["q_id"])
                {
                        $ilTabs->addTarget("statistics",
                                $this->ctrl->getLinkTargetByClass($classname, "assessment"),
                                array("assessment"),
                                $classname, "");
                }
                
                if (($_GET["calling_test"] > 0) || ($_GET["test_ref_id"] > 0))
                {
                        $ref_id = $_GET["calling_test"];
                        if (strlen($ref_id) == 0) $ref_id = $_GET["test_ref_id"];

                        global $___test_express_mode;

                        if (!$_GET['test_express_mode'] && !$___test_express_mode) {
                            $ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), "ilias.php?baseClass=ilObjTestGUI&cmd=questions&ref_id=$ref_id");
                        }
                        else {
                            $link = ilTestExpressPage::getReturnToPageLink();
                            $ilTabs->setBackTarget($this->lng->txt("backtocallingtest"), $link);
                        }
                }
                else
                {
                        $ilTabs->setBackTarget($this->lng->txt("qpl"), $this->ctrl->getLinkTargetByClass("ilobjquestionpoolgui", "questions"));
                }
        }

        function getSpecificFeedbackOutput($active_id, $pass)
        {
                $output = "";
                return $this->object->prepareTextareaOutput($output, TRUE);
        }

        public function getAfterParticipationSuppressionQuestionPostVars()
        {
                return array();
        }

        public function getAggregatedAnswersView($relevant_answers)
        {
                // Empty implementation here since a feasible way to aggregate answer is not known.
                return ''; //print_r($relevant_answers,true);
        }
        
        // hey: prevPassSolutions - shown files needs to be chosen so upload can replace or complete fileset
        protected function buildFileTableDeleteButtonInstance()
        {
                require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssFileUploadFileTableDeleteButton.php';
                return ilAssFileUploadFileTableDeleteButton::getInstance();
        }
        
        protected function buildFileTableReuseButtonInstance()
        {
                require_once 'Modules/TestQuestionPool/classes/questions/class.ilAssFileUploadFileTableReuseButton.php';
                return ilAssFileUploadFileTableReuseButton::getInstance();
        }
        
        protected function buildTestPresentationFileTableCommandButtonInstance()
        {
                if( $this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled() )
                {
                        return $this->buildFileTableReuseButtonInstance();
                }
                
                return $this->buildFileTableDeleteButtonInstance();
        }
        
        protected function getTestPresentationFileTablePostVar()
        {
                if( $this->object->getTestPresentationConfig()->isSolutionInitiallyPrefilled() )
                {
                        return assFileUpload::REUSE_FILES_TBL_POSTVAR;
                }
                
                return assFileUpload::DELETE_FILES_TBL_POSTVAR;
        }
        // hey.
        
        // hey: prevPassSolutions - overwrite common prevPassSolution-Checkbox
        protected function getPreviousSolutionProvidedMessage()
        {
                return $this->lng->txt('use_previous_solution_advice_file_upload');
        }
        
        protected function getPreviousSolutionConfirmationCheckboxHtml()
        {
                return '';
        }
        // hey.
        
        public function getFormEncodingType()
        {
                return self::FORM_ENCODING_MULTIPART;
        }
}