Exercise submission. More...

Collaboration diagram for ilExSubmission:

Public Member Functions
	__construct (ilExAssignment $a_ass, $a_user_id, ilExAssignmentTeam $a_team=null, $a_is_tutor=false, $a_public_submissions=false)

	getSubmissionType ()

	getAssignment ()

	getTeam ()

	getPeerReview ()

	validatePeerReviews ()

	getUserId ()

	getUserIds ()

	getFeedbackId ()

	hasSubmitted ()

	getSelectedObject ()

	canSubmit ()

	canView ()

	isTutor ()

	hasNoTeamYet ()

	isInTeam ($a_user_id=null)

	isOwner ()

	hasPeerReviewAccess ()

	canAddFile ()

	uploadFile ($a_http_post_files, $unzip=false)
	Save submitted file of user. More...

	processUploadedZipFile ($fileTmp)
	processes errorhandling etc for uploaded archive More...

	getFiles (array $a_file_ids=null, $a_only_valid=false, $a_min_timestamp=null)

	lookupNewFiles ()
	Check how much files have been uploaded by the learner after the last download of the tutor. More...

	deleteAllFiles ()

	deleteSelectedFiles (array $file_id_array)
	Deletes already delivered files. More...

	downloadFiles (array $a_file_ids=null, $a_only_new=false, $a_peer_review_mask_filename=false)

	updateTutorDownloadTime ()

	getLastSubmission ()
	Get the date of the last submission of a user for the assignment. More...

	addResourceObject ($a_wsp_id, $a_text=null)
	Add personal resource to assigment. More...

	deleteResourceObject ($a_returned_id)
	Remove personal resource to assigment. More...

	updateTextSubmission ($a_text)
	Handle text assignment submissions. More...

	getDownloadedFilesInfoForTableGUIS ($a_parent_obj, $a_parent_cmd=null)

Static Public Member Functions
static	hasAnySubmissions ($a_ass_id)

static	getAllAssignmentFiles ($a_exc_id, $a_ass_id)

static	lookupExerciseIdForReturnedId ($a_returned_id)
	Get exercise from submission id (used in ilObjMediaObject) More...

static	findUserFiles ($a_user_id, $a_filetitle)
	Check if given file was assigned. More...

static	deleteUser ($a_exc_id, $a_user_id)
	Delete all delivered files of user. More...

static	downloadAllAssignmentFiles (ilExAssignment $a_ass, array $members)
	Download all submitted files of an assignment (all user) More...

Protected Member Functions
	isLate ()

	initStorage ()

	getLastDownloadTime (array $a_user_ids)

	downloadSingleFile ($a_user_id, $filename, $filetitle)

	downloadMultipleFiles ($a_filenames, $a_user_id, $a_multi_user=false)

Protected Attributes
	$assignment

	$user_id

	$team

	$peer_review

	$is_tutor

	$public_submissions

Detailed Description

Exercise submission.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 10 of file class.ilExSubmission.php.

Constructor & Destructor Documentation

◆ __construct()

ilExSubmission::__construct	(	ilExAssignment	$a_ass,
			$a_user_id,
		ilExAssignmentTeam	$a_team = `null`,
			$a_is_tutor = `false`,
			$a_public_submissions = `false`
	)

Definition at line 19 of file class.ilExSubmission.php.

