Merge pull request #45 from catalyst/filter-class

fix: Move filter to /classes for 4.5 compat

Author: Peterburnett

filter.php renamed to classes/text_filter.php

@@ -14,6 +14,8 @@
 // You should have received a copy of the GNU General Public License
 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
 
+namespace filter_smartmedia;
+
 use local_smartmedia\conversion;
 use core\plugininfo\media;
 use core\url;
@@ -22,6 +24,13 @@
 use core\context\course;
 use local_smartmedia\aws_api;
 use local_smartmedia\aws_elastic_transcoder;
+use core_media_manager;
+use core_media_player_native;
+use media_videojs_plugin;
+use DOMDocument;
+use DOMXPath;
+use stdClass;
+use core\output\single_button;
 
 /**
  * Automatic smart media embedding filter class.
@@ -30,7 +39,7 @@
  * @copyright  2019 Matt Porritt <mattp@catalyst-au.net>
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
-class filter_smartmedia extends moodle_text_filter {
+class text_filter extends \core_filters\text_filter {
 
     /**
      * Video.js plugin enabled status not set.
@@ -126,7 +135,7 @@ class filter_smartmedia extends moodle_text_filter {
      * @param array $localconfig Any context-specific configuration for this filter.
      * @param conversion|null $conversion
      */
