Forum notifications. More...

Inheritance diagram for ilForumCronNotification:

Collaboration diagram for ilForumCronNotification:

Public Member Functions
	__construct ()

	getId ()
	Get id. More...

	getTitle ()
	Get title. More...

	getDescription ()
	Get description. More...

	getDefaultScheduleType ()
	Get schedule type. More...

	getDefaultScheduleValue ()
	Get schedule value. More...

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

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

	hasCustomSettings ()

	keepAlive ()

	run ()

	existsProviderObject ($post_id)

	activationWasToggled ($a_currently_active)

	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...

	getValidScheduleTypes ()
	Get all available schedule types. 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	KEEP_ALIVE_CHUNK_SIZE = 25

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

Static Public Attributes
static	$providerObject = array()

Protected Member Functions
	getRefIdsByObjId ($a_obj_id)

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

Protected Attributes
	$settings

	$logger

	$num_sent_messages = 0

Static Protected Attributes
static	$deleted_ids_cache = array()

static	$ref_ids_by_obj_id = array()

static	$accessible_ref_ids_by_user = array()

Private Member Functions
	addProviderObject ($row)

	resetProviderCache ()

Detailed Description

Forum notifications.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de; Nadia Matuschek nmatu.nosp@m.sche.nosp@m.k@dat.nosp@m.abay.nosp@m..de

Definition at line 13 of file class.ilForumCronNotification.php.

Constructor & Destructor Documentation

◆ __construct()

ilForumCronNotification::__construct ( )

Definition at line 55 of file class.ilForumCronNotification.php.

        {
                $this->settings = new ilSetting('frma');
        }

References settings().

Here is the call graph for this function:

Member Function Documentation

◆ activationWasToggled()

ilForumCronNotification::activationWasToggled ( $a_currently_active )

Parameters

bool $a_currently_active

Reimplemented from ilCronJob.

Definition at line 579 of file class.ilForumCronNotification.php.

        {               
                global $ilSetting;
                
                // propagate cron-job setting to object setting
                if((bool)$a_currently_active)
                {
                        $ilSetting->set('forum_notification', 2);
                }
                else
                {
                        $ilSetting->set('forum_notification', 1);
                }
        }

References $ilSetting.

◆ addProviderObject()

ilForumCronNotification::addProviderObject ( $row )

private

Parameters

$row

Definition at line 538 of file class.ilForumCronNotification.php.

        {
                $tmp_provider = new ilForumCronNotificationDataProvider($row);
 
                self::$providerObject[$row['pos_pk']] = $tmp_provider;
                self::$providerObject[$row['pos_pk']]->addRecipient($row['user_id']);
        }

References $row.

◆ existsProviderObject()

ilForumCronNotification::existsProviderObject ( $post_id )

Parameters

$post_id

Returns: bool

Definition at line 526 of file class.ilForumCronNotification.php.

        {
                if(isset(self::$providerObject[$post_id]))
                {
                        return true;
                }       
                return false;
        }

◆ getDefaultScheduleType()

ilForumCronNotification::getDefaultScheduleType ( )

Get schedule type.

Returns: int

Reimplemented from ilCronJob.

Definition at line 79 of file class.ilForumCronNotification.php.

        {
                return self::SCHEDULE_TYPE_IN_HOURS;
        }

References ilCronJob\SCHEDULE_TYPE_IN_HOURS.

◆ getDefaultScheduleValue()

ilForumCronNotification::getDefaultScheduleValue ( )

Get schedule value.

Returns: int|array

Reimplemented from ilCronJob.

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

        {
                return 1;
        }

◆ getDescription()

ilForumCronNotification::getDescription ( )

Get description.

Returns: string

Reimplemented from ilCronJob.

Definition at line 72 of file class.ilForumCronNotification.php.

        {
                global $lng;
 
                return $lng->txt("cron_forum_notification_crob_desc");
        }

References $lng.

◆ getId()

ilForumCronNotification::getId ( )

Get id.

Returns: string

Reimplemented from ilCronJob.

Definition at line 60 of file class.ilForumCronNotification.php.

        {
                return "frm_notification";
        }

Referenced by keepAlive().

Here is the caller graph for this function:

◆ getRefIdsByObjId()

ilForumCronNotification::getRefIdsByObjId ( $a_obj_id )

protected

Parameters

int $a_obj_id

Returns: array

Definition at line 387 of file class.ilForumCronNotification.php.

        {
                if(!array_key_exists($a_obj_id, self::$ref_ids_by_obj_id))
                {
                        self::$ref_ids_by_obj_id[$a_obj_id] = ilObject::_getAllReferences($a_obj_id);
                }
 
                return (array)self::$ref_ids_by_obj_id[$a_obj_id];
        }

