media_wysiwyg.module 27.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16
<?php

/**
 * @file
 * Primarily Drupal hooks.
 */

// Functions for tracking the file usage of [[inline tags]].
require_once dirname(__FILE__) . '/includes/media_wysiwyg.file_usage.inc';

// Functions for working with [[inline tags]] and wysiwyg editors.
require_once dirname(__FILE__) . '/includes/media_wysiwyg.filter.inc';

// Functions for UUID support to embedded media.
require_once dirname(__FILE__) . '/includes/media_wysiwyg.uuid.inc';

17 18 19
// Functions for features integration.
require_once dirname(__FILE__) . '/includes/media_wysiwyg.features.inc';

20 21 22 23 24 25 26 27 28 29 30 31 32 33
/**
 * Implements hook_page_build().
 */
function media_wysiwyg_page_build(&$page) {
  // We need to load some minor CSS if media alignment is enabled.
  if (variable_get('media_wysiwyg_alignment', FALSE)) {
    $page['page_bottom']['media_wysiwyg']['#attached']['css'] = array(
      drupal_get_path('module', 'media_wysiwyg') . '/css/media_wysiwyg.base.css' => array(
        'every_page' => TRUE,
      ),
    );
  }
}

34 35 36 37 38
/**
 * Implements hook_hook_info().
 */
function media_wysiwyg_hook_info() {
  $hooks = array(
39
    'media_wysiwyg_allowed_attributes_alter',
40 41 42 43 44 45 46 47 48 49 50 51
    'media_wysiwyg_token_to_markup_alter',
    'media_wysiwyg_allowed_view_modes_alter',
    'media_wysiwyg_format_form_prepare_alter',
  );

  return array_fill_keys($hooks, array('group' => 'media_wysiwyg'));
}

/**
 * Implements hook_menu().
 */
function media_wysiwyg_menu() {
52 53
  $items = array();

54 55 56 57 58
  $items['media/%file/format-form'] = array(
    'title' => 'Style selector',
    'description' => 'Choose a format for a piece of media',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('media_wysiwyg_format_form', 1),
59
    'access callback' => 'media_wysiwyg_access',
60
    'access arguments' => array('view', 1),
61
    'file' => 'includes/media_wysiwyg.pages.inc',
62 63 64 65 66 67 68
    'theme callback' => 'media_dialog_get_theme_name',
    'type' => MENU_CALLBACK,
  );

  return $items;
}

69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89
/**
 * Implements hook_permission().
 */
function media_wysiwyg_permission() {
  return array(
    'use media wysiwyg' => array(
      'title' => t('Use Media WYSIWYG in an editor'),
      // Marked restrict because the WYSIWYG forms generate image derivatives,
      // which could lead to a DoS security vulnerability.
      'restrict access' => TRUE,
    ),
  );
}

/**
 * Access callback for WYSIWYG Media.
 */
function media_wysiwyg_access($op, $file = NULL, $account = NULL) {
  return user_access('use media wysiwyg', $account) && file_entity_access($op, $file, $account);
}

90 91 92 93 94 95 96
/**
 * Implements hook_element_info_alter().
 */
function media_wysiwyg_element_info_alter(&$types) {
  $types['text_format']['#pre_render'][] = 'media_wysiwyg_pre_render_text_format';
}

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115
/**
 * Builds a map of media tags in the element.
 *
 * Builds a map of the media tags in an element that are being rendered to their
 * rendered HTML. The map is stored in JS, so we can transform them when the
 * editor is being displayed.
 */
