Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.
<?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/>.

/**
 * Main class for plugin 'media_youtube'
 *
 * @package   media_youtube
 * @copyright 2016 Marina Glancy
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

defined('MOODLE_INTERNAL') || die();

/**
 * Player that creates youtube embedding.
 *
 * @package   media_youtube
 * @author    2011 The Open University
 * @copyright 2016 Marina Glancy
 * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
class media_youtube_plugin extends core_media_player_external {
    /**
     * Stores whether the playlist regex was matched last time when
     * {@link list_supported_urls()} was called
     * @var bool
     */
    protected $isplaylist = false;

    public function list_supported_urls(array $urls, array $options = array()) {
        // These only work with a SINGLE url (there is no fallback).
        if (count($urls) == 1) {
            $url = reset($urls);

            // Check against regex.
            if (preg_match($this->get_regex(), $url->out(false), $this->matches)) {
                $this->isplaylist = false;
                return array($url);
            }

            // Check against playlist regex.
            if (preg_match($this->get_regex_playlist(), $url->out(false), $this->matches)) {
                $this->isplaylist = true;
                return array($url);
            }
        }

        return array();
    }

    protected function embed_external(moodle_url $url, $name, $width, $height, $options) {
> global $OUTPUT; > $nocookie = get_config('media_youtube', 'nocookie');
$info = trim($name ?? ''); if (empty($info) or strpos($info, 'http') === 0) { $info = get_string('pluginname', 'media_youtube'); } $info = s($info); self::pick_video_size($width, $height);
< if ($this->isplaylist) {
> // Template context. > $context = [ > 'width' => $width, > 'height' => $height, > 'title' => $info > ];
> if ($this->isplaylist) {
$site = $this->matches[1]; $playlist = $this->matches[3];
< return <<<OET < <span class="mediaplugin mediaplugin_youtube"> < <iframe width="$width" height="$height" src="https://$site/embed/videoseries?list=$playlist" frameborder="0" allowfullscreen="1"></iframe> < </span> < OET;
> $params = ['list' => $playlist]; > > // Handle no cookie option. > if (!$nocookie) { > $embedurl = new moodle_url("https://$site/embed/videoseries", $params);
} else {
> $embedurl = new moodle_url('https://www.youtube-nocookie.com/embed/videoseries', $params ); > } $videoid = end($this->matches); > $context['embedurl'] = $embedurl->out(false); $params = ''; > $start = self::get_start_time($url); > // Return the rendered template. if ($start > 0) { > return $OUTPUT->render_from_template('media_youtube/embed', $context);
$params .= "start=$start&amp;";
> } else {
< $params = '';
> $params = [];
< $params .= "start=$start&amp;";
> $params['start'] = $start;
$listid = $url->param('list'); // Check for non-empty but valid playlist ID. if (!empty($listid) && !preg_match('/[^a-zA-Z0-9\-_]/', $listid)) { // This video is part of a playlist, and we want to embed it as such.
< $params .= "list=$listid&amp;";
> $params['list'] = $listid;
}
< return <<<OET < <span class="mediaplugin mediaplugin_youtube"> < <iframe title="$info" width="$width" height="$height" < src="https://www.youtube.com/embed/$videoid?{$params}rel=0&amp;wmode=transparent" frameborder="0" allowfullscreen="1"></iframe> < </span> < OET;
> // Add parameters to object to be passed to the mustache template. > $params['rel'] = 0; > $params['wmode'] = 'transparent'; > > // Handle no cookie option. > if (!$nocookie) { > $embedurl = new moodle_url('https://www.youtube.com/embed/' . $videoid, $params ); > } else { > $embedurl = new moodle_url('https://www.youtube-nocookie.com/embed/' . $videoid, $params ); > } > > $context['embedurl'] = $embedurl->out(false); > > // Return the rendered template. > return $OUTPUT->render_from_template('media_youtube/embed', $context);
} } /** * Check for start time parameter. Note that it's in hours/mins/secs in the URL, * but the embedded player takes only a number of seconds as the "start" parameter. * @param moodle_url $url URL of video to be embedded. * @return int Number of seconds video should start at. */ protected static function get_start_time($url) { $matches = array(); $seconds = 0; $rawtime = $url->param('t'); if (empty($rawtime)) { $rawtime = $url->param('start'); } if (is_numeric($rawtime)) { // Start time already specified as a number of seconds; ensure it's an integer. $seconds = $rawtime; } else if (preg_match('/(\d+?h)?(\d+?m)?(\d+?s)?/i', $rawtime ?? '', $matches)) { // Convert into a raw number of seconds, as that's all embedded players accept. for ($i = 1; $i < count($matches); $i++) { if (empty($matches[$i])) { continue; } $part = str_split($matches[$i], strlen($matches[$i]) - 1); switch ($part[1]) { case 'h': $seconds += 3600 * $part[0]; break; case 'm': $seconds += 60 * $part[0]; break; default: $seconds += $part[0]; } } } return intval($seconds); } /** * Returns regular expression used to match URLs for single youtube video * @return string PHP regular expression e.g. '~^https?://example.org/~' */ protected function get_regex() { // Regex for standard youtube link. $link = '(youtube(-nocookie)?\.com/(?:watch\?v=|v/))'; // Regex for shortened youtube link. $shortlink = '((youtu|y2u)\.be/)'; // Initial part of link. $start = '~^https?://((www|m)\.)?(' . $link . '|' . $shortlink . ')'; // Middle bit: Video key value. $middle = '([a-z0-9\-_]+)'; return $start . $middle . core_media_player_external::END_LINK_REGEX_PART; } /** * Returns regular expression used to match URLs for youtube playlist * @return string PHP regular expression e.g. '~^https?://example.org/~' */ protected function get_regex_playlist() { // Initial part of link. $start = '~^https?://(www\.youtube(-nocookie)?\.com)/'; // Middle bit: either view_play_list?p= or p/ (doesn't work on youtube) or playlist?list=. $middle = '(?:view_play_list\?p=|p/|playlist\?list=)([a-z0-9\-_]+)'; return $start . $middle . core_media_player_external::END_LINK_REGEX_PART; } public function get_embeddable_markers() { return array('youtube.com', 'youtube-nocookie.com', 'youtu.be', 'y2u.be'); } /** * Default rank * @return int */ public function get_rank() { return 1001; } }