moodle/media/player/html5audio/tests/player_test.php

<?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/>.

namespace media_html5audio;

use core_media_manager;
use media_html5audio_plugin;

/**
 * Test script for media embedding.
 *
 * @package media_html5audio
 * @copyright 2016 Marina Glancy
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class player_test extends \advanced_testcase {

    /**
     * Pre-test setup. Preserves $CFG.
     */
    public function setUp(): void {
        parent::setUp();

        // Reset $CFG and $SERVER.
        $this->resetAfterTest();

        // Consistent initial setup: all players disabled.
        \core\plugininfo\media::set_enabled_plugins('html5audio');

        // Pretend to be using Firefox browser (must support ogg for tests to work).
        \core_useragent::instance(true, 'Mozilla/5.0 (X11; Linux x86_64; rv:46.0) Gecko/20100101 Firefox/46.0 ');
    }

    /**
     * Test that plugin is returned as enabled media plugin.
     */
    public function test_is_installed() {
        $sortorder = \core\plugininfo\media::get_enabled_plugins();
        $this->assertEquals(['html5audio' => 'html5audio'], $sortorder);
    }

    /**
     * Test method get_supported_extensions()
     */
    public function test_get_supported_extensions() {
        global $CFG;
        require_once($CFG->libdir . '/filelib.php');

        $nativeextensions = file_get_typegroup('extension', 'html_audio');

        // Make sure that the list of extensions from the setting is exactly the same as html_audio group.
        $player = new media_html5audio_plugin();
        $this->assertEmpty(array_diff($player->get_supported_extensions(), $nativeextensions));
        $this->assertEmpty(array_diff($nativeextensions, $player->get_supported_extensions()));
    }

    /**
     * Test method list_supported_urls()
     */
    public function test_list_supported_urls() {
        global $CFG;
        require_once($CFG->libdir . '/filelib.php');

        $nativeextensions = file_get_typegroup('extension', 'html_audio');

        // Create list of URLs for each extension.
        $urls = array_map(function($ext){
            return new \moodle_url('http://example.org/audio.' . $ext);
        }, $nativeextensions);

        // Make sure that the list of supported URLs is not filtering permitted extensions.
        $player = new media_html5audio_plugin();
        $this->assertCount(count($urls), $player->list_supported_urls($urls));
    }

    /**
     * Test embedding without media filter (for example for displaying file resorce).
     */
    public function test_embed_url() {
        global $CFG;

        $url = new \moodle_url('http://example.org/1.wav');

        $manager = core_media_manager::instance();
        $embedoptions = array(
            core_media_manager::OPTION_TRUSTED => true,
            core_media_manager::OPTION_BLOCK => true,
        );

        $this->assertTrue($manager->can_embed_url($url, $embedoptions));
        $content = $manager->embed_url($url, 'Test & file', 0, 0, $embedoptions);

        $this->assertMatchesRegularExpression('~mediaplugin_html5audio~', $content);
        $this->assertMatchesRegularExpression('~</audio>~', $content);
        $this->assertMatchesRegularExpression('~title="Test &amp; file"~', $content);
        // Do not set default width/height (it's an audio after all).
        $this->assertDoesNotMatchRegularExpression('~width=~', $content);
        $this->assertDoesNotMatchRegularExpression('~height=~', $content);

        // This plugin ignores size settings.
        $this->assertDoesNotMatchRegularExpression('~width=~', $content);
        $this->assertDoesNotMatchRegularExpression('~height=~', $content);
    }

    /**
     * Test that mediaplugin filter replaces a link to the supported file with media tag.
     *
     * filter_mediaplugin is enabled by default.
     */
    public function test_embed_link() {
        $url = new \moodle_url('http://example.org/some_filename.wav');
        $text = \html_writer::link($url, 'Watch this one');
        $content = format_text($text, FORMAT_HTML);

        $this->assertMatchesRegularExpression('~mediaplugin_html5audio~', $content);
        $this->assertMatchesRegularExpression('~</audio>~', $content);
        $this->assertMatchesRegularExpression('~title="Watch this one"~', $content);
        $this->assertDoesNotMatchRegularExpression('~<track\b~i', $content);
    }

    /**
     * Test that mediaplugin filter does not work on <audio> tags.
     */
    public function test_embed_media() {
        $url = new \moodle_url('http://example.org/some_filename.wav');
        $trackurl = new \moodle_url('http://example.org/some_filename.vtt');
        $text = '<audio controls="true"><source src="'.$url.'"/><source src="somethinginvalid"/>' .
            '<track src="'.$trackurl.'">Unsupported text</audio>';
        $content = format_text($text, FORMAT_HTML);

        $this->assertDoesNotMatchRegularExpression('~mediaplugin_html5audio~', $content);
        $this->assertEquals(clean_text($text, FORMAT_HTML), $content);
    }
}