Project

General

Profile

Paste
Download (47.7 KB) Statistics
| Branch: | Revision:

root / drupal7 / sites / all / modules / media / media.module @ 1f623f01

1
<?php
2

    
3
/**
4
 * @file
5
 * Media API
6
 *
7
 * The core Media API.
8
 * See http://drupal.org/project/media for more details.
9
 */
10

    
11
// Code relating to using media as a field.
12
require_once dirname(__FILE__) . '/includes/media.fields.inc';
13

    
14
/**
15
 * Implements hook_hook_info().
16
 */
17
function media_hook_info() {
18
  $hooks = array(
19
    'media_parse',
20
    'media_browser_plugin_info',
21
    'media_browser_plugin_info_alter',
22
    'media_browser_plugins_alter',
23
    'media_browser_params_alter',
24
    'query_media_browser_alter',
25
  );
26

    
27
  return array_fill_keys($hooks, array('group' => 'media'));
28
}
29

    
30
/**
31
 * Implements hook_help().
32
 */
33
function media_help($path, $arg) {
34
  switch ($path) {
35
    case 'admin/help#media':
36
      $output = '';
37
      $output .= '<h3>' . t('About') . '</h3>';
38
      $output .= '<p>' . t('The Media module is a File Browser to the Internet, media provides a framework for managing files and multimedia assets, regardless of whether they are hosted on your own site or a 3rd party site. It replaces the Drupal core upload field with a unified User Interface where editors and administrators can upload, manage, and reuse files and multimedia assets. Media module also provides rich integration with WYSIWYG module to let content creators access media assets in rich text editor. Javascript is required to use the Media module.  For more information check <a href="@media_faq">Media Module page</a>', array('@media_faq' => 'http://drupal.org/project/media')) . '.</p>';
39
      $output .= '<h3>' . t('Uses') . '</h3>';
40
      $output .= '<dl>';
41
      $output .= '<dt>' . t('Media Repository') . '</dt>';
42
      $output .= '<dd>' . t('Media module allows you to maintain a <a href="@mediarepo">media asset repository</a> where in you can add, remove, reuse your media assets. You can add the media file using upload form or from a url and also do bulk operations on the media assets.', array('@mediarepo' => url('admin/content/media'))) . '</dd>';
43
      $output .= '<dt>' . t('Attaching media assets to content types') . '</dt>';
44
      $output .= '<dd>' . t('Media assets can be attached to content types as fields. To add a media field to a <a href="@content-type">content type</a>, go to the content type\'s <em>manage fields</em> page, and add a new field of type <em>Multimedia Asset</em>.', array('@content-type' => url('admin/structure/types'))) . '</dd>';
45
      $output .= '<dt>' . t('Using media assets in WYSIWYG') . '</dt>';
46
      $output .= '<dd>' . t('Media module provides rich integration with WYSIWYG editors, using Media Browser plugin you can select media asset from library to add to the rich text editor moreover you can add media asset from the media browser itself using either upload method or add from url method. To configure media with WYSIWYG you need two steps of configuration:');
47
      $output .= '<ul><li>' . t('Enable WYSIWYG plugin on your desired <a href="@wysiwyg-profile">WYSIWYG profile</a>. Please note that you will need to have <a href="@wysiwyg">WYSIWYG</a> module enabled.', array('@wysiwyg-profile' => url('admin/config/content/wysiwyg'), '@wysiwyg' => 'http://drupal.org/project/wysiwyg')) . '</li>';
48
      $output .= '<li>' . t('Enable the <em>Convert Media tags to markup</em> filter on the <a href="@input-format">Input format</a> you are using with the WYSIWYG profile.', array('@input-format' => url('admin/config/content/formats'))) . '</li></ul></dd>';
49
      return $output;
50
  }
51
}
52

    
53
/**
54
 * Implements hook_entity_info_alter().
55
 */
56
function media_entity_info_alter(&$entity_info) {
57
  // For sites that updated from Media 1.x, continue to provide these deprecated
58
  // view modes.
59
  // @see http://drupal.org/node/1051090
60
  if (variable_get('media_show_deprecated_view_modes', FALSE)) {
61
    $entity_info['file']['view modes']['media_link'] = array(
62
      'label' => t('Link'),
63
      'custom settings' => TRUE,
64
    );
65
    $entity_info['file']['view modes']['media_original'] = array(
66
      'label' => t('Original'),
67
      'custom settings' => TRUE,
68
    );
69
  }
70
  if (module_exists('entity_translation')) {
71
    $entity_info['file']['translation']['entity_translation']['class'] = 'MediaEntityTranslationHandler';
72
    $entity_info['file']['translation']['entity_translation']['path schemes']['media'] = array('edit path' => 'media/%file/edit/%ctools_js');
73
  }
74
}
75

    
76
/**
77
 * Implements hook_menu().
78
 */
79
function media_menu() {
80
  // For managing different types of media and the fields associated with them.
81
  $items['admin/config/media/browser'] = array(
82
    'title' => 'Media browser settings',
83
    'description' => 'Configure the behavior and display of the media browser.',
84
    'page callback' => 'drupal_get_form',
85
    'page arguments' => array('media_admin_config_browser'),
86
    'access arguments' => array('administer media browser'),
87
    'file' => 'includes/media.admin.inc',
88
  );
89

    
90
  // Administrative screens for managing media.
91
  $items['admin/content/file/thumbnails'] = array(
92
    'title' => 'Thumbnails',
93
    'description' => 'Manage files used on your site.',
94
    'page callback' => 'drupal_get_form',
95
    'page arguments' => array('file_entity_admin_file'),
96
    'access arguments' => array('administer files'),
97
    'type' => MENU_LOCAL_TASK,
98
    'file' => 'file_entity.admin.inc',
99
    'file path' => drupal_get_path('module', 'file_entity'),
100
    'weight' => 10,
101
  );
102

    
103
  $items['media/ajax'] = array(
104
    'page callback' => 'media_ajax_upload',
105
    'delivery callback' => 'ajax_deliver',
106
    'access arguments' => array('access content'),
107
    'theme callback' => 'ajax_base_page_theme',
108
    'type' => MENU_CALLBACK,
109
  );
110

    
111
  $items['media/browser'] = array(
112
    'title' => 'Media browser',
113
    'description' => 'Media Browser for picking media and uploading new media',
114
    'page callback' => 'media_browser',
115
    'access arguments' => array('access media browser'),
116
    'type' => MENU_CALLBACK,
117
    'file' => 'includes/media.browser.inc',
118
    'theme callback' => 'media_dialog_get_theme_name',
119
  );
120

    
121
  // A testbed to try out the media browser with different launch commands.
122
  $items['media/browser/testbed'] = array(
123
    'title' => 'Media Browser test',
124
    'description' => 'Make it easier to test media browser',
125
    'page callback' => 'drupal_get_form',
126
    'page arguments' => array('media_browser_testbed'),
127
    'access arguments' => array('administer files'),
128
    'type' => MENU_CALLBACK,
129
    'file' => 'includes/media.browser.inc',
130
  );
131

    
132
  // We could re-use the file/%file/edit path for the modal callback, but
133
  // it is just easier to use our own namespace here.
134
  $items['media/%file/edit/%ctools_js'] = array(
135
    'title' => 'Edit',
136
    'page callback' => 'drupal_get_form',
137
    'page arguments' => array('media_file_edit_modal', 1, 3),
138
    'access callback' => 'file_entity_access',
139
    'access arguments' => array('update', 1),
140
    'theme callback' => 'ajax_base_page_theme',
141
    'file' => 'includes/media.pages.inc',
142
    'type' => MENU_CALLBACK,
143
  );
144

    
145
  return $items;
146
}
147

    
148
/**
149
 * Implements hook_menu_local_tasks_alter().
150
 */
