Inheritance diagram for ilCronDeleteInactiveUserAccounts:

Collaboration diagram for ilCronDeleteInactiveUserAccounts:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	hasCustomSettings ()

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)

	saveCustomSettings (ilPropertyFormGUI $a_form)

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?int $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 (?int $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 Member Functions
	isDecimal ($number)

	getTimeDifferenceBySchedule (int $schedule_time, int $multiplier)

	calculateDeletionData (int $date_for_deletion)

Private Attributes
const	DEFAULT_INACTIVITY_PERIOD = 365

const	DEFAULT_REMINDER_PERIOD = 0

int	$period

int	$reminderTimer

array	$include_roles

ilSetting	$settings

ilLanguage	$lng

ilRbacReview	$rbacReview

ilObjectDataCache	$objectDataCache

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

ilCronJobRepository	$cronRepository

ilGlobalTemplateInterface	$main_tpl

Additional Inherited Members
Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_MINUTES = 2
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_HOURS = 3
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_IN_DAYS = 4
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_WEEKLY = 5
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_MONTHLY = 6
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_QUARTERLY = 7
	This will be replaced with an ENUM in ILIAS 9 More...

const	SCHEDULE_TYPE_YEARLY = 8
	This will be replaced with an ENUM in ILIAS 9 More...

Protected Attributes inherited from ilCronJob
int	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Definition at line 25 of file class.ilCronDeleteInactiveUserAccounts.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteInactiveUserAccounts::__construct ( )

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

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

     {
         global $DIC;
         $this->main_tpl = $DIC->ui()->mainTemplate();
 
         if ($DIC) {
             if (isset($DIC['http'])) {
                 $this->http = $DIC->http();
             }
 
             if (isset($DIC['lng'])) {
                 $this->lng = $DIC->language();
             }
 
             if (isset($DIC['refinery'])) {
                 $this->refinery = $DIC->refinery();
             }
 
             if (isset($DIC['ilObjDataCache'])) {
                 $this->objectDataCache = $DIC['ilObjDataCache'];
             }
 
             if (isset($DIC['rbacreview'])) {
                 $this->rbacReview = $DIC->rbac()->review();
             }
 
             if (isset($DIC['cron.repository'])) {
                 $this->cronRepository = $DIC->cron()->repository();
             }
 
             if (isset($DIC['ilSetting'])) {
                 $this->settings = $DIC->settings();
 
                 $include_roles = $DIC['ilSetting']->get(
                     'cron_inactive_user_delete_include_roles',
                     null
                 );
                 if ($include_roles === null) {
                     $this->include_roles = [];
                 } else {
                     $this->include_roles = array_filter(array_map('intval', explode(',', $include_roles)));
                 }
 
                 $this->period = (int) $this->settings->get(
                     'cron_inactive_user_delete_period',
                     (string) self::DEFAULT_INACTIVITY_PERIOD
                 );
                 $this->reminderTimer = (int) $this->settings->get(
                     'cron_inactive_user_reminder_period',
                     (string) self::DEFAULT_REMINDER_PERIOD
                 );
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteInactiveUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 273 of file class.ilCronDeleteInactiveUserAccounts.php.

References ilPropertyFormGUI\addItem(), ilNumberInputGUI\allowDecimals(), ANONYMOUS_ROLE_ID, ilPropertyFormGUI\getItemByPostVar(), ILIAS\Repository\lng(), ilFormPropertyGUI\setInfo(), and ILIAS\Repository\settings().

                                                                       : void
     {
         $this->lng->loadLanguageModule("user");
 
         $schedule = $a_form->getItemByPostVar('type');
         $schedule->setTitle($this->lng->txt('delete_inactive_user_accounts_frequency'));
         $schedule->setInfo($this->lng->txt('delete_inactive_user_accounts_frequency_desc'));
 
         $sub_mlist = new ilMultiSelectInputGUI(
             $this->lng->txt('delete_inactive_user_accounts_include_roles'),
             'cron_inactive_user_delete_include_roles'
         );
         $sub_mlist->setInfo($this->lng->txt('delete_inactive_user_accounts_include_roles_desc'));
         $roles = [];
         foreach ($this->rbacReview->getGlobalRoles() as $role_id) {
             if ($role_id !== ANONYMOUS_ROLE_ID) {
                 $roles[$role_id] = $this->objectDataCache->lookupTitle($role_id);
             }
         }
         $sub_mlist->setOptions($roles);
         $setting = $this->settings->get('cron_inactive_user_delete_include_roles', null);
         if ($setting === null) {
             $setting = [];
         } else {
             $setting = explode(',', $setting);
         }
         $sub_mlist->setValue($setting);
         $sub_mlist->setWidth(300);
         $a_form->addItem($sub_mlist);
 
         $default_setting = (string) self::DEFAULT_INACTIVITY_PERIOD;
 
         $sub_text = new ilNumberInputGUI(
             $this->lng->txt('delete_inactive_user_accounts_period'),
             'cron_inactive_user_delete_period'
         );
         $sub_text->allowDecimals(false);
         $sub_text->setInfo($this->lng->txt('delete_inactive_user_accounts_period_desc'));
         $sub_text->setValue($this->settings->get("cron_inactive_user_delete_period", $default_setting));
         $sub_text->setSize(4);
         $sub_text->setMaxLength(4);
         $sub_text->setRequired(true);
         $a_form->addItem($sub_text);
 
         $sub_period = new ilNumberInputGUI(
             $this->lng->txt('send_mail_to_inactive_users'),
             'cron_inactive_user_reminder_period'
         );
         $sub_period->allowDecimals(false);
         $sub_period->setInfo($this->lng->txt("send_mail_to_inactive_users_desc"));
         $sub_period->setValue($this->settings->get("cron_inactive_user_reminder_period", $default_setting));
         $sub_period->setSuffix($this->lng->txt("send_mail_to_inactive_users_suffix"));
         $sub_period->setSize(4);
         $sub_period->setMaxLength(4);
         $sub_period->setRequired(false);
         $sub_period->setMinValue(0);
         $a_form->addItem($sub_period);
     }

Here is the call graph for this function:

◆ calculateDeletionData()

ilCronDeleteInactiveUserAccounts::calculateDeletionData ( int $date_for_deletion )

protected

Definition at line 251 of file class.ilCronDeleteInactiveUserAccounts.php.

References getId(), getTimeDifferenceBySchedule(), and ILIAS\Repository\int().

Referenced by hasCustomSettings().

                                                                     : int
     {
         $cron_timing = $this->cronRepository->getCronJobData($this->getId());
         $time_difference = 0;
         $multiplier = 1;
 
         if (!is_array($cron_timing) || !isset($cron_timing[0]) || !is_array($cron_timing[0])) {
             return time() + $date_for_deletion + $time_difference;
         }
 
         if (array_key_exists('schedule_type', $cron_timing[0])) {
             if ($cron_timing[0]['schedule_value'] !== null) {
                 $multiplier = (int) $cron_timing[0]['schedule_value'];
             }
             $time_difference = $this->getTimeDifferenceBySchedule(
                 (int) $cron_timing[0]['schedule_type'],
                 $multiplier
             );
         }
         return time() + $date_for_deletion + $time_difference;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteInactiveUserAccounts::getDefaultScheduleType ( )

Definition at line 157 of file class.ilCronDeleteInactiveUserAccounts.php.

                                             : int
     {
         return self::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilCronDeleteInactiveUserAccounts::getDefaultScheduleValue ( )

Definition at line 162 of file class.ilCronDeleteInactiveUserAccounts.php.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilCronDeleteInactiveUserAccounts::getDescription ( )

Definition at line 152 of file class.ilCronDeleteInactiveUserAccounts.php.

References ILIAS\Repository\lng().

                                     : string
     {
         return $this->lng->txt("delete_inactive_user_accounts_desc");
     }

Here is the call graph for this function:

◆ getId()

ilCronDeleteInactiveUserAccounts::getId ( )

Definition at line 142 of file class.ilCronDeleteInactiveUserAccounts.php.

Referenced by calculateDeletionData().

                            : string
     {
         return "user_inactive";
     }

Here is the caller graph for this function:

◆ getTimeDifferenceBySchedule()

ilCronDeleteInactiveUserAccounts::getTimeDifferenceBySchedule	(	int	$schedule_time,
		int	$multiplier
	)

protected

Definition at line 108 of file class.ilCronDeleteInactiveUserAccounts.php.

References ilCronJob\SCHEDULE_TYPE_DAILY, ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_IN_HOURS, ilCronJob\SCHEDULE_TYPE_IN_MINUTES, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, ilCronJob\SCHEDULE_TYPE_WEEKLY, and ilCronJob\SCHEDULE_TYPE_YEARLY.

Referenced by calculateDeletionData().

                                                                                        : int
     {
         $time_difference = 0;
 
         switch ($schedule_time) {
             case ilCronJob::SCHEDULE_TYPE_DAILY:
                 $time_difference = 86400;
                 break;
             case ilCronJob::SCHEDULE_TYPE_IN_MINUTES:
                 $time_difference = 60 * $multiplier;
                 break;
             case ilCronJob::SCHEDULE_TYPE_IN_HOURS:
                 $time_difference = 3600 * $multiplier;
                 break;
             case ilCronJob::SCHEDULE_TYPE_IN_DAYS:
                 $time_difference = 86400 * $multiplier;
                 break;
             case ilCronJob::SCHEDULE_TYPE_WEEKLY:
                 $time_difference = 604800;
                 break;
             case ilCronJob::SCHEDULE_TYPE_MONTHLY:
                 $time_difference = 2629743;
                 break;
             case ilCronJob::SCHEDULE_TYPE_QUARTERLY:
                 $time_difference = 7889229;
                 break;
             case ilCronJob::SCHEDULE_TYPE_YEARLY:
                 $time_difference = 31556926;
                 break;
         }
 
         return $time_difference;
     }

Here is the caller graph for this function:

◆ getTitle()

ilCronDeleteInactiveUserAccounts::getTitle ( )

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

References ILIAS\Repository\lng().

                               : string
     {
         return $this->lng->txt("delete_inactive_user_accounts");
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilCronDeleteInactiveUserAccounts::hasAutoActivation ( )

Definition at line 167 of file class.ilCronDeleteInactiveUserAccounts.php.

                                        : bool
     {
         return false;
     }

◆ hasCustomSettings()

ilCronDeleteInactiveUserAccounts::hasCustomSettings ( )

Definition at line 177 of file class.ilCronDeleteInactiveUserAccounts.php.

References $DIC, $reminderTimer, ANONYMOUS_USER_ID, calculateDeletionData(), ilObjectFactory\getInstanceByObjId(), ilObjUser\getUserIdsByInactivityPeriod(), ilCronDeleteInactiveUserReminderMail\removeEntriesFromTableIfLastLoginIsNewer(), ilCronJob\run(), ilCronDeleteInactiveUserReminderMail\sendReminderMailIfNeeded(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and SYSTEM_USER_ID.

                                        : bool
     {
         return true;
     }

Here is the call graph for this function:

◆ hasFlexibleSchedule()

ilCronDeleteInactiveUserAccounts::hasFlexibleSchedule ( )

Definition at line 172 of file class.ilCronDeleteInactiveUserAccounts.php.

                                          : bool
     {
         return true;
     }

◆ isDecimal()

ilCronDeleteInactiveUserAccounts::isDecimal ( $number )

protected

Parameters

string | int $number

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

Referenced by saveCustomSettings().

                                          : bool
     {
         $number = (string) $number;
 
         return strpos($number, ',') || strpos($number, '.');
     }

Here is the caller graph for this function:

◆ saveCustomSettings()

ilCronDeleteInactiveUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 332 of file class.ilCronDeleteInactiveUserAccounts.php.

References $valid, ilCronDeleteInactiveUserReminderMail\flushDataTable(), ilPropertyFormGUI\getItemByPostVar(), ILIAS\FileDelivery\http(), isDecimal(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilCronJob\SCHEDULE_TYPE_IN_DAYS, ilCronJob\SCHEDULE_TYPE_MONTHLY, ilCronJob\SCHEDULE_TYPE_QUARTERLY, ilCronJob\SCHEDULE_TYPE_WEEKLY, ilCronJob\SCHEDULE_TYPE_YEARLY, and ILIAS\Repository\settings().

                                                                  : bool
     {
         $this->lng->loadLanguageModule("user");
 
         $valid = true;
 
         $cron_period = $this->http->wrapper()->post()->retrieve(
             'type',
             $this->refinery->kindlyTo()->int()
         );
 
         $cron_period_custom = 0;
         $delete_period = 0;
         $reminder_period = '';
 
         $empty_string_trafo = $this->refinery->custom()->transformation(static function ($value): string {
             if ($value === '') {
                 return '';
             }
 
             throw new Exception('The value to be transformed is not an empty string');
         });
 
         if ($this->http->wrapper()->post()->has('sdyi')) {
             $cron_period_custom = $this->http->wrapper()->post()->retrieve(
                 'sdyi',
                 $this->refinery->byTrying([
                     $this->refinery->kindlyTo()->int(),
                     $empty_string_trafo
                 ])
             );
         }
 
         if ($this->http->wrapper()->post()->has('cron_inactive_user_delete_period')) {
             $delete_period = $this->http->wrapper()->post()->retrieve(
                 'cron_inactive_user_delete_period',
                 $this->refinery->byTrying([
                     $this->refinery->kindlyTo()->int(),
                     $this->refinery->in()->series([
                         $this->refinery->kindlyTo()->float(),
                         $this->refinery->kindlyTo()->int()
                     ])
                 ])
             );
         }
 
         if ($this->http->wrapper()->post()->has('cron_inactive_user_reminder_period')) {
             $reminder_period = $this->http->wrapper()->post()->retrieve(
                 'cron_inactive_user_reminder_period',
                 $this->refinery->byTrying([
                     $empty_string_trafo,
                     $this->refinery->byTrying([
                         $this->refinery->kindlyTo()->int(),
                         $this->refinery->in()->series([
                             $this->refinery->kindlyTo()->float(),
                             $this->refinery->kindlyTo()->int()
                         ])
                     ])
                 ])
             );
         }
 
         if ($this->isDecimal($delete_period)) {
             $valid = false;
             $a_form->getItemByPostVar('cron_inactive_user_delete_period')->setAlert(
                 $this->lng->txt('send_mail_to_inactive_users_numbers_only')
             );
         }
 
         if ($this->isDecimal($reminder_period)) {
             $valid = false;
             $a_form->getItemByPostVar('cron_inactive_user_reminder_period')->setAlert(
                 $this->lng->txt('send_mail_to_inactive_users_numbers_only')
             );
         }
 
         if ($reminder_period >= $delete_period) {
             $valid = false;
             $a_form->getItemByPostVar('cron_inactive_user_reminder_period')->setAlert(
                 $this->lng->txt('send_mail_to_inactive_users_must_be_smaller_than')
             );
         }
 
         if ($cron_period >= ilCronJob::SCHEDULE_TYPE_IN_DAYS && $cron_period <= ilCronJob::SCHEDULE_TYPE_YEARLY && $reminder_period > 0) {
             $logic = true;
             $check_window_logic = $delete_period - $reminder_period;
             if ($cron_period === ilCronJob::SCHEDULE_TYPE_IN_DAYS) {
                 if ($check_window_logic < $cron_period_custom) {
                     $logic = false;
                 }
             } elseif ($cron_period === ilCronJob::SCHEDULE_TYPE_WEEKLY) {
                 if ($check_window_logic <= 7) {
                     $logic = false;
                 }
             } elseif ($cron_period === ilCronJob::SCHEDULE_TYPE_MONTHLY) {
                 if ($check_window_logic <= 31) {
                     $logic = false;
                 }
             } elseif ($cron_period === ilCronJob::SCHEDULE_TYPE_QUARTERLY) {
                 if ($check_window_logic <= 92) {
                     $logic = false;
                 }
             } elseif ($cron_period === ilCronJob::SCHEDULE_TYPE_YEARLY) {
                 if ($check_window_logic <= 366) {
                     $logic = false;
                 }
             }
 
             if (!$logic) {
                 $valid = false;
                 $a_form->getItemByPostVar('cron_inactive_user_reminder_period')->setAlert(
                     $this->lng->txt('send_mail_reminder_window_too_small')
                 );
             }
         }
 
         if ($delete_period > 0) {
             $roles = implode(',', $this->http->wrapper()->post()->retrieve(
                 'cron_inactive_user_delete_include_roles',
                 $this->refinery->byTrying([
                     $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                     $this->refinery->always([])
                 ])
             ));
 
             $this->settings->set('cron_inactive_user_delete_include_roles', $roles);
             $this->settings->set('cron_inactive_user_delete_period', (string) $delete_period);
         }
 
         if ($this->reminderTimer > $reminder_period) {
             ilCronDeleteInactiveUserReminderMail::flushDataTable();
         }
 
         $this->settings->set('cron_inactive_user_reminder_period', (string) $reminder_period);
 
         if (!$valid) {
             $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("form_input_not_valid"));
             return false;
         }
 
         return true;
     }