',
+ 'content' => array(),
+ '#prefix' => '
',
'#suffix' => '
',
- '#weight' => 0,
- 'content' => $file ? media_get_thumbnail_preview($file) : array(),
+ '#ajax' => $ajax_settings,
+ '#weight' => -10,
);
- // @todo: Perhaps this language logic should be handled by JS since the state
- // changes on client side after choosing an item.
- $element['select'] = array(
+ // Substitute the JS preview for a true file thumbnail and disable browsing
+ // for files once the file is attached.
+ if ($element['#file']) {
+ $element['preview']['content'] = media_get_thumbnail_preview($element['#file']);
+ $element['preview']['#prefix'] = '';
+ $element['preview']['#suffix'] = '';
+ }
+
+ $element['browse_button'] = array(
'#type' => 'link',
'#href' => '',
- '#title' => t('Select'),
- '#attributes' => array('class' => array('button', 'launcher')),
+ '#title' => t('Browse'),
+ '#attributes' => array('class' => array('button', 'browse')),
'#options' => array('fragment' => FALSE, 'external' => TRUE),
- '#weight' => 10,
+ '#weight' => -9,
);
- // @todo Figure out how to update the preview image after the Edit modal is
- // closed.
- $element['edit'] = array(
- '#type' => 'link',
- '#href' => 'media/' . $fid . '/edit/nojs',
- '#title' => t('Edit'),
- '#attributes' => array(
- 'class' => array(
- // Required for CTools modal to work.
- 'ctools-use-modal', 'use-ajax',
- 'ctools-modal-media-file-edit', 'button', 'edit',
- ),
- ),
- '#weight' => 20,
- '#access' => $file ? file_entity_access('update', $file) : TRUE, // only do perm check for existing files
- );
- $element['remove'] = array(
- '#type' => 'link',
- '#href' => '',
- '#title' => t('Remove'),
+
+ // Force the progress indicator for the remove button to be either 'none' or
+ // 'throbber', even if the upload button is using something else.
+ $ajax_settings['progress']['type'] = 'throbber';
+ $ajax_settings['progress']['message'] = NULL;
+ $ajax_settings['effect'] = 'none';
+ $element['remove_button'] = array(
+ '#name' => implode('_', $element['#parents']) . '_remove_button',
+ '#type' => 'submit',
+ '#value' => t('Remove'),
+ '#validate' => array(),
+ '#submit' => array('media_file_submit'),
+ '#limit_validation_errors' => array($element['#parents']),
+ '#ajax' => $ajax_settings,
'#attributes' => array('class' => array('button', 'remove')),
- '#options' => array('fragment' => FALSE, 'external' => TRUE),
- '#weight' => 30,
+ '#weight' => -3,
+ '#access' => $element['#file'] ? file_entity_access('delete', $element['#file']) : TRUE, // only do perm check for existing files
);
$element['fid'] = array(
'#type' => 'hidden',
'#value' => $fid,
'#attributes' => array('class' => array('fid')),
- '#weight' => 100,
);
// Media browser attach code.
$element['#attached']['js'][] = drupal_get_path('module', 'media') . '/js/media.js';
- $setting = array();
- $setting['media']['elements'][$element['#id']] = $element['#media_options'];
-
- $element['#attached']['js'][] = array(
- 'type' => 'setting',
- 'data' => $setting,
+ // Add the media options to the page as JavaScript settings.
+ $element['browse_button']['#attached']['js'] = array(
+ array(
+ 'type' => 'setting',
+ 'data' => array('media' => array('elements' => array('#' . $element['#id'] . '-browse-button' => $element['#media_options'])))
+ )
);
- // @todo: Might need to think about this. All settings would likely apply to
- // all media in a multi-value, but what about passing the existing fid?
module_load_include('inc', 'media', 'includes/media.browser');
media_attach_browser_js($element);
+ // Prefix and suffix used for Ajax replacement.
+ $element['#prefix'] = '
';
+ $element['#suffix'] = '
';
+
return $element;
- // @todo: make this work for file and image fields.
+}
+
+/**
+ * The #value_callback for a media type element.
+ */
+function media_file_value(&$element, $input = FALSE, $form_state = NULL) {
+ $fid = 0;
+
+ // Find the current value of this field from the form state.
+ $form_state_fid = $form_state['values'];
+ foreach ($element['#parents'] as $parent) {
+ $form_state_fid = isset($form_state_fid[$parent]) ? $form_state_fid[$parent] : 0;
+ }
+
+ if ($element['#extended'] && isset($form_state_fid['fid'])) {
+ $fid = $form_state_fid['fid'];
+ }
+ elseif (is_numeric($form_state_fid)) {
+ $fid = $form_state_fid;
+ }
+
+ // Process any input and save new uploads.
+ if ($input !== FALSE) {
+ $return = $input;
+
+ // Uploads take priority over all other values.
+ if ($file = file_managed_file_save_upload($element)) {
+ $fid = $file->fid;
+ }
+ else {
+ // Check for #filefield_value_callback values.
+ // Because FAPI does not allow multiple #value_callback values like it
+ // does for #element_validate and #process, this fills the missing
+ // functionality to allow File fields to be extended through FAPI.
+ if (isset($element['#file_value_callbacks'])) {
+ foreach ($element['#file_value_callbacks'] as $callback) {
+ $callback($element, $input, $form_state);
+ }
+ }
+ // Load file if the FID has changed to confirm it exists.
+ if (isset($input['fid']) && $file = file_load($input['fid'])) {
+ $fid = $file->fid;
+ }
+ }
+ }
+
+ // If there is no input, set the default value.
+ else {
+ if ($element['#extended']) {
+ $default_fid = isset($element['#default_value']['fid']) ? $element['#default_value']['fid'] : 0;
+ $return = isset($element['#default_value']) ? $element['#default_value'] : array('fid' => 0);
+ }
+ else {
+ $default_fid = isset($element['#default_value']) ? $element['#default_value'] : 0;
+ $return = array('fid' => 0);
+ }
+
+ // Confirm that the file exists when used as a default value.
+ if ($default_fid && $file = file_load($default_fid)) {
+ $fid = $file->fid;
+ }
+ }
+
+ $return['fid'] = $fid;
+
+ return $return;
}
/**
@@ -690,20 +797,96 @@ function media_element_process(&$element, &$form_state, $form) {
* necessary in order to respect the #required property.
*/
function media_element_validate(&$element, &$form_state) {
- if ($element['#required']) {
- $has_value = FALSE;
- $widget_parents = $element['#array_parents'];
- array_pop($widget_parents);
- $items = drupal_array_get_nested_value($form_state['values'], $widget_parents);
- foreach ($items as $value) {
- if (is_array($value) && !empty($value['fid'])) {
- $has_value = TRUE;
- }
- }
- if (!$has_value) {
- form_error($element, t('%element_title field is required.', array('%element_title' => $element['#title'])));
+ $clicked_button = end($form_state['triggering_element']['#parents']);
+
+ // Check required property based on the FID.
+ if ($element['#required'] && empty($element['fid']['#value']) && !in_array($clicked_button, array('attach_button', 'edit_button', 'remove_button'))) {
+ form_error($element['browse_button'], t('!name field is required.', array('!name' => $element['#title'])));
+ }
+
+ // Consolidate the array value of this field to a single FID.
+ if (!$element['#extended']) {
+ form_set_value($element, $element['fid']['#value'], $form_state);
+ }
+}
+
+/**
+ * Form submission handler for attach / edit / remove buttons of media elements.
+ *
+ * @see media_element_process()
+ */
+function media_file_submit($form, &$form_state) {
+ // Determine whether it was the attach, edit or remove button that was
+ // clicked, and set $element to the managed_file element that contains that
+ // button.
+ $parents = $form_state['triggering_element']['#array_parents'];
+ $button_key = array_pop($parents);
+ $element = drupal_array_get_nested_value($form, $parents);
+
+ // No action is needed here for the attach button, because all file uploads on
+ // the form are processed by media_file_value() regardless of which button was
+ // clicked. Action is needed here for the remove button, because we only
+ // remove a file in response to its remove button being clicked.
+ if ($button_key == 'remove_button') {
+ // If it's a temporary file we can safely remove it immediately, otherwise
+ // it's up to the implementing module to clean up files that are in use.
+ if ($element['#file'] && $element['#file']->status == 0) {
+ file_delete($element['#file']);
}
+ // Update both $form_state['values'] and $form_state['input'] to reflect
+ // that the file has been removed, so that the form is rebuilt correctly.
+ // $form_state['values'] must be updated in case additional submit handlers
+ // run, and for form building functions that run during the rebuild, such as
+ // when the media element is part of a field widget.
+ // $form_state['input'] must be updated so that media_file_value() has
+ // correct information during the rebuild.
+ $values_element = $element['#extended'] ? $element['fid'] : $element;
+ form_set_value($values_element, NULL, $form_state);
+ drupal_array_set_nested_value($form_state['input'], $values_element['#parents'], NULL);
}
+
+ // Set the form to rebuild so that $form is correctly updated in response to
+ // processing the file removal. Since this function did not change $form_state
+ // if the upload button was clicked, a rebuild isn't necessary in that
+ // situation and setting $form_state['redirect'] to FALSE would suffice.
+ // However, we choose to always rebuild, to keep the form processing workflow
+ // consistent between the two buttons.
+ $form_state['rebuild'] = TRUE;
+}
+
+/**
+ * #pre_render callback to hide display of the browse/attach or edit/remove
+ * controls.
+ *
+ * Browse/attach controls are hidden when a file is already uploaded.
+ * Edit/Remove controls are hidden when there is no file attached. Controls are
+ * hidden here instead of in media_element_process(), because #access for these
+ * buttons depends on the media element's #value. See the documentation of
+ * form_builder() for more detailed information about the relationship between
+ * #process, #value, and #access.
+ *
+ * Because #access is set here, it affects display only and does not prevent
+ * JavaScript or other untrusted code from submitting the form as though access
+ * were enabled. The form processing functions for these elements should not
+ * assume that the buttons can't be "clicked" just because they are not
+ * displayed.
+ *
+ * @see media_element_process()
+ * @see form_builder()
+ */
+function media_element_pre_render($element) {
+ // If we already have a file, we don't want to show the browse and attach
+ // controls.
+ if (!empty($element['#value']['fid'])) {
+ $element['browse_button']['#access'] = FALSE;
+ $element['attach_button']['#access'] = FALSE;
+ }
+ // If we don't already have a file, there is nothing to edit or remove.
+ else {
+ $element['edit_button']['#access'] = FALSE;
+ $element['remove_button']['#access'] = FALSE;
+ }
+ return $element;
}
/**