function media_wysiwyg_pre_render_text_format($element) {
  // filter_process_format() copies properties to the expanded 'value' child
  // element.
  if (!isset($element['format'])) {
    return $element;
  }

  $field = &$element['value'];
  $settings = array(
    'field' => $field['#id'],
  );

116
  if (!isset($field['#value']) && $field['#value'] != '') {
117 118 119
    return $element;
  }

120
  $tagmap = array();
121

122
  foreach (array('value', 'summary') as $column) {
123
    if (isset($element[$column]['#value'])) {
124 125 126 127 128
      $tagmap += _media_wysiwyg_generate_tagMap($element[$column]['#value']);
    }
  }

  if (!empty($tagmap)) {
129 130 131 132 133 134 135 136 137
    $element['#attached']['js'][] = array(
      'data' => array(
        'tagmap' => $tagmap,
      ),
      'type' => 'setting',
    );
  }

  // Load the media browser library.
138 139
  $element['#attached']['library'][] = array('media', 'media_browser');
  $element['#attached']['library'][] = array('media', 'media_browser_settings');
140 141

  // Add wysiwyg-specific settings.
142
  $settings = array(
143
    'wysiwyg_allowed_attributes' => media_wysiwyg_allowed_attributes(),
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161
    'img_alt_field' => 'field_file_image_alt_text',
    'img_title_field' => 'field_file_image_title_text',
  );

  // The file_entity module lets you specify a string, possibly with tokens, for
  // the alt and title attributes of images. We need the actual field names instead.
  // If the variable only contains a token of the format [file:field_file_image_alt_text]
  // then it's possible to extract it.
  $alt_token = variable_get('file_entity_alt', '[file:field_file_image_alt_text]');
  $title_token = variable_get('file_entity_title', '[file:field_file_image_title_text]');
  $matches = array();
  if (preg_match('/^\[file:(field_[[:alnum:]_-]+)\]$/', trim($alt_token), $matches)) {
    $settings['img_alt_field'] = $matches[1];
  }
  if (preg_match('/^\[file:(field_[[:alnum:]_-]+)\]$/', trim($title_token), $matches)) {
    $settings['img_title_field'] = $matches[1];
  }

162 163 164
  $element['#attached']['js'][] = array(
    'data' => array(
      'media' => $settings,
165
      'mediaDoLinkText' => (boolean) variable_get('media_wysiwyg_use_link_text_for_filename', 1),
166 167 168 169 170 171 172 173 174 175
    ),
    'type' => 'setting',
  );

  // Add filter handling.
  $element['#attached']['js'][] = drupal_get_path('module', 'media_wysiwyg') . '/js/media_wysiwyg.filter.js';

  return $element;
}

176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
/**
 * Implements hook_form_FORM_ID_alter().
 */
function media_wysiwyg_form_field_ui_field_edit_form_alter(&$form, &$form_state) {
  // Add a checkbox that marks this field as one that can be
  // overridden in the WYSIWYG.
  if ($form['#instance']['entity_type'] == 'file') {
    $field_type = $form['#field']['type'];
    $allowed_field_types = variable_get('media_wysiwyg_wysiwyg_override_field_types', array('text', 'text_long'));
    if (in_array($field_type, $allowed_field_types)) {
      $form['instance']['settings']['wysiwyg_override'] = array(
        '#type' => 'checkbox',
        '#title' => t('Override in WYSIWYG'),
        '#description' => t('If checked, then this field may be overridden in the WYSIWYG editor.'),
        '#default_value' => isset($form['#instance']['settings']['wysiwyg_override']) ? $form['#instance']['settings']['wysiwyg_override'] : FALSE,
      );
    }
  }
}

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233
/**
 * Implements hook_form_FORM_ID_alter().
 */
function media_wysiwyg_form_wysiwyg_profile_form_alter(&$form, &$form_state) {
  // Add warnings if the media filter is disabled for the WYSIWYG's text format.
  $form['buttons']['drupal']['media']['#element_validate'][] = 'media_wysiwyg_wysiwyg_button_element_validate';
  $form['buttons']['drupal']['media']['#after_build'][] = 'media_wysiwyg_wysiwyg_button_element_validate';
  form_load_include($form_state, 'inc', 'media_wysiwyg', 'wysiwyg_plugins/media');
}

