Inheritance diagram for ilCronDeleteNeverLoggedInUserAccounts:

Collaboration diagram for ilCronDeleteNeverLoggedInUserAccounts:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()
	Is to be activated on "installation", does only work for ILIAS core cron jobs. More...

	hasFlexibleSchedule ()

	hasCustomSettings ()

	run ()

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

Private Attributes
const	DEFAULT_CREATION_THRESHOLD = 365

string	$roleIdWhiteliste = ''

int	$thresholdInDays = self::DEFAULT_CREATION_THRESHOLD

ilLanguage	$lng

ilSetting	$settings

ilRbacReview	$rbacreview

ilObjectDataCache	$objectDataCache

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

ilGlobalTemplateInterface	$main_tpl

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

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

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

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

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

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

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

const	SCHEDULE_TYPE_YEARLY = 8
	@depracated 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 23 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteNeverLoggedInUserAccounts::__construct ( )

Definition at line 37 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();
 
        if ($DIC) {
            if (isset($DIC['ilSetting'])) {
                $this->settings = $DIC->settings();
 
                $this->roleIdWhiteliste = (string) $this->settings->get(
                    'cron_users_without_login_delete_incl_roles',
                    ''
                );
 
                $this->thresholdInDays = (int) $this->settings->get(
                    'cron_users_without_login_delete_threshold',
                    (string) self::DEFAULT_CREATION_THRESHOLD
                );
            }
 
            if (isset($DIC['lng'])) {
                $this->lng = $DIC->language();
                $this->lng->loadLanguageModule('usr');
            }
 
            if (isset($DIC['rbacreview'])) {
                $this->rbacreview = $DIC->rbac()->review();
            }
 
            if (isset($DIC['ilObjDataCache'])) {
                $this->objectDataCache = $DIC['ilObjDataCache'];
            }
 
            if (isset($DIC['http'])) {
                $this->http = $DIC->http();
            }
 
            if (isset($DIC['refinery'])) {
                $this->refinery = $DIC->refinery();
            }
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteNeverLoggedInUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

Definition at line 186 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                                                      : void
    {
        $roleWhiteList = new ilMultiSelectInputGUI(
            $this->lng->txt('cron_users_without_login_del_role_whitelist'),
            'role_whitelist'
        );
        $roleWhiteList->setInfo($this->lng->txt('cron_users_without_login_del_role_whitelist_info'));
        $roles = array();
        foreach ($this->rbacreview->getGlobalRoles() as $role_id) {
            if ($role_id !== ANONYMOUS_ROLE_ID) {
                $roles[$role_id] = $this->objectDataCache->lookupTitle($role_id);
            }
        }
        $roleWhiteList->setOptions($roles);
        $roleWhiteList->setValue(array_filter(array_map('intval', explode(',', $this->roleIdWhiteliste))));
        $roleWhiteList->setWidth(300);
        $a_form->addItem($roleWhiteList);
 
        $threshold = new ilNumberInputGUI(
            $this->lng->txt('cron_users_without_login_del_create_date_thr'),
            'threshold'
        );
        $threshold->allowDecimals(false);
        $threshold->setInfo($this->lng->txt('cron_users_without_login_del_create_date_thr_info'));
        $threshold->setValue((string) $this->thresholdInDays);
        $threshold->setSuffix($this->lng->txt('days'));
        $threshold->setSize(4);
        $threshold->setMaxLength(4);
        $threshold->setRequired(true);
        $a_form->addItem($threshold);
    }

References ilPropertyFormGUI\addItem(), ANONYMOUS_ROLE_ID, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleType ( )

Reimplemented from ilCronJob.

Definition at line 99 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                            : int
    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleValue ( )

Reimplemented from ilCronJob.

Definition at line 104 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

◆ getDescription()

ilCronDeleteNeverLoggedInUserAccounts::getDescription ( )

Reimplemented from ilCronJob.

Definition at line 92 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                    : string
    {
        global $DIC;
 
        return $DIC->language()->txt('user_never_logged_in_info');
    }

References $DIC.

◆ getId()

ilCronDeleteNeverLoggedInUserAccounts::getId ( )

Reimplemented from ilCronJob.

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

                           : string
    {
        return 'user_never_logged_in';
    }

◆ getTitle()

ilCronDeleteNeverLoggedInUserAccounts::getTitle ( )

Reimplemented from ilCronJob.

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

                              : string
    {
        global $DIC;
 
        return $DIC->language()->txt('user_never_logged_in');
    }

References $DIC.

◆ hasAutoActivation()

ilCronDeleteNeverLoggedInUserAccounts::hasAutoActivation ( )

Is to be activated on "installation", does only work for ILIAS core cron jobs.

Reimplemented from ilCronJob.

Definition at line 109 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::hasCustomSettings ( )

Reimplemented from ilCronJob.

Definition at line 119 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronDeleteNeverLoggedInUserAccounts::hasFlexibleSchedule ( )

Reimplemented from ilCronJob.

Definition at line 114 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                         : bool
    {
        return true;
    }

◆ run()

ilCronDeleteNeverLoggedInUserAccounts::run ( )

Reimplemented from ilCronJob.

Definition at line 124 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                         : ilCronJobResult
    {
        global $DIC;
 
        $result = new ilCronJobResult();
 
        $status = ilCronJobResult::STATUS_NO_ACTION;
        $message = 'No user deleted';
 
        $userIds = ilObjUser::getUserIdsNeverLoggedIn(
            $this->thresholdInDays ?: self::DEFAULT_CREATION_THRESHOLD
        );
 
        $roleIdWhitelist = array_filter(array_map('intval', explode(',', $this->roleIdWhiteliste)));
 
        $counter = 0;
        foreach ($userIds as $userId) {
            if ($userId === ANONYMOUS_USER_ID || $userId === SYSTEM_USER_ID) {
                continue;
            }
 
            $user = ilObjectFactory::getInstanceByObjId($userId, false);
            if (!($user instanceof ilObjUser)) {
                continue;
            }
 
            $ignoreUser = true;
 
            if (count($roleIdWhitelist) > 0) {
                $assignedRoleIds = array_filter(array_map('intval', $this->rbacreview->assignedRoles($userId)));
 
                $respectedRolesToInclude = array_intersect($assignedRoleIds, $roleIdWhitelist);
                if (count($respectedRolesToInclude) > 0) {
                    $ignoreUser = false;
                }
            }
 
            if ($ignoreUser) {
                continue;
            }
 
            $DIC->logger()->user()->info(sprintf(
                "Deleting user account with id %s (login: %s)",
                $user->getId(),
                $user->getLogin()
            ));
            $user->delete();
 
            $counter++;
        }
 
        if ($counter) {
            $status = ilCronJobResult::STATUS_OK;
            $message = sprintf('%s user(s) deleted', $counter);
        }
 
        $result->setStatus($status);
        $result->setMessage($message);
 
        return $result;
    }

References $DIC, $message, ANONYMOUS_USER_ID, ilObjectFactory\getInstanceByObjId(), ilObjUser\getUserIdsNeverLoggedIn(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, and SYSTEM_USER_ID.

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

Reimplemented from ilCronJob.

Definition at line 218 of file class.ilCronDeleteNeverLoggedInUserAccounts.php.

                                                                 : bool
    {
        $valid = true;
 
        $this->roleIdWhiteliste = implode(',', $this->http->wrapper()->post()->retrieve(
            'role_whitelist',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->listOf($this->refinery->kindlyTo()->int()),
                $this->refinery->always([])
            ])
        ));
 
        try {
            $this->thresholdInDays = $this->http->wrapper()->post()->retrieve(
                'threshold',
                $this->refinery->kindlyTo()->int()
            );
        } catch (ConstraintViolationException $e) {
            $valid = false;
            $a_form->getItemByPostVar('threshold')->setAlert($this->lng->txt('user_never_logged_in_info_threshold_err_num'));
        }
 
        if ($valid) {
            $this->settings->set(
                'cron_users_without_login_delete_incl_roles',
                $this->roleIdWhiteliste
            );
            $this->settings->set(
                'cron_users_without_login_delete_threshold',
                (string) $this->thresholdInDays
            );
            return true;
        }
 
        $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
        return false;
    }