editor.module 25 KB
Newer Older
1 2 3 4 5 6 7
<?php

/**
 * @file
 * Adds bindings for client-side "text editors" to text formats.
 */

8
use Drupal\Component\Utility\Html;
9
use Drupal\editor\Entity\Editor;
10
use Drupal\Core\Entity\FieldableEntityInterface;
11
use Drupal\Core\Field\FieldDefinitionInterface;
12
use Drupal\Core\Form\FormStateInterface;
13
use Drupal\Core\Render\Element;
14
use Drupal\Core\Routing\RouteMatchInterface;
15
use Drupal\Core\StringTranslation\TranslatableMarkup;
16
use Drupal\Core\Entity\EntityInterface;
17 18
use Drupal\filter\FilterFormatInterface;
use Drupal\filter\Plugin\FilterInterface;
19 20 21 22

/**
 * Implements hook_help().
 */
23
function editor_help($route_name, RouteMatchInterface $route_match) {
24 25
  switch ($route_name) {
    case 'help.page.editor':
26 27
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
28
      $output .= '<p>' . t('The Text Editor module provides a framework that other modules (such as <a href=":ckeditor">CKEditor module</a>) can use to provide toolbars and other functionality that allow users to format text more easily than typing HTML tags directly. For more information, see the <a href=":documentation">online documentation for the Text Editor module</a>.', array(':documentation' => 'https://www.drupal.org/documentation/modules/editor', ':ckeditor' => (\Drupal::moduleHandler()->moduleExists('ckeditor')) ? \Drupal::url('help.page', array('name' => 'ckeditor')) : '#')) . '</p>';
29 30
      $output .= '<h3>' . t('Uses') . '</h3>';
      $output .= '<dl>';
31
      $output .= '<dt>' . t('Installing text editors') . '</dt>';
32
      $output .= '<dd>' . t('The Text Editor module provides a framework for managing editors. To use it, you also need to enable a text editor. This can either be the core <a href=":ckeditor">CKEditor module</a>, which can be enabled on the <a href=":extend">Extend page</a>, or a contributed module for any other text editor. When installing a contributed text editor module, be sure to check the installation instructions, because you will most likely need to download and install an external library as well as the Drupal module.', array(':ckeditor' => (\Drupal::moduleHandler()->moduleExists('ckeditor')) ? \Drupal::url('help.page', array('name' => 'ckeditor')) : '#', ':extend' => \Drupal::url('system.modules_list'))) . '</dd>';
33
      $output .= '<dt>' . t('Enabling a text editor for a text format') . '</dt>';
34
      $output .= '<dd>' . t('On the <a href=":formats">Text formats and editors page</a> you can see which text editor is associated with each text format. You can change this by clicking on the <em>Configure</em> link, and then choosing a text editor or <em>none</em> from the <em>Text editor</em> drop-down list. The text editor will then be displayed with any text field for which this text format is chosen.', array(':formats' => \Drupal::url('filter.admin_overview'))) . '</dd>';
35 36 37 38
      $output .= '<dt>' . t('Configuring a text editor') . '</dt>';
      $output .= '<dd>' . t('Once a text editor is associated with a text format, you can configure it by clicking on the <em>Configure</em> link for this format. Depending on the specific text editor, you can configure it for example by adding buttons to its toolbar. Typically these buttons provide formatting or editing tools, and they often insert HTML tags into the field source. For details, see the help page of the specific text editor.') . '</dd>';
      $output .= '<dt>' . t('Using different text editors and formats') . '</dt>';
      $output .= '<dd>' . t('If you change the text format on a text field, the text editor will change as well because the text editor configuration is associated with the individual text format. This allows the use of the same text editor with different options for different text formats. It also allows users to choose between text formats with different text editors if they are installed.') . '</dd>';
39 40 41 42 43 44
      $output .= '</dl>';
      return $output;
  }
}

