ilFileSystemCleanTempDirCron Class Reference

Class ilFileSystemCleanTempDirCron. More...

Inheritance diagram for ilFileSystemCleanTempDirCron:

Collaboration diagram for ilFileSystemCleanTempDirCron:

Public Member Functions
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()
Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)
	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $schedule_type, ?int $schedule_value, bool $is_manually_executed=false)
	getScheduleType ()
	Get current schedule type (if flexible) More...
	getScheduleValue ()
	Get current schedule value (if flexible) More...
	setSchedule (?CronJobScheduleType $a_type, ?int $a_value)
	Update current schedule (if flexible) More...
	getAllScheduleTypes ()
	Get all available schedule types. More...
	getScheduleTypesWithValues ()
	getValidScheduleTypes ()
	Returns a collection of all valid schedule types for a specific job. More...
	isManuallyExecutable ()
	hasCustomSettings ()
	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	saveCustomSettings (ilPropertyFormGUI $a_form)
	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)
	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)
	Important: This method is (also) called from the setup process, where the constructor of an ilCronJob ist NOT executed. More...
	getId ()
	getTitle ()
	getDescription ()
	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...
	hasFlexibleSchedule ()
	getDefaultScheduleType ()
	getDefaultScheduleValue ()
	run ()

Protected Attributes
ILIAS Filesystem Filesystem	$filesystem
ilLanguage	$language
ilLogger	$logger
Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null
int	$schedule_value = null
Closure	$date_time_provider = null

Private Member Functions
	initDependencies ()

Detailed Description

Class ilFileSystemCleanTempDirCron.

Author

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

Definition at line 28 of file class.ilFileSystemCleanTempDirCron.php.

Member Function Documentation

getDefaultScheduleType()

ilFileSystemCleanTempDirCron::getDefaultScheduleType

(

)

Definition at line 85 of file class.ilFileSystemCleanTempDirCron.php.

                                            : CronJobScheduleType
    {
        return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
    }

getDefaultScheduleValue()

ilFileSystemCleanTempDirCron::getDefaultScheduleValue

(

)

Definition at line 90 of file class.ilFileSystemCleanTempDirCron.php.

                                             : ?int
    {
        return 1;
    }

getDescription()

ilFileSystemCleanTempDirCron::getDescription

(

)

Definition at line 70 of file class.ilFileSystemCleanTempDirCron.php.

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                    : string
    {
        return $this->language->txt("file_system_clean_temp_dir_cron_info");
    }

Here is the call graph for this function:

getId()

ilFileSystemCleanTempDirCron::getId

(

)

Definition at line 60 of file class.ilFileSystemCleanTempDirCron.php.

                           : string
    {
        return "file_system_clean_temp_dir";
    }

getTitle()

ilFileSystemCleanTempDirCron::getTitle

(

)

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

References ILIAS\UI\examples\Symbol\Glyph\Language\language().

                              : string
    {
        return $this->language->txt('file_system_clean_temp_dir_cron');
    }

Here is the call graph for this function:

hasAutoActivation()

ilFileSystemCleanTempDirCron::hasAutoActivation

(

)

Definition at line 75 of file class.ilFileSystemCleanTempDirCron.php.

                                       : bool
    {
        return false;
    }

hasFlexibleSchedule()

ilFileSystemCleanTempDirCron::hasFlexibleSchedule

(

)

Definition at line 80 of file class.ilFileSystemCleanTempDirCron.php.

                                         : bool
    {
        return true;
    }

initDependencies()

ilFileSystemCleanTempDirCron::initDependencies ( )

private

Definition at line 56 of file class.ilFileSystemCleanTempDirCron.php.

Referenced by run().

                                       : void
    {
    }

Here is the caller graph for this function:

run()

ilFileSystemCleanTempDirCron::run

(

)

Definition at line 95 of file class.ilFileSystemCleanTempDirCron.php.

References Vendor\Package\$a, Vendor\Package\$b, $path, ILIAS\Repository\filesystem(), ILIAS\Filesystem\DTO\Metadata\getPath(), initDependencies(), ILIAS\Repository\logger(), and ilCronJobResult\STATUS_OK.

                         : ilCronJobResult
    {
        $this->initDependencies();
        // only delete files and folders older than ten days to prevent issues with ongoing processes (e.g. zipping a folder)
        $date = "until 10 day ago";

        // files are deleted before folders to prevent issues that would arise when trying to delete a (no longer existing) file in a deleted folder.
        $files = $this->filesystem->finder()->in([""]);
        $files = $files->files();
        $files = $files->date($date);
        $files = $files->getIterator();
        $files->rewind();
        $deleted_files = [];
        while ($files->valid()) {
            try {
                $file_match = $files->current();
                $path = $file_match->getPath();
                if ($file_match->isFile()) {
                    $this->filesystem->delete($path);
                    $deleted_files[] = $path;
                }
                $files->next();
            } catch (Throwable $t) {
                $this->logger->error(
                    "Cron Job \"Clean temp directory\" could not delete " . $path
                    . "due to the following exception: " . $t->getMessage()
                );
                $files->next();
            }
        }

        // the folders are sorted based on their path length to ensure that nested folders are deleted first
        // thereby preventing any issues due to deletion attempts on no longer existing folders.
        $folders = $this->filesystem->finder()->in([""]);
        $folders = $folders->directories();
        $folders = $folders->date($date);
        $folders = $folders->sort(fn (
            Metadata $a,
            Metadata $b
        ): int => strlen($a->getPath()) - strlen($b->getPath()));
        $folders = $folders->reverseSorting();
        $folders = $folders->getIterator();

        $deleted_folders = [];

        $folders->rewind();
        while ($folders->valid()) {
            try {
                $folder_match = $folders->current();
                $path = $folder_match->getPath();
                if ($folder_match->isDir()) {
                    $this->filesystem->deleteDir($path);
                    $deleted_folders[] = $path;
                }
                $folders->next();
            } catch (Throwable $t) {
                $this->logger->error(
                    "Cron Job \"Clean temp directory\" could not delete " . $path
                    . "due to the following exception: " . $t->getMessage()
                );
                $folders->next();
            }
        }

        $num_folders = count($deleted_folders);
        $num_files = count($deleted_files);

        $result = new ilCronJobResult();
        $result->setMessage($num_folders . " folders and " . $num_files . " files have been deleted.");
        $result->setStatus(ilCronJobResult::STATUS_OK);
        return $result;
    }

Here is the call graph for this function:

Field Documentation

$filesystem

ILIAS Filesystem Filesystem ilFileSystemCleanTempDirCron::$filesystem

protected

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

$language

ilLanguage ilFileSystemCleanTempDirCron::$language

protected

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

$logger

ilLogger ilFileSystemCleanTempDirCron::$logger

protected

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

---

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

• Services/FileSystem/classes/class.ilFileSystemCleanTempDirCron.php