Background task handler for zip creation. More...

Inheritance diagram for ilZipBackgroundTaskHandler:

Collaboration diagram for ilZipBackgroundTaskHandler:

Public Member Functions
	__construct ()
	Constructor. More...

	setDeliveryFilename ($a_value)
	Sets the delivery file name. More...

	getDeliveryFilename ()
	Gets the delivery file name. More...

	getTask ()
	Get current task instance. More...

	process ()
	Process the task. More...

	cancel ()
	Cancel download. More...

	finish ()
	Finish download. More...

	deliver ()
	Deliver file. More...

	deleteTaskAndFiles ()
	Remove task and its files. More...

Public Member Functions inherited from ilBackgroundTaskHandler
	getTask ()
	Get current task instance. More...

	init ($a_params)
	Init background task. More...

	process ()
	Process the task. More...

	cancel ()
	Cancel the task. More...

	finish ()
	Finish the task. More...

	deleteTaskAndFiles ()
	Remove task and its files. More...

Protected Member Functions
	setTask (ilBackgroundTask $a_task)
	Set current task instance. More...

	gatherFiles ()
	Copy files to target directory. More...

	deleteTempFiles ($a_delete_zip=true)
	Deletes the temporary files and folders belonging to this download. More...

	getTempFolderPath ()
	Gets the temporary folder path to copy the files and folders to. More...

	getTempZipFilePath ()
	Gets the full path of the temporary zip file that gets created. More...

	getTempBasePath ()
	Gets the temporary base path for all files and folders related to this download. More...

Protected Attributes
	$task

	$filename

Private Attributes
	$log

Additional Inherited Members
Static Public Member Functions inherited from ilBackgroundTaskHandler
static	getInstanceFromTask (ilBackgroundTask $a_task)
	Constructor/Factory. More...

Detailed Description

Background task handler for zip creation.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 12 of file class.ilZipBackgroundTaskHandler.php.

Constructor & Destructor Documentation

◆ __construct()

ilZipBackgroundTaskHandler::__construct ( )

Constructor.

Returns: self

Reimplemented in ilFolderDownloadBackgroundTaskHandler.

Definition at line 27 of file class.ilZipBackgroundTaskHandler.php.

    {
        $this->log = ilLoggerFactory::getLogger('btsk');
        $this->settings = new ilSetting("fold");
    }

References ilLoggerFactory\getLogger(), and settings().

Here is the call graph for this function:

Member Function Documentation

◆ cancel()

ilZipBackgroundTaskHandler::cancel ( )

Cancel download.

Returns: boolean

Implements ilBackgroundTaskHandler.

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

    {
        $this->log->debug("");
        $this->deleteTempFiles();
        
        $this->task->setStatus(ilBackgroundTask::STATUS_CANCELLED);
        $this->task->save();
        
        return true;
    }

References deleteTempFiles(), and ilBackgroundTask\STATUS_CANCELLED.

Referenced by process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteTaskAndFiles()

ilZipBackgroundTaskHandler::deleteTaskAndFiles ( )

Remove task and its files.

Implements ilBackgroundTaskHandler.

Definition at line 154 of file class.ilZipBackgroundTaskHandler.php.

    {
        if (!$this->task) {
            return;
        }
        
        $this->deleteTempFiles();
        
        $this->task->delete();
        unset($this->task);
    }

References deleteTempFiles().

Here is the call graph for this function:

◆ deleteTempFiles()

ilZipBackgroundTaskHandler::deleteTempFiles ( $a_delete_zip = true )

protected

Deletes the temporary files and folders belonging to this download.

Parameters

bool $a_delete_zip

Definition at line 183 of file class.ilZipBackgroundTaskHandler.php.

    {
        $successful = true;
        
        // delete temp directory
        $tmp_folder = $this->getTempFolderPath();
        if (is_dir($tmp_folder)) {
            ilUtil::delDir($tmp_folder);
            $successful = !file_exists($tmp_folder);
        }
        
        if ($a_delete_zip) {
            // delete temp zip file
            $tmp_file = $this->getTempZipFilePath();
            if (file_exists($tmp_file)) {
                $successful = @unlink($tmp_file);
            }
        }
        
        return $successful;
    }

References ilUtil\delDir(), getTempFolderPath(), and getTempZipFilePath().

Referenced by cancel(), deleteTaskAndFiles(), and finish().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deliver()

ilZipBackgroundTaskHandler::deliver ( )

Deliver file.

Definition at line 147 of file class.ilZipBackgroundTaskHandler.php.

    {
        $tmpzipfile = $this->getTempZipFilePath();
        $deliverFilename = ilUtil::getAsciiFilename($this->getDeliveryFilename()) . ".zip";
        ilUtil::deliverFile($tmpzipfile, $deliverFilename, '', false, true, false);
    }

References ilUtil\deliverFile(), getDeliveryFilename(), and getTempZipFilePath().

Here is the call graph for this function:

◆ finish()

ilZipBackgroundTaskHandler::finish ( )

Finish download.

Implements ilBackgroundTaskHandler.

Definition at line 131 of file class.ilZipBackgroundTaskHandler.php.

    {
        global $DIC;
        $ilCtrl = $DIC['ilCtrl'];
        
        $this->deleteTempFiles(false);
        
        $ilCtrl->setParameterByClass("ilbackgroundtaskhub", "tid", $this->task->getId());
        $url = $ilCtrl->getLinkTargetByClass("ilbackgroundtaskhub", "deliver", "", false, false);
 
        return array("redirect", $url);
    }

