class.ilCronDeleteInactiveUserAccounts.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once "Services/Cron/classes/class.ilCronJob.php";

class ilCronDeleteInactiveUserAccounts extends ilCronJob
{       
        const DEFAULT_INACTIVITY_PERIOD = 365;

        private $period = null;

        private $include_roles = null;
        
        public function __construct()
        {
                global $ilSetting;

                if(is_object($ilSetting))
                {
                        $this->include_roles = $ilSetting->get(
                                'cron_inactive_user_delete_include_roles', null
                        );
                        if($this->include_roles === null) $this->include_roles = array();
                        else $this->include_roles = explode(',', $this->include_roles);

                        $this->period = $ilSetting->get(
                                'cron_inactive_user_delete_period',
                                self::DEFAULT_INACTIVITY_PERIOD
                        );
                }
        }
        
        public function getId()
        {
                return "user_inactive";
        }
        
        public function getTitle()
        {
                global $lng;
                
                return $lng->txt("delete_inactive_user_accounts");
        }
        
        public function getDescription()
        {
                global $lng;
                
                return $lng->txt("delete_inactive_user_accounts_desc");
        }
        
        public function getDefaultScheduleType()
        {
                return self::SCHEDULE_TYPE_DAILY;
        }
        
        public function getDefaultScheduleValue()
        {
                return;
        }
        
        public function hasAutoActivation()
        {
                return false;
        }
        
        public function hasFlexibleSchedule()
        {
                return true;
        }
        
        public function hasCustomSettings()
        {
                return true;
        }
        
        public function run()
        {               
                global $rbacreview;
                
                $status = ilCronJobResult::STATUS_NO_ACTION;
                
                $usr_ids = ilObjUser::_getUserIdsByInactivityPeriod($this->period);

                $counter = 0;
                foreach($usr_ids as $usr_id)
                {
                        if($usr_id == ANONYMOUS_USER_ID || $usr_id == SYSTEM_USER_ID) continue;

                        $continue = true;
                        foreach($this->include_roles as $role_id)
                        {
                                if( $rbacreview->isAssigned($usr_id, $role_id) )
                                {
                                        $continue = false;
                                        break;
                                }
                        }
                        if($continue) continue;

                        $user = ilObjectFactory::getInstanceByObjId($usr_id);

                        $user->delete();
                        
                        $counter++;
                }
                
                if($counter)
                {
                        $status = ilCronJobResult::STATUS_OK;
                }               
                $result = new ilCronJobResult();
                $result->setStatus($status);            
                return $result;
        }
        
        public function addCustomSettingsToForm(ilPropertyFormGUI $a_form)
        {
                global $lng, $rbacreview, $ilObjDataCache, $ilSetting;

                include_once('Services/Form/classes/class.ilMultiSelectInputGUI.php');
                $sub_mlist = new ilMultiSelectInputGUI(
                        $lng->txt('delete_inactive_user_accounts_include_roles'),
                        'cron_inactive_user_delete_include_roles'
                );
                $sub_mlist->setInfo($lng->txt('delete_inactive_user_accounts_include_roles_desc'));
                $roles = array();
                foreach($rbacreview->getGlobalRoles() as $role_id)
                {
                        if( $role_id != ANONYMOUS_ROLE_ID )
                                $roles[$role_id] = $ilObjDataCache->lookupTitle($role_id);
                }
                $sub_mlist->setOptions($roles);
                $setting = $ilSetting->get('cron_inactive_user_delete_include_roles', null);
                if($setting === null) $setting = array();
                else $setting = explode(',', $setting);
                $sub_mlist->setValue($setting);
                $sub_mlist->setWidth(300);
                #$sub_mlist->setHeight(100);
                $a_form->addItem($sub_mlist);

                $default_setting = self::DEFAULT_INACTIVITY_PERIOD;
                $sub_text = new ilNumberInputGUI(
                        $lng->txt('delete_inactive_user_accounts_period'),
                        'cron_inactive_user_delete_period'
                );
                $sub_text->setInfo($lng->txt('delete_inactive_user_accounts_period_desc'));
                $sub_text->setValue($ilSetting->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);            
                
                /*              
                $default_setting = ilCronDeleteInactiveUserAccounts::DEFAULT_SETTING_INCLUDE_ADMINS;
                $sub_cb = new ilCheckboxInputGUI($lng->txt('delete_inactive_user_accounts_include_admins'),'cron_inactive_user_delete_include_admins');
                $sub_cb->setChecked($ilSetting->get("cron_inactive_user_delete_include_admins", $default_setting) ? 1 : 0 );
                //$sub_cb->setOptionTitle($lng->txt('delete_inactive_user_accounts_include_admins'));
                $sub_cb->setInfo($lng->txt('delete_inactive_user_accounts_include_admins_desc'));
                $a_form->addItem($sub_cb);
                */              
        }
        
        public function saveCustomSettings(ilPropertyFormGUI $a_form)
        {
                global $ilSetting;
                
                $setting = implode(',', $_POST['cron_inactive_user_delete_include_roles']);
                if( !strlen($setting) ) $setting = null;
                $ilSetting->set('cron_inactive_user_delete_include_roles', $setting);
                $ilSetting->set('cron_inactive_user_delete_period', $_POST['cron_inactive_user_delete_period']);
                
                return true;
        }
}