class.ilExSubmissionTeamGUI.php

Go to the documentation of this file.

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

class ilExSubmissionTeamGUI
{       
        protected $exercise; // [ilObjExercise]
        protected $assignment; // [ilExAssignment]
        protected $submission; // [ilExSubmission]
        protected $team; // [ilExAssignmentTeam]
        
        public function __construct(ilObjExercise $a_exercise, ilExSubmission $a_submission)
        {
                global $ilCtrl, $ilTabs, $lng, $tpl;
                
                $this->exercise = $a_exercise;
                $this->submission = $a_submission;
                $this->assignment = $a_submission->getAssignment();
        
                // :TODO:
                $this->ctrl = $ilCtrl;
                $this->tabs_gui = $ilTabs;
                $this->lng = $lng;
                $this->tpl = $tpl;      
        }
        
        public function executeCommand()
        {
                global $ilCtrl;
                
                $class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd("submissionScreenTeam");         
                        
                if(!$this->assignment->hasTeam() ||
                        !$this->submission->canView())
                {
                        return;
                }
                $this->team = $this->submission->getTeam();
                
                if(!$this->submission->isTutor())
                {
                        self::handleTabs();
                        $this->tabs_gui->activateTab("team");   
                }
                
                switch($class)
                {               
                        case 'ilrepositorysearchgui':                                   
                                $this->ctrl->setReturn($this,'submissionScreenTeam');   
                                include_once('./Services/Search/classes/class.ilRepositorySearchGUI.php');
                                $rep_search = new ilRepositorySearchGUI();              
                                $rep_search->setTitle($this->lng->txt("exc_team_member_add"));
                                $rep_search->setCallback($this,'addTeamMemberActionObject');
                                $this->ctrl->forwardCommand($rep_search);
                                break;
                                                        
                        default:                                                                        
                                $this->{$cmd."Object"}();                               
                                break;
                }
        }               
        
        public static function getOverviewContent(ilInfoScreenGUI $a_info, ilExSubmission $a_submission)
        {               
                global $lng, $ilCtrl;
                
                if(!$a_submission->getAssignment()->hasTeam())
                {
                        return;
                }
                                                                
                $team_members = $a_submission->getTeam()->getMembers();
                if(sizeof($team_members))
                {
                        $team = array();                                                
                        foreach($team_members as $member_id)
                        {
                                $team[] = ilObjUser::_lookupFullname($member_id);
                        }                                               
                        $team = implode(", ", $team);
                        
                        // any team member upload?
                        if(!$a_submission->getLastSubmission())
                        {
                                $button = ilLinkButton::getInstance();                                                  
                                $button->setCaption("exc_delete_team");
                                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "confirmDeleteTeam"));                                                       
                                $team .= " ".$button->render(); 
                        }

                        $button = ilLinkButton::getInstance();                                                  
                        
