Delete orphaned mails. More...

Inheritance diagram for ilMailCronOrphanedMails:

Collaboration diagram for ilMailCronOrphanedMails:

Public Member Functions
	getId ()

	getTitle ()

	getDescription ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	getValidScheduleTypes ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

	ping ()

	run ()

Public Member Functions inherited from ILIAS\Cron\CronJob
	setDateTimeProvider (?\Closure $date_time_provider)

	isDue (?\DateTimeImmutable $last_run, ?JobScheduleType $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 (?JobScheduleType $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 ()

	usesLegacyForms ()

	getCustomConfigurationInput (\ILIAS\UI\Factory $ui_factory, \ILIAS\Refinery\Factory $factory, \ilLanguage $lng)

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomConfiguration (mixed $form_data)

	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 ()

Private Member Functions
	init ()

	emptyStringOrFloatOrIntToEmptyOrIntegerString ()

	processNotification ()

	processDeletion ()

Private Attributes
GlobalHttpState	$http

Refinery	$refinery

ilLanguage	$lng

ilSetting	$settings

ilDBInterface	$db

ilObjUser	$user

bool	$initDone = false

JobManager	$cron_manager

Additional Inherited Members
Protected Attributes inherited from ILIAS\Cron\CronJob
JobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Delete orphaned mails.

Author: Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 38 of file class.ilMailCronOrphanedMails.php.

Member Function Documentation

◆ addCustomSettingsToForm()

ilMailCronOrphanedMails::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 144 of file class.ilMailCronOrphanedMails.php.

References ilPropertyFormGUI\addItem(), emptyStringOrFloatOrIntToEmptyOrIntegerString(), ILIAS\FileDelivery\http(), init(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and ILIAS\Repository\settings().

                                                                       : void
     {
         $this->init();
 
         parent::addCustomSettingsToForm($a_form);
 
         $threshold = new ilNumberInputGUI($this->lng->txt('mail_threshold'), 'mail_threshold');
         $threshold->setInfo($this->lng->txt('mail_threshold_info'));
         $threshold->allowDecimals(false);
         $threshold->setSuffix($this->lng->txt('days'));
         $threshold->setMinValue(1);
         $threshold->setSize(4);
         $threshold->setValue($this->settings->get('mail_threshold', ''));
 
         $a_form->addItem($threshold);
 
         $mail_folder = new ilCheckboxInputGUI(
             $this->lng->txt('only_inbox_trash'),
             'mail_only_inbox_trash'
         );
         $mail_folder->setValue('1');
         $mail_folder->setInfo($this->lng->txt('only_inbox_trash_info'));
         $mail_folder->setChecked((bool) $this->settings->get('mail_only_inbox_trash', '0'));
         $a_form->addItem($mail_folder);
 
         $notification = new ilNumberInputGUI(
             $this->lng->txt('mail_notify_orphaned'),
             'mail_notify_orphaned'
         );
         $notification->setInfo($this->lng->txt('mail_notify_orphaned_info'));
         $notification->allowDecimals(false);
         $notification->setSize(4);
         $notification->setSuffix($this->lng->txt('days'));
         $notification->setMinValue(0);
 
         if ($this->http->wrapper()->post()->has('mail_threshold')) {
             $mail_threshold = (int) $this->http->wrapper()->post()->retrieve(
                 'mail_threshold',
                 $this->emptyStringOrFloatOrIntToEmptyOrIntegerString()
             );
         } else {
             $mail_threshold = (int) $this->settings->get('mail_threshold');
         }
         $maxvalue = $mail_threshold - 1;
         $notification->setMaxValue($maxvalue);
         $notification->setValue($this->settings->get('mail_notify_orphaned', ''));
         $a_form->addItem($notification);
     }

Here is the call graph for this function:

◆ emptyStringOrFloatOrIntToEmptyOrIntegerString()

ilMailCronOrphanedMails::emptyStringOrFloatOrIntToEmptyOrIntegerString ( )

private

Definition at line 67 of file class.ilMailCronOrphanedMails.php.

References null, and ILIAS\Repository\refinery().

Referenced by addCustomSettingsToForm(), and saveCustomSettings().

                                                                     : Transformation
     {
         $empty_string_or_null_to_stirng_trafo = $this->refinery->custom()->transformation(static function ($value): string {
             if ($value === '' || null === $value) {
                 return '';
             }
 
             throw new Exception('The value to be transformed is not an empty string');
         });
 
         return $this->refinery->in()->series([
             $this->refinery->byTrying([
                 $empty_string_or_null_to_stirng_trafo,
                 $this->refinery->kindlyTo()->int(),
                 $this->refinery->in()->series([
                     $this->refinery->kindlyTo()->float(),
                     $this->refinery->kindlyTo()->int()
                 ])
             ]),
             $this->refinery->kindlyTo()->string()
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilMailCronOrphanedMails::getDefaultScheduleType ( )

Definition at line 129 of file class.ilMailCronOrphanedMails.php.

                                             : JobScheduleType
     {
         return JobScheduleType::DAILY;
     }

◆ getDefaultScheduleValue()

ilMailCronOrphanedMails::getDefaultScheduleValue ( )

Definition at line 134 of file class.ilMailCronOrphanedMails.php.

◆ getDescription()

ilMailCronOrphanedMails::getDescription ( )

Definition at line 101 of file class.ilMailCronOrphanedMails.php.

References init(), and ILIAS\Repository\lng().

                                     : string
     {
         $this->init();
         return $this->lng->txt('mail_orphaned_mails_desc');
     }

Here is the call graph for this function:

◆ getId()

ilMailCronOrphanedMails::getId ( )

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

Referenced by ping().

                            : string
     {
         return 'mail_orphaned_mails';
     }

Here is the caller graph for this function:

◆ getTitle()

ilMailCronOrphanedMails::getTitle ( )

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

References init(), and ILIAS\Repository\lng().

                               : string
     {
         $this->init();
         return $this->lng->txt('mail_orphaned_mails');
     }

Here is the call graph for this function:

◆ getValidScheduleTypes()

ilMailCronOrphanedMails::getValidScheduleTypes ( )

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

References ILIAS\Cron\Job\Schedule\YEARLY.

                                            : array
     {
         return [
             JobScheduleType::DAILY,
             JobScheduleType::WEEKLY,
             JobScheduleType::MONTHLY,
             JobScheduleType::QUARTERLY,
             JobScheduleType::YEARLY,
             JobScheduleType::IN_DAYS
         ];
     }

◆ hasAutoActivation()

ilMailCronOrphanedMails::hasAutoActivation ( )

Definition at line 107 of file class.ilMailCronOrphanedMails.php.

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilMailCronOrphanedMails::hasCustomSettings ( )

Definition at line 139 of file class.ilMailCronOrphanedMails.php.

                                        : bool
     {
         return true;
     }

◆ hasFlexibleSchedule()

ilMailCronOrphanedMails::hasFlexibleSchedule ( )

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

                                          : bool
     {
         return true;
     }

◆ init()

ilMailCronOrphanedMails::init ( )

private

Definition at line 49 of file class.ilMailCronOrphanedMails.php.

References $DIC, ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ILIAS\Repository\settings(), and ILIAS\Repository\user().

Referenced by addCustomSettingsToForm(), getDescription(), getTitle(), processDeletion(), processNotification(), run(), and saveCustomSettings().

                            : void
     {
         global $DIC;
 
         if (!$this->initDone) {
             $this->settings = $DIC->settings();
             $this->lng = $DIC->language();
             $this->db = $DIC->database();
             $this->user = $DIC->user();
             $this->http = $DIC->http();
             $this->refinery = $DIC->refinery();
             $this->cron_manager = $DIC->cron()->manager();
 
             $this->lng->loadLanguageModule('mail');
             $this->initDone = true;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ping()

ilMailCronOrphanedMails::ping ( )

Definition at line 222 of file class.ilMailCronOrphanedMails.php.

References getId().

                           : void
     {
         $this->cron_manager->ping($this->getId());
     }

Here is the call graph for this function:

◆ processDeletion()

ilMailCronOrphanedMails::processDeletion ( )

private

Definition at line 271 of file class.ilMailCronOrphanedMails.php.

References init().

Referenced by run().

                                       : void
     {
         $this->init();
 
         $processor = new MailDeletionHandler($this, new ExpiredOrOrphanedMailsCollector($this));
         $processor->delete();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processNotification()

ilMailCronOrphanedMails::processNotification ( )

private

Definition at line 258 of file class.ilMailCronOrphanedMails.php.

References init(), ILIAS\Repository\int(), ILIAS\Mail\Cron\ExpiredOrOrphanedMails\Notifier\send(), and ILIAS\Repository\settings().

Referenced by run().

                                           : void
     {
         $this->init();
 
         $notifier = new Notifier(
             $this,
             new NotificationsCollector($this),
             (int) $this->settings->get('mail_threshold', '0'),
             (int) $this->settings->get('mail_notify_orphaned', '0')
         );
         $notifier->send();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ run()

ilMailCronOrphanedMails::run ( )

Definition at line 227 of file class.ilMailCronOrphanedMails.php.

References ilLoggerFactory\getLogger(), init(), ILIAS\Repository\int(), processDeletion(), processNotification(), and ILIAS\Repository\settings().

                          : JobResult
     {
         $this->init();
 
         $mail_expiration_days = (int) $this->settings->get('mail_threshold', '0');
 
         ilLoggerFactory::getLogger('mail')->info(sprintf(
             'Started mail deletion job with threshold: %s day(s)',
             var_export($mail_expiration_days, true)
         ));
 
         if ($mail_expiration_days >= 1 && (int) $this->settings->get('mail_notify_orphaned', '0') >= 1) {
             $this->processNotification();
         }
 
         if ($mail_expiration_days >= 1 && (int) $this->settings->get('last_cronjob_start_ts', (string) time())) {
             $this->processDeletion();
         }
 
         $result = new JobResult();
         $status = JobResult::STATUS_OK;
         $result->setStatus($status);
 
         ilLoggerFactory::getLogger('mail')->info(sprintf(
             'Finished mail deletion job with threshold: %s day(s)',
             var_export($mail_expiration_days, true)
         ));
 
         return $result;
     }

Here is the call graph for this function:

◆ saveCustomSettings()

ilMailCronOrphanedMails::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 193 of file class.ilMailCronOrphanedMails.php.

References emptyStringOrFloatOrIntToEmptyOrIntegerString(), ilPropertyFormGUI\getInput(), ilLoggerFactory\getLogger(), init(), ILIAS\Repository\settings(), ILIAS\Refinery\transform(), and ILIAS\Repository\user().

                                                                  : bool
     {
         $this->init();
 
         $this->settings->set('mail_only_inbox_trash', (string) ((int) $a_form->getInput('mail_only_inbox_trash')));
         $this->settings->set(
             'mail_threshold',
             $this->emptyStringOrFloatOrIntToEmptyOrIntegerString()->transform($a_form->getInput('mail_threshold'))
         );
         $this->settings->set(
             'mail_notify_orphaned',
             $this->emptyStringOrFloatOrIntToEmptyOrIntegerString()->transform($a_form->getInput('mail_notify_orphaned'))
         );
 
         if ((int) $this->settings->get('mail_notify_orphaned', '0') === 0) {
             //delete all mail_cron_orphaned-table entries!
             $this->db->manipulate('DELETE FROM mail_cron_orphaned');
 
             ilLoggerFactory::getLogger('mail')->info(sprintf(
                 "Deleted all scheduled mail deletions " .
                 "because a reminder shouldn't be sent (login: %s|usr_id: %s) anymore!",
                 $this->user->getLogin(),
                 $this->user->getId()
             ));
         }
 
         return true;
     }

Here is the call graph for this function:

Field Documentation

◆ $cron_manager

JobManager ilMailCronOrphanedMails::$cron_manager

private

Definition at line 47 of file class.ilMailCronOrphanedMails.php.

◆ $db

ilDBInterface ilMailCronOrphanedMails::$db

private

Definition at line 44 of file class.ilMailCronOrphanedMails.php.

◆ $http

GlobalHttpState ilMailCronOrphanedMails::$http

private

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

◆ $initDone

bool ilMailCronOrphanedMails::$initDone = false

private

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

◆ $lng

ilLanguage ilMailCronOrphanedMails::$lng

private

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

◆ $refinery

Refinery ilMailCronOrphanedMails::$refinery

private

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

◆ $settings

ilSetting ilMailCronOrphanedMails::$settings

private

Definition at line 43 of file class.ilMailCronOrphanedMails.php.

◆ $user

ilObjUser ilMailCronOrphanedMails::$user

private

Definition at line 45 of file class.ilMailCronOrphanedMails.php.

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

components/ILIAS/Mail/classes/class.ilMailCronOrphanedMails.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addCustomSettingsToForm()

◆ emptyStringOrFloatOrIntToEmptyOrIntegerString()

◆ getDefaultScheduleType()

◆ getDefaultScheduleValue()

◆ getDescription()

◆ getId()

◆ getTitle()

◆ getValidScheduleTypes()

◆ hasAutoActivation()

◆ hasCustomSettings()

◆ hasFlexibleSchedule()

◆ init()

◆ ping()

◆ processDeletion()

◆ processNotification()

◆ run()

◆ saveCustomSettings()

Field Documentation

◆ $cron_manager

◆ $db

◆ $http

◆ $initDone

◆ $lng

◆ $refinery

◆ $settings

◆ $user