-    public function __construct($context, array $localconfig, conversion $conversion = null) {
+    public function __construct($context, array $localconfig, ?conversion $conversion = null) {
         parent::__construct($context, $localconfig);
 
         if (!empty($conversion)) {
@@ -576,7 +585,7 @@ public function filter($text, array $options = []) {
         // Add a wrapping div so DOMDocument doesnt mangle the structure.
         $loadtext = '<div>' . $text . '</div>';
         // Ensure the encoding can be loaded by the domdoc.
-        $loadtext = mb_convert_encoding($loadtext, 'HTML-ENTITIES', 'UTF-8');
+        $loadtext = html_entity_decode($loadtext);
 
         // Supress warnings. HTML5 nodes currently throw warnings.
         // Use flags to prevent html and body tags from being included.
@@ -609,7 +618,7 @@ public function filter($text, array $options = []) {
             // Encase in another div to prevent mangling when loading into the new domdoc.
             $newtext = '<div>' . $newtext . '</div>';
             // Encode to the domdocument usable format.
-            $newtext = mb_convert_encoding($newtext, 'HTML-ENTITIES', 'UTF-8');
+            $newtext = html_entity_decode($newtext);
 
             // Open that as a new doc to pull the video node out.
             $tempdom = new DOMDocument('1.0', 'UTF-8');
@@ -653,7 +662,7 @@ public function filter($text, array $options = []) {
                     if ($link->isSameNode($newlink)) {
                         $exists = true;
                     }
-                } catch (Throwable $e) {
+                } catch (\Throwable $e) {
                     // Some error, likely when the $link is no longer a valid DOMElement.
                     continue;
                 }
@@ -679,7 +688,7 @@ public function filter($text, array $options = []) {
             // Encase in another div to prevent mangling when loading into the new domdoc.
             $newtext = '<div>' . $newtext . '</div>';
             // Encode to the domdocument usable format.
-            $newtext = mb_convert_encoding($newtext, 'HTML-ENTITIES', 'UTF-8');
+            $newtext = html_entity_decode($newtext);
 
             // Open that as a new doc to pull the video node out.
             $tempdom = new DOMDocument('1.0', 'UTF-8');

tests/filter_test.php

@@ -21,14 +21,14 @@
 use core\context\course;
 use core\context\module;
 use local_smartmedia\conversion;
+use filter_smartmedia\text_filter;
 
 defined('MOODLE_INTERNAL') || die();
 
 global $CFG;
-require_once($CFG->dirroot . '/filter/smartmedia/filter.php'); // Include the code to test.
 
 /**
- * Unit test for the filter_smartmedia
+ * Unit test for the text_filter
  *
  * @package    filter_smartmedia
  * @copyright  2019 Matt Porritt <mattp@catalyst-au.net>
@@ -63,10 +63,10 @@ public function setUp(): void {
     public function test_videojs_enabled_true(): void {
         $this->resetAfterTest(true);
 
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         // We're testing a private method, so we need to setup reflector magic.
-        $method = new ReflectionMethod('filter_smartmedia', 'videojs_enabled');
+        $method = new ReflectionMethod('\filter_smartmedia\text_filter', 'videojs_enabled');
         $method->setAccessible(true); // Allow accessing of private method.
         $proxy = $method->invoke($filterplugin); // Get result of invoked method.
 
@@ -82,10 +82,10 @@ public function test_videojs_enabled_false(): void {
         // Only enable the HTML5 video player not video.js.
         media::set_enabled_plugins('html5video');
 
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         // We're testing a private method, so we need to setup reflector magic.
-        $method = new ReflectionMethod('filter_smartmedia', 'videojs_enabled');
+        $method = new ReflectionMethod('\filter_smartmedia\text_filter', 'videojs_enabled');
         $method->setAccessible(true); // Allow accessing of private method.
         $proxy = $method->invoke($filterplugin); // Get result of invoked method.
 
@@ -98,12 +98,12 @@ public function test_videojs_enabled_false(): void {
      */
     public function test_get_smart_elements_no_smart(): void {
         $this->resetAfterTest(true);
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         $linkhref = 'http://moodle.local/pluginfile.php/1461/mod_label/intro/SampleVideo1mb.mp4';
 
         // We're testing a private method, so we need to setup reflector magic.
-        $method = new ReflectionMethod('filter_smartmedia', 'get_smart_elements');
+        $method = new ReflectionMethod('\filter_smartmedia\text_filter', 'get_smart_elements');
         $method->setAccessible(true); // Allow accessing of private method.
         list($context, $proxy) = $method->invoke($filterplugin, $linkhref); // Get result of invoked method.
 
@@ -113,7 +113,7 @@ public function test_get_smart_elements_no_smart(): void {
 
     public function test_get_embed_markup_simple(): void {
         $this->resetAfterTest(true);
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         $linkhref = 'http://moodle.local/pluginfile.php/1461/mod_label/intro/OriginalVideo.mp4';
         $urls = [new url('http://moodle.local/pluginfile.php/1461/mod_label/intro/SampleVideo1mb.m3u8')];
@@ -128,7 +128,7 @@ public function test_get_embed_markup_simple(): void {
         ];
 
         // We're testing a private method, so we need to setup reflector magic.
-        $method = new ReflectionMethod('filter_smartmedia', 'get_embed_markup');
+        $method = new ReflectionMethod('\filter_smartmedia\text_filter', 'get_embed_markup');
         $method->setAccessible(true); // Allow accessing of private method.
         $proxy = $method->invoke($filterplugin, $linkhref, $urls, $options, $download, false); // Get result of invoked method.
 
@@ -142,9 +142,9 @@ public function test_get_embed_markup_simple(): void {
      * There is no valid tags to replace.
      * Output next should be the same as input text.
      */
-    public function test_filter_smartmedia_filter_no_replace(): void {
+    public function test_text_filter_filter_no_replace(): void {
         $this->resetAfterTest(true);
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         $inputtext = '<div class="no-overflow">'
             .'<a href="#">Some test data</a>'
@@ -162,7 +162,7 @@ public function test_get_placeholder_markkup(): void {
         $this->resetAfterTest(true);
 
         global $DB;
-        $filterplugin = new filter_smartmedia(null, []);
+        $filterplugin = new text_filter(null, []);
 
         $linkhref = 'http://moodle.local/pluginfile.php/1461/mod_label/intro/SampleVideo1mb.avi';
         $fulltext = '<div class="no-overflow">'
@@ -239,7 +239,7 @@ public function test_get_placeholder_markkup(): void {
             $initialfilerecord2['itemid'], $initialfilerecord2['filepath'], $initialfilerecord2['filename']);
 
         // We're testing a private method, so we need to setup reflector magic.
-        $method = new ReflectionMethod('filter_smartmedia', 'get_placeholder_markup');
+        $method = new ReflectionMethod('\filter_smartmedia\text_filter', 'get_placeholder_markup');
         $method->setAccessible(true); // Allow accessing of private method.
 
         $proxy = $method->invoke($filterplugin, $linkhref, $fulltext); // Get result of invoked method.
@@ -514,7 +514,7 @@ public function test_filter_replace($text, $regex, $matchcount, $mediaplugincoun
         ]);
         $PAGE->set_url(new url($pageurl));
 
-        $filterplugin = new filter_smartmedia(null, [], $conversion);
+        $filterplugin = new text_filter(null, [], $conversion);
         $result = $filterplugin->filter($text);
         $this->assertEquals($matchcount, preg_match_all($regex, $result));
 
@@ -545,7 +545,7 @@ public function test_view_source(): void {
         ]);
         $PAGE->set_url(new url("/my/"));
 
-        $filterplugin = new filter_smartmedia(null, [], $conversion);
+        $filterplugin = new text_filter(null, [], $conversion);
         $text = '<div><div><video><source src="url.com/pluginfile.php/fake.mp4"/></video></div></div>';
         $result = $filterplugin->filter($text);
         $this->assertMatchesRegularExpression('/<button.*View source media.*<\/button>/', $result);
@@ -570,7 +570,7 @@ public function test_view_optimised(): void {
         $text = '<div><div><video><source src="url.com/pluginfile.php/fake.mp4"/></video></div></div>';
         $SESSION->local_smartmedia_viewsource = [sha1('url.com/pluginfile.php/fake.mp4') => true];
 
-        $filterplugin = new filter_smartmedia(null, [], $conversion);
+        $filterplugin = new text_filter(null, [], $conversion);
         $result = $filterplugin->filter($text);
         $this->assertMatchesRegularExpression('/<button.*View optimised media.*<\/button>/', $result);
     }

version.php

@@ -25,8 +25,8 @@
 defined('MOODLE_INTERNAL') || die();
 
 $plugin->component = 'filter_smartmedia';
-$plugin->release = 2025061300;
-$plugin->version = 2025061300;
+$plugin->release = 2025061301;
+$plugin->version = 2025061301;
 $plugin->supported = [405, 405];
 $plugin->requires = 2024100700; // 4.5
 $plugin->maturity = MATURITY_STABLE;