Course/group notifications. More...

Inheritance diagram for ilMembershipCronNotifications:

Collaboration diagram for ilMembershipCronNotifications:

Public Member Functions
	__construct ()

	getId ()

	getTitle ()

	getDescription ()

	getDefaultScheduleType ()

	getDefaultScheduleValue ()

	hasAutoActivation ()

	hasFlexibleSchedule ()

	run ()

	addToExternalSettingsForm (int $a_form_id, array &$a_fields, bool $a_is_active)

	activationWasToggled (ilDBInterface $db, ilSetting $setting, bool $a_currently_active)

Public Member Functions inherited from ilCronJob
	setDateTimeProvider (?Closure $date_time_provider)

	isDue (?DateTimeImmutable $last_run, ?CronJobScheduleType $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 (?CronJobScheduleType $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 ()

Protected Member Functions
	filterDuplicateItems (array $a_objects)
	Filter duplicate news items from structure*. More...

	sendMail (int $a_user_id, array $a_objects, string $a_last_run)
	Send news mail for 1 user and n objects. More...

Protected Attributes
ilLanguage	$lng

ilDBInterface	$db

ilLogger	$logger

ilTree	$tree

ilMembershipCronNotificationsData	$data

Protected Attributes inherited from ilCronJob
CronJobScheduleType	$schedule_type = null

int	$schedule_value = null

Closure	$date_time_provider = null

Detailed Description

Course/group notifications.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 29 of file class.ilMembershipCronNotifications.php.

Constructor & Destructor Documentation

◆ __construct()

ilMembershipCronNotifications::__construct ( )

Definition at line 36 of file class.ilMembershipCronNotifications.php.

References $DIC, ILIAS\Repository\lng(), and ILIAS\Repository\logger().

     {
         global $DIC;
 
         $this->lng = $DIC->language();
         $this->db = $DIC->database();
         $this->logger = $DIC->logger()->mmbr();
         $this->tree = $DIC->repositoryTree();
     }

Here is the call graph for this function:

Member Function Documentation

◆ activationWasToggled()

ilMembershipCronNotifications::activationWasToggled	(	ilDBInterface	$db,
		ilSetting	$setting,
		bool	$a_currently_active
	)

Definition at line 494 of file class.ilMembershipCronNotifications.php.

References ilSetting\set().

                                                                                                          : void
     {
         $setting->set("crsgrp_ntf", (string) ((int) $a_currently_active));
     }

Here is the call graph for this function:

◆ addToExternalSettingsForm()

ilMembershipCronNotifications::addToExternalSettingsForm	(	int	$a_form_id,
		array &	$a_fields,
		bool	$a_is_active
	)

Definition at line 482 of file class.ilMembershipCronNotifications.php.

References ilAdministrationSettingsFormHandler\FORM_COURSE, ilAdministrationSettingsFormHandler\FORM_GROUP, and ILIAS\Repository\lng().

                                                                                                   : void
     {
         switch ($a_form_id) {
             case ilAdministrationSettingsFormHandler::FORM_COURSE:
             case ilAdministrationSettingsFormHandler::FORM_GROUP:
                 $a_fields["enable_course_group_notifications"] = $a_is_active ?
                     $this->lng->txt("enabled") :
                     $this->lng->txt("disabled");
                 break;
         }
     }

Here is the call graph for this function:

◆ filterDuplicateItems()

ilMembershipCronNotifications::filterDuplicateItems ( array $a_objects )

protected

Filter duplicate news items from structure*.

Definition at line 321 of file class.ilMembershipCronNotifications.php.

References $path, and ILIAS\Repository\int().

Referenced by sendMail().

                                                              : array
     {
         $parent_map = $news_map = $parsed_map = array();
 
         // gather news ref ids and news parent ref ids
         foreach ($a_objects as $parent_ref_id => $news) {
             foreach ($news as $item) {
                 $news_map[$item["id"]] = (int) ($item["ref_id"] ?? 0);
                 $parent_map[$item["id"]][$parent_ref_id] = $parent_ref_id;
 
                 if ($item["aggregation"] ?? false) {
                     foreach ($item["aggregation"] as $subitem) {
                         $news_map[$subitem["id"]] = (int) ($subitem["ref_id"] ?? 0);
                         $parent_map[$subitem["id"]][$parent_ref_id] = $parent_ref_id;
                     }
                 }
             }
         }
         // if news has multiple parents find "lowest" parent in path
         foreach ($parent_map as $news_id => $parents) {
             if (count($parents) > 1 && $news_map[$news_id] > 0) {
                 $path = $this->tree->getPathId((int) $news_map[$news_id]);
                 $lookup = array_flip($path);
 
                 $level = 0;
                 foreach ($parents as $parent_ref_id) {
                     $level = max($level, (int) ($lookup[$parent_ref_id] ?? 0));
                 }
 
                 $parsed_map[$news_id] = $path[$level];
             }
         }
 
         return $parsed_map;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultScheduleType()

ilMembershipCronNotifications::getDefaultScheduleType ( )

Definition at line 66 of file class.ilMembershipCronNotifications.php.

                                             : CronJobScheduleType
     {
         return CronJobScheduleType::SCHEDULE_TYPE_DAILY;
     }

◆ getDefaultScheduleValue()

ilMembershipCronNotifications::getDefaultScheduleValue ( )

Definition at line 71 of file class.ilMembershipCronNotifications.php.

                                              : ?int
     {
         return null;
     }

◆ getDescription()

ilMembershipCronNotifications::getDescription ( )

Definition at line 61 of file class.ilMembershipCronNotifications.php.

References ILIAS\Repository\lng().

                                     : string
     {
         return $this->lng->txt("enable_course_group_notifications_desc");
     }

Here is the call graph for this function:

◆ getId()

ilMembershipCronNotifications::getId ( )

Definition at line 51 of file class.ilMembershipCronNotifications.php.

Referenced by run().

                            : string
     {
         return "mem_notification";
     }

Here is the caller graph for this function:

◆ getTitle()

ilMembershipCronNotifications::getTitle ( )

Definition at line 56 of file class.ilMembershipCronNotifications.php.

References ILIAS\Repository\lng().

                               : string
     {
         return $this->lng->txt("enable_course_group_notifications");
     }

Here is the call graph for this function:

◆ hasAutoActivation()

ilMembershipCronNotifications::hasAutoActivation ( )

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

                                        : bool
     {
         return false;
     }

◆ hasFlexibleSchedule()

ilMembershipCronNotifications::hasFlexibleSchedule ( )

Definition at line 81 of file class.ilMembershipCronNotifications.php.

                                          : bool
     {
         return true;
     }

◆ run()

ilMembershipCronNotifications::run ( )

Definition at line 86 of file class.ilMembershipCronNotifications.php.

References Vendor\Package\$c, $comments, $DIC, $lng, $res, ilLanguageFactory\_getLanguageOfUser(), ilObject\_lookupTitle(), ilNewsItem\determineNewsContent(), ilNewsItem\determineNewsTitle(), ilDatePresentation\formatDate(), ilLikeGUI\getExpressionText(), getId(), ilUserUtil\getNamePresentation(), IL_CAL_DATETIME, ilLanguage\loadLanguageModule(), ILIAS\Repository\logger(), ilObjectPlugin\lookupTxtById(), sendMail(), ilDatePresentation\setUseRelativeDates(), ilStr\shortenTextExtended(), ilCronJobResult\STATUS_NO_ACTION, ilCronJobResult\STATUS_OK, ilLanguage\txt(), and ilDatePresentation\useRelativeDates().

                          : ilCronJobResult
     {
         global $DIC;
 
         $this->logger->debug("===Member Notifications=== start");
 
         $status = ilCronJobResult::STATUS_NO_ACTION;
         $status_details = null;
 
         $setting = new ilSetting("cron");
         $last_run = $setting->get(get_class($this));
 
         // no last run?
         if (!$last_run) {
             $last_run = date("Y-m-d H:i:s", strtotime("yesterday"));
 
             $status_details = "No previous run found - starting from yesterday.";
         } // migration: used to be date-only value
         elseif (strlen($last_run) === 10) {
             $last_run .= " 00:00:00";
 
             $status_details = "Switched from daily runs to open schedule.";
         }
 
         // out-comment for debugging purposes
         //$last_run = date("Y-m-d H:i:s", strtotime("yesterday"));
 
         $last_run_unix = strtotime($last_run);
 
         $this->logger->debug("Last run: " . $last_run);
 
         $this->data = new ilMembershipCronNotificationsData($last_run_unix, $this->getId());
 
         $this->logger->debug("prepare sending mails");
 
         // send mails (1 max for each user)
 
         $old_lng = $this->lng;
         $old_dt = ilDatePresentation::useRelativeDates();
         ilDatePresentation::setUseRelativeDates(false);
 
         $user_news_aggr = $this->data->getAggregatedNews();
         if (count($user_news_aggr)) {
             foreach ($user_news_aggr as $user_id => $user_news) {
                 $this->logger->debug("sending mails to user " . $user_id . ", nr news: " . count($user_news));
                 $this->sendMail($user_id, $user_news, $last_run);
                 $DIC->cron()->manager()->ping($this->getId());
             }
             // mails were sent - set cron job status accordingly
             $status = ilCronJobResult::STATUS_OK;
         }
 
         ilDatePresentation::setUseRelativeDates($old_dt);
 
         $this->logger->debug("save run");
 
         // save last run
         $setting->set(get_class($this), date("Y-m-d H:i:s"));
         $result = new ilCronJobResult();
         $result->setStatus($status);
         if ($status_details) {
             $result->setMessage($status_details);
         }
         $this->logger->debug("===Member Notifications=== done");
         return $result;
     }

Here is the call graph for this function:

◆ sendMail()

ilMembershipCronNotifications::sendMail	(	int	$a_user_id,
		array	$a_objects,
		string	$a_last_run
	)

protected

Send news mail for 1 user and n objects.

Exceptions

ilDateTimeException|ilWACException

Definition at line 361 of file class.ilMembershipCronNotifications.php.

References $client, $DIC, $path, $txt, ilLink\_getStaticLink(), ilObjUser\_lookupLogin(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ANONYMOUS_USER_ID, filterDuplicateItems(), ilDatePresentation\formatDate(), ilLanguage\getUserLanguage(), IL_CAL_DATETIME, IL_CAL_UNIX, ILIAS\Repository\logger(), and ilLanguage\txt().

Referenced by run().

                                                                                      : void
     {
         global $DIC;
 
         $ilClientIniFile = $DIC['ilClientIniFile'];
 
         $ntf = new ilSystemNotification();
         $ntf->setLangModules(array("crs", "news"));
         // no single object anymore
         // $ntf->setRefId($a_ref_id);
         // $ntf->setGotoLangId('url');
         // $ntf->setSubjectLangId('crs_subject_course_group_notification');
 
         // user specific language
         $lng = $ntf->getUserLanguage($a_user_id);
         $filter_map = $this->filterDuplicateItems($a_objects);
 
         $tmp = array();
 
         foreach ($a_objects as $parent_ref_id => $items) {
             $parent = array();
 
             // path
             $path = array();
             foreach ($this->tree->getPathId($parent_ref_id) as $node) {
                 $path[] = $node;
             }
             $path = implode("-", $path);
 
             $parent_obj_id = ilObject::_lookupObjId((int) $parent_ref_id);
             $parent_type = ilObject::_lookupType($parent_obj_id);
 
             $parent["title"] = $lng->txt("obj_" . $parent_type) . ' "' . ilObject::_lookupTitle($parent_obj_id) . '"';
             $parent["url"] = "  " . $lng->txt("crs_course_group_notification_link") . " " . ilLink::_getStaticLink($parent_ref_id);
 
             $this->logger->debug("ref id: " . $parent_ref_id . ", items: " . count($items));
 
             // news summary
             $parsed = array();
             if (is_array($items)) {
                 foreach ($items as $news_item) {
                     if ($news_item === null) {
                         continue;
                     }
 
                     // # Type "<Object Title>": "<News Title>" - News Text
                     $parsed_item = $this->parseNewsItem($parent_ref_id, $filter_map, $news_item, false, $a_user_id);
                     if ($parsed_item) {
                         $parsed[md5($parsed_item)] = $parsed_item;
                     }
                 }
             }
 
             // any news?
             if (count($parsed)) {
                 $parent["news"] = implode("\n\n", $parsed);
                 $tmp[$path] = $parent;
             }
         }
 
         // any objects?
         if (!count($tmp)) {
             $this->logger->debug("returning");
             return;
         }
 
         ksort($tmp);
         $counter = 0;
         $obj_index = array();
         $txt = "";
         foreach ($tmp as $item) {
             $counter++;
 
             $txt .= "(" . $counter . ") " . $item["title"] . "\n" .
                 $item["url"] . "\n\n" .
                 $item["news"] . "\n\n";
 
             $obj_index[] = "(" . $counter . ") " . $item["title"];
         }
 
         $ntf->setIntroductionLangId("crs_intro_course_group_notification_for");
 
         // index
         $period = sprintf(
             $lng->txt("crs_intro_course_group_notification_index"),
             ilDatePresentation::formatDate(new ilDateTime($a_last_run, IL_CAL_DATETIME)),
             ilDatePresentation::formatDate(new ilDateTime(time(), IL_CAL_UNIX))
         );
         $ntf->addAdditionalInfo(
             $period,
             trim(implode("\n", $obj_index)),
             true,
             true
         );
 
         // object list
         $ntf->addAdditionalInfo(
             "",
             trim($txt),
             true
         );
 
         // :TODO: does it make sense to add client to subject?
         $client = $ilClientIniFile->readVariable('client', 'name');
         $subject = sprintf($lng->txt("crs_subject_course_group_notification"), $client);
 
         $mail_content = $ntf->composeAndGetMessage($a_user_id, null, "read", true);
         $this->logger->debug("sending mail content: " . $mail_content);
 
         // #10044
         $mail = new ilMail(ANONYMOUS_USER_ID);
         $mail->enqueue(
             ilObjUser::_lookupLogin($a_user_id),
             (string) null,
             (string) null,
             $subject,
             $mail_content,
             []
         );
     }