References ilObject\_getAllReferences().

Here is the call graph for this function:

◆ getTitle()

ilForumCronNotification::getTitle ( )

Get title.

Returns: string

Reimplemented from ilCronJob.

Definition at line 65 of file class.ilForumCronNotification.php.

        {
                global $lng;
 
                return $lng->txt("cron_forum_notification");
        }

References $lng.

◆ hasAutoActivation()

ilForumCronNotification::hasAutoActivation ( )

Is to be activated on "installation".

Returns: boolean

Reimplemented from ilCronJob.

Definition at line 89 of file class.ilForumCronNotification.php.

        {
                return false;
        }

◆ hasCustomSettings()

ilForumCronNotification::hasCustomSettings ( )

Returns: bool

Reimplemented from ilCronJob.

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

        {
                return true;
        }

◆ hasFlexibleSchedule()

ilForumCronNotification::hasFlexibleSchedule ( )

Can the schedule be configured?

Returns: boolean

Reimplemented from ilCronJob.

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

        {
                return true;
        }

◆ keepAlive()

ilForumCronNotification::keepAlive ( )

Definition at line 110 of file class.ilForumCronNotification.php.

        {
                $this->logger->debug('Sending ping to cron manager ...');
                \ilCronManager::ping($this->getId());
                $this->logger->debug(sprintf('Current memory usage: %s', memory_get_usage(true)));
        }

References getId(), memory_get_usage, ilCronManager\ping(), and sprintf.

Referenced by run().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetProviderCache()

ilForumCronNotification::resetProviderCache ( )

private

Definition at line 549 of file class.ilForumCronNotification.php.

        {
                self::$providerObject = array();
        }

◆ run()

ilForumCronNotification::run ( )

Returns: ilCronJobResult

