ilExSubmission Class Reference

Exercise submission //TODO: This class has to much static methods related to delivered "files". 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)
	Get submission items (not only files) More...
	lookupNewFiles ($a_tutor=null)
	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 ()
	getTableUserWhere ($a_team_mode=false)
	Get user/team where clause. More...
	getLastSubmission ()
	TODO -> get rid of getTableUserWhere and move to repository class Get the date of the last submission of a user for the assignment. More...
	getLastOpeningHTMLView ()
	TODO -> get rid of getTableUserWhere and move to repository class Get a mysql timestamp from the last HTML view opening. More...
	addResourceObject ($a_wsp_id, $a_text=null)
	Add personal resource or repository object (ref_id) 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	getAllAssignmentFiles ($a_exc_id, $a_ass_id)
static	getAssignmentFilesByUsers (int $a_exc_id, int $a_ass_id, array $a_users)
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, $to_path)
	Download all submitted files of an assignment (all user) More...
static	getSubmissionsForFilename ($a_filename, $a_assignment_types=array())
	Get assignment return entries for a filename. More...
static	getDirectoryNameFromUserData ($a_user_id)
static	getAssignmentParticipants (int $a_exercise_id, int $a_ass_id)

Data Fields
const	TYPE_FILE = "File"
const	TYPE_OBJECT = "Object"
const	TYPE_TEXT = "Text"
const	TYPE_REPO_OBJECT = "RepoObject"

Protected Member Functions
	isLate ()
	initStorage ()
	getStorageId ()
	Get storage id. More...
	getLastDownloadTime (array $a_user_ids)
	downloadSingleFile ($a_user_id, $filename, $filetitle, $a_team_id)
	downloadMultipleFiles ($a_filenames, $a_user_id, $a_multi_user=false)

Protected Attributes
	$user
	$db
	$lng
	$ctrl
	$assignment
	$user_id
	$team
	$peer_review
	$is_tutor
	$public_submissions
	$ass_type
	$ass_types

Detailed Description

Exercise submission //TODO: This class has to much static methods related to delivered "files".

Extract them to classes.

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 11 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 55 of file class.ilExSubmission.php.

