class.ilPortfolioExerciseGUI.php

Go to the documentation of this file.

<?php

/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Modules/Exercise/classes/class.ilExAssignment.php";       
include_once "Modules/Exercise/classes/class.ilExSubmission.php";       

class ilPortfolioExerciseGUI
{
        protected $user_id; // [int]
        protected $obj_id; // [int]
        protected $ass_id; // [int]
        protected $file; // [string]
        
        public function __construct($a_user_id, $a_obj_id)
        {
                $this->user_id = $a_user_id;
                $this->obj_id = $a_obj_id;
                $this->ass_id = (int)$_GET["ass"];
                $this->file = trim($_GET["file"]);
        }
        
        function executeCommand()
        {
                global $ilCtrl;
                
                if(!$this->ass_id ||
                        !$this->user_id)
                {
                        $this->ctrl->returnToParent($this);
                }
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
        
                switch($next_class)
                {
                        default:                                
                                $this->$cmd();
                                break;
                }
                
                return true;
        }
        
        public static function checkExercise($a_user_id, $a_obj_id, $a_add_submit = false)
        {                       
                global $tree;
                
                $info = array();
                
                $exercises = ilExSubmission::findUserFiles($a_user_id, $a_obj_id);
                // #0022794
                if (!$exercises)
                {
                        $exercises = ilExSubmission::findUserFiles($a_user_id, $a_obj_id.".sec");
                }
                if($exercises)
                {
                        foreach($exercises as $exercise)
                        {
                                // #9988
                                $active_ref = false;
                                foreach(ilObject::_getAllReferences($exercise["obj_id"]) as $ref_id)
                                {
                                        if(!$tree->isSaved($ref_id))
                                        {
                                                $active_ref = true;
                                                break;
                                        }
                                }
                                if($active_ref)
                                {                               
                                        $part = self::getExerciseInfo($a_user_id, $exercise["ass_id"], $a_add_submit);
                                        if($part)
                                        {
                                                $info[] = $part;
                                        }
                                }
                        }
                        if(sizeof($info))
                        {
                                return implode("<br />", $info);                                
                        }
                }
        }       
        
        protected static function getExerciseInfo($a_user_id, $a_assignment_id, $a_add_submit = false)
        {                               
                global $lng, $ilCtrl;
                
                include_once "Modules/Exercise/classes/class.ilExAssignment.php";                       
                $ass = new ilExAssignment($a_assignment_id);            
                $exercise_id = $ass->getExerciseId();
                if(!$exercise_id)
                {
                        return;
                }
                
                // is the assignment still open?
                $times_up = $ass->afterDeadlineStrict();
                
                // exercise goto
                include_once "./Services/Link/classes/class.ilLink.php";
                $exc_ref_id = array_shift(ilObject::_getAllReferences($exercise_id));
                $exc_link = ilLink::_getStaticLink($exc_ref_id, "exc");

                $info = sprintf($lng->txt("prtf_exercise_info"), 
                        $ass->getTitle(),
                        "<a href=\"".$exc_link."\">".
                        ilObject::_lookupTitle($exercise_id)."</a>");
                
                // submit button
                if($a_add_submit && !$times_up)
                {                               
                        $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
                        $submit_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "finalize");
                        $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");      
                        
                        include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                        $button = ilLinkButton::getInstance();
                        $button->setCaption("prtf_finalize_portfolio");
                        $button->setPrimary(true);
                        $button->setUrl($submit_link);                  
                        $info .= " ".$button->render();                 
                }
                
                // submitted files
                include_once "Modules/Exercise/classes/class.ilExSubmission.php";               
                $submission = new ilExSubmission($ass, $a_user_id);             
                if($submission->hasSubmitted())
                {
                        // #16888
                        $submitted = $submission->getSelectedObject();  
                        
                        $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
                        $dl_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "downloadExcSubFile");
                        $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");
                        
                        $rel = ilDatePresentation::useRelativeDates();
                        ilDatePresentation::setUseRelativeDates(false);
                        
                        include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
                        $button = ilLinkButton::getInstance();
                        $button->setCaption("download");
                        $button->setUrl($dl_link);                      
                        
