video_embed_field.handlers.inc in Video Embed Field 7.2
Provide some handlers for video embed field Other modules can implement the hook_video_embed_handler_info to provide more handlers.
File
video_embed_field.handlers.incView source
<?php
/**
* @file
* Provide some handlers for video embed field
* Other modules can implement the hook_video_embed_handler_info to provide more
* handlers.
*/
/**
* Implements hook_video_embed_handler_info().
*/
function video_embed_field_video_embed_handler_info() {
$handlers = array();
$handlers['youtube'] = array(
'title' => 'Youtube',
'function' => 'video_embed_field_handle_youtube',
'thumbnail_function' => 'video_embed_field_handle_youtube_thumbnail',
'thumbnail_default' => drupal_get_path('module', 'video_embed_field') . '/img/youtube.jpg',
'data_function' => 'video_embed_field_handle_youtube_data',
'form' => 'video_embed_field_handler_youtube_form',
'form_validate' => 'video_embed_field_handler_youtube_form_validate',
'domains' => array(
'youtube.com',
'youtu.be',
),
'defaults' => array(
'width' => 640,
'height' => 360,
'autoplay' => 0,
'vq' => 'large',
'rel' => 0,
'controls' => 1,
'autohide' => 2,
'showinfo' => 1,
'modestbranding' => 0,
'theme' => 'dark',
'iv_load_policy' => 1,
'class' => '',
),
);
$handlers['vimeo'] = array(
'title' => 'Vimeo',
'function' => 'video_embed_field_handle_vimeo',
'thumbnail_function' => 'video_embed_field_handle_vimeo_thumbnail',
'thumbnail_default' => drupal_get_path('module', 'video_embed_field') . '/img/vimeo.jpg',
'data_function' => '_video_embed_field_get_vimeo_data',
'form' => 'video_embed_field_handler_vimeo_form',
'form_validate' => 'video_embed_field_handler_vimeo_form_validate',
'domains' => array(
'vimeo.com',
),
'defaults' => array(
'width' => 640,
'height' => 360,
'color' => '00adef',
'portrait' => 1,
'title' => 1,
'byline' => 1,
'autoplay' => 0,
'loop' => 0,
'froogaloop' => 0,
'class' => '',
),
);
return $handlers;
}
/**
* Helper function to get the youtube video's id.
*
* @param string $url
* The video URL.
*
* @return string|bool
* The video ID, or FALSE in case the ID can't be retrieved from the URL.
*/
function _video_embed_field_get_youtube_id($url) {
// Find the ID of the video they want to play from the url.
if (stristr($url, 'http://')) {
$url = substr($url, 7);
}
elseif (stristr($url, 'https://')) {
$url = substr($url, 8);
}
if (stristr($url, 'playlist')) {
// Playlists need the appended ampersand to take the options properly.
$url = $url . '&';
$pos = strripos($url, '?list=');
if ($pos !== FALSE) {
$pos2 = stripos($url, '&');
$pos2++;
}
else {
return FALSE;
}
}
elseif (stristr($url, 'view_play_list')) {
$url = $url . '&';
// All playlist ID's are prepended with PL.
if (!stristr($url, '?p=PL')) {
$url = substr_replace($url, 'PL', strpos($url, '?p=') + 3, 0);
}
// Replace the links format with the embed format.
$url = str_ireplace('play_list?p=', 'videoseries?list=', $url);
$pos = strripos($url, 'videoseries?list=');
if ($pos !== FALSE) {
$pos2 = stripos($url, '&');
$pos2++;
}
else {
return FALSE;
}
}
else {
$pos = strripos($url, 'v=');
if ($pos !== FALSE) {
$pos += 2;
$pos2 = stripos($url, '&', $pos);
$pos_hash = stripos($url, '#', $pos);
$pos2 = _video_embed_get_min($pos2, $pos_hash);
}
else {
$pos = strripos($url, '/');
if ($pos !== FALSE) {
$pos++;
$pos2 = stripos($url, '?', $pos);
$pos_hash = stripos($url, '#', $pos);
$pos2 = _video_embed_get_min($pos2, $pos_hash);
}
}
}
if ($pos === FALSE) {
return FALSE;
}
else {
if ($pos2 > 0) {
$id = substr($url, $pos, $pos2 - $pos);
}
else {
$id = substr($url, $pos);
}
}
return check_plain($id);
}
/**
* Handler for Youtube videos.
*
* @param string $url
* The video URL.
* @param array $settings
* The settings array.
*
* @return array
* The video iframe render array.
*/
function video_embed_field_handle_youtube($url, $settings) {
$output = array();
if (preg_match('/#t=((?P<min>\\d+)m)?((?P<sec>\\d+)s)?((?P<tinsec>\\d+))?/', $url, $matches)) {
if (isset($matches['tinsec'])) {
$settings['start'] = $matches['tinsec'];
// url already in form #t=125 for 2 minutes and 5 seconds
}
else {
// url in form #t=2m5s or with other useless data, this is why we still keep adding the default data..
// give it some default data in case there is no #t=...
$matches += array(
"min" => 0,
"sec" => 0,
);
if ($time = $matches["min"] * 60 + $matches["sec"]) {
$settings['start'] = $time;
}
}
}
$id = _video_embed_field_get_youtube_id($url);
if (!$id) {
// We can't decode the URL - just return the URL as a link.
$output['#markup'] = l($url, $url);
return $output;
}
// Add class to variable to avoid adding it to URL param string.
$class = $settings['class'];
unset($settings['class']);
// Construct the embed code.
$settings['wmode'] = 'opaque';
$settings_str = urlencode(_video_embed_code_get_settings_str($settings));
$output['#markup'] = '<iframe class="' . check_plain($class) . '" width="' . check_plain($settings['width']) . '" height="' . check_plain($settings['height']) . '" src="//www.youtube.com/embed/' . $id . '?' . $settings_str . '" frameborder="0" allowfullscreen></iframe>';
return $output;
}
/**
* Gets the thumbnail url for youtube videos.
*
* @param string $url
* The video URL.
*
* @return array
* The video thumbnail information.
*/
function video_embed_field_handle_youtube_thumbnail($url) {
$info = array();
$id = _video_embed_field_get_youtube_id($url);
// Playlist.
if (stristr($id, '?list=')) {
// Strip out all but the ID, including the PL behind the ID.
$start = strpos($id, '?list=PL') + 8;
$length = strpos($id, '&') - $start;
$id = substr($id, $start, $length);
$info['id'] = $id;
// Playlist info is stored in XML. The thumbnail is in there.
$xml = drupal_http_request('http://gdata.youtube.com/feeds/api/playlists/' . $id);
if (!isset($xml->error)) {
$xml = new SimpleXMLElement($xml->data);
$media = $xml
->children('http://search.yahoo.com/mrss/');
if ($media->group->thumbnail && $media->group->thumbnail[0]
->attributes()) {
$attrs = $media->group->thumbnail[0]
->attributes();
$info['url'] = (string) $attrs['url'];
}
}
}
elseif ($id) {
$info['id'] = $id;
$info['url'] = 'http://img.youtube.com/vi/' . $id . '/0.jpg';
}
return $info;
}
/**
* Gets video data for a YouTube video URL.
*
* @param string $url
* A YouTube video URL to get data for
*
* @return array|bool
* An array of video data, or FALSE if unable to fetch data
*/
function video_embed_field_handle_youtube_data($url) {
// Get YouTube video ID from URL.
$id = _video_embed_field_get_youtube_id($url);
if ($id) {
$options['v'] = 3;
$options['key'] = variable_get('video_embed_field_youtube_v3_api_key', '');
$options['part'] = 'snippet';
$options['id'] = $id;
$response = drupal_http_request(url('https://www.googleapis.com/youtube/v3/videos', array(
'query' => $options,
)));
if (!isset($response->error)) {
$data = json_decode($response->data);
return _video_embed_field_clean_up_youtube_data($data->items);
}
}
return FALSE;
}
/**
* Flattens out some unnecessary nesting in the youtube data.
*
* @param array $data
* The unflattened data.
*
* @return array
* The flattened data.
*/
function _video_embed_field_clean_up_youtube_data($data) {
// Make things a bit nicer for people trying to use the data.
foreach ($data as $key => $value) {
if (is_object($value)) {
$temp = (array) $value;
if (isset($temp['$t'])) {
$data[$key] = $temp['$t'];
}
else {
$data[$key] = _video_embed_field_clean_up_youtube_data($temp);
}
}
elseif (is_array($value)) {
$data[$key] = _video_embed_field_clean_up_youtube_data($value);
}
if ($key === 'category') {
$terms = array();
foreach ($data[$key] as $value) {
if (isset($value['scheme']) && $value['scheme'] == 'http://schemas.google.com/g/2005#kind') {
continue;
}
if (isset($value['term'])) {
$terms[] = $value['term'];
}
}
$data['terms'] = $terms;
}
}
return $data;
}
/**
* Defines the form elements for the Youtube configuration form.
*
* @param array $defaults
* The form default values.
*
* @return array
* The provider settings form array.
*/
function video_embed_field_handler_youtube_form($defaults) {
$form = array();
$form['width'] = array(
'#type' => 'textfield',
'#size' => '5',
'#title' => t('Player Width'),
'#description' => t('The width of the youtube player.'),
'#default_value' => $defaults['width'],
);
$form['height'] = array(
'#type' => 'textfield',
'#size' => '5',
'#title' => t('Player Height'),
'#description' => t('The height of the youtube player.'),
'#default_value' => $defaults['height'],
);
$form['theme'] = array(
'#type' => 'select',
'#options' => array(
'dark' => t('Dark'),
'light' => t('Light'),
),
'#title' => t('Player theme'),
'#default_value' => $defaults['theme'],
);
$form['autoplay'] = array(
'#type' => 'checkbox',
'#title' => t('Autoplay'),
'#description' => t('Play the video immediately.'),
'#default_value' => $defaults['autoplay'],
);
$form['vq'] = array(
'#type' => 'select',
'#title' => t('Video quality'),
'#options' => array(
'small' => t('Small (240p)'),
'medium' => t('Medium (360p)'),
'large' => t('Large (480p)'),
'hd720' => t('HD 720p'),
'hd1080' => t('HD 10800p'),
),
'#default_value' => $defaults['vq'],
'#description' => t('Attempt to play the video in certain quality if available.'),
);
$form['rel'] = array(
'#type' => 'checkbox',
'#title' => t('Show related videos'),
'#description' => t('Show related videos after the video is finished playing.'),
'#default_value' => $defaults['rel'],
);
$form['showinfo'] = array(
'#type' => 'checkbox',
'#title' => t('Show info'),
'#description' => t('Display information like the video title and rating before the video starts playing.'),
'#default_value' => $defaults['showinfo'],
);
$form['modestbranding'] = array(
'#type' => 'checkbox',
'#title' => t('Hide Youtube logo'),
'#description' => t('Hide the Youtube logo button on the player'),
'#default_value' => $defaults['modestbranding'],
);
$form['iv_load_policy'] = array(
'#type' => 'radios',
'#options' => array(
1 => t('Show video annotations.'),
3 => t('Hide video annotations.'),
),
'#title' => t('Display annotations'),
'#description' => t('Controls the display of annotations over the video content. Only works when using the flash player.'),
'#default_value' => $defaults['iv_load_policy'],
);
$form['controls'] = array(
'#type' => 'radios',
'#options' => array(
0 => t('Hide video controls.'),
1 => t('Show video controls. Youtube default.'),
2 => t('Show video controls with performance improvement for iframe embeds.'),
),
'#title' => t('Display Youtube player controls'),
'#description' => t('This parameter indicates whether the video player controls will display.'),
'#default_value' => $defaults['controls'],
);
$form['autohide'] = array(
'#type' => 'radios',
'#options' => array(
0 => t('The video progress bar and player controls will be visible throughout the video.'),
1 => t('Automatically slide the video progress bar and the player controls out of view a couple of seconds after the video starts playing. They will only reappear if the user moves her mouse over the video player or presses a keyboard key.'),
2 => t('The video progress bar will fade out but the player controls (play button, volume control, etc.) remain visible.'),
),
'#title' => t('Autohide progress bar and the player controls'),
'#description' => t('Controls the autohide behavior of the youtube player controls.'),
'#default_value' => $defaults['autohide'],
);
$form['class'] = array(
'#type' => 'textfield',
'#title' => t('Player CSS class'),
'#description' => t('CSS class to add to the player'),
'#default_value' => $defaults['class'],
);
return $form;
}
/**
* Validates the form elements for the Youtube configuration form.
*
* @param array $element
* The form element to validate.
* @param array $form_state
* The form to validate state.
* @param array $form
* The form to validate structure.
*/
function video_embed_field_handler_youtube_form_validate($element, &$form_state, $form) {
video_embed_field_validate_dimensions($element);
}
/**
* Helper function to get the Vimeo video's data attributes.
*
* @param string $url
* A Vimeo video URL to get the data from.
*
* @return integer|false
* The video's data attributes, or FALSE if unable to get the video ID.
*/
function _video_embed_field_get_vimeo_data($url) {
// Set oembed endpoint
$oembed_endpoint = 'http://vimeo.com/api/oembed';
// Fetch vimeo data
$response = drupal_http_request($oembed_endpoint . '.json?url=' . rawurlencode($url));
try {
return json_decode($response->data, TRUE);
} catch (Exception $e) {
return FALSE;
}
}
/**
* Helper function to get the Vimeo video's data attributes.
*
* @param string $url
* A Vimeo video URL to get the ID of.
*
* @return integer|false
* The video ID, or FALSE if unable to get the video ID.
*/
function _video_embed_field_get_vimeo_id($vimeo_data) {
try {
$video_id = $vimeo_data['video_id'];
} catch (Exception $e) {
$video_id = FALSE;
}
return $video_id;
}
/**
* Handler for Vimeo videos.
*
* @param string $url
* The video URL.
* @param array $settings
* The settings array.
*
* @return string
* The video iframe.
*/
function video_embed_field_handle_vimeo($url, $settings) {
$vimeo_data = _video_embed_field_get_vimeo_data($url);
// Get ID of video from URL.
$id = _video_embed_field_get_vimeo_id($vimeo_data);
if (empty($id)) {
return array(
'#markup' => l($url, $url),
);
}
// Construct the embed code.
$settings['player_id'] = drupal_html_id('vimeo-' . $id);
if (!empty($settings['froogaloop'])) {
$settings['api'] = 1;
}
unset($settings['froogaloop']);
// Add class to variable to avoid adding it to URL param string.
$class = $settings['class'];
unset($settings['class']);
$settings_str = _video_embed_code_get_settings_str($settings);
return array(
'#markup' => '<iframe class="' . check_plain($class) . '" id="' . $settings['player_id'] . '" width="' . check_plain($settings['width']) . '" height="' . check_plain($settings['height']) . '" src="//player.vimeo.com/video/' . $id . '?' . $settings_str . '" frameborder="0" webkitAllowFullScreen mozallowfullscreen allowfullscreen></iframe>',
);
}
/**
* Gets the thumbnail url for vimeo videos.
*
* @param string $url
* The video URL.
*
* @return array
* The video thumbnail information.
*/
function video_embed_field_handle_vimeo_thumbnail($url) {
$vimeo_data = _video_embed_field_get_vimeo_data($url);
// Get ID of video from URL.
$id = _video_embed_field_get_vimeo_id($vimeo_data);
$info = array(
'id' => $id,
);
try {
$info['url'] = $vimeo_data['thumbnail_url'];
} catch (Exception $e) {
}
return $info;
}
/**
* Defines the form elements for the Vimeo configuration form.
*
* @param array $defaults
* The form default values.
*
* @return array
* The provider settings form array.
*/
function video_embed_field_handler_vimeo_form($defaults) {
$form = array();
$form['width'] = array(
'#type' => 'textfield',
'#size' => '5',
'#title' => t('Player Width'),
'#description' => t('The width of the vimeo player.'),
'#default_value' => $defaults['width'],
);
$form['height'] = array(
'#type' => 'textfield',
'#size' => '5',
'#title' => t('Player Height'),
'#description' => t('The height of the vimeo player.'),
'#default_value' => $defaults['height'],
);
$form['color'] = array(
'#type' => 'select',
'#options' => array(
'00adef' => t('Blue'),
'ff9933' => t('Orange'),
'c9ff23' => t('Lime'),
'ff0179' => t('Fuschia'),
'ffffff' => t('White'),
),
'#title' => t('Player Color'),
'#description' => t('The color to use on the vimeo player.'),
'#default_value' => $defaults['color'],
);
$form['portrait'] = array(
'#type' => 'checkbox',
'#title' => t('Overlay Author Thumbnail'),
'#description' => t("Overlay the author's thumbnail before the video is played."),
'#default_value' => $defaults['portrait'],
);
$form['title'] = array(
'#type' => 'checkbox',
'#title' => t("Overlay Video's Title"),
'#description' => t("Overlay the video's title before the video is played."),
'#default_value' => $defaults['title'],
);
$form['byline'] = array(
'#type' => 'checkbox',
'#title' => t("Overlay Video's Byline"),
'#description' => t("Overlay the video's description before the video is played."),
'#default_value' => $defaults['byline'],
);
$form['overridable'] = array(
'#prefix' => '<p class="note"><strong>' . t('Note') . ': </strong><em>',
'#markup' => t('Color, portrait, title and byline can be restricted by Vimeo Plus videos.
Such videos will ignore these settings.'),
'#suffix' => '</em></p>',
);
$form['autoplay'] = array(
'#type' => 'checkbox',
'#title' => t('Autoplay'),
'#description' => t('Play the video immediately.'),
'#default_value' => $defaults['autoplay'],
);
$form['loop'] = array(
'#type' => 'checkbox',
'#title' => t('Loop'),
'#description' => t("Loop the video's playback"),
'#default_value' => $defaults['loop'],
);
$form['froogaloop'] = array(
'#type' => 'checkbox',
'#title' => t('Enable froogaloop support'),
'#description' => t("Enables Froogallop Vimeo's library support"),
'#default_value' => $defaults['loop'],
);
$form['class'] = array(
'#type' => 'textfield',
'#title' => t('Player CSS class'),
'#description' => t('CSS class to add to the player'),
'#default_value' => $defaults['class'],
);
return $form;
}
/**
* Validates the form elements for the Vimeo configuration form.
*
* @param array $element
* The form element to validate.
* @param array $form_state
* The form to validate state.
* @param array $form
* The form to validate structure.
*/
function video_embed_field_handler_vimeo_form_validate($element, &$form_state, $form) {
video_embed_field_validate_dimensions($element);
}
/**
* Calculates the min index for use in finding the id of a youtube video.
*
* @param string $pos1
* The first index.
* @param string $pos2
* The second index.
*
* @return string
* The min index.
*/
function _video_embed_get_min($pos1, $pos2) {
if (!$pos1) {
return $pos2;
}
elseif (!$pos2) {
return $pos1;
}
else {
return min($pos1, $pos2);
}
}Functions
Name |
Description |
|---|---|
| video_embed_field_handler_vimeo_form | Defines the form elements for the Vimeo configuration form. |
| video_embed_field_handler_vimeo_form_validate | Validates the form elements for the Vimeo configuration form. |
| video_embed_field_handler_youtube_form | Defines the form elements for the Youtube configuration form. |
| video_embed_field_handler_youtube_form_validate | Validates the form elements for the Youtube configuration form. |
| video_embed_field_handle_vimeo | Handler for Vimeo videos. |
| video_embed_field_handle_vimeo_thumbnail | Gets the thumbnail url for vimeo videos. |
| video_embed_field_handle_youtube | Handler for Youtube videos. |
| video_embed_field_handle_youtube_data | Gets video data for a YouTube video URL. |
| video_embed_field_handle_youtube_thumbnail | Gets the thumbnail url for youtube videos. |
| video_embed_field_video_embed_handler_info | Implements hook_video_embed_handler_info(). |
| _video_embed_field_clean_up_youtube_data | Flattens out some unnecessary nesting in the youtube data. |
| _video_embed_field_get_vimeo_data | Helper function to get the Vimeo video's data attributes. |
| _video_embed_field_get_vimeo_id | Helper function to get the Vimeo video's data attributes. |
| _video_embed_field_get_youtube_id | Helper function to get the youtube video's id. |
| _video_embed_get_min | Calculates the min index for use in finding the id of a youtube video. |