References $DIC, $ilUser, $user_id, ilExAssignment\getAssignmentType(), ilExAssignment\getId(), ilExAssignmentTypes\getInstance(), ilExcAssMemberState\getInstanceByIds(), ilExAssignmentTeam\getInstanceByUserId(), ilExAssignment\hasTeam(), and user().

    {
        global $DIC;

        $this->user = $DIC->user();
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->ctrl = $DIC->ctrl();
        $ilUser = $DIC->user();
        
        $this->assignment = $a_ass;
        $this->ass_type = $this->assignment->getAssignmentType();
        $this->ass_types = ilExAssignmentTypes::getInstance();

        $this->user_id = $a_user_id;
        $this->is_tutor = (bool) $a_is_tutor;
        $this->public_submissions = (bool) $a_public_submissions;

        $this->state = ilExcAssMemberState::getInstanceByIds($a_ass->getId(), $a_user_id);
        
        if ($a_ass->hasTeam()) {
            if (!$a_team) {
                $this->team = ilExAssignmentTeam::getInstanceByUserId($this->assignment->getId(), $this->user_id);
            } else {
                $this->team = $a_team;
            }
        }
        
        if ($this->assignment->getPeerReview()) {
            $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 or repository object (ref_id) to assigment.

Parameters

int	$a_wsp_id
string	$a_text

Returns

int

Exceptions

ilExerciseException

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

References $db, $ilDB, $query, $user_id, getAssignment(), getSubmissionsForFilename(), getSubmissionType(), getTeam(), getUserId(), isLate(), ilUtil\now(), and TYPE_REPO_OBJECT.

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

    {
        $ilDB = $this->db;

        if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
            $user_id = 0;
            $team_id = $this->getTeam()->getId();
        } else {
            $user_id = $this->getUserId();
            $team_id = 0;
        }

        // repository objects must be unique in submissions
        // the same repo object cannot be used in different submissions or even different assignment/exercises
        // why? -> the access handling would fail, since the access depends e.g. on teams or even phase of the
        // assignment
        if ($this->getAssignment()->getAssignmentType()->getSubmissionType() == ilExSubmission::TYPE_REPO_OBJECT) {
            $repos_ass_type_ids = $this->ass_types->getIdsForSubmissionType(ilExSubmission::TYPE_REPO_OBJECT);
            $subs = $this->getSubmissionsForFilename($a_wsp_id, $repos_ass_type_ids);
            if (count($subs) > 0) {
                throw new ilExerciseException("Repository object $a_wsp_id is already assigned to another assignment.");
            }
        }

        $next_id = $ilDB->nextId("exc_returned");
        $query = sprintf(
            "INSERT INTO exc_returned " .
                         "(returned_id, obj_id, user_id, filetitle, ass_id, ts, atext, late, team_id) " .
                         "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s)",
            $ilDB->quote($next_id, "integer"),
            $ilDB->quote($this->assignment->getExerciseId(), "integer"),
            $ilDB->quote($user_id, "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->quote($team_id, "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 252 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 185 of file class.ilExSubmission.php.

References isOwner().

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

    {
        return ($this->isOwner() &&
            $this->state->isSubmissionAllowed());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

canView()

ilExSubmission::canView

(

)

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

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

Referenced by ilExSubmissionGUI\getOverviewContent().

    {
        $ilUser = $this->user;
        
        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 616 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 1273 of file class.ilExSubmission.php.

References $db, $ilDB, and getTableUserWhere().

Referenced by ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), and ilExSubmissionObjectGUI\unlinkPortfolioObject().

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

Here is the call graph for this function:

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 633 of file class.ilExSubmission.php.

References $db, $filename, $ilDB, $result, getAssignment(), getTableUserWhere(), initStorage(), and ilExAssignmentTeam\TEAM_LOG_REMOVE_FILE.

Referenced by deleteAllFiles().

    {
        $ilDB = $this->db;


        $where = " AND " . $this->getTableUserWhere(true);


        if (!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") .
                $where);
            
            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") .
                    $where);
                
                // 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"]
                            );
                        }

                        if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
                            $storage_id = $value["team_id"];
                        } else {
                            $storage_id = $value["user_id"];
                        }

                        $filename = $path . "/" . $storage_id . "/" . basename($value["filename"]);
                        if (file_exists($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 695 of file class.ilExSubmission.php.

References $team, and ilExAssignment\getInstancesByExercise().

Referenced by ilExerciseMembers\deassignMember().

    {
        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,   $to_path  )

static

Download all submitted files of an assignment (all user)

Parameters

$a_ass	ilExAssignment
$members	array of user names, key is user id
$to_path	string

Exceptions

ilExerciseException

Returns

void

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

References $ass_type, $DIC, $lng, $user, ilObject\_lookupObjId(), ilObject\_lookupType(), ilFSStorageExercise\create(), ilUtil\delDir(), ilUtil\dirsize(), ilUtil\escapeShellArg(), ilUtil\getASCIIFilename(), ilExAssignmentTeam\getAssignmentTeamMap(), ilExAssignment\getAssignmentType(), ilExAssignment\getExerciseId(), ilExAssignment\getId(), ilExAssignment\getType(), ilExAssignment\hasTeam(), ilUtil\makeDir(), ilExAssignment\TYPE_BLOG, ilExAssignment\TYPE_PORTFOLIO, and ilUtil\unzip().

Referenced by ilExerciseManagementCollectFilesJob\collectSubmissionFiles(), and ilExerciseManagementGUI\downloadAllObject().

    {
        global $DIC;

        $lng = $DIC->language();
        
        $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());

        $tmpdir = $storage->getTempPath();
        chdir($tmpdir);
        $zip = PATH_TO_ZIP;

        // 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;
            }

            // 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;
            }

            if ($a_ass->getAssignmentType()->isSubmissionAssignedToTeam()) {
                $targetdir = $team_dir . ilUtil::getASCIIFilename(
                    $item["name"]
                );
                if ($targetdir == "") {
                    continue;
                }
            } else {
                $targetdir = self::getDirectoryNameFromUserData($id);
                if ($a_ass->getAssignmentType()->usesTeams()) {
                    $targetdir = $team_dir . $targetdir;
                }
            }
            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);
                }

                if ($a_ass->getAssignmentType()->getSubmissionType() == self::TYPE_REPO_OBJECT) {
                    $obj_id = ilObject::_lookupObjId($targetfile);
                    $obj_type = ilObject::_lookupType($obj_id);
                    $targetfile = $obj_type . "_" . $obj_id . ".zip";
                }

                
                // #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?
                if (is_array($user_files)) {    // see #23900
                    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)) {
                    throw new ilExerciseException("Could not copy " . basename($sourcefile) . " to '" . $targetfile . "'.");
                } 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);
                    }
                }
            }
        }
        $tmpzipfile = ilUtil::getASCIIFilename($lng->txt("exc_ass_submission_zip")) . ".zip";
        // Safe mode fix
        $zipcmd = $zip . " -r " . ilUtil::escapeShellArg($tmpzipfile) . " .";
        exec($zipcmd);
        //$path_final_zip_file = $to_path.DIRECTORY_SEPARATOR."Submissions/".$tmpzipfile;
        $path_final_zip_file = $to_path . DIRECTORY_SEPARATOR . $tmpzipfile;

        if (file_exists($tmpdir . DIRECTORY_SEPARATOR . $tmpzipfile)) {
            copy($tmpzipfile, $path_final_zip_file);
            ilUtil::delDir($tmpdir);

            //unzip the submissions zip file.(decided to unzip to allow the excel link the files more obvious when blog/portfolio)
            chdir($to_path);
            //TODO Bug in ilUtil -> if flat unzip fails. We can get rid of creating Submissions directory
            //ilUtil::unzip($path_final_zip_file,FALSE, TRUE);
            ilUtil::unzip($path_final_zip_file);
            unlink($path_final_zip_file);
        }

        chdir($cdir);
    }

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 728 of file class.ilExSubmission.php.

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

    {
        $ilUser = $this->user;
        $lng = $this->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;

                    // @todo: generalize
                    case ilExAssignment::TYPE_WIKI_TEAM:
                        $file["filetitle"] = ilObject::_lookupTitle($this->assignment->getExerciseId()) . " - " .
                            $this->assignment->getTitle() . " (Team " . $this->getTeam()->getId() . ").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;
                } elseif ($file["late"]) {
                    $file["filetitle"] = $lng->txt("exc_late_submission") . " - " .
                        $file["filetitle"];
                }

                $this->downloadSingleFile($file["user_id"], $file["filename"], $file["filetitle"], $file["team_id"]);
            } else {
                $array_files = array();
                foreach ($files as $seq => $file) {
                    if ($this->assignment->getAssignmentType()->isSubmissionAssignedToTeam()) {
                        $storage_id = $file["team_id"];
                    } else {
                        $storage_id = $file["user_id"];
                    }

                    $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[$storage_id][] = array(
                            "src" => $src,
                            "tgt" => $tgt
                        );
                    } else {
                        $array_files[$storage_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 875 of file class.ilExSubmission.php.

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

Referenced by downloadFiles().

    {
        $lng = $this->lng;
        
        $path = $this->initStorage()->getAbsoluteSubmissionPath();
        
        $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 $storage_id => $files) {
            $pathname = $path . "/" . $storage_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,   $a_team_id  )

protected

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

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

Referenced by downloadFiles().

    {
        if ($this->ass_type->isSubmissionAssignedToTeam()) {
            $storage_id = $a_team_id;
        } else {
            $storage_id = $a_user_id;
        }

        $filename = $this->initStorage()->getAbsoluteSubmissionPath() .
            "/" . $storage_id . "/" . basename($filename);

        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 599 of file class.ilExSubmission.php.

References $DIC, $ilDB, and $res.

Referenced by ilBlogExercise\getAssignmentsOfBlog(), and ilPortfolioExercise\getAssignmentsOfPortfolio().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $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 408 of file class.ilExSubmission.php.

References $ass_type, $DIC, $ilDB, $query, $res, ilExAssignmentTypes\getInstance(), and ilExAssignment\lookupType().

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

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $storage = new ilFSStorageExercise($a_exc_id, $a_ass_id);
        $path = $storage->getAbsoluteSubmissionPath();

        $ass_type = ilExAssignmentTypes::getInstance()->getById(ilExAssignment::lookupType($a_ass_id));

        $query = "SELECT * FROM exc_returned WHERE ass_id = " .
            $ilDB->quote($a_ass_id, "integer");

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            if ($ass_type->isSubmissionAssignedToTeam()) {
                $storage_id = $row["team_id"];
            } else {
                $storage_id = $row["user_id"];
            }

            $row["timestamp"] = $row["ts"];
            $row["filename"] = $path . "/" . $storage_id . "/" . basename($row["filename"]);
            $delivered[] = $row;
        }
        
        return $delivered ? $delivered : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignment()

ilExSubmission::getAssignment

(

)

Returns

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

References $assignment.

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

    {
        return $this->assignment;
    }

Here is the caller graph for this function:

getAssignmentFilesByUsers()

static ilExSubmission::getAssignmentFilesByUsers ( int  $a_exc_id, int  $a_ass_id, array  $a_users  )

static

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

References $ass_type, $DIC, $ilDB, $query, $res, ilExAssignmentTypes\getInstance(), and ilExAssignment\lookupType().

Referenced by ilExerciseManagementGUI\listTextAssignmentObject().

                                                                                                   : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $storage = new ilFSStorageExercise($a_exc_id, $a_ass_id);
        $path = $storage->getAbsoluteSubmissionPath();

        $ass_type = ilExAssignmentTypes::getInstance()->getById(ilExAssignment::lookupType($a_ass_id));

        $query = "SELECT * FROM exc_returned WHERE ass_id = " .
            $ilDB->quote($a_ass_id, "integer") .
            " AND user_id IN (" . implode(',', $a_users) . ")";

        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            if ($ass_type->isSubmissionAssignedToTeam()) {
                $storage_id = $row["team_id"];
            } else {
                $storage_id = $row["user_id"];
            }

            $row["timestamp"] = $row["ts"];
            $row["filename"] = $path . "/" . $storage_id . "/" . basename($row["filename"]);
            $delivered[] = $row;
        }

        return $delivered ? $delivered : array();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignmentParticipants()

static ilExSubmission::getAssignmentParticipants ( int  $a_exercise_id, int  $a_ass_id  )

static

Parameters

$a_exercise_id
$a_ass_id

Returns

array

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

References $DIC, $ilDB, $query, and $res.

Referenced by ilExerciseManagementGUI\listTextAssignmentObject().

                                                                                        : array
    {
        global $DIC;

        $ilDB = $DIC->database();

        $participants = array();
        $query = "SELECT user_id FROM exc_returned WHERE ass_id = " .
            $ilDB->quote($a_ass_id, "integer") .
            " AND obj_id = " .
            $ilDB->quote($a_exercise_id, "integer");

        $res = $ilDB->query($query);

        while ($row = $ilDB->fetchAssoc($res)) {
            $participants[] = $row['user_id'];
        }

        return $participants;
    }

Here is the caller graph for this function:

getDirectoryNameFromUserData()

static ilExSubmission::getDirectoryNameFromUserData (   $a_user_id )

static

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

References ilObjUser\_lookupName(), and ilUtil\getASCIIFilename().

Referenced by ilExerciseManagementCollectFilesJob\addLink(), ilExerciseManagementCollectFilesJob\createTargetDirectory(), ilExerciseManagementCollectFilesJob\getFeedbackDirectory(), ilDownloadSubmissionsBackgroundTask\run(), and ilExerciseManagementCollectFilesJob\run().

    {
        $userName = ilObjUser::_lookupName($a_user_id);
        $targetdir = ilUtil::getASCIIFilename(
            trim($userName["lastname"]) . "_" .
            trim($userName["firstname"]) . "_" .
            trim($userName["login"]) . "_" .
            $userName["user_id"]
        );

        return $targetdir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDownloadedFilesInfoForTableGUIS()

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

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

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        
        $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_tbl_action_download_files");
                    } else {
                        $result["files"]["download_txt"] = $lng->txt("exc_tbl_action_download_all_files");
                    }
                    
                    // 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_tbl_action_download_new_files");
                    }
                }
                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_tbl_action_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_tbl_action_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_tbl_action_text_assignment_show");
                    }
                }
                break;

            case ilExAssignment::TYPE_WIKI_TEAM:
                $result["files"]["txt"] = $lng->txt("exc_wiki_returned");
                $objs = $this->getFiles();
                if ($objs) {
                    $objs = array_pop($objs);
                    if ($objs && substr($objs["filename"], -1) != "/") {
                        if ($objs["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_tbl_action_download_files");
                    }
                }
                break;
        }
        
        $ilCtrl->setParameterByClass("ilexsubmissionfilegui", "member_id", "");
        
        return $result;
    }