/**
45
 * Implements hook_menu_links_discovered_alter().
46 47 48 49
 *
 * Rewrites the menu entries for filter module that relate to the configuration
 * of text editors.
 */
50
function editor_menu_links_discovered_alter(array &$links) {
51
  $links['filter.admin_overview']['title'] = new TranslatableMarkup('Text formats and editors');
52
  $links['filter.admin_overview']['description'] = new TranslatableMarkup('Select and configure text editors, and how content is filtered when displayed.');
53 54 55
}

/**
56
 * Implements hook_element_info_alter().
57 58 59 60 61
 *
 * Extends the functionality of text_format elements (provided by Filter
 * module), so that selecting a text format notifies a client-side text editor
 * when it should be enabled or disabled.
 *
62
 * @see \Drupal\filter\Element\TextFormat
63
 */
64 65
function editor_element_info_alter(&$types) {
  $types['text_format']['#pre_render'][] = 'element.editor:preRenderTextFormat';
66 67 68
}

/**
69
 * Implements hook_form_FORM_ID_alter() for \Drupal\filter\FilterFormatListBuilder.
70 71 72 73 74 75 76 77 78 79 80 81 82 83
 *
 * Implements hook_field_formatter_info_alter().
 *
 * @see quickedit_field_formatter_info_alter()
 */
function editor_field_formatter_info_alter(&$info) {
  // Update \Drupal\text\Plugin\Field\FieldFormatter\TextDefaultFormatter's
  // annotation to indicate that it supports the 'editor' in-place editor
  // provided by this module.
  $info['text_default']['quickedit'] = ['editor' => 'editor'];
}

/**
 * Implements hook_form_FORM_ID_alter().
84
 */
85
function editor_form_filter_admin_overview_alter(&$form, FormStateInterface $form_state) {
86
  // @todo Cleanup column injection: https://www.drupal.org/node/1876718.
87 88 89 90 91 92
  // Splice in the column for "Text editor" into the header.
  $position = array_search('name', $form['formats']['#header']) + 1;
  $start = array_splice($form['formats']['#header'], 0, $position, array('editor' => t('Text editor')));
  $form['formats']['#header'] = array_merge($start, $form['formats']['#header']);

  // Then splice in the name of each text editor for each text format.
93
  $editors = \Drupal::service('plugin.manager.editor')->getDefinitions();
94
  foreach (Element::children($form['formats']) as $format_id) {
95
    $editor = editor_load($format_id);
96
    $editor_name = ($editor && isset($editors[$editor->getEditor()])) ? $editors[$editor->getEditor()]['label'] : '—';
97 98 99 100 101 102 103 104
    $editor_column['editor'] = array('#markup' => $editor_name);
    $position = array_search('name', array_keys($form['formats'][$format_id])) + 1;
    $start = array_splice($form['formats'][$format_id], 0, $position, $editor_column);
    $form['formats'][$format_id] = array_merge($start, $form['formats'][$format_id]);
  }
}

/**
105
 * Implements hook_form_BASE_FORM_ID_alter() for \Drupal\filter\FilterFormatEditForm.
106
 */