151
function media_menu_local_tasks_alter(&$data, $router_item, $root_path) {
152
  // Add action link to 'file/add' on 'admin/content/file/thumbnails' page.
153
  if ($root_path == 'admin/content/file/thumbnails') {
154
    $item = menu_get_item('file/add');
155
    if (!empty($item['access'])) {
156
      $data['actions']['output'][] = array(
157
        '#theme' => 'menu_local_action',
158
        '#link' => $item,
159
        '#weight' => $item['weight'],
160
      );
161
    }
162
  }
163
}
164

    
165
/**
166
 * Implements hook_admin_paths().
167
 */
168
function media_admin_paths() {
169
  $paths['media/*/edit/*'] = TRUE;
170
  $paths['media/*/format-form'] = TRUE;
171

    
172
  // If the media browser theme is set to the admin theme, ensure it gets set
173
  // as an admin path as well.
174
  $dialog_theme = variable_get('media_dialog_theme', '');
175
  if (empty($dialog_theme) || $dialog_theme == variable_get('admin_theme')) {
176
    $paths['media/browser'] = TRUE;
177
    $paths['media/browser/*'] = TRUE;
178
  }
179

    
180
  return $paths;
181
}
182

    
183
/**
184
 * Implements hook_permission().
185
 */
186
function media_permission() {
187
  return array(
188
    'administer media browser' => array(
189
      'title' => t('Administer media browser'),
190
      'description' => t('Access media browser settings.'),
191
    ),
192
    'access media browser' => array(
193
      'title' => t('Use the media browser'),
194
    ),
195
  );
196
}
197

    
198
/**
199
 * Implements hook_theme().
200
 */
201
function media_theme() {
202
  return array(
203
    // media.module.
204
    'media_element' => array(
205
      'render element' => 'element',
206
    ),
207

    
208
    // media.field.inc.
209
    'media_widget' => array(
210
      'render element' => 'element',
211
    ),
212
    'media_widget_multiple' => array(
213
      'render element' => 'element',
214
    ),
215
    'media_upload_help' => array(
216
      'variables' => array('description' => NULL),
217
    ),
218

    
219
    // media.theme.inc.
220
    'media_thumbnail' => array(
221
      'render element' => 'element',
222
      'file' => 'includes/media.theme.inc',
223
    ),
224
    'media_formatter_large_icon' => array(
225
      'variables' => array('file' => NULL, 'attributes' => array(), 'style_name' => 'media_thumbnail'),
226
      'file' => 'includes/media.theme.inc',
227
    ),
228
    'media_dialog_page' => array(
229
      'render element' => 'page',
230
      'template' => 'templates/media-dialog-page',
231
      'file' => 'includes/media.theme.inc',
232
    ),
233
  );
234
}
235

    
236
/**
237
 * Menu callback; Shared Ajax callback for media attachment and deletions.
238
 *
239
 * This rebuilds the form element for a particular field item. As long as the
240
 * form processing is properly encapsulated in the widget element the form
241
 * should rebuild correctly using FAPI without the need for additional callbacks
242
 * or processing.
243
 */
244
function media_ajax_upload() {
245
  $form_parents = func_get_args();
246
  $form_build_id = (string) array_pop($form_parents);
247

    
248
  if (empty($_POST['form_build_id']) || $form_build_id != $_POST['form_build_id']) {
249
    // Invalid request.
250
    drupal_set_message(t('An unrecoverable error occurred. The uploaded file likely exceeded the maximum file size (@size) that this server supports.', array('@size' => format_size(file_upload_max_size()))), 'error');
251
    $commands = array();
252
    $commands[] = ajax_command_replace(NULL, theme('status_messages'));
253
    return array('#type' => 'ajax', '#commands' => $commands);
254
  }
255

    
256
  list($form, $form_state, $form_id, $form_build_id, $commands) = ajax_get_form();
257

    
258
  if (!$form) {
259
    // Invalid form_build_id.
260
    drupal_set_message(t('An unrecoverable error occurred. Use of this form has expired. Try reloading the page and submitting again.'), 'error');
261
    $commands = array();
262
    $commands[] = ajax_command_replace(NULL, theme('status_messages'));
263
    return array('#type' => 'ajax', '#commands' => $commands);
264
  }
265

    
266
  // Get the current element and count the number of files.
267
  $current_element = $form;
268
  foreach ($form_parents as $parent) {
269
    $current_element = $current_element[$parent];
270
  }
271
  $current_file_count = isset($current_element['#file_upload_delta']) ? $current_element['#file_upload_delta'] : 0;
272

    
273
  // Process user input. $form and $form_state are modified in the process.
274
  drupal_process_form($form['#form_id'], $form, $form_state);
275

    
276
  // Retrieve the element to be rendered.
277
  foreach ($form_parents as $parent) {
278
    $form = $form[$parent];
279
  }
280

    
281
  // Add the special Ajax class if a new file was added.
282
  if (isset($form['#file_upload_delta']) && $current_file_count < $form['#file_upload_delta']) {
283
    $form[$current_file_count]['#attributes']['class'][] = 'ajax-new-content';
284
  }
285
  // Otherwise just add the new content class on a placeholder.
286
  else {
287
    $form['#suffix'] .= '<span class="ajax-new-content"></span>';
288
  }
289

    
290
  $output = theme('status_messages') . drupal_render($form);
291
  $js = drupal_add_js();
292
  $settings = call_user_func_array('array_merge_recursive', $js['settings']['data']);
293

    
294
  $commands[] = ajax_command_replace(NULL, $output, $settings);
295
  return array('#type' => 'ajax', '#commands' => $commands);
296
}
297

    
298
/**
299
 * Implements hook_image_default_styles().
300
 */
301
function media_image_default_styles() {
302
  $styles = array();
303
  $styles['media_thumbnail'] = array(
304
    'label' => 'Media thumbnail (100x100)',
305
    'effects' => array(
306
      array(
307
        'name' => 'image_scale_and_crop',
308
        'data' => array('width' => 100, 'height' => 100),
309
        'weight' => 0,
310
      ),
311
    ),
312
  );
313
  return $styles;
314
}
315

    
316
/**
317
 * Implements hook_page_alter().
318
 *
319
 * This is used to use our alternate template when ?render=media-popup is passed
320
 * in the URL.
321
 */