References $DIC, $ilCtrl, $url, and deleteTempFiles().

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ gatherFiles()

ilZipBackgroundTaskHandler::gatherFiles ( )

abstractprotected

Copy files to target directory.

Returns: int current step

Reimplemented in ilFolderDownloadBackgroundTaskHandler.

Referenced by process().

Here is the caller graph for this function:

◆ getDeliveryFilename()

ilZipBackgroundTaskHandler::getDeliveryFilename ( )

Gets the delivery file name.

Returns: string

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

    {
        return $this->filename;
    }

References $filename.

Referenced by deliver().

Here is the caller graph for this function:

◆ getTask()

ilZipBackgroundTaskHandler::getTask ( )

Get current task instance.

Returns: \ilBackgroundTask

Implements ilBackgroundTaskHandler.

Definition at line 72 of file class.ilZipBackgroundTaskHandler.php.

    {
        return $this->task;
    }

References $task.

◆ getTempBasePath()

ilZipBackgroundTaskHandler::getTempBasePath ( )

protected

Gets the temporary base path for all files and folders related to this download.

Returns: int

Definition at line 235 of file class.ilZipBackgroundTaskHandler.php.

    {
        return ilUtil::getDataDir() . "/temp/dl_" . $this->task->getId();
    }

References ilUtil\getDataDir().

Referenced by getTempFolderPath(), and getTempZipFilePath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempFolderPath()

ilZipBackgroundTaskHandler::getTempFolderPath ( )

protected

Gets the temporary folder path to copy the files and folders to.

Returns: int

Definition at line 215 of file class.ilZipBackgroundTaskHandler.php.

    {
        return $this->getTempBasePath() . ".tmp";
    }

References getTempBasePath().

Referenced by deleteTempFiles(), ilFolderDownloadBackgroundTaskHandler\gatherFiles(), and process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTempZipFilePath()

ilZipBackgroundTaskHandler::getTempZipFilePath ( )

protected

Gets the full path of the temporary zip file that gets created.

Returns: int

Definition at line 225 of file class.ilZipBackgroundTaskHandler.php.

    {
        return $this->getTempBasePath() . ".zip";
    }

References getTempBasePath().

Referenced by deleteTempFiles(), deliver(), and process().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ process()

ilZipBackgroundTaskHandler::process ( )

Process the task.

Implements ilBackgroundTaskHandler.

Definition at line 77 of file class.ilZipBackgroundTaskHandler.php.

    {
        $this->log->debug("start");
        // create temporary file to download
        $tmpdir = $this->getTempFolderPath();
        ilUtil::makeDirParents($tmpdir);
        
        // gather all files
        $current_step = $this->gatherFiles();
        
        // has been cancelled?
        if ($this->task->isToBeCancelled()) {
            return $this->cancel();
        }
                    
        // :TODO: create zip in several steps
        
        $this->task->setCurrentStep(++$current_step);
        $this->task->save();
        
        // create archive to download
        $tmpzipfile = $this->getTempZipFilePath();
        ilUtil::zip($tmpdir, $tmpzipfile, true);
        ilUtil::delDir($tmpdir);
        
        // has been cancelled?
        if ($this->task->isToBeCancelled()) {
            return $this->cancel();
        }
        
        $this->task->setStatus(ilBackgroundTask::STATUS_FINISHED);
        $this->task->save();
        $this->log->debug("end");
    }

References cancel(), ilUtil\delDir(), gatherFiles(), getTempFolderPath(), getTempZipFilePath(), ilUtil\makeDirParents(), ilBackgroundTask\STATUS_FINISHED, and ilUtil\zip().

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeliveryFilename()

ilZipBackgroundTaskHandler::setDeliveryFilename ( $a_value )

Sets the delivery file name.

Parameters

string

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

    {
        $this->filename = $a_value;
    }

◆ setTask()

ilZipBackgroundTaskHandler::setTask ( ilBackgroundTask $a_task )

protected

Set current task instance.

Parameters

ilBackgroundTask $a_task

Definition at line 62 of file class.ilZipBackgroundTaskHandler.php.

    {
        $this->task = $a_task;
    }

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

Here is the caller graph for this function:

Field Documentation

◆ $filename

ilZipBackgroundTaskHandler::$filename

protected

Definition at line 15 of file class.ilZipBackgroundTaskHandler.php.

Referenced by getDeliveryFilename(), and ilFolderDownloadBackgroundTaskHandler\renameDuplicateFile().

◆ $log

ilZipBackgroundTaskHandler::$log

private

Definition at line 20 of file class.ilZipBackgroundTaskHandler.php.

◆ $task

ilZipBackgroundTaskHandler::$task

protected

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

Referenced by getTask(), and ilFolderDownloadBackgroundTaskHandler\init().

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

Services/BackgroundTask/classes/class.ilZipBackgroundTaskHandler.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cancel()

◆ deleteTaskAndFiles()

◆ deleteTempFiles()

◆ deliver()

◆ finish()

◆ gatherFiles()

◆ getDeliveryFilename()

◆ getTask()

◆ getTempBasePath()

◆ getTempFolderPath()

◆ getTempZipFilePath()

◆ process()

◆ setDeliveryFilename()

◆ setTask()

Field Documentation

◆ $filename

◆ $log

◆ $task