107
function editor_form_filter_format_form_alter(&$form, FormStateInterface $form_state) {
108 109
  $editor = $form_state->get('editor');
  if ($editor === NULL) {
110 111
    $format = $form_state->getFormObject()->getEntity();
    $format_id = $format->isNew() ? NULL : $format->id();
112 113
    $editor = editor_load($format_id);
    $form_state->set('editor', $editor);
114 115 116
  }

  // Associate a text editor with this text format.
117
  $manager = \Drupal::service('plugin.manager.editor');
118 119
  $editor_options = $manager->listOptions();
  $form['editor'] = array(
120 121 122 123 124
    // Position the editor selection before the filter settings (weight of 0),
    // but after the filter label and name (weight of -20).
    '#weight' => -9,
  );
  $form['editor']['editor'] = array(
125 126 127 128
    '#type' => 'select',
    '#title' => t('Text editor'),
    '#options' => $editor_options,
    '#empty_option' => t('None'),
129
    '#default_value' => $editor ? $editor->getEditor() : '',
130 131 132 133 134
    '#ajax' => array(
      'trigger_as' => array('name' => 'editor_configure'),
      'callback' => 'editor_form_filter_admin_form_ajax',
      'wrapper' => 'editor-settings-wrapper',
    ),
135
    '#weight' => -10,
136
  );
137
  $form['editor']['configure'] = array(
138 139 140 141 142 143 144 145 146
    '#type' => 'submit',
    '#name' => 'editor_configure',
    '#value' => t('Configure'),
    '#limit_validation_errors' => array(array('editor')),
    '#submit' => array('editor_form_filter_admin_format_editor_configure'),
    '#ajax' => array(
      'callback' => 'editor_form_filter_admin_form_ajax',
      'wrapper' => 'editor-settings-wrapper',
    ),
147
    '#weight' => -10,
148 149 150 151 152
    '#attributes' => array('class' => array('js-hide')),
  );

  // If there aren't any options (other than "None"), disable the select list.
  if (empty($editor_options)) {
153 154
    $form['editor']['editor']['#disabled'] = TRUE;
    $form['editor']['editor']['#description'] = t('This option is disabled because no modules that provide a text editor are currently enabled.');
155 156
  }

157
  $form['editor']['settings'] = array(
158 159 160 161
    '#tree' => TRUE,
    '#weight' => -8,
    '#type' => 'container',
    '#id' => 'editor-settings-wrapper',
162 163
    '#attached' => array(
      'library' => array(
164
        'editor/drupal.editor.admin',
165 166
      ),
    ),
167 168 169 170
  );

  // Add editor-specific validation and submit handlers.
  if ($editor) {
171
    $plugin = $manager->createInstance($editor->getEditor());
172 173
    $settings_form = array();
    $settings_form['#element_validate'][] = array($plugin, 'settingsFormValidate');
174 175
    $form['editor']['settings']['subform'] = $plugin->settingsForm($settings_form, $form_state, $editor);
    $form['editor']['settings']['subform']['#parents'] = array('editor', 'settings');
176
    $form['actions']['submit']['#submit'][] = array($plugin, 'settingsFormSubmit');
177 178
  }

179
  $form['#validate'][] = 'editor_form_filter_admin_format_validate';
180
  $form['actions']['submit']['#submit'][] = 'editor_form_filter_admin_format_submit';
181 182 183
}

/**
184
 * Button submit handler for filter_format_form()'s 'editor_configure' button.
185
 */
186
function editor_form_filter_admin_format_editor_configure($form, FormStateInterface $form_state) {
187
  $editor = $form_state->get('editor');
188 189
  $editor_value = $form_state->getValue(array('editor', 'editor'));
  if ($editor_value !== NULL) {
190
    if ($editor_value === '') {
191
      $form_state->set('editor', FALSE);
192
    }
193
    elseif (empty($editor) || $editor_value !== $editor->getEditor()) {
194
      $format = $form_state->getFormObject()->getEntity();
195
      $editor = Editor::create([
196
        'format' => $format->isNew() ? NULL : $format->id(),
197
        'editor' => $editor_value,
198
      ]);
199
      $form_state->set('editor', $editor);
200 201
    }
  }
202
  $form_state->setRebuild();
203 204 205
}

/**
206
 * AJAX callback handler for filter_format_form().
207
 */
208
function editor_form_filter_admin_form_ajax($form, FormStateInterface $form_state) {
209
  return $form['editor']['settings'];
210 211
}

212
/**
213
 * Additional validate handler for filter_format_form().
214
 */
