ilDownloadFilesBackgroundTask Class Reference

Description of class class. More...

Collaboration diagram for ilDownloadFilesBackgroundTask:

Public Member Functions
	__construct ($a_usr_id)
	Constructor. More...
	setEvents (array $a_events)
	Set events. More...
	getEvents ()
	Get events. More...
	setBucketTitle ($a_title)
	set bucket title. More...
	getBucketTitle ()
	return bucket title. More...
	run ()
	Run task. More...

Protected Attributes
	$user_id
	$user = null
	$task_factory = null
	$bucket_title
	$has_files = false

Private Member Functions
	collectFiles (ilCalendarCopyDefinition $def)
	Collect files. More...
	getEventFileNameFromId (ilCalendarEntry $a_event, $a_file_id)
	Only courses store the files using the id for naming. More...

Private Attributes
	$logger = null
	$events = []
	Array of calendar event. More...

Detailed Description

Description of class class.

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

__construct()

ilDownloadFilesBackgroundTask::__construct

(

$a_usr_id

)

Constructor.

Parameters

type

$a_usr_id

Definition at line 58 of file class.ilDownloadFilesBackgroundTask.php.

References $DIC, ilObjectFactory\getInstanceByObjId(), and user().

    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
        $this->user_id = $a_usr_id;
        $this->task_factory = $DIC->backgroundTasks()->taskFactory();
        $this->lng = $DIC->language();

        $this->user = \ilObjectFactory::getInstanceByObjId($a_usr_id, false);
    }

Here is the call graph for this function:

Member Function Documentation

collectFiles()

ilDownloadFilesBackgroundTask::collectFiles ( ilCalendarCopyDefinition  $def )

private

Collect files.

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

References ilCalendarCopyDefinition\addCopyDefinition(), ilUtil\getASCIIFilename(), getEventFileNameFromId(), getEvents(), ilAppointmentFileHandlerFactory\getInstance(), ilCalendarCategory\getInstanceByCategoryId(), IL_CAL_FKT_DATE, IL_CAL_UNIX, ilCalendarCategory\TYPE_OBJ, and user().

