ilCollectWorkspaceFilesJob Class Reference

Description of class class. More...

Inheritance diagram for ilCollectWorkspaceFilesJob:

Collaboration diagram for ilCollectWorkspaceFilesJob:

Public Member Functions
	__construct ()
	getInputTypes ()
	getOutputType ()
	isStateless ()
	run (array $input, \ILIAS\BackgroundTasks\Observer $observer)
	getExpectedTimeOfTaskInSeconds ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns Value[] More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	setInput (array $values)
	getOutput ()
	getInput ()
	getType ()
	unfoldTask ()
	Unfold the task. More...
	getRemoveOption ()
	Returns Option An Option to remove the current task and do some cleanup if possible. This Option is displayed if the Bucket is completed. You do not have to provide an additional Option to remove in your UserInteraction, the remove-Option is added to the list of Options (last position) See also self::getAbortOption(); More...
	getAbortOption ()
	Returns Option In case a Job is failed or did not respond for some time, an Abort-Option is displayed. There is already a Standard-Abort-Option registered, you can override with your own and do some cleanup if possible. More...
	getType ()
	getInputTypes ()
	getOutputType ()
	getOutput ()
	setInput (array $values)
	getInput ()
	unfoldTask ()
	getRemoveOption ()
	getAbortOption ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Task\Job
	run (array $input, Observer $observer)
	isStateless ()
	getInput ()
	getExpectedTimeOfTaskInSeconds ()

Protected Attributes
ilWorkspaceTree	$tree
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
ILIAS BackgroundTasks Value	$output

Private Member Functions
	getFileDirs (int $a_wsp_id, string $a_file_name, string $a_temp_dir)
	recurseFolder (int $a_wsp_id, string $a_folder_name, string $a_temp_dir, int $a_num_recursions, bool $a_initiated_by_folder_action)

Private Attributes
ilLogger	$logger = null

Additional Inherited Members
Data Fields inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
const	MAIN_REMOVE = 'bt_main_remove'
const	MAIN_ABORT = 'bt_main_abort'
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)
	extractType ($value)

Detailed Description

Description of class class.

Author

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

Definition at line 30 of file class.ilCollectWorkspaceFilesJob.php.

Constructor & Destructor Documentation

__construct()

ilCollectWorkspaceFilesJob::__construct

(

)

Definition at line 35 of file class.ilCollectWorkspaceFilesJob.php.

    {
        global $DIC;
 
        $user = $DIC->user();
 
        $this->logger = ilLoggerFactory::getLogger("pwsp");
        $this->tree = new ilWorkspaceTree($user->getId());
    }