322
function media_page_alter(&$page) {
323
  if (isset($_GET['render']) && $_GET['render'] == 'media-popup') {
324
    $page['#theme'] = 'media_dialog_page';
325

    
326
    // Disable administration modules from adding output to the popup.
327
    // @see http://drupal.org/node/914786
328
    module_invoke_all('suppress', TRUE);
329

    
330
    foreach (element_children($page) as $key) {
331
      if ($key != 'content') {
332
        unset($page[$key]);
333
      }
334
    }
335
  }
336
}
337

    
338
/**
339
 * Implements hook_form_FIELD_UI_FIELD_EDIT_FORM_alter().
340
 *
341
 * @todo: Respect field settings in 7.x-2.x and handle them in the media widget
342
 * UI.
343
 */
344
function media_form_field_ui_field_edit_form_alter(&$form, &$form_state) {
345
  // On file fields that use the media widget we need remove specific fields.
346
  if ($form['#field']['type'] == 'file' && $form['instance']['widget']['type']['#value'] == 'media_generic') {
347
    $form['instance']['settings']['file_extensions']['#title'] = t('Allowed file extensions for uploaded files');
348
    $form['instance']['settings']['file_extensions']['#maxlength'] = 255;
349
  }
350

    
351
  // On image fields using the media widget we remove the alt/title fields.
352
  if ($form['#field']['type'] == 'image' && $form['instance']['widget']['type']['#value'] == 'media_generic') {
353
    $form['instance']['settings']['alt_field']['#access'] = FALSE;
354
    $form['instance']['settings']['title_field']['#access'] = FALSE;
355
    $form['instance']['settings']['file_extensions']['#title'] = t('Allowed file extensions for uploaded files');
356
    // Do not increase maxlength of file extensions for image fields, since
357
    // presumably they will not need a long list of extensions.
358
  }
359

    
360
  // Add a validation function to any field instance which uses the media widget
361
  // to ensure that the upload destination scheme is one of the allowed schemes
362
  // if any defined by settings.
363
  if ($form['instance']['widget']['type']['#value'] == 'media_generic' && isset($form['#field']['settings']['uri_scheme'])) {
364
    $form['#validate'][] = 'media_field_instance_validate';
365
  }
366

    
367
  if ($form['#instance']['entity_type'] == 'file') {
368
    $form['instance']['settings']['wysiwyg_override'] = array(
369
      '#type' => 'checkbox',
370
      '#title' => t('Override in WYSIWYG'),
371
      '#description' => t('If checked, then this field may be overridden in the WYSIWYG editor.'),
372
      '#default_value' => isset($form['#instance']['settings']['wysiwyg_override']) ? $form['#instance']['settings']['wysiwyg_override'] : TRUE,
373
    );
374
  }
375
}
376

    
377
/**
378
 * Validation handler; ensure that the upload destination scheme is one of the
379
 * allowed schemes.
380
 */
381
function media_field_instance_validate($form, &$form_state) {
382
  $allowed_schemes = array_filter($form_state['values']['instance']['widget']['settings']['allowed_schemes']);
383
  $upload_destination = $form_state['values']['field']['settings']['uri_scheme'];
384

    
385
  if (!empty($allowed_schemes) && !in_array($upload_destination, $allowed_schemes)) {
386
    form_set_error('allowed_schemes', t('The upload destination must be one of the allowed schemes.'));
387
  }
388
}
389

    
390
/**
391
 * Implements hook_form_alter().
392
 */
393
function media_form_alter(&$form, &$form_state, $form_id) {
394
  // If we're in the media browser, set the #media_browser key to true
395
  // so that if an ajax request gets sent to a different path, the form
396
  // still uses the media_browser_form_submit callback.
397
  if (current_path() == 'media/browser') {
398
    if ($form_id == 'views_exposed_form') {
399
      $form['render'] = array('#type' => 'hidden', '#value' => 'media-popup');
400
      $form['#action'] = '/media/browser';
401
    } else {
402
      $form_state['#media_browser'] = TRUE;
403
    }
404
  }
405

    
406
  // If the #media_browser key isset and is true we are using the browser
407
  // popup, so add the media_browser submit handler.
408
  if (!empty($form_state['#media_browser'])) {
409
    $form['#submit'][] = 'media_browser_form_submit';
410
  }
411
}
412

    
413
/**
414
 * Submit handler; direction form submissions in the media browser.
415
 */
416
function media_browser_form_submit($form, &$form_state) {
417
  $url = NULL;
418
  $parameters = array();
419

    
420
  // Single upload.
421
  if (!empty($form_state['file'])) {
422
    $file = $form_state['file'];
423
    $url = 'media/browser';
424
    $parameters = array('query' => array('render' => 'media-popup', 'fid' => $file->fid));
425
  }
426

    
427
  // If $url is set, we had some sort of upload, so redirect the form.
428
  if (!empty($url)) {
429
    $form_state['redirect'] = array($url, $parameters);
430
  }
431
}
432

    
433
/**
434
 * Implements hook_library().
435
 */
436
function media_library() {
437
  $path = drupal_get_path('module', 'media');
438
  $info = system_get_info('module', 'media');
439

    
440
  $common = array(
441
    'website' => 'http://drupal.org/project/media',
442
    'version' => !empty($info['version']) ? $info['version'] : '7.x-2.x',
443
  );
444

    
445
  // Contains libraries common to other media modules.
446
  $libraries['media_base'] = array(
447
    'title' => 'Media base',
448
    'js' => array(
449
      $path . '/js/media.core.js' => array('group' => JS_LIBRARY, 'weight' => -5),
450
      $path . '/js/util/json2.js' => array('group' => JS_LIBRARY),
451
      $path . '/js/util/ba-debug.min.js' => array('group' => JS_LIBRARY),
452
    ),
453
    'css' => array(
454
      $path . '/css/media.css',
455
    ),
456
  );
457

    
458
  // Includes resources needed to launch the media browser.  Should be included
459
  // on pages where the media browser needs to be launched from.
460
  $libraries['media_browser'] = array(
461
    'title' => 'Media Browser popup libraries',
462
    'js' => array(
463
      $path . '/js/media.popups.js' => array('group' => JS_DEFAULT),
464
    ),
465
    'dependencies' => array(
466
      array('system', 'ui.resizable'),
467
      array('system', 'ui.draggable'),
468
      array('system', 'ui.dialog'),
469
      array('media', 'media_base'),
470
    ),
471
  );
472

    
473
  // Resources needed in the media browser itself.
474
  $libraries['media_browser_page'] = array(
475
    'title' => 'Media browser',
476
    'js' => array(
477
      $path . '/js/media.browser.js'  => array('group' => JS_DEFAULT),
478
    ),
479
    'dependencies' => array(
480
      array('system', 'ui.tabs'),
481
      array('system', 'ui.draggable'),
482
      array('system', 'ui.dialog'),
483
      array('media', 'media_base'),
484
    ),
485
  );
486

    
487
  // Settings for the dialog etc.
488
  $settings = array(
489
    'browserUrl' => url('media/browser', array(
490
      'query' => array(
491
        'render' => 'media-popup'
492
      ))
493
    ),
494
    'styleSelectorUrl' => url('media/-media_id-/format-form', array(
495
      'query' => array(
496
        'render' => 'media-popup'
497
      ))
498
    ),
499
    'dialogOptions' => array(
500
      'dialogclass' => variable_get('media_dialogclass', 'media-wrapper'),
501
      'modal' => (boolean)variable_get('media_modal', TRUE),
502
      'draggable' => (boolean)variable_get('media_draggable', FALSE),
503
      'resizable' => (boolean)variable_get('media_resizable', FALSE),
504
      'minwidth' => (int)variable_get('media_minwidth', 500),
505
      'width' => (int)variable_get('media_width', 670),
506
      'height' => (int)variable_get('media_height', 280),
507
      'position' => variable_get('media_position', 'center'),
508
      'overlay' => array(
509
        'backgroundcolor' => variable_get('media_backgroundcolor', '#000000'),
510
        'opacity' => (float)variable_get('media_opacity', 0.4),
511
      ),
512
      'zindex' => (int)variable_get('media_zindex', 10000),
513
    ),
514
  );
515

    
516
  $libraries['media_browser_settings'] = array(
517
    'title' => 'Media browser settings',
518
    'js' => array(
519
      0 => array(
520
        'data' => array(
521
          'media' => $settings,
522
        ),
523
        'type' => 'setting',
524
      ),
525
    ),
526
  );
527

    
528
  foreach ($libraries as &$library) {
529
    $library += $common;
530
  }
531
  return $libraries;
532
}
533

    
534
/**
535
 * Theme callback used to identify when we are in a popup dialog.
536
 *
537
 * Generally the default theme will look terrible in the media browser. This
538
 * will default to the administration theme, unless set otherwise.
539
 */
