first commit

blocks/news_items/block_news_items.php

@@ -0,0 +1,169 @@
+<?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/>.
+
+/**
+ * This file contains the news item block class, based upon block_base.
+ *
+ * @package    block_news_items
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+/**
+ * Class block_news_items
+ *
+ * @package    block_news_items
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class block_news_items extends block_base {
+    function init() {
+        $this->title = get_string('pluginname', 'block_news_items');
+    }
+
+    function get_content() {
+        global $CFG, $USER;
+
+        if ($this->content !== NULL) {
+            return $this->content;
+        }
+
+        $this->content = new stdClass;
+        $this->content->text = '';
+        $this->content->footer = '';
+
+        if (empty($this->instance)) {
+            return $this->content;
+        }
+
+
+        if ($this->page->course->newsitems) {   // Create a nice listing of recent postings
+
+            require_once($CFG->dirroot.'/mod/forum/lib.php');   // We'll need this
+
+            $text = '';
+
+            if (!$forum = forum_get_course_forum($this->page->course->id, 'news')) {
+                return '';
+            }
+
+            $modinfo = get_fast_modinfo($this->page->course);
+            if (empty($modinfo->instances['forum'][$forum->id])) {
+                return '';
+            }
+            $cm = $modinfo->instances['forum'][$forum->id];
+
+            if (!$cm->uservisible) {
+                return '';
+            }
+
+            $context = context_module::instance($cm->id);
+
+        /// User must have perms to view discussions in that forum
+            if (!has_capability('mod/forum:viewdiscussion', $context)) {
+                return '';
+            }
+
+        /// First work out whether we can post to this group and if so, include a link
+            $groupmode    = groups_get_activity_groupmode($cm);
+            $currentgroup = groups_get_activity_group($cm, true);
+
+            if (forum_user_can_post_discussion($forum, $currentgroup, $groupmode, $cm, $context)) {
+                $text .= '<div class="newlink"><a href="'.$CFG->wwwroot.'/mod/forum/post.php?forum='.$forum->id.'">'.
+                          get_string('addanewtopic', 'forum').'</a>...</div>';
+            }
+
+        /// Get all the recent discussions we're allowed to see
+
+            // This block displays the most recent posts in a forum in
+            // descending order. The call to default sort order here will use
+            // that unless the discussion that post is in has a timestart set
+            // in the future.
+            // This sort will ignore pinned posts as we want the most recent.
+            $sort = forum_get_default_sort_order(true, 'p.modified', 'd', false);
+            if (! $discussions = forum_get_discussions($cm, $sort, false,
+                                                        -1, $this->page->course->newsitems,
+                                                        false, -1, 0, FORUM_POSTS_ALL_USER_GROUPS) ) {
+                $text .= '('.get_string('nonews', 'forum').')';
+                $this->content->text = $text;
+                return $this->content;
+            }
+
+        /// Actually create the listing now
+
+            $strposttimeformat = get_string('strftimedatetime', 'core_langconfig');
+            $strmore = get_string('more', 'forum');
+
+        /// Accessibility: markup as a list.
+            $text .= "\n<ul class='unlist'>\n";
+            foreach ($discussions as $discussion) {
+
+                $discussion->subject = $discussion->name;
+
+                $discussion->subject = format_string($discussion->subject, true, $forum->course);
+
+                $posttime = $discussion->modified;
+                if (!empty($CFG->forum_enabletimedposts) && ($discussion->timestart > $posttime)) {
+                    $posttime = $discussion->timestart;
+                }
+
+                // If the user who created the discussion post has been deleted, indicate so.
+                if ($discussion->userdeleted) {
+                    $userfullname = get_string('deleteduser', 'mod_forum');
+                } else {
+                    $userfullname = fullname($discussion, has_capability('moodle/site:viewfullnames', $context));
+                }
+
+                $text .= '<li class="post">'.
+                         '<div class="head clearfix">'.
+                         '<div class="date">'.userdate($posttime, $strposttimeformat).'</div>'.
+                         '<div class="name">'.$userfullname.'</div>'.
+                         '</div>'.
+                         '<div class="info"><a href="'.$CFG->wwwroot.'/mod/forum/discuss.php?d='.$discussion->discussion.'">'.$discussion->subject.'</a></div>'.
+                         "</li>\n";
+            }
+            $text .= "</ul>\n";
+
+            $this->content->text = $text;
+
+            $this->content->footer = '<a href="'.$CFG->wwwroot.'/mod/forum/view.php?f='.$forum->id.'">'.
+                                      get_string('oldertopics', 'forum').'</a> ...';
+
+        /// If RSS is activated at site and forum level and this forum has rss defined, show link
+            if (isset($CFG->enablerssfeeds) && isset($CFG->forum_enablerssfeeds) &&
+                $CFG->enablerssfeeds && $CFG->forum_enablerssfeeds && $forum->rsstype && $forum->rssarticles) {
+                require_once($CFG->dirroot.'/lib/rsslib.php');   // We'll need this
+                if ($forum->rsstype == 1) {
+                    $tooltiptext = get_string('rsssubscriberssdiscussions','forum');
+                } else {
+                    $tooltiptext = get_string('rsssubscriberssposts','forum');
+                }
+                if (!isloggedin()) {
+                    $userid = $CFG->siteguest;
+                } else {
+                    $userid = $USER->id;
+                }
+
+                $this->content->footer .= '<br />'.rss_get_link($context->id, $userid, 'mod_forum', $forum->id, $tooltiptext);
+            }
+
+        }
+
+        return $this->content;
+    }
+}
+
+

blocks/news_items/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 block_news_items.
+ *
+ * @package    block_news_items
+ * @copyright  2018 Zig Tan <zig@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace block_news_items\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Privacy Subsystem for block_news_items implementing null_provider.
+ *
+ * @copyright  2018 Zig Tan <zig@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';
+    }
+}

blocks/news_items/db/access.php

@@ -0,0 +1,51 @@
+<?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/>.
+
+/**
+ * News items block caps.
+ *
+ * @package    block_news_items
+ * @copyright  Mark Nelson <markn@moodle.com>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$capabilities = array(
+
+    'block/news_items:myaddinstance' => array(
+        'captype' => 'write',
+        'contextlevel' => CONTEXT_SYSTEM,
+        'archetypes' => array(
+            'user' => CAP_ALLOW
+        ),
+
+        'clonepermissionsfrom' => 'moodle/my:manageblocks'
+    ),
+
+    'block/news_items:addinstance' => array(
+        'riskbitmask' => RISK_SPAM | RISK_XSS,
+
+        'captype' => 'write',
+        'contextlevel' => CONTEXT_BLOCK,
+        'archetypes' => array(
+            'editingteacher' => CAP_ALLOW,
+            'manager' => CAP_ALLOW
+        ),
+
+        'clonepermissionsfrom' => 'moodle/site:manageblocks'
+    ),
+);

blocks/news_items/lang/en/block_news_items.php

@@ -0,0 +1,28 @@
+<?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/>.
+
+/**
+ * Strings for component 'block_news_items', language 'en', branch 'MOODLE_20_STABLE'
+ *
+ * @package   block_news_items
+ * @copyright 1999 onwards Martin Dougiamas  {@link http://moodle.com}
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['news_items:addinstance'] = 'Add a new latest announcements block';
+$string['news_items:myaddinstance'] = 'Add a new latest announcements block to Dashboard';
+$string['pluginname'] = 'Latest announcements';
+$string['privacy:metadata'] = 'The Latest announcements block only shows data stored in the forum and does not store data itself.';

blocks/news_items/tests/behat/display_news.feature

@@ -0,0 +1,41 @@
+@block @block_news_items
+Feature: Latest announcements block displays the course latest news
+  In order to be aware of the course announcements
+  As a user
+  I need to see the latest announcements block in the main course page
+
+  @javascript
+  Scenario: Latest course announcements are displayed and can be configured
+    Given the following "users" exist:
+      | username | firstname | lastname | email |
+      | teacher1 | Teacher | 1 | teacher1@example.com |
+    And the following "courses" exist:
+      | fullname | shortname | category | newsitems |
+      | Course 1 | C1        | 0        | 5         |
+    And the following "course enrolments" exist:
+      | user     | course | role           |
+      | teacher1 | C1     | editingteacher |
+    And the following "blocks" exist:
+      | blockname  | contextlevel | reference | pagetypepattern | defaultregion |
+      | news_items | Course       | C1        | course-view-*   | side-pre      |
+    And the following "mod_forum > discussions" exist:
+      | user     | forum         | name             | message       |
+      | teacher1 | Announcements | Discussion One   | Not important |
+      | teacher1 | Announcements | Discussion Two   | Not important |
+      | teacher1 | Announcements | Discussion Three | Not important |
+    When I am on the "Course 1" Course page logged in as teacher1
+    Then I should see "Discussion One" in the "Latest announcements" "block"
+    And I should see "Discussion Two" in the "Latest announcements" "block"
+    And I should see "Discussion Three" in the "Latest announcements" "block"
+    And I navigate to "Settings" in current page administration
+    And I set the following fields to these values:
+      | Number of announcements | 2 |
+    And I press "Save and display"
+    And I should not see "Discussion One" in the "Latest announcements" "block"
+    And I should see "Discussion Two" in the "Latest announcements" "block"
+    And I should see "Discussion Three" in the "Latest announcements" "block"
+    And I navigate to "Settings" in current page administration
+    And I set the following fields to these values:
+      | Number of announcements | 0 |
+    And I press "Save and display"
+    And "Latest announcements" "block" should not exist

blocks/news_items/version.php

@@ -0,0 +1,30 @@
+<?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/>.
+
+/**
+ * Version details
+ *
+ * @package    block_news_items
+ * @copyright  1999 onwards Martin Dougiamas (http://dougiamas.com)
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+$plugin->version   = 2024042200;         // The current plugin version (Date: YYYYMMDDXX).
+$plugin->requires  = 2024041600;         // Requires this Moodle version.
+$plugin->component = 'block_news_items'; // Full name of the plugin (used for diagnostics)
+$plugin->dependencies = ['mod_forum' => 2024041600];