215
function editor_form_filter_admin_format_validate($form, FormStateInterface $form_state) {
216
  // This validate handler is not applicable when using the 'Configure' button.
217
  if ($form_state->getTriggeringElement()['#name'] === 'editor_configure') {
218 219 220
    return;
  }

221
  // When using this form with JavaScript disabled in the browser, the
222 223 224
  // 'Configure' button won't be clicked automatically. So, when the user has
  // selected a text editor and has then clicked 'Save configuration', we should
  // point out that the user must still configure the text editor.
225
  if ($form_state->getValue(['editor', 'editor']) !== '' && !$form_state->get('editor')) {
226
    $form_state->setErrorByName('editor][editor', t('You must configure the selected text editor.'));
227 228 229
  }
}

230
/**
231
 * Additional submit handler for filter_format_form().
232
 */
233
function editor_form_filter_admin_format_submit($form, FormStateInterface $form_state) {
234
  // Delete the existing editor if disabling or switching between editors.
235 236
  $format = $form_state->getFormObject()->getEntity();
  $format_id = $format->isNew() ? NULL : $format->id();
237
  $original_editor = editor_load($format_id);
238
  if ($original_editor && $original_editor->getEditor() != $form_state->getValue(array('editor', 'editor'))) {
239 240 241 242
    $original_editor->delete();
  }

  // Create a new editor or update the existing editor.
243
  if ($editor = $form_state->get('editor')) {
244 245
    // Ensure the text format is set: when creating a new text format, this
    // would equal the empty string.
246 247 248
    $editor->set('format', $format_id);
    $editor->setSettings($form_state->getValue(['editor', 'settings']));
    $editor->save();
249 250 251 252 253 254
  }
}

/**
 * Loads an individual configured text editor based on text format ID.
 *
255 256 257
 * @param int $format_id
 *   A text format ID.
 *
258
 * @return \Drupal\editor\Entity\Editor|null
259
 *   A text editor object, or NULL.
260 261 262 263 264 265
 */
function editor_load($format_id) {
  // Load all the editors at once here, assuming that either no editors or more
  // than one editor will be needed on a page (such as having multiple text
  // formats for administrators). Loading a small number of editors all at once
  // is more efficient than loading multiple editors individually.
266
  $editors = Editor::loadMultiple();
267
  return isset($editors[$format_id]) ? $editors[$format_id] : NULL;
268 269
}

270 271 272 273 274
/**
 * Applies text editor XSS filtering.
 *
 * @param string $html
 *   The HTML string that will be passed to the text editor.
275 276 277
 * @param \Drupal\filter\FilterFormatInterface|null $format
 *   The text format whose text editor will be used or NULL if the previously
 *   defined text format is now disabled.
278 279 280 281 282 283 284
 * @param \Drupal\filter\FilterFormatInterface $original_format|null
 *   (optional) The original text format (i.e. when switching text formats,
 *   $format is the text format that is going to be used, $original_format is
 *   the one that was being used initially, the one that is stored in the
 *   database when editing).
 *
 * @return string|false
285 286 287 288 289 290
 *   The XSS filtered string or FALSE when no XSS filtering needs to be applied,
 *   because one of the next conditions might occur:
 *   - No text editor is associated with the text format,
 *   - The previously defined text format is now disabled,
 *   - The text editor is safe from XSS,
 *   - The text format does not use any XSS protection filters.
291
 *
292
 * @see https://www.drupal.org/node/2099741
293
 */
