Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403] [Versions 39 and 310]

   1  <?php
   2  // This file is part of Moodle - http://moodle.org/
   3  //
   4  // Moodle is free software: you can redistribute it and/or modify
   5  // it under the terms of the GNU General Public License as published by
   6  // the Free Software Foundation, either version 3 of the License, or
   7  // (at your option) any later version.
   8  //
   9  // Moodle is distributed in the hope that it will be useful,
  10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  // GNU General Public License for more details.
  13  //
  14  // You should have received a copy of the GNU General Public License
  15  // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
  16  
  17  /**
  18   * Test classes for handling embedded media.
  19   *
  20   * @package media_youtube
  21   * @copyright 2016 Marina Glancy
  22   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  
  27  /**
  28   * Test script for media embedding.
  29   *
  30   * @package media_youtube
  31   * @copyright 2016 Marina Glancy
  32   * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  33   */
  34  class media_youtube_testcase extends advanced_testcase {
  35  
  36      /**
  37       * Pre-test setup. Preserves $CFG.
  38       */
  39      public function setUp(): void {
  40          parent::setUp();
  41  
  42          // Reset $CFG and $SERVER.
  43          $this->resetAfterTest();
  44  
  45          // Consistent initial setup: all players disabled.
  46          \core\plugininfo\media::set_enabled_plugins('youtube');
  47  
  48          // Pretend to be using Firefox browser (must support ogg for tests to work).
  49          core_useragent::instance(true, 'Mozilla/5.0 (X11; Linux x86_64; rv:46.0) Gecko/20100101 Firefox/46.0 ');
  50      }
  51  
  52      /**
  53       * Test that plugin is returned as enabled media plugin.
  54       */
  55      public function test_is_installed() {
  56          $sortorder = \core\plugininfo\media::get_enabled_plugins();
  57          $this->assertEquals(['youtube' => 'youtube'], $sortorder);
  58      }
  59  
  60      /**
  61       * Test supported link types
  62       */
  63      public function test_supported() {
  64          $manager = core_media_manager::instance();
  65  
  66          // Format: youtube.
  67          $url = new moodle_url('http://www.youtube.com/watch?v=vyrwMmsufJc');
  68          $t = $manager->embed_url($url);
  69          $this->assertStringContainsString('</iframe>', $t);
  70          $url = new moodle_url('http://www.youtube.com/v/vyrwMmsufJc');
  71          $t = $manager->embed_url($url);
  72          $this->assertStringContainsString('</iframe>', $t);
  73          $url = new moodle_url('http://m.youtube.com/watch?v=vyrwMmsufJc');
  74          $t = $manager->embed_url($url);
  75          $this->assertStringContainsString('</iframe>', $t);
  76  
  77          // Format: youtube video within playlist.
  78          $url = new moodle_url('https://www.youtube.com/watch?v=dv2f_xfmbD8&index=4&list=PLxcO_MFWQBDcyn9xpbmx601YSDlDcTcr0');
  79          $t = $manager->embed_url($url);
  80          $this->assertStringContainsString('</iframe>', $t);
  81          $this->assertStringContainsString('list=PLxcO_MFWQBDcyn9xpbmx601YSDlDcTcr0', $t);
  82  
  83          // Format: youtube video with start time.
  84          $url = new moodle_url('https://www.youtube.com/watch?v=JNJMF1l3udM&t=1h11s');
  85          $t = $manager->embed_url($url);
  86          $this->assertStringContainsString('</iframe>', $t);
  87          $this->assertStringContainsString('start=3611', $t);
  88  
  89          // Format: youtube video within playlist with start time.
  90          $url = new moodle_url('https://www.youtube.com/watch?v=dv2f_xfmbD8&index=4&list=PLxcO_MFWQBDcyn9xpbmx601YSDlDcTcr0&t=1m5s');
  91          $t = $manager->embed_url($url);
  92          $this->assertStringContainsString('</iframe>', $t);
  93          $this->assertStringContainsString('list=PLxcO_MFWQBDcyn9xpbmx601YSDlDcTcr0', $t);
  94          $this->assertStringContainsString('start=65', $t);
  95  
  96          // Format: youtube video with invalid parameter values (injection attempts).
  97          $url = new moodle_url('https://www.youtube.com/watch?v=dv2f_xfmbD8&index=4&list=PLxcO_">');
  98          $t = $manager->embed_url($url);
  99          $this->assertStringContainsString('</iframe>', $t);
 100          $this->assertStringNotContainsString('list=PLxcO_', $t); // We shouldn't get a list param as input was invalid.
 101          $url = new moodle_url('https://www.youtube.com/watch?v=JNJMF1l3udM&t=">');
 102          $t = $manager->embed_url($url);
 103          $this->assertStringContainsString('</iframe>', $t);
 104          $this->assertStringNotContainsString('start=', $t); // We shouldn't get a start param as input was invalid.
 105  
 106          // Format: youtube playlist.
 107          $url = new moodle_url('http://www.youtube.com/view_play_list?p=PL6E18E2927047B662');
 108          $t = $manager->embed_url($url);
 109          $this->assertStringContainsString('</iframe>', $t);
 110          $url = new moodle_url('http://www.youtube.com/playlist?list=PL6E18E2927047B662');
 111          $t = $manager->embed_url($url);
 112          $this->assertStringContainsString('</iframe>', $t);
 113          $url = new moodle_url('http://www.youtube.com/p/PL6E18E2927047B662');
 114          $t = $manager->embed_url($url);
 115          $this->assertStringContainsString('</iframe>', $t);
 116  
 117      }
 118  
 119      /**
 120       * Test embedding without media filter (for example for displaying URL resorce).
 121       */
 122      public function test_embed_url() {
 123          global $CFG;
 124  
 125          $url = new moodle_url('http://www.youtube.com/v/vyrwMmsufJc');
 126  
 127          $manager = core_media_manager::instance();
 128          $embedoptions = array(
 129              core_media_manager::OPTION_TRUSTED => true,
 130              core_media_manager::OPTION_BLOCK => true,
 131          );
 132  
 133          $this->assertTrue($manager->can_embed_url($url, $embedoptions));
 134          $content = $manager->embed_url($url, 'Test & file', 0, 0, $embedoptions);
 135  
 136          $this->assertRegExp('~mediaplugin_youtube~', $content);
 137          $this->assertRegExp('~</iframe>~', $content);
 138          $this->assertRegExp('~width="' . $CFG->media_default_width . '" height="' .
 139              $CFG->media_default_height . '"~', $content);
 140  
 141          // Repeat sending the specific size to the manager.
 142          $content = $manager->embed_url($url, 'New file', 123, 50, $embedoptions);
 143          $this->assertRegExp('~width="123" height="50"~', $content);
 144      }
 145  
 146      /**
 147       * Test that mediaplugin filter replaces a link to the supported file with media tag.
 148       *
 149       * filter_mediaplugin is enabled by default.
 150       */
 151      public function test_embed_link() {
 152          global $CFG;
 153          $url = new moodle_url('http://www.youtube.com/v/vyrwMmsufJc');
 154          $text = html_writer::link($url, 'Watch this one');
 155          $content = format_text($text, FORMAT_HTML);
 156  
 157          $this->assertRegExp('~mediaplugin_youtube~', $content);
 158          $this->assertRegExp('~</iframe>~', $content);
 159          $this->assertRegExp('~width="' . $CFG->media_default_width . '" height="' .
 160              $CFG->media_default_height . '"~', $content);
 161      }
 162  
 163      /**
 164       * Test that mediaplugin filter adds player code on top of <video> tags.
 165       *
 166       * filter_mediaplugin is enabled by default.
 167       */
 168      public function test_embed_media() {
 169          global $CFG;
 170          $url = new moodle_url('http://www.youtube.com/v/vyrwMmsufJc');
 171          $trackurl = new moodle_url('http://example.org/some_filename.vtt');
 172          $text = '<video controls="true"><source src="'.$url.'"/>' .
 173              '<track src="'.$trackurl.'">Unsupported text</video>';
 174          $content = format_text($text, FORMAT_HTML);
 175  
 176          $this->assertRegExp('~mediaplugin_youtube~', $content);
 177          $this->assertRegExp('~</iframe>~', $content);
 178          $this->assertRegExp('~width="' . $CFG->media_default_width . '" height="' .
 179              $CFG->media_default_height . '"~', $content);
 180          // Video tag, unsupported text and tracks are removed.
 181          $this->assertNotRegExp('~</video>~', $content);
 182          $this->assertNotRegExp('~<source\b~', $content);
 183          $this->assertNotRegExp('~Unsupported text~', $content);
 184          $this->assertNotRegExp('~<track\b~i', $content);
 185  
 186          // Video with dimensions and source specified as src attribute without <source> tag.
 187          $text = '<video controls="true" width="123" height="35" src="'.$url.'">Unsupported text</video>';
 188          $content = format_text($text, FORMAT_HTML);
 189          $this->assertRegExp('~mediaplugin_youtube~', $content);
 190          $this->assertRegExp('~</iframe>~', $content);
 191          $this->assertRegExp('~width="123" height="35"~', $content);
 192      }
 193  }