/**
 * Element validate callback for the media WYSIWYG button.
 */
function media_wysiwyg_wysiwyg_button_element_validate($element, &$form_state) {
  if (!empty($element['#value'])) {
    $format = filter_format_load($form_state['build_info']['args'][0]->format);
    $filters = filter_list_format($format->format);
    if (empty($filters['media_filter']->status)) {
      form_error($element, t('The <em>Convert Media tags to markup</em> filter must be enabled for the <a href="@format-link">@format format</a> in order to use the Media browser WYSIWYG button.', array(
        '@format-link' => url('admin/config/content/formats/' . $format->format, array('query' => array('destination' => $_GET['q']))),
        '@format' => $format->name,
      )));
    }
  }

  return $element;
}

/**
 * Implements hook_form_FORM_ID_alter().
 */
function media_wysiwyg_form_media_admin_config_browser_alter(&$form, &$form_state) {
  $form['wysiwyg'] = array(
    '#type' => 'fieldset',
    '#title' => t('WYSIWYG configuration'),
    '#collapsible' => TRUE,
    '#collapsed' => FALSE,
  );
234
  $form['wysiwyg']['media_wysiwyg_wysiwyg_browser_plugins'] = array(
235 236 237 238
    '#type' => 'checkboxes',
    '#title' => t('Enabled browser plugins'),
    '#options' => array(),
    '#required' => FALSE,
239
    '#default_value' => variable_get('media_wysiwyg_wysiwyg_browser_plugins', array()),
240 241 242 243 244 245
    '#description' => t('If no plugins are selected, they will all be available.'),
  );

  $plugins = media_get_browser_plugin_info();

  foreach ($plugins as $key => $plugin) {
246
    $form['wysiwyg']['media_wysiwyg_wysiwyg_browser_plugins']['#options'][$key] = !empty($plugin['title']) ? $plugin['title'] : $key;
247 248
  }

249
  $form['wysiwyg']['media_wysiwyg_wysiwyg_upload_directory'] = array(
250 251
    '#type' => 'textfield',
    '#title' => t("File directory for uploaded media"),
252
    '#default_value' => variable_get('media_wysiwyg_wysiwyg_upload_directory', ''),
253 254 255 256
    '#description' => t('Optional subdirectory within the upload destination where files will be stored. Do not include preceding or trailing slashes.'),
  );

  if (module_exists('token')) {
257
    $form['wysiwyg']['media_wysiwyg_wysiwyg_upload_directory']['#description'] .= t('This field supports tokens.');
258 259 260 261 262 263
    $form['wysiwyg']['tokens'] = array(
      '#theme' => 'token_tree',
      '#dialog' => TRUE,
    );
  }

264 265 266 267 268 269 270 271 272 273 274
  $form['wysiwyg']['media_wysiwyg_default_render'] = array(
    '#type' => 'radios',
    '#title' => t('How should file entities be rendered within a text field?'),
    '#description' => t("Full file entity rendering is the best choice for most sites. It respects the file entity's display settings specified at admin/structure/file-types. If your site already uses the legacy method, note that changing this option will affect your site's markup. Testing it on a non-production site is recommended."),
    '#options' => array(
      'file_entity' => 'Full file entity rendering',
      'field_attach' => 'Legacy rendering (using field attach)',
    ),
    '#default_value' => variable_get('media_wysiwyg_default_render', 'file_entity'),
  );

275
  $form['wysiwyg']['media_wysiwyg_wysiwyg_allowed_types'] = array(
276 277 278
    '#type' => 'checkboxes',
    '#title' => t('Allowed types in WYSIWYG'),
    '#options' => file_entity_type_get_names(),
279
    '#default_value' => variable_get('media_wysiwyg_wysiwyg_allowed_types', array('audio', 'image', 'video', 'document')),
280 281
  );

282 283
  $options = array();
  foreach(field_info_field_types() as $key => $type) {
284
    $options[$key] = (!empty($type['label']))? $type['label'] : ucfirst(str_replace("_"," ",$key));
285 286 287 288 289 290 291
  }
  asort($options);
  $form['wysiwyg']['media_wysiwyg_wysiwyg_override_field_types'] = array(
    '#type' => 'checkboxes',
    '#title' => t('Override field types in WYSIWYG'),
    '#options' => $options,
    '#default_value' => variable_get('media_wysiwyg_wysiwyg_override_field_types', array('text', 'text_long')),
292 293 294 295 296 297 298 299
    '#description' => t('If checked, then the field type may be overridden in the WYSIWYG editor. Not all field types/widgets (e.g. Term reference autocomplete) currently support being overridden so the desired result might not be achieved.')
  );

  $form['wysiwyg']['media_wysiwyg_wysiwyg_override_multivalue'] = array(
    '#type' => 'checkbox',
    '#title' => t('Override multi-value fields in WYSIWYG'),
    '#description' => t('If checked, then multi-value fields may be overridden in the WYSIWYG editor. Not all field types/widgets (e.g. Term reference autocomplete) currently support being overridden so the desired result might not be achieved.'),
    '#default_value' => variable_get('media_wysiwyg_wysiwyg_override_multivalue', FALSE),
300 301
  );

302 303 304 305 306 307 308
  $form['wysiwyg']['media_wysiwyg_use_link_text_for_filename'] = array(
    '#type' => 'checkbox',
    '#title' => t("Use link text for filename"),
    '#default_value' => variable_get('media_wysiwyg_use_link_text_for_filename', 1),
    '#description' => t('When formatting inserted media, allow editable link text to be used in place of the filename. Turn this off if your file view modes handle link formatting.'),
  );

309 310 311 312 313 314 315
  $form['wysiwyg']['media_wysiwyg_alignment'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide alignment option when embedding media'),
    '#default_value' => variable_get('media_wysiwyg_alignment', FALSE),
    '#description' => t('If checked, there will be an alignment (left/right/center) option when embedding media in a WYSIWYG.'),
  );

316 317 318 319 320 321
  $form['wysiwyg']['media_wysiwyg_external_link'] = array(
    '#type' => 'checkbox',
    '#title' => t('Provide the ability to link media to pages'),
    '#default_value' => variable_get('media_wysiwyg_external_link', FALSE),
    '#description' => t('If checked there will be a new field when embedding that will allow users to link to the media to urls'),
  );
322 323 324 325 326 327 328 329

  $form['wysiwyg']['media_wysiwyg_remove_media_class'] = array(
    '#type' => 'checkbox',
    '#title' => t('Remove the ".media" class from embedded media'),
    '#description' => t('If checked, the ".media" class will be removed from embedded media. Particularlly for sites using Bootstrap, the ".media" class can cause CSS to be unexpectedly applied to embedded media.'),
    '#default_value' => variable_get('media_wysiwyg_remove_media_class', FALSE),
  );

330 331 332 333 334 335 336
  $form['#submit'][] = 'media_wysiwyg_admin_config_browser_pre_submit';
}

