video_widget.inc in Video 6.5
Same filename and directory in other branches
Common Video module widget functions
File
video_widget.incView source
<?php
/**
* @file
* Common Video module widget functions
*/
/**
* Process elements loads on settings
*/
function video_widget_element_settings(&$element) {
$file = $element['#value'];
$delta = $element['#delta'];
$field = content_fields($element['#field_name'], $element['#type_name']);
// Check if using the default width and replace tokens.
$override_dimensions = user_access('override player dimensions');
$allow_autoconversion = !empty($field['widget']['autoconversion']);
// Setup our default dimensions.
$dimensions = $field['widget']['default_dimensions'];
$player_dimensions = $field['widget']['default_player_dimensions'];
// Lets figure out our dimensions for our video and add astericks next to our options.
$options = video_explode("\n", variable_get('video_dimensions', video_default_dimensions()));
if (isset($element['preview']) && $override_dimensions) {
if ($allow_autoconversion) {
$video_info = _video_dimensions_options($options, $file['filepath']);
$description = t('Set your video dimensions. This will ctranscode your video with these dimensions.');
if (!empty($video_info)) {
$description .= t('Your video size is !size, if you choose a higher resolution, this could cause video distortion. You are shown dimensions that match your aspect ratio, if you choose dimensions that do not match your ratio, we will pad your video by adding black bars on either the top or bottom while maintaining your videos original aspect ratio.', array(
'!size' => $video_info['width'] . 'x' . $video_info['height'],
));
$dimensions = $video_info['width'] . 'x' . $video_info['height'];
}
// Override our dimensions to the user selected.
if (!empty($file['data']['dimensions'])) {
$dimensions = $file['data']['dimensions'];
}
$element['data']['dimensions'] = array(
'#type' => 'select',
'#title' => t('Dimensions transcoding'),
'#default_value' => $dimensions,
'#description' => $description,
'#options' => $options,
);
}
else {
$element['noautoconvert'] = array(
'#type' => 'markup',
'#value' => '<p><small>' . t('This video will not be transcoded because the setting @setting-name is off for this field.', array(
'@setting-name' => t('Enable video conversion'),
)) . '</small></p>',
'#weight' => 50,
);
}
}
if ($override_dimensions) {
// Override our player dimensions to the user selected.
if (!empty($file['data']['player_dimensions'])) {
$player_dimensions = $file['data']['player_dimensions'];
}
$element['data']['player_dimensions'] = array(
'#type' => 'select',
'#title' => t('Dimensions for video player'),
'#default_value' => $player_dimensions,
'#description' => t('WxH of your video player.'),
'#options' => $options,
);
}
// only in preview mode and then create thumbnails
if ($allow_autoconversion) {
$bypass = isset($file['data']['bypass_autoconversion']) ? $file['data']['bypass_autoconversion'] : variable_get('video_bypass_conversion', FALSE);
if (user_access('bypass conversion video')) {
$element['data']['bypass_autoconversion'] = array(
'#type' => 'checkbox',
'#title' => t('Bypass auto conversion'),
'#default_value' => $bypass,
'#description' => t('This will bypass your auto conversion of videos.'),
'#attributes' => array(
'class' => 'video-bypass-auto-conversion',
),
);
if ($file['status'] == FILE_STATUS_TEMPORARY) {
// Checkbox #default_value does not work when the checkbox is inserted using AHAH
$element['data']['bypass_autoconversion']['#value'] = $bypass;
}
}
else {
$element['data']['bypass_autoconversion'] = array(
'#type' => 'value',
'#value' => $bypass,
);
}
$convert = isset($file['data']['convert_video_on_save']) ? $file['data']['convert_video_on_save'] : variable_get('video_convert_on_save', FALSE);
if (user_access('convert on submission')) {
$element['data']['convert_video_on_save'] = array(
'#type' => 'checkbox',
'#title' => t('Convert video on save'),
'#default_value' => $convert,
'#description' => t('This will convert your video to flv format when you save, instead of scheduling it for cron.'),
'#attributes' => array(
'class' => 'video-convert-video-on-save',
),
);
if ($file['status'] == FILE_STATUS_TEMPORARY) {
// Checkbox #default_value does not work when the checkbox is inserted using AHAH
$element['data']['convert_video_on_save']['#value'] = $convert;
}
}
else {
$element['data']['convert_video_on_save'] = array(
'#type' => 'value',
'#value' => $convert,
);
}
$default_thumb = isset($file['data']['use_default_video_thumb']) ? $file['data']['use_default_video_thumb'] : variable_get('video_use_default_thumb', FALSE);
if (user_access('use default thumb')) {
$element['data']['use_default_video_thumb'] = array(
'#type' => 'checkbox',
'#title' => t('Use the default thumbnail for this video?'),
'#default_value' => $default_thumb,
'#description' => t('This will set a flag for this video to use the default video thumbnail when outputed..'),
'#attributes' => array(
'class' => 'video-use-default-video-thumb',
),
);
if ($file['status'] == FILE_STATUS_TEMPORARY) {
// Checkbox #default_value does not work when the checkbox is inserted using AHAH
$element['data']['use_default_video_thumb']['#value'] = $default_thumb;
}
}
else {
$element['data']['use_default_video_thumb'] = array(
'#type' => 'value',
'#value' => $default_thumb,
);
}
}
}
/**
* Updates options list to show matching aspect ratios and resolutions
*
* We will update the options array by reference and return the dimensions of
* the video.
*/
function _video_dimensions_options(&$options, $video) {
$transcoder = video_get_transcoder();
$dimensions = $transcoder
->get_dimensions($video);
if (empty($dimensions)) {
return $dimensions;
}
$videoratio = _video_aspect_ratio($dimensions['width'], $dimensions['height']);
// Loop through our options and find matching ratio's and also the exact width/height
foreach ($options as $key => $value) {
$wxh = explode('x', $value);
// Lets check our width and height first
if ($videoratio['width'] == $wxh[0] && $videoratio['height'] == $wxh[1]) {
$options[$key] = $value . ' ' . t('(Matches Resolution)');
}
else {
// Now lets check our ratio's
$ratio = _video_aspect_ratio($wxh[0], $wxh[1]);
if ($ratio == $videoratio) {
$options[$key] = $value . ' ' . t('(Matches Ratio)');
}
}
}
return $dimensions;
}
/**
* Video_widget_process for API handlers for any video types.
*/
function video_widget_process(&$element, &$form_state) {
$item = $element['#value'];
$field = content_fields($element['#field_name'], $element['#type_name']);
switch ($form_state['clicked_button']['#submit'][0]) {
case 'node_form_submit':
// Multistep module support
case 'multistep_save':
case 'multistep_next':
case 'multistep_previous':
case 'multistep_done':
// Auto convert our video file
if ($field['widget']['autoconversion']) {
video_convert_process($element, $field);
// Lets set our node status to unpublished if our video is not converted.
if (isset($element['#unpublish']) && $element['#unpublish']) {
// Unpublish the node
$form_state['values']['status'] = 0;
}
}
// Save manually uploaded thumbs (if they exist) and add them to element
$filename = $field['field_name'] . '_' . $element['#delta'] . '_thumbs';
if (isset($_FILES['files']) && is_array($_FILES['files']['name']) && !empty($_FILES['files']['name'][$filename])) {
video_upload_manual_thumb($element);
}
// Call hook_video_submit API
video_module_invoke('insert', $element, $form_state);
// Queue up the file id to update the node id in the video rendering / cdn tables.
$form_state['values']['video_id'][] = $item['fid'];
break;
case 'node_form_build_preview':
// Call hook_video_preview API
video_module_invoke('preview', $element, $form_state);
break;
case 'node_form_delete_submit':
// Moved to hook_file_delete in video module.
break;
}
}
/**
* Adds a video to the video rendering table.
*
* If auto converting, it will convert your video to flv right now. We are
* passing the element by reference just in case we ever want to add more to
* the element during this process.
*/
function video_convert_process(&$element, $field) {
$value =& $element['#value'];
// Set the dimensions when the user has no permission
if (!user_access('override player dimensions')) {
$value['data']['dimensions'] = $field['widget']['default_dimensions'];
$value['data']['player_dimensions'] = $field['widget']['default_player_dimensions'];
}
// If the dimensions #value is empty, it is probably because the user
// clicked the Save button directly and did not choose dimensions.
// Take the default dimensions.
$dimensions = NULL;
if (!empty($value['data']['dimensions'])) {
$dimensions = $value['data']['dimensions'];
}
elseif (!empty($element['data']['dimensions'])) {
$dimensions = $element['data']['dimensions']['#default_value'];
}
if (!empty($value['fid']) && empty($value['data']['bypass_autoconversion'])) {
$convert = FALSE;
$fid = intval($value['fid']);
// Setup our conversion class and check for the fid existence.
$transcoder = video_get_transcoder();
// Lets verify that we haven't added this video already. Multiple validation fails will cause this to be ran more than once
if (!($video = $transcoder
->load_job($fid))) {
// Get a proper video object
$file = db_fetch_object(db_query('SELECT f.* FROM {files} f WHERE f.fid = %d', $fid));
// Move the file to the original folder
$filedir = dirname($file->filepath);
$originaldir = $filedir . '/original';
if (!field_file_check_directory($originaldir, FILE_CREATE_DIRECTORY)) {
watchdog('video_command', 'Video conversion failed. Could not create directory %dir for storing original videos.', array(
'%dir' => $originaldir,
), WATCHDOG_ERROR);
return;
}
// Lets move our video and then convert it.
$filepath = $file->filepath;
if (!file_move($filepath, $originaldir . '/' . $file->filename)) {
watchdog('video_command', 'Could not move video %orig to the original folder.', array(
'%orig' => $file->filepath,
), WATCHDOG_ERROR);
return;
}
// Update our filepath since we moved it
$file->filepath = $filepath;
drupal_write_record('files', $file, 'fid');
$element['#value']['filepath'] = $filepath;
// Video has not been added to the queue yet so lets add it.
$file->dimensions = $dimensions;
if (!$transcoder
->create_job($file)) {
drupal_set_message(t('Something went wrong with your video job creation. Please check your recent log entries for further debugging.'), 'error');
}
$convert = TRUE;
// Lets queue our node status to unpublished.
$element['#unpublish'] = TRUE;
$video = $transcoder
->load_job($fid);
}
elseif ($video->status != VIDEO_RENDERING_COMPLETE) {
// Lets queue our node status to unpublished.
$element['#unpublish'] = TRUE;
}
// Our video should be in the database pending, lets see if we need to convert it now.
// Check if we are going from unselected to selected or if this is a new video and we have checked the checkbox
$convert_video_on_save = FALSE;
$element_data_convert_on_save = '';
$file_date_convert_on_save = '';
$convert_on_save = variable_get('video_convert_on_save', FALSE);
if (isset($element['data']['convert_video_on_save']['#value'])) {
$element_data_convert_on_save = $element['data']['convert_video_on_save']['#value'];
}
if (isset($value['data']['convert_video_on_save'])) {
$file_date_convert_on_save = $value['data']['convert_video_on_save'];
}
$convert_video_on_save = $element_data_convert_on_save || $file_date_convert_on_save;
if ((!isset($element['#default_value']['data']['convert_video_on_save']) || !$element['#default_value']['data']['convert_video_on_save']) && $convert_video_on_save || $convert && $convert_video_on_save || $convert_on_save) {
$return = video_process_video($video);
if ($return === FALSE) {
drupal_set_message(t('Something went wrong with your video conversion. Please check your recent log entries for further debugging.'), 'error');
}
elseif ($return === TRUE) {
// We are always unpublished until we are converted.
unset($element['#unpublish']);
drupal_set_message(t('Successfully converted your video.'));
}
}
elseif ($convert) {
drupal_set_message(t('Video submission queued for processing. Please wait: our servers are preparing your video for display.'));
}
}
}
/**
* Handle saving of manual thumbs
*/
function video_upload_manual_thumb(&$element) {
$destination = video_thumb_path($element['#value']);
if (!is_dir($destination)) {
form_set_error('video_thumb_upload', t('The thumbnail image could not be uploaded. The destination %destination does not exist or is not writable by the server.', array(
'%destination' => $destination,
)));
return;
}
$validators = array(
'file_validate_is_image' => array(),
);
if (!($file = file_save_upload($element['#field_name'] . '_' . $element['#delta'] . '_thumbs', $validators, $destination))) {
// No upload to save we hope... or file_save_upload() reported an error on its own.
return;
}
// Remove old image (if any) & clean up database.
$old_thumb = $element['data']['video_thumb']['#value'];
if (!empty($old_thumb)) {
if (file_delete($old_thumb)) {
db_query('DELETE FROM {files} WHERE filepath=\'%s\'', $old_thumb);
}
}
// Make the file permanent and store it in the form.
file_set_status($file, FILE_STATUS_PERMANENT);
$element['data']['video_thumb']['#value'] = $file->filepath;
}
function video_default_widget_settings($widget) {
$form = array();
// Default video settings.
$form['plugins'] = array(
'#type' => 'fieldset',
'#title' => t('Video advanced settings'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#weight' => 10,
);
$form['plugins']['default_dimensions'] = array(
'#type' => 'select',
'#title' => t('Default transcoding dimensions'),
'#default_value' => !empty($widget['default_dimensions']) ? $widget['default_dimensions'] : '',
'#options' => video_explode("\n", variable_get('video_dimensions', video_default_dimensions())),
'#description' => t('Default transcoding resolution WIDTHxHEIGHT, in px, that will be uses to transcode your video files.'),
);
$form['plugins']['default_player_dimensions'] = array(
'#type' => 'select',
'#title' => t('Default video player dimensions'),
'#default_value' => !empty($widget['default_player_dimensions']) ? $widget['default_player_dimensions'] : '',
'#options' => video_explode("\n", variable_get('video_dimensions', video_default_dimensions())),
'#description' => t('Default player WIDTHxHEIGHT in px. This is your actual player dimensions that your video will be playing in.'),
);
$form['plugins']['autoconversion'] = array(
'#type' => 'checkbox',
'#title' => t('Enable video conversion'),
'#default_value' => !empty($widget['autoconversion']) ? $widget['autoconversion'] : 0,
'#description' => t('Automatically convert videos to web compatible types such as FLV, Please make sure to configure your transcoder settings.') . '<br/><strong>' . t('If this option is not enabled, the input video will be used as it is uploaded.') . '</strong>',
);
// Default thumbnail settings.
$form['default'] = array(
'#type' => 'fieldset',
'#title' => t('Video thumbnail settings'),
'#element_validate' => array(
'video_default_widget_settings_validate',
),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#weight' => 11,
);
$thumb_options = array(
'auto' => 'Automatically generate thumbnails',
'auto_fallback' => 'Automatically generate thumbnails, with fallback to manual upload',
'manual_upload' => 'Manually upload a thumbnail',
'no' => 'Don\'t create thumbnail',
);
$form['default']['autothumbnail'] = array(
'#type' => 'radios',
'#title' => t('Thumbnail generation'),
'#options' => $thumb_options,
'#description' => t('Create thumbnails using the selected transcoder. Please make sure to configure your transcoder settings before enabling this option.'),
'#default_value' => isset($widget['autothumbnail']) ? $widget['autothumbnail'] : 'no',
);
// @TODO: Move this to the actual upload/attach when creating a node to allow the user to upload their own thumbnail for each video.
// Present a video image of the current default image.
if (!empty($widget['default_video_thumb'])) {
$form['default']['default_video_thumbnail'] = array(
'#type' => 'markup',
'#value' => theme('video_image', $widget['default_video_thumb'], '', '', array(
'width' => '150',
), FALSE),
'#prefix' => '<div class="video_thumbnail">',
'#suffix' => '</div>',
);
$form['default']['delete_default_video_thumbnail'] = array(
'#type' => 'checkbox',
'#title' => t('Delete the default thumbnail'),
);
}
$form['default']['default_video_thumb_upload'] = array(
'#type' => 'file',
'#title' => empty($widget['default_video_thumb']) ? t('Upload default video thumbnail') : t('Replace default video thumbnail with'),
'#description' => t('Choose a image that will be used as video thumbnail when you don\'t have video thumbnails for videos.'),
);
// We set this value on 'validate' so we can get CCK to add it
// as a standard field setting.
$form['default_video_thumb'] = array(
'#type' => 'value',
'#value' => isset($widget['default_video_thumb']) ? $widget['default_video_thumb'] : NULL,
);
return $form;
}
/**
* Element specific validation for video default value.
*/
function video_default_widget_settings_validate($element, &$form_state) {
// Verify the destination exists
$destination = video_thumb_path();
if (!field_file_check_directory($destination, FILE_CREATE_DIRECTORY)) {
form_set_error('default_video_thumb', t('The default image could not be uploaded. The destination %destination does not exist or is not writable by the server.', array(
'%destination' => dirname($destination),
)));
return;
}
$oldthumb = $form_state['values']['default_video_thumb'];
// We save the upload here because we can't know the correct path until the file is saved.
$newthumb = file_save_upload('default_video_thumb_upload', array(
'file_validate_is_image' => array(),
), $destination);
// Delete the current file if there is a new one or the delete_default_video_thumbnail checkbox is checked
if (!empty($oldthumb['fid']) && ($newthumb || !empty($form_state['values']['delete_default_video_thumbnail']))) {
if (file_delete(file_create_path($oldthumb['filepath']))) {
db_query('DELETE FROM {files} WHERE fid=%d', $oldthumb['fid']);
}
$form_state['values']['default_video_thumb'] = array();
}
if ($newthumb) {
// Make the file permanent and store it in the form.
file_set_status($newthumb, FILE_STATUS_PERMANENT);
$newthumb->timestamp = time();
$form_state['values']['default_video_thumb'] = (array) $newthumb;
}
}
function video_widget_settings_file_path_validate($element, &$form_state) {
// Lets prepend our video folder to the path settings. first truncate videos/ off the end if it exists.
// #848804
if (!module_exists('filefield_paths')) {
$form_state['values']['file_path'] = 'videos/' . $form_state['values']['file_path'];
}
}
/**
* Compares passed extensions with normal video web extensions.
*/
function video_web_extensions($ext) {
$extensions = array_filter(explode(' ', $ext));
$web_extensions = array(
'mov',
'mp4',
'3gp',
'3g2',
'mpg',
'mpeg',
'm4v',
// Quicktime
'divx',
'mkv',
// Divx
'rm',
// Realplayer
'flv',
'f4v',
// Flash player
'swf',
// SWF Player
'dir',
'dcr',
// DCR Player
'asf',
'wmv',
'avi',
'mpg',
'mpeg',
// Windows Media
'ogg',
'ogv',
'webm',
);
return count(array_diff($extensions, $web_extensions)) == 0;
}
/**
* Adds a preview of thumbnails for you to select when uploading videos.
*/
function video_thumb_process(&$element) {
$file = $element['#value'];
$fid = intval($file['fid']);
$field = content_fields($element['#field_name'], $element['#type_name']);
$gen_fail = FALSE;
if (isset($element['preview']) && $fid != 0) {
if (in_array($field['widget']['autothumbnail'], array(
'auto',
'auto_fallback',
))) {
$transcoder = video_get_transcoder();
$video = new stdClass();
$video->fid = $fid;
$video->filepath = $file['filepath'];
$video->filename = $file['filepath'];
$thumbs = $transcoder
->generate_thumbnails($video);
if (!empty($thumbs)) {
drupal_add_js(drupal_get_path('module', 'video') . '/js/video.admin.js');
$thumbss = array();
foreach ($thumbs as $img) {
$thumbss[$img->filepath] = theme('video_thumbnails', $img, '', '', array(
'width' => '50',
), FALSE);
}
if (!empty($file['data']['video_thumb']) && isset($thumbss[$file['data']['video_thumb']])) {
$currentthumb = $file['data']['video_thumb'];
}
else {
$currentthumb = array_rand($thumbss);
}
$element['data']['video_thumb'] = array(
'#type' => 'radios',
'#title' => t('Video thumbnail'),
'#options' => $thumbss,
'#default_value' => $currentthumb,
'#weight' => 10,
'#attributes' => array(
'class' => 'video-thumbnails',
'onchange' => 'videoftp_thumbnail_change()',
'rel' => 'video_large_thumbnail-' . $fid,
),
);
}
else {
$gen_fail = TRUE;
}
}
if (!empty($gen_fail) && $field['widget']['autothumbnail'] == 'auto_fallback' || $field['widget']['autothumbnail'] == 'manual_upload') {
$element['data']['video_thumb_file'] = array(
'#name' => 'files[' . $element['#field_name'] . '_' . $element['#delta'] . '_thumbs]',
'#type' => 'file',
'#size' => '40',
'#title' => !empty($file['data']['video_thumb']) ? t('Replace the video thumbnail') : t('Upload a video thumbnail'),
'#description' => t('This thumbnail will be uploaded when the node is saved.'),
);
$element['data']['video_thumb'] = array(
'#type' => 'value',
'#value' => isset($file['data']['video_thumb']) ? $file['data']['video_thumb'] : FALSE,
);
}
// Setup our large thumbnail that is on the left.
// @todo Add smaller video preview instead of thumbnail?
if (!empty($currentthumb)) {
$large_thumb = array(
'filepath' => $currentthumb,
);
}
elseif (!empty($file['data']['video_thumb'])) {
$large_thumb = array(
'filepath' => $file['data']['video_thumb'],
);
}
elseif (!empty($field['widget']['default_video_thumb'])) {
$large_thumb = $field['widget']['default_video_thumb'];
}
if (!empty($large_thumb)) {
// @todo Integrate the thumbnails with imagecache.
$element['preview']['#suffix'] = '<div class="video_large_thumbnail-' . $fid . '">' . theme('video_thumbnails', $large_thumb, '', '', array(
'width' => 150,
), FALSE) . '</div>';
}
}
}
/**
* #options helper function to set our key=value for the form api.
*/
function video_explode($delimeter, $dimensions) {
$options = array();
$values = explode($delimeter, $dimensions);
foreach ($values as $value) {
// Lets check we have a value and its in the right format
if (!empty($value) && video_format_right($value)) {
$options[trim($value)] = trim($value);
}
}
return $options;
}
function video_format_right($value) {
$format = explode('x', $value, 2);
if (!isset($format[0]) || !is_numeric(trim($format[0]))) {
return FALSE;
}
if (!isset($format[1]) || !is_numeric(trim($format[1]))) {
return FALSE;
}
return TRUE;
}Functions
Name |
Description |
|---|---|
| video_convert_process | Adds a video to the video rendering table. |
| video_default_widget_settings | |
| video_default_widget_settings_validate | Element specific validation for video default value. |
| video_explode | #options helper function to set our key=value for the form api. |
| video_format_right | |
| video_thumb_process | Adds a preview of thumbnails for you to select when uploading videos. |
| video_upload_manual_thumb | Handle saving of manual thumbs |
| video_web_extensions | Compares passed extensions with normal video web extensions. |
| video_widget_element_settings | Process elements loads on settings |
| video_widget_process | Video_widget_process for API handlers for any video types. |
| video_widget_settings_file_path_validate | |
| _video_dimensions_options | Updates options list to show matching aspect ratios and resolutions |