294 295
function editor_filter_xss($html, FilterFormatInterface $format = NULL, FilterFormatInterface $original_format = NULL) {
  $editor = $format ? editor_load($format->id()) : NULL;
296

297 298 299
  // If no text editor is associated with this text format or the previously
  // defined text format is now disabled, then we don't need text editor XSS
  // filtering either.
300 301 302 303 304 305
  if (!isset($editor)) {
    return FALSE;
  }

  // If the text editor associated with this text format guarantees security,
  // then we also don't need text editor XSS filtering.
306
  $definition = \Drupal::service('plugin.manager.editor')->getDefinition($editor->getEditor());
307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  if ($definition['is_xss_safe'] === TRUE) {
    return FALSE;
  }

  // If there is no filter preventing XSS attacks in the text format being used,
  // then no text editor XSS filtering is needed either. (Because then the
  // editing user can already be attacked by merely viewing the content.)
  // e.g.: an admin user creates content in Full HTML and then edits it, no text
  // format switching happens; in this case, no text editor XSS filtering is
  // desirable, because it would strip style attributes, amongst others.
  $current_filter_types = $format->getFilterTypes();
  if (!in_array(FilterInterface::TYPE_HTML_RESTRICTOR, $current_filter_types, TRUE)) {
    if ($original_format === NULL) {
      return FALSE;
    }
    // Unless we are switching from another text format, in which case we must
    // first check whether a filter preventing XSS attacks is used in that text
    // format, and if so, we must still apply XSS filtering.
    // e.g.: an anonymous user creates content in Restricted HTML, an admin user
    // edits it (then no XSS filtering is applied because no text editor is
    // used), and switches to Full HTML (for which a text editor is used). Then
    // we must apply XSS filtering to protect the admin user.
    else {
      $original_filter_types = $original_format->getFilterTypes();
      if (!in_array(FilterInterface::TYPE_HTML_RESTRICTOR, $original_filter_types, TRUE)) {
        return FALSE;
      }
    }
  }

  // Otherwise, apply the text editor XSS filter. We use the default one unless
  // a module tells us to use a different one.
  $editor_xss_filter_class = '\Drupal\editor\EditorXssFilter\Standard';
  \Drupal::moduleHandler()->alter('editor_xss_filter', $editor_xss_filter_class, $format, $original_format);

  return call_user_func($editor_xss_filter_class . '::filterXss', $html, $format, $original_format);
}

345 346 347 348
/**
 * Implements hook_entity_insert().
 */
function editor_entity_insert(EntityInterface $entity) {
349
  // Only act on content entities.
350
  if (!($entity instanceof FieldableEntityInterface)) {
351 352
    return;
  }
353 354 355 356 357 358 359 360 361 362
  $referenced_files_by_field = _editor_get_file_uuids_by_field($entity);
  foreach ($referenced_files_by_field as $field => $uuids) {
    _editor_record_file_usage($uuids, $entity);
  }
}

/**
 * Implements hook_entity_update().
 */
function editor_entity_update(EntityInterface $entity) {
363
  // Only act on content entities.
364
  if (!($entity instanceof FieldableEntityInterface)) {
365 366 367
    return;
  }

368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401
  // On new revisions, all files are considered to be a new usage and no
  // deletion of previous file usages are necessary.
  if (!empty($entity->original) && $entity->getRevisionId() != $entity->original->getRevisionId()) {
    $referenced_files_by_field = _editor_get_file_uuids_by_field($entity);
    foreach ($referenced_files_by_field as $field => $uuids) {
      _editor_record_file_usage($uuids, $entity);
    }
  }
  // On modified revisions, detect which file references have been added (and
  // record their usage) and which ones have been removed (delete their usage).
  // File references that existed both in the previous version of the revision
  // and in the new one don't need their usage to be updated.
  else {
    $original_uuids_by_field = _editor_get_file_uuids_by_field($entity->original);
    $uuids_by_field = _editor_get_file_uuids_by_field($entity);

    // Detect file usages that should be incremented.
    foreach ($uuids_by_field as $field => $uuids) {
      $added_files = array_diff($uuids_by_field[$field], $original_uuids_by_field[$field]);
      _editor_record_file_usage($added_files, $entity);
    }

    // Detect file usages that should be decremented.
    foreach ($original_uuids_by_field as $field => $uuids) {
      $removed_files = array_diff($original_uuids_by_field[$field], $uuids_by_field[$field]);
      _editor_delete_file_usage($removed_files, $entity, 1);
    }
  }
}

/**
 * Implements hook_entity_delete().
 */