/**
 * Manipulate values before form is submitted.
 */
function media_wysiwyg_admin_config_browser_pre_submit(&$form, &$form_state) {
337
  $wysiwyg_browser_plugins = array_unique(array_values($form_state['values']['media_wysiwyg_wysiwyg_browser_plugins']));
338
  if (empty($wysiwyg_browser_plugins[0])) {
339 340
    variable_del('media_wysiwyg_wysiwyg_browser_plugins');
    unset($form_state['values']['media_wysiwyg_wysiwyg_browser_plugins']);
341 342 343 344 345 346 347 348 349
  }
}

/**
 * Implements hook_filter_info().
 */
function media_wysiwyg_filter_info() {
  $filters['media_filter'] = array(
    'title' => t('Convert Media tags to markup'),
350
    'description' => t('This filter will convert [[{type:media... ]] tags into markup. This must be enabled for the Media WYSIWYG integration to work with this input format. It is recommended to run this before the "@convert_urls" filter.', array('@convert_urls' => 'Convert URLs into links')),
351 352 353 354 355 356
    'process callback' => 'media_wysiwyg_filter',
    'weight' => 2,
    // @TODO not implemented
    'tips callback' => 'media_filter_tips',
  );

357 358
  $filters['media_filter_paragraph_fix'] = array(
    'title' => t('Ensure that embedded Media tags are not contained in paragraphs'),
359
    'description' => t('This filter will fix any paragraph tags surrounding embedded Media tags. This helps to avoid the chopped up markup that can result from unexpectedly closed paragraph tags. This filter should be positioned above (before) the "Convert Media tags to markup" filter.'),
360
    'process callback' => 'media_wysiwyg_filter_paragraph_fix',
361 362 363 364
    'settings callback' => '_media_filter_paragraph_fix_settings',
    'default settings' => array(
      'replace' => 0,
    ),
365 366 367
    'weight' => 1,
  );

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383
  return $filters;
}

