Description of class class. More...

Inheritance diagram for ilCheckSumOfWorkspaceFileSizesJob:

Collaboration diagram for ilCheckSumOfWorkspaceFileSizesJob:

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 Member Functions
	calculateRecursive (array $object_wps_ids, int &$a_file_size)
	Calculates the number and size of the files being downloaded recursively. More...

	validateAccess (int $wsp_id)

Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)

	extractType ($value)

Protected Attributes
ilSetting	$settings

ilWorkspaceTree	$tree

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

ILIAS BackgroundTasks Value	$output

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'

Detailed Description

Description of class class.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCheckSumOfWorkspaceFileSizesJob::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ calculateRecursive()

ilCheckSumOfWorkspaceFileSizesJob::calculateRecursive	(	array	$object_wps_ids,
		int &	$a_file_size
	)

protected

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

Definition at line 98 of file class.ilCheckSumOfWorkspaceFileSizesJob.php.

     : void {
        global $DIC;
        $tree = $DIC['tree'];
 
        // parse folders
        foreach ($object_wps_ids as $object_wps_id) {
            if (!$this->validateAccess($object_wps_id)) {
                continue;
            }
 
            // we are only interested in folders and files
            $obj_id = $this->tree->lookupObjectId($object_wps_id);
            $type = ilObject::_lookupType($obj_id);
            switch ($type) {
                case "wfld":
                    // get child objects
                    $subtree = $tree->getChildsByTypeFilter($object_wps_id, array("wfld", "file"));
                    if (count($subtree) > 0) {
                        $child_wsp_ids = array();
                        foreach ($subtree as $child) {
                            $child_wsp_ids[] = $child["child"];
                        }
                        $this->calculateRecursive($child_wsp_ids, $a_file_size);
                    }
                    break;
 
                case "file":
                    $a_file_size += ilObjFileAccess::_lookupFileSize($obj_id, false);
                    break;
            }
        }
    }

References $tree, $type, ilObjFileAccess\_lookupFileSize(), ilObject\_lookupType(), calculateRecursive(), ilTree\getChildsByTypeFilter(), and validateAccess().

Referenced by calculateRecursive(), and run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExpectedTimeOfTaskInSeconds()

ilCheckSumOfWorkspaceFileSizesJob::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 145 of file class.ilCheckSumOfWorkspaceFileSizesJob.php.

◆ getInputTypes()

ilCheckSumOfWorkspaceFileSizesJob::getInputTypes ( )

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

Implements ILIAS\BackgroundTasks\Task.

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

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

◆ getOutputType()

ilCheckSumOfWorkspaceFileSizesJob::getOutputType ( )

Implements ILIAS\BackgroundTasks\Task.

Definition at line 56 of file class.ilCheckSumOfWorkspaceFileSizesJob.php.

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

◆ isStateless()

ilCheckSumOfWorkspaceFileSizesJob::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 61 of file class.ilCheckSumOfWorkspaceFileSizesJob.php.

                                 : bool
    {
        return true;
    }

◆ run()

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

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

                                                                                : Value
    {
        $this->logger->debug('Start checking adherence to maxsize!');
        $this->logger->dump($input);
        $definition = $input[0];
        $object_wps_ids = $definition->getObjectWspIds();
 
        // get global limit (max sum of individual file-sizes) from file settings
        $size_limit = (int) $this->settings->get("bgtask_download_limit", '0');
        $size_limit_bytes = $size_limit * 1024 * 1024;
        $this->logger->debug('Global limit (max sum of all file-sizes) in file-settings: ' . $size_limit_bytes . ' bytes');
        // get sum of individual file-sizes
        $total_bytes = 0;
        $this->calculateRecursive($object_wps_ids, $total_bytes);
        $this->logger->debug('Calculated sum of all file-sizes: ' . $total_bytes . 'MB');
        // check if calculated total size adheres top global limit
        $adheres_to_limit = new BooleanValue();
        $adheres_to_limit->setValue(true);
        if ($total_bytes > $size_limit_bytes) {
            $adheres_to_limit->setValue(false);
        }
 
        $definition->setSumFileSizes($total_bytes);
        $definition->setAdheresToLimit($adheres_to_limit);
 
        return $definition;
    }

References ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask\$input, calculateRecursive(), ILIAS\Repository\int(), ILIAS\Repository\logger(), and ILIAS\Repository\settings().

Here is the call graph for this function:

◆ validateAccess()

ilCheckSumOfWorkspaceFileSizesJob::validateAccess ( int $wsp_id )

protected

Definition at line 134 of file class.ilCheckSumOfWorkspaceFileSizesJob.php.

                                                  : bool
    {
        $ilAccess = new ilWorkspaceAccessHandler($this->tree);
 
        if (!$ilAccess->checkAccess("read", "", $wsp_id)) {
            return false;
        }
 
        return true;
    }