', 'media/' . $file->fid);
}
}
@@ -311,9 +304,9 @@ function media_add_upload_multiple_submit($form, &$form_state) {
/**
* Form builder: Builds the edit file form.
*/
-function media_edit($form, $form_state, $media) {
- field_attach_form('media', $media, $form, $form_state);
- unset($form['file']);
+function media_edit($form, $form_state, $file) {
+ $form_state['file'] = $file;
+ field_attach_form('file', $file, $form, $form_state);
$form['#attached'] = array(
'css' => array(drupal_get_path('module', 'media') . '/css/media.css'),
@@ -323,7 +316,7 @@ function media_edit($form, $form_state, $media) {
$form['#attributes']['class'][] = 'media-image-left';
$form['#attributes']['class'][] = 'media-edit-form';
- $form['preview'] = field_view_field('media', $media, 'file', 'media_preview');
+ $form['preview'] = file_view_file($file, 'media_preview');
$form['preview']['#weight'] = -10;
$form['preview']['#suffix'] = '';
@@ -344,29 +337,34 @@ function media_edit($form, $form_state, $media) {
'#submit' => array('media_edit_submit'),
);
- $form['fid'] = array(
- '#type' => 'hidden',
- '#value' => $media->fid,
- );
+ // Add internal file properties needed by media_edit_validate().
+ foreach (array('fid', 'type') as $key) {
+ $form[$key] = array('#type' => 'value', '#value' => $file->$key);
+ }
return $form;
}
+/**
+ * Form validation handler for the media edit form.
+ */
function media_edit_validate($form, &$form_state) {
- $media = media_load($form_state['values']['fid']);
- field_attach_form_validate('media', $media, $form, $form_state);
+ entity_form_field_validate('file', $form, $form_state);
}
/**
- * Process media_edit form submissions.
+ * Form submit handler for the media submit form.
*/
function media_edit_submit($form, &$form_state) {
- $media = media_load($form_state['values']['fid']);
- field_attach_submit('media', $media, $form, $form_state);
- media_save($media);
- $form_state['redirect'] = 'media/' . $media->fid;
+ $file = $form_state['file'];
+ entity_form_submit_build_entity('file', $file, $form, $form_state);
+ file_save($file);
+ $form_state['redirect'] = 'media/' . $file->fid;
}
+/**
+ * Form submit handler for the Delete button on the media edit form.
+ */
function media_edit_delete_submit($form, &$form_state) {
$fid = $form_state['values']['fid'];
$destination = array();
diff --git a/includes/media.theme.inc b/includes/media.theme.inc
index 1b5f373..84855ce 100644
--- a/includes/media.theme.inc
+++ b/includes/media.theme.inc
@@ -283,7 +283,7 @@ function theme_media_thumbnail($variables) {
// Arguments for the thumbnail link
$thumb = $element['#children'];
- $target = 'media/' . $element['#object']->fid . '/edit';
+ $target = 'media/' . $element['#file']->fid . '/edit';
$options = array('query' => $destination, 'html' => true, 'attributes' => array('title' => t('Click to edit details')));
// Element should be a field renderable array... This is a little wonky - admitted.
@@ -310,7 +310,7 @@ function template_preprocess_media_thumbnail(&$variables) {
// Set the name for the thumbnail to be the filename. This is done here so
// that other modules can hijack the name displayed if it should not be the
// filename.
- $variables['element']['#name'] = isset($variables['element']['#object']->filename) ? $variables['element']['#object']->filename : NULL;
+ $variables['element']['#name'] = isset($variables['element']['#file']->filename) ? $variables['element']['#file']->filename : NULL;
}
/**
@@ -320,5 +320,6 @@ function theme_media_formatter_large_icon($variables) {
$file = $variables['file'];
$icon_dir = media_variable_get('icon_base_directory') . '/' . media_variable_get('icon_set');
$icon = file_icon_path((object)$file, $icon_dir);
- return theme('image', array('path' => $icon));
+ $variables['path'] = $icon;
+ return theme('image', $variables);
}
diff --git a/includes/media.types.inc b/includes/media.types.inc
index 8f7a813..65a99d6 100644
--- a/includes/media.types.inc
+++ b/includes/media.types.inc
@@ -9,6 +9,83 @@
*/
/**
+ * Implements hook_file_type_info().
+ */
+function media_file_type_info() {
+ $types = array();
+ foreach (media_type_get_types() as $type => $type_object) {
+ $types[$type] = array(
+ 'label' => $type_object->label,
+ 'weight' => $type_object->weight,
+ 'claim callback' => 'media_file_type_media_claim',
+ 'default view callback' => 'media_file_type_media_default_view',
+ );
+ }
+ return $types;
+}
+
+/**
+ * Implements hook_file_type_TYPE_claim().
+ *
+ * Returns TRUE if the passed in file should be assigned the passed in type.
+ */
+function media_file_type_media_claim($file, $type) {
+ if (($type_object = media_type_load($type)) && ($function = $type_object->type_callback) && function_exists($function) && $function($file, $type_object->type_callback_args)) {
+ return TRUE;
+ }
+}
+
+/**
+ * Implements hook_file_type_TYPE_default_view().
+ *
+ * Returns a drupal_render() array for displaying the file when there are no
+ * administrator-configured formatters, or none of the configured ones return a
+ * display.
+ */
+function media_file_type_media_default_view($file, $view_mode, $langcode) {
+ // If the file is an image, attempt to display it using the File Entity
+ // module's image formatter.
+ if ($file->type == 'image') {
+ if ($view_mode == 'media_preview') {
+ $image_style = 'square_thumbnail';
+ }
+ elseif ($view_mode == 'media_large') {
+ $image_style = 'large';
+ }
+ elseif ($view_mode == 'media_original') {
+ $image_style = '';
+ }
+ if (isset($image_style)) {
+ $display = array(
+ 'type' => 'file_image',
+ 'settings' => array(
+ 'image_style' => $image_style,
+ ),
+ );
+ $element = file_entity_file_formatter_file_image_view($file, $display, $langcode);
+ if (isset($element)) {
+ return $element;
+ }
+ }
+ }
+
+ // During preview, or when custom attribute values are needed on the displayed
+ // element, use a media icon.
+ if ($view_mode == 'media_preview' || isset($file->override)) {
+ return array(
+ '#theme' => 'media_formatter_large_icon',
+ '#file' => $file,
+ );
+ }
+
+ // Finally, fall back to File module's generic file display.
+ return array(
+ '#theme' => 'file_link',
+ '#file' => $file,
+ );
+}
+
+/**
* Update an existing media type or create a new one.
*
* The default media types are currently 'Audio', 'Image', 'Video', and
@@ -40,8 +117,6 @@ function media_type_save(&$type) {
->fields((array)$type)
->execute();
- media_type_configure_fields($type);
-
// Clear the caches
drupal_static_reset('media_type_get_types');
drupal_static_reset('media_type_get_mime_map');
@@ -49,37 +124,11 @@ function media_type_save(&$type) {
}
/**
- * Assigns formatters to view_modes for the file field of a media type.
- *
- * Each media type contains a field called "file" and certain stock view modes.
- * This function will assign a format to each view mode. For instance, images
- * would want to use a thumbnail format for files when in the "preview"
- * view_mode. The called would pass in 'image' for $name and
- * array('media_preview' => 'styles_file_square_thumbnail') to $view_modes_to_formatters.
- *
- * This will also set the "custom_settings" bit to make sure it actually takes effect.
- *
- * @param string $name
- * @param array $view_modes_to_formatters
- * @throws Exception
- * @return void
+ * @todo Remove this function after ensuring that nothing (including update
+ * functions) call it. It is deprecated with the change from media entity
+ * containing a file field to just a file entity.
*/
function media_type_configure_formatters($name, $view_modes_to_formatters) {
- $instance = field_info_instance('media', 'file', $name);
- $bundle_settings = field_bundle_settings('media', $name);
-
- if (!$instance) {
- throw new Exception('Unable to set formatter preferences for '. $name);
- }
- foreach ($view_modes_to_formatters as $view_mode => $formatter) {
- $bundle_settings['view_modes'][$view_mode]['custom_settings'] = 1;
- if (!isset($instance['display'][$view_mode])) {
- $instance['display'][$view_mode] = $instance['display']['default'];
- }
- $instance['display'][$view_mode]['type'] = $formatter;
- }
- field_bundle_settings('media', $name, $bundle_settings);
- field_update_instance($instance);
}
/**
@@ -96,58 +145,6 @@ function media_type_load($name) {
}
/**
- * Sets up the default fields which a media type needs.
- *
- * Currently, this is just a "file" field which contains the reference to the actual file.
- * @TODO Do we also want to make the file 'description/caption' a field?
- *
- * @param StdClass $media_type
- * @return void
- */
-function media_type_configure_fields($media_type) {
- $field = field_info_field('file');
- $instance = field_info_instance('media', 'file', $media_type->name);
-
- if (empty($field)) {
- $field = array(
- 'field_name' => 'file',
- 'type' => 'file',
- );
- $field = field_create_field($field);
- }
-
- // Perhaps the file field exists already, if so skip.
- if (empty($instance)) {
- $weight = -5;
- $instance = array(
- 'field_name' => 'file',
- 'entity_type' => 'media',
- 'bundle' => $media_type->name,
- 'label' => 'File',
- 'widget_type' => 'file_file',
- 'widget' => array(
- 'weight' => $weight,
- ),
- 'required' => TRUE,
- 'locked' => TRUE,
- 'display' => array(
- 'media_preview' => array(
- 'label' => 'hidden',
- 'type' => 'file_default',
- 'weight' => $weight,
- ),
- 'media_original' => array(
- 'label' => 'hidden',
- 'type' => 'file_default',
- 'weight' => $weight,
- ),
- ),
- );
- field_create_instance($instance);
- }
-}
-
-/**
* Loads all media types into an array keyed by machine name and sorted
* and weighted lexographically.
*
@@ -207,22 +204,22 @@ function media_get_type($file) {
}
/**
- * Default callback used to determine if a piece of media is of a given type.
+ * Default callback used to determine if a file is of a given type.
*
* @TODO: document 'any' and 'all' matching.
*
- * @param $media
- * The media file asset object.
+ * @param $file
+ * The file object.
* @param $args
*
* @return unknown_type
*/
-function media_is_type($media, $args) {
+function media_is_type($file, $args) {
$match_type = !empty($args['match_type']) ? 'any' : $args['match_type'];
$match_all = $match_type == 'all';
if (!empty($args['mimetypes'])) {
foreach ($args['mimetypes'] as $expression) {
- if (preg_match($expression, $media->filemime)) {
+ if (preg_match($expression, $file->filemime)) {
if (!$match_all) {
return TRUE;
}
@@ -235,7 +232,7 @@ function media_is_type($media, $args) {
}
if (!empty($args['extensions'])) {
- if (in_array(pathinfo($media->uri, PATHINFO_EXTENSION), $args['extensions'])) {
+ if (in_array(pathinfo($file->uri, PATHINFO_EXTENSION), $args['extensions'])) {
if (!$match_all) {
return TRUE;
}
@@ -253,15 +250,13 @@ function media_is_type($media, $args) {
/**
* Implement hook_media_format_form_prepare_alter
*/
-function media_media_format_form_prepare_alter(&$form, &$form_state, $media) {
- switch($media->type) {
+function media_media_format_form_prepare_alter(&$form, &$form_state, $file) {
+ switch($file->type) {
case 'image':
- // @TODO: Isn't there a $file->description?
- $description = $media->filename;
- $form['options']['alt'] = array(
+ $form['options']['alt'] = array(
'#type' => 'textfield',
'#title' => t('Description'),
- '#default_value' => $description,
+ '#default_value' => $file->filename,
'#description' => t('Alternate text a user will see if the image is not available'),
);
break;
@@ -273,7 +268,7 @@ function media_media_format_form_prepare_alter(&$form, &$form_state, $media) {
*/
function media_type_invalid_files_count() {
return db_select('file_managed', 'fm')
- ->condition('type', NULL)
+ ->condition('type', '')
->countQuery()
->execute()
->fetchField();
@@ -298,7 +293,7 @@ function media_type_batch_update($update_existing = FALSE, $no_to_update = NULL,
->fields('fm', array('fid'));
if (!$update_existing) {
- $query->condition('type', NULL);
+ $query->condition('type', '');
}
if ($no_to_update) {
@@ -314,7 +309,6 @@ function media_type_batch_update($update_existing = FALSE, $no_to_update = NULL,
if (!$file->fid) {
throw new Exception('Unable to continue, file was not loaded.');
}
- $file->type = media_get_type($file);
file_save($file);
$results[] = $fid;
}
diff --git a/media.info b/media.info
index 782b255..e382383 100644
--- a/media.info
+++ b/media.info
@@ -3,7 +3,7 @@ name = Media
description = Provides the core Media API
package = Media
core = 7.x
-php = 5.2
+
files[] = media.install
files[] = media.module
files[] = includes/media.admin.inc
@@ -14,8 +14,8 @@ files[] = includes/MediaReadOnlyStreamWrapper.inc
files[] = test/media.types.test
files[] = test/media.entity.test
files[] = test/media.filter.test
-dependencies[] = file
+
+dependencies[] = file_entity
dependencies[] = image
-dependencies[] = file_styles
testing_api = 2.x
diff --git a/media.install b/media.install
index 957add3..c88452e 100644
--- a/media.install
+++ b/media.install
@@ -11,87 +11,35 @@ define('MEDIA_UPDATE_RECORDS_ON_INSTALL', 200);
* Implements hook_install().
*/
function media_install() {
- /**
- * DISCLAIMER:
- * Yes I am altering a core table.
- * No I am not on crack.
- * Basically, the problem we're facing is the media "type" which is not the
- * mime type, but is probably computed from it.
- *
- * The file table has no type field. As a result, we would have to either:
- *
- * 1). Create a media_files table to join them. This is nice and clean,
- * however it requires keeping the tables in sync, and it also means we have
- * to write our own SQL instead of using BaseEntityController, and that's
- * kinda scary.
- *
- * 2). Make the media type a "computed" field. Wherein, everytime we loaded
- * a piece of media, we would need to compute its type from the mime-type.
- * This is unacceptable from a performance standpoint and also requires us
- * override the Controller in ways we probably don't want to.
- *
- * I know it's a sin, but I think it is also excusable because:
- *
- * 1). This is hoping to be a core addition, so think of it as a core patch
- * that will eventually go in.
- *
- * 2). It is adding a new field, so it shouldn't cause any conflicts. If it
- * does that INSERT / SELECT code is badly written and should use complete
- * INSERTS or column names.
- */
-
- // Alter {file_managed}.type and add it as an index.
- db_add_field('file_managed', 'type', _media_type_field_spec());
- db_add_index('file_managed', 'file_type', array('type'));
+ // @todo Move some of what's in media_enable() into here.
}
/**
* Implement hook_enable().
*/
function media_enable() {
- // @TODO: Revisit the default types to provide. For instance, PDFs and text.
// @TODO: We may need to disable the media bundle & field in hook_disable.
- $view_mode_defaults = array(
- 'media_link' => 'file_generic',
- 'media_preview' => 'media_large_icon',
- //@TODO: We need a real "original" formatter
- 'media_original' => 'file_generic',
- 'media_small' => 'hidden',
- 'media_large' => 'file_generic',
- );
-
$types = array();
- // This is the default type which will be used if no other type is found
+ // Define the default type to be used if no other type is found. Give it a
+ // high weight to ensure it runs last.
$types['default'] = new StdClass();
$types['default']->name = 'default';
$types['default']->label = "Other";
$types['default']->base = TRUE;
- //@todo: I don't like this but we have to do something here.
- $view_mode_settings['default'] = $view_mode_defaults;
-
- // This should always run last because it is a fallback in case no other
- // types claim the media.
$types['default']->weight = 1000;
- // This is the default.
$types['default']->type_callback_args = array(
'match_type' => 'any',
'mimetypes' => array('/.*/'),
);
- // Add the common media types.
+ // Define the common media types: image, audio, and video.
$types['image'] = new StdClass();
$types['image']->name = 'image';
$types['image']->label = "Image";
$types['image']->base = TRUE;
- $view_mode_settings['image'] = $view_mode_defaults;
- $view_mode_settings['image']['media_preview'] = 'styles_file_square_thumbnail';
- $view_mode_settings['image']['media_large'] = 'styles_file_large';
- $view_mode_settings['image']['media_original'] = 'styles_file_original';
-
- $types['image']->type_callback_args =
- array(
+ $types['image']->type_callback_args = array(
'match_type' => 'all',
'mimetypes' => array('/^image/'),
'extensions' => array('jpg', 'jpeg', 'gif', 'png', 'tiff'),
@@ -102,42 +50,36 @@ function media_enable() {
$types['audio']->name = 'audio';
$types['audio']->label = "Audio";
$types['audio']->base = TRUE;
-
- // @todo: these are image specific, needs to change
- $view_mode_settings['audio'] = $view_mode_defaults;
$types['audio']->type_callback_args = array(
'match_type' => 'all',
'mimetypes' => array('/^audio/'),
'extensions' => array('mp3', 'ogg', 'wma'),
'streams' => array('public', 'private'),
);
-
+
$types['video'] = new StdClass();
$types['video']->name = 'video';
$types['video']->label = "Video";
$types['video']->base = TRUE;
-
- // @todo: these are image specific, needs to change
- $view_mode_settings['video'] = $view_mode_defaults;
- $view_mode_settings['video']['media_preview'] = 'styles_file_square_thumbnail';
- $view_mode_settings['video']['media_large'] = 'styles_file_large';
-
- // This is the default, otherwise could provide
- //$types['video']->type_callback = 'media_default_is_type';
- $types['video']->type_callback_args =
- array(
+ $types['video']->type_callback_args = array(
'match_type' => 'all',
'mimetypes' => array('/^video/'),
'extensions' => array('mov', 'mp4', 'avi'),
'streams' => array('public', 'private'),
);
+ // Create the defined types.
foreach ($types as $name => $type) {
media_type_save($type);
- media_type_configure_formatters($type->name, $view_mode_settings[$type->name]);
+
+ // @todo We hide the file display in the 'small' view mode for legacy
+ // reasons. Does it still make sense to do so?
+ $bundle_settings = field_bundle_settings('file', $name);
+ $bundle_settings['extra_fields']['display']['file']['media_small'] = array('weight' => 0, 'visible' => FALSE);
+ field_bundle_settings('file', $name, $bundle_settings);
}
-
- // Set permissions
+
+ // Set permissions.
$roles = user_roles();
foreach ($roles as $rid => $role) {
user_role_grant_permissions($rid, array('view media'));
@@ -158,18 +100,6 @@ function media_enable() {
}
/**
- * Define the database {file_managed}.type field.
- */
-function _media_type_field_spec() {
- return array(
- 'description' => 'Type of file for use in Media Bundles',
- 'type' => 'varchar',
- 'length' => 50,
- 'not null' => FALSE,
- );
-}
-
-/**
* Implement hook_schema().
*/
function media_schema() {
@@ -239,21 +169,9 @@ function media_field_schema($field) {
}
/**
- * Implement hook_schema_alter().
- */
-function media_schema_alter(&$schema) {
- // Alter {file_managed}.type.
- $schema['file_managed']['fields']['type'] = _media_type_field_spec();
-}
-
-/**
* Implement hook_uninstall().
*/
function media_uninstall() {
- /**
- * See comment above in media_install.
- */
- db_drop_field('file_managed', 'type');
foreach (media_variable_default() as $name => $value) {
media_variable_del($name);
}
@@ -396,6 +314,8 @@ function media_update_7006() {
* Changes the preview formatter for non-image types to the icon view.
*/
function media_update_7007() {
+ // @todo media_type_configure_formatters() is a deprecated function, so remove
+ // this code entirely?
drupal_load('module', 'media');
drupal_load('module', 'field');
@@ -420,6 +340,8 @@ function media_update_7008() {
* Changes the preview formatter for video types to a square thumbnail, like for images.
*/
function media_update_7009() {
+ // @todo media_type_configure_formatters() is a deprecated function, so remove
+ // this code entirely?
drupal_load('module', 'media');
drupal_load('module', 'field');
media_type_configure_formatters('video', array('media_preview' => 'styles_file_square_thumbnail'));
@@ -429,6 +351,8 @@ function media_update_7009() {
* Changes the large formatter for video types to the large file style.
*/
function media_update_7010() {
+ // @todo media_type_configure_formatters() is a deprecated function, so remove
+ // this code entirely?
// This formatter association was added to media_enable() at one point, but
// without a corresponding update function, so here's that update function.
drupal_load('module', 'media');
@@ -518,4 +442,121 @@ function media_update_7014() {
*/
function media_update_7015() {
registry_rebuild();
-}
\ No newline at end of file
+}
+
+/**
+ * Update Media entities to File entities.
+ */
+function media_update_7016() {
+ // Allow File Entity module to take over the {file_managed}.type field. It
+ // will create new indexes as it needs to, but it doesn't know about old ones,
+ // so delete them.
+ if (db_index_exists('file_managed', 'file_type')) {
+ db_drop_index('file_managed', 'file_type');
+ }
+ module_enable(array('file_entity'));
+
+ // Move all field instances from Media entity to File entity.
+ $instances = field_read_instances(array('entity_type' => 'media'), array('include_inactive' => TRUE, 'include_deleted' => TRUE));
+ foreach ($instances as $instance) {
+ // Skip the old self-referencing file field. It will be deleted later in
+ // this function.
+ if ($instance['field_name'] === 'file') {
+ continue;
+ }
+
+ $fields = field_read_fields(array('id' => $instance['field_id']), array('include_inactive' => TRUE, 'include_deleted' => TRUE));
+ $field = $fields[$instance['field_id']];
+
+ // There is no API for updating the entity_type foreign key within field
+ // data storage. We can do a direct db_update() for when the default SQL
+ // storage back-end is being used, but must skip updating fields that use a
+ // different storage type.
+ // @todo What else should be added here (e.g., logging and/or a message to
+ // the administrator)?
+ if ($field['storage']['type'] !== 'field_sql_storage' || !module_exists('field_sql_storage') || !$field['storage']['active']) {
+ continue;
+ }
+
+ // Update the data tables.
+ $table_name = _field_sql_storage_tablename($field);
+ $revision_name = _field_sql_storage_revision_tablename($field);
+ db_update($table_name)
+ ->fields(array('entity_type' => 'file'))
+ ->condition('entity_type', 'media')
+ ->condition('bundle', $instance['bundle'])
+ ->execute();
+ db_update($revision_name)
+ ->fields(array('entity_type' => 'file'))
+ ->condition('entity_type', 'media')
+ ->condition('bundle', $instance['bundle'])
+ ->execute();
+
+ // Once all the data has been updated, update the {field_config_instance}
+ // record.
+ db_update('field_config_instance')
+ ->fields(array('entity_type' => 'file'))
+ ->condition('id', $instance['id'])
+ ->execute();
+ }
+
+ // Update the field_bundle_settings configuration variable: move media bundle
+ // settings to file bundles, and move settings of the old self-referencing
+ // file field to the new file pseudo-field.
+ $settings = variable_get('field_bundle_settings', array());
+ if (!isset($settings['file'])) {
+ $settings['file'] = array();
+ }
+ if (isset($settings['media'])) {
+ $settings['file'] = array_merge($settings['file'], $settings['media']);
+ unset($settings['media']);
+ }
+ foreach ($instances as $instance) {
+ if ($instance['field_name'] === 'file' && !$instance['deleted']) {
+ if (isset($instance['widget']['weight'])) {
+ $settings['file'][$instance['bundle']]['extra_fields']['form']['file']['weight'] = $instance['widget']['weight'];
+ }
+ if (isset($instance['display'])) {
+ foreach ($instance['display'] as $view_mode => $display) {
+ if (isset($display['weight'])) {
+ $settings['file'][$instance['bundle']]['extra_fields']['display']['file'][$view_mode]['weight'] = $display['weight'];
+ }
+ if (isset($display['type'])) {
+ $settings['file'][$instance['bundle']]['extra_fields']['display']['file'][$view_mode]['visible'] = ($display['type'] != 'hidden');
+ }
+ }
+ }
+ }
+ }
+ variable_set('field_bundle_settings', $settings);
+
+ // Copy field formatter settings of old self-referencing file field to file
+ // pseudo-field formatter settings.
+ $file_displays = variable_get('file_displays', array());
+ foreach ($instances as $instance) {
+ if ($instance['field_name'] === 'file' && !$instance['deleted']) {
+ if (isset($instance['display'])) {
+ foreach ($instance['display'] as $view_mode => $display) {
+ if (isset($display['type']) && $display['type'] != 'hidden') {
+ $file_formatter = 'file_field_' . $display['type'];
+ $file_displays[$instance['bundle']][$view_mode][$file_formatter]['status'] = TRUE;
+ if (isset($display['settings'])) {
+ $file_displays[$instance['bundle']][$view_mode][$file_formatter]['settings'] = $display['settings'];
+ }
+ }
+ }
+ }
+ }
+ }
+ variable_set('file_displays', $file_displays);
+
+ // Delete the old self-referencing file field instances. If all instances are
+ // deleted, field_delete_instance() will delete the field too.
+ foreach ($instances as $instance) {
+ if ($instance['field_name'] === 'file' && !$instance['deleted']) {
+ field_delete_instance($instance);
+ }
+ }
+
+ field_cache_clear();
+}
diff --git a/media.module b/media.module
index ff1506c..f4715fb 100644
--- a/media.module
+++ b/media.module
@@ -16,13 +16,13 @@
// A registry of variable_get defaults.
require_once ( dirname(__FILE__) . '/includes/media.variables.inc');
-// Creating media types, entity definition
+// Define media related file types and how to display them.
require_once ( dirname(__FILE__) . '/includes/media.types.inc');
-// Code relating to using media as a field
+// Code relating to using media as a field.
require_once ( dirname(__FILE__) . '/includes/media.fields.inc');
- // Functions for working with [[inline tags]] and wysiwyg editors
+ // Functions for working with [[inline tags]] and wysiwyg editors.
require_once ( dirname(__FILE__) . '/includes/media.filter.inc');
/* ***************************************** */
@@ -54,6 +54,19 @@ function media_help($path,$arg) {
}
/**
+ * Implements hook_entity_info_alter().
+ *
+ * Add view modes to the file entity type, appropriate for displaying media.
+ */
+function media_entity_info_alter(&$entity_info) {
+ $entity_info['file']['view modes']['media_link'] = array('label' => t('Link'), 'custom settings' => TRUE);
+ $entity_info['file']['view modes']['media_preview'] = array('label' => t('Preview'), 'custom settings' => TRUE);
+ $entity_info['file']['view modes']['media_small'] = array('label' => t('Small'), 'custom settings' => TRUE);
+ $entity_info['file']['view modes']['media_large'] = array('label' => t('Large'), 'custom settings' => TRUE);
+ $entity_info['file']['view modes']['media_original'] = array('label' => t('Original'), 'custom settings' => TRUE);
+}
+
+/**
* Implement of hook_menu().
*/
function media_menu() {
@@ -75,32 +88,24 @@ function media_menu() {
'access arguments' => array('administer media'),
'file' => 'includes/media.admin.inc',
);
- // For managing different types of media and the fields associated with them.
- $items['admin/config/media/types'] = array(
- 'title' => 'Media Types',
- 'description' => 'Manage files used on your site.',
- 'page callback' => 'media_admin_type_list',
- 'access arguments' => array('administer media'),
- 'file' => 'includes/media.admin.inc',
- );
// Settings used for determining the type of media a file is.
- $items['admin/config/media/types/manage/%media_type'] = array(
- 'title' => 'Manage media',
- 'title callback' => 'media_type_page_title',
- 'title arguments' => array(5),
- 'description' => 'Manage files used on your site.',
- 'page callback' => 'drupal_get_form',
- 'page arguments' => array('media_admin_type_manage_form', 5),
- 'access arguments' => array('administer media'),
- 'file' => 'includes/media.admin.inc',
- );
-
- $items['admin/config/media/types/manage/%media_type/settings'] = array(
- 'title' => 'Settings',
- 'type' => MENU_DEFAULT_LOCAL_TASK,
- 'weight' => -1,
- );
+ // @todo Find a new home for this that integrates with the file_entity module.
+// $items['admin/config/media/types/manage/%media_type'] = array(
+// 'title' => 'Manage media',
+// 'title callback' => 'media_type_page_title',
+// 'title arguments' => array(5),
+// 'description' => 'Manage files used on your site.',
+// 'page callback' => 'drupal_get_form',
+// 'page arguments' => array('media_admin_type_manage_form', 5),
+// 'access arguments' => array('administer media'),
+// 'file' => 'includes/media.admin.inc',
+// );
+// $items['admin/config/media/types/manage/%media_type/settings'] = array(
+// 'title' => 'Settings',
+// 'type' => MENU_DEFAULT_LOCAL_TASK,
+// 'weight' => -1,
+// );
// Administrative screens for managing media.
$items['admin/content/media'] = array(
@@ -171,7 +176,7 @@ function media_menu() {
'file' => 'includes/media.browser.inc',
);
- $items['media/%media/format-form'] = array(
+ $items['media/%file/format-form'] = array(
'title' => 'Style selector',
'description' => 'Choose a format for a piece of media',
'page callback' => 'drupal_get_form',
@@ -182,21 +187,21 @@ function media_menu() {
'theme callback' => 'media_dialog_get_theme_name',
);
- $items['media/%media'] = array(
- 'page callback' => 'media_file_view',
+ $items['media/%file'] = array(
+ 'page callback' => 'media_view_page',
'page arguments' => array(1),
'access callback' => 'media_access',
'access arguments' => array('view'),
'file' => 'includes/media.pages.inc',
);
- $items['media/%media/view'] = array(
+ $items['media/%file/view'] = array(
'title' => 'View',
'type' => MENU_DEFAULT_LOCAL_TASK,
'weight' => -10,
);
- $items['media/%media/edit'] = array(
+ $items['media/%file/edit'] = array(
'title' => 'Edit',
'page callback' => 'media_page_edit',
'page arguments' => array(1),
@@ -222,7 +227,7 @@ function media_menu() {
'theme callback' => '_node_custom_theme',
);
- $items['media/%media/delete'] = array(
+ $items['media/%file/delete'] = array(
'title' => 'Delete',
'page callback' => 'media_page_delete',
'page arguments' => array(1),
@@ -341,7 +346,7 @@ function media_theme() {
),
'media_formatter_large_icon' => array(
- 'variables' => array('file' => NULL),
+ 'variables' => array('file' => NULL, 'attributes' => array()),
'file' => 'includes/media.theme.inc',
),
);
@@ -365,29 +370,16 @@ function media_image_default_styles() {
}
/**
- * Implement hook_file_insert().
- */
-function media_file_insert($file) {
- $file->type = media_get_type($file);
- drupal_write_record('file_managed', $file, array('fid'));
- media_save_attached_file($file);
-}
-
-/**
* Implement hook_file_update().
*/
function media_file_update($file) {
- $file->type = media_get_type($file);
- media_save_attached_file($file);
+ media_filter_invalidate_caches($file->fid);
}
/**
* Implements hook_file_delete().
*/
function media_file_delete($file) {
- // @todo: call field_attach_delete() from here, or add media_delete().
-
- // Remove this file from the {media_filter_usage} table.
db_delete('media_filter_usage')->condition('fid', $file->fid)->execute();
}
@@ -541,95 +533,18 @@ function media_forms($form_id, $args) {
/* ***************************************** */
/**
- * Loads a Media Asset
- *
- * @param string $fid
- * @return Media
- */
-function media_load($fid) {
- if ($files = entity_load('media', array($fid))) {
- return array_shift($files);
- }
- return FALSE;
-}
-
-/**
- * Loads multiple media Assets
+ * Load callback for %media_multi placeholder in menu paths.
*
* @param string $fids
- * Separated by plus(+) signs. e.g. 3+6+12+99
+ * Separated by space (e.g., "3 6 12 99"). This often appears as "+" within
+ * URLs (e.g., "3+6+12+99"), but Drupal automatically decodes paths when
+ * intializing $_GET['q'].
*
* @return array
- * An array of corresponding media entities.
+ * An array of corresponding file entities.
*/
function media_multi_load($fids) {
- $fids = explode(" ", $fids);
- if ($files = media_load_multiple($fids)) {
- return $files;
- }
-}
-
-/**
- * Load media entities from the database.
- *
- * @see entity_load()
- *
- * @param $fids
- * An array of media file IDs.
- * @param $conditions
- * An array of conditions on the {file_managed} table in the form
- * 'field' => $value.
- * @param $reset
- * Whether to reset the internal media_load cache.
- *
- * @return
- * An array of media objects indexed by fid.
- */
-function media_load_multiple($fids = array(), $conditions = array(), $reset = FALSE) {
- return entity_load('media', $fids, $conditions, $reset);
-}
-
-/**
- * Save a Media Asset
- *
- * @param $media
- * @return StdClass
- */
-function media_save($media) {
- field_attach_presave('media', $media);
- if ($media->fid) {
- $op = 'update';
- }
- else {
- $op = 'insert';
- }
- // Do something here for insert update
- if ($op == 'insert') {
- // should never happen I think, except perhaps on import.
- // @todo: validate bundle, etc
- field_attach_insert('media', $media);
- }
- else {
- field_attach_update('media', $media);
- media_filter_invalidate_caches($media->fid);
- }
-
- // Since the Media module can't make files into fieldable entities directly
- // without hacking Drupal core, it does so indirectly via a "media" entity
- // type. The indirection requires media entities to have one of its fields be
- // a file field containing the file that defines the media entity itself.
- // The File module treats this media entity / file field relationship like
- // any other entity / file field relationship, and increments the file usage
- // count whenever the media entity is saved, as part of the
- // field_attach_(insert|update)() execution above. However, we don't want the
- // media entity's reference to itself to count as usage, since that would
- // result in all media entities being "in use" and undeletable, so we remove
- // the self-referential usage record.
- if ($media->fid) {
- // file_usage_delete() requires the first argument to be an instance of
- // stdClass, but $media is an instance of some other class, so we cast it.
- file_usage_delete((object)(array) $media, 'file', 'media', $media->fid);
- }
+ return file_load_multiple(explode(" ", $fids));
}
/**
@@ -949,50 +864,6 @@ function media_parse_to_file($url) {
}
/**
- * When we save a file, we need to ensure any required media entity info is
- * saved as well.
- */
-function media_save_attached_file($file) {
- if ($file) {
- // This is terrible. Just awful.
- if ($file->status != FILE_STATUS_PERMANENT) {
- // We only want to manage files which are FILE_STATUS_PERMANENT
- return;
- }
- $defaults = array (
- 'display' => TRUE,
- );
-
- // Make a copy of the file object to use as the media object
- // (file is a field of media and the base table). This is weird.
- // The problem is, files get managed elsewhere, and when they move from
- // temporary to PERMANENT files, we want to create media entities for them.
- // Unfortunately, there is no hook for that, so on every insert / update
- // we have to look to see if the media entity has been setup
- // and if not, we have to create it.
- $media = media_load($file->fid);
- if (!$media->file) { //Then we haven't setup the media entity.
- $media->file = array();
- $media->file[LANGUAGE_NONE] = array();
- $media->file[LANGUAGE_NONE][0] = (array)$file + $defaults;
- $media->is_new = TRUE;
- field_attach_presave('media', $media);
- field_attach_update('media', $media);
- //field_attach_insert('media', $media);
- // @todo Why aren't we calling media_save() instead of the above code.
- // Since we aren't, we have to update usage here too, as we do in
- // media_save().
- file_usage_delete((object)(array) $media, 'file', 'media', $media->fid);
-
- // Also clear cached text formats from here.
- media_filter_invalidate_caches($media->fid);
- }
- }
- return $media;
-}
-
-
-/**
* Implements hook_element_info().
*/
function media_element_info() {
@@ -1024,10 +895,12 @@ function media_element_info() {
return $types;
}
+/**
+ * #process callback for the media form element.
+ */
function media_element_process(&$element, &$form_state, $form) {
$fid = isset($element['#value']['fid']) ? $element['#value']['fid'] : 0;
- //$fid = isset($element['#default_value']['fid']) ? $element['#default_value']['fid'] : 0;
- $media = media_load($fid);
+ $file = file_load($fid);
$path = drupal_get_path('module', 'media');
$element['title'] = array(
@@ -1040,8 +913,8 @@ function media_element_process(&$element, &$form_state, $form) {
//@TODO: This should be loaded from the JS in case of a failed form submission.
$markup = '';
- if (!empty($media)) {
- $preview = media_get_thumbnail_preview($media);
+ if (!empty($file)) {
+ $preview = media_get_thumbnail_preview($file);
$markup = drupal_render($preview);
}
$element['preview'] = array(
@@ -1072,11 +945,8 @@ function media_element_process(&$element, &$form_state, $form) {
// array_push($parents, 'more_fields');
//
// if ($file) {
-// $media_wo_file = $file;
-// $media_wo_file->file = array(); // heh, let's see how this works.
-// field_attach_prepare_view('media', array($file->fid => $media_wo_file));
-// entity_prepare_view('media', array($file->fid => $media_wo_file));
-// $element['more_fields_wrapper']['more_fields'] = field_attach_view('media', $media_wo_file, 'media_preview');
+// $element['more_fields_wrapper']['more_fields'] = file_view($file, 'media_preview');
+// unset($element['more_fields_wrapper']['more_fields']['file']);
// }
//@HACK: @todo: this is so I can find it in media.js without putting every field in a settings variable.
@@ -1175,13 +1045,13 @@ function _media_save_file_permenently(&$file) {
* Returns a renderable array with the necessary classes to support a media
* thumbnail. Also provides default fallback images if no image is available.
*
- * @param $media
+ * @param $file
*
* @return array
* Renderable array.
*/
-function media_get_thumbnail_preview($media, $link = NULL) {
- $preview = field_view_field('media', $media, 'file', 'media_preview');
+function media_get_thumbnail_preview($file, $link = NULL) {
+ $preview = file_view_file($file, 'media_preview');
$preview['#show_names'] = TRUE;
$preview['#add_link'] = $link;
$preview['#theme_wrappers'][] = 'media_thumbnail';
@@ -1189,46 +1059,6 @@ function media_get_thumbnail_preview($media, $link = NULL) {
}
/**
- * Implements hook_entity_info().
- */
-function media_entity_info() {
- $view_modes = media_field_view_modes('media');
- $return = array(
- 'media' => array(
- 'label' => t('Media'),
- 'base table' => 'file_managed',
- 'fieldable' => TRUE,
- 'view modes' => $view_modes,
- 'entity keys' => array(
- 'id' => 'fid',
- 'bundle' => 'type', // @TODO: Why 'type' here...
- ),
- 'bundle keys' => array(
- 'bundle' => 'name', // @TODO: But 'name' here?
- ),
- 'bundles' => array(),
- ),
- );
-
- $media_types = media_type_get_types();
-
- foreach ($media_types as $type => $bundle_info) {
- $return['media']['bundles'][$type] = (array)$bundle_info;
- $return['media']['bundles'][$type]['admin'] = array(
- 'label' => $bundle_info->label,
- 'path' => 'admin/config/media/types/manage/%media_type',
- 'real path' => 'admin/config/media/types/manage/' . $type,
- 'bundle argument' => 5,
- // @TODO: Add an 'administer media types' perm?
- 'access arguments' => array('administer site configuration'),
- );
- }
-
- // @TODO: Do we need to define search-related view modes for attached fields?
- return $return;
-}
-
-/**
* Check that the media is one of the selected types.
*
* @param $file
diff --git a/modules/media_youtube_test/media_youtube_test.info b/modules/media_youtube_test/media_youtube_test.info
new file mode 100644
index 0000000..c109386
--- /dev/null
+++ b/modules/media_youtube_test/media_youtube_test.info
@@ -0,0 +1,8 @@
+
+name = "Media YouTube Test"
+description = "Tests integration with the http://drupal.org/project/media_youtube module."
+package = Testing
+core = 7.x
+php = 5.2
+dependencies[] = media_youtube
+;hidden=TRUE
diff --git a/modules/media_youtube_test/media_youtube_test.install b/modules/media_youtube_test/media_youtube_test.install
new file mode 100644
index 0000000..4dece41
--- /dev/null
+++ b/modules/media_youtube_test/media_youtube_test.install
@@ -0,0 +1,35 @@
+ TRUE,
+ 'weight' => 10,
+ );
+ $file_displays['video'][$view_mode]['media_youtube_test_image'] = array(
+ 'status' => TRUE,
+ 'weight' => 11,
+ 'settings' => array('image_style' => ''),
+ );
+ }
+
+ // Within a Media preview, display a square thumbnail image.
+ $file_displays['video']['media_preview']['media_youtube_test_image'] = array(
+ 'status' => TRUE,
+ 'weight' => 10,
+ 'settings' => array('image_style' => 'square_thumbnail'),
+ );
+
+ variable_set('file_displays', $file_displays);
+}
diff --git a/modules/media_youtube_test/media_youtube_test.module b/modules/media_youtube_test/media_youtube_test.module
new file mode 100644
index 0000000..ed9b651
--- /dev/null
+++ b/modules/media_youtube_test/media_youtube_test.module
@@ -0,0 +1,95 @@
+ t('YouTube Video'),
+ 'default settings' => array('width' => '560', 'height' => '340'),
+ 'view callback' => 'media_youtube_test_file_formatter_media_youtube_test_video_view',
+ 'settings callback' => 'media_youtube_test_file_formatter_media_youtube_test_video_settings',
+ );
+ $formatters['media_youtube_test_image'] = array(
+ 'label' => t('YouTube Image'),
+ 'default settings' => array('image_style' => ''),
+ 'view callback' => 'media_youtube_test_file_formatter_media_youtube_test_image_view',
+ 'settings callback' => 'media_youtube_test_file_formatter_media_youtube_test_image_settings',
+ );
+ return $formatters;
+}
+
+
+/**
+ * Implements hook_file_formatter_FORMATTER_view().
+ */
+function media_youtube_test_file_formatter_media_youtube_test_video_view($file, $display, $langcode) {
+ $scheme = file_uri_scheme($file->uri);
+ // WYSIWYG does not yet support video inside a running editor instance.
+ if ($scheme == 'youtube' && empty($file->override['wysiwyg'])) {
+ $element = array(
+ '#theme' => 'media_youtube_video',
+ '#uri' => $file->uri,
+ '#width' => isset($file->override['width']) ? $file->override['width'] : $display['settings']['width'],
+ '#height' => isset($file->override['height']) ? $file->override['height'] : $display['settings']['height'],
+ );
+ return $element;
+ }
+}
+
+/**
+ * Implements hook_file_formatter_FORMATTER_settings().
+ */
+function media_youtube_test_file_formatter_media_youtube_test_video_settings($form, &$form_state, $settings) {
+ $element = array();
+ $element['width'] = array(
+ '#title' => t('Width'),
+ '#type' => 'textfield',
+ '#default_value' => $settings['width'],
+ );
+ $element['height'] = array(
+ '#title' => t('Height'),
+ '#type' => 'textfield',
+ '#default_value' => $settings['height'],
+ );
+ return $element;
+}
+
+/**
+ * Implements hook_file_formatter_FORMATTER_view().
+ */
+function media_youtube_test_file_formatter_media_youtube_test_image_view($file, $display, $langcode) {
+ $scheme = file_uri_scheme($file->uri);
+ if ($scheme == 'youtube') {
+ $wrapper = file_stream_wrapper_get_instance_by_uri($file->uri);
+ if (!empty($display['settings']['image_style'])) {
+ $element = array(
+ '#theme' => 'image_style',
+ '#style_name' => $display['settings']['image_style'],
+ '#path' => $wrapper->getLocalThumbnailPath(),
+ );
+ }
+ else {
+ $element = array(
+ '#theme' => 'image',
+ '#path' => $wrapper->getOriginalThumbnailPath(),
+ );
+ }
+ return $element;
+ }
+}
+
+/**
+ * Implements hook_file_formatter_FORMATTER_settings().
+ */
+function media_youtube_test_file_formatter_media_youtube_test_image_settings($form, &$form_state, $settings) {
+ $element = array();
+ $element['image_style'] = array(
+ '#title' => t('Image style'),
+ '#type' => 'select',
+ '#options' => image_style_options(FALSE),
+ '#default_value' => $settings['image_style'],
+ '#empty_option' => t('None (original image)'),
+ );
+ return $element;
+}