                        $info .= "<br />".sprintf($lng->txt("prtf_exercise_submitted_info"), 
                                ilDatePresentation::formatDate(new ilDateTime($submitted["ts"], IL_CAL_DATETIME)),
                                $button->render());
                        
                        ilDatePresentation::setUseRelativeDates($rel);
                }               
                
                
                // work instructions incl. files
                
                $tooltip = "";

                $inst = $ass->getInstruction();
                if($inst)
                {
                        $tooltip .= nl2br($inst);                                       
                }

                $ass_files = $ass->getFiles();
                if (count($ass_files) > 0)
                {
                        if($tooltip)
                        {
                                $tooltip .= "<br /><br />";
                        }
                        
                        foreach($ass_files as $file)
                        {
                                $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", $a_assignment_id);
                                $ilCtrl->setParameterByClass("ilportfolioexercisegui", "file", urlencode($file["name"]));
                                $dl_link = $ilCtrl->getLinkTargetByClass("ilportfolioexercisegui", "downloadExcAssFile");
                                $ilCtrl->setParameterByClass("ilportfolioexercisegui", "file", "");                     
                                $ilCtrl->setParameterByClass("ilportfolioexercisegui", "ass", "");                      
                                
                                $tooltip .= $file["name"].": <a href=\"".$dl_link."\">".
                                        $lng->txt("download")."</a>";                                                                           
                        }
                }                       
                
                if($tooltip)
                {
                        $ol_id = "exc_ass_".$a_assignment_id;

                        include_once "Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php";
                        $overlay = new ilOverlayGUI($ol_id);

                        // overlay
                        $overlay->setAnchor($ol_id."_tr");
                        $overlay->setTrigger($ol_id."_tr", "click", $ol_id."_tr");
                        $overlay->setAutoHide(false);
                        // $overlay->setCloseElementId($cl_id);
                        $overlay->add();

                        // trigger
                        $overlay->addTrigger($ol_id."_tr", "click", $ol_id."_tr");

                        $info .= "<div id=\"".$ol_id."_tr\"><a href=\"#\">".$lng->txt("exc_instruction")."</a></div>".
                                "<div id=\"".$ol_id."\" style=\"display:none; background-color:white; border: 1px solid #bbb; padding: 10px;\">".$tooltip."</div>";
                }
                
                return $info;
        }
        
        function downloadExcAssFile()
        {
                if($this->file)
                {               
                        include_once "Modules/Exercise/classes/class.ilExAssignment.php";                       
                        $ass = new ilExAssignment($this->ass_id);               
                        $ass_files = $ass->getFiles();
                        if (count($ass_files) > 0)
                        {
                                foreach($ass_files as $file)
                                {
                                        if($file["name"] == $this->file)
                                        {
                                                ilUtil::deliverFile($file["fullpath"], $file["name"]);                                          
                                        }                                                                                               
                                }
                        }
                }                                       
        }
        
        function downloadExcSubFile()
        {               
                $ass = new ilExAssignment($this->ass_id);
                $submission = new ilExSubmission($ass, $this->user_id);
                $submitted = $submission->getFiles();                           
                if (count($submitted) > 0)
                {
                        $submitted = array_pop($submitted);                     

                        $user_data = ilObjUser::_lookupName($submitted["user_id"]);
                        $title = ilObject::_lookupTitle($submitted["obj_id"])." - ".
                                $ass->getTitle()." - ".
                                $user_data["firstname"]." ".
                                $user_data["lastname"]." (".
                                $user_data["login"].").zip";

                        ilUtil::deliverFile($submitted["filename"], $title);                                                                                                                                    
                }                                                       
        }
                
        protected function finalize()
        {                               
                global $lng, $ilCtrl;
                
                include_once "Modules/Exercise/classes/class.ilExSubmissionBaseGUI.php";
                include_once "Modules/Exercise/classes/class.ilExSubmissionObjectGUI.php";              
                $exc_gui = ilExSubmissionObjectGUI::initGUIForSubmit($this->ass_id);
                $exc_gui->submitPortfolio($this->obj_id);
                
                ilUtil::sendSuccess($lng->txt("prtf_finalized"), true);
                $ilCtrl->returnToParent($this);
        }
}