class.ilExSubmissionFileGUI.php

Go to the documentation of this file.

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

class ilExSubmissionFileGUI extends ilExSubmissionBaseGUI
{               
        public function executeCommand()
        {
                global $ilCtrl;
                
                if(!$this->submission->canView())
                {
                        $this->returnToParentObject();
                }
                
                $class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("submissionScreen");             
                
                switch($class)
                {               
                        default:                                                                        
                                $this->{$cmd."Object"}();                               
                                break;                  
                }
        }
        
        public static function getOverviewContent(ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
        {               
                global $lng, $ilCtrl;
                
                $titles = array();
                foreach($a_submission->getFiles() as $file)
                {
                        $titles[] = $file["filetitle"];
                }
                $files_str = implode($titles, ", ");
                if ($files_str == "")
                {
                        $files_str = $lng->txt("message_no_delivered_files");
                }

                // no team == no submission
                if(!$a_submission->hasNoTeamYet())
                {                                                       
                        if ($a_submission->canSubmit())
                        {
                                $title = (count($titles) == 0
                                        ? $lng->txt("exc_hand_in")
                                        : $lng->txt("exc_edit_submission"));                                                                                            

                                $button = ilLinkButton::getInstance();
                                $button->setPrimary(true);
                                $button->setCaption($title, false);
                                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen"));                                                        
                                $files_str.= " ".$button->render();                                                             
                        }
                        else
                        {
                                if (count($titles) > 0)
                                {                                                               
                                        $button = ilLinkButton::getInstance();                                                          
                                        $button->setCaption("already_delivered_files");
                                        $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionFileGUI"), "submissionScreen"));                                                                                        
                                        $files_str.= " ".$button->render();
                                }
                        }
                }

                $a_info->addProperty($lng->txt("exc_files_returned"), $files_str);      
        }
        
        function submissionScreenObject()
        {
                global $ilToolbar, $ilHelp;


                $this->handleTabs();

                $ilHelp->setScreenIdComponent("exc");
                $ilHelp->setScreenId("submissions");

                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"));
                }
                else 
                {
                        $max_files = $this->submission->getAssignment()->getMaxFile();
                        
                        if($this->submission->canAddFile())
                        {                       
                                $ilToolbar->addButton($this->lng->txt("file_add"), 
                                        $this->ctrl->getLinkTarget($this, "uploadForm"));

                                if(!$max_files ||
                                        $max_files > 1)
                                {
                                        $ilToolbar->addButton($this->lng->txt("header_zip"), 
                                                $this->ctrl->getLinkTarget($this, "uploadZipForm"));
                                }
                                
                                // #15883 - extended deadline warning
                                if($this->assignment->getDeadline() &&
                                        time() >  $this->assignment->getDeadline())
                                {                                                       
                                        $dl = ilDatePresentation::formatDate(new ilDateTime($this->assignment->getDeadline(),IL_CAL_UNIX));
                                        $dl = sprintf($this->lng->txt("exc_late_submission_warning"), $dl);                                                                     
                                        $dl = '<span class="warning">'.$dl.'</span>';                                                   
                                        $ilToolbar->addText($dl);
                                }
                        }
                        
                        if($max_files)
                        {
                                ilUtil::sendInfo(sprintf($this->lng->txt("exc_max_file_reached"), $max_files));
                        }                       
                }

                include_once("./Modules/Exercise/classes/class.ilExcDeliveredFilesTableGUI.php");
                $tab = new ilExcDeliveredFilesTableGUI($this, "submissionScreen", $this->submission);
                $this->tpl->setContent($tab->getHTML());
        }
        
