1f29e2e5b8fb9a332959450d2a778c03b52610bc
[moodle.git] / media / player / videojs / classes / plugin.php
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/>.
17 /**
18  * Main class for plugin 'media_videojs'
19  *
20  * @package   media_videojs
21  * @copyright 2016 Marina Glancy
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 /**
28  * Player that creates HTML5 <video> tag.
29  *
30  * @package   media_videojs
31  * @copyright 2016 Marina Glancy
32  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
33  */
34 class media_videojs_plugin extends core_media_player_native {
35     /** @var array caches last moodle_page used to include AMD modules */
36     protected $loadedonpage = [];
37     /** @var string language file to use */
38     protected $language = 'en';
39     /** @var array caches supported extensions */
40     protected $extensions = null;
41     /** @var bool is this a youtube link */
42     protected $youtube = false;
44     /**
45      * Generates code required to embed the player.
46      *
47      * @param moodle_url[] $urls
48      * @param string $name
49      * @param int $width
50      * @param int $height
51      * @param array $options
52      * @return string
53      */
54     public function embed($urls, $name, $width, $height, $options) {
55         global $CFG;
56         require_once($CFG->libdir . '/filelib.php');
58         $sources = array();
59         $mediamanager = core_media_manager::instance();
60         $datasetup = [];
62         $text = null;
63         $isaudio = null;
64         $hastracks = false;
65         $hasposter = false;
66         if (array_key_exists(core_media_manager::OPTION_ORIGINAL_TEXT, $options) &&
67                 preg_match('/^<(video|audio)\b/i', $options[core_media_manager::OPTION_ORIGINAL_TEXT], $matches)) {
68             // Original text already had media tag - get some data from it.
69             $text = $options[core_media_manager::OPTION_ORIGINAL_TEXT];
70             $isaudio = strtolower($matches[1]) === 'audio';
71             $hastracks = preg_match('/<track\b/i', $text);
72             $hasposter = self::get_attribute($text, 'poster') !== null;
73         }
75         // Currently Flash in VideoJS does not support responsive layout. If Flash is enabled try to guess
76         // if HTML5 player will be engaged for the user and then set it to responsive.
77         $responsive = (get_config('media_videojs', 'useflash') && !$this->youtube) ? null : true;
78         $flashtech = false;
80         // Build list of source tags.
81         foreach ($urls as $url) {
82             $extension = $mediamanager->get_extension($url);
83             $mimetype = $mediamanager->get_mimetype($url);
84             if ($mimetype === 'video/quicktime' && (core_useragent::is_chrome() || core_useragent::is_edge())) {
85                 // Fix for VideoJS/Chrome bug https://github.com/videojs/video.js/issues/423 .
86                 $mimetype = 'video/mp4';
87             }
88             // If this is RTMP stream, adjust mimetype to those VideoJS suggests to use (either flash or mp4).
89             if ($url->get_scheme() === 'rtmp') {
90                 if ($mimetype === 'video/x-flv') {
91                     $mimetype = 'rtmp/flv';
92                 } else {
93                     $mimetype = 'rtmp/mp4';
94                 }
95             }
96             $source = html_writer::empty_tag('source', array('src' => $url, 'type' => $mimetype));
97             $sources[] = $source;
98             if ($isaudio === null) {
99                 $isaudio = in_array('.' . $extension, file_get_typegroup('extension', 'audio'));
100             }
101             if ($responsive === null) {
102                 $responsive = core_useragent::supports_html5($extension);
103             }
104             if (($url->get_scheme() === 'rtmp' || !core_useragent::supports_html5($extension))
105                     && get_config('media_videojs', 'useflash')) {
106                 $flashtech = true;
107             }
108         }
109         $sources = implode("\n", $sources);
111         // Find the title, prevent double escaping.
112         $title = $this->get_name($name, $urls);
113         $title = preg_replace(['/&amp;/', '/&gt;/', '/&lt;/'], ['&', '>', '<'], $title);
115         if ($this->youtube) {
116             $datasetup[] = '"techOrder": ["youtube"]';
117             $datasetup[] = '"sources": [{"type": "video/youtube", "src":"' . $urls[0] . '"}]';
118             $sources = ''; // Do not specify <source> tags - it may confuse browser.
119             $isaudio = false; // Just in case.
120         } else if ($flashtech) {
121             $datasetup[] = '"techOrder": ["flash", "html5"]';
122         }
124         // Add a language.
125         if ($this->language) {
126             $datasetup[] = '"language": "' . $this->language . '"';
127         }
129         // Set responsive option.
130         if ($responsive) {
131             $datasetup[] = '"fluid": true';
132         }
134         if ($isaudio && !$hastracks) {
135             // We don't need a full screen toggle for the audios (except when tracks are present).
136             $datasetup[] = '"controlBar": {"fullscreenToggle": false}';
137         }
139         if ($isaudio && !$height && !$hastracks && !$hasposter) {
140             // Hide poster area for audios without tracks or poster.
141             // See discussion on https://github.com/videojs/video.js/issues/2777 .
142             // Maybe TODO: if there are only chapter tracks we still don't need poster area.
143             $datasetup[] = '"aspectRatio": "1:0"';
144         }
146         // Attributes for the video/audio tag.
147         // We use data-setup-lazy as the attribute name for the config instead of
148         // data-setup because data-setup will cause video.js to load the player as soon as the library is loaded,
149         // which is BEFORE we have a chance to load any additional libraries (youtube).
150         // The data-setup-lazy is just a tag name that video.js does not recognise so we can manually initialise
151         // it when we are sure the dependencies are loaded.
152         static $playercounter = 1;
153         $attributes = [
154             'data-setup-lazy' => '{' . join(', ', $datasetup) . '}',
155             'id' => 'id_videojs_' . uniqid() . '_' . $playercounter++,
156             'class' => get_config('media_videojs', $isaudio ? 'audiocssclass' : 'videocssclass')
157         ];
159         if (!$responsive) {
160             // Note we ignore limitsize setting if not responsive.
161             parent::pick_video_size($width, $height);
162             $attributes += ['width' => $width] + ($height ? ['height' => $height] : []);
163         }
165         if (core_useragent::is_ios(10)) {
166             // Hides native controls and plays videos inline instead of fullscreen,
167             // see https://github.com/videojs/video.js/issues/3761 and
168             // https://github.com/videojs/video.js/issues/3762 .
169             // iPhone with iOS 9 still displays double controls and plays fullscreen.
170             // iPhone with iOS before 9 display only native controls.
171             $attributes += ['playsinline' => 'true'];
172         }
174         if ($text !== null) {
175             // Original text already had media tag - add necessary attributes and replace sources
176             // with the supported URLs only.
177             if (($class = self::get_attribute($text, 'class')) !== null) {
178                 $attributes['class'] .= ' ' . $class;
179             }
180             $text = self::remove_attributes($text, ['id', 'width', 'height', 'class']);
181             if (self::get_attribute($text, 'title') === null) {
182                 $attributes['title'] = $title;
183             }
184             $text = self::add_attributes($text, $attributes);
185             $text = self::replace_sources($text, $sources);
186         } else {
187             // Create <video> or <audio> tag with necessary attributes and all sources.
188             // We don't want fallback to another player because list_supported_urls() is already smart.
189             // Otherwise we could end up with nested <audio> or <video> tags. Fallback to link only.
190             $attributes += ['preload' => 'auto', 'controls' => 'true', 'title' => $title];
191             $text = html_writer::tag($isaudio ? 'audio' : 'video', $sources . self::LINKPLACEHOLDER, $attributes);
192         }
194         // Limit the width of the video if width is specified.
195         // We do not do it in the width attributes of the video because it does not work well
196         // together with responsive behavior.
197         if ($responsive) {
198             self::pick_video_size($width, $height);
199             if ($width) {
200                 $text = html_writer::div($text, null, ['style' => 'max-width:' . $width . 'px;']);
201             }
202         }
204         return html_writer::div($text, 'mediaplugin mediaplugin_videojs');
205     }
207     /**
208      * Utility function that sets width and height to defaults if not specified
209      * as a parameter to the function (will be specified either if, (a) the calling
210      * code passed it, or (b) the URL included it).
211      * @param int $width Width passed to function (updated with final value)
212      * @param int $height Height passed to function (updated with final value)
213      */
214     protected static function pick_video_size(&$width, &$height) {
215         if (!get_config('media_videojs', 'limitsize')) {
216             return;
217         }
218         parent::pick_video_size($width, $height);
219     }
221     public function get_supported_extensions() {
222         global $CFG;
223         require_once($CFG->libdir . '/filelib.php');
224         if ($this->extensions === null) {
225             // Get extensions set by user in UI config.
226             $filetypes = preg_split('/\s*,\s*/',
227                 strtolower(trim(get_config('media_videojs', 'videoextensions') . ',' .
228                 get_config('media_videojs', 'audioextensions'))));
230             $this->extensions = file_get_typegroup('extension', $filetypes);
231             if ($this->extensions && !get_config('media_videojs', 'useflash')) {
232                 // If Flash is disabled get extensions supported by player that don't rely on flash.
233                 $supportedextensions = array_merge(file_get_typegroup('extension', 'html_video'),
234                     file_get_typegroup('extension', 'html_audio'), file_get_typegroup('extension', 'media_source'));
235                 $this->extensions = array_intersect($this->extensions, $supportedextensions);
236             }
237         }
238         return $this->extensions;
239     }
241     public function list_supported_urls(array $urls, array $options = array()) {
242         $result = [];
243         // Youtube.
244         $this->youtube = false;
245         if (count($urls) == 1 && get_config('media_videojs', 'youtube')) {
246             $url = reset($urls);
248             // Check against regex.
249             if (preg_match($this->get_regex_youtube(), $url->out(false), $this->matches)) {
250                 $this->youtube = true;
251                 return array($url);
252             }
253         }
255         $extensions = $this->get_supported_extensions();
256         $rtmpallowed = get_config('media_videojs', 'rtmp') && get_config('media_videojs', 'useflash');
257         foreach ($urls as $url) {
258             // If RTMP support is disabled, skip the URL that is using RTMP (which
259             // might have been picked to the list by its valid extension).
260             if (!$rtmpallowed && ($url->get_scheme() === 'rtmp')) {
261                 continue;
262             }
264             // If RTMP support is allowed, URL with RTMP scheme is supported irrespective to extension.
265             if ($rtmpallowed && ($url->get_scheme() === 'rtmp')) {
266                 $result[] = $url;
267                 continue;
268             }
270             $ext = '.' . core_media_manager::instance()->get_extension($url);
271             // Handle HLS and MPEG-DASH if supported.
272             $isstream = in_array($ext, file_get_typegroup('extension', 'media_source'));
273             if ($isstream && in_array($ext, $extensions) && core_useragent::supports_media_source_extensions($ext)) {
274                 $result[] = $url;
275                 continue;
276             }
278             if (!get_config('media_videojs', 'useflash')) {
279                 return parent::list_supported_urls($urls, $options);
280             } else {
281                 // If Flash fallback is enabled we can not check if/when browser supports flash.
282                 // We assume it will be able to handle any other extensions that player supports.
283                 if (in_array($ext, $extensions)) {
284                     $result[] = $url;
285                 }
286             }
287         }
288         return $result;
289     }
291     /**
292      * Default rank
293      * @return int
294      */
295     public function get_rank() {
296         return 2000;
297     }
299     /**
300      * Tries to match the current language to existing language files
301      *
302      * Matched language is stored in $this->language
303      *
304      * @return string JS code with a setting
305      */
306     protected function find_language() {
307         global $CFG;
308         $this->language = current_language();
309         $basedir = $CFG->dirroot . '/media/player/videojs/videojs/lang/';
310         $langfiles = get_directory_list($basedir);
311         $candidates = [];
312         foreach ($langfiles as $langfile) {
313             if (strtolower(pathinfo($langfile, PATHINFO_EXTENSION)) !== 'js') {
314                 continue;
315             }
316             $lang = basename($langfile, '.js');
317             if (strtolower($langfile) === $this->language . '.js') {
318                 // Found an exact match for the language.
319                 $js = file_get_contents($basedir . $langfile);
320                 break;
321             }
322             if (substr($this->language, 0, 2) === strtolower(substr($langfile, 0, 2))) {
323                 // Not an exact match but similar, for example "pt_br" is similar to "pt".
324                 $candidates[$lang] = $langfile;
325             }
326         }
327         if (empty($js) && $candidates) {
328             // Exact match was not found, take the first candidate.
329             $this->language = key($candidates);
330             $js = file_get_contents($basedir . $candidates[$this->language]);
331         }
332         // Add it as a language for Video.JS.
333         if (!empty($js)) {
334             return "$js\n";
335         }
337         // Could not match, use default language of video player (English).
338         $this->language = null;
339         return "";
340     }
342     public function supports($usedextensions = []) {
343         $supports = parent::supports($usedextensions);
344         if (get_config('media_videojs', 'youtube')) {
345             $supports .= ($supports ? '<br>' : '') . get_string('youtube', 'media_videojs');
346         }
347         if (get_config('media_videojs', 'rtmp') && get_config('media_videojs', 'useflash')) {
348             $supports .= ($supports ? '<br>' : '') . get_string('rtmp', 'media_videojs');
349         }
350         return $supports;
351     }
353     public function get_embeddable_markers() {
354         $markers = parent::get_embeddable_markers();
355         // Add YouTube support if enabled.
356         if (get_config('media_videojs', 'youtube')) {
357             $markers = array_merge($markers, array('youtube.com', 'youtube-nocookie.com', 'youtu.be', 'y2u.be'));
358         }
359         // Add RTMP support if enabled.
360         if (get_config('media_videojs', 'rtmp') && get_config('media_videojs', 'useflash')) {
361             $markers[] = 'rtmp://';
362         }
364         return $markers;
365     }
367     /**
368      * Returns regular expression used to match URLs for single youtube video
369      * @return string PHP regular expression e.g. '~^https?://example.org/~'
370      */
371     protected function get_regex_youtube() {
372         // Regex for standard youtube link.
373         $link = '(youtube(-nocookie)?\.com/(?:watch\?v=|v/))';
374         // Regex for shortened youtube link.
375         $shortlink = '((youtu|y2u)\.be/)';
377         // Initial part of link.
378         $start = '~^https?://(www\.)?(' . $link . '|' . $shortlink . ')';
379         // Middle bit: Video key value.
380         $middle = '([a-z0-9\-_]+)';
381         return $start . $middle . core_media_player_external::END_LINK_REGEX_PART;
382     }
384     /**
385      * Setup page requirements.
386      *
387      * @param moodle_page $page The page we are going to add requirements to.
388      */
389     public function setup($page) {
391         // Load dynamic loader. It will scan page for videojs media and load necessary modules.
392         // Loader will be loaded on absolutely every page, however the videojs will only be loaded
393         // when video is present on the page or added later to it in AJAX.
394         $path = new moodle_url('/media/player/videojs/videojs/video-js.swf');
395         $contents = 'videojs.options.flash.swf = "' . $path . '";' . "\n";
396         $contents .= $this->find_language(current_language());
397         $page->requires->js_amd_inline(<<<EOT
398 require(["media_videojs/loader"], function(loader) {
399     loader.setUp(function(videojs) {
400         $contents
401     });
402 });
403 EOT
404         );
405     }