/**
 * Implements hook_wysiwyg_include_directory().
 */
function media_wysiwyg_wysiwyg_include_directory($type) {
  switch ($type) {
    case 'plugins':
      return 'wysiwyg_plugins';

      break;
  }
}

/**
384
 * Returns the set of allowed attributes for use with WYSIWYG.
385 386 387 388
 *
 * @return array
 *   An array of whitelisted attributes.
 */
389 390 391
function media_wysiwyg_allowed_attributes() {
  // Support the legacy variable for this.
  $allowed_attributes = variable_get('media_wysiwyg_wysiwyg_allowed_attributes', array(
392 393 394 395 396 397 398 399 400 401 402 403 404 405
    'alt',
    'title',
    'height',
    'width',
    'hspace',
    'vspace',
    'border',
    'align',
    'style',
    'class',
    'id',
    'usemap',
    'data-picture-group',
    'data-picture-align',
406
    'data-picture-mapping',
407
    'data-delta',
408 409
  ));
  drupal_alter('media_wysiwyg_allowed_attributes', $allowed_attributes);
410
  return $allowed_attributes;
411 412 413 414 415 416 417
}

/**
 * Returns a drupal_render() array for just the file portion of a file entity.
 *
 * Optional custom settings can override how the file is displayed.
 */