        public function uploadFormObject(ilPropertyFormGUI $a_form = null)
        {               
                if (!$this->submission->canSubmit())
                {
                        $this->ctrl->redirect($this, "submissionScreen");
                }
                
                $this->tabs_gui->clearTargets();
                $this->tabs_gui->setBackTarget($this->lng->txt("back"), 
                        $this->ctrl->getLinkTarget($this, "submissionScreen"));

                global $ilHelp;
                $ilHelp->setScreenIdComponent("exc");
                $ilHelp->setScreenId("upload_submission");

                if(!$a_form)
                {
                        $a_form = $this->initUploadForm();
                }
                $this->tpl->setContent($a_form->getHTML());     
        }
        
        public function uploadZipFormObject(ilPropertyFormGUI $a_form = null)
        {               
                if (!$this->submission->canSubmit())
                {
                        $this->ctrl->redirect($this, "submissionScreen");
                }
                
                $this->tabs_gui->clearTargets();
                $this->tabs_gui->setBackTarget($this->lng->txt("back"), 
                        $this->ctrl->getLinkTarget($this, "submissionScreen"));         

                if(!$a_form)
                {
                        $a_form = $this->initZipUploadForm();
                }
                $this->tpl->setContent($a_form->getHTML());     
        }
 
        protected function initUploadForm()
        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
        
                // file input
                include_once("./Services/Form/classes/class.ilFileWizardInputGUI.php");
                $fi = new ilFileWizardInputGUI($lng->txt("file"), "deliver");
                $fi->setFilenames(array(0 => ''));
                $fi->setRequired(true);
                $form->addItem($fi);
        
                $form->addCommandButton("uploadFile", $lng->txt("upload"));
                $form->addCommandButton("submissionScreen", $lng->txt("cancel"));
                        
