This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilFSStorageExercise:

Collaboration diagram for ilFSStorageExercise:

Public Member Functions
	__construct (int $a_container_id=0, int $a_ass_id=0)

	init ()
	Append ass_<ass_id> to path (assignment id) More...

	getAbsoluteSubmissionPath ()

	getTempPath ()

	getFeedbackPath (string $a_user_id)

	getGlobalFeedbackPath ()

	getMultiFeedbackUploadPath (int $a_user_id)
	Get multi feedback upload path (each uploader handled in a separate path) More...

	getPeerReviewUploadPath (int $a_peer_id, int $a_giver_id, ?int $a_crit_id=null)
	Get pear review upload path (each peer handled in a separate path) More...

	create ()
	Create directory. More...

	getFiles ()

	uploadFile (array $a_http_post_file, int $user_id, bool $is_unziped=false)
	store delivered file in filesystem More...

	addFileUpload (\ILIAS\FileUpload\DTO\UploadResult $result, int $user_id)
	store delivered file in filesystem More...

	getFeedbackFiles (string $a_user_id)

	countFeedbackFiles (string $a_user_id)

	getAssignmentFilePath (string $a_file)

	getFeedbackFilePath (string $a_user_id, string $a_file)

	uploadAssignmentFiles (array $a_files)

Public Member Functions inherited from ilFileSystemAbstractionStorage
	__construct (int $a_storage_type, bool $a_path_conversion, int $a_container_id)
	Constructor. More...

	fileExists (string $a_absolute_path)

	getContainerId ()

	writeToFile (string $a_data, $a_absolute_path)

	copyFile (string $a_from, string $a_to)

	create ()

	getAbsolutePath ()
	Calculates the full path on the filesystem. More...

	delete ()

	deleteDirectory (string $a_abs_name)

	deleteFile (string $a_abs_name)

	appendToPath (string $a_appendix)

	getStorageType ()

	getPath ()

Protected Member Functions
	getRelativeSubmissionPath ()

	getPathPostfix ()

	getPathPrefix ()

	getStorageFilename (string $filename)

Protected Member Functions inherited from ilFileSystemAbstractionStorage
	getLegacyFullAbsolutePath (string $relative_path)

	getFileSystemService ()

	getPathPrefix ()
	Get path prefix. More...

	getPathPostfix ()
	Get directory name. More...

	getLegacyAbsolutePath ()
	Calculates the absolute filesystem storage location. More...

	init ()

Protected Attributes
string	$relative_submission_path

ILIAS FileUpload FileUpload	$upload

int	$ass_id

string	$submission_path

string	$tmp_path

string	$feedb_path

string	$multi_feedback_upload_path

string	$peer_review_upload_path

Protected Attributes inherited from ilFileSystemAbstractionStorage
string	$path = null

ILIAS Filesystem Filesystems	$file_system_service

Additional Inherited Members
Static Public Member Functions inherited from ilFileSystemAbstractionStorage
static	createPathFromId (int $a_container_id, string $a_name)

static	_copyDirectory (string $a_sdir, string $a_tdir)

Data Fields inherited from ilFileSystemAbstractionStorage
const	STORAGE_WEB = 1

const	STORAGE_DATA = 2

const	STORAGE_SECURED = 3

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 22 of file class.ilFSStorageExercise.php.

Constructor & Destructor Documentation

◆ __construct()

ilFSStorageExercise::__construct	(	int	$a_container_id = `0`,
		int	$a_ass_id = `0`
	)

Definition at line 33 of file class.ilFSStorageExercise.php.

