Class ilCronDeleteNeverLoggedInUserAccounts. More...

Inheritance diagram for ilCronDeleteNeverLoggedInUserAccounts:

Collaboration diagram for ilCronDeleteNeverLoggedInUserAccounts:

Public Member Functions
	__construct ()
	ilCronDeleteNeverLoggedInUserAccounts constructor. More...

	getId ()
	Get id. Returns string More...

	getTitle ()
	Get title. Returns string More...

	getDescription ()
	Get description. Returns string More...

	getDefaultScheduleType ()
	Get schedule type. Returns int More...

	getDefaultScheduleValue ()
	Get schedule value. Returns int\|array More...

	hasAutoActivation ()
	Is to be activated on "installation". Returns boolean More...

	hasFlexibleSchedule ()
	Can the schedule be configured? Returns boolean More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? Returns boolean More...

	run ()
	Run job. Returns ilCronJobResult More...

	addCustomSettingsToForm (\ilPropertyFormGUI $a_form)

	saveCustomSettings (\ilPropertyFormGUI $a_form)

Public Member Functions inherited from ilCronJob
	isActive ($a_ts_last_run, $a_schedule_type, $a_schedule_value, $a_manual=false)
	Is job currently active? More...

	getScheduleType ()
	Get current schedule type (if flexible) More...

	getScheduleValue ()
	Get current schedule value (if flexible) More...

	setSchedule ($a_type, $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...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	isManuallyExecutable ()
	Defines whether or not a cron job can be started manually. More...

	hasCustomSettings ()
	Has cron job any custom setting which can be edited? More...

	addCustomSettingsToForm (ilPropertyFormGUI $a_form)
	Add custom settings to form. More...

	saveCustomSettings (ilPropertyFormGUI $a_form)
	Save custom settings. More...

	addToExternalSettingsForm ($a_form_id, array &$a_fields, $a_is_active)
	Add external settings to form. More...

	activationWasToggled ($a_currently_active)
	Cron job status was changed. More...

	getId ()
	Get id. More...

	hasAutoActivation ()
	Is to be activated on "installation". More...

	hasFlexibleSchedule ()
	Can the schedule be configured? More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

	run ()
	Run job. More...

Data Fields
const	DEFAULT_CREATION_THRESHOLD = 365

Data Fields inherited from ilCronJob
const	SCHEDULE_TYPE_DAILY = 1

const	SCHEDULE_TYPE_IN_MINUTES = 2

const	SCHEDULE_TYPE_IN_HOURS = 3

const	SCHEDULE_TYPE_IN_DAYS = 4

const	SCHEDULE_TYPE_WEEKLY = 5

const	SCHEDULE_TYPE_MONTHLY = 6

const	SCHEDULE_TYPE_QUARTERLY = 7

const	SCHEDULE_TYPE_YEARLY = 8

Protected Member Functions
	hasDecimals ($number)

Protected Member Functions inherited from ilCronJob
	checkSchedule ($a_ts_last_run, $a_schedule_type, $a_schedule_value)

Protected Attributes
	$lng

	$settings

	$rbacreview

	$objectDataCache

	$request

Private Attributes
	$roleIdWhiteliste = ''

	$thresholdInDays = self::DEFAULT_CREATION_THRESHOLD

Detailed Description

Class ilCronDeleteNeverLoggedInUserAccounts.

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

Constructor & Destructor Documentation

◆ __construct()

ilCronDeleteNeverLoggedInUserAccounts::__construct ( )

ilCronDeleteNeverLoggedInUserAccounts constructor.

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

    {
        global $DIC;
 
        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',
                    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->request = $DIC->http()->request();
            }
        }
    }

References $DIC, and settings().

Here is the call graph for this function:

Member Function Documentation

◆ addCustomSettingsToForm()

ilCronDeleteNeverLoggedInUserAccounts::addCustomSettingsToForm ( \ilPropertyFormGUI $a_form )

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

    {
        $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->setInfo($this->lng->txt('cron_users_without_login_del_create_date_thr_info'));
        $threshold->setValue($this->thresholdInDays);
        $threshold->setSuffix($this->lng->txt('days'));
        $threshold->setSize(4);
        $threshold->setMaxLength(4);
        $threshold->setRequired(true);
        $a_form->addItem($threshold);
    }

References ilPropertyFormGUI\addItem().

Here is the call graph for this function:

◆ getDefaultScheduleType()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

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

    {
        return self::SCHEDULE_TYPE_DAILY;
    }

References ilCronJob\SCHEDULE_TYPE_DAILY.

◆ getDefaultScheduleValue()

ilCronDeleteNeverLoggedInUserAccounts::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

    {
        return 1;
    }

◆ getDescription()

ilCronDeleteNeverLoggedInUserAccounts::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

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

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

References $DIC.

◆ getId()

ilCronDeleteNeverLoggedInUserAccounts::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

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

    {
        return 'user_never_logged_in';
    }

◆ getTitle()

ilCronDeleteNeverLoggedInUserAccounts::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

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

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

References $DIC.

◆ hasAutoActivation()

ilCronDeleteNeverLoggedInUserAccounts::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return false;
    }

◆ hasCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::hasCustomSettings ( )

Has cron job any custom setting which can be edited?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ hasDecimals()

ilCronDeleteNeverLoggedInUserAccounts::hasDecimals ( $number )

protected

Parameters

mixed $number

Returns: bool

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

                                            : bool
    {
        if (strpos($number, ',') !== false || strpos($number, '.') !== false) {
            return true;
        }
 
        return false;
    }

Referenced by saveCustomSettings().

Here is the caller graph for this function:

◆ hasFlexibleSchedule()

ilCronDeleteNeverLoggedInUserAccounts::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

    {
        return true;
    }

◆ run()

ilCronDeleteNeverLoggedInUserAccounts::run ( )

Run job.

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

    {
        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 || !($user instanceof \ilObjUser)) {
                continue;
            }
 
            $ignoreUser = true;
 
            if (count($roleIdWhitelist) > 0) {
                $assignedRoleIds = array_filter(array_map('intval', (array) $this->rbacreview->assignedRoles($userId)));
 
                $respectedRolesToInclude = array_intersect($assignedRoleIds, $roleIdWhitelist);
                if (count($respectedRolesToInclude) > 0) {
                    $ignoreUser = false;
                }
            }
 
            if ($ignoreUser) {
                continue;
            }
 
            $DIC->logger()->usr()->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, $result, ilObjectFactory\getInstanceByObjId(), ilObjUser\getUserIdsNeverLoggedIn(), ilCronJobResult\STATUS_NO_ACTION, and ilCronJobResult\STATUS_OK.

Here is the call graph for this function:

◆ saveCustomSettings()

ilCronDeleteNeverLoggedInUserAccounts::saveCustomSettings ( \ilPropertyFormGUI $a_form )

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

    {
        $valid = true;
 
        $roleIdWhitelist = $this->request->getParsedBody()['role_whitelist'] ?? [];
        $this->roleIdWhiteliste = implode(',', array_map('intval', (is_array($roleIdWhitelist) ? $roleIdWhitelist : [])));
 
        $this->thresholdInDays = $this->request->getParsedBody()['threshold'] ?? '';
 
        if (!is_numeric($this->thresholdInDays) || $this->hasDecimals($this->thresholdInDays)) {
            $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',
                (string) $this->roleIdWhiteliste
            );
            $this->settings->set(
                'cron_users_without_login_delete_threshold',
                (int) $this->thresholdInDays
            );
            return true;
        } else {
            \ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
            return false;
        }
    }