ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
ilCheckSumOfFileSizesJob Class Reference

Description of class class. More...

+ Inheritance diagram for ilCheckSumOfFileSizesJob:
+ Collaboration diagram for ilCheckSumOfFileSizesJob:

Public Member Functions

 __construct ()
 Construct. More...
 
 getInputTypes ()
 @inheritDoc More...
 
 getOutputType ()
 @inheritDoc More...
 
 isStateless ()
 @inheritDoc More...
 
 run (array $input, Observer $observer)
 @inheritDoc More...
 
 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
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 ()
 
 run (array $input, Observer $observer)
 
 isStateless ()
 
 getInput ()
 
 getExpectedTimeOfTaskInSeconds ()
 

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 (array $values)
 
 extractType ($value)
 

Protected Attributes

ilSetting $settings
 
- Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array $input = []
 
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 33 of file class.ilCheckSumOfFileSizesJob.php.

Constructor & Destructor Documentation

◆ __construct()

ilCheckSumOfFileSizesJob::__construct ( )

Construct.

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

43 {
44 global $DIC;
45 $this->logger = $DIC->logger()->cal();
46 $this->settings = new ilSetting("fold");
47 }
ILIAS Setting Class.
global $DIC
Definition: shib_login.php:26

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

+ 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 118 of file class.ilCheckSumOfFileSizesJob.php.

118 : void
119 {
120 global $DIC;
121 $tree = $DIC['tree'];
122
123 // parse folders
124 foreach ($a_ref_ids as $ref_id) {
125 if (!$this->validateAccess($ref_id)) {
126 continue;
127 }
128
129 // we are only interested in folders and files
130 switch (ilObject::_lookupType($ref_id, true)) {
131 case "fold":
132 // get child objects
133 $subtree = $tree->getChildsByTypeFilter($ref_id, ["fold", "file"]);
134 if (count($subtree) > 0) {
135 $child_ref_ids = [];
136 foreach ($subtree as $child) {
137 $child_ref_ids[] = $child["ref_id"];
138 }
139 $this->calculateRecursive($child_ref_ids, $a_file_size);
140 }
141 break;
142
143 case "file":
145 break;
146 }
147 }
148 }
validateAccess(int $ref_id)
Check file access.
calculateRecursive(array $a_ref_ids, int &$a_file_size)
Calculates the number and size of the files being downloaded recursively.
static _lookupFileSize(int $a_id, bool $by_reference=true)
static _lookupType(int $id, bool $reference=false)
$ref_id
Definition: ltiauth.php:66

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

Referenced by calculateRecursive(), and run().

+ 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 171 of file class.ilCheckSumOfFileSizesJob.php.

171 : int
172 {
173 return 30;
174 }

◆ getInputTypes()

ilCheckSumOfFileSizesJob::getInputTypes ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

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

53 : array
54 {
55 return
56 [
57 new SingleType(ilCopyDefinition::class),
58 ];
59 }

◆ getOutputType()

ilCheckSumOfFileSizesJob::getOutputType ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task.

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

65 : Type
66 {
67 return new SingleType(ilCopyDefinition::class);
68 }

◆ isStateless()

ilCheckSumOfFileSizesJob::isStateless ( )

@inheritDoc

Implements ILIAS\BackgroundTasks\Task\Job.

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

74 : bool
75 {
76 return true;
77 }

◆ run()

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

@inheritDoc

Todo:
use filesystem service

Implements ILIAS\BackgroundTasks\Task\Job.

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

84 : Value
85 {
86 $this->logger->debug('Start checking adherence to maxsize!');
87 $this->logger->dump($input);
88 $definition = $input[0];
89 $object_ref_ids = $definition->getObjectRefIds();
90
91 // get global limit (max sum of individual file-sizes) from file settings
92 $general = new General();
93 $size_limit = $general->getDownloadLimitinMB();
94 $size_limit_bytes = $size_limit * 1024 * 1024;
95 $this->logger->debug('Global limit (max sum of all file-sizes) in file-settings: ' . $size_limit_bytes . ' bytes');
96 // get sum of individual file-sizes
97 $total_bytes = 0;
98 $this->calculateRecursive($object_ref_ids, $total_bytes);
99 $this->logger->debug('Calculated sum of all file-sizes: ' . $total_bytes . 'MB');
100 // check if calculated total size adheres top global limit
101 $adheres_to_limit = new BooleanValue();
102 $adheres_to_limit->setValue(true);
103 if ($total_bytes > $size_limit_bytes) {
104 $adheres_to_limit->setValue(false);
105 }
106
107 $definition->setSumFileSizes($total_bytes);
108 $definition->setAdheresToLimit($adheres_to_limit);
109
110 return $definition;
111 }
$general
SECTIONS.

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

+ Here is the call graph for this function:

◆ validateAccess()

ilCheckSumOfFileSizesJob::validateAccess ( int  $ref_id)
protected

Check file access.

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

156 : bool
157 {
158 global $DIC;
159 $ilAccess = $DIC['ilAccess'];
160
161 if (!$ilAccess->checkAccess("read", "", $ref_id)) {
162 return false;
163 }
165 }
static _isInTrash(int $ref_id)

References $DIC, $ref_id, and ilObject\_isInTrash().

Referenced by calculateRecursive().

+ 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 35 of file class.ilCheckSumOfFileSizesJob.php.

◆ $settings

ilSetting ilCheckSumOfFileSizesJob::$settings
protected

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


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