540
function media_dialog_get_theme_name() {
541
  return variable_get('media_dialog_theme', variable_get('admin_theme'));
542
}
543

    
544
/**
545
 * This will parse a url or embedded code into a unique URI.
546
 *
547
 * The function will call all modules implementing hook_media_parse($url),
548
 * which should return either a string containing a parsed URI or NULL.
549
 *
550
 * @NOTE The implementing modules may throw an error, which will not be caught
551
 * here; it's up to the calling function to catch any thrown errors.
552
 *
553
 * @NOTE In emfield, we originally also accepted an array of regex patterns
554
 * to match against. However, that module used a registration for providers,
555
 * and simply stored the match in the database keyed to the provider object.
556
 * However, other than the stream wrappers, there is currently no formal
557
 * registration for media handling. Additionally, few, if any, stream wrappers
558
 * will choose to store a straight match from the parsed URL directly into
559
 * the URI. Thus, we leave both the matching and the final URI result to the
560
 * implementing module in this implementation.
561
 *
562
 * An alternative might be to do the regex pattern matching here, and pass a
563
 * successful match back to the implementing module. However, that would
564
 * require either an overloaded function or a new hook, which seems like more
565
 * overhead than it's worth at this point.
566
 *
567
 * @TODO Once hook_module_implements_alter() is in core (see the issue at
568
 * http://drupal.org/node/692950) we may want to implement media_media_parse()
569
 * to ensure we were passed a valid URL, rather than an unsupported or
570
 * malformed embed code that wasn't caught earlier. It will needed to be
571
 * weighted so it's called after all other streams have a go, as the fallback,
572
 * and will need to throw an error.
573
 *
574
 * @param string $url
575
 *   The original URL or embed code to parse.
576
 *
577
 * @return string
578
 *   The unique URI for the file, based on its stream wrapper, or NULL.
579
 *
580
 * @see media_parse_to_file()
581
 * @see media_add_from_url_validate()
582
 */
583
function media_parse_to_uri($url) {
584
  // Trim any whitespace before parsing.
585
  $url = trim($url);
586
  foreach (module_implements('media_parse') as $module) {
587
    $success = module_invoke($module, 'media_parse', $url);
588
    $context = array(
589
      'url' => $url,
590
      'module' => $module,
591
    );
592
    drupal_alter('media_parse', $success, $context);
593
    if (isset($success)) {
594
      return $success;
595
    }
596
  }
597
}
598

    
599
/**
600
 * Parse a URL or embed code and return a file object.
601
 *
602
 * If a remote stream doesn't claim the parsed URL in media_parse_to_uri(),
603
 * then we'll copy the file locally.
604
 *
605
 * @NOTE The implementing modules may throw an error, which will not be caught
606
 * here; it's up to the calling function to catch any thrown errors.
607
 *
608
 * @see media_parse_to_uri()
609
 * @see media_add_from_url_submit()
610
 */
611
function media_parse_to_file($url) {
612
  try {
613
    $uri = media_parse_to_uri($url);
614
  }
615
  catch (Exception $e) {
616
    // Pass the error along.
617
    throw $e;
618
    return;
619
  }
620

    
621
  if (isset($uri)) {
622
    // Attempt to load an existing file from the unique URI.
623
    $select = db_select('file_managed', 'f')
624
    ->extend('PagerDefault')
625
    ->fields('f', array('fid'))
626
    ->condition('uri', $uri);
627

    
628
    $fid = $select->execute()->fetchCol();
629
    if (!empty($fid)) {
630
      $file = file_load(array_pop($fid));
631
      return $file;
632
    }
633
  }
634

    
635
  if (isset($uri)) {
636
    // The URL was successfully parsed to a URI, but does not yet have an
637
    // associated file: save it!
638
    $file = file_uri_to_object($uri);
639
    file_save($file);
640
  }
641
  else {
642
    // The URL wasn't parsed. We'll try to save a remote file.
643
    // Copy to temporary first.
644
    $source_uri = file_stream_wrapper_uri_normalize('temporary://' . basename($url));
645
    if (!@copy(@$url, $source_uri)) {
646
      throw new Exception('Unable to add file ' . $url);
647
      return;
648
    }
649
    $source_file = file_uri_to_object($source_uri);
650
    $scheme = variable_get('file_default_scheme', 'public') . '://';
651
    $uri = file_stream_wrapper_uri_normalize($scheme . $source_file->filename);
652
    // Now to its new home.
653
    $file = file_move($source_file, $uri, FILE_EXISTS_RENAME);
654
  }
655

    
656
  return $file;
657
}
658

    
659
/**
660
 * Utility function to recursively run check_plain on an array.
661
 *
662
 * @todo There is probably something in core I am not aware of that does this.
663
 */
664
function media_recursive_check_plain(&$value, $key) {
665
  $value = check_plain($value);
666
}
667

    
668
/**
669
 * Implements hook_element_info().
670
 */