                $form->setTitle($lng->txt("file_add"));
                $form->setFormAction($ilCtrl->getFormAction($this, "uploadFile"));
                return $form;
        }

        protected function initZipUploadForm()
        {
                global $lng, $ilCtrl;
        
                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                $form = new ilPropertyFormGUI();
        
                include_once("./Services/Form/classes/class.ilFileInputGUI.php");
                $fi = new ilFileInputGUI($lng->txt("file"), "deliver");
                $fi->setRequired(true);
                $fi->setSuffixes(array("zip"));
                $form->addItem($fi);
        
                $form->addCommandButton("uploadZip", $lng->txt("upload"));
                $form->addCommandButton("submissionScreen", $lng->txt("cancel"));
                        
                $form->setTitle($lng->txt("header_zip"));
                $form->setFormAction($ilCtrl->getFormAction($this, "uploadZip"));
                
                return $form;
        }
 
        function uploadFileObject()
        {
                global $ilCtrl;
                
                // #15322
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"), true);                  
                }
                else
                {
                        $form = $this->initUploadForm();
                        if(!$form->checkInput())
                        {
                                return $this->uploadFormObject($form);
                        }
                        
                        $success = false;
                        foreach ($_FILES["deliver"]["name"] as $k => $v)
                        {
                                $file = array(
                                        "name" => $_FILES["deliver"]["name"][$k], 
                                        "type" => $_FILES["deliver"]["type"][$k],
                                        "tmp_name" => $_FILES["deliver"]["tmp_name"][$k],
                                        "error" => $_FILES["deliver"]["error"][$k],
                                        "size" => $_FILES["deliver"]["size"][$k],
                                        );
                                if(!$this->submission->uploadFile($file))
                                {
                                        ilUtil::sendFailure($this->lng->txt("exc_upload_error"), true);
                                }
                                else
                                {
                                        $success = true;
                                }
                        }

                        if($success)
                        {
                                ilUtil::sendSuccess($this->lng->txt("file_added"), true);                               
                                $this->handleNewUpload();
                        }
                }
                
                $ilCtrl->redirect($this, "submissionScreen");
        }

        function uploadZipObject()
        {
                global $ilCtrl;
        
                // #15322
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"), true);                  
                }
                else 
                {
                        $form = $this->initZipUploadForm();
                        if(!$form->checkInput())
                        {
                                return $this->uploadZipFormObject($form);
                        }
                        
                        if (preg_match("/zip/",$_FILES["deliver"]["type"]) == 1)
                        {
                                if($this->submission->processUploadedZipFile($_FILES["deliver"]["tmp_name"]))
                                {
                                        ilUtil::sendSuccess($this->lng->txt("file_added"), true);                               
                                        $this->handleNewUpload();                               
                                }
                        }
                }
                
                $ilCtrl->redirect($this, "submissionScreen");
        }
        
        function confirmDeleteDeliveredObject()
        {
                global $ilCtrl, $tpl, $lng;
                
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);
                        $ilCtrl->redirect($this, "submissionScreen");
                }
                
                if (!is_array($_POST["delivered"]) || count($_POST["delivered"]) == 0)
                {
                        ilUtil::sendFailure($lng->txt("no_checkbox"), true);
                        $ilCtrl->redirect($this, "submissionScreen");
                }
                else
                {                       
                        $this->tabs_gui->clearTargets();
                        $this->tabs_gui->setBackTarget($this->lng->txt("back"), 
                                $this->ctrl->getLinkTarget($this, "submissionScreen"));
                
                        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                        $cgui = new ilConfirmationGUI();
                        $cgui->setFormAction($ilCtrl->getFormAction($this));
                        $cgui->setHeaderText($lng->txt("info_delete_sure"));
                        $cgui->setCancel($lng->txt("cancel"), "submissionScreen");
                        $cgui->setConfirm($lng->txt("delete"), "deleteDelivered");
                        
                        $files = $this->submission->getFiles();

                        foreach ($_POST["delivered"] as $i)
                        {
                                reset ($files);
                                $title = "";
                                foreach ($files as $f)
                                {
                                        if ($f["returned_id"] == $i)
                                        {
                                                $title = $f["filetitle"];
                                        }
                                }
                                $cgui->addItem("delivered[]", $i, $title);
                        }

                        $tpl->setContent($cgui->getHTML());
                }
        }
        
        function deleteDeliveredObject()
        {
                global $ilCtrl;
                
                if (!$this->submission->canSubmit())
                {
                        ilUtil::sendFailure($this->lng->txt("exercise_time_over"), true);                       
                }               
                else if (!count($_POST["delivered"]))
                {
                        ilUtil::sendFailure($this->lng->txt("please_select_a_delivered_file_to_delete"), true);
                }
                else
                {
                        $this->submission->deleteSelectedFiles($_POST["delivered"]);                            
                        $this->handleRemovedUpload();
                        
                        ilUtil::sendSuccess($this->lng->txt("exc_submitted_files_deleted"), true);
                }               
                $ilCtrl->redirect($this, "submissionScreen");
        }       
        
        function downloadReturnedObject($a_only_new = false)
        {               
                $peer_review_mask_filename = false;
                
                if($this->submission->canView())
                {
                        $peer_review_mask_filename = $this->submission->hasPeerReviewAccess();                                  
                }                                                                       
                else 
                {
                        // no access
                        return;
                }               
                
                $this->submission->downloadFiles(null, $a_only_new, $peer_review_mask_filename);                        
                $this->returnToParentObject();
        }

        function downloadNewReturnedObject()
        {                                               
                $this->downloadReturnedObject(true);    
        }

        function downloadObject()
        {
                global $ilCtrl;

                if(!$this->submission->canView())
                {
                        $this->returnToParentObject();
                }
                
                if (count($_REQUEST["delivered"]))
                {
                        if(!is_array($_REQUEST["delivered"]))
                        {
                                $_REQUEST["delivered"] = array($_REQUEST["delivered"]);
                        }
                        $this->submission->downloadFiles($_REQUEST["delivered"]);
                        exit;
                }
                else
                {
                        ilUtil::sendFailure($this->lng->txt("please_select_a_delivered_file_to_download"), true);
                        $ilCtrl->redirect($this, "submissionScreen");
                }
        }
}