Background task handler for folder downloads. More...

Inheritance diagram for ilFolderDownloadBackgroundTaskHandler:

Collaboration diagram for ilFolderDownloadBackgroundTaskHandler:

Public Member Functions
	__construct ()
	Constructor. More...

	getRefIds ()
	Gets the involved reference ids. More...

	setRefIds ($a_val)
	Sets the involved reference ids. More...

	init ($a_params=null)
	Init background task. More...

Public Member Functions inherited from ilZipBackgroundTaskHandler
	__construct ()
	Constructor. More...

	setDeliveryFilename ($a_value)
	Sets the delivery file name. More...

	getDeliveryFilename ()
	Gets the delivery file name. More...

	getTask ()
	Get current task instance. More...

	process ()
	Process the task. More...

	cancel ()
	Cancel download. More...

	finish ()
	Finish download. More...

	deliver ()
	Deliver file. More...

	deleteTaskAndFiles ()
	Remove task and its files. More...

Static Public Member Functions
static	getInstanceFromTask (ilBackgroundTask $a_task)
	Constructor/Factory. More...

static	isActive ()
	Is folder background download active? More...

static	getObjectListAction ($a_ref_id)
	Get object list action. More...

static	initObjectListAction ()
	init js for background download More...

Protected Member Functions
	gatherFiles ()

	calculateRecursive ($a_ref_ids, &$a_file_count, &$a_file_size)
	Calculates the number and size of the files being downloaded recursively. More...

	recurseFolder ($a_ref_id, $a_title, $a_tmpdir, &$a_current_step)
	Copies a folder and its files to the specified temporary directory. More...

	copyFile ($a_obj_id, $a_title, $a_tmpdir, &$a_current_step)
	Copies a file to the specified temporary directory. More...

	validateAccess ($ref_id)
	Check file access. More...

	getDownloadSizeLimit ()
	Get overall download size limit. More...

	getFileCountThreshold ()
	Get file count threshold. More...

	getTotalSizeThreshold ()
	Get total size threshold. More...

Protected Member Functions inherited from ilZipBackgroundTaskHandler
	setTask (ilBackgroundTask $a_task)
	Set current task instance. More...

	gatherFiles ()
	Copy files to target directory. More...

	deleteTempFiles ($a_delete_zip=true)
	Deletes the temporary files and folders belonging to this download. More...

	getTempFolderPath ()
	Gets the temporary folder path to copy the files and folders to. More...

	getTempZipFilePath ()
	Gets the full path of the temporary zip file that gets created. More...

	getTempBasePath ()
	Gets the temporary base path for all files and folders related to this download. More...

Protected Attributes
	$settings

	$ref_ids = array()

Protected Attributes inherited from ilZipBackgroundTaskHandler
	$task

	$filename

Static Protected Attributes
static	$initialized

Static Private Member Functions
static	renameDuplicateFile ($duplicate_filename)
	bugfix mantis 24309: add a number in round brackets to the filename (in front of the file-type-extension) if there are identically named files in the same folder to prevent an exception being thrown More...

Static Private Attributes
static	$duplicate_files = array()

Detailed Description

Background task handler for folder downloads.

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 12 of file class.ilFolderDownloadBackgroundTaskHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilFolderDownloadBackgroundTaskHandler::__construct ( )

Constructor.

Returns: self

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

References settings().

     {
         parent::__construct();
         $this->settings = new ilSetting("fold");
     }

Here is the call graph for this function:

Member Function Documentation

◆ calculateRecursive()

ilFolderDownloadBackgroundTaskHandler::calculateRecursive	(		$a_ref_ids,
		&	$a_file_count,
		&	$a_file_size
	)

protected

Calculates the number and size of the files being downloaded recursively.

Parameters

array	$a_ref_ids
int	&$a_file_count
int	&$a_file_size

Definition at line 256 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, ilObjFileAccess\_lookupFileSize(), ilObject\_lookupObjId(), ilObject\_lookupType(), array, and validateAccess().

