Chris@0: <?php
Chris@0: 
Chris@0: /**
Chris@0:  * @file
Chris@0:  * Post update functions for Views.
Chris@0:  */
Chris@0: 
Chris@17: use Drupal\Core\Config\Entity\ConfigEntityUpdater;
Chris@0: use Drupal\Core\StringTranslation\TranslatableMarkup;
Chris@0: use Drupal\views\Entity\View;
Chris@14: use Drupal\views\Plugin\views\filter\NumericFilter;
Chris@14: use Drupal\views\Plugin\views\filter\StringFilter;
Chris@0: use Drupal\views\Views;
Chris@0: 
Chris@0: /**
Chris@0:  * Update the cacheability metadata for all views.
Chris@0:  */
Chris@0: function views_post_update_update_cacheability_metadata() {
Chris@0:   // Load all views.
Chris@0:   $views = \Drupal::entityManager()->getStorage('view')->loadMultiple();
Chris@0: 
Chris@0:   /* @var \Drupal\views\Entity\View[] $views */
Chris@0:   foreach ($views as $view) {
Chris@0:     $displays = $view->get('display');
Chris@0:     foreach (array_keys($displays) as $display_id) {
Chris@0:       $display =& $view->getDisplay($display_id);
Chris@0:       // Unset the cache_metadata key, so all cacheability metadata for the
Chris@0:       // display is recalculated.
Chris@0:       unset($display['cache_metadata']);
Chris@0:     }
Chris@0:     $view->save();
Chris@0:   }
Chris@0: 
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Update some views fields that were previously duplicated.
Chris@0:  */
Chris@0: function views_post_update_cleanup_duplicate_views_data() {
Chris@0:   $config_factory = \Drupal::configFactory();
Chris@0:   $ids = [];
Chris@0:   $message = NULL;
Chris@0:   $data_tables = [];
Chris@0:   $base_tables = [];
Chris@0:   $revision_tables = [];
Chris@0:   $entities_by_table = [];
Chris@0:   $duplicate_fields = [];
Chris@0:   $handler_types = Views::getHandlerTypes();
Chris@0: 
Chris@0:   /** @var \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager */
Chris@0:   $entity_type_manager = \Drupal::service('entity_type.manager');
Chris@0:   // This will allow us to create an index of all entity types of the site.
Chris@0:   foreach ($entity_type_manager->getDefinitions() as $entity_type_id => $entity_type) {
Chris@0:     // Store the entity keyed by base table. If it has a data table, use that as
Chris@0:     // well.
Chris@0:     if ($data_table = $entity_type->getDataTable()) {
Chris@0:       $entities_by_table[$data_table] = $entity_type;
Chris@0:     }
Chris@0:     if ($base_table = $entity_type->getBaseTable()) {
Chris@0:       $entities_by_table[$base_table] = $entity_type;
Chris@0:     }
Chris@0: 
Chris@0:     // The following code basically contains the same kind of logic as
Chris@0:     // \Drupal\Core\Entity\Sql\SqlContentEntityStorage::initTableLayout() to
Chris@0:     // prefetch all tables (base, data, revision, and revision data).
Chris@0:     $base_tables[$entity_type_id] = $entity_type->getBaseTable() ?: $entity_type->id();
Chris@0:     $revisionable = $entity_type->isRevisionable();
Chris@0: 
Chris@0:     $revision_table = '';
Chris@0:     if ($revisionable) {
Chris@0:       $revision_table = $entity_type->getRevisionTable() ?: $entity_type->id() . '_revision';
Chris@0:     }
Chris@0:     $revision_tables[$entity_type_id] = $revision_table;
Chris@0: 
Chris@0:     $translatable = $entity_type->isTranslatable();
Chris@0:     $data_table = '';
Chris@0:     // For example the data table just exists, when the entity type is
Chris@0:     // translatable.
Chris@0:     if ($translatable) {
Chris@0:       $data_table = $entity_type->getDataTable() ?: $entity_type->id() . '_field_data';
Chris@0:     }
Chris@0:     $data_tables[$entity_type_id] = $data_table;
Chris@0: 
Chris@0:     $duplicate_fields[$entity_type_id] = array_intersect_key($entity_type->getKeys(), array_flip(['id', 'revision', 'bundle']));
Chris@0:   }
Chris@0: 
Chris@0:   foreach ($config_factory->listAll('views.view.') as $view_config_name) {
Chris@0:     $changed = FALSE;
Chris@0:     $view = $config_factory->getEditable($view_config_name);
Chris@0: 
Chris@0:     $displays = $view->get('display');
Chris@0:     if (isset($entities_by_table[$view->get('base_table')])) {
Chris@0:       $entity_type = $entities_by_table[$view->get('base_table')];
Chris@0:       $entity_type_id = $entity_type->id();
Chris@0:       $data_table = $data_tables[$entity_type_id];
Chris@0:       $base_table = $base_tables[$entity_type_id];
Chris@0:       $revision_table = $revision_tables[$entity_type_id];
Chris@0: 
Chris@0:       if ($data_table) {
Chris@0:         foreach ($displays as $display_name => &$display) {
Chris@0:           foreach ($handler_types as $handler_type) {
Chris@0:             if (!empty($display['display_options'][$handler_type['plural']])) {
Chris@0:               foreach ($display['display_options'][$handler_type['plural']] as $field_name => &$field) {
Chris@0:                 $table = $field['table'];
Chris@0:                 if (($table === $base_table || $table === $revision_table) && in_array($field_name, $duplicate_fields[$entity_type_id])) {
Chris@0:                   $field['table'] = $data_table;
Chris@0:                   $changed = TRUE;
Chris@0:                 }
Chris@0:               }
Chris@0:             }
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0: 
Chris@0:     if ($changed) {
Chris@0:       $view->set('display', $displays);
Chris@0:       $view->save();
Chris@0:       $ids[] = $view->get('id');
Chris@0:     }
Chris@0:   }
Chris@0:   if (!empty($ids)) {
Chris@0:     $message = new TranslatableMarkup('Updated tables for field handlers for views: @ids', ['@ids' => implode(', ', array_unique($ids))]);
Chris@0:   }
Chris@0: 
Chris@0:   return $message;
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Include field formatter dependencies in a view when the formatter is used.
Chris@0:  */
Chris@0: function views_post_update_field_formatter_dependencies() {
Chris@0:   $views = View::loadMultiple();
Chris@0:   array_walk($views, function (View $view) {
Chris@0:     $view->save();
Chris@0:   });
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Fix views with dependencies on taxonomy terms that don't exist.
Chris@0:  */
Chris@0: function views_post_update_taxonomy_index_tid() {
Chris@0:   $views = View::loadMultiple();
Chris@0:   array_walk($views, function (View $view) {
Chris@0:     $old_dependencies = $view->getDependencies();
Chris@0:     $new_dependencies = $view->calculateDependencies()->getDependencies();
Chris@0:     if ($old_dependencies !== $new_dependencies) {
Chris@0:       $view->save();
Chris@0:     }
Chris@0:   });
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Fix views with serializer dependencies.
Chris@0:  */
Chris@0: function views_post_update_serializer_dependencies() {
Chris@0:   $views = View::loadMultiple();
Chris@0:   array_walk($views, function (View $view) {
Chris@0:     $old_dependencies = $view->getDependencies();
Chris@0:     $new_dependencies = $view->calculateDependencies()->getDependencies();
Chris@0:     if ($old_dependencies !== $new_dependencies) {
Chris@0:       $view->save();
Chris@0:     }
Chris@0:   });
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Set all boolean filter values to strings.
Chris@0:  */
Chris@0: function views_post_update_boolean_filter_values() {
Chris@0:   $config_factory = \Drupal::configFactory();
Chris@0:   foreach ($config_factory->listAll('views.view.') as $view_config_name) {
Chris@0:     $view = $config_factory->getEditable($view_config_name);
Chris@0:     $save = FALSE;
Chris@0:     foreach ($view->get('display') as $display_name => $display) {
Chris@0:       if (isset($display['display_options']['filters'])) {
Chris@0:         foreach ($display['display_options']['filters'] as $filter_name => $filter) {
Chris@0:           if (isset($filter['plugin_id']) && $filter['plugin_id'] === 'boolean') {
Chris@0:             $new_value = FALSE;
Chris@0:             // Update all boolean and integer values to strings.
Chris@0:             if ($filter['value'] === TRUE || $filter['value'] === 1) {
Chris@0:               $new_value = '1';
Chris@0:             }
Chris@0:             elseif ($filter['value'] === FALSE || $filter['value'] === 0) {
Chris@0:               $new_value = '0';
Chris@0:             }
Chris@0:             if ($new_value !== FALSE) {
Chris@0:               $view->set("display.$display_name.display_options.filters.$filter_name.value", $new_value);
Chris@0:               $save = TRUE;
Chris@0:             }
Chris@0:           }
Chris@0:         }
Chris@0:       }
Chris@0:     }
Chris@0:     if ($save) {
Chris@0:       $view->save();
Chris@0:     }
Chris@0:   }
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Rebuild caches to ensure schema changes are read in.
Chris@0:  */
Chris@0: function views_post_update_grouped_filters() {
Chris@0:   // Empty update to cause a cache rebuild so that the schema changes are read.
Chris@0: }
Chris@0: 
Chris@0: /**
Chris@0:  * Fix table names for revision metadata fields.
Chris@16:  *
Chris@16:  * @see https://www.drupal.org/node/2831499
Chris@0:  */
Chris@0: function views_post_update_revision_metadata_fields() {
Chris@0:   // The table names are fixed automatically in
Chris@0:   // \Drupal\views\Entity\View::preSave(), so we just need to re-save all views.
Chris@0:   $views = View::loadMultiple();
Chris@0:   array_walk($views, function (View $view) {
Chris@0:     $view->save();
Chris@0:   });
Chris@0: }
Chris@14: 
Chris@14: /**
Chris@14:  * Add additional settings to the entity link field and convert node_path usage
Chris@14:  * to entity_link.
Chris@14:  */
Chris@14: function views_post_update_entity_link_url() {
Chris@14:   // Load all views.
Chris@14:   $views = \Drupal::entityTypeManager()->getStorage('view')->loadMultiple();
Chris@14: 
Chris@14:   /* @var \Drupal\views\Entity\View[] $views */
Chris@14:   foreach ($views as $view) {
Chris@14:     $displays = $view->get('display');
Chris@14:     $changed = FALSE;
Chris@14:     foreach ($displays as $display_name => &$display) {
Chris@14:       if (isset($display['display_options']['fields'])) {
Chris@14:         foreach ($display['display_options']['fields'] as $field_name => &$field) {
Chris@14:           if (isset($field['plugin_id']) && $field['plugin_id'] === 'entity_link') {
Chris@14:             // Add any missing settings for entity_link.
Chris@14:             if (!isset($field['output_url_as_text'])) {
Chris@14:               $field['output_url_as_text'] = FALSE;
Chris@14:               $changed = TRUE;
Chris@14:             }
Chris@14:             if (!isset($field['absolute'])) {
Chris@14:               $field['absolute'] = FALSE;
Chris@14:               $changed = TRUE;
Chris@14:             }
Chris@14:           }
Chris@14:           elseif (isset($field['plugin_id']) && $field['plugin_id'] === 'node_path') {
Chris@14:             // Convert the use of node_path to entity_link.
Chris@14:             $field['plugin_id'] = 'entity_link';
Chris@14:             $field['field'] = 'view_node';
Chris@14:             $field['output_url_as_text'] = TRUE;
Chris@14:             $changed = TRUE;
Chris@14:           }
Chris@14:         }
Chris@14:       }
Chris@14:     }
Chris@14:     if ($changed) {
Chris@14:       $view->set('display', $displays);
Chris@14:       $view->save();
Chris@14:     }
Chris@14:   }
Chris@14: }
Chris@14: 
Chris@14: /**
Chris@14:  * Update dependencies for moved bulk field plugin.
Chris@14:  */
Chris@14: function views_post_update_bulk_field_moved() {
Chris@14:   $views = View::loadMultiple();
Chris@14:   array_walk($views, function (View $view) {
Chris@14:     $old_dependencies = $view->getDependencies();
Chris@14:     $new_dependencies = $view->calculateDependencies()->getDependencies();
Chris@14:     if ($old_dependencies !== $new_dependencies) {
Chris@14:       $view->save();
Chris@14:     }
Chris@14:   });
Chris@14: }
Chris@14: 
Chris@14: /**
Chris@14:  * Add placeholder settings to string or numeric filters.
Chris@14:  */
Chris@14: function views_post_update_filter_placeholder_text() {
Chris@14:   // Load all views.
Chris@14:   $views = \Drupal::entityTypeManager()->getStorage('view')->loadMultiple();
Chris@14:   /** @var \Drupal\views\Plugin\ViewsHandlerManager $filter_manager */
Chris@14:   $filter_manager = \Drupal::service('plugin.manager.views.filter');
Chris@14: 
Chris@14:   /* @var \Drupal\views\Entity\View[] $views */
Chris@14:   foreach ($views as $view) {
Chris@14:     $displays = $view->get('display');
Chris@14:     $save = FALSE;
Chris@14:     foreach ($displays as $display_name => &$display) {
Chris@14:       if (isset($display['display_options']['filters'])) {
Chris@14:         foreach ($display['display_options']['filters'] as $filter_name => &$filter) {
Chris@14:           // Any of the children of the modified classes will also be inheriting
Chris@14:           // the new settings.
Chris@14:           $filter_instance = $filter_manager->getHandler($filter);
Chris@14:           if ($filter_instance instanceof StringFilter) {
Chris@14:             if (!isset($filter['expose']['placeholder'])) {
Chris@14:               $filter['expose']['placeholder'] = '';
Chris@14:               $save = TRUE;
Chris@14:             }
Chris@14:           }
Chris@14:           elseif ($filter_instance instanceof NumericFilter) {
Chris@14:             if (!isset($filter['expose']['placeholder'])) {
Chris@14:               $filter['expose']['placeholder'] = '';
Chris@14:               $save = TRUE;
Chris@14:             }
Chris@14:             if (!isset($filter['expose']['min_placeholder'])) {
Chris@14:               $filter['expose']['min_placeholder'] = '';
Chris@14:               $save = TRUE;
Chris@14:             }
Chris@14:             if (!isset($filter['expose']['max_placeholder'])) {
Chris@14:               $filter['expose']['max_placeholder'] = '';
Chris@14:               $save = TRUE;
Chris@14:             }
Chris@14:           }
Chris@14:         }
Chris@14:       }
Chris@14:     }
Chris@14:     if ($save) {
Chris@14:       $view->set('display', $displays);
Chris@14:       $view->save();
Chris@14:     }
Chris@14:   }
Chris@14: }
Chris@14: 
Chris@14: /**
Chris@14:  * Include views data table provider in views dependencies.
Chris@14:  */
Chris@14: function views_post_update_views_data_table_dependencies(&$sandbox = NULL) {
Chris@14:   $storage = \Drupal::entityTypeManager()->getStorage('view');
Chris@14:   if (!isset($sandbox['views'])) {
Chris@14:     $sandbox['views'] = $storage->getQuery()->accessCheck(FALSE)->execute();
Chris@14:     $sandbox['count'] = count($sandbox['views']);
Chris@14:   }
Chris@14: 
Chris@14:   // Process 10 views at a time.
Chris@14:   $views = $storage->loadMultiple(array_splice($sandbox['views'], 0, 10));
Chris@14:   foreach ($views as $view) {
Chris@14:     $original_dependencies = $view->getDependencies();
Chris@14:     // Only re-save if dependencies have changed.
Chris@14:     if ($view->calculateDependencies()->getDependencies() !== $original_dependencies) {
Chris@14:       // We can trust the data because we've already recalculated the
Chris@14:       // dependencies.
Chris@14:       $view->trustData();
Chris@14:       $view->save();
Chris@14:     }
Chris@14:   }
Chris@14: 
Chris@14:   $sandbox['#finished'] = empty($sandbox['views']) ? 1 : ($sandbox['count'] - count($sandbox['views'])) / $sandbox['count'];
Chris@14: }
Chris@14: 
Chris@14: /**
Chris@14:  * Fix cache max age for table displays.
Chris@14:  */
Chris@14: function views_post_update_table_display_cache_max_age(&$sandbox = NULL) {
Chris@17:   \Drupal::classResolver(ConfigEntityUpdater::class)->update($sandbox, 'view', function ($view) {
Chris@17:     /** @var \Drupal\views\ViewEntityInterface $view */
Chris@17:     $displays = $view->get('display');
Chris@17:     foreach ($displays as $display_name => &$display) {
Chris@17:       if (isset($display['display_options']['style']['type']) && $display['display_options']['style']['type'] === 'table') {
Chris@17:         return TRUE;
Chris@14:       }
Chris@14:     }
Chris@17:     return FALSE;
Chris@17:   });
Chris@14: }
Chris@18: 
Chris@18: /**
Chris@18:  * Update exposed filter blocks label display to be disabled.
Chris@18:  */
Chris@18: function views_post_update_exposed_filter_blocks_label_display(&$sandbox = NULL) {
Chris@18:   \Drupal::classResolver(ConfigEntityUpdater::class)->update($sandbox, 'block', function ($block) {
Chris@18:     /** @var \Drupal\block\BlockInterface $block */
Chris@18:     if (strpos($block->getPluginId(), 'views_exposed_filter_block:') === 0) {
Chris@18:       $block->getPlugin()->setConfigurationValue('label_display', '0');
Chris@18:       return TRUE;
Chris@18:     }
Chris@18: 
Chris@18:     return FALSE;
Chris@18:   });
Chris@18: }
Chris@18: 
Chris@18: /**
Chris@18:  * Rebuild cache to allow placeholder texts to be translatable.
Chris@18:  */
Chris@18: function views_post_update_make_placeholders_translatable() {
Chris@18:   // Empty update to cause a cache rebuild to allow placeholder texts to be
Chris@18:   // translatable.
Chris@18: }