                        if(!$a_submission->getAssignment()->getTeamTutor())
                        {
                                $button->setCaption("exc_manage_team");
                                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "submissionScreenTeam"));                                                    
                        }                       
                        else
                        {
                                $button->setCaption("exc_team_log");
                                $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "submissionScreenTeamLog"));                                         
                        }
                        $team .= " ".$button->render();                         

                        $a_info->addProperty($lng->txt("exc_team_members"), $team);     
                }
                else
                {                       
                        if($a_submission->getAssignment()->beforeDeadline())
                        {
                                if(!$a_submission->hasSubmitted())
                                {
                                         $team_info = $lng->txt("exc_no_team_yet_notice");                                                              
                                }
                                else
                                {
                                        $team_info = '<span class="warning">'.$lng->txt("exc_no_team_yet_notice").'</span>';            
                                }       

                                if(!$a_submission->getAssignment()->getTeamTutor())
                                {
                                        $button = ilLinkButton::getInstance();
                                        $button->setPrimary(true);
                                        $button->setCaption("exc_create_team");
                                        $button->setUrl($ilCtrl->getLinkTargetByClass(array("ilExSubmissionGUI", "ilExSubmissionTeamGUI"), "createTeam"));                                                      
                                        $team_info .= " ".$button->render();            
                                        
                                        $team_info .= '<div class="ilFormInfo">'.$lng->txt("exc_no_team_yet_info").'</div>';
                                }
                                else
                                {
                                        $team_info .= '<div class="ilFormInfo">'.$lng->txt("exc_no_team_yet_info_tutor").'</div>';
                                }                               
                        }
                        else
                        {
                                $team_info = '<span class="warning">'.$lng->txt("exc_create_team_times_up_warning").'</span>';
                        }
                        
                        $a_info->addProperty($lng->txt("exc_team_members"), $team_info);
                }
        }
        
        function returnToParentObject()
        {
                $this->ctrl->returnToParent($this);
        }
        
        public static function handleTabs()
        {               
                global $ilTabs, $ilCtrl, $lng;
                
                $ilTabs->addTab("team", $lng->txt("exc_team"), 
                        $ilCtrl->getLinkTargetByClass("ilExSubmissionTeamGUI", "submissionScreenTeam"));

                $ilTabs->addTab("log", $lng->txt("exc_team_log"), 
                        $ilCtrl->getLinkTargetByClass("ilExSubmissionTeamGUI", "submissionScreenTeamLog"));
        }
        
        protected function canEditTeam()
        {
                return (($this->submission->canSubmit() &&
                        !$this->submission->getAssignment()->getTeamTutor()) ||
                        $this->submission->isTutor());
        }
        
        function submissionScreenTeamObject()
        {
                global $ilToolbar;
                                                
                // #13414
                $read_only = !$this->canEditTeam();
                                
                if ($this->submission->getAssignment()->afterDeadlineStrict())
                {
                        ilUtil::sendInfo($this->lng->txt("exercise_time_over"));
                }
                else if(!$read_only)
                {                                                               
                        // add member
                        include_once './Services/Search/classes/class.ilRepositorySearchGUI.php';
                        ilRepositorySearchGUI::fillAutoCompleteToolbar(
                                $this,
                                $ilToolbar,
                                array(
                                        'auto_complete_name'    => $this->lng->txt('user'),
                                        'submit_name'                   => $this->lng->txt('add'),
                                        'add_search'                    => true,
                                        'add_from_container'    => $this->exercise->getRefId()          
                                )
                        );
                }
                else if($this->submission->getAssignment()->getTeamTutor())
                {
                        ilUtil::sendInfo($this->lng->txt("exc_no_team_yet_info_tutor"));
                }
                
                include_once "Modules/Exercise/classes/class.ilExAssignmentTeamTableGUI.php";
                $tbl = new ilExAssignmentTeamTableGUI(
                        $this, 
                        "submissionScreenTeam",
                        ilExAssignmentTeamTableGUI::MODE_EDIT, 
                        $this->exercise->getRefId(),
                        $this->team, 
                        $read_only                      
                );
                
                $this->tpl->setContent($tbl->getHTML());                                
        }
        
        public function addTeamMemberActionObject($a_user_ids = array())
        {                               
                if(!$this->canEditTeam())
                {
                        $this->ctrl->redirect("submissionScreenTeam");
                }
                
                if(!count($a_user_ids))
                {
                        ilUtil::sendFailure($this->lng->txt("no_checkbox"));
                        return false;
                }
                        
                foreach($a_user_ids as $user_id)
                {               
                        if($this->team->addTeamMember($user_id, $this->exercise->getRefId()))
                        {
                                $new_users[] = $user_id;
                                
                                // #14277
                                if (!$this->exercise->members_obj->isAssigned($user_id))
                                {
                                        $this->exercise->members_obj->assignMember($user_id);
                                }
                        }
                        else 
                        {
                                // #11959
                                ilUtil::sendFailure($this->lng->txt("exc_members_already_assigned_team"), true);
                        }
                }
                
                if(sizeof($new_users))
                {
                        // re-evaluate complete team, as new member could have already submitted
                        $this->exercise->processExerciseStatus(
                                $this->assignment,
                                $this->team->getMembers(),
                                $this->submission->hasSubmitted(),
                                $this->submission->validatePeerReviews()
                        );                      
                        // :TODO: notification?
                }
                
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);                   
                $this->ctrl->redirect($this, "submissionScreenTeam");
        }
        
        public function confirmDeleteTeamObject()
        {
                $this->confirmRemoveTeamMemberObject(true);
        }
        
        public function confirmRemoveTeamMemberObject($a_full_delete = false)
        {
                global $ilUser, $tpl;
                
                if(!$this->submission->isTutor())
                {                       
                        $ids = (bool)$a_full_delete
                                ? $this->team->getMembers()
                                : $_POST["id"];
                        
                        if(!sizeof($ids) &&
                                !$this->canEditTeam())
                        {
                                ilUtil::sendFailure($this->lng->txt("select_one"), true);
                                $this->ctrl->redirect($this, "submissionScreenTeam");
                        }                                       
                }
                else
                {
                        $ids = array($_GET["id"]);
                        if(!sizeof($ids))
                        {
                                $this->returnToParentObject();
                        }
                }
                        
                $members = $this->team->getMembers();
                if(sizeof($members) <= sizeof($ids))
                {
                        if(sizeof($members) == 1 && $members[0] == $ilUser->getId())
                        {
                                // direct team deletion - no confirmation
                                return $this->removeTeamMemberObject($a_full_delete);
                        }                                               
                        else
                        {
                                ilUtil::sendFailure($this->lng->txt("exc_team_at_least_one"), true);
                                $this->ctrl->redirect($this, "submissionScreenTeam");
                        }
                }
                        
                include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
                $cgui = new ilConfirmationGUI();
                $cgui->setFormAction($this->ctrl->getFormAction($this));
                $cgui->setHeaderText($this->lng->txt("exc_team_member_remove_sure"));   
                $cgui->setConfirm($this->lng->txt("remove"), "removeTeamMember");
                $cgui->setCancel($this->lng->txt("cancel"), $this->submission->isTutor()
                        ? "returnToParent"
                        : "submissionScreenTeam");

                $files = $this->submission->getFiles();
                
                include_once "Services/User/classes/class.ilUserUtil.php";
                
                foreach($ids as $id)
                {
                        $details = array();
                        foreach ($files as $file)
                        {                               
                                if($file["owner_id"] == $id)
                                {
                                        $details[] = $file["filetitle"];
                                }                                                       
                        }
                        $uname = ilUserUtil::getNamePresentation($id);
                        if(sizeof($details))
                        {
                                $uname .= ": ".implode(", ", $details);
                        }
                        $cgui->addItem("id[]", $id, $uname);
                }

                $tpl->setContent($cgui->getHTML());             
        }
        
        public function removeTeamMemberObject($a_full_delete = false)
        {
                global $ilUser;
                
                $cancel_cmd = $this->submission->isTutor()
                        ? "returnToParent"
                        : "submissionScreenTeam";
                
                $ids = (bool)$a_full_delete
                        ? $this->team->getMembers()
                        : $_POST["id"];

                if(!sizeof($ids) ||
                        !$this->canEditTeam())
                {
                        ilUtil::sendFailure($this->lng->txt("select_one"), true);
                        $this->ctrl->redirect($this, $cancel_cmd);
                }
                                
                $team_deleted = (bool)$a_full_delete;           
                if(!$team_deleted)
                {
                        $members = $this->team->getMembers();
                        if(sizeof($members) <= sizeof($ids))
                        {                               
                                if(sizeof($members) == 1 && $members[0] == $ilUser->getId())
                                {
                                        $team_deleted = true;
                                }                                               
                                else
                                {
                                        ilUtil::sendFailure($this->lng->txt("exc_team_at_least_one"), true);
                                        $this->ctrl->redirect($this, $cancel_cmd);
                                }
                        }
                }
                
                foreach($ids as $user_id)
                {
                        $this->team->removeTeamMember($user_id, $this->exercise->getRefId());                                                           
                }
                
                // reset ex team members, as any submission is not valid without team                                                                   
                $this->exercise->processExerciseStatus(
                        $this->assignment,
                        $ids,
                        false
                );      
                
                if(!$team_deleted)
                {
                        // re-evaluate complete team, as removed member might have had submitted
                        $this->exercise->processExerciseStatus(
                                $this->assignment,
                                $this->team->getMembers(),
                                $this->submission->hasSubmitted(),
                                $this->submission->validatePeerReviews()
                        );      
                }               
                                
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);           
                if(!$team_deleted)
                {
                        $this->ctrl->redirect($this, $cancel_cmd);              
                }
                else
                {
                        $this->ctrl->redirect($this, "returnToParent"); 
                }               
        }
        
        function submissionScreenTeamLogObject()
        {               
                $this->tabs_gui->activateTab("log");
        
                include_once "Modules/Exercise/classes/class.ilExAssignmentTeamLogTableGUI.php";
                $tbl = new ilExAssignmentTeamLogTableGUI($this, "submissionScreenTeamLog",
                        $this->team);
                
                $this->tpl->setContent($tbl->getHTML());                                                
        }
        
        function createSingleMemberTeamObject()
        {                       
                ilExAssignmentTeam::getTeamId(
                        $this->assignment->getId(), 
                        $this->submission->getUserId(), 
                        true
                );              
                ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);
                $this->returnToParentObject();  
        }                       
        
        function showTeamLogObject()
        {                                                                               
                include_once "Modules/Exercise/classes/class.ilExAssignmentTeamLogTableGUI.php";
                $tbl = new ilExAssignmentTeamLogTableGUI($this, "showTeamLog", $this->team);            
                $this->tpl->setContent($tbl->getHTML());                                                
        }
                
        public function createTeamObject()
        {               
                global $ilCtrl, $ilUser, $lng, $tpl;
                
                if($this->submission->canSubmit())
                {                       
                        $options = ilExAssignmentTeam::getAdoptableTeamAssignments($this->assignment->getExerciseId(), $this->assignment->getId(), $ilUser->getId());
                        if(sizeof($options))
                        {                                                                                               
                                include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
                                $form = new ilPropertyFormGUI();                         
                                $form->setTitle($lng->txt("exc_team_assignment_adopt_user"));
                                $form->setFormAction($ilCtrl->getFormAction($this, "createAdoptedTeam"));

                                $teams = new ilRadioGroupInputGUI($lng->txt("exc_assignment"), "ass_adpt");
                                $teams->setValue(-1);

                                $teams->addOption(new ilRadioOption($lng->txt("exc_team_assignment_adopt_none_user"), -1));
                                
                                $current_map = ilExAssignmentTeam::getAssignmentTeamMap($this->assignment->getId());

                                include_once "Services/User/classes/class.ilUserUtil.php";
                                foreach($options as $id => $item)
                                {
                                        $members = array();
                                        $free = false;
                                        foreach($item["user_team"] as $user_id)
                                        {
                                                $members[$user_id] = ilUserUtil::getNamePresentation($user_id);
                                                
                                                if(array_key_exists($user_id, $current_map))
                                                {
                                                        $members[$user_id] .= " (".$lng->txt("exc_team_assignment_adopt_already_assigned").")";
                                                }
                                                else
                                                {
                                                        $free = true;
                                                }
                                        }
                                        asort($members);
                                        $members = implode("<br />", $members);
                                        $option = new ilRadioOption($item["title"], $id);
                                        $option->setInfo($members);
                                        if(!$free)
                                        {
                                                $option->setDisabled(true);
                                        }
                                        $teams->addOption($option);
                                }

                                $form->addItem($teams);

                                $form->addCommandButton("createAdoptedTeam", $lng->txt("save"));
                                $form->addCommandButton("returnToParent", $lng->txt("cancel"));

                                $tpl->setContent($form->getHTML());
                                return;
                        }                       
                        
                        ilExAssignmentTeam::getTeamId($this->assignment->getId(), $ilUser->getId(), true);              
                        
                        // #18046
                        if(!$this->exercise->members_obj->isAssigned($ilUser->getId()))
                        {
                                $this->exercise->members_obj->assignMember($ilUser->getId());
                        }
                        
                        ilUtil::sendSuccess($this->lng->txt("settings_saved"), true);   
                }
                
                $ilCtrl->redirect($this, "returnToParent");
        }
        
        public function createAdoptedTeamObject()
        {
                global $ilCtrl, $ilUser, $lng;
                
                if($this->submission->canSubmit())
                {       
                        $src_ass_id = (int)$_POST["ass_adpt"];
                        if($src_ass_id > 0)
                        {
                                ilExAssignmentTeam::adoptTeams($src_ass_id, $this->assignment->getId(), $ilUser->getId(), $this->exercise->getRefId());                                         
                        }
                        else
                        {
                                ilExAssignmentTeam::getTeamId($this->assignment->getId(), $ilUser->getId(), true);              
                        }
                        
                        ilUtil::sendSuccess($lng->txt("settings_saved"), true);
                }
                
                $ilCtrl->redirect($this, "returnToParent");
        }       
        
        
        public function addUserFromAutoCompleteObject()
        {               
                if(!strlen(trim($_POST['user_login'])))
                {
                        ilUtil::sendFailure($this->lng->txt('msg_no_search_string'));
                        $this->submissionScreenTeamObject();    
                        return false;
                }
                
                $users = explode(',', $_POST['user_login']);

                $user_ids = array();
                foreach($users as $user)
                {
                        $user_id = ilObjUser::_lookupId($user);

                        if(!$user_id)
                        {
                                ilUtil::sendFailure($this->lng->txt('user_not_known'));                                                         
                                return $this->submissionScreenTeamObject();                             
                        }
                        
                        $user_ids[] = $user_id;
                }
        
                return $this->addTeamMemberActionObject($user_ids);                                                             
        }
}