ilCheckSumOfFileSizesJob Class Reference

Description of class class. More...

Inheritance diagram for ilCheckSumOfFileSizesJob:

Collaboration diagram for ilCheckSumOfFileSizesJob:

Public Member Functions
	__construct ()
	Construct. More...
	getInputTypes ()
	getOutputType ()
	isStateless ()
	run (array $input, Observer $observer)
	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 More...
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractJob
	getInput ()
	Returns array returns the input array 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...

Protected Member Functions
	calculateRecursive (array $a_ref_ids, int &$a_file_size)
	Calculates the number and size of the files being downloaded recursively. More...
	validateAccess (int $ref_id)
	Check file access. More...
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes ($values)
	extractType ($value)

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

Private Attributes
readonly ilLogger	$logger

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

Lukas Zehnder lz@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

__construct()

ilCheckSumOfFileSizesJob::__construct

(

)

Construct.

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

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

    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
        $this->settings = new ilSetting("fold");
    }

Here is the call graph for this function:

Member Function Documentation

calculateRecursive()

ilCheckSumOfFileSizesJob::calculateRecursive ( array  $a_ref_ids, int &  $a_file_size  )

protected

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

Definition at line 117 of file class.ilCheckSumOfFileSizesJob.php.

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

Referenced by run().

                                                                              : void
    {
        global $DIC;
        $tree = $DIC['tree'];

        // 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, ["fold", "file"]);
                    if (count($subtree) > 0) {
                        $child_ref_ids = [];
                        foreach ($subtree as $child) {
                            $child_ref_ids[] = $child["ref_id"];
                        }
                        $this->calculateRecursive($child_ref_ids, $a_file_size);
                    }
                    break;

                case "file":
                    $a_file_size += ilObjFileAccess::_lookupFileSize($ref_id);
                    break;
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExpectedTimeOfTaskInSeconds()

ilCheckSumOfFileSizesJob::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 170 of file class.ilCheckSumOfFileSizesJob.php.

                                                    : int
    {
        return 30;
    }

getInputTypes()

ilCheckSumOfFileSizesJob::getInputTypes

(

)

Implements ILIAS\BackgroundTasks\Task.

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

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

getOutputType()

ilCheckSumOfFileSizesJob::getOutputType

(

)

Implements ILIAS\BackgroundTasks\Task.

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

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

isStateless()

ilCheckSumOfFileSizesJob::isStateless

(

)

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 73 of file class.ilCheckSumOfFileSizesJob.php.

                                 : bool
    {
        return true;
    }

run()

ilCheckSumOfFileSizesJob::run	(	array	$input,
		Observer	$observer
	)

Todo:

use filesystem service

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 83 of file class.ilCheckSumOfFileSizesJob.php.

References $general, calculateRecursive(), and ILIAS\Repository\logger().

                                                         : Value
    {
        $this->logger->debug('Start checking adherence to maxsize!');
        $this->logger->dump($input);
        $definition = $input[0];
        $object_ref_ids = $definition->getObjectRefIds();

        // get global limit (max sum of individual file-sizes) from file settings
        $general = new General();
        $size_limit = $general->getDownloadLimitinMB();
        $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_ref_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;
    }

Here is the call graph for this function:

validateAccess()

ilCheckSumOfFileSizesJob::validateAccess ( int  $ref_id )

protected

Check file access.

Definition at line 155 of file class.ilCheckSumOfFileSizesJob.php.

References $DIC, and ilObject\_isInTrash().

Referenced by calculateRecursive().

                                                  : bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];

        if (!$ilAccess->checkAccess("read", "", $ref_id)) {
            return false;
        }
        return !ilObject::_isInTrash($ref_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$logger

readonly ilLogger ilCheckSumOfFileSizesJob::$logger

private

Definition at line 34 of file class.ilCheckSumOfFileSizesJob.php.

$settings

ilSetting ilCheckSumOfFileSizesJob::$settings

protected

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

---

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

• components/ILIAS/BackgroundTasks_/classes/Jobs/class.ilCheckSumOfFileSizesJob.php