Merge pull request #8476 from christianbeeznest/fixes-plugin-rss01

Plugin: Improve Rss plugin region integration

Author: christianbeeznest

public/main/admin/settings.lib.php

@@ -334,6 +334,7 @@ function getStablePluginAllowList(): array
         'MigrationMoodle',
         'EmbedRegistry',
         'SearchCourse',
+        'Rss',
     ];
 }
 

public/plugin/Rss/index.php

@@ -2,36 +2,40 @@
 
 /* For licensing terms, see /license.txt */
 
-use Zend\Feed\Reader\Feed\FeedInterface;
-use Zend\Feed\Reader\Reader;
+if (!function_exists('api_get_path')) {
+    require_once __DIR__.'/../../main/inc/global.inc.php';
+}
+
+require_once __DIR__.'/lib/rss_plugin.class.php';
 
 $plugin = RssPlugin::create();
 
-$url = $plugin->get_rss();
-$title = $plugin->get_block_title();
-$title = $title ? "<h4>$title</h4>" : '';
-$css = $plugin->get_css();
+$isDirectRequest = isset($_SERVER['SCRIPT_FILENAME'])
+    && realpath((string) $_SERVER['SCRIPT_FILENAME']) === realpath(__FILE__);
+
+$isRenderingOwnFullPage = defined('RSS_FULL_PAGE_RENDERING') && RSS_FULL_PAGE_RENDERING;
 
-if (empty($url)) {
-    echo Display::return_message(get_lang('NoRSSItem'), 'warning');
+if (!$plugin->isEnabled()) {
+    if ($isDirectRequest && !$isRenderingOwnFullPage) {
+        api_not_allowed(true);
+    }
 
     return;
 }
 
-try {
-    $channel = Reader::import($url);
-    if (!empty($channel)) {
-        /** @var FeedInterface $item */
-        foreach ($channel as $item) {
-            $title = $item->getTitle();
-            $link = $item->getLink();
-            if (!empty($link)) {
-                $title = Display::url($title, $link, ['target' => '_blank']);
-            }
-            echo Display::panel($item->getDescription(), $title);
-        }
-    }
-} catch (Exception $e) {
-    echo Display::return_message($plugin->get_lang('no_valid_rss'), 'warning');
-    error_log($e->getMessage());
+if ($isRenderingOwnFullPage) {
+    return;
 }
+
+if (!$isDirectRequest) {
+    echo $plugin->renderBlock();
+
+    return;
+}
+
+define('RSS_FULL_PAGE_RENDERING', true);
+
+$template = new Template($plugin->get_title());
+$template->assign('header', $plugin->get_title());
+$template->assign('content', $plugin->renderFullPage());
+$template->display_one_col_template();

public/plugin/Rss/lang/en_US.php

@@ -8,9 +8,14 @@
 $strings['plugin_title'] = 'RSS';
 $strings['plugin_comment'] = 'Display RSS content.';
 
-$strings['rss'] = 'RSS';
+$strings['rss'] = 'RSS URL';
+$strings['rss_help'] = 'Public HTTP or HTTPS URL of the RSS/Atom feed to display.';
 $strings['block_title'] = 'Block title';
+$strings['block_title_help'] = 'Optional title displayed above the feed items.';
 
 $strings['title'] = 'Title';
-$strings['no_rss'] = 'There is no RSS configured. Please add a RSS';
-$strings['no_valid_rss'] = 'Please check if the URL contains a valid RSS URL';
+$strings['Feed'] = 'Feed';
+$strings['no_rss'] = 'There is no RSS URL configured. Please add a valid RSS or Atom feed URL.';
+$strings['no_valid_rss'] = 'Please check if the URL contains a valid RSS or Atom feed.';
+$strings['invalid_rss_url'] = 'The RSS URL must be a valid public HTTP or HTTPS URL.';
+$strings['no_items'] = 'No RSS items were found.';

public/plugin/Rss/lang/es.php

@@ -8,9 +8,14 @@
 $strings['plugin_title'] = 'RSS';
 $strings['plugin_comment'] = 'Muestra contenido RSS.';
 
-$strings['rss'] = 'RSS';
+$strings['rss'] = 'URL RSS';
+$strings['rss_help'] = 'URL pública HTTP o HTTPS del feed RSS/Atom que se mostrará.';
 $strings['block_title'] = 'Título del bloque';
+$strings['block_title_help'] = 'Título opcional mostrado encima de los elementos del feed.';
 
 $strings['title'] = 'Título';
-$strings['no_rss'] = 'RSS no está configurado. Favor de agregar una fuente RSS';
-$strings['no_valid_rss'] = 'Por favor, verifica si la URL contiene una URL RSS válida';
+$strings['Feed'] = 'Feed';
+$strings['no_rss'] = 'RSS no está configurado. Agrega una URL RSS o Atom válida.';
+$strings['no_valid_rss'] = 'Verifica si la URL contiene un feed RSS o Atom válido.';
+$strings['invalid_rss_url'] = 'La URL RSS debe ser una URL pública HTTP o HTTPS válida.';
+$strings['no_items'] = 'No se encontraron elementos RSS.';