418
function media_wysiwyg_get_file_without_label($file, $view_mode, $settings = array(), $langcode = NULL) {
419 420 421 422 423 424 425 426 427 428 429 430 431 432
  // Get the override alt & title from the fields override array. Grab the
  // "special" field names from the token replacement in file_entity, then see
  // if an override is provided and needed.
  $pattern = '/\[(\w+):(\w+)\]/';
  $alt = variable_get('file_entity_alt', '[file:field_file_image_alt_text]');
  $title = variable_get('file_entity_title', '[file:field_file_image_title_text]');
  $overrides = array(
    'alt' => $alt,
    'title' => $title,
  );
  foreach ($overrides as $field_type => $field_name) {
    preg_match($pattern, $field_name, $matches);
    if (!empty($matches[2])) {
      $field_name = $matches[2];
433 434
      $field_langcode = field_language('file', $file, $field_name);
      if (isset($settings['fields'][$field_name][$field_langcode]['value'])) {
435
        if (empty($settings['attributes'][$field_type])) {
436
          $settings['attributes'][$field_type] = $settings['fields'][$field_name][$field_langcode]['value'];
437 438
        }
      }
439
      if (isset($settings['fields'][$field_name][$field_langcode][0]['value'])) {
440
        if (empty($settings['attributes'][$field_type])) {
441
          $settings['attributes'][$field_type] = $settings['fields'][$field_name][$field_langcode][0]['value'];
442 443 444 445 446
        }
      }
    }
  }

447 448
  $file->override = $settings;

449 450 451 452 453 454 455 456 457
  $element = file_view_file($file, $view_mode, $langcode);

  // Field Translation Support.
  if (field_has_translation_handler('file')) {
    if ($field_items = field_get_items('file', $file, 'field_file_image_alt_text', $langcode)) {
      $value = field_view_value('file', $file, 'field_file_image_alt_text', $field_items[0], array(), $langcode);
      $element['#alt'] = isset($value['#markup']) ? $value['#markup'] : '';
    }
  }
458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

  // The formatter invoked by file_view_file() can use $file->override to
  // customize the returned render array to match the requested settings. To
  // support simple formatters that don't do this, set the element attributes to
  // what was requested, but not if the formatter applied its own logic for
  // element attributes.
  if (isset($settings['attributes'])) {
    if (empty($element['#attributes'])) {
      $element['#attributes'] = $settings['attributes'];
    }

    // While this function may be called for any file type, images are a common
    // use-case, and image theme functions have their own structure for render
    // arrays.
    if (isset($element['#theme'])) {
      // theme_image() and theme_image_style() require the 'alt' attributes to
      // be passed separately from the 'attributes' array. (see
      // http://drupal.org/node/999338). Until that's fixed, implement this
      // special-case logic. Image formatters using other theme functions are
      // responsible for their own 'alt' attribute handling. See
      // theme_media_formatter_large_icon() for an example.
      if (in_array($element['#theme'], array('image', 'image_style'))) {
        if (empty($element['#alt']) && isset($settings['attributes']['alt'])) {
          $element['#alt'] = $settings['attributes']['alt'];
        }
      }
      // theme_image_formatter() and any potential replacements, such as
      // theme_colorbox_image_formatter(), also require attribute handling.
      elseif (strpos($element['#theme'], 'image_formatter') !== FALSE) {
        // theme_image_formatter() requires the attributes to be
        // set on the item rather than the element itself.
        if (empty($element['#item']['attributes'])) {
          $element['#item']['attributes'] = $settings['attributes'];
        }

        // theme_image_formatter() also requires alt, title, height, and
        // width attributes to be set on the item rather than within its
        // attributes array.
        foreach (array('alt', 'title', 'width', 'height') as $attr) {
          if (isset($settings['attributes'][$attr])) {
            $element['#item'][$attr] = $settings['attributes'][$attr];
          }
        }
      }
    }
  }

  return $element;
}

/**
 * Returns an array containing the names of all fields that perform text filtering.
 */
function media_wysiwyg_filter_fields_with_text_filtering($entity_type, $entity) {
  list($entity_id, $revision_id, $bundle) = entity_extract_ids($entity_type, $entity);
  $fields = field_info_instances($entity_type, $bundle);

  // Get all of the fields on this entity that allow text filtering.
  $fields_with_text_filtering = array();
  foreach ($fields as $field_name => $field) {
    if (!empty($field['settings']['text_processing'])) {
      $fields_with_text_filtering[] = $field_name;
    }
  }

  return $fields_with_text_filtering;
}
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585

/**
 * Return a list of view modes allowed for a file type.
 *
 * @param string $file_type
 *   A file type machine name.
 *
 * @return array
 *   An array of view modes that can be used on the file type.
 */