References $DIC, ILIAS\MetaData\Repository\Validation\Data\__construct(), and ILIAS\Repository\upload().

       {
         global $DIC;
 
         $this->ass_id = $a_ass_id;
         parent::__construct(self::STORAGE_DATA, true, $a_container_id);
         $this->upload = $DIC->upload();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addFileUpload()

ilFSStorageExercise::addFileUpload	(	\ILIAS\FileUpload\DTO\UploadResult	$result,
		int	$user_id
	)

store delivered file in filesystem

Parameters

array	$a_http_post_file
int	$user_id
bool	$is_unziped

Returns: ?array result array with filename and mime type of the saved file

Exceptions

ilException
ilFileUtilsException

Definition at line 282 of file class.ilFSStorageExercise.php.

References $filename, create(), getRelativeSubmissionPath(), getStorageFilename(), and ILIAS\Repository\upload().

      : ?array {
         $this->create();
 
         $filename = $result->getName();
         $filename = $this->getStorageFilename($filename);
 
         $savepath = $this->getRelativeSubmissionPath();
         $savepath .= '/' . $user_id;
 
         $now = getdate();
         $prefix = sprintf(
             "%04d%02d%02d%02d%02d%02d",
             $now["year"],
             $now["mon"],
             $now["mday"],
             $now["hours"],
             $now["minutes"],
             $now["seconds"]
         );
 
         $this->upload->moveOneFileTo(
             $result,
             $savepath,
             \ILIAS\FileUpload\Location::STORAGE,
             $prefix . "_" . $filename,
             true
         );
 
         $result = array(
             "filename" => $prefix . "_" . $filename,
             "fullname" => $savepath . "/" . $prefix . "_" . $filename,
             "mimetype" => $result->getMimeType()
         );
 
         return $result;
     }

Here is the call graph for this function:

◆ countFeedbackFiles()

ilFSStorageExercise::countFeedbackFiles ( string $a_user_id )

Definition at line 346 of file class.ilFSStorageExercise.php.

References getFeedbackFiles().

Referenced by ilExerciseSubmissionTableGUI\parseColumns().

      : int {
         $fbf = $this->getFeedbackFiles($a_user_id);
         return count($fbf);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilFSStorageExercise::create ( )

Create directory.

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

References ilFileUtils\makeDirParents().

Referenced by ilExAssignmentPeerReviewTableGUI\__construct(), ilExerciseXMLParser\__construct(), addFileUpload(), ilExSubmission\downloadAllAssignmentFiles(), ilExPeerReviewGUI\executeCommand(), ilExerciseManagementGUI\executeCommand(), ilExPeerReviewGUI\getPeerReviewReceiverPanel(), ilExerciseDataSet\importRecord(), and uploadFile().

                             : void
     {
         parent::create();
         if (!file_exists($this->submission_path)) {
             ilFileUtils::makeDirParents($this->submission_path);
         }
         if (!file_exists($this->tmp_path)) {
             ilFileUtils::makeDirParents($this->tmp_path);
         }
         if (!file_exists($this->feedb_path)) {
             ilFileUtils::makeDirParents($this->feedb_path);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAbsoluteSubmissionPath()

ilFSStorageExercise::getAbsoluteSubmissionPath ( )

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

References $submission_path.

Referenced by uploadFile().

                                                : string
     {
         return $this->submission_path;
     }

Here is the caller graph for this function:

◆ getAssignmentFilePath()

ilFSStorageExercise::getAssignmentFilePath ( string $a_file )

Definition at line 353 of file class.ilFSStorageExercise.php.

References ilFileSystemAbstractionStorage\getAbsolutePath().

                                                          : string
     {
         return $this->getAbsolutePath() . "/" . $a_file;
     }

Here is the call graph for this function:

◆ getFeedbackFilePath()

ilFSStorageExercise::getFeedbackFilePath	(	string	$a_user_id,
		string	$a_file
	)

Definition at line 358 of file class.ilFSStorageExercise.php.

References getFeedbackPath().

      : string {
         $dir = $this->getFeedbackPath($a_user_id);
         return $dir . "/" . $a_file;
     }

Here is the call graph for this function:

◆ getFeedbackFiles()

ilFSStorageExercise::getFeedbackFiles ( string $a_user_id )

Returns: string[]

Definition at line 325 of file class.ilFSStorageExercise.php.

References getFeedbackPath().

Referenced by countFeedbackFiles().

      : array {
         $files = array();
 
         if ($a_user_id === "t") {   // team assignment without team, see #36253
             return[];
         }
 
         $dir = $this->getFeedbackPath($a_user_id);
         if (is_dir($dir)) {
             $dp = opendir($dir);
             while ($file = readdir($dp)) {
                 if (!is_dir($this->path . '/' . $file) && substr($file, 0, 1) != ".") {
                     $files[] = $file;
                 }
             }
         }
         return $files;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFeedbackPath()

ilFSStorageExercise::getFeedbackPath ( string $a_user_id )

Definition at line 91 of file class.ilFSStorageExercise.php.

References ilFileSystemAbstractionStorage\$path, and ilFileUtils\makeDirParents().

Referenced by getFeedbackFilePath(), and getFeedbackFiles().

      : string {
         $path = $this->feedb_path . "/" . $a_user_id;
         if (!file_exists($path)) {
             ilFileUtils::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFiles()

ilFSStorageExercise::getFiles ( )

Definition at line 161 of file class.ilFSStorageExercise.php.

References ilArrayUtil\sortArray().

Referenced by ilObjExercise\update().

                               : array
     {
         $files = array();
         if (!is_dir($this->path)) {
             return $files;
         }
 
         $dp = opendir($this->path);
         while ($file = readdir($dp)) {
             if (!is_dir($this->path . '/' . $file)) {
                 $files[] = array(
                     'name' => $file,
                     'size' => filesize($this->path . '/' . $file),
                     'ctime' => filectime($this->path . '/' . $file),
                     'fullpath' => $this->path . '/' . $file);
             }
         }
         closedir($dp);
         return ilArrayUtil::sortArray($files, "name", "asc");
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getGlobalFeedbackPath()

ilFSStorageExercise::getGlobalFeedbackPath ( )

Definition at line 101 of file class.ilFSStorageExercise.php.

References ilFileSystemAbstractionStorage\$path, and ilFileUtils\makeDirParents().

                                            : string
     {
         $path = $this->feedb_path . "/0";
         if (!file_exists($path)) {
             ilFileUtils::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

◆ getMultiFeedbackUploadPath()

ilFSStorageExercise::getMultiFeedbackUploadPath ( int $a_user_id )

Get multi feedback upload path (each uploader handled in a separate path)

Definition at line 114 of file class.ilFSStorageExercise.php.

References ilFileSystemAbstractionStorage\$path, and ilFileUtils\makeDirParents().

      : string {
         $path = $this->multi_feedback_upload_path . "/" . $a_user_id;
         if (!file_exists($path)) {
             ilFileUtils::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

◆ getPathPostfix()

ilFSStorageExercise::getPathPostfix ( )

protected

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

                                        : string
     {
         return 'exc';
     }

◆ getPathPrefix()

ilFSStorageExercise::getPathPrefix ( )

protected

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

                                       : string
     {
         return 'ilExercise';
     }

◆ getPeerReviewUploadPath()

ilFSStorageExercise::getPeerReviewUploadPath	(	int	$a_peer_id,
		int	$a_giver_id,
		?int	$a_crit_id = `null`
	)

Get pear review upload path (each peer handled in a separate path)

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

References ilFileSystemAbstractionStorage\$path, ILIAS\Repository\int(), and ilFileUtils\makeDirParents().

Referenced by ilExPeerReviewGUI\executeCommand(), and ilExcCriteriaFile\initStorage().

      : string {
         $path = $this->peer_review_upload_path . "/" . $a_peer_id . "/" . $a_giver_id . "/";
 
         if ((int) $a_crit_id !== 0) {
             $path .= (int) $a_crit_id . "/";
         }
         if (!file_exists($path)) {
             ilFileUtils::makeDirParents($path);
         }
         return $path;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRelativeSubmissionPath()

ilFSStorageExercise::getRelativeSubmissionPath ( )

protected

Definition at line 44 of file class.ilFSStorageExercise.php.

References $relative_submission_path.

Referenced by addFileUpload().

                                                   : string
     {
         return $this->relative_submission_path;
     }

Here is the caller graph for this function:

◆ getStorageFilename()

ilFSStorageExercise::getStorageFilename ( string $filename )

protected

Definition at line 260 of file class.ilFSStorageExercise.php.

References $DIC, $filename, and ilFileUtils\getValidFilename().

Referenced by addFileUpload(), and uploadFile().

                                                            : string
     {
         global $DIC;
 
         $filename = ilFileUtils::getValidFilename($filename);
         // replace whitespaces with underscores
         $filename = preg_replace("/\s/", "_", $filename);
         $filename = (new \ilFileServicesPolicy($DIC->fileServiceSettings()))->ascii($filename);
         // remove all special characters
         $filename = preg_replace("/[^_a-zA-Z0-9\.]/", "", $filename);
         return $filename;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempPath()

ilFSStorageExercise::getTempPath ( )

Definition at line 86 of file class.ilFSStorageExercise.php.

References $tmp_path.

                                  : string
     {
         return $this->tmp_path;
     }

◆ init()

ilFSStorageExercise::init ( )

Append ass_<ass_id> to path (assignment id)

Definition at line 52 of file class.ilFSStorageExercise.php.

References $ass_id, ilFileSystemAbstractionStorage\getAbsolutePath(), and init().

                           : bool
     {
         if (parent::init()) {
             if ($this->ass_id > 0) {
                 $this->submission_path = $this->getAbsolutePath() . "/subm_" . $this->ass_id;
                 $this->relative_submission_path = $this->path . "/subm_" . $this->ass_id;
                 ;
                 $this->tmp_path = $this->getAbsolutePath() . "/tmp_" . $this->ass_id;
                 $this->feedb_path = $this->getAbsolutePath() . "/feedb_" . $this->ass_id;
                 $this->multi_feedback_upload_path = $this->getAbsolutePath() . "/mfb_up_" . $this->ass_id;
                 $this->peer_review_upload_path = $this->getAbsolutePath() . "/peer_up_" . $this->ass_id;
                 $this->path .= "/ass_" . $this->ass_id;
             }
         } else {
             return false;
         }
         return true;
     }

Here is the call graph for this function:

◆ uploadAssignmentFiles()

ilFSStorageExercise::uploadAssignmentFiles ( array $a_files )

Exceptions

ilException

Definition at line 369 of file class.ilFSStorageExercise.php.

References ilFileSystemAbstractionStorage\getAbsolutePath(), and ilFileUtils\moveUploadedFile().

      : void {
         if (is_array($a_files["name"])) {
             foreach ($a_files["name"] as $k => $name) {
                 if ($name != "") {
                     $tmp_name = $a_files["tmp_name"][$k];
                     ilFileUtils::moveUploadedFile(
                         $tmp_name,
                         basename($name),
                         $this->getAbsolutePath() . DIRECTORY_SEPARATOR . basename($name),
                         false
                     );
                 }
             }
         }
     }

Here is the call graph for this function:

◆ uploadFile()

ilFSStorageExercise::uploadFile	(	array	$a_http_post_file,
		int	$user_id,
		bool	$is_unziped = `false`
	)

store delivered file in filesystem

Parameters

array	$a_http_post_file
int	$user_id
bool	$is_unziped

Returns: ?array result array with filename and mime type of the saved file

Exceptions

ilException
ilFileUtilsException

Deprecated:: use addFileUpload instead

Definition at line 197 of file class.ilFSStorageExercise.php.

References $filename, create(), getAbsoluteSubmissionPath(), ilObjMediaObject\getMimeType(), getStorageFilename(), ilFileUtils\makeDir(), ilFileUtils\moveUploadedFile(), and ilFileUtils\rename().

      : ?array {
         $this->create();
         // TODO:
         // CHECK UPLOAD LIMIT
 
         //
         $result = null;
         if (isset($a_http_post_file) && $a_http_post_file['size']) {
             $filename = $a_http_post_file['name'];
 
             $filename = $this->getStorageFilename($filename);
 
             if (!is_dir($savepath = $this->getAbsoluteSubmissionPath())) {
                 ilFileUtils::makeDir($savepath);
             }
             $savepath .= '/' . $user_id;
             if (!is_dir($savepath)) {
                 ilFileUtils::makeDir($savepath);
             }
 
             // CHECK IF FILE PATH EXISTS
             if (!is_dir($savepath)) {
                 ilFileUtils::makeDir($savepath);
             }
             $now = getdate();
             $prefix = sprintf(
                 "%04d%02d%02d%02d%02d%02d",
                 $now["year"],
                 $now["mon"],
                 $now["mday"],
                 $now["hours"],
                 $now["minutes"],
                 $now["seconds"]
             );
 
             if (!$is_unziped) {
                 ilFileUtils::moveUploadedFile(
                     $a_http_post_file["tmp_name"],
                     $prefix . "_" . $filename,
                     $savepath . "/" . $prefix . "_" . $filename
                 );
             } else {
                 ilFileUtils::rename(
                     $a_http_post_file['tmp_name'],
                     $savepath . "/" . $prefix . "_" . $filename
                 );
             }
 
             if (is_file($savepath . "/" . $prefix . "_" . $filename)) {
                 $result = array(
                     "filename" => $prefix . "_" . $filename,
                     "fullname" => $savepath . "/" . $prefix . "_" . $filename,
                     "mimetype" => ilObjMediaObject::getMimeType($savepath . "/" . $prefix . "_" . $filename)
                 );
             }
         }
         return $result;
     }