first commit

message/output/popup/classes/api.php

@@ -0,0 +1,114 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Contains class used to return information to display for the message popup.
+ *
+ * @package    message_popup
+ * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace message_popup;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class used to return information to display for the message popup.
+ *
+ * @copyright  2016 Ryan Wyllie <ryan@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class api {
+    /**
+     * Get popup notifications for the specified users. Nothing is returned if notifications are disabled.
+     *
+     * @param int $useridto the user id who received the notification
+     * @param string $sort the column name to order by including optionally direction
+     * @param int $limit limit the number of result returned
+     * @param int $offset offset the result set by this amount
+     * @return array notification records
+     * @throws \moodle_exception
+     * @since 3.2
+     */
+    public static function get_popup_notifications($useridto = 0, $sort = 'DESC', $limit = 0, $offset = 0) {
+        global $DB, $USER;
+
+        $sort = strtoupper($sort);
+        if ($sort != 'DESC' && $sort != 'ASC') {
+            throw new \moodle_exception('invalid parameter: sort: must be "DESC" or "ASC"');
+        }
+
+        if (empty($useridto)) {
+            $useridto = $USER->id;
+        }
+
+        // Is notification enabled ?
+        if ($useridto == $USER->id) {
+            $disabled = $USER->emailstop;
+        } else {
+            $user = \core_user::get_user($useridto, "emailstop", MUST_EXIST);
+            $disabled = $user->emailstop;
+        }
+        if ($disabled) {
+            // Notifications are disabled.
+            return array();
+        }
+
+        $sql = "SELECT n.id, n.useridfrom, n.useridto,
+                       n.subject, n.fullmessage, n.fullmessageformat,
+                       n.fullmessagehtml, n.smallmessage, n.contexturl,
+                       n.contexturlname, n.timecreated, n.component,
+                       n.eventtype, n.timeread, n.customdata
+                  FROM {notifications} n
+                 WHERE n.id IN (SELECT notificationid FROM {message_popup_notifications})
+                   AND n.useridto = ?
+              ORDER BY timecreated $sort, timeread $sort, id $sort";
+
+        $notifications = [];
+        $records = $DB->get_recordset_sql($sql, [$useridto], $offset, $limit);
+        foreach ($records as $record) {
+            $notifications[] = (object) $record;
+        }
+        $records->close();
+
+        return $notifications;
+    }
+
+    /**
+     * Count the unread notifications for a user.
+     *
+     * @param int $useridto the user id who received the notification
+     * @return int count of the unread notifications
+     * @since 3.2
+     */
+    public static function count_unread_popup_notifications($useridto = 0) {
+        global $USER, $DB;
+
+        if (empty($useridto)) {
+            $useridto = $USER->id;
+        }
+
+        return $DB->count_records_sql(
+            "SELECT count(id)
+               FROM {notifications}
+              WHERE id IN (SELECT notificationid FROM {message_popup_notifications})
+                AND useridto = ?
+                AND timeread is NULL",
+            [$useridto]
+        );
+    }
+}

message/output/popup/classes/output/popup_notification.php

@@ -0,0 +1,80 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Contains class used to prepare a popup notification for display.
+ *
+ * @package   message_popup
+ * @copyright 2016 Ryan Wyllie <ryan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace message_popup\output;
+
+defined('MOODLE_INTERNAL') || die();
+
+require_once($CFG->dirroot . '/message/lib.php');
+
+use renderable;
+use templatable;
+use moodle_url;
+use core_user;
+
+/**
+ * Class to prepare a popup notification for display.
+ *
+ * @package   message_popup
+ * @copyright 2016 Ryan Wyllie <ryan@moodle.com>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class popup_notification implements templatable, renderable {
+
+    /**
+     * @var \stdClass The notification.
+     */
+    protected $notification;
+
+    /**
+     * Constructor.
+     *
+     * @param \stdClass $notification
+     */
+    public function __construct($notification) {
+        $this->notification = $notification;
+    }
+
+    public function export_for_template(\renderer_base $output) {
+        $context = clone $this->notification;
+        $context->timecreatedpretty = get_string('ago', 'message', format_time(time() - $context->timecreated));
+        $context->text = message_format_message_text($context);
+        $context->read = $context->timeread ? true : false;
+
+        // Need to strip any HTML from these.
+        $context->subject = clean_param($context->subject, PARAM_TEXT);
+        $context->contexturlname = clean_param($context->contexturlname, PARAM_TEXT);
+        $context->shortenedsubject = shorten_text($context->subject, 125);
+
+        if (!empty($context->component) && substr($context->component, 0, 4) == 'mod_') {
+            $iconurl = $output->image_url('monologo', $context->component);
+        } else {
+            $iconurl = $output->image_url('i/marker', 'core');
+        }
+
+        $context->iconurl = $iconurl->out();
+
+        return $context;
+    }
+}

message/output/popup/classes/privacy/provider.php

@@ -0,0 +1,46 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Privacy Subsystem implementation for message_popup.
+ *
+ * @package    message_popup
+ * @copyright  2018 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace message_popup\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for message_popup implementing null_provider.
+ *
+ * @copyright  2018 Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class provider implements \core_privacy\local\metadata\null_provider {
+
+    /**
+     * Get the language string identifier with the component's language
+     * file to explain why this plugin stores no data.
+     *
+     * @return string
+     */
+    public static function get_reason(): string {
+        return 'privacy:metadata';
+    }
+}