References $DIC, ilLoggerFactory\getLogger(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

getExpectedTimeOfTaskInSeconds()

ilCollectWorkspaceFilesJob::getExpectedTimeOfTaskInSeconds

(

)

Returns

int the amount of seconds this task usually taskes. If your task-duration scales with the the amount of data, try to set a possible high value of try to calculate it. If a task duration exceeds this value, it will be displayed as "possibly failed" to the user

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 176 of file class.ilCollectWorkspaceFilesJob.php.

                                                    : int
    {
        return 30;
    }

getFileDirs()

ilCollectWorkspaceFilesJob::getFileDirs ( int  $a_wsp_id, string  $a_file_name, string  $a_temp_dir  )

private

Definition at line 107 of file class.ilCollectWorkspaceFilesJob.php.

     : ?array {
        global $DIC;
 
        $user = $DIC->user();
        $ilAccess = new ilWorkspaceAccessHandler($this->tree);
        if ($ilAccess->checkAccessOfUser($this->tree, $user->getId(), "read", "", $a_wsp_id)) {
            $file = new ilObjFile($this->tree->lookupObjectId($a_wsp_id), false);
            $source_dir = $file->getFile($file->getVersion());
            if (!is_file($source_dir)) {
                $source_dir = $file->getFile();
            }
            $target_dir = $a_temp_dir . '/' . ilFileUtils::getASCIIFilename($a_file_name);
 
            return [
                "source_dir" => $source_dir,
                "target_dir" => $target_dir
            ];
        }
        return null;
    }

Referenced by run().

Here is the caller graph for this function:

getInputTypes()

ilCollectWorkspaceFilesJob::getInputTypes

(

)

Returns

Type[] A list of types that are taken as input.

Implements ILIAS\BackgroundTasks\Task.

Definition at line 45 of file class.ilCollectWorkspaceFilesJob.php.

                                   : array
    {
        return
            [
                new SingleType(ilWorkspaceCopyDefinition::class),
                new SingleType(BooleanValue::class)
            ];
    }

getOutputType()

ilCollectWorkspaceFilesJob::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

Definition at line 54 of file class.ilCollectWorkspaceFilesJob.php.

                                   : Type
    {
        return new SingleType(ilWorkspaceCopyDefinition::class);
    }

isStateless()

ilCollectWorkspaceFilesJob::isStateless

(

)

Returns

bool returns true iff the job's output ONLY depends on the input. Stateless task results may be cached!

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 59 of file class.ilCollectWorkspaceFilesJob.php.

                                 : bool
    {
        return true;
    }

recurseFolder()

ilCollectWorkspaceFilesJob::recurseFolder ( int  $a_wsp_id, string  $a_folder_name, string  $a_temp_dir, int  $a_num_recursions, bool  $a_initiated_by_folder_action  )

private

Definition at line 132 of file class.ilCollectWorkspaceFilesJob.php.

     : array {
        $num_recursions = $a_num_recursions + 1;
        $tree = $this->tree;
        $ilAccess = new ilWorkspaceAccessHandler($this->tree);
        $files = array();
 
        // Avoid the duplication of the uppermost folder when the download is initiated via a folder's action drop-down
        // by not including said folders name in the temp_dir path.
        if (($num_recursions <= 1) and ($a_initiated_by_folder_action)) {
            $temp_dir = $a_temp_dir;
        } else {
            $temp_dir = $a_temp_dir . '/' . ilFileUtils::getASCIIFilename($a_folder_name);
        }
 
 
        $subtree = $tree->getChildsByTypeFilter($a_wsp_id, array("wfld","file"));
 
        foreach ($subtree as $child) {
            if (!$ilAccess->checkAccess("read", "", $child["child"])) {
                continue;
            }
            if ($child["type"] == "wfld") {
                $files_from_folder = $this->recurseFolder($child["child"], $child['title'], $temp_dir, $num_recursions, $a_initiated_by_folder_action);
                $files = array_merge($files, $files_from_folder);
            } elseif (($child["type"] == "file") and ($this->getFileDirs($child["child"], $child['title'], $temp_dir) != false)) {
                $files[] = $this->getFileDirs((int) $child["wsp_id"], $child['title'], $temp_dir);
            }
        }
        // ensure that empty folders are also contained in the downloaded zip
        if (empty($subtree)) {
            $files[] = [
                "source_dir" => "",
                "target_dir" => $temp_dir . '/'
            ];
        }
        return $files;
    }

Referenced by run().

Here is the caller graph for this function:

run()

ilCollectWorkspaceFilesJob::run	(	array	$input,
		\ILIAS\BackgroundTasks\Observer	$observer
	)

Definition at line 64 of file class.ilCollectWorkspaceFilesJob.php.

                                                                                : Value
    {
        $this->logger->debug('Start collecting files!');
        $this->logger->dump($input);
        $definition = $input[0];
        $initiated_by_folder_action = $input[1]->getValue();
        $object_wps_ids = $definition->getObjectWspIds();
        $files = array();
 
        foreach ($object_wps_ids as $object_wps_id) {
            $obj_id = $this->tree->lookupObjectId($object_wps_id);
            $object_type = ilObject::_lookupType($obj_id);
            $object_name = ilObject::_lookupTitle($obj_id);
            $object_temp_dir = ""; // empty as content will be added in recurseFolder and getFileDirs
 
            if ($object_type == "wfld") {
                $num_recursions = 0;
                $files_from_folder = $this->recurseFolder($object_wps_id, $object_name, $object_temp_dir, $num_recursions, $initiated_by_folder_action);
                $files = array_merge($files, $files_from_folder);
            } elseif (($object_type == "file") and ($this->getFileDirs($object_wps_id, $object_name, $object_temp_dir) != false)) {
                $files[] = $this->getFileDirs($object_wps_id, $object_name, $object_temp_dir);
            }
        }
        $this->logger->debug('Collected files:');
        $this->logger->dump($files);
 
        $num_files = 0;
        foreach ($files as $file) {
            $definition->addCopyDefinition($file['source_dir'], $file['target_dir']);
            $this->logger->debug('Added new copy definition: ' . $file['source_dir'] . ' -> ' . $file['target_dir']);
 
            // count files only (without empty directories)
            $is_empty_folder = preg_match_all("/\/$/", $file['target_dir']);
            if (!$is_empty_folder) {
                $num_files++;
            }
        }
        $definition->setObjectWspIds($object_wps_ids);
        $definition->setNumFiles($num_files);
 
        return $definition;
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, ilObject\_lookupTitle(), ilObject\_lookupType(), getFileDirs(), ILIAS\Repository\logger(), and recurseFolder().

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilCollectWorkspaceFilesJob::$logger = null

private

Definition at line 32 of file class.ilCollectWorkspaceFilesJob.php.

$tree

ilWorkspaceTree ilCollectWorkspaceFilesJob::$tree

protected

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

---

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

• Modules/WorkspaceFolder/BackgroundTask/classes/class.ilCollectWorkspaceFilesJob.php