671
function media_element_info() {
672
  $types['media'] = array(
673
    '#input' => TRUE,
674
    '#process' => array('media_element_process'),
675
    '#value_callback' => 'media_file_value',
676
    '#element_validate' => array('media_element_validate'),
677
    '#pre_render' => array('media_element_pre_render'),
678
    '#theme' => 'media_element',
679
    '#theme_wrappers' => array('form_element'),
680
    '#size' => 22,
681
    '#extended' => FALSE,
682
    '#media_options' => array(
683
      'global' => array(
684
        // Example: array('image', 'audio');
685
        'types' => array(),
686
        // Example: array('http', 'ftp', 'flickr');
687
        'schemes' => array(),
688
      ),
689
    ),
690
    '#attached' => array(
691
      'library' => array(
692
        array('media', 'media_browser'),
693
      ),
694
    ),
695
  );
696

    
697
  $setting = array();
698
  $setting['media']['global'] = $types['media']['#media_options'];
699

    
700
  $types['media']['#attached']['js'][] = array(
701
    'type' => 'setting',
702
    'data' => $setting,
703
  );
704

    
705
  return $types;
706
}
707

    
708
/**
709
 * Process callback for the media form element.
710
 */
711
function media_element_process($element, &$form_state, $form) {
712
  ctools_include('modal');
713
  ctools_include('ajax');
714
  ctools_modal_add_js();
715

    
716
  // Append the '-upload' to the #id so the field label's 'for' attribute
717
  // corresponds with the textfield element.
718
  $original_id = $element['#id'];
719
  $element['#id'] .= '-upload';
720
  $fid = isset($element['#value']['fid']) ? $element['#value']['fid'] : 0;
721

    
722
  // Set some default element properties.
723
  $element['#file'] = $fid ? file_load($fid) : FALSE;
724
  $element['#tree'] = TRUE;
725

    
726
  $ajax_settings = array(
727
    'path' => 'media/ajax/' . implode('/', $element['#array_parents']) . '/' . $form['form_build_id']['#value'],
728
    'wrapper' => $original_id . '-ajax-wrapper',
729
    'effect' => 'fade',
730
  );
731

    
732
  // Set up the buttons first since we need to check if they were clicked.
733
  $element['attach_button'] = array(
734
    '#name' => implode('_', $element['#parents']) . '_attach_button',
735
    '#type' => 'submit',
736
    '#value' => t('Attach'),
737
    '#validate' => array(),
738
    '#submit' => array('media_file_submit'),
739
    '#limit_validation_errors' => array($element['#parents']),
740
    '#ajax' => $ajax_settings,
741
    '#attributes' => array('class' => array('attach')),
742
    '#weight' => -1,
743
  );
744

    
745
  $element['preview'] = array(
746
    'content' => array(),
747
    '#prefix' => '<div class="preview">',
748
    '#suffix' => '</div>',
749
    '#ajax' => $ajax_settings,
750
    '#weight' => -10,
751
  );
752

    
753
  // Substitute the JS preview for a true file thumbnail once the file is
754
  // attached.
755
  if ($fid && $element['#file']) {
756
    $element['preview']['content'] = media_get_thumbnail_preview($element['#file']);
757
  }
758

    
759
  // The file ID field itself.
760
  $element['upload'] = array(
761
    '#name' => 'media[' . implode('_', $element['#parents']) . ']',
762
    '#type' => 'textfield',
763
    '#title' => t('Enter the ID of an existing file'),
764
    '#title_display' => 'invisible',
765
    '#field_prefix' => t('File ID'),
766
    '#size' => $element['#size'],
767
    '#theme_wrappers' => array(),
768
    '#attributes' => array('class' => array('upload')),
769
    '#weight' => -9,
770
  );
771

    
772
  $element['browse_button'] = array(
773
    '#type' => 'link',
774
    '#href' => '',
775
    '#title' => t('Browse'),
776
    '#attributes' => array('class' => array('button', 'browse', 'element-hidden')),
777
    '#options' => array('fragment' => FALSE, 'external' => TRUE),
778
    '#weight' => -8,
779
  );
780

    
781
  // Force the progress indicator for the remove button to be either 'none' or
782
  // 'throbber', even if the upload button is using something else.
783
  $ajax_settings['progress']['type'] = 'throbber';
784
  $ajax_settings['progress']['message'] = NULL;
785
  $ajax_settings['effect'] = 'none';
786
  $element['edit'] = array(
787
    '#type' => 'link',
788
    '#href' => 'media/' . $fid . '/edit/nojs',
789
    '#title' => t('Edit'),
790
    '#attributes' => array(
791
      'class' => array(
792
        // Required for CTools modal to work.
793
        'ctools-use-modal',
794
        'ctools-modal-media-file-edit', 'button', 'edit',
795
      ),
796
    ),
797
    '#weight' => 20,
798
    '#access' => $element['#file'] ? file_entity_access('update', $element['#file']) : FALSE,
799
  );
800
  $element['remove_button'] = array(
801
    '#name' => implode('_', $element['#parents']) . '_remove_button',
802
    '#type' => 'submit',
803
    '#value' => t('Remove'),
804
    '#validate' => array(),
805
    '#submit' => array('media_file_submit'),
806
    '#limit_validation_errors' => array($element['#parents']),
807
    '#ajax' => $ajax_settings,
808
    '#attributes' => array('class' => array('remove')),
809
    '#weight' => 0,
810
  );
811

    
812
  $element['fid'] = array(
813
    '#type' => 'hidden',
814
    '#value' => $fid,
815
    '#attributes' => array('class' => array('fid')),
816
  );
817

    
818
  // Media browser attach code.
819
  $element['#attached']['js'][] = drupal_get_path('module', 'media') . '/js/media.js';
820

    
821
  // Add the media options to the page as JavaScript settings.
822
  $element['browse_button']['#attached']['js'] = array(
823
    array(
824
      'type' => 'setting',
825
      'data' => array('media' => array('elements' => array('#' . $element['#id'] => $element['#media_options'])))
826
    )
827
  );
828

    
829
  $element['#attached']['library'][] = array('media', 'media_browser');
830
  $element['#attached']['library'][] = array('media', 'media_browser_settings');
831

    
832
  // Prefix and suffix used for Ajax replacement.
833
  $element['#prefix'] = '<div id="' . $original_id . '-ajax-wrapper">';
834
  $element['#suffix'] = '</div>';
835

    
836
  return $element;
837
}
838

    
839
/**
840
 * Implements hook_form_FORM_ID_alter().
841
 */
842
function media_form_file_entity_edit_alter(&$form, &$form_state) {
843
  // Make adjustments to the file edit form when used in a CTools modal.
844
  if (!empty($form_state['ajax'])) {
845
    // Remove the preview and the delete button.
846
    $form['preview']['#access'] = FALSE;
847
    $form['actions']['delete']['#access'] = FALSE;
848

    
849
    // Convert the cancel link to a button which triggers a modal close.
850
    $form['actions']['cancel']['#attributes']['class'][] = 'button';
851
    $form['actions']['cancel']['#attributes']['class'][] = 'button-no';
852
    $form['actions']['cancel']['#attributes']['class'][] = 'ctools-close-modal';
853
  }
854
}
855

    
856
/**
857
 * The #value_callback for a media type element.
858
 */