Reimplemented from ilCronJob.

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

        {
                global $ilDB, $ilSetting, $lng;
 
                $this->logger = $GLOBALS['DIC']->logger()->frm();
 
                $status = ilCronJobResult::STATUS_NO_ACTION;
 
                $lng->loadLanguageModule('forum');
 
                $this->logger->info('Started forum notification job ...');
 
                if(!($last_run_datetime = $ilSetting->get('cron_forum_notification_last_date')))
                {
                        $last_run_datetime = null;
                }
 
                $this->num_sent_messages = 0;
                $cj_start_date = date('Y-m-d H:i:s');
 
                if($last_run_datetime != null &&
                        checkDate(date('m', strtotime($last_run_datetime)), date('d', strtotime($last_run_datetime)), date('Y', strtotime($last_run_datetime))))
                {
                        $threshold = max(strtotime($last_run_datetime), strtotime('-' . (int)$this->settings->get('max_notification_age', 30) . ' days', time()));
                }
                else
                {
                        $threshold = strtotime('-' . (int)$this->settings->get('max_notification_age', 30) . ' days', time());
                }
 
                $this->logger->info(sprintf('Threshold for forum event determination is: %s', date('Y-m-d H:i:s', $threshold)));
 
                $threshold_date =  date('Y-m-d H:i:s', $threshold);
                $new_posts_condition = '
                        frm_posts.pos_status = %s AND (
                                (frm_posts.pos_date >= %s AND frm_posts.pos_date = frm_posts.pos_activation_date) OR 
                                (frm_posts.pos_activation_date >= %s AND frm_posts.pos_date < frm_posts.pos_activation_date)
                        ) ';
                $types          = array('integer', 'timestamp', 'timestamp');
                $values         = array(1, $threshold_date, $threshold_date);
                
                /*** new posts ***/
                $res = $ilDB->queryf('
                        SELECT  frm_threads.thr_subject thr_subject, 
                                        frm_data.top_name top_name, 
                                        frm_data.top_frm_fk obj_id, 
                                        frm_notification.user_id user_id, 
                                        frm_threads.thr_pk thread_id,
                                        frm_posts.* 
                        FROM    frm_notification, frm_posts, frm_threads, frm_data 
                        WHERE   frm_posts.pos_thr_fk = frm_threads.thr_pk AND '.$new_posts_condition.' 
                        AND     ((frm_threads.thr_top_fk = frm_data.top_pk AND  frm_data.top_frm_fk = frm_notification.frm_id)
                                        OR (frm_threads.thr_pk = frm_notification.thread_id 
                        AND     frm_data.top_pk = frm_threads.thr_top_fk) )
                        AND     frm_posts.pos_display_user_id != frm_notification.user_id
                        ORDER BY frm_posts.pos_date ASC',
                        $types,
                        $values
                );
                
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "new posting" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_POST_NEW);
                        $this->logger->info(sprintf('Sent notifications for new postings ...'));
                }
 
                $this->keepAlive();
 
                /*** updated posts ***/
                $updated_condition = '
                        frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND 
                        (frm_posts.pos_update > frm_posts.pos_date AND frm_posts.pos_update >= %s) ';
                $types             = array('integer', 'integer', 'timestamp');
                $values            = array(0, 1, $threshold_date);
 
                $res = $ilDB->queryf('
                        SELECT  frm_threads.thr_subject thr_subject, 
                                        frm_data.top_name top_name, 
                                        frm_data.top_frm_fk obj_id, 
                                        frm_notification.user_id user_id,
                                        frm_threads.thr_pk thread_id,
                                        frm_posts.* 
                        FROM    frm_notification, frm_posts, frm_threads, frm_data 
                        WHERE   frm_posts.pos_thr_fk = frm_threads.thr_pk AND '.$updated_condition.' 
                        AND     ((frm_threads.thr_top_fk = frm_data.top_pk AND  frm_data.top_frm_fk = frm_notification.frm_id)
                                        OR (frm_threads.thr_pk = frm_notification.thread_id 
                        AND     frm_data.top_pk = frm_threads.thr_top_fk) )
                        AND     frm_posts.pos_display_user_id != frm_notification.user_id
                        ORDER BY frm_posts.pos_date ASC',
                        $types,
                        $values
                );
                
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "updated posting" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_POST_UPDATED);
                        $this->logger->info(sprintf('Sent notifications for updated postings ...'));
                }
 
                $this->keepAlive();
 
                /*** censored posts ***/ 
                $censored_condition = '
                        frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND  
            (frm_posts.pos_cens_date >= %s AND frm_posts.pos_cens_date > frm_posts.pos_activation_date ) ';
                $types              = array('integer', 'integer', 'timestamp');
                $values             = array(1, 1, $threshold_date);
 
                $res = $ilDB->queryf('
                        SELECT  frm_threads.thr_subject thr_subject, 
                                        frm_data.top_name top_name, 
                                        frm_data.top_frm_fk obj_id, 
                                        frm_notification.user_id user_id,
                                        frm_threads.thr_pk thread_id,
                                        frm_posts.* 
                        FROM    frm_notification, frm_posts, frm_threads, frm_data 
                        WHERE   frm_posts.pos_thr_fk = frm_threads.thr_pk AND '.$censored_condition.'
                        AND     ((frm_threads.thr_top_fk = frm_data.top_pk AND  frm_data.top_frm_fk = frm_notification.frm_id)
                                        OR (frm_threads.thr_pk = frm_notification.thread_id 
                        AND     frm_data.top_pk = frm_threads.thr_top_fk) )
                        AND     (frm_posts.pos_display_user_id != frm_notification.user_id)
                        ORDER BY frm_posts.pos_date ASC',
                        $types,
                        $values
                );
                
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "censored posting" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_POST_CENSORED);
                        $this->logger->info(sprintf('Sent notifications for new censored ...'));
                }
 
                $this->keepAlive();
 
                /*** uncensored posts ***/
                $uncensored_condition = '
                        frm_posts.pos_cens = %s AND frm_posts.pos_status = %s AND  
            (frm_posts.pos_cens_date >= %s AND frm_posts.pos_cens_date > frm_posts.pos_activation_date ) ';
                $types              = array('integer', 'integer', 'timestamp');
                $values             = array(0, 1, $threshold_date);
 
                $res = $ilDB->queryf('
                        SELECT  frm_threads.thr_subject thr_subject, 
                                        frm_data.top_name top_name, 
                                        frm_data.top_frm_fk obj_id, 
                                        frm_notification.user_id user_id,
                                        frm_threads.thr_pk thread_id,
                                        frm_posts.* 
                        FROM    frm_notification, frm_posts, frm_threads, frm_data 
                        WHERE   frm_posts.pos_thr_fk = frm_threads.thr_pk AND '.$uncensored_condition.' 
                        AND     ((frm_threads.thr_top_fk = frm_data.top_pk AND  frm_data.top_frm_fk = frm_notification.frm_id)
                                        OR (frm_threads.thr_pk = frm_notification.thread_id 
                        AND     frm_data.top_pk = frm_threads.thr_top_fk) )
                        AND     frm_posts.pos_display_user_id != frm_notification.user_id
                        ORDER BY frm_posts.pos_date ASC',
                        $types,
                        $values
                );
                
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "uncensored posting" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_POST_UNCENSORED);
                        $this->logger->info(sprintf('Sent notifications for uncensored postings ...'));
                }
 
                $this->keepAlive();
 
                /*** deleted threads ***/
                $res = $ilDB->queryF('
                        SELECT  frm_posts_deleted.thread_title thr_subject, 
                                        frm_posts_deleted.forum_title  top_name, 
                                        frm_posts_deleted.obj_id obj_id, 
                                        frm_notification.user_id user_id, 
                                        frm_posts_deleted.pos_display_user_id,
                                        frm_posts_deleted.pos_usr_alias,
                                        frm_posts_deleted.deleted_id,
                                        frm_posts_deleted.post_date pos_date,
                                        frm_posts_deleted.post_title pos_subject,
                                        frm_posts_deleted.post_message pos_message
                                        
                        FROM    frm_notification, frm_posts_deleted
                        
                        WHERE   ( frm_posts_deleted.obj_id = frm_notification.frm_id
                                        OR frm_posts_deleted.thread_id = frm_notification.thread_id) 
                        AND     frm_posts_deleted.pos_display_user_id != frm_notification.user_id
                        AND     frm_posts_deleted.is_thread_deleted = %s
                        ORDER BY frm_posts_deleted.post_date ASC',
                        array('integer'), array(1));
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "deleted threads" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_THREAD_DELETED);
                        if(count(self::$deleted_ids_cache) > 0)
                        {
                                $ilDB->manipulate('DELETE FROM frm_posts_deleted WHERE '. $ilDB->in('deleted_id', self::$deleted_ids_cache, false, 'integer'));
                                $this->logger->info('Deleted obsolete entries of table "frm_posts_deleted" ...');
                        }
                        $this->logger->info(sprintf('Sent notifications for deleted threads ...'));
                }
 
                $this->keepAlive();
 
                /*** deleted posts ***/
                $res = $ilDB->queryF('
                        SELECT  frm_posts_deleted.thread_title thr_subject, 
                                        frm_posts_deleted.forum_title  top_name, 
                                        frm_posts_deleted.obj_id obj_id, 
                                        frm_notification.user_id user_id, 
                                        frm_posts_deleted.pos_display_user_id,
                                        frm_posts_deleted.pos_usr_alias,
                                        frm_posts_deleted.deleted_id,
                                        frm_posts_deleted.post_date pos_date,
                                        frm_posts_deleted.post_title pos_subject,
                                        frm_posts_deleted.post_message pos_message
                                        
                        FROM    frm_notification, frm_posts_deleted
                        
                        WHERE   ( frm_posts_deleted.obj_id = frm_notification.frm_id
                                        OR frm_posts_deleted.thread_id = frm_notification.thread_id) 
                        AND     frm_posts_deleted.pos_display_user_id != frm_notification.user_id
                        AND     frm_posts_deleted.is_thread_deleted = %s
                        ORDER BY frm_posts_deleted.post_date ASC',
                        array('integer'), array(0));
                
                $numRows = $ilDB->numRows($res);
                if($numRows > 0)
                {
                        $this->logger->info(sprintf('Sending notifications for %s "deleted postings" events ...', $numRows));
                        $this->sendCronForumNotification($res, ilForumMailNotification::TYPE_POST_DELETED);
                        if(count(self::$deleted_ids_cache) > 0)
                        {
                                $ilDB->manipulate('DELETE FROM frm_posts_deleted WHERE '. $ilDB->in('deleted_id', self::$deleted_ids_cache, false, 'integer')); 
                                $this->logger->info('Deleted entries from table "frm_posts_deleted" ...');
                        }
                        $this->logger->info(sprintf('Sent notifications for deleted postings ...'));
                }
 
                $ilSetting->set('cron_forum_notification_last_date', $cj_start_date);
 
                $mess = 'Sent '.$this->num_sent_messages.' messages.';
 
                $this->logger->info($mess);
                $this->logger->info('Finished forum notification job');
 
                $result = new ilCronJobResult();
                if($this->num_sent_messages)
                {
                        $status = ilCronJobResult::STATUS_OK;
                        $result->setMessage($mess);
                };
                $result->setStatus($status);
                return $result;
        }

References $GLOBALS, $ilDB, $ilSetting, $lng, $res, $result, date, keepAlive(), settings(), sprintf, ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, ilForumMailNotification\TYPE_POST_CENSORED, ilForumMailNotification\TYPE_POST_DELETED, ilForumMailNotification\TYPE_POST_NEW, ilForumMailNotification\TYPE_POST_UNCENSORED, ilForumMailNotification\TYPE_POST_UPDATED, and ilForumMailNotification\TYPE_THREAD_DELETED.

Here is the call graph for this function:

◆ saveCustomSettings()

ilForumCronNotification::saveCustomSettings ( ilPropertyFormGUI $a_form )

Parameters

ilPropertyFormGUI $a_form

Returns: bool

Reimplemented from ilCronJob.

Definition at line 622 of file class.ilForumCronNotification.php.

        {
                $this->settings->set('max_notification_age', $a_form->getInput('max_notification_age'));
                return true;
        }