References $ilUser, $user_id, ilExAssignmentTeam\getInstanceByUserId(), and ilExAssignment\hasTeam().

         {                               
                 global $ilUser;
                 
                 $this->assignment = $a_ass;
                 $this->user_id = $a_user_id;    
                 $this->is_tutor = (bool)$a_is_tutor;
                 $this->public_submissions = (bool)$a_public_submissions;
                 
                 if($a_ass->hasTeam())
                 {
                         if(!$a_team)
                         {
                                 include_once "Modules/Exercise/classes/class.ilExAssignmentTeam.php";
                                 $this->team = ilExAssignmentTeam::getInstanceByUserId($this->assignment->getId(), $this->user_id);
                         }
                         else
                         {
                                 $this->team = $a_team;
                         }
                 }
                 
                 if($this->assignment->getPeerReview())
                 {
                         include_once "Modules/Exercise/classes/class.ilExPeerReview.php";
                         $this->peer_review = new ilExPeerReview($this->assignment);
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ addResourceObject()

ilExSubmission::addResourceObject	(	$a_wsp_id,
		$a_text = `null`
	)

Add personal resource to assigment.

Parameters

int	$a_wsp_id
string	$a_text

Definition at line 1079 of file class.ilExSubmission.php.

References $ilDB, $query, isLate(), and ilUtil\now().

Referenced by ilObjPortfolioGUI\createPortfolioFromTemplateProcess(), and updateTextSubmission().

         {
                 global $ilDB;
         
                 $next_id = $ilDB->nextId("exc_returned");
                 $query = sprintf("INSERT INTO exc_returned ".
                                                  "(returned_id, obj_id, user_id, filetitle, ass_id, ts, atext, late) ".
                                                  "VALUES (%s, %s, %s, %s, %s, %s, %s, %s)",
                         $ilDB->quote($next_id, "integer"),
                         $ilDB->quote($this->assignment->getExerciseId(), "integer"),
                         $ilDB->quote($this->getUserId(), "integer"),
                         $ilDB->quote($a_wsp_id, "text"),
                         $ilDB->quote($this->assignment->getId(), "integer"),
                         $ilDB->quote(ilUtil::now(), "timestamp"),
                         $ilDB->quote($a_text, "text"),
                         $ilDB->quote($this->isLate(), "integer")
                 );
                 $ilDB->manipulate($query);
                 
                 return $next_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canAddFile()

ilExSubmission::canAddFile ( )

Definition at line 216 of file class.ilExSubmission.php.

References canSubmit(), getAssignment(), and getFiles().

Referenced by uploadFile().

         {
                 if(!$this->canSubmit())
                 {
                         return false;
                 }
                 
                 $max = $this->getAssignment()->getMaxFile();
                 if($max &&
                         $max <= sizeof($this->getFiles()))
                 {
                         return false;
                 }       
                 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canSubmit()

ilExSubmission::canSubmit ( )

Definition at line 142 of file class.ilExSubmission.php.

References isOwner().

Referenced by canAddFile(), canView(), ilExSubmissionFileGUI\getOverviewContent(), ilExSubmissionTextGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), and ilExSubmissionObjectGUI\getOverviewContentPortfolio().

         {
                 return ($this->isOwner() &&
                         !$this->assignment->notStartedYet() &&
                         $this->assignment->beforeDeadline());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canView()

ilExSubmission::canView ( )

Definition at line 149 of file class.ilExSubmission.php.

References $ilUser, canSubmit(), isInTeam(), and isTutor().

Referenced by ilExSubmissionGUI\getOverviewContent().

         {
                 global $ilUser;
                 
                 if($this->canSubmit() ||
                         $this->isTutor() ||
                         $this->isInTeam() ||
                         $this->public_submissions)
                 {
                         return true;
                 }
                                 
                 // #16115
                 if($this->peer_review)
                 {
                         // peer review givers may view peer submissions
                         foreach($this->peer_review->getPeerReviewsByPeerId($this->getUserId()) as $giver)
                         {
                                 if($giver["giver_id"] == $ilUser->getId())
                                 {
                                         return true;
                                 }
                         }
                 }
                 
                 return false;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAllFiles()

ilExSubmission::deleteAllFiles ( )

Definition at line 507 of file class.ilExSubmission.php.

References deleteSelectedFiles(), and getFiles().

Referenced by updateTextSubmission().

         {                                               
                 $files = array();
                 foreach($this->getFiles() as $item)
                 {
                         $files[] = $item["returned_id"];
                 }
                 if(sizeof($files))
                 {
                         $this->deleteSelectedFiles($files);             
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteResourceObject()

ilExSubmission::deleteResourceObject ( $a_returned_id )

Remove personal resource to assigment.

Parameters

int $a_returned_id

Definition at line 1106 of file class.ilExSubmission.php.

References $ilDB.

Referenced by ilExSubmissionObjectGUI\getOverviewContentBlog(), and ilExSubmissionObjectGUI\getOverviewContentPortfolio().

         {
                 global $ilDB;
                 
                 $ilDB->manipulate("DELETE FROM exc_returned".
                         " WHERE obj_id = ".$ilDB->quote($this->assignment->getExerciseId(), "integer").
                         " AND user_id = ".$ilDB->quote($this->getUserId(), "integer").
                         " AND ass_id = ".$ilDB->quote($this->assignment->getId(), "integer").
                         " AND returned_id = ".$ilDB->quote($a_returned_id, "integer"));         
         }

Here is the caller graph for this function:

◆ deleteSelectedFiles()

ilExSubmission::deleteSelectedFiles ( array $file_id_array )

Deletes already delivered files.

Parameters

array	$file_id_array	An array containing database ids of the delivered files
numeric	$user_id	The database id of the user public

Definition at line 526 of file class.ilExSubmission.php.

References $filename, $ilDB, $path, $result, $row, getUserIds(), initStorage(), and ilExAssignmentTeam\TEAM_LOG_REMOVE_FILE.

Referenced by deleteAllFiles().

         {               
                 global $ilDB;
                                 
                 $user_ids = $this->getUserIds();
                 if(!$user_ids || 
                         !sizeof($file_id_array))
                 {
                         return;
                 }
                 
                 if (count($file_id_array))
                 {                                                                               
                         $result = $ilDB->query("SELECT * FROM exc_returned".
                                 " WHERE ".$ilDB->in("returned_id", $file_id_array, false, "integer").
                                 " AND ".$ilDB->in("user_id", $user_ids, "", "integer"));        
                         
                         if ($ilDB->numRows($result))
                         {                                                               
                                 $result_array = array();
                                 while ($row = $ilDB->fetchAssoc($result))
                                 {
                                         $row["timestamp"] = $row["ts"];
                                         array_push($result_array, $row);
                                 }
                                 
                                 // delete the entries in the database
                                 $ilDB->manipulate("DELETE FROM exc_returned".
                                         " WHERE ".$ilDB->in("returned_id", $file_id_array, false, "integer").
                                         " AND ".$ilDB->in("user_id", $user_ids, "", "integer"));
                                 
                                 // delete the files                             
                                 $path = $this->initStorage()->getAbsoluteSubmissionPath();
                                 foreach ($result_array as $key => $value)
                                 {
                                         if($value["filename"])
                                         {
                                                 if($this->team)
                                                 {
                                                         $this->team->writeLog(ilExAssignmentTeam::TEAM_LOG_REMOVE_FILE, 
                                                                 $value["filetitle"]);
                                                 }
                                                 
                                                 $filename = $path."/".$value["user_id"]."/".basename($value["filename"]);
                                                 unlink($filename);
                                         }
                                 }
                         }
                 }               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteUser()

static ilExSubmission::deleteUser	(	$a_exc_id,
		$a_user_id
	)

static

Delete all delivered files of user.

Parameters

int	$a_exc_id	excercise id
int	$a_user_id	user id

Definition at line 583 of file class.ilExSubmission.php.

References $team, and ilExAssignment\getInstancesByExercise().

Referenced by ilExerciseMembers\deassignMember().

         {
                 
                 include_once("./Modules/Exercise/classes/class.ilExAssignment.php");
                 
                 foreach(ilExAssignment::getInstancesByExercise($a_exc_id) as $ass)
                 {
                         $submission = new self($ass, $a_user_id);
                         $submission->deleteAllFiles();
                         
                         // remove from any team
                         $team = $submission->getTeam();
                         if($team)
                         {
                                 $team->removeTeamMember($a_user_id);
                         }
                         
                         // #14900
                         $member_status = $ass->getMemberStatus($a_user_id);
                         $member_status->setStatus("notgraded");         
                         $member_status->update();
                 }       
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadAllAssignmentFiles()

static ilExSubmission::downloadAllAssignmentFiles	(	ilExAssignment	$a_ass,
		array	$members
	)

static

Download all submitted files of an assignment (all user)

Parameters

$members array of user names, key is user id

Definition at line 870 of file class.ilExSubmission.php.

References $file, $lng, ilObjUser\_lookupName(), ilFSStorageExercise\create(), ilUtil\delDir(), ilUtil\deliverFile(), ilUtil\dirsize(), ilUtil\escapeShellArg(), ilUtil\getASCIIFilename(), ilExAssignmentTeam\getAssignmentTeamMap(), ilExAssignment\getExerciseId(), ilExAssignment\getId(), ilExAssignment\getTitle(), ilExAssignment\getType(), ilExAssignment\hasTeam(), ilUtil\ilTempnam(), ilUtil\makeDir(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, and ilUtil\unzip().

Referenced by ilExerciseManagementGUI\downloadAllObject().

         {
                 global $lng, $ilias;
                 
                 include_once "./Services/Utilities/classes/class.ilUtil.php";
                 include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                 
                 $storage = new ilFSStorageExercise($a_ass->getExerciseId(), $a_ass->getId());
                 $storage->create();
                 
                 ksort($members);
                 //$savepath = $this->getExercisePath() . "/" . $this->obj_id . "/";
                 $savepath = $storage->getAbsoluteSubmissionPath();
                 $cdir = getcwd();
 
 
                 // important check: if the directory does not exist
                 // ILIAS stays in the current directory (echoing only a warning)
                 // and the zip command below archives the whole ILIAS directory
                 // (including the data directory) and sends a mega file to the user :-o
                 if (!is_dir($savepath))
                 {
                         return;
                 }
                 // Safe mode fix
 //              chdir($this->getExercisePath());
                 chdir($storage->getTempPath());
                 $zip = PATH_TO_ZIP;
 
                 // check first, if we have enough free disk space to copy all files to temporary directory
                 $tmpdir = ilUtil::ilTempnam();
                 ilUtil::makeDir($tmpdir);
                 chdir($tmpdir);
 
                 // check free diskspace
                 $dirsize = 0;
                 foreach (array_keys($members) as $id) 
                 {
                         $directory = $savepath.DIRECTORY_SEPARATOR.$id;
                         $dirsize += ilUtil::dirsize($directory);
                 }
                 if ($dirsize > disk_free_space($tmpdir)) 
                 {
                         return -1;
                 }
                 
                 $ass_type = $a_ass->getType();
 
                 // copy all member directories to the temporary folder
                 // switch from id to member name and append the login if the member name is double
                 // ensure that no illegal filenames will be created
                 // remove timestamp from filename               
                 if($a_ass->hasTeam())
                 {
                         $team_dirs = array();
                         $team_map = ilExAssignmentTeam::getAssignmentTeamMap($a_ass->getId());
                 }               
                 foreach ($members as $id => $item)
                 {               
                         $user = $item["name"];
                         $user_files = $item["files"];
                         
                         $sourcedir = $savepath.DIRECTORY_SEPARATOR.$id;
                         if (!is_dir($sourcedir))
                         {
                                 continue;
                         }
                         
                         $userName = ilObjUser::_lookupName($id);
                         
                         // group by teams
                         $team_dir= "";
                         if(is_array($team_map) &&
                                 array_key_exists($id, $team_map))
                         {
                                 $team_id = $team_map[$id];
                                 if(!array_key_exists($team_id, $team_dirs))
                                 {
                                         $team_dir = $lng->txt("exc_team")." ".$team_id;
                                         ilUtil::makeDir($team_dir);                                             
                                         $team_dirs[$team_id] = $team_dir;
                                 }
                                 $team_dir = $team_dirs[$team_id].DIRECTORY_SEPARATOR;
                         }
                         
                         $targetdir = $team_dir.ilUtil::getASCIIFilename(                                
                                 trim($userName["lastname"])."_".
                                 trim($userName["firstname"])."_".
                                 trim($userName["login"])."_".
                                 $userName["user_id"]
                         );                                              
                         ilUtil::makeDir($targetdir);                    
                                                 
                         $sourcefiles = scandir($sourcedir);
                         $duplicates = array();
                         foreach ($sourcefiles as $sourcefile) {
                                 if ($sourcefile == "." || $sourcefile == "..")
                                 {
                                         continue;
                                 }
                                 
                                 $targetfile = trim(basename($sourcefile));
                                 $pos = strpos($targetfile, "_");
                                 if ($pos !== false)
                                 {                                               
                                         $targetfile= substr($targetfile, $pos + 1);
                                 }
                                 
                                 // #14536 
                                 if(array_key_exists($targetfile, $duplicates))
                                 {
                                         $suffix = strrpos($targetfile, ".");                                            
                                         $targetfile = substr($targetfile, 0, $suffix).
                                                 " (".(++$duplicates[$targetfile]).")".
                                                 substr($targetfile, $suffix);                           
                                 }
                                 else
                                 {
                                         $duplicates[$targetfile] = 1;
                                 }                                
                                 
                                 // late submission?
                                 foreach($user_files as $file)
                                 {
                                         if(basename($file["filename"]) == $sourcefile)
                                         {
                                                 if($file["late"])
                                                 {
                                                         $targetfile = $lng->txt("exc_late_submission")." - ".
                                                                 $targetfile;
                                                 }
                                                 break;
                                         }
                                 }
                                 
                                 $targetfile = ilUtil::getASCIIFilename($targetfile);
                                 $targetfile = $targetdir.DIRECTORY_SEPARATOR.$targetfile;
                                 $sourcefile = $sourcedir.DIRECTORY_SEPARATOR.$sourcefile;
 
                                 if (!copy ($sourcefile, $targetfile))
                                 {
                                         //echo 'Could not copy '.$sourcefile.' to '.$targetfile;
                                         $ilias->raiseError('Could not copy '.basename($sourcefile)." to '".$targetfile."'.",
                                                 $ilias->error_obj->MESSAGE);
                                 }
                                 else
                                 {
                                         // preserve time stamp
                                         touch($targetfile, filectime($sourcefile));
                                         
                                         // blogs and portfolios are stored as zip and have to be unzipped
                                         if($ass_type == ilExAssignment::TYPE_PORTFOLIO || 
                                                 $ass_type == ilExAssignment::TYPE_BLOG)
                                         {
                                                 ilUtil::unzip($targetfile);
                                                 unlink($targetfile);
                                         }                                       
                                 }
 
                         }
                 }
                 
                 $tmpfile = ilUtil::ilTempnam();
                 $tmpzipfile = $tmpfile . ".zip";
                 // Safe mode fix
                 $zipcmd = $zip." -r ".ilUtil::escapeShellArg($tmpzipfile)." .";
                 exec($zipcmd);
                 ilUtil::delDir($tmpdir);
 
                 $assTitle = $a_ass->getTitle()."_".$a_ass->getId();
                 chdir($cdir);
                 ilUtil::deliverFile($tmpzipfile, (strlen($assTitle) == 0
                         ? strtolower($lng->txt("exc_assignment"))
                         : $assTitle). ".zip", "", false, true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadFiles()

ilExSubmission::downloadFiles	(	array	$a_file_ids = `null`,
			$a_only_new = `false`,
			$a_peer_review_mask_filename = `false`
	)

Definition at line 620 of file class.ilExSubmission.php.

References $file, $ilUser, $lng, ilObjUser\_lookupName(), ilObject\_lookupTitle(), downloadMultipleFiles(), downloadSingleFile(), getFiles(), getLastDownloadTime(), getUserId(), getUserIds(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, and updateTutorDownloadTime().

         {                       
                 global $ilUser, $lng;
                 
                 $user_ids = $this->getUserIds();
                 $is_team = $this->assignment->hasTeam();
                 
                 // get last download time
                 $download_time = null;
                 if ($a_only_new)
                 {
                         $download_time = $this->getLastDownloadTime($user_ids);                                 
                 }
                 
                 if($this->is_tutor)
                 {
                         $this->updateTutorDownloadTime();               
                 }               
                 
                 if($a_peer_review_mask_filename)
                 {
                         // process peer review sequence id
                         $peer_id = null;
                         foreach($this->peer_review->getPeerReviewsByGiver($ilUser->getId()) as $idx => $item)
                         {
                                 if($item["peer_id"] == $this->getUserId())
                                 {
                                         $peer_id = $idx+1;
                                         break;
                                 }
                         }       
 
                         // this will remove personal info from zip-filename
                         $is_team = true;
                 }
         
                 $files = $this->getFiles($a_file_ids, false, $download_time);           
                 if($files)
                 {
                         if (sizeof($files) == 1)
                         {                       
                                 $file = array_pop($files);
 
                                 switch($this->assignment->getType())
                                 {
                                         case ilExAssignment::TYPE_BLOG:
                                         case ilExAssignment::TYPE_PORTFOLIO:
                                                 $file["filetitle"] = ilObjUser::_lookupName($file["user_id"]);
                                                 $file["filetitle"] = ilObject::_lookupTitle($this->assignment->getExerciseId())." - ".
                                                         $this->assignment->getTitle()." - ".
                                                         $file["filetitle"]["firstname"]." ".
                                                         $file["filetitle"]["lastname"]." (".
                                                         $file["filetitle"]["login"].").zip";
                                                 break;
 
                                         default:
                                                 break;
                                 }               
 
                                 if($a_peer_review_mask_filename)
                                 {
                                         $suffix = array_pop(explode(".", $file["filetitle"]));
                                         $file["filetitle"] = $this->assignment->getTitle()."_peer".$peer_id.".".$suffix;                                                        
                                 }
                                 else if($file["late"])
                                 {
                                         $file["filetitle"] = $lng->txt("exc_late_submission")." - ".
                                                 $file["filetitle"];
                                 }
 
                                 $this->downloadSingleFile($file["user_id"], $file["filename"], $file["filetitle"]);
                         }
                         else 
                         {
                                 $array_files = array();
                                 foreach($files as $seq => $file)
                                 {                                               
                                         $src = basename($file["filename"]);                             
                                         if($a_peer_review_mask_filename)
                                         {                                                                       
                                                 $suffix = array_pop(explode(".", $src));
                                                 $tgt = $this->assignment->getTitle()."_peer".$peer_id.
                                                         "_".(++$seq).".".$suffix;                       
                                                 
                                                 $array_files[$file["user_id"]][] = array(
                                                         "src" => $src, 
                                                         "tgt" => $tgt
                                                 );
                                         }
                                         else
                                         {                                               
                                                 $array_files[$file["user_id"]][] = array(
                                                         "src" => $src,
                                                         "late" => $file["late"]                                                 
                                                 );
                                         }                               
                                 }                       
                                                                 
                                 $this->downloadMultipleFiles($array_files, 
                                         ($is_team ? null : $this->getUserId()), $is_team);
                         }
                 }
                 else
                 {
                         return false;
                 }
 
                 return true;
         }

Here is the call graph for this function:

◆ downloadMultipleFiles()

ilExSubmission::downloadMultipleFiles	(	$a_filenames,
		$a_user_id,
		$a_multi_user = `false`
	)

protected

Definition at line 761 of file class.ilExSubmission.php.

References $filename, $lng, $path, $user_id, ilObjUser\_lookupName(), ilUtil\delDir(), ilUtil\deliverFile(), ilUtil\escapeShellArg(), exit, ilUtil\getASCIIFilename(), ilUtil\ilTempnam(), initStorage(), ilExAssignment\lookupTitle(), and ilUtil\makeDir().

Referenced by downloadFiles().

         {                                       
                 global $lng;
                 
                 $path = $this->initStorage()->getAbsoluteSubmissionPath();
                 
                 require_once "./Services/Utilities/classes/class.ilUtil.php";
                 $cdir = getcwd();
 
                 $zip = PATH_TO_ZIP;
                 $tmpdir = ilUtil::ilTempnam();
                 $tmpfile = ilUtil::ilTempnam();
                 $tmpzipfile = $tmpfile . ".zip";
 
                 ilUtil::makeDir($tmpdir);
                 chdir($tmpdir);
 
                 $assTitle = ilExAssignment::lookupTitle($this->assignment->getId());
                 $deliverFilename = str_replace(" ", "_", $assTitle);
                 if ($a_user_id > 0 && !$a_multi_user)
                 {
                         $userName = ilObjUser::_lookupName($a_user_id);
                         $deliverFilename .= "_".$userName["lastname"]."_".$userName["firstname"];
                 }
                 else
                 {
                         $deliverFilename .= "_files";
                 }
                 $orgDeliverFilename = trim($deliverFilename);
                 $deliverFilename = ilUtil::getASCIIFilename($orgDeliverFilename);
                 ilUtil::makeDir($tmpdir."/".$deliverFilename);
                 chdir($tmpdir."/".$deliverFilename);
                         
                 //copy all files to a temporary directory and remove them afterwards
                 $parsed_files = $duplicates = array();
                 foreach ($a_filenames as $user_id => $files)
                 {
                         $pathname = $path."/".$user_id;
 
                         foreach($files as $filename)
                         {
                                 // peer review masked filenames, see deliverReturnedFiles()
                                 if(isset($filename["tgt"]))
                                 {
                                         $newFilename = $filename["tgt"];
                                         $filename = $filename["src"];
                                 }
                                 else
                                 {
                                         $late = $filename["late"];
                                         $filename = $filename["src"];
                                         
                                         // remove timestamp
                                         $newFilename = trim($filename);
                                         $pos = strpos($newFilename , "_");
                                         if ($pos !== false)
                                         {                               
                                                 $newFilename = substr($newFilename, $pos + 1);
                                         }
                                         // #11070
                                         $chkName = strtolower($newFilename);
                                         if(array_key_exists($chkName, $duplicates))
                                         {
                                                 $suffix = strrpos($newFilename, ".");                                           
                                                 $newFilename = substr($newFilename, 0, $suffix).
                                                         " (".(++$duplicates[$chkName]).")".
                                                         substr($newFilename, $suffix);
                                         }
                                         else
                                         {
                                                 $duplicates[$chkName] = 1;
                                         }
                                         
                                         if($late)
                                         {
                                                 $newFilename = $lng->txt("exc_late_submission")." - ".
                                                         $newFilename;
                                         }                                                                               
                                 }
                                 
                                 $newFilename = ilUtil::getASCIIFilename($newFilename);
                                 $newFilename = $tmpdir.DIRECTORY_SEPARATOR.$deliverFilename.DIRECTORY_SEPARATOR.$newFilename;
                                 // copy to temporal directory
                                 $oldFilename =  $pathname.DIRECTORY_SEPARATOR.$filename;
                                 if (!copy ($oldFilename, $newFilename))
                                 {
                                         echo 'Could not copy '.$oldFilename.' to '.$newFilename;
                                 }
                                 touch($newFilename, filectime($oldFilename));
                                 $parsed_files[] =  ilUtil::escapeShellArg($deliverFilename.DIRECTORY_SEPARATOR.basename($newFilename)); 
                         }
                 }                               
                 
                 chdir($tmpdir);
                 $zipcmd = $zip." ".ilUtil::escapeShellArg($tmpzipfile)." ".join($parsed_files, " ");
 
                 exec($zipcmd);
                 ilUtil::delDir($tmpdir);
                 
                 chdir($cdir);
                 ilUtil::deliverFile($tmpzipfile, $orgDeliverFilename.".zip", "", false, true);
                 exit;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ downloadSingleFile()

ilExSubmission::downloadSingleFile	(	$a_user_id,
		$filename,
		$filetitle
	)

protected

Definition at line 752 of file class.ilExSubmission.php.

References $filename, ilUtil\deliverFile(), and initStorage().

Referenced by downloadFiles().

         {       
                 $filename = $this->initStorage()->getAbsoluteSubmissionPath().
                         "/".$a_user_id."/".basename($filename);
 
                 require_once "./Services/Utilities/classes/class.ilUtil.php";
                 ilUtil::deliverFile($filename, $filetitle);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ findUserFiles()

static ilExSubmission::findUserFiles	(	$a_user_id,
		$a_filetitle
	)

static

Check if given file was assigned.

Used in Blog/Portfolio

Parameters

int	$a_user_id
string	$a_filetitle

Definition at line 491 of file class.ilExSubmission.php.

References $ilDB, $res, and $row.

Referenced by ilBlogExerciseGUI\checkExercise(), and ilPortfolioExerciseGUI\checkExercise().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT obj_id, ass_id".
                         " FROM exc_returned".
                         " WHERE user_id = ".$ilDB->quote($a_user_id, "integer").
                         " AND filetitle = ".$ilDB->quote($a_filetitle, "text"));
                 $res = array();
                 while($row = $ilDB->fetchAssoc($set))
                 {
                         $res[$row["ass_id"]] = $row;
                 }
                 return $res;
         }

Here is the caller graph for this function:

◆ getAllAssignmentFiles()

static ilExSubmission::getAllAssignmentFiles	(	$a_exc_id,
		$a_ass_id
	)

static

Definition at line 366 of file class.ilExSubmission.php.

References $ilDB, $path, $query, $res, and $row.

Referenced by ilExAssignmentListTextTableGUI\parse(), and ilExAssignment\recalculateLateSubmissions().

         {
                 global $ilDB;
                 
                 include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                 $storage = new ilFSStorageExercise($a_exc_id, $a_ass_id);
                 $path = $storage->getAbsoluteSubmissionPath();
                 
                 $query = "SELECT * FROM exc_returned WHERE ass_id = ".
                         $ilDB->quote($a_ass_id, "integer");
 
                 $res = $ilDB->query($query);
                 while($row = $ilDB->fetchAssoc($res))
                 {
                         $row["timestamp"] = $row["ts"];
                         $row["filename"] = $path."/".$row["user_id"]."/".basename($row["filename"]);
                         $delivered[] = $row;
                 }
                 
                 return $delivered ? $delivered : array();
         }

Here is the caller graph for this function:

◆ getAssignment()

ilExSubmission::getAssignment ( )

Definition at line 66 of file class.ilExSubmission.php.

References $assignment.

Referenced by ilExSubmissionBaseGUI\__construct(), ilExSubmissionTeamGUI\__construct(), canAddFile(), getFiles(), getLastDownloadTime(), ilExSubmissionObjectGUI\getOverviewContent(), ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmissionGUI\getOverviewContent(), ilExPeerReviewGUI\getOverviewContent(), and lookupNewFiles().

         {
                 return $this->assignment;
         }

Here is the caller graph for this function:

◆ getDownloadedFilesInfoForTableGUIS()

ilExSubmission::getDownloadedFilesInfoForTableGUIS	(	$a_parent_obj,
		$a_parent_cmd = `null`
	)

Definition at line 1163 of file class.ilExSubmission.php.

References $file, $ilCtrl, $lng, $result, ilDatePresentation\formatDate(), getFiles(), getLastSubmission(), getUserId(), IL_CAL_DATETIME, lookupNewFiles(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, and ilExAssignment\TYPE_UPLOAD_TEAM.

         {
                 global $lng, $ilCtrl;
                 
                 $result = array();
                 $result["files"]["count"] = "---";
         
                 // submission:
                 // see if files have been resubmmited after solved
                 $last_sub =     $this->getLastSubmission();
                 if ($last_sub)
                 {
                         $last_sub = ilDatePresentation::formatDate(new ilDateTime($last_sub,IL_CAL_DATETIME));
                 }
                 else
                 {
                         $last_sub = "---";
                 }
                 /* #13741 - status_time has been reduced to grading (mark/status)
                 if (self::lookupUpdatedSubmission($a_ass_id, $a_user_id) == 1) 
                 {
                         $last_sub = "<b>".$last_sub."</b>";
                 }                
                 */              
                 $result["last_submission"]["txt"] = $lng->txt("exc_last_submission");
                 $result["last_submission"]["value"] = $last_sub;
                 
                 // #16994
                 $ilCtrl->setParameterByClass("ilexsubmissionfilegui", "member_id", $this->getUserId());
                 
                 // assignment type specific
                 switch($this->assignment->getType())
                 {                       
                         case ilExAssignment::TYPE_UPLOAD_TEAM:
                                 // data is merged by team - see above
                                 // fallthrough
                                 
                         case ilExAssignment::TYPE_UPLOAD:                               
                                 $all_files = $this->getFiles();
                                 $late_files = 0;
                                 foreach($all_files as $file)
                                 {
                                         if($file["late"])
                                         {
                                                 $late_files++;
                                         }
                                 }
                                 
                                 // nr of submitted files
                                 $result["files"]["txt"] = $lng->txt("exc_files_returned");                                              
                                 if ($late_files)
                                 {
                                         $result["files"]["txt"].= ' - <span class="warning">'.$lng->txt("exc_late_submission")." (".$late_files.")</span>";
                                 }                               
                                 $sub_cnt = count($all_files);
                                 $new = $this->lookupNewFiles();
                                 if (count($new) > 0)
                                 {
                                         $sub_cnt.= " ".sprintf($lng->txt("cnt_new"),count($new));
                                 }
                                 
                                 $result["files"]["count"] = $sub_cnt;
 
                                 // download command                                                             
                                 if ($sub_cnt > 0)
                                 {
                                         $result["files"]["download_url"] = 
                                                 $ilCtrl->getLinkTargetByClass("ilexsubmissionfilegui", "downloadReturned");
                                                                         
                                         if (count($new) <= 0)
                                         {
                                                 $result["files"]["download_txt"] = $lng->txt("exc_download_files");
                                         }
                                         else
                                         {
                                                 $result["files"]["download_txt"] = $lng->txt("exc_download_all");
                                         }
                                         
                                         // download new files only
                                         if (count($new) > 0)
                                         {
                                                 $result["files"]["download_new_url"] = 
                                                         $ilCtrl->getLinkTargetByClass("ilexsubmissionfilegui", "downloadNewReturned");
                                                 
                                                 $result["files"]["download_new_txt"] = $lng->txt("exc_download_new");                                           
                                         }
                                 }
                                 break;
                                 
                         case ilExAssignment::TYPE_BLOG:                         
                                 $result["files"]["txt"] =$lng->txt("exc_blog_returned");                                
                                 $blogs = $this->getFiles();
                                 if($blogs)
                                 {
                                         $blogs = array_pop($blogs);                                     
                                         if($blogs && substr($blogs["filename"], -1) != "/")
                                         {                                               
                                                 if($blogs["late"])
                                                 {
                                                         $result["files"]["txt"].= ' - <span class="warning">'.$lng->txt("exc_late_submission")."</span>";
                                                 }       
                                                 
                                                 $result["files"]["count"] = 1;
                                                                                         
                                                 $result["files"]["download_url"] = 
                                                         $ilCtrl->getLinkTargetByClass("ilexsubmissionfilegui", "downloadReturned");
                                                 
                                                 $result["files"]["download_txt"] = $lng->txt("exc_download_files");                                             
                                         }
                                 }
                                 break;
                                 
                         case ilExAssignment::TYPE_PORTFOLIO:
                                 $result["files"]["txt"] = $lng->txt("exc_portfolio_returned");                          
                                 $portfolios = $this->getFiles();
                                 if($portfolios)
                                 {
                                         $portfolios = array_pop($portfolios);                                                                   
                                         if($portfolios && substr($portfolios["filename"], -1) != "/")
                                         {       
                                                 if($portfolios["late"])
                                                 {
                                                         $result["files"]["txt"].= ' - <span class="warning">'.$lng->txt("exc_late_submission")."</span>";
                                                 }       
                                                 
                                                 $result["files"]["count"] = 1;
                                                                                                 
                                                 $result["files"]["download_url"] = 
                                                         $ilCtrl->getLinkTargetByClass("ilexsubmissionfilegui", "downloadReturned");             
                                                 
                                                 $result["files"]["download_txt"] = $lng->txt("exc_download_files");                                             
                                         }
                                 }
                                 break;
                                 
                         case ilExAssignment::TYPE_TEXT:
                                 $result["files"]["txt"] = $lng->txt("exc_files_returned_text");
                                 $files = $this->getFiles();
                                 if($files)
                                 {
                                         $result["files"]["count"] = 1;
                                         
                                         $files = array_shift($files);                                                                                                                   
                                         if(trim($files["atext"]))
                                         {                                                       
                                                 if($files["late"])
                                                 {
                                                         $result["files"]["txt"].= ' - <span class="warning">'.$lng->txt("exc_late_submission")."</span>";
                                                 }       
                                                 
                                                 $result["files"]["download_url"] =
                                                         $ilCtrl->getLinkTargetByClass("ilexsubmissiontextgui", "showAssignmentText");                                                                                           
                                                 
                                                 $result["files"]["download_txt"] = $lng->txt("exc_text_assignment_show");                                               
                                         }
                                 }
                                 break;
                 }
                 
                 $ilCtrl->setParameterByClass("ilexsubmissionfilegui", "member_id", "");
                 
                 return $result;
         }

Here is the call graph for this function:

◆ getFeedbackId()

ilExSubmission::getFeedbackId ( )

Definition at line 116 of file class.ilExSubmission.php.

References getUserId().

         {
                 if($this->team)
                 {
                         return "t".$this->team->getId();
                 }
                 else
                 {
                         return $this->getUserId();
                 }
         }

Here is the call graph for this function:

◆ getFiles()

ilExSubmission::getFiles	(	array	$a_file_ids = `null`,
			$a_only_valid = `false`,
			$a_min_timestamp = `null`
	)

Definition at line 388 of file class.ilExSubmission.php.

References $ilDB, $path, $result, $row, getAssignment(), getUserIds(), and initStorage().

Referenced by canAddFile(), deleteAllFiles(), ilBlogExerciseGUI\downloadExcSubFile(), downloadFiles(), getDownloadedFilesInfoForTableGUIS(), ilExSubmissionFileGUI\getOverviewContent(), getSelectedObject(), ilExPeerReviewGUI\getSubmissionContent(), hasSubmitted(), processUploadedZipFile(), and updateTextSubmission().

         {
                 global $ilDB;
                 
                 $sql = "SELECT * FROM exc_returned".
                         " WHERE ass_id = ".$ilDB->quote($this->getAssignment()->getId(), "integer").
                         " AND ".$ilDB->in("user_id", $this->getUserIds(), "", "integer");
                 
                 if($a_file_ids)
                 {
                         $sql .= " AND ".$ilDB->in("returned_id", $a_file_ids, false, "integer");
                 }
                 
                 if($a_min_timestamp)
                 {
                         $sql .= " AND ts > ".$ilDB->quote($a_min_timestamp, "timestamp");
                 }       
                 
                 $result = $ilDB->query($sql);
                 
                 $delivered_files = array();
                 if ($ilDB->numRows($result))
                 {
                         $path = $this->initStorage()->getAbsoluteSubmissionPath();
                 
                         while ($row = $ilDB->fetchAssoc($result))
                         {
                                 // blog/portfolio/text submissions
                                 if($a_only_valid && 
                                         !$row["filename"] &&
                                         !(trim($row["atext"])))
                                 {
                                         continue;
                                 }
                                 
                                 $row["owner_id"] = $row["user_id"];
                                 $row["timestamp"] = $row["ts"];
                                 $row["timestamp14"] = substr($row["ts"], 0, 4).
                                         substr($row["ts"], 5, 2).substr($row["ts"], 8, 2).
                                         substr($row["ts"], 11, 2).substr($row["ts"], 14, 2).
                                         substr($row["ts"], 17, 2);
                                 $row["filename"] = $path.
                                         "/".$row["user_id"]."/".basename($row["filename"]);
                                 array_push($delivered_files, $row);
                         }
                 }
                                 
                 return $delivered_files;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastDownloadTime()

ilExSubmission::getLastDownloadTime ( array $a_user_ids )

protected

Definition at line 607 of file class.ilExSubmission.php.

References $ilDB, $ilUser, and getAssignment().

Referenced by downloadFiles().

         {
                 global $ilDB, $ilUser;
         
                 $q = "SELECT download_time FROM exc_usr_tutor WHERE ".
                         " ass_id = ".$ilDB->quote($this->getAssignment()->getId(), "integer")." AND ".
                         $ilDB->in("usr_id", $a_user_ids, "", "integer")." AND ".
                         " tutor_id = ".$ilDB->quote($ilUser->getId(), "integer");
                 $lu_set = $ilDB->query($q);
                 $lu_rec = $ilDB->fetchAssoc($lu_set);
                 return $lu_rec["download_time"];                
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastSubmission()

ilExSubmission::getLastSubmission ( )

Get the date of the last submission of a user for the assignment.

Returns: mixed false or mysql timestamp of last submission

Definition at line 1051 of file class.ilExSubmission.php.

References $ilDB, and ilUtil\getMySQLTimestamp().

Referenced by getDownloadedFilesInfoForTableGUIS(), and ilExSubmissionTeamGUI\getOverviewContent().

         {
                 global $ilDB;
         
                 $ilDB->setLimit(1);
 
                 $q = "SELECT obj_id,user_id,ts FROM exc_returned".
                         " WHERE ass_id = ".$ilDB->quote($this->assignment->getId(), "integer").
                         " AND ".$ilDB->in("user_id", $this->getUserIds(), "", "integer").
                         " AND (filename IS NOT NULL OR atext IS NOT NULL)".
                         " AND ts IS NOT NULL".
                         " ORDER BY ts DESC";
                 $usr_set = $ilDB->query($q);
                 $array = $ilDB->fetchAssoc($usr_set);           
                 return ilUtil::getMySQLTimestamp($array["ts"]);                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPeerReview()

ilExSubmission::getPeerReview ( )

Definition at line 76 of file class.ilExSubmission.php.

References $peer_review.

Referenced by ilExPeerReviewGUI\getOverviewContent().

         {
                 return $this->peer_review;
         }

Here is the caller graph for this function:

◆ getSelectedObject()

ilExSubmission::getSelectedObject ( )

Definition at line 133 of file class.ilExSubmission.php.

References getFiles().

Referenced by ilBlogExerciseGUI\getExerciseInfo(), ilExSubmissionObjectGUI\getOverviewContentBlog(), and ilExSubmissionObjectGUI\getOverviewContentPortfolio().

         {
                 $files = $this->getFiles();
                 if(sizeof($files))              
                 {
                         return array_pop($files);
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubmissionType()

ilExSubmission::getSubmissionType ( )

Definition at line 48 of file class.ilExSubmission.php.

References ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, ilExAssignment\TYPE_TEXT, ilExAssignment\TYPE_UPLOAD, and ilExAssignment\TYPE_UPLOAD_TEAM.

Referenced by ilExSubmissionGUI\getOverviewContent().

         {
                 switch($this->assignment->getType())
                 {
                         case ilExAssignment::TYPE_UPLOAD_TEAM:                                  
                         case ilExAssignment::TYPE_UPLOAD:               
                                 return "File";
 
                         case ilExAssignment::TYPE_BLOG:                 
                         case ilExAssignment::TYPE_PORTFOLIO:                            
                                 return "Object";        
 
                         case ilExAssignment::TYPE_TEXT:                                                                                         
                                 return "Text";  
                 };
         }

Here is the caller graph for this function:

◆ getTeam()

ilExSubmission::getTeam ( )

Definition at line 71 of file class.ilExSubmission.php.

References $team.

Referenced by ilExSubmissionTeamGUI\getOverviewContent().

         {
                 return $this->team;
         }

Here is the caller graph for this function:

◆ getUserId()

ilExSubmission::getUserId ( )

Definition at line 99 of file class.ilExSubmission.php.

References $user_id.

Referenced by downloadFiles(), getDownloadedFilesInfoForTableGUIS(), getFeedbackId(), ilExPeerReviewGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), isOwner(), and uploadFile().

         {
                 return $this->user_id;
         }

Here is the caller graph for this function:

◆ getUserIds()

ilExSubmission::getUserIds ( )

Definition at line 104 of file class.ilExSubmission.php.

References hasNoTeamYet().

Referenced by deleteSelectedFiles(), downloadFiles(), getFiles(), isInTeam(), lookupNewFiles(), updateTutorDownloadTime(), and validatePeerReviews().

         {
                 if($this->team && 
                         !$this->hasNoTeamYet())
                 {                       
                         return $this->team->getMembers();
                 }
                 
                 // if has no team currently there still might be uploads attached
                 return array($this->user_id);           
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAnySubmissions()

static ilExSubmission::hasAnySubmissions ( $a_ass_id )

static

Definition at line 354 of file class.ilExSubmission.php.

References $ilDB, $query, and $res.

Referenced by ilExerciseManagementGUI\membersObject().

         {
                 global $ilDB;
                 
                 $query = "SELECT * FROM exc_returned".
                         " WHERE ass_id = ".$ilDB->quote($a_ass_id, "integer").
                         " AND (filename IS NOT NULL OR atext IS NOT NULL)".
                         " AND ts IS NOT NULL";
                 $res = $ilDB->query($query);
                 return $res->numRows($res);
         }

Here is the caller graph for this function:

◆ hasNoTeamYet()

ilExSubmission::hasNoTeamYet ( )

Definition at line 182 of file class.ilExSubmission.php.

Referenced by ilExSubmissionFileGUI\getOverviewContent(), and getUserIds().

         {
                 if($this->assignment->hasTeam() &&
                         !$this->team->getId())
                 {
                         return true;
                 }
                 return false;
         }

Here is the caller graph for this function:

◆ hasPeerReviewAccess()

ilExSubmission::hasPeerReviewAccess ( )

Definition at line 210 of file class.ilExSubmission.php.

         {
                 return ($this->peer_review &&
                         $this->peer_review->hasPeerReviewAccess($this->user_id));
         }

◆ hasSubmitted()

ilExSubmission::hasSubmitted ( )

Definition at line 128 of file class.ilExSubmission.php.

References getFiles().

Referenced by ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), and ilExSubmissionObjectGUI\getOverviewContentPortfolio().

         {
                 return (bool)sizeof($this->getFiles(null, true));
         }               

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStorage()

ilExSubmission::initStorage ( )

protected

Definition at line 244 of file class.ilExSubmission.php.

Referenced by deleteSelectedFiles(), downloadMultipleFiles(), downloadSingleFile(), getFiles(), and uploadFile().

         {
                 include_once("./Modules/Exercise/classes/class.ilFSStorageExercise.php");
                 return new ilFSStorageExercise($this->assignment->getExerciseId(), $this->assignment->getId());
         }

Here is the caller graph for this function:

◆ isInTeam()

ilExSubmission::isInTeam ( $a_user_id = null )

Definition at line 192 of file class.ilExSubmission.php.

References $ilUser, and getUserIds().

Referenced by canView().

         {
                 global $ilUser;
                 
                 if(!$a_user_id)
                 {
                         $a_user_id = $ilUser->getId();
                 }
                 return in_array($a_user_id, $this->getUserIds());
         }       

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isLate()

ilExSubmission::isLate ( )

protected

Definition at line 238 of file class.ilExSubmission.php.

Referenced by addResourceObject(), and updateTextSubmission().

         {
                 return ($this->assignment->getDeadline() &&
                         $this->assignment->getDeadline() < time());             
         }

Here is the caller graph for this function:

◆ isOwner()

ilExSubmission::isOwner ( )

Definition at line 203 of file class.ilExSubmission.php.

References $ilUser, and getUserId().

Referenced by canSubmit().

         {               
                 global $ilUser;         
                 
                 return ($ilUser->getId() == $this->getUserId());
         }       

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isTutor()

ilExSubmission::isTutor ( )

Definition at line 177 of file class.ilExSubmission.php.

References $is_tutor.

Referenced by canView().

         {
                 return $this->is_tutor;
         }

Here is the caller graph for this function:

◆ lookupExerciseIdForReturnedId()

static ilExSubmission::lookupExerciseIdForReturnedId ( $a_returned_id )

static

Get exercise from submission id (used in ilObjMediaObject)

Parameters

int $a_returned_id

Returns: int

Definition at line 472 of file class.ilExSubmission.php.

References $ilDB, and $row.

Referenced by ilObjMediaObject\getParentObjectIdForUsage().

         {
                 global $ilDB;
                 
                 $set = $ilDB->query("SELECT obj_id".
                         " FROM exc_returned".
                         " WHERE returned_id = ".$ilDB->quote($a_returned_id, "integer"));
                 $row = $ilDB->fetchAssoc($set);
                 return (int)$row["obj_id"];             
         }

Here is the caller graph for this function:

◆ lookupNewFiles()

ilExSubmission::lookupNewFiles ( )

Check how much files have been uploaded by the learner after the last download of the tutor.

Definition at line 442 of file class.ilExSubmission.php.

References $ilDB, $ilUser, getAssignment(), and getUserIds().

Referenced by getDownloadedFilesInfoForTableGUIS().

         {
                 global $ilDB, $ilUser;
                 
                 $q = "SELECT exc_returned.returned_id AS id ".
                         "FROM exc_usr_tutor, exc_returned ".
                         "WHERE exc_returned.ass_id = exc_usr_tutor.ass_id ".
                         " AND exc_returned.user_id = exc_usr_tutor.usr_id ".
                         " AND exc_returned.ass_id = ".$ilDB->quote($this->getAssignment()->getId(), "integer").
                         " AND ".$ilDB->in("exc_returned.user_id", $this->getUserIds(), "", "integer").
                         " AND exc_usr_tutor.tutor_id = ".$ilDB->quote($ilUser->getId(), "integer").
                         " AND exc_usr_tutor.download_time < exc_returned.ts ";
 
                 $new_up_set = $ilDB->query($q);
 
                 $new_up = array();
                 while ($new_up_rec = $ilDB->fetchAssoc($new_up_set))
                 {
                         $new_up[] = $new_up_rec["id"];
                 }
 
                 return $new_up;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processUploadedZipFile()

ilExSubmission::processUploadedZipFile ( $fileTmp )

processes errorhandling etc for uploaded archive

Parameters

string $tmpFile path and filename to uploaded file

Definition at line 296 of file class.ilExSubmission.php.

References $filename, $lng, $success, ilUtil\delDir(), getFiles(), ilUtil\ilTempnam(), ilUtil\makeDir(), ilFileUtils\processZipFile(), ilFileUtils\recursive_dirscan(), ilUtil\sendFailure(), uploadFile(), and ilFileUtils\utf8_encode().

         {               
                 global $lng; 
                 
                 // Create unzip-directory
                 $newDir = ilUtil::ilTempnam();
                 ilUtil::makeDir($newDir);
 
                 include_once ("Services/Utilities/classes/class.ilFileUtils.php");
                 
                 $success = true;
                         
                 try 
                 {
                         ilFileUtils::processZipFile($newDir,$fileTmp, false);
                         ilFileUtils::recursive_dirscan($newDir, $filearray);    
                         
                         // #18441 - check number of files in zip
                         $max_num = $this->assignment->getMaxFile();
                         if($max_num)
                         {
                                 $current_num = sizeof($this->getFiles());
                                 $zip_num = sizeof($filearray["file"]);
                                 if($current_num + $zip_num > $max_num)
                                 {
                                         $success = false;
                                         ilUtil::sendFailure($lng->txt("exc_upload_error"), true);
                                 }
                         }
                         
                         if($success)
                         {
                                 foreach ($filearray["file"] as $key => $filename)
                                 {
                                         $a_http_post_files["name"] = ilFileUtils::utf8_encode($filename);
                                         $a_http_post_files["type"] = "other";
                                         $a_http_post_files["tmp_name"] = $filearray["path"][$key]."/".$filename;
                                         $a_http_post_files["error"] = 0;
                                         $a_http_post_files["size"] = filesize($filearray["path"][$key]."/".$filename);
 
                                         if(!$this->uploadFile($a_http_post_files, true))
                                         {
                                                 $success = false;
                                                 ilUtil::sendFailure($lng->txt("exc_upload_error"), true);
                                         }                                                       
                                 }                       
                         }
                 } 
                 catch (ilFileUtilsException $e) 
                 {
                         $success = false;
                         ilUtil::sendFailure($e->getMessage());
                 }
                 
                 ilUtil::delDir($newDir);
                 return $success;
         }

Here is the call graph for this function:

◆ updateTextSubmission()

ilExSubmission::updateTextSubmission ( $a_text )

Handle text assignment submissions.

Parameters

string $a_text

Returns: int

Definition at line 1123 of file class.ilExSubmission.php.

References $ilDB, addResourceObject(), deleteAllFiles(), getFiles(), isLate(), and ilUtil\now().

         {
                 global $ilDB;
                 
                 $files = $this->getFiles();
                 
                 // no text = remove submission
                 if(!trim($a_text))
                 {
                         $this->deleteAllFiles();
                         return;
                 }
                                 
                 if(!$files)
                 {                       
                         return $this->addResourceObject("TEXT", $a_text);
                 }
                 else
                 {
                         $files = array_shift($files);
                         $id = $files["returned_id"];
                         if($id)
                         {
                                 $ilDB->manipulate("UPDATE exc_returned".
                                         " SET atext = ".$ilDB->quote($a_text, "text").
                                         ", ts = ".$ilDB->quote(ilUtil::now(), "timestamp").
                                         ", late = ".$ilDB->quote($this->isLate(), "integer").
                                         " WHERE returned_id = ".$ilDB->quote($id, "integer"));
                                 return $id;
                         }
                 }
         }

Here is the call graph for this function:

◆ updateTutorDownloadTime()

ilExSubmission::updateTutorDownloadTime ( )

Definition at line 731 of file class.ilExSubmission.php.

References $ilDB, $ilUser, $user_id, getUserIds(), and ilUtil\now().

Referenced by downloadFiles().

         {
                 global $ilUser, $ilDB;
                                 
                 $exc_id = $this->assignment->getExerciseId();
                 $ass_id = $this->assignment->getId();
 
                 foreach($this->getUserIds() as $user_id)
                 {
                         $ilDB->manipulateF("DELETE FROM exc_usr_tutor ".
                                 "WHERE ass_id = %s AND usr_id = %s AND tutor_id = %s",
                                 array("integer", "integer", "integer"),
                                 array($ass_id, $user_id, $ilUser->getId()));
 
                         $ilDB->manipulateF("INSERT INTO exc_usr_tutor (ass_id, obj_id, usr_id, tutor_id, download_time) VALUES ".
                                 "(%s, %s, %s, %s, %s)",
                                 array("integer", "integer", "integer", "integer", "timestamp"),
                                 array($ass_id, $exc_id, $user_id, $ilUser->getId(), ilUtil::now()));
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ uploadFile()

ilExSubmission::uploadFile	(	$a_http_post_files,
		$unzip = `false`
	)

Save submitted file of user.

Definition at line 253 of file class.ilExSubmission.php.

References $ilDB, $query, canAddFile(), getUserId(), ilFileUtils\getValidFilename(), initStorage(), ilUtil\now(), and ilExAssignmentTeam\TEAM_LOG_ADD_FILE.

Referenced by processUploadedZipFile().

         {
                 global $ilDB;
                 
                 if(!$this->canAddFile())
                 {
                         return false;
                 }
                         
                 $deliver_result = $this->initStorage()->uploadFile($a_http_post_files, $this->getUserId(), $unzip);
 
                 if ($deliver_result)
                 {                       
                         $next_id = $ilDB->nextId("exc_returned");
                         $query = sprintf("INSERT INTO exc_returned ".
                                                          "(returned_id, obj_id, user_id, filename, filetitle, mimetype, ts, ass_id, late) ".
                                                          "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
                                 $ilDB->quote($next_id, "integer"),
                                 $ilDB->quote($this->assignment->getExerciseId(), "integer"),
                                 $ilDB->quote($this->getUserId(), "integer"),
                                 $ilDB->quote($deliver_result["fullname"], "text"),
                                 $ilDB->quote(ilFileUtils::getValidFilename($a_http_post_files["name"]), "text"),
                                 $ilDB->quote($deliver_result["mimetype"], "text"),
                                 $ilDB->quote(ilUtil::now(), "timestamp"),
                                 $ilDB->quote($this->assignment->getId(), "integer"),
                                 $ilDB->quote($this->isLate(), "integer")
                         );
                         $ilDB->manipulate($query);
                 
                         if($this->team)
                         {                               
                                 $this->team->writeLog(ilExAssignmentTeam::TEAM_LOG_ADD_FILE, 
                                         $a_http_post_files["name"]);                    
                         }               
                         
                         return true;
                 }               
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validatePeerReviews()

ilExSubmission::validatePeerReviews ( )

Definition at line 81 of file class.ilExSubmission.php.

References $res, $user_id, $valid, and getUserIds().

         {
                 $res = array();                         
                 foreach($this->getUserIds() as $user_id)
                 {                                       
                         $valid = true;
                         
                         // no peer review == valid
                         if($this->peer_review)
                         {
                                 $valid = $this->peer_review->isFeedbackValidForPassed($user_id);
                         }
                         
                         $res[$user_id] = $valid;
                 }
                 return $res;
         }

Here is the call graph for this function:

Field Documentation

◆ $assignment

ilExSubmission::$assignment

protected

Definition at line 12 of file class.ilExSubmission.php.

Referenced by getAssignment().

◆ $is_tutor

ilExSubmission::$is_tutor

protected

Definition at line 16 of file class.ilExSubmission.php.

Referenced by isTutor().

◆ $peer_review

ilExSubmission::$peer_review

protected

Definition at line 15 of file class.ilExSubmission.php.

Referenced by getPeerReview().

◆ $public_submissions

ilExSubmission::$public_submissions

protected

Definition at line 17 of file class.ilExSubmission.php.

◆ $team

ilExSubmission::$team

protected

Definition at line 14 of file class.ilExSubmission.php.

Referenced by deleteUser(), and getTeam().

◆ $user_id

ilExSubmission::$user_id

protected

Definition at line 13 of file class.ilExSubmission.php.

Referenced by __construct(), downloadMultipleFiles(), getUserId(), updateTutorDownloadTime(), and validatePeerReviews().

The documentation for this class was generated from the following file:

Modules/Exercise/classes/class.ilExSubmission.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addResourceObject()

◆ canAddFile()

◆ canSubmit()

◆ canView()

◆ deleteAllFiles()

◆ deleteResourceObject()

◆ deleteSelectedFiles()

◆ deleteUser()

◆ downloadAllAssignmentFiles()

◆ downloadFiles()

◆ downloadMultipleFiles()

◆ downloadSingleFile()

◆ findUserFiles()

◆ getAllAssignmentFiles()

◆ getAssignment()

◆ getDownloadedFilesInfoForTableGUIS()

◆ getFeedbackId()

◆ getFiles()

◆ getLastDownloadTime()

◆ getLastSubmission()

◆ getPeerReview()

◆ getSelectedObject()

◆ getSubmissionType()

◆ getTeam()

◆ getUserId()

◆ getUserIds()

◆ hasAnySubmissions()

◆ hasNoTeamYet()

◆ hasPeerReviewAccess()

◆ hasSubmitted()

◆ initStorage()

◆ isInTeam()

◆ isLate()

◆ isOwner()

◆ isTutor()

◆ lookupExerciseIdForReturnedId()

◆ lookupNewFiles()

◆ processUploadedZipFile()

◆ updateTextSubmission()

◆ updateTutorDownloadTime()

◆ uploadFile()

◆ validatePeerReviews()

Field Documentation

◆ $assignment

◆ $is_tutor

◆ $peer_review

◆ $public_submissions

◆ $team

◆ $user_id