859
function media_file_value(&$element, $input = FALSE, $form_state = NULL) {
860
  $fid = 0;
861

    
862
  // Find the current value of this field from the form state.
863
  $form_state_fid = $form_state['values'];
864
  foreach ($element['#parents'] as $parent) {
865
    $form_state_fid = isset($form_state_fid[$parent]) ? $form_state_fid[$parent] : 0;
866
  }
867

    
868
  if ($element['#extended'] && isset($form_state_fid['fid'])) {
869
    $fid = $form_state_fid['fid'];
870
  }
871
  elseif (is_numeric($form_state_fid)) {
872
    $fid = $form_state_fid;
873
  }
874

    
875
  // Process any input and attach files.
876
  if ($input !== FALSE) {
877
    $return = $input;
878

    
879
    // Attachments take priority over all other values.
880
    if ($file = media_attach_file($element)) {
881
      $fid = $file->fid;
882
    }
883
    else {
884
      // Check for #filefield_value_callback values.
885
      // Because FAPI does not allow multiple #value_callback values like it
886
      // does for #element_validate and #process, this fills the missing
887
      // functionality to allow File fields to be extended through FAPI.
888
      if (isset($element['#file_value_callbacks'])) {
889
        foreach ($element['#file_value_callbacks'] as $callback) {
890
          $callback($element, $input, $form_state);
891
        }
892
      }
893
      // Load file if the FID has changed to confirm it exists.
894
      if (isset($input['fid']) && $file = file_load($input['fid'])) {
895
        $fid = $file->fid;
896
      }
897
    }
898
  }
899

    
900
  // If there is no input, set the default value.
901
  else {
902
    if ($element['#extended']) {
903
      $default_fid = isset($element['#default_value']['fid']) ? $element['#default_value']['fid'] : 0;
904
      $return = isset($element['#default_value']) ? $element['#default_value'] : array('fid' => 0);
905
    }
906
    else {
907
      $default_fid = isset($element['#default_value']) ? $element['#default_value'] : 0;
908
      $return = array('fid' => 0);
909
    }
910

    
911
    // Confirm that the file exists when used as a default value.
912
    if ($default_fid && $file = file_load($default_fid)) {
913
      $fid = $file->fid;
914
    }
915
  }
916

    
917
  $return['fid'] = $fid;
918

    
919
  return $return;
920
}
921

    
922
/**
923
 * Validate media form elements.
924
 *
925
 * The file type is validated during the upload process, but this is necessary
926
 * necessary in order to respect the #required property.
927
 */
928
function media_element_validate(&$element, &$form_state) {
929
  $clicked_button = end($form_state['triggering_element']['#parents']);
930

    
931
  // Check required property based on the FID.
932
  if ($element['#required'] && empty($element['fid']['#value']) && !in_array($clicked_button, array('attach_button', 'remove_button'))) {
933
    form_error($element['browse_button'], t('!name field is required.', array('!name' => $element['#title'])));
934
  }
935

    
936
  // Consolidate the array value of this field to a single FID.
937
  if (!$element['#extended']) {
938
    form_set_value($element, $element['fid']['#value'], $form_state);
939
  }
940
}
941

    
942
/**
943
 * Form submission handler for attach / remove buttons of media elements.
944
 *
945
 * @see media_element_process()
946
 */
947
function media_file_submit($form, &$form_state) {
948
  // Determine whether it was the attach or remove button that was clicked, and
949
  // set $element to the managed_file element that contains that button.
950
  $parents = $form_state['triggering_element']['#array_parents'];
951
  $button_key = array_pop($parents);
952
  $element = drupal_array_get_nested_value($form, $parents);
953

    
954
  // No action is needed here for the attach button, because all media
955
  // attachments on the form are processed by media_file_value() regardless of
956
  // which button was clicked. Action is needed here for the remove button,
957
  // because we only remove a file in response to its remove button being
958
  // clicked.
959
  if ($button_key == 'remove_button') {
960
    // If it's a temporary file we can safely remove it immediately, otherwise
961
    // it's up to the implementing module to clean up files that are in use.
962
    if ($element['#file'] && $element['#file']->status == 0) {
963
      file_delete($element['#file']);
964
    }
965
    // Update both $form_state['values'] and $form_state['input'] to reflect
966
    // that the file has been removed, so that the form is rebuilt correctly.
967
    // $form_state['values'] must be updated in case additional submit handlers
968
    // run, and for form building functions that run during the rebuild, such as
969
    // when the media element is part of a field widget.
970
    // $form_state['input'] must be updated so that media_file_value() has
971
    // correct information during the rebuild.
972
    $values_element = $element['#extended'] ? $element['fid'] : $element;
973
    form_set_value($values_element, NULL, $form_state);
974
    drupal_array_set_nested_value($form_state['input'], $values_element['#parents'], NULL);
975
  }
976

    
977
  // Set the form to rebuild so that $form is correctly updated in response to
978
  // processing the file removal. Since this function did not change $form_state
979
  // if the upload button was clicked, a rebuild isn't necessary in that
980
  // situation and setting $form_state['redirect'] to FALSE would suffice.
981
  // However, we choose to always rebuild, to keep the form processing workflow
982
  // consistent between the two buttons.
983
  $form_state['rebuild'] = TRUE;
984
}
985

    
986
/**
987
 * Attaches any files that have been referenced by a media element.
988
 *
989
 * @param $element
990
 *   The FAPI element whose files are being attached.
991
 *
992
 * @return
993
 *   The file object representing the file that was attached, or FALSE if no
994
 *   file was attached.
995
 */
996
function media_attach_file($element) {
997
  $upload_name = implode('_', $element['#parents']);
998
  if (empty($_POST['media'][$upload_name])) {
999
    return FALSE;
1000
  }
1001

    
1002
  if (!$file = file_load($_POST['media'][$upload_name])) {
1003
    watchdog('file', 'The file upload failed. %upload', array('%upload' => $upload_name));
1004
    form_set_error($upload_name, t('The file in the !name field was unable to be uploaded.', array('!name' => $element['#title'])));
1005
    return FALSE;
1006
  }
1007

    
1008
  return $file;
1009
}
1010

    
1011
/**
1012
 * Returns HTML for a managed file element.
1013
 *
1014
 * @param $variables
1015
 *   An associative array containing:
1016
 *   - element: A render element representing the file.
1017
 *
1018
 * @ingroup themeable
1019
 */