Referenced by run().

    {
        //filter here the objects, don't repeat the object Id
        $object_ids = [];
        foreach ($this->getEvents() as $event) {
            $start = new ilDateTime($event['dstart'], IL_CAL_UNIX);
            $cat = ilCalendarCategory::getInstanceByCategoryId($event['category_id']);
            $obj_id = $cat->getObjId();

            $this->logger->debug('Handling event: ' . $event['event']->getPresentationTitle());
            //22295 If the object type is exc then we need all the assignments.Otherwise we will get only one.
            if (
                $cat->getType() != \ilCalendarCategory::TYPE_OBJ ||
                $cat->getObjType() == 'exc' ||
                !in_array($obj_id, $object_ids)
            ) {

                $this->logger->debug('New obj_id..');
                $object_ids[] = $obj_id;

                $folder_date = $start->get(IL_CAL_FKT_DATE, 'Y-m-d', $this->user->getTimeZone());


                if ($event['fullday']) {
                    $folder_app = ilUtil::getASCIIFilename($event['event']->getPresentationTitle(false));   //title formalized
                } else {
                    $start_time = $start->get(IL_CAL_FKT_DATE, 'H.i', $this->user->getTimeZone());

                    $end = new ilDateTime($event['dend'], IL_CAL_UNIX);
                    $end_time = $end->get(IL_CAL_FKT_DATE, 'H.i', $this->user->getTimeZone());

                    if ($start_time != $end_time) {
                        $start_time .= (' - ' . $end_time);
                    }
                    $folder_app = $start_time . ' ' .
                        ilUtil::getASCIIFilename($event['event']->getPresentationTitle(false));   //title formalized
                }

                $this->logger->debug("collecting files...event title = " . $folder_app);
                $file_handler = ilAppointmentFileHandlerFactory::getInstance($event);
                $this->logger->debug('Current file handler: ' . get_class($file_handler));

                if ($files = $file_handler->getFiles()) {
                    $this->has_files = true;
                }
                //if file_system_path is set, it is the real path of the file (courses use ids as names file->getId())
                //otherwise $file_with_absolut_path is the path. ($file->getName())
                foreach ($files as $file_system_path => $file_with_absolut_path) {
                    #22198 check if the key is a string defined by ILIAS or a number set by PHP as a sequential key
                    //[/Sites/data/client/ilCourse/2/crs_xx/info/1] => /Sites/data/client/ilCourse/2/crs_xxx/info/image.png
                    //[0] =>  /Sites/data/client/ilFile/3/file_3xx/001/image.png
                    if (is_string($file_system_path)) {
                        $file_with_absolut_path = $file_system_path;
                        $file_id = (int) basename($file_system_path);
                        $basename = $this->getEventFileNameFromId($event['event'], $file_id);
                    } else {
                        $basename = ilUtil::getASCIIFilename(basename($file_with_absolut_path));
                    }
                    $def->addCopyDefinition(
                        $file_with_absolut_path,
                        $folder_date . '/' . $folder_app . '/' . $basename
                    );

                    $this->logger->debug('Added new copy definition: ' . $folder_date . '/' . $folder_app . '/' . $basename . ' -> ' . $file_with_absolut_path);
                }
            }
            else {
                $this->logger->info('Ignoring obj_id: ' . $obj_id . ' already processed.');
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getBucketTitle()

ilDownloadFilesBackgroundTask::getBucketTitle

(

)

return bucket title.

Returns

string

Definition at line 100 of file class.ilDownloadFilesBackgroundTask.php.

References $bucket_title.

Referenced by run().

    {
        //TODO: fix ilUtil zip stuff
        // Error If name starts "-"
        // error massage from ilUtil->execQuoted = ["","zip error: Invalid command arguments (short option 'a' not supported)"]
        if (substr($this->bucket_title, 0, 1) === "-") {
            $this->bucket_title = ltrim($this->bucket_title, "-");
        }

        return $this->bucket_title;
    }

Here is the caller graph for this function:

getEventFileNameFromId()

ilDownloadFilesBackgroundTask::getEventFileNameFromId ( ilCalendarEntry  $a_event,   $a_file_id  )

private

Only courses store the files using the id for naming.

Parameters

ilCalendarEntry

Returns

string

Definition at line 233 of file class.ilDownloadFilesBackgroundTask.php.

References $filename, ilCalendarCategoryAssignments\_lookupCategory(), ilObject\_lookupType(), ilUtil\getASCIIFilename(), ilCalendarEntry\getEntryId(), ilCalendarCategory\getInstanceByCategoryId(), and ilCalendarCategory\TYPE_OBJ.

Referenced by collectFiles().

    {
        $filename = "";
        $cat_id = ilCalendarCategoryAssignments::_lookupCategory($a_event->getEntryId());
        $cat = ilCalendarCategory::getInstanceByCategoryId($cat_id);
        $cat_type = $cat->getType();
        $obj_id = $cat->getObjId();
        $obj_type = ilObject::_lookupType($obj_id);

        if ($cat_type == ilCalendarCategory::TYPE_OBJ && $obj_type == "crs") {
            $course_file = new ilCourseFile((int) $a_file_id);
            $filename = $course_file->getFileName();
        }
        return ilUtil::getASCIIFilename($filename);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEvents()

ilDownloadFilesBackgroundTask::getEvents

(

)

Get events.

Returns

type

Definition at line 82 of file class.ilDownloadFilesBackgroundTask.php.

References $events.

Referenced by collectFiles().

    {
        return $this->events;
    }

Here is the caller graph for this function:

run()

ilDownloadFilesBackgroundTask::run

(

)

Run task.

Returns

bool

Definition at line 116 of file class.ilDownloadFilesBackgroundTask.php.

References $GLOBALS, collectFiles(), ilUtil\getASCIIFilename(), getBucketTitle(), and ilUtil\sendInfo().

    {
        $definition = new ilCalendarCopyDefinition();
        $normalized_name = ilUtil::getASCIIFilename($this->getBucketTitle());
        $definition->setTempDir($normalized_name);

        $this->collectFiles($definition);

        if (!$this->has_files) {
            ilUtil::sendInfo($this->lng->txt("cal_down_no_files"), true);
            return false;
        }

        $bucket = new BasicBucket();
        $bucket->setUserId($this->user_id);
        
        // move files from source dir to target directory
        $copy_job = $this->task_factory->createTask(ilCalendarCopyFilesToTempDirectoryJob::class, [$definition]);
        $zip_job = $this->task_factory->createTask(ilCalendarZipJob::class, [$copy_job]);
        
        $download_name = new StringValue();

        $this->logger->debug("Normalized name = " . $normalized_name);
        $download_name->setValue($normalized_name . '.zip');

        $download_interaction = $this->task_factory->createTask(ilCalendarDownloadZipInteraction::class, [$zip_job, $download_name]);

        // last task to bucket
        $bucket->setTask($download_interaction);

        $bucket->setTitle($this->getBucketTitle());
        
        $task_manager = $GLOBALS['DIC']->backgroundTasks()->taskManager();
        $task_manager->run($bucket);
        return true;
    }

Here is the call graph for this function:

setBucketTitle()

ilDownloadFilesBackgroundTask::setBucketTitle

(

$a_title

)

set bucket title.

Parameters

$a_title

Definition at line 91 of file class.ilDownloadFilesBackgroundTask.php.

Referenced by ilAppointmentPresentationGUI\downloadFiles().

    {
        $this->bucket_title = $a_title;
    }

Here is the caller graph for this function:

setEvents()

ilDownloadFilesBackgroundTask::setEvents

(

array

$a_events

)

Set events.

Parameters

array

$a_events

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

    {
        $this->events = $a_events;
    }

Field Documentation

$bucket_title

ilDownloadFilesBackgroundTask::$bucket_title

protected

Definition at line 46 of file class.ilDownloadFilesBackgroundTask.php.

Referenced by getBucketTitle().

$events

ilDownloadFilesBackgroundTask::$events = []

private

Array of calendar event.

Definition at line 40 of file class.ilDownloadFilesBackgroundTask.php.

Referenced by getEvents().

$has_files

ilDownloadFilesBackgroundTask::$has_files = false

protected

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

$logger

ilDownloadFilesBackgroundTask::$logger = null

private

Definition at line 19 of file class.ilDownloadFilesBackgroundTask.php.

$task_factory

ilDownloadFilesBackgroundTask::$task_factory = null

protected

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

$user

ilDownloadFilesBackgroundTask::$user = null

protected

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

$user_id

ilDownloadFilesBackgroundTask::$user_id

protected

Definition at line 24 of file class.ilDownloadFilesBackgroundTask.php.

---

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

• Services/Calendar/classes/BackgroundTasks/class.ilDownloadFilesBackgroundTask.php