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 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 Attributes
const	DEFAULT_CREATION_THRESHOLD = 365

string	$roleIdWhiteliste = ''

int	$thresholdInDays = self::DEFAULT_CREATION_THRESHOLD

Language	$lng

ilSetting	$settings

ilRbacReview	$rbacreview

ilObjectDataCache	$objectDataCache

ILIAS HTTP GlobalHttpState	$http

ILIAS Refinery Factory	$refinery

ilGlobalTemplateInterface	$main_tpl

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

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

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteNeverLoggedInUserAccounts::__construct ( )

Definition at line 40 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\objectDataCache(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteNeverLoggedInUserAccounts::addCustomSettingsToForm ( ilPropertyFormGUI $a_form )

Definition at line 189 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 = [];
        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, ILIAS\Repository\lng(), and ILIAS\Repository\objectDataCache().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleType ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                            : JobScheduleType
    {
        return JobScheduleType::DAILY;
    }

◆ getDefaultScheduleValue()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleValue ( )

Reimplemented from ILIAS\Cron\CronJob.

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

◆ getDescription()

ilCronDeleteNeverLoggedInUserAccounts::getDescription ( )

Reimplemented from ILIAS\Cron\CronJob.

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

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

References $DIC.

◆ getId()

ilCronDeleteNeverLoggedInUserAccounts::getId ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                           : string
    {
        return 'user_never_logged_in';
    }

◆ getTitle()

ilCronDeleteNeverLoggedInUserAccounts::getTitle ( )

Reimplemented from ILIAS\Cron\CronJob.

Definition at line 88 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 ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return false;
    }

◆ hasCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::hasCustomSettings ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                       : bool
    {
        return true;
    }

◆ hasFlexibleSchedule()

ilCronDeleteNeverLoggedInUserAccounts::hasFlexibleSchedule ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                                         : bool
    {
        return true;
    }

◆ run()

ilCronDeleteNeverLoggedInUserAccounts::run ( )

Reimplemented from ILIAS\Cron\CronJob.

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

                         : JobResult
    {
        global $DIC;
 
        $result = new JobResult();
 
        $status = JobResult::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 = JobResult::STATUS_OK;
            $message = sprintf('%s user(s) deleted', $counter);
        }
 
        $result->setStatus($status);
        $result->setMessage($message);
 
        return $result;
    }

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

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::saveCustomSettings ( ilPropertyFormGUI $a_form )

Definition at line 221 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;
    }