function media_wysiwyg_get_file_type_view_mode_options($file_type) {
  $enabled_view_modes = &drupal_static(__FUNCTION__, array());

  // @todo Add more caching for this.
  if (!isset($enabled_view_modes[$file_type])) {
    $enabled_view_modes[$file_type] = array();

    // Add the default view mode by default.
    $enabled_view_modes[$file_type]['default'] = t('Default');

    $entity_info = entity_get_info('file');
    $view_mode_settings = field_view_mode_settings('file', $file_type);
    foreach ($entity_info['view modes'] as $view_mode => $view_mode_info) {
      // Do not show view modes that don't have their own settings and will
      // only fall back to the default view mode.
      if (empty($view_mode_settings[$view_mode]['custom_settings'])) {
        continue;
      }

      // Don't present the user with an option to choose a view mode in which
      // the file is hidden.
      $extra_fields = field_extra_fields_get_display('file', $file_type, $view_mode);
      if (empty($extra_fields['file']['visible'])) {
        continue;
      }

      // Add the view mode to the list of enabled view modes.
      $enabled_view_modes[$file_type][$view_mode] = $view_mode_info['label'];
    }
  }

  return $enabled_view_modes[$file_type];
}

/**
 * Return a list of view modes allowed for a file embedded in the WYSIWYG.
 *
 * @param object $file
 *   A file entity.
 *
 * @return array
 *   An array of view modes that can be used on the file when embedded in the
 *   WYSIWYG.
 */
function media_wysiwyg_get_file_view_mode_options($file) {
  $view_modes = media_wysiwyg_get_file_type_view_mode_options($file->type);
  drupal_alter('media_wysiwyg_allowed_view_modes', $view_modes, $file);
  // Invoke the deprecated/misspelled alter hook as well.
  drupal_alter('media_wysiwyg_wysiwyg_allowed_view_modes', $view_modes, $file);
  return $view_modes;
}
586 587 588 589 590 591 592 593 594 595 596 597 598 599

/**
 * Implements hook_file_displays_alter().
 */
function media_wysiwyg_file_displays_alter(&$displays, $file, $view_mode) {
  // Override the fields of the file when requested by the WYSIWYG.
  if (isset($file->override) && isset($file->override['fields'])) {
    $instance = field_info_instances('file', $file->type);
    foreach ($file->override['fields'] as $field_name => $value) {
      if (!isset($instance[$field_name]['settings']) || !isset($instance[$field_name]['settings']['wysiwyg_override']) || $instance[$field_name]['settings']['wysiwyg_override']) {
        $file->{$field_name} = $value;
      }
    }
  }
600 601 602 603 604 605 606 607 608
  // For integration/support of the picture module https://www.drupal.org/project/picture.
  // Disable Picture display in WYSIWYG mode. Normal <img> will be rendered
  // instead. CKEditor and Media WYSIWYG modules with render with common <img>
  // while frontend will render full <picture> output as usual.
  if (module_exists('picture')) {
    if (!empty($file->override['wysiwyg']) && !empty($displays['file_field_picture']['status'])) {
      $displays['file_field_picture']['status'] = 0;
    }
  }
609
}
610 611 612 613 614 615 616

/**
 * Implements hook_entity_info_alter().
 *
 * Add a file type named 'WYSIWYG'.
 */