Referenced by init().

     {
         global $DIC;
         $tree = $DIC['tree'];
         
         include_once("./Modules/File/classes/class.ilObjFileAccess.php");
                         
         // parse folders
         foreach ($a_ref_ids as $ref_id) {
             if (!$this->validateAccess($ref_id)) {
                 continue;
             }
             
             // we are only interested in folders and files
             switch (ilObject::_lookupType($ref_id, true)) {
                 case "fold":
                     // get child objects
                     $subtree = $tree->getChildsByTypeFilter($ref_id, array("fold", "file"));
                     if (count($subtree) > 0) {
                         $child_ref_ids = array();
                         foreach ($subtree as $child) {
                             $child_ref_ids[] = $child["ref_id"];
                         }
                         $this->calculateRecursive($child_ref_ids, $a_file_count, $a_file_size);
                     }
                     break;
                     
                 case "file":
                     $a_file_size += ilObjFileAccess::_lookupFileSize(ilObject::_lookupObjId($ref_id));
                     $a_file_count += 1;
                     break;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copyFile()

ilFolderDownloadBackgroundTaskHandler::copyFile	(		$a_obj_id,
			$a_title,
			$a_tmpdir,
		&	$a_current_step
	)

protected

Copies a file to the specified temporary directory.

Parameters

int	$a_obj_id
string	$a_title
string	$a_tmpdir
int	&$a_current_step

Definition at line 338 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References ilObjFile\_lookupAbsolutePath(), ilUtil\getASCIIFilename(), and renameDuplicateFile().

Referenced by gatherFiles(), and recurseFolder().

     {
         // :TODO: every file?
         $this->task->setCurrentStep(++$a_current_step);
         $this->task->save();
         
         $new_filename = $a_tmpdir . "/" . ilUtil::getASCIIFilename($a_title);
 
         // bugfix mantis 24309:
         // alter the filename if there are identically named files in the same folder to prevent overwriting
         if (file_exists($new_filename)) {
             $new_filename = $this->renameDuplicateFile($new_filename);
         }
 
         // copy to temporary directory
         include_once "Modules/File/classes/class.ilObjFile.php";
         $old_filename = ilObjFile::_lookupAbsolutePath($a_obj_id);
         if (!copy($old_filename, $new_filename)) {
             throw new ilFileException("Could not copy " . $old_filename . " to " . $new_filename);
         }
         
         touch($new_filename, filectime($old_filename));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherFiles()

ilFolderDownloadBackgroundTaskHandler::gatherFiles ( )

protected

Definition at line 212 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References copyFile(), ilObjectFactory\getInstanceByRefId(), getRefIds(), ilZipBackgroundTaskHandler\getTempFolderPath(), recurseFolder(), and validateAccess().

     {
         $tmpdir = $this->getTempFolderPath();
         
         $current_step = 0;
                 
         // parse folders
         foreach ($this->getRefIds() as $ref_id) {
             // has been cancelled: hurry up
             if ($this->task->isToBeCancelled()) {
                 return;
             }
             
             if (!$this->validateAccess($ref_id)) {
                 continue;
             }
             
             $object = ilObjectFactory::getInstanceByRefId($ref_id);
             switch ($object->getType()) {
                 case "fold":
                     $this->recurseFolder($ref_id, $object->getTitle(), $tmpdir, $current_step);
                     break;
                                 
                 case "file":
                     $this->copyFile($object->getId(), $object->getTitle(), $tmpdir, $current_step);
                     break;
             }
         }
         
         return $current_step;
     }

Here is the call graph for this function:

◆ getDownloadSizeLimit()

ilFolderDownloadBackgroundTaskHandler::getDownloadSizeLimit ( )

protected

Get overall download size limit.

Returns: int

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

References settings().

Referenced by init().

     {
         return (int) $this->settings->get("bgtask_download_limit", 0);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileCountThreshold()

ilFolderDownloadBackgroundTaskHandler::getFileCountThreshold ( )

protected

Get file count threshold.

Returns: int

Definition at line 448 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References settings().

Referenced by init().

     {
         return (int) $this->settings->get("bgtask_download_tcount", 0);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceFromTask()

static ilFolderDownloadBackgroundTaskHandler::getInstanceFromTask ( ilBackgroundTask $a_task )

static

Constructor/Factory.

Parameters

ilBackgroundTask $a_task

Returns

Implements ilBackgroundTaskHandler.

Definition at line 37 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, $params, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and ilBackgroundTask\getParams().

     {
         global $DIC;
         $tree = $DIC['tree'];
         
         $obj = new self();
         $obj->setTask($a_task);
         
         $params = $a_task->getParams();
         $obj->setRefIds($params["ref_ids"]);
         
         $ref_id = (sizeof($params["ref_ids"]) == 1)
             ? $params["ref_ids"][0]
             : $tree->getParentId($params["ref_ids"][0]);
         $obj->setDeliveryFilename(ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id)));
         
         return $obj;
     }

Here is the call graph for this function:

◆ getObjectListAction()

static ilFolderDownloadBackgroundTaskHandler::getObjectListAction ( $a_ref_id )

static

Get object list action.

See also: ilObjectListGUI::insertCommand()

Parameters

int $a_ref_id

Returns: string

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

Referenced by ilObjectListGUI\insertCommand().

     {
         self::initObjectListAction();
 
         return "il.BgTask.init('" . static::class . "', " . $a_ref_id . ");";
     }

Here is the caller graph for this function:

◆ getRefIds()

ilFolderDownloadBackgroundTaskHandler::getRefIds ( )

Gets the involved reference ids.

Returns: array

Definition at line 77 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $ref_ids.

Referenced by gatherFiles(), and init().

     {
         return $this->ref_ids;
     }

Here is the caller graph for this function:

◆ getTotalSizeThreshold()

ilFolderDownloadBackgroundTaskHandler::getTotalSizeThreshold ( )

protected

Get total size threshold.

Returns: int

Definition at line 458 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References settings().

Referenced by init().

     {
         return (int) $this->settings->get("bgtask_download_tsize", 0);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ init()

ilFolderDownloadBackgroundTaskHandler::init ( $a_params = null )

Init background task.

Parameters

mixed $a_params

Returns: json

Implements ilBackgroundTaskHandler.

Definition at line 141 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, $ilUser, $lng, $res, ilZipBackgroundTaskHandler\$task, array, calculateRecursive(), ilZipBackgroundTaskHandler\finish(), ilUtil\formatSize(), ilBackgroundTask\getActiveByUserId(), ilBackgroundTaskJson\getBlockedJson(), getDownloadSizeLimit(), ilBackgroundTaskJson\getFailedJson(), getFileCountThreshold(), ilBackgroundTaskJson\getFinishedJson(), ilBackgroundTaskJson\getProcessingJson(), getRefIds(), getTotalSizeThreshold(), ilZipBackgroundTaskHandler\process(), setRefIds(), ilZipBackgroundTaskHandler\setTask(), ilBackgroundTask\STATUS_FINISHED, and ilBackgroundTask\STATUS_INITIALIZED.

     {
         global $DIC;
         $lng = $DIC['lng'];
         $ilUser = $DIC['ilUser'];
         
         if ($a_params) {
             $this->setRefIds(explode(",", $a_params));
         }
         
         $file_count = $total_bytes = 0;
         $this->calculateRecursive($this->getRefIds(), $file_count, $total_bytes);
         
         include_once "Services/BackgroundTask/classes/class.ilBackgroundTaskJson.php";
         
         // empty folder - nothing to do
         if (!$file_count) {
             $json = ilBackgroundTaskJson::getFailedJson($lng->txt("bgtask_empty_folder"));
         } else {
             // check if below download size limit
             $size_limit_mb = $this->getDownloadSizeLimit() * 1024 * 1024;
             if ($size_limit_mb > 0 && $total_bytes > $size_limit_mb) {
                 $json = ilBackgroundTaskJson::getFailedJson(sprintf($lng->txt("bgtask_download_too_large"), ilUtil::formatSize($size_limit_mb)));
             } else {
                 // set up task instance
                 include_once "Services/BackgroundTask/classes/class.ilBackgroundTask.php";
                 $task = new ilBackgroundTask();
                 $task->setHandlerId(get_class($this));
                 $task->setUserId($ilUser->getId());
                 $task->setParams(array(
                     "ref_ids" => $this->getRefIds()
                 ));
                 $task->setSteps($file_count+1); // +1 = create zip
                 $task->setStatus(ilBackgroundTask::STATUS_INITIALIZED);
                 $task->save();
                 
                 $this->setTask($task);
                 
                 // above thresholds: do background task
                 if ($file_count >= $this->getFileCountThreshold()
                     || $total_bytes >= $this->getTotalSizeThreshold() * 1024 * 1024) {
                     // check for other tasks from same user
                     $existing = ilBackgroundTask::getActiveByUserId($ilUser->getId());
                     if (sizeof($existing)) {
                         $json = ilBackgroundTaskJson::getBlockedJson($task->getId());
                     } else {
                         $json = ilBackgroundTaskJson::getProcessingJson(
                             $task->getId(),
                             sprintf($lng->txt("bgtask_download_long"), $file_count, ilUtil::formatSize($total_bytes)),
                             $file_count+1
                         );
                     }
                 }
                 // below thresholds: direct download
                 else {
                     $this->process();
                     
                     $task->setStatus(ilBackgroundTask::STATUS_FINISHED);
                     $task->save();
                     
                     $res = $this->finish();
                     
                     // see ilBackgroundTaskHub::progress()
                     $json = ilBackgroundTaskJson::getFinishedJson($task->getId(), $res[0], $res[1]);
                 }
             }
         }
         
         return $json;
     }

Here is the call graph for this function:

◆ initObjectListAction()

static ilFolderDownloadBackgroundTaskHandler::initObjectListAction ( )

static

init js for background download

Definition at line 115 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, $ilCtrl, $tpl, $url, array, and ilModalGUI\initJS().

Referenced by ilContainerContentGUI\renderItem().

     {
         // js init only needed once per request
         if (!self::$initialized) {
             global $DIC;
             $tpl = $DIC['tpl'];
             $ilCtrl = $DIC['ilCtrl'];
 
             $url =  $ilCtrl->getLinkTargetByClass(array("ilrepositorygui", "ilobjfoldergui", "ilbackgroundtaskhub"), "", "", true, false);
 
             $tpl->addJavaScript("Services/BackgroundTask/js/BgTask.js");
             $tpl->addOnLoadCode('il.BgTask.setAjax("' . $url . '");');
 
             // enable modals from js
             include_once "Services/UIComponent/Modal/classes/class.ilModalGUI.php";
             ilModalGUI::initJS();
 
             self::$initialized = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isActive()

static ilFolderDownloadBackgroundTaskHandler::isActive ( )

static

Is folder background download active?

Returns: boolean

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

References $settings.

Referenced by ilObjectListGUI\insertCommand().

     {
         $settings = new ilSetting("fold");
         return (bool) $settings->get("bgtask_download", false);
     }

Here is the caller graph for this function:

◆ recurseFolder()

ilFolderDownloadBackgroundTaskHandler::recurseFolder	(		$a_ref_id,
			$a_title,
			$a_tmpdir,
		&	$a_current_step
	)

protected

Copies a folder and its files to the specified temporary directory.

Parameters

int	$a_ref_id
string	$a_title
string	$a_tmpdir
int	&$a_current_step

Definition at line 299 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, array, copyFile(), ilUtil\getASCIIFilename(), ilUtil\makeDir(), and validateAccess().

Referenced by gatherFiles().

     {
         global $DIC;
         $tree = $DIC['tree'];
         
         $tmpdir = $a_tmpdir . "/" . ilUtil::getASCIIFilename($a_title);
         ilUtil::makeDir($tmpdir);
         
         $subtree = $tree->getChildsByTypeFilter($a_ref_id, array("fold", "file"));
         foreach ($subtree as $child) {
             // has been cancelled: hurry up
             if ($this->task->isToBeCancelled()) {
                 return;
             }
             
             if (!$this->validateAccess($child["ref_id"])) {
                 continue;
             }
             
             switch ($child["type"]) {
                 case "fold":
                     $this->recurseFolder($child["ref_id"], $child["title"], $tmpdir, $a_current_step);
                     break;
                 
                 case "file":
                     $this->copyFile($child["obj_id"], $child["title"], $tmpdir, $a_current_step);
                     break;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renameDuplicateFile()

static ilFolderDownloadBackgroundTaskHandler::renameDuplicateFile ( $duplicate_filename )

staticprivate

bugfix mantis 24309: add a number in round brackets to the filename (in front of the file-type-extension) if there are identically named files in the same folder to prevent an exception being thrown

Parameters

$duplicate_filename string filename including path and extension

Returns: string

Definition at line 372 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References ilZipBackgroundTaskHandler\$filename, and $path.

Referenced by copyFile().

     {
         // determine the copy_number that will be added to the filename either by obtaining it from
         // the entry of the current file in the duplicate_files-array or use 1 if there is no entry yet
         $copy_number = 1;
         $duplicate_has_array_entry = false;
         foreach (self::$duplicate_files as &$duplicate_file) {
             if ($duplicate_file['file_name'] == $duplicate_filename) {
                 $duplicate_has_array_entry = true;
                 $copy_number = $duplicate_file['copy_number'];
                 // increment the copy_number for correctly renaming the next duplicate of this file
                 $duplicate_file['copy_number']++;
             }
         }
 
         // create an array entry for the duplicate file if there isn't one to ensure that the
         // copy_number can be determined correctly for other duplicates of this file
         if (!$duplicate_has_array_entry) {
             self::$duplicate_files[] = [
                 'file_name'   => $duplicate_filename,
                 'copy_number' => 2 // set as 2 because 1 is already used for this duplicate
             ];
         }
 
         // rename the file
         $path = pathinfo($duplicate_filename, PATHINFO_DIRNAME);
         $filename = pathinfo($duplicate_filename, PATHINFO_FILENAME);
         $extension = pathinfo($duplicate_filename, PATHINFO_EXTENSION);
         $new_filename = $path . "/" . $filename . " (" . $copy_number . ")." . $extension;
 
         return $new_filename;
     }

Here is the caller graph for this function:

◆ setRefIds()

ilFolderDownloadBackgroundTaskHandler::setRefIds ( $a_val )

Sets the involved reference ids.

Parameters

array $a_val

Definition at line 87 of file class.ilFolderDownloadBackgroundTaskHandler.php.

Referenced by init().

     {
         $this->ref_ids = $a_val;
     }

Here is the caller graph for this function:

◆ validateAccess()

ilFolderDownloadBackgroundTaskHandler::validateAccess ( $ref_id )

protected

Check file access.

Parameters

int $ref_id

Returns: boolean

Definition at line 412 of file class.ilFolderDownloadBackgroundTaskHandler.php.

References $DIC, and ilObject\_isInTrash().

Referenced by calculateRecursive(), gatherFiles(), and recurseFolder().

     {
         global $DIC;
         $ilAccess = $DIC['ilAccess'];
         
         if (!$ilAccess->checkAccess("read", "", $ref_id)) {
             return false;
         }
 
         if (ilObject::_isInTrash($ref_id)) {
             return false;
         }
         
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $duplicate_files

ilFolderDownloadBackgroundTaskHandler::$duplicate_files = array()

staticprivate

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

◆ $initialized

ilFolderDownloadBackgroundTaskHandler::$initialized

staticprotected

Definition at line 20 of file class.ilFolderDownloadBackgroundTaskHandler.php.

◆ $ref_ids

ilFolderDownloadBackgroundTaskHandler::$ref_ids = array()

protected

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

Referenced by getRefIds().

◆ $settings

ilFolderDownloadBackgroundTaskHandler::$settings

protected

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

Referenced by isActive().

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

Services/BackgroundTask/classes/class.ilFolderDownloadBackgroundTaskHandler.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ calculateRecursive()

◆ copyFile()

◆ gatherFiles()

◆ getDownloadSizeLimit()

◆ getFileCountThreshold()

◆ getInstanceFromTask()

◆ getObjectListAction()

◆ getRefIds()

◆ getTotalSizeThreshold()

◆ init()

◆ initObjectListAction()

◆ isActive()

◆ recurseFolder()

◆ renameDuplicateFile()

◆ setRefIds()

◆ validateAccess()

Field Documentation

◆ $duplicate_files

◆ $initialized

◆ $ref_ids

◆ $settings