uploadfield_widget.inc in Video 6.3
Same filename and directory in other branches
uploadfield widget hooks and callbacks.
File
types/uploadfield/uploadfield_widget.incView source
<?php
/**
* @file
* uploadfield widget hooks and callbacks.
*/
/**
* Implementation of CCK's hook_widget_settings($op = 'form').
*/
function uploadfield_widget_settings_form($widget) {
$form = module_invoke('filefield', 'widget_settings', 'form', $widget);
if ($form['file_extensions']['#default_value'] == 'txt') {
$form['file_extensions']['#default_value'] = 'mp4 mpeg avi mpg wmv flv';
}
// Default video player settings.
$form['player'] = array(
'#type' => 'fieldset',
'#title' => t('Video Player Settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
'#weight' => 9,
);
$form['player']['default_resolution'] = array(
'#type' => 'textfield',
'#title' => t('Default Video Resolution'),
'#default_value' => !empty($widget['default_resolution']) ? $widget['default_resolution'] : '16:9',
'#size' => 15,
'#maxlength' => 5,
'#description' => t('Default player resolution WIDTH:HEIGHT in px. eg : 16:9 for widescreen or 4:3 for general screen'),
);
$form['player']['default_width'] = array(
'#type' => 'textfield',
'#title' => t('Default Video Player Width'),
'#default_value' => !empty($widget['default_width']) ? $widget['default_width'] : 640,
'#size' => 15,
'#maxlength' => 5,
'#description' => t('Default player WIDTH:HEIGHT in px. eg : 640 for 640X480 player size if resolution it 4:3'),
);
// Default image settings.
$form['default'] = array(
'#type' => 'fieldset',
'#title' => t('Video Thumbnail Settings'),
'#element_validate' => array(
'_uploadfield_widget_settings_default_validate',
),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#weight' => 10,
);
// 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('uploadfield_image', $widget['default_video_thumb'], '', '', array(
'width' => '150',
), FALSE),
'#prefix' => '<div class="video_thumbnail">',
'#suffix' => '</div>',
);
}
$form['default']['default_video_thumb_upload'] = array(
'#type' => 'file',
'#title' => empty($widget['default_video_thumb']) ? t('Upload video thumbnail') : t('Replace video thumbnail with'),
'#description' => t('Choose a image that will be used as default video thumbnail.'),
);
// 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' => $widget['default_video_thumb'],
);
// Default image settings.
$form['plugings'] = array(
'#type' => 'fieldset',
'#title' => t('Video Advanced Settings'),
'#collapsible' => TRUE,
'#collapsed' => FALSE,
'#weight' => 10,
);
$form['plugings']['autoconversion'] = array(
'#type' => 'checkbox',
'#title' => t('Enable auto conversion video'),
'#description' => t('Use ffmpeg(Default) to automatically convert videos to web compatible types eg. FLV, Please make sure to configure convertor settings.'),
'#default_value' => $widget['autoconversion'],
);
$form['plugings']['autothumbnail'] = array(
'#type' => 'checkbox',
'#title' => t('Enable auto thumbnail video'),
'#description' => t('Use ffmpeg(Default) to automatically thumbnails, Please make sure to configure convertor settings.'),
'#default_value' => $widget['autothumbnail'],
);
return $form;
}
/**
* Element specific validation for uploadfield default value.
*
* Validated in a separate function from uploadfield_field() to get access
* to the $form_state variable.
*/
function _uploadfield_widget_settings_default_validate($element, &$form_state) {
// Verify the destination exists
$destination = file_directory_path() . '/video_thumb';
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;
}
$validators = array(
'file_validate_is_image' => array(),
);
// We save the upload here because we can't know the correct path until the file is saved.
if (!($file = file_save_upload('default_video_thumb_upload', $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_default = $form_state['values']['default_video_thumb'];
if (!empty($old_default['fid'])) {
if (file_delete(file_create_path($old_default['filepath']))) {
db_query('DELETE FROM {files} WHERE fid=%d', $old_default['fid']);
}
}
// Make the file permanent and store it in the form.
file_set_status($file, FILE_STATUS_PERMANENT);
$file->timestamp = time();
$form_state['values']['default_video_thumb'] = (array) $file;
}
/**
* Implementation of CCK's hook_widget_settings($op = 'validate').
*/
function uploadfield_widget_settings_validate($widget) {
// Check that only web images are specified in the callback.
$extensions = array_filter(explode(' ', $widget['file_extensions']));
$web_extensions = array(
'mov',
'mp4',
'3gp',
'3g2',
'mpg',
'mpeg',
// quicktime
'divx',
//divx
'rm',
// realplayer
'flv',
'f4v',
//flash player
'swf',
// swf player
'dir',
'dcr',
// dcr player
'asf',
'wmv',
'avi',
'mpg',
'mpeg',
// windows media
'ogg',
);
if (count(array_diff($extensions, $web_extensions))) {
form_set_error('file_extensions', t('Only web-standard videos are supported through the video widget. If needing to upload other types of files, change the widget to use a standard file upload.'));
}
// Check that set video resolutions are valid.
foreach (array(
'default_width',
) as $numerics) {
if (!empty($widget[$numerics]) && !preg_match('/^[0-9]+$/', $widget[$numerics])) {
form_set_error($numerics, t('Please specify default width in integers only (e.g. 640).'));
}
}
// Check that set resolutions are valid.
foreach (array(
'default_resolution',
) as $resolution) {
if (!empty($widget[$resolution]) && !preg_match('/^[0-9]+:[0-9]+$/', $widget[$resolution])) {
form_set_error($resolution, t('Please specify a resolution in the format WIDTH:HEIGHT (e.g. 16:9).'));
}
}
// Check for convertor is installed
}
/**
* Implementation of CCK's hook_widget_settings($op = 'save').
*/
function uploadfield_widget_settings_save($widget) {
$filefield_settings = module_invoke('filefield', 'widget_settings', 'save', $widget);
return array_merge($filefield_settings, array(
'default_video_thumb',
'default_width',
'default_resolution',
'autoconversion',
'autothumbnail',
));
}
/**
* Element #value_callback function.
*/
function uploadfield_widget_value($element, $edit = FALSE) {
$item = filefield_widget_value($element, $edit);
// print_r($edit);
// exit;
// if ($edit) {
// $item['alt'] = isset($edit['alt']) ? $edit['alt'] : '';
// $item['title'] = isset($edit['title']) ? $edit['title'] : '';
// $item['video_thumb_fid'] = isset($edit['default_video_thumb']['fid']) ? $edit['default_video_thumb']['fid'] : 'novalue';
// }
// else {
// $item['alt'] = '';
// $item['title'] = '';
// $item['default_video_thumb'] = '';
// }
return $item;
}
/**
* Element #process callback function.
*/
function uploadfield_widget_process($element, $edit, &$form_state, $form) {
// TODO : get play duration/ image thumbnails
$file = $element['#value'];
$field = content_fields($element['#field_name'], $element['#type_name']);
$element['#theme'] = 'uploadfield_widget_item';
if (isset($element['preview']) && $file['fid'] != 0) {
//TODO : implement preview video play
$tml_thumb = !empty($file['data']['video_thumb']) ? array(
'filepath' => $file['data']['video_thumb'],
) : $field['widget']['default_video_thumb'];
$element['preview']['#suffix'] = '<div class="video_thumbnail">' . theme('uploadfield_image', $tml_thumb, '', '', array(
'width' => '150',
), FALSE) . '</div>';
}
// Check if using the default width and replace tokens.
$default_width = user_access('override player width');
$element['data']['width'] = array(
'#type' => $default_width ? 'textfield' : 'value',
'#title' => t('Width for Player'),
'#default_value' => empty($file['data']['width']) ? $field['widget']['default_width'] : $file['data']['width'],
'#description' => t('Set player width(in pix) here, make sure your video have good resolution to fit on larger values.'),
'#size' => 15,
'#maxlength' => 5,
'#attributes' => array(
'class' => 'video-width-text',
),
);
if (!$default_width) {
$element['data']['width']['#value'] = empty($file['data']['width']) ? $field['widget']['default_width'] : $file['data']['width'];
}
// only in preview mode and then create thumbnails
if ($field['widget']['autoconversion']) {
video_module_invoke('convert', $element);
//bypass auto conversion
if (user_access('bypass conversion video')) {
$element['data']['bypass_autoconversion'] = array(
'#type' => 'checkbox',
'#title' => t('Bypass auto conversion'),
'#default_value' => !empty($file['data']['bypass_autoconversion']) ? $file['data']['bypass_autoconversion'] : FALSE,
'#description' => t('This will bypass your auto conversion of videos.'),
'#attributes' => array(
'class' => 'video-bypass-auto-conversion',
),
);
/* Future development
$element['data']['convert_video_on_save'] = array(
'#type' => 'checkbox',
'#title' => t('Convert video on save'),
'#default_value' => !empty($file['data']['convert_video_on_save']) ? $file['data']['convert_video_on_save'] : FALSE,
'#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'),
);
*/
}
}
//Create video thubs and save in a directory then we can get thumbnails from it using folder read
// only in preview mode and then create thumbnails
if ($field['widget']['autothumbnail']) {
video_module_invoke('thumbs', $element);
}
// default image default_image
if (user_access('use default thumbnail') && !empty($field['widget']['default_video_thumb'])) {
$element['data']['use_default_video_thumb'] = array(
'#type' => 'checkbox',
'#title' => t('Override Video Thumbnail with Default'),
'#default_value' => !empty($file['data']['use_default_video_thumb']) ? $file['data']['use_default_video_thumb'] : FALSE,
'#description' => t('If you want to use default image instead of using actual thumbnail of video then check.'),
'#weight' => 9,
'#attributes' => array(
'class' => 'video-default-thumbnail',
),
);
}
//Lets use the clicked_button #submit[0] value here instead and see how that works out for now...
//@todo This switch needs rework, especially the delete. We may not need this anymore as we can hand
//off the actual checking to other functionality.
if ($form_state['submitted'] == 1) {
switch ($form_state['clicked_button']['#submit'][0]) {
case 'node_form_submit':
if (!empty($form_state['values']['nid'])) {
video_module_invoke('update', $element);
}
else {
video_module_invoke('insert', $element);
}
break;
case 'node_form_build_preview':
break;
case 'node_form_delete_submit':
//@todo When a user presses the delete button, they are then prompted with a confirmation page.
//If a user clicks cancel on that page... well the dlete hook is still executed. Need to put this somewhere else.
video_module_invoke('delete', $element);
break;
}
}
return $element;
}
/**
* FormAPI theme function. Theme the output of an video upload field.
*/
function theme_uploadfield_widget($element) {
drupal_add_css(drupal_get_path('module', 'uploadfield') . '/uploadfield.css');
return theme('form_element', $element, $element['#children']);
}Functions
Name |
Description |
|---|---|
| theme_uploadfield_widget | FormAPI theme function. Theme the output of an video upload field. |
| uploadfield_widget_process | Element #process callback function. |
| uploadfield_widget_settings_form | Implementation of CCK's hook_widget_settings($op = 'form'). |
| uploadfield_widget_settings_save | Implementation of CCK's hook_widget_settings($op = 'save'). |
| uploadfield_widget_settings_validate | Implementation of CCK's hook_widget_settings($op = 'validate'). |
| uploadfield_widget_value | Element #value_callback function. |
| _uploadfield_widget_settings_default_validate | Element specific validation for uploadfield default value. |