1020
function theme_media_element($variables) {
1021
  $element = $variables['element'];
1022

    
1023
  $attributes = array();
1024
  if (isset($element['#id'])) {
1025
    $attributes['id'] = $element['#id'];
1026
  }
1027
  if (!empty($element['#attributes']['class'])) {
1028
    $attributes['class'] = (array) $element['#attributes']['class'];
1029
  }
1030
  $attributes['class'][] = 'form-media';
1031

    
1032
  // This wrapper is required to apply JS behaviors and CSS styling.
1033
  $output = '';
1034
  $output .= '<div' . drupal_attributes($attributes) . '>';
1035
  $output .= drupal_render_children($element);
1036
  $output .= '</div>';
1037
  return $output;
1038
}
1039

    
1040
/**
1041
 * #pre_render callback to hide display of the browse/attach or remove controls.
1042
 *
1043
 * Browse/attach controls are hidden when a file is already attached.
1044
 * Remove controls are hidden when there is no file attached. Controls are
1045
 * hidden here instead of in media_element_process(), because #access for these
1046
 * buttons depends on the media element's #value. See the documentation of
1047
 * form_builder() for more detailed information about the relationship between
1048
 * #process, #value, and #access.
1049
 *
1050
 * Because #access is set here, it affects display only and does not prevent
1051
 * JavaScript or other untrusted code from submitting the form as though access
1052
 * were enabled. The form processing functions for these elements should not
1053
 * assume that the buttons can't be "clicked" just because they are not
1054
 * displayed.
1055
 *
1056
 * @see media_element_process()
1057
 * @see form_builder()
1058
 */
1059
function media_element_pre_render($element) {
1060
  // If we already have a file, we don't want to show the browse and attach
1061
  // controls.
1062
  if (!empty($element['#value']['fid'])) {
1063
    $element['upload']['#access'] = FALSE;
1064
    $element['browse_button']['#access'] = FALSE;
1065
    $element['attach_button']['#access'] = FALSE;
1066
  }
1067
  // If we don't already have a file, there is nothing to remove.
1068
  else {
1069
    $element['remove_button']['#access'] = FALSE;
1070
  }
1071
  return $element;
1072
}
1073

    
1074
/**
1075
 * Generates a thumbnail preview of a file.
1076
 *
1077
 * Provides default fallback images if an image of the file cannot be generated.
1078
 *
1079
 * @param object $file
1080
 *   A Drupal file object.
1081
 * @param boolean $link
1082
 *   (optional) Boolean indicating whether the thumbnail should be linked to the
1083
 *   file. Defaults to FALSE.
1084
 * @param string $view_mode
1085
 *   (optional) The view mode to use when rendering the thumbnail. Defaults to
1086
 *   'preview'.
1087
 *
1088
 * @return array
1089
 *   Renderable array suitable for drupal_render() with the necessary classes
1090
 *   and CSS to support a media thumbnail.
1091
 */
1092
function media_get_thumbnail_preview($file, $link = FALSE, $view_mode = 'preview') {
1093
  // If a file has an invalid type, allow file_view_file() to work.
1094
  if (!file_type_is_enabled($file->type)) {
1095
    $file->type = file_get_type($file);
1096
  }
1097

    
1098
  $preview = file_view_file($file, $view_mode);
1099
  $preview['#show_names'] = TRUE;
1100
  $preview['#add_link'] = $link;
1101
  $preview['#theme_wrappers'][] = 'media_thumbnail';
1102
  $preview['#attached']['css'][] = drupal_get_path('module', 'media') . '/css/media.css';
1103

    
1104
  return $preview;
1105
}
1106

    
1107
/**
1108
 * Check that the media is one of the selected types.
1109
 *
1110
 * @param object $file
1111
 *   A Drupal file object.
1112
 * @param array $types
1113
 *   An array of media type names
1114
 *
1115
 * @return array
1116
 *   If the file type is not allowed, it will contain an error message.
1117
 *
1118
 * @see hook_file_validate()
1119
 */
1120
function media_file_validate_types($file, $types) {
1121
  $errors = array();
1122
  if (!in_array(file_get_type($file), $types)) {
1123
    $errors[] = t('Only the following types of files are allowed to be uploaded: %types-allowed', array('%types-allowed' => implode(', ', $types)));
1124
  }
1125

    
1126
  return $errors;
1127
}
1128

    
1129
/**
1130
 * Implements hook_file_displays_alter().
1131
 */
1132
function media_file_displays_alter(&$displays, $file, $view_mode) {
1133
  if ($view_mode == 'preview' && empty($displays)) {
1134
    // We re in the media browser and this file has no formatters enabled.
1135
    // Instead of letting it go through theme_file_link(), pass it through
1136
    // theme_media_formatter_large_icon() to get our cool file icon instead.
1137
    $displays['file_field_media_large_icon'] = array(
1138
      'weight' => 0,
1139
      'status' => 1,
1140
      'settings' => NULL,
1141
    );
1142
  }
1143

    
1144
  // Override the fields of the file when requested by the WYSIWYG.
1145
  if (isset($file->override) && isset($file->override['fields'])) {
1146
    $instance = field_info_instances('file', $file->type);
1147
    foreach ($file->override['fields'] as $field_name => $value) {
1148
      if (!isset($instance[$field_name]['settings']) || !isset($instance[$field_name]['settings']['wysiwyg_override']) || $instance[$field_name]['settings']['wysiwyg_override']) {
1149
        $file->{$field_name} = $value;}
1150
    }
1151
  }
1152

    
1153
  // Alt and title are special.
1154
  // @see file_entity_file_load
1155
  $alt = variable_get('file_entity_alt', '[file:field_file_image_alt_text]');
1156
  $title = variable_get('file_entity_title', '[file:field_file_image_title_text]');
1157

    
1158
  $replace_options = array(
1159
    'clear' => TRUE,
1160
    'sanitize' => FALSE,
1161
  );
1162

    
1163
  // Load alt and title text from fields.
1164
  if (!empty($alt)) {
1165
    $file->alt = decode_entities(token_replace($alt, array('file' => $file), $replace_options));
1166
  }
1167
  if (!empty($title)) {
1168
    $file->title = decode_entities(token_replace($title, array('file' => $file), $replace_options));
1169
  }
1170
}
1171

    
1172
/**
1173
 * For sanity in grammar.
1174
 *
1175
 * @see media_set_browser_params()
1176
 */
1177
function media_get_browser_params() {
1178
  return media_set_browser_params();
1179
}
1180

    
1181
/**
1182
 * Provides a singleton of the params passed to the media browser.
1183
 *
1184
 * This is useful in situations like form alters because callers can pass
1185
 * id="wysiywg_form" or whatever they want, and a form alter could pick this up.
1186
 * We may want to change the hook_media_browser_plugin_view() implementations to
1187
 * use this function instead of being passed params for consistency.
1188
 *
1189
 * It also offers a chance for some meddler to meddle with them.
1190
 *
1191
 * @see media_browser()
1192
 */
1193
function media_set_browser_params() {
1194
  $params = &drupal_static(__FUNCTION__, array());
1195

    
1196
  if (empty($params)) {
1197
    // Build out browser settings. Permissions- and security-related behaviors
1198
    // should not rely on these parameters, since they come from the HTTP query.
1199
    // @TODO make sure we treat parameters as user input.
1200
    $params = drupal_get_query_parameters() + array(
1201
        'types' => array(),
1202
        'multiselect' => FALSE,
1203
      );
1204

    
1205
    // Transform text 'true' and 'false' to actual booleans.
1206
    foreach ($params as $k => $v) {
1207
      if ($v === 'true') {
1208
        $params[$k] = TRUE;
1209
      }
1210
      elseif ($v === 'false') {
1211
        $params[$k] = FALSE;
1212
      }
1213
    }
1214

    
1215
    array_walk_recursive($params, 'media_recursive_check_plain');
1216

    
1217
    // Allow modules to alter the parameters.
1218
    drupal_alter('media_browser_params', $params);
1219
  }
1220

    
1221
  return $params;
1222
}
1223

    
1224
/**
1225
 * Implements hook_ctools_plugin_api().
1226
 *
1227
 * Lets CTools know which plugin APIs are implemented by Media module.
1228
 */