Here is the call graph for this function:

getFeedbackId()

ilExSubmission::getFeedbackId

(

)

Definition at line 163 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
	)

Get submission items (not only files)

Todo:

this also returns non-file entries, rename this, see dev.txt.php

Parameters

array | null	$a_file_ids
bool	$a_only_valid
null	$a_min_timestamp

Returns

array

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

References $db, $ilDB, $result, getAssignment(), getTableUserWhere(), and initStorage().

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

    {
        $ilDB = $this->db;
        
        $sql = "SELECT * FROM exc_returned" .
            " WHERE ass_id = " . $ilDB->quote($this->getAssignment()->getId(), "integer");

        $sql .= " AND " . $this->getTableUserWhere(true);


        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);

                if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
                    $storage_id = $row["team_id"];
                } else {
                    $storage_id = $row["user_id"];
                }


                $row["filename"] = $path .
                    "/" . $storage_id . "/" . basename($row["filename"]);

                // see 22301, 22719
                if (is_file($row["filename"]) || (!$this->assignment->getAssignmentType()->usesFileUpload())) {
                    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 714 of file class.ilExSubmission.php.

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

Referenced by downloadFiles().

    {
        $ilDB = $this->db;
        $ilUser = $this->user;
    
        $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:

getLastOpeningHTMLView()

ilExSubmission::getLastOpeningHTMLView

(

)

TODO -> get rid of getTableUserWhere and move to repository class Get a mysql timestamp from the last HTML view opening.

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

References $data, $res, ilUtil\getMySQLTimestamp(), and getTableUserWhere().

    {
        $this->db->setLimit(1);

        $q = "SELECT web_dir_access_time FROM exc_returned" .
            " WHERE ass_id = " . $this->db->quote($this->assignment->getId(), "integer") .
            " AND (filename IS NOT NULL OR atext IS NOT NULL)" .
            " AND web_dir_access_time IS NOT NULL" .
            " AND " . $this->getTableUserWhere(true) .
            " ORDER BY web_dir_access_time DESC";

        $res = $this->db->query($q);

        $data = $this->db->fetchAssoc($res);

        return ilUtil::getMySQLTimestamp($data["web_dir_access_time"]);
    }

Here is the call graph for this function:

getLastSubmission()

ilExSubmission::getLastSubmission

(

)

TODO -> get rid of getTableUserWhere and move to repository class 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 1172 of file class.ilExSubmission.php.

References $db, $ilDB, ilUtil\getMySQLTimestamp(), and getTableUserWhere().

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

    {
        $ilDB = $this->db;
    
        $ilDB->setLimit(1);

        $q = "SELECT obj_id,user_id,ts FROM exc_returned" .
            " WHERE ass_id = " . $ilDB->quote($this->assignment->getId(), "integer") .
            " AND " . $this->getTableUserWhere(true) .
            " 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

(

)

Returns

Definition at line 126 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 177 of file class.ilExSubmission.php.

References getFiles().

Referenced by ilObjWikiGUI\getAssignmentButtons(), ilBlogExerciseGUI\getDownloadSubmissionButton(), ilBlogExerciseGUI\getExerciseInfo(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

    {
        $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:

getStorageId()

ilExSubmission::getStorageId ( )

protected

Get storage id.

Returns

int

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

References getTeam(), and getUserId().

Referenced by uploadFile().

    {
        if ($this->ass_type->isSubmissionAssignedToTeam()) {
            $storage_id = $this->getTeam()->getId();
        } else {
            $storage_id = $this->getUserId();
        }
        return $storage_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubmissionsForFilename()

static ilExSubmission::getSubmissionsForFilename (   $a_filename,   $a_assignment_types = array()  )

static

Get assignment return entries for a filename.

Parameters

string	$a_filename
	int[]	$a_assignment_types

Returns

array

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

References $db, $DIC, and $query.

Referenced by addResourceObject(), ilExcRepoObjAssignmentInfo\getInfo(), and ilObjWikiListGUI\getProperties().

    {
        global $DIC;

        $db = $DIC->database();

        $query = "SELECT * FROM exc_returned r LEFT JOIN exc_assignment a" .
            " ON (r.ass_id = a.id) " .
            " WHERE r.filetitle = " . $db->quote($a_filename, "string");

        if (is_array($a_assignment_types) && count($a_assignment_types) > 0) {
            $query .= " AND " . $db->in("a.type", $a_assignment_types, false, "integer");
        }

        $set = $db->query($query);
        $rets = array();
        while ($rec = $db->fetchAssoc($set)) {
            $rets[] = $rec;
        }


        return $rets;
    }

Here is the caller graph for this function:

getSubmissionType()

ilExSubmission::getSubmissionType

(

)

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

Referenced by addResourceObject(), and ilExSubmissionGUI\getOverviewContent().

    {
        return $this->assignment->getAssignmentType()->getSubmissionType();
        /*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:

getTableUserWhere()

ilExSubmission::getTableUserWhere

(

$a_team_mode = false

)

Get user/team where clause.

Parameters

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

References $db, $ilDB, getAssignment(), getTeam(), getUserId(), and getUserIds().

Referenced by deleteResourceObject(), deleteSelectedFiles(), getFiles(), getLastOpeningHTMLView(), getLastSubmission(), and lookupNewFiles().

    {
        $ilDB = $this->db;

        if ($this->getAssignment()->getAssignmentType()->isSubmissionAssignedToTeam()) {
            $team_id = $this->getTeam()->getId();
            $where = " team_id = " . $ilDB->quote($team_id, "integer") . " ";
        } else {
            if ($a_team_mode) {
                $where = " " . $ilDB->in("user_id", $this->getUserIds(), "", "integer") . " ";
            } else {
                $where = " user_id = " . $ilDB->quote($this->getUserId(), "integer");
            }
        }
        return $where;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTeam()

ilExSubmission::getTeam

(

)

Returns

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

References $team.

Referenced by addResourceObject(), downloadFiles(), ilExSubmissionTeamGUI\getOverviewContent(), getStorageId(), getTableUserWhere(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), and uploadFile().

    {
        return $this->team;
    }

Here is the caller graph for this function:

getUserId()

ilExSubmission::getUserId

(

)

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

References $user_id.

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

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

getUserIds()

ilExSubmission::getUserIds

(

)

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

References hasNoTeamYet().

Referenced by downloadFiles(), getTableUserWhere(), ilExAssTypeWikiTeam\handleNewUpload(), isInTeam(), 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:

hasNoTeamYet()

ilExSubmission::hasNoTeamYet

(

)

Definition at line 220 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 246 of file class.ilExSubmission.php.

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

hasSubmitted()

ilExSubmission::hasSubmitted

(

)

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

References getFiles().

Referenced by ilExSubmissionTeamGUI\getOverviewContent(), ilExSubmissionObjectGUI\getOverviewContentBlog(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilExAssTypeWikiTeam\handleNewUpload(), ilExcAssMemberState\isGlobalFeedbackFileAccessible(), and ilExAssTypeWikiTeamGUI\renderOverviewContent().

    {
        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 279 of file class.ilExSubmission.php.

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

    {
        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 229 of file class.ilExSubmission.php.

References $ilUser, $user, and getUserIds().

Referenced by canView().

    {
        $ilUser = $this->user;
        
        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 272 of file class.ilExSubmission.php.

Referenced by addResourceObject(), and updateTextSubmission().

    {
        $dl = $this->state->getOfficialDeadline();
        //$dl = $this->assignment->getPersonalDeadline($this->getUserId());
        return ($dl && $dl < time());
    }

Here is the caller graph for this function:

isOwner()

ilExSubmission::isOwner

(

)

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

References $ilUser, $user, and getUserId().

Referenced by canSubmit().

    {
        $ilUser = $this->user;
        
        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 215 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 578 of file class.ilExSubmission.php.

References $DIC, and $ilDB.

Referenced by ilObjMediaObject\getParentObjectIdForUsage().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $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

(

$a_tutor = null

)

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

Parameters

tutor

integer

Returns

array

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

References $db, $ilDB, $ilUser, $user, getAssignment(), and getTableUserWhere().

Referenced by getDownloadedFilesInfoForTableGUIS().

    {
        $ilDB = $this->db;
        $ilUser = $this->user;

        $tutor = ($a_tutor)
            ? $a_tutor
            : $ilUser->getId();

        $where = " AND " . $this->getTableUserWhere(true);

        $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") .
            $where .
            " AND exc_usr_tutor.tutor_id = " . $ilDB->quote($tutor, "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 360 of file class.ilExSubmission.php.

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

    {
        $lng = $this->lng;
        
        // Create unzip-directory
        $newDir = ilUtil::ilTempnam();
        ilUtil::makeDir($newDir);

        $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") . " [Zip1]", 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") . " [Zip2]", 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 1290 of file class.ilExSubmission.php.

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

    {
        $ilDB = $this->db;
        
        $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 836 of file class.ilExSubmission.php.

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

Referenced by downloadFiles().

    {
        $ilUser = $this->user;
        $ilDB = $this->db;
                
        $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 303 of file class.ilExSubmission.php.

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

Referenced by processUploadedZipFile().

    {
        $ilDB = $this->db;

        if (!$this->canAddFile()) {
            return false;
        }

        if ($this->ass_type->isSubmissionAssignedToTeam()) {
            $team_id = $this->getTeam()->getId();
            $user_id = 0;
            if ($team_id == 0) {
                return false;
            }
        } else {
            $team_id = 0;
            $user_id = $this->getUserId();
        }
        $storage_id = $this->getStorageId();

        $deliver_result = $this->initStorage()->uploadFile($a_http_post_files, $storage_id, $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, team_id) " .
                             "VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s)",
                $ilDB->quote($next_id, "integer"),
                $ilDB->quote($this->assignment->getExerciseId(), "integer"),
                $ilDB->quote($user_id, "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->quote($team_id, "integer")
            );
            $ilDB->manipulate($query);
        
            if ($this->team) {
                $this->team->writeLog(
                    ilExAssignmentTeam::TEAM_LOG_ADD_FILE,
                    $a_http_post_files["name"]
                );
            }
            
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

validatePeerReviews()

ilExSubmission::validatePeerReviews

(

)

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

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

Referenced by ilExAssTypeWikiTeam\handleNewUpload().

    {
        $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:

Here is the caller graph for this function:

Field Documentation

$ass_type

ilExSubmission::$ass_type

protected

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

Referenced by downloadAllAssignmentFiles(), getAllAssignmentFiles(), and getAssignmentFilesByUsers().

$ass_types

ilExSubmission::$ass_types

protected

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

$assignment

ilExSubmission::$assignment

protected

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

Referenced by getAssignment().

$ctrl

ilExSubmission::$ctrl

protected

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

Referenced by getDownloadedFilesInfoForTableGUIS().

$db

ilExSubmission::$db

protected

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

Referenced by addResourceObject(), deleteResourceObject(), deleteSelectedFiles(), getFiles(), getLastDownloadTime(), getLastSubmission(), getSubmissionsForFilename(), getTableUserWhere(), lookupNewFiles(), updateTextSubmission(), updateTutorDownloadTime(), and uploadFile().

$is_tutor

ilExSubmission::$is_tutor

protected

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

Referenced by isTutor().

$lng

ilExSubmission::$lng

protected

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

Referenced by downloadAllAssignmentFiles(), downloadFiles(), downloadMultipleFiles(), getDownloadedFilesInfoForTableGUIS(), and processUploadedZipFile().

$peer_review

ilExSubmission::$peer_review

protected

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

Referenced by getPeerReview().

$public_submissions

ilExSubmission::$public_submissions

protected

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

$team

ilExSubmission::$team

protected

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

Referenced by deleteUser(), and getTeam().

$user

ilExSubmission::$user

protected

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

Referenced by canView(), downloadAllAssignmentFiles(), downloadFiles(), getLastDownloadTime(), isInTeam(), isOwner(), lookupNewFiles(), and updateTutorDownloadTime().

$user_id

ilExSubmission::$user_id

protected

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

Referenced by __construct(), addResourceObject(), getUserId(), updateTutorDownloadTime(), uploadFile(), and validatePeerReviews().

TYPE_FILE

const ilExSubmission::TYPE_FILE = "File"

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

Referenced by ilExAssTypeUpload\getSubmissionType(), and ilExAssTypeUploadTeam\getSubmissionType().

TYPE_OBJECT

const ilExSubmission::TYPE_OBJECT = "Object"

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

Referenced by ilExAssTypeBlog\getSubmissionType(), and ilExAssTypePortfolio\getSubmissionType().

TYPE_REPO_OBJECT

const ilExSubmission::TYPE_REPO_OBJECT = "RepoObject"

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

Referenced by addResourceObject(), ilExSubmissionGUI\executeCommand(), ilExcRepoObjAssignmentInfo\getInfo(), ilExSubmissionGUI\getOverviewContent(), and ilExAssTypeWikiTeam\getSubmissionType().

TYPE_TEXT

const ilExSubmission::TYPE_TEXT = "Text"

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

Referenced by ilExAssTypeText\getSubmissionType().

---

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

• Modules/Exercise/classes/class.ilExSubmission.php