function editor_entity_delete(EntityInterface $entity) {
402
  // Only act on content entities.
403
  if (!($entity instanceof FieldableEntityInterface)) {
404 405
    return;
  }
406 407 408 409 410 411 412 413 414 415
  $referenced_files_by_field = _editor_get_file_uuids_by_field($entity);
  foreach ($referenced_files_by_field as $field => $uuids) {
    _editor_delete_file_usage($uuids, $entity, 0);
  }
}

/**
 * Implements hook_entity_revision_delete().
 */
function editor_entity_revision_delete(EntityInterface $entity) {
416
  // Only act on content entities.
417
  if (!($entity instanceof FieldableEntityInterface)) {
418 419
    return;
  }
420 421 422 423 424 425 426
  $referenced_files_by_field = _editor_get_file_uuids_by_field($entity);
  foreach ($referenced_files_by_field as $field => $uuids) {
    _editor_delete_file_usage($uuids, $entity, 1);
  }
}

/**
427
 * Records file usage of files referenced by formatted text fields.
428 429 430 431 432 433 434 435 436 437 438
 *
 * Every referenced file that does not yet have the FILE_STATUS_PERMANENT state,
 * will be given that state.
 *
 * @param array $uuids
 *   An array of file entity UUIDs.
 * @param EntityInterface $entity
 *   An entity whose fields to inspect for file references.
 */
function _editor_record_file_usage(array $uuids, EntityInterface $entity) {
  foreach ($uuids as $uuid) {
439
    if ($file = \Drupal::entityManager()->loadEntityByUuid('file', $uuid)) {
440 441 442 443 444
      if ($file->status !== FILE_STATUS_PERMANENT) {
        $file->status = FILE_STATUS_PERMANENT;
        $file->save();
      }
      \Drupal::service('file.usage')->add($file, 'editor', $entity->getEntityTypeId(), $entity->id());
445 446 447 448 449
    }
  }
}

/**
450
 * Deletes file usage of files referenced by formatted text fields.
451 452 453 454 455 456 457 458 459
 *
 * @param array $uuids
 *   An array of file entity UUIDs.
 * @param EntityInterface $entity
 *   An entity whose fields to inspect for file references.
 * @param $count
 *   The number of references to delete. Should be 1 when deleting a single
 *   revision and 0 when deleting an entity entirely.
 *
460
 * @see \Drupal\file\FileUsage\FileUsageInterface::delete()
461 462 463
 */