function media_wysiwyg_entity_info_alter(&$entity_info) {
617 618 619
  $entity_info['file']['view modes']['wysiwyg'] = array(
    'label' => t('WYSIWYG'),
    'custom settings' => TRUE,
620 621 622 623 624 625 626 627 628
  );
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add select when editing file types to set wysiwyg view mode.
 */
function media_wysiwyg_form_file_entity_file_type_form_alter(&$form, &$form_state) {
629 630 631 632
  // #2609244 Keep media from trying to alter the File add form just edit.
  if (empty($form_state['build_info']['args'][0])) {
    return;
  }
633

634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723
  $options = array();

  // Add an option allowing users not to use a view mode.
  $options['none'] = t('None');

  // Add the default view mode by default.
  $options['default'] = t('Default');

  $entity_info = entity_get_info('file');
  foreach ($entity_info['view modes'] as $view_mode => $view_mode_info) {
    $options[$view_mode] = check_plain($view_mode_info['label']);
  }

  $file_type = $form['#file_type']->type;
  $view_mode = db_query('SELECT view_mode FROM {media_view_mode_wysiwyg} WHERE type = :type', array(':type' => $file_type))->fetchField();
  $view_mode = empty($view_mode) ? 'none' : $view_mode;

  $form['file_wysiwyg_view_mode'] = array(
    '#type' => 'select',
    '#title' => t('WYSIWYG view mode'),
    '#options' => $options,
    '#default_value' => $view_mode,
    '#description' => t('View mode to be used when displaying files inside of the WYSIWYG editor.'),
  );

  // Move submit after our select box. There might be a better way to do this.
  $form['submit']['#weight'] = 1;

  array_unshift($form['#submit'], 'media_wysiwyg_form_file_entity_file_type_form_alter_submit');
}

/**
 * Custom submit handler.
 *
 * Save wysiwyg view mode.
 *
 * @see media_wysiwyg_form_file_entity_file_type_form_alter().
 */
function media_wysiwyg_form_file_entity_file_type_form_alter_submit(&$form, &$form_state) {
  $file_type = $form['#file_type']->type;
  $view_mode = $form_state['values']['file_wysiwyg_view_mode'];
  db_delete('media_view_mode_wysiwyg')->condition('type', $file_type)->execute();
  if ($view_mode != 'none') {
    $record = array('type' => $file_type, 'view_mode' => $view_mode);
    drupal_write_record('media_view_mode_wysiwyg', $record);
  }
}

/**
 * Implements hook_form_FORM_ID_alter().
 *
 * Add checkbox to restrict file type view mode availability in wysiwyg.
 */
function media_wysiwyg_form_file_entity_file_display_form_alter(&$form, &$form_state) {
  $file_type = $form['#file_type'];
  $view_mode = $form['#view_mode'];

  if ($view_mode != 'none') {
    $restricted = db_query(
      'SELECT 1 FROM {media_restrict_wysiwyg} WHERE type = :type and display = :display',
      array(':type' => $file_type, ':display' => $view_mode)
    )->fetchField();
    $form['restrict_wysiwyg'] = array(
      '#type' => 'checkbox',
      '#title' => t('Restrict in WYSIWYG'),
      '#description' => t('If checked, then this mode will not be allowed from the WYSIWYG.'),
      '#default_value' => !empty($restricted),
    );
    array_unshift($form['#submit'], 'media_wysiwyg_form_file_entity_file_display_form_alter_submit');
  }

  return $form;
}

/**
 * Custom submit handler.
 *
 * Save restricted wysiwyg file types.
 *
 * @see media_wysiwyg_form_file_entity_file_display_form_alter().
 */
function media_wysiwyg_form_file_entity_file_display_form_alter_submit(&$form, &$form_state) {
  $file_type = $form['#file_type'];
  $view_mode = $form['#view_mode'];
  db_delete('media_restrict_wysiwyg')->condition('type', $file_type)->condition('display', $view_mode)->execute();
  if (!empty($form_state['values']['restrict_wysiwyg'])) {
    $record = array('type' => $file_type, 'display' => $view_mode);
    drupal_write_record('media_restrict_wysiwyg', $record);
  }
}
724 725 726 727 728 729 730 731 732 733 734 735 736 737 738

/**
 * Implements hook_media_browser_params_alter().
 */
function media_wysiwyg_media_browser_params_alter(&$params) {
  // Set the media browser options as defined in the interface.
  if (!empty($params['id']) && $params['id'] === 'media_wysiwyg') {
    $params = array(
      'enabledPlugins' => variable_get('media_wysiwyg_wysiwyg_browser_plugins', array()),
      'file_directory' => variable_get('media_wysiwyg_wysiwyg_upload_directory', ''),
      'types' => variable_get('media_wysiwyg_wysiwyg_allowed_types', array('audio', 'image', 'video', 'document')),
      'id' => 'media_wysiwyg',
    ) + $params;
  }
}