ilCopyFilesToTempDirectoryJob Class Reference

Description of class class. More...

Inheritance diagram for ilCopyFilesToTempDirectoryJob:

Collaboration diagram for ilCopyFilesToTempDirectoryJob:

Public Member Functions
	__construct ()
	Constructor. More...
	getInputTypes ()
	getOutputType ()
	isStateless ()
	run (array $input, Observer $observer)
	run the job 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 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
	createUniqueTempDirectory ()
	createTargetDirectory (string $a_tmpdir)
	copyFiles (string $tmpdir, ilCopyDefinition $definition)
	Copy files. More...
Protected Member Functions inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
	checkTypes (array $values)
	extractType ($value)

Protected Attributes
string	$target_directory = ''
Protected Attributes inherited from ILIAS\BackgroundTasks\Implementation\Tasks\AbstractTask
array	$input = []
Value	$output

Private Attributes
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

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

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

Constructor & Destructor Documentation

__construct()

ilCopyFilesToTempDirectoryJob::__construct

(

)

Constructor.

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

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

    {
        global $DIC;
        $this->logger = $DIC->logger()->cal();
    }

Here is the call graph for this function:

Member Function Documentation

copyFiles()

ilCopyFilesToTempDirectoryJob::copyFiles ( string  $tmpdir, ilCopyDefinition  $definition  )

protected

Copy files.

Definition at line 135 of file class.ilCopyFilesToTempDirectoryJob.php.

References ilCopyDefinition\COPY_SOURCE_DIR, ilCopyDefinition\COPY_TARGET_DIR, ilCopyDefinition\getCopyDefinitions(), ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by run().

                                                                              : void
    {
        foreach ($definition->getCopyDefinitions() as $copy_task) {
            $source_dir_or_file = $copy_task[ilCopyDefinition::COPY_SOURCE_DIR];
            $target_dir_or_file = $copy_task[ilCopyDefinition::COPY_TARGET_DIR];
            $absolute_path_of_target_dir_or_file = $tmpdir . '/' . $target_dir_or_file;
            $absolute_directory_of_target_dir_or_file = $tmpdir . '/' . dirname($target_dir_or_file);

            $this->logger->debug('Creating directory: ' . $tmpdir . '/' . dirname($target_dir_or_file));

            ilFileUtils::makeDirParents(
                $absolute_directory_of_target_dir_or_file
            );

            if (!file_exists($source_dir_or_file)) {
                // if the "file" to be copied is an empty folder the directory has to be created so it will be contained in the download zip
                $is_empty_folder = preg_match_all("/\/$/", $target_dir_or_file);
                if ($is_empty_folder && !file_exists($absolute_path_of_target_dir_or_file)) {
                    mkdir($absolute_path_of_target_dir_or_file);
                    $this->logger->notice('Empty folder has been created: ' . $tmpdir . '/' . $source_dir_or_file);
                } else {
                    $this->logger->notice('Cannot find file: ' . $source_dir_or_file);
                }
                continue;
            }

            $this->logger->debug(
                'Copying from: ' .
                $source_dir_or_file .
                ' to ' .
                $absolute_path_of_target_dir_or_file
            );
            if (
                !is_dir($source_dir_or_file) && is_file($source_dir_or_file)
                && !is_dir($absolute_path_of_target_dir_or_file)
            ) {
                copy(
                    $source_dir_or_file,
                    $absolute_path_of_target_dir_or_file
                );
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createTargetDirectory()

ilCopyFilesToTempDirectoryJob::createTargetDirectory ( string  $a_tmpdir )

protected

Definition at line 122 of file class.ilCopyFilesToTempDirectoryJob.php.

References $target_directory, ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by run().

                                                              : string
    {
        $final_dir = $a_tmpdir . "/" . $this->target_directory;
        ilFileUtils::makeDirParents($final_dir);
        $this->logger->info('New final directory: ' . $final_dir);

        return $final_dir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createUniqueTempDirectory()

ilCopyFilesToTempDirectoryJob::createUniqueTempDirectory ( )

protected

Returns

string absolute path to new temp directory

Todo:

refactor to new file system access Create unique temp directory

Definition at line 112 of file class.ilCopyFilesToTempDirectoryJob.php.

References ilFileUtils\ilTempnam(), ILIAS\Repository\logger(), and ilFileUtils\makeDirParents().

Referenced by run().

                                                  : string
    {
        $tmpdir = ilFileUtils::ilTempnam();
        ilFileUtils::makeDirParents($tmpdir);
        $this->logger->info('New temp directory: ' . $tmpdir);

        return $tmpdir;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getExpectedTimeOfTaskInSeconds()

ilCopyFilesToTempDirectoryJob::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 183 of file class.ilCopyFilesToTempDirectoryJob.php.

                                                    : int
    {
        return 30;
    }

getInputTypes()

ilCopyFilesToTempDirectoryJob::getInputTypes

(

)

Returns

SingleType[]

Implements ILIAS\BackgroundTasks\Task.

Definition at line 51 of file class.ilCopyFilesToTempDirectoryJob.php.

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

getOutputType()

ilCopyFilesToTempDirectoryJob::getOutputType

(

)

Todo:

output should be file type

Implements ILIAS\BackgroundTasks\Task.

Definition at line 63 of file class.ilCopyFilesToTempDirectoryJob.php.

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

isStateless()

ilCopyFilesToTempDirectoryJob::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 69 of file class.ilCopyFilesToTempDirectoryJob.php.

                                 : bool
    {
        return true;
    }

run()

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

run the job

Parameters

Value

$input

Implements ILIAS\BackgroundTasks\Task\Job.

Definition at line 79 of file class.ilCopyFilesToTempDirectoryJob.php.

References $out, copyFiles(), createTargetDirectory(), createUniqueTempDirectory(), and ILIAS\Repository\logger().

                                                         : Value
    {
        $definition = $input[0];

        $this->logger->info('Called copy files job');

        $this->target_directory = $definition->getTempDir();

        // create temp directory
        $tmpdir = $this->createUniqueTempDirectory();
        $targetdir = $this->createTargetDirectory($tmpdir);

        // copy files from source to temp directory
        //$this->copyFiles($targetdir, $input[0]);
        $this->copyFiles($targetdir, $definition);

        // zip

        // return zip file name
        $this->logger->debug('Returning new tempdirectory: ' . $targetdir);

        $out = new StringValue();
        $out->setValue($targetdir);

        return $out;
    }

Here is the call graph for this function:

Field Documentation

$logger

ilLogger ilCopyFilesToTempDirectoryJob::$logger

private

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

$target_directory

string ilCopyFilesToTempDirectoryJob::$target_directory = ''

protected

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

Referenced by createTargetDirectory().

---

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

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