function _editor_delete_file_usage(array $uuids, EntityInterface $entity, $count) {
  foreach ($uuids as $uuid) {
464
    if ($file = \Drupal::entityManager()->loadEntityByUuid('file', $uuid)) {
465 466
      \Drupal::service('file.usage')->delete($file, 'editor', $entity->getEntityTypeId(), $entity->id(), $count);
    }
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
/**
 * Implements hook_file_download().
 *
 * @see file_file_download()
 * @see file_get_file_references()
 */
function editor_file_download($uri) {
  // Get the file record based on the URI. If not in the database just return.
  /** @var \Drupal\file\FileInterface[] $files */
  $files = \Drupal::entityTypeManager()
    ->getStorage('file')
    ->loadByProperties(['uri' => $uri]);
  if (count($files)) {
    foreach ($files as $item) {
      // Since some database servers sometimes use a case-insensitive comparison
      // by default, double check that the filename is an exact match.
      if ($item->getFileUri() === $uri) {
        $file = $item;
        break;
      }
    }
  }
  if (!isset($file)) {
    return;
  }

  // Temporary files are handled by file_file_download(), so nothing to do here
  // about them.
  // @see file_file_download()

  // Find out if any editor-backed field contains the file.
  $usage_list = \Drupal::service('file.usage')->listUsage($file);

  // Stop processing if there are no references in order to avoid returning
  // headers for files controlled by other modules. Make an exception for
  // temporary files where the host entity has not yet been saved (for example,
  // an image preview on a node creation form) in which case, allow download by
  // the file's owner.
  if (empty($usage_list['editor']) && ($file->isPermanent() || $file->getOwnerId() != \Drupal::currentUser()->id())) {
    return;
  }

  // Editor.module MUST NOT call $file->access() here (like file_file_download()
  // does) as checking the 'download' access to a file entity would end up in
  // FileAccessControlHandler->checkAccess() and ->getFileReferences(), which
  // calls file_get_file_references(). This latter one would allow downloading
  // files only handled by the file.module, which is exactly not the case right
  // here.

  // Access is granted.
  $headers = file_get_content_headers($file);
  return $headers;
}

524
/**
525
 * Finds all files referenced (data-entity-uuid) by formatted text fields.
526 527 528 529 530 531 532 533 534 535
 *
 * @param EntityInterface $entity
 *   An entity whose fields to analyze.
 *
 * @return array
 *   An array of file entity UUIDs.
 */
function _editor_get_file_uuids_by_field(EntityInterface $entity) {
  $uuids = array();

536 537
  $formatted_text_fields = _editor_get_formatted_text_fields($entity);
  foreach ($formatted_text_fields as $formatted_text_field) {
538 539 540 541
    $text = '';
    $field_items = $entity->get($formatted_text_field);
    foreach ($field_items as $field_item) {
      $text .= $field_item->value;
542 543 544
      if ($field_item->getFieldDefinition()->getType() == 'text_with_summary') {
        $text .= $field_item->summary;
      }
545
    }
546
    $uuids[$formatted_text_field] = _editor_parse_file_uuids($text);
547 548 549 550 551
  }
  return $uuids;
}

/**
552
 * Determines the formatted text fields on an entity.
553
 *
554
 * @param \Drupal\Core\Entity\FieldableEntityInterface $entity
555 556 557
 *   An entity whose fields to analyze.
 *
 * @return array
558
 *   The names of the fields on this entity that support formatted text.
559
 */
560
function _editor_get_formatted_text_fields(FieldableEntityInterface $entity) {
561 562
  $field_definitions = $entity->getFieldDefinitions();
  if (empty($field_definitions)) {
563 564 565
    return array();
  }

566 567 568
  // Only return formatted text fields.
  return array_keys(array_filter($field_definitions, function (FieldDefinitionInterface $definition) {
    return in_array($definition->getType(), array('text', 'text_long', 'text_with_summary'), TRUE);
569
  }));
570 571 572
}

/**
573
 * Parse an HTML snippet for any linked file with data-entity-uuid attributes.
574 575 576 577 578 579 580 581 582
 *
 * @param string $text
 *   The partial (X)HTML snippet to load. Invalid markup will be corrected on
 *   import.
 *
 * @return array
 *   An array of all found UUIDs.
 */
function _editor_parse_file_uuids($text) {
583
  $dom = Html::load($text);
584 585
  $xpath = new \DOMXPath($dom);
  $uuids = array();
586 587
  foreach ($xpath->query('//*[@data-entity-type="file" and @data-entity-uuid]') as $node) {
    $uuids[] = $node->getAttribute('data-entity-uuid');
588 589 590
  }
  return $uuids;
}
591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617

/**
 * Implements hook_ENTITY_TYPE_presave().
 *
 * Synchronizes the editor status to its paired text format status.
 */
function editor_filter_format_presave(FilterFormatInterface $format) {
  // The text format being created cannot have a text editor yet.
  if ($format->isNew()) {
    return;
  }

  /** @var \Drupal\filter\FilterFormatInterface $original */
  $original = \Drupal::entityManager()
    ->getStorage('filter_format')
    ->loadUnchanged($format->getOriginalId());

  // If the text format status is the same, return early.
  if (($status = $format->status()) === $original->status()) {
    return;
  }

  /** @var \Drupal\editor\EditorInterface $editor */
  if ($editor = Editor::load($format->id())) {
    $editor->setStatus($status)->save();
  }
}