Update the plugin and fixes

* Update glide version
* Make sure we use cache to prevent fetching the feed at each page display
* Small refactoring
* Remove image prefix is set

Author: laurentdavid

.travis.yml

@@ -0,0 +1,25 @@
+# RSS Thumbnails #
+
+[![Moodle plugin CI for Moodle 3.9 and 3.10](https://github.com/call-learning/moodle-block_rss_thumbnails/actions/workflows/main.yml/badge.svg)](https://github.com/call-learning/moodle-block_rss_thumbnails/actions/workflows/main.yml)
+
+Display a given RSS feed in a slider. Mostly used on site frontpage.
+
+## License ##
+
+2021 CALL Learning <[email protected]>
+
+This program 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.
+
+This program 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
+this program.  If not, see <http://www.gnu.org/licenses/>.
+
+## Dependencies ##
+
+Glide.JS:  https://glidejs.com/docs/

README.md

@@ -5,12 +5,13 @@
  * @copyright 2020 - CALL Learning - Laurent David <laurent@call-learning>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-define(['jquery', 'block_rss_thumbnails/config'], function($) {
+// eslint-disable-next-line no-unused-vars
+define(['block_rss_thumbnails/config'], function() {
     return function(locator, config) {
         require(['glide'], function(Glide) {
             // Show the slider now we are initialised.
-            $(locator).removeClass('d-none');
-            new Glide(locator, config).mount();
+            document.querySelector(locator).classList.remove('d-none');
+            (new Glide(locator, config)).mount();
         });
     };
 });

amd/build/glide.min.js

@@ -25,7 +25,7 @@
 use block_rss_thumbnails\output\block;
 use block_rss_thumbnails\output\feed;
 use block_rss_thumbnails\output\footer;
-use block_rss_thumbnails\feed_creator;
+use block_rss_thumbnails\feed_factory;
 
 defined('MOODLE_INTERNAL') || die();
 global $CFG;
@@ -53,7 +53,6 @@ class block_rss_thumbnails extends block_base {
 
     /** @var bool Track whether any of the output feeds have recorded failures */
     private $hasfailedfeeds = false;
-
     /** @var int Defines the number of maximum feeds in the thumbnail */
     private $maxentries = self::DEFAULT_MAX_ENTRIES;
 
@@ -103,7 +102,7 @@ public function get_content() {
             return $this->content;
         }
         $carousseldelay = $this->config->carousseldelay ?? self::DEFAULT_CAROUSSEL_DELAY;
-        $block = new block($carousseldelay);
+        $block = new block($carousseldelay, $this->config->remove_image_size_suffix ?? false);
 
         if (!empty($this->config->rssid)) {
             list($rssidssql, $params) = $DB->get_in_or_equal($this->config->rssid);
@@ -117,14 +116,11 @@ public function get_content() {
             }
 
             $footer = $this->get_footer($rssfeeds);
-        } else {
-            $rssfeeds = array();
         }
 
         $renderer = $this->page->get_renderer('block_rss_thumbnails');
-
         $this->content = (object) [
-            'text' => $renderer->render($block, $rssfeeds),
+            'text' => $renderer->render($block),
             'footer' => $footer ? $renderer->render($footer) : ''
         ];
         return $this->content;
@@ -180,9 +176,20 @@ public function get_feed($feedrecord, $maxentries, $showtitle = true): ?feed {
             $this->hasfailedfeeds = true;
             return null;
         }
+        return feed_factory::create_feed_from_url($feedrecord->url, $maxentries, $showtitle);
 
-        return feed_creator::create_feed_from_url($feedrecord->url, $maxentries, $showtitle);
+    }
 
+    /**
+     * Serialize and store config data
+     *
+     * @param stdClass $data
+     * @param false $nolongerused
+     * @throws coding_exception
+     */
+    public function instance_config_save($data, $nolongerused = false) {
+        parent::instance_config_save($data, $nolongerused);
+        cache_helper::purge_by_event('block_rss_thumbnails/expiresfeed');
     }
 
     /**
@@ -197,7 +204,6 @@ public function get_feed($feedrecord, $maxentries, $showtitle = true): ?feed {
     public function format_title($title, $max = 64): string {
         return (core_text::strlen($title) <= $max) ? $title : core_text::substr($title, 0, $max - 3) . '...';
     }
-
     /**
      * Checks wether the configuration of the block is valid or not.
      *

amd/build/glide.min.js.map

@@ -27,6 +27,7 @@
 use block_rss_thumbnails\output\channel_image;
 use block_rss_thumbnails\output\feed;
 use block_rss_thumbnails\output\item;
+use cache;
 use moodle_exception;
 use moodle_url;
 use SimpleXMLElement;
@@ -38,7 +39,7 @@
  * @copyright 202 - CALL Learning - Martin CORNU-MANSUY <martin@call-learning>
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class feed_creator {
+class feed_factory {
 
     /** A list of XML entities. */
     const XML_ENTITIES = array(
@@ -70,13 +71,23 @@ class feed_creator {
     /**
      * A function that creates a feed from the given url of an xml file.
      *
+     * Note: we cache the feed content in the block_rss_thumbnails/feeds cache to avoid
+     * fetching the feed at each page load.
+     *
      * @param string $xmlurl the url of the file
      * @param int $maxentries the maximum number of items this feed will have
      * @param bool $showtitle should we display the title of the feed ?
+     * the feed provides the thumbnail image as xxx-80x80.png for example. The real image is xxx.png
      * @return feed|null the feed created or null if an error occurred
      */
     public static function create_feed_from_url(string $xmlurl, int $maxentries, bool $showtitle = true) {
-        return self::create_feed(file_get_contents($xmlurl), $maxentries, $showtitle);
+        $cache = cache::make('block_rss_thumbnails', 'feeds');
+        if ($cache->has($xmlurl)) {
+            return $cache->get($xmlurl);
+        }
+        $feed = self::create_feed(file_get_contents($xmlurl), $maxentries, $showtitle);
+        $cache->set($xmlurl, $feed);
+        return $feed;
     }
 
     /**
@@ -101,19 +112,19 @@ public static function create_feed(string $xmlsource, int $maxentries, bool $sho
         $image = $channel->image;
         if (!empty($image)) {
             $image = new channel_image(
-                    new moodle_url($image->url),
-                    $image->title,
-                    new moodle_url($image->link)
+                new moodle_url($image->url),
+                $image->title,
+                new moodle_url($image->link)
             );
         } else {
             $image = null;
         }
         $feed = new feed(
-                $channel->title,
-                new moodle_url($channel->link),
-                $image,
-                $showtitle,
-                $image ? true : false,
+            (string) $channel->title,
+            new moodle_url($channel->link),
+            $image,
+            $showtitle,
+            $image ? true : false
         );
 
         $counter = 0;
@@ -131,6 +142,16 @@ public static function create_feed(string $xmlsource, int $maxentries, bool $sho
         return $feed;
     }
 
+    /**
+     * Replaces HTML entities that could be in the xml file so SimpleXML will be able to interpret every entity.
+     *
+     * @param string $xmlfile the source file content as a string.
+     * @return string the source file content with only XML entities.
+     */
+    public static function normalize_xml_file(string $xmlfile): string {
+        return str_replace(self::HTML_ENTITIES, self::XML_ENTITIES, $xmlfile);
+    }
+
     /**
      * Creates all the items of a feed by calling {@see self::create_item()} and returns them into an array.
      *
@@ -161,12 +182,11 @@ private static function create_items(SimpleXMLElement $simplexmlelt): array {
      *
      * @param SimpleXMLElement $xmlitem The source of the item to be created.
      * @return item The item created.
-     * @throws moodle_exception See the use of {@see moodle_url}
      */
     public static function create_item(SimpleXMLElement $xmlitem) {
         $categories = [];
         foreach ($xmlitem->category as $category) {
-            $categories[] = $category;
+            $categories[] = (string) $category;
         }
 
         $namespaces = $xmlitem->getNamespaces(true);
@@ -180,22 +200,12 @@ public static function create_item(SimpleXMLElement $xmlitem) {
             $imageurl = new moodle_url("");
         }
 
-        $id = $xmlitem->guid ?? $xmlitem->title;
+        $id = (string) ($xmlitem->guid ?? $xmlitem->title);
         $link = new moodle_url($xmlitem->link);
-        $description = $xmlitem->description;
+        $description = (string) $xmlitem->description;
         $timestamp = strtotime($xmlitem->pubDate);
-        $title = $xmlitem->title;
+        $title = (string) $xmlitem->title;
 
         return new item($id, $link, $description, $timestamp, true, $title, $imageurl, $categories);
     }
-
-    /**
-     * Replaces HTML entities that could be in the xml file so SimpleXML will be able to interpret every entity.
-     *
-     * @param string $xmlfile the source file content as a string.
-     * @return string the source file content with only XML entities.
-     */
-    public static function normalize_xml_file(string $xmlfile): string {
-        return str_replace(self::HTML_ENTITIES, self::XML_ENTITIES, $xmlfile);
-    }
 }

amd/src/glide.js

@@ -37,22 +37,28 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class block implements renderable, templatable {
-
+    /**
+     * @var bool $removeimagesuffix should we remove image url suffix to show the large version of the image ? Sometime
+     * the feed provides the thumbnail image as xxx-80x80.png for example. The real image is xxx.png.
+     */
+    public $removeimagesuffix = false;
     /** @var int The delay between two slides of the caroussel (in milliseconds) */
     private $carousseldelay;
 
     /** @var array An array of renderable feeds */
     private $feeds;
 
     /**
-     * Contructor
+     * Constructor
      *
      * @param int $carousseldelay An integer representing the speed of the carroussel
-     * @param array $feeds An array of renderable feeds
+     * @param bool $removeimagesuffix should we remove the image prefix on export_for_template ?
      */
-    public function __construct(int $carousseldelay = block_rss_thumbnails::DEFAULT_CAROUSSEL_DELAY, array $feeds = array()) {
-        $this->feeds = $feeds;
+    public function __construct(int $carousseldelay = block_rss_thumbnails::DEFAULT_CAROUSSEL_DELAY,
+        bool $removeimagesuffix = false) {
+        $this->feeds = [];
         $this->carousseldelay = $carousseldelay;
+        $this->removeimagesuffix = $removeimagesuffix;
     }
 
     /**
@@ -67,6 +73,7 @@ public function export_for_template(renderer_base $output): array {
             'carousseldelay' => $this->carousseldelay
         );
         foreach ($this->feeds as $feed) {
+            $feed->removeimagesuffix = $this->removeimagesuffix;
             $data['feeds'][] = $feed->export_for_template($output);
         }
 

block_rss_thumbnails.php

@@ -37,6 +37,11 @@
  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 class feed implements renderable, templatable {
+    /**
+     * @var bool $removeimagesuffix should we remove image url suffix to show the large version of the image ? Sometime
+     * the feed provides the thumbnail image as xxx-80x80.png for example. The real image is xxx.png.
+     */
+    public $removeimagesuffix = false;
 
     /** @var string|null The feed's title. */
     private $title;
@@ -124,7 +129,6 @@ public function get_link() {
     public function get_title() {
         return $this->title;
     }
-
     /**
      * Export this for use in a mustache template context.
      *
@@ -141,6 +145,7 @@ public function export_for_template(renderer_base $output) {
         $data['image'] = ($this->showimage && $this->image) ? $this->image->export_for_template($output) : null;
 
         foreach ($this->items as $item) {
+            $item->removeimagesuffix = $this->removeimagesuffix;
             $data['items'][] = $item->export_for_template($output);
         }