1229
function media_ctools_plugin_api($module, $api) {
1230
  if ($module == 'file_entity' && $api == 'file_default_displays') {
1231
    return array(
1232
      'version' => 1,
1233
    );
1234
  }
1235
}
1236

    
1237
/**
1238
 * Implements hook_form_FORM_ID_alter().
1239
 *
1240
 * This alter enhances the default admin/content/file page, addding JS and CSS.
1241
 * It also makes modifications to the thumbnail view by replacing the existing
1242
 * checkboxes and table with thumbnails.
1243
 */
1244
function media_form_file_entity_admin_file_alter(&$form, $form_state) {
1245
  if (!empty($form_state['values']['operation'])) {
1246
    // The form is being rebuilt because an operation requiring confirmation
1247
    // We don't want to be messing with it in this case.
1248
    return;
1249
  }
1250

    
1251
  // Add the "Add file" local action, and notify users if they have files
1252
  // selected and they try to switch between the "Thumbnail" and "List" local
1253
  // tasks.
1254
  $path = drupal_get_path('module', 'media');
1255
  $form['#attributes']['class'][] = 'file-entity-admin-file-form';
1256
  $form['#attached']['js'][] = $path . '/js/media.admin.js';
1257
  $form['#attached']['css'][] = $path . '/css/media.css';
1258

    
1259
  // By default, this form contains a table select element called "files". For
1260
  // the 'thumbnails' tab, Media generates a thumbnail for each file and
1261
  // replaces the tableselect with a grid of thumbnails.
1262
  if (arg(3) == 'thumbnails') {
1263
    if (empty($form['admin']['files']['#options'])) {
1264
      // Display empty text if there are no files.
1265
      $form['admin']['files'] = array(
1266
        '#markup' => '<p>' . $form['admin']['files']['#empty'] . '</p>',
1267
      );
1268
    }
1269
    else {
1270
      $files = file_load_multiple(array_keys($form['admin']['files']['#options']));
1271

    
1272
      $form['admin']['files'] = array(
1273
        '#tree' => TRUE,
1274
        '#prefix' => '<div class="media-display-thumbnails media-clear clearfix"><ul id="media-browser-library-list" class="media-list-thumbnails">',
1275
        '#suffix' => '</ul></div>',
1276
      );
1277

    
1278
      foreach ($files as $file) {
1279
        $preview = media_get_thumbnail_preview($file, TRUE);
1280
        $form['admin']['files'][$file->fid] = array(
1281
          '#type' => 'checkbox',
1282
          '#title' => '',
1283
          '#prefix' => '<li>' . drupal_render($preview),
1284
          '#suffix' => '</li>',
1285
        );
1286
      }
1287
    }
1288
  }
1289
}
1290

    
1291
/**
1292
 * Implements hook_views_api().
1293
 */
1294
function media_views_api() {
1295
  return array(
1296
    'api' => 3,
1297
    'path' => drupal_get_path('module', 'media'),
1298
  );
1299
}
1300

    
1301
/**
1302
 * Implements hook_views_default_views().
1303
 */
1304
function media_views_default_views() {
1305
  return media_load_all_exports('media', 'views', 'view.inc', 'view');
1306
}
1307

    
1308
/**
1309
 * Fetches an array of exportables from files.
1310
 *
1311
 * @param string $module
1312
 *   The module invoking this request. (Can be called by other modules.)
1313
 * @param string $directory
1314
 *   The subdirectory in the custom module.
1315
 * @param string $extension
1316
 *   The file extension.
1317
 * @param string $name
1318
 *   The name of the variable found in each file. Defaults to the same as
1319
 *   $extension.
1320
 *
1321
 * @return array
1322
 *   Array of $name objects.
1323
 */
1324
function media_load_all_exports($module, $directory, $extension, $name = NULL) {
1325
  if (!$name) {
1326
    $name = $extension;
1327
  }
1328

    
1329
  $return = array();
1330
  // Find all the files in the directory with the correct extension.
1331
  $files = file_scan_directory(drupal_get_path('module', $module) . "/$directory", "/.$extension/");
1332
  foreach ($files as $path => $file) {
1333
    require $path;
1334
    if (isset($$name)) {
1335
      $return[$$name->name] = $$name;
1336
    }
1337
  }
1338

    
1339
  return $return;
1340
}
1341

    
1342
/**
1343
 * Returns metadata describing Media browser plugins.
1344
 *
1345
 * @return
1346
 *   An associative array of plugin information, keyed by plugin.
1347
 *
1348
 * @see hook_media_browser_plugin_info()
1349
 * @see hook_media_browser_plugin_info_alter()
1350
 */
1351
function media_get_browser_plugin_info() {
1352
  $info = &drupal_static(__FUNCTION__);
1353

    
1354
  if (!isset($info)) {
1355
    $info = module_invoke_all('media_browser_plugin_info');
1356
    drupal_alter('media_browser_plugin_info', $info);
1357
  }
1358

    
1359
  return $info;
1360
}
1361

    
1362
/**
1363
 * Gets the MIME type mapped to a given extension.
1364
 *
1365
 * @param string $extension
1366
 *   A file extension.
1367
 *
1368
 * @return string
1369
 *   The MIME type associated with the extension or FALSE if the extension does
1370
 *   not have an associated MIME type.
1371
 *
1372
 * @see file_mimetype_mapping()
1373
 */
1374
function media_get_extension_mimetype($extension) {
1375
  include_once DRUPAL_ROOT . '/includes/file.mimetypes.inc';
1376
  $mimetype_mappings = file_mimetype_mapping();
1377

    
1378
  if (isset($mimetype_mappings['extensions'][$extension])) {
1379
    $id = $mimetype_mappings['extensions'][$extension];
1380
    return $mimetype_mappings['mimetypes'][$id];
1381
  }
1382
  else {
1383
    return FALSE;
1384
  }
1385
}
1386

    
1387
/**
1388
 * Helper function to get a list of local stream wrappers.
1389
 */
1390
function media_get_local_stream_wrappers() {
1391
  return file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL_NORMAL);
1392
}
1393

    
1394
/**
1395
 * Helper function to get a list of remote stream wrappers.
1396
 */
1397
function media_get_remote_stream_wrappers() {
1398
  $wrappers = file_get_stream_wrappers();
1399
  $wrappers = array_diff_key($wrappers, file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL_NORMAL));
1400
  $wrappers = array_diff_key($wrappers, file_get_stream_wrappers(STREAM_WRAPPERS_LOCAL_HIDDEN));
1401
  return $wrappers;
1402
}