comparison core/modules/media_library/media_library.module @ 5:12f9dff5fda9 tip

Update to Drupal core 8.7.1

  * @file
  * Contains hook implementations for the media_library module.
  */
 
 use Drupal\Component\Utility\UrlHelper;
-use Drupal\Component\Serialization\Json;
+use Drupal\Core\Access\AccessResult;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\Entity\EntityFormDisplay;
+use Drupal\Core\Entity\Entity\EntityViewDisplay;
 use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Render\Element;
 use Drupal\Core\Routing\RouteMatchInterface;
+use Drupal\Core\Session\AccountInterface;
 use Drupal\Core\Template\Attribute;
-use Drupal\Core\Url;
+use Drupal\image\Entity\ImageStyle;
+use Drupal\image\Plugin\Field\FieldType\ImageItem;
+use Drupal\media\MediaTypeForm;
+use Drupal\media\MediaTypeInterface;
+use Drupal\media_library\Form\FileUploadForm;
+use Drupal\media_library\Form\OEmbedForm;
+use Drupal\media_library\MediaLibraryState;
 use Drupal\views\Form\ViewsForm;
 use Drupal\views\Plugin\views\cache\CachePluginBase;
-use Drupal\views\Plugin\views\query\QueryPluginBase;
-use Drupal\views\Plugin\views\query\Sql;
 use Drupal\views\ViewExecutable;
 
 /**
  * Implements hook_help().
  *

       return $output;
   }
 }
 
 /**
+ * Implements hook_media_source_info_alter().
+ */
+function media_library_media_source_info_alter(array &$sources) {
+  $sources['audio_file']['forms']['media_library_add'] = FileUploadForm::class;
+  $sources['file']['forms']['media_library_add'] = FileUploadForm::class;
+  $sources['image']['forms']['media_library_add'] = FileUploadForm::class;
+  $sources['video_file']['forms']['media_library_add'] = FileUploadForm::class;
+  $sources['oembed:video']['forms']['media_library_add'] = OEmbedForm::class;
+}
+
+/**
  * Implements hook_theme().
  */
 function media_library_theme() {
   return [
     'media__media_library' => [

     ],
   ];
 }
 
 /**
- * Implements hook_preprocess_view().
- *
- * Adds a link to add media above the view.
- */
-function media_library_preprocess_views_view(&$variables) {
-  $view = $variables['view'];
-  if ($view->id() === 'media_library' && $view->current_display === 'widget') {
-    $url = Url::fromRoute('media_library.upload');
-    if ($url->access()) {
-      $url->setOption('query', \Drupal::request()->query->all());
-      $variables['header']['add_media'] = [
-        '#type' => 'link',
-        '#title' => t('Add media'),
-        '#url' => $url,
-        '#attributes' => [
-          'class' => ['button', 'button-action', 'button--primary', 'use-ajax'],
-          'data-dialog-type' => 'modal',
-          'data-dialog-options' => Json::encode([
-            'dialogClass' => 'media-library-widget-modal',
-            'height' => '75%',
-            'width' => '75%',
-            'title' => t('Add media'),
-          ]),
-        ],
-      ];
-    }
-  }
-}
-
-/**
  * Implements hook_views_post_render().
  */
 function media_library_views_post_render(ViewExecutable $view, &$output, CachePluginBase $cache) {
   if ($view->id() === 'media_library') {
     $output['#attached']['library'][] = 'media_library/view';
-    if ($view->current_display === 'widget') {
-      $query = array_intersect_key(\Drupal::request()->query->all(), array_flip([
-        'media_library_widget_id',
-        'media_library_allowed_types',
-        'media_library_remaining',
-      ]));
+    if (strpos($view->current_display, 'widget') === 0) {
+      $query = MediaLibraryState::fromRequest($view->getRequest())->all();
       // If the current query contains any parameters we use to contextually
       // filter the view, ensure they persist across AJAX rebuilds.
       // The ajax_path is shared for all AJAX views on the page, but our query
       // parameters are prefixed and should not interfere with any other views.
       // @todo Rework or remove this in https://www.drupal.org/node/2983451
       if (!empty($query)) {
         $ajax_path = &$output['#attached']['drupalSettings']['views']['ajax_path'];
         $parsed_url = UrlHelper::parse($ajax_path);
         $query = array_merge($query, $parsed_url['query']);
         $ajax_path = $parsed_url['path'] . '?' . UrlHelper::buildQuery($query);
-        if (isset($query['media_library_remaining'])) {
-          $output['#attached']['drupalSettings']['media_library']['selection_remaining'] = (int) $query['media_library_remaining'];
-        }
       }
     }
   }
 }
 

       $form['header']['media_bulk_form']['#attributes']['class'][] = 'media-library-views-form__bulk_form';
     }
   }
 
   // Add after build to fix media library views exposed filter's submit button.
-  if ($form_id === 'views_exposed_form' && $form['#id'] === 'views-exposed-form-media-library-widget') {
+  if ($form_id === 'views_exposed_form' && strpos($form['#id'], 'views-exposed-form-media-library-widget') === 0) {
     $form['#after_build'][] = '_media_library_views_form_media_library_after_build';
+  }
+
+  // Configures media_library displays when a type is submitted.
+  if ($form_object instanceof MediaTypeForm) {
+    $form['actions']['submit']['#submit'][] = '_media_library_media_type_form_submit';
   }
 }
 
 /**
  * After build callback for views form media library.

   $form['actions']['#attributes']['class'][] = 'media-library-view--form-actions';
   return $form;
 }
 
 /**
- * Implements hook_views_query_alter().
- *
- * Alters the widget view's query to only show media that can be selected,
- * based on what types are allowed in the field settings.
- *
- * @todo Remove in https://www.drupal.org/node/2983454
- */
-function media_library_views_query_alter(ViewExecutable $view, QueryPluginBase $query) {
-  if ($query instanceof Sql && $view->id() === 'media_library' && $view->current_display === 'widget') {
-    $types = _media_library_get_allowed_types();
-    if ($types) {
-      $entity_type = \Drupal::entityTypeManager()->getDefinition('media');
-      $group = $query->setWhereGroup();
-      $query->addWhere($group, $entity_type->getDataTable() . '.' . $entity_type->getKey('bundle'), $types, 'in');
-    }
-  }
-}
-
-/**
- * Implements hook_form_FORM_ID_alter().
- *
- * Limits the types available in the exposed filter to avoid users trying to
- * filter by a type that is un-selectable.
- *
- * @see media_library_views_query_alter()
- *
- * @todo Remove in https://www.drupal.org/node/2983454
- */
-function media_library_form_views_exposed_form_alter(array &$form, FormStateInterface $form_state) {
-  if (isset($form['#id']) && $form['#id'] === 'views-exposed-form-media-library-widget') {
-    $types = _media_library_get_allowed_types();
-    if ($types && isset($form['type']['#options'])) {
-      $keys = array_flip($types);
-      // Ensure that the default value (by default "All") persists.
-      if (isset($form['type']['#default_value'])) {
-        $keys[$form['type']['#default_value']] = TRUE;
-      }
-      $form['type']['#options'] = array_intersect_key($form['type']['#options'], $keys);
+ * Submit callback for media type form.
+ */
+function _media_library_media_type_form_submit(array &$form, FormStateInterface $form_state) {
+  $form_object = $form_state->getFormObject();
+  if ($form_object->getOperation() === 'add') {
+    $type = $form_object->getEntity();
+    $form_display_created = _media_library_configure_form_display($type);
+    $view_display_created = _media_library_configure_view_display($type);
+    if ($form_display_created || $view_display_created) {
+      \Drupal::messenger()->addStatus(t('Media Library form and view displays have been created for the %type media type.', [
+        '%type' => $type->label(),
+      ]));
     }
   }
 }
 
 /**

     }
   }
 }
 
 /**
- * Determines what types are allowed based on the current request.
- *
- * @return array
- *   An array of allowed types.
- */
-function _media_library_get_allowed_types() {
-  $types = \Drupal::request()->query->get('media_library_allowed_types');
-  if ($types && is_array($types)) {
-    return array_filter($types, 'is_string');
-  }
-  return [];
-}
+ * Implements hook_ENTITY_TYPE_access().
+ */
+function media_library_image_style_access(EntityInterface $entity, $operation, AccountInterface $account) {
+  // Prevent the fallback 'media_library' image style from being deleted.
+  // @todo: Lock the image style instead of preventing delete access.
+  //   https://www.drupal.org/project/drupal/issues/2247293
+  if ($operation === 'delete' && $entity->id() === 'media_library') {
+    return AccessResult::forbidden();
+  }
+}
+
+/**
+ * Ensures that the given media type has a media_library form display.
+ *
+ * @param \Drupal\media\MediaTypeInterface $type
+ *   The media type to configure.
+ *
+ * @return bool
+ *   Whether a form display has been created or not.
+ *
+ * @throws \Drupal\Core\Entity\EntityStorageException
+ */
+function _media_library_configure_form_display(MediaTypeInterface $type) {
+  $display = EntityFormDisplay::load('media.' . $type->id() . '.media_library');
+
+  if ($display) {
+    return FALSE;
+  }
+
+  $values = [
+    'targetEntityType' => 'media',
+    'bundle' => $type->id(),
+    'mode' => 'media_library',
+    'status' => TRUE,
+  ];
+  $display = EntityFormDisplay::create($values);
+  // Remove all default components.
+  foreach (array_keys($display->getComponents()) as $name) {
+    $display->removeComponent($name);
+  }
+  // Expose the name field when it is not mapped.
+  $field_map = $type->getFieldMap();
+  if (empty($field_map['name'])) {
+    $display->setComponent('name', [
+      'type' => 'string_textfield',
+      'settings' => [
+        'size' => 60,
+      ],
+    ]);
+  }
+  // If the source field is an image field, expose it so that users can set alt
+  // and title text.
+  $source_field = $type->getSource()->getSourceFieldDefinition($type);
+  if ($source_field->isDisplayConfigurable('form') && is_a($source_field->getItemDefinition()->getClass(), ImageItem::class, TRUE)) {
+    $type->getSource()->prepareFormDisplay($type, $display);
+  }
+  return (bool) $display->save();
+}
+
+/**
+ * Ensures that the given media type has a media_library view display.
+ *
+ * @param \Drupal\media\MediaTypeInterface $type
+ *   The media type to configure.
+ *
+ * @return bool
+ *   Whether a view display has been created or not.
+ *
+ * @throws \Drupal\Core\Entity\EntityStorageException
+ */
+function _media_library_configure_view_display(MediaTypeInterface $type) {
+  $display = EntityViewDisplay::load('media.' . $type->id() . '.media_library');
+
+  if ($display) {
+    return FALSE;
+  }
+
+  $values = [
+    'targetEntityType' => 'media',
+    'bundle' => $type->id(),
+    'mode' => 'media_library',
+    'status' => TRUE,
+  ];
+  $display = EntityViewDisplay::create($values);
+  // Remove all default components.
+  foreach (array_keys($display->getComponents()) as $name) {
+    $display->removeComponent($name);
+  }
+
+  // @todo: Remove dependency on 'medium' and 'thumbnail' image styles from
+  //   media and media library modules.
+  //   https://www.drupal.org/project/drupal/issues/3030437
+  $image_style = ImageStyle::load('medium');
+
+  // Expose the thumbnail component. If the medium image style doesn't exist,
+  // use the fallback 'media_library' image style.
+  $display->setComponent('thumbnail', [
+    'type' => 'image',
+    'label' => 'hidden',
+    'settings' => [
+      'image_style' => $image_style ? $image_style->id() : 'media_library',
+      'image_link' => '',
+    ],
+  ]);
+  return (bool) $display->save();
+}