123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148 |
- <?php
- namespace Drupal\features\Plugin\FeaturesAssignment;
- use Drupal\features\FeaturesAssignmentMethodBase;
- /**
- * Class for excluding configuration from packages.
- *
- * @Plugin(
- * id = "exclude",
- * weight = -5,
- * name = @Translation("Exclude"),
- * description = @Translation("Exclude configuration items from packaging by various methods including by configuration type."),
- * config_route_name = "features.assignment_exclude",
- * default_settings = {
- * "curated" = FALSE,
- * "module" = {
- * "installed" = FALSE,
- * "profile" = FALSE,
- * "namespace" = FALSE,
- * "namespace_any" = FALSE,
- * },
- * "types" = { "config" = {} }
- * }
- * )
- */
- class FeaturesAssignmentExclude extends FeaturesAssignmentMethodBase {
- /**
- * {@inheritdoc}
- */
- public function assignPackages($force = FALSE) {
- $current_bundle = $this->assigner->getBundle();
- $settings = $current_bundle->getAssignmentSettings($this->getPluginId());
- $config_collection = $this->featuresManager->getConfigCollection();
- // Exclude by configuration type.
- $exclude_types = $settings['types']['config'];
- if (!empty($exclude_types)) {
- foreach ($config_collection as $item_name => $item) {
- // Don't exclude already-assigned items.
- if (empty($item->getPackage()) && in_array($item->getType(), $exclude_types)) {
- $item->setExcluded(TRUE);
- }
- }
- }
- // Exclude configuration already provided by modules.
- $exclude_module = $settings['module'];
- if (!empty($exclude_module['installed'])) {
- $install_list = $this->featuresManager->getExtensionStorages()->listAll();
- // There are two settings that can limit what's included.
- // First, we can skip configuration provided by the install profile.
- $module_profile = !empty($exclude_module['profile']);
- // Second, we can skip configuration provided by namespaced modules.
- $module_namespace = !empty($exclude_module['namespace']);
- if ($module_profile || $module_namespace) {
- $profile_list = [];
- $extension_list = [];
- // Load the names of any configuration objects provided by the install
- // profile.
- if ($module_profile) {
- $all_modules = $this->featuresManager->getAllModules();
- // FeaturesBundleInterface::getProfileName() would return the profile
- // for the current bundle, if any. We want the profile that was
- // installed.
- $profile_name = drupal_get_profile();
- if (isset($all_modules[$profile_name])) {
- $profile_list = $this->featuresManager->listExtensionConfig($all_modules[$profile_name]);
- // If the configuration has been assigned to a feature that's
- // present on the file system, don't make an exception for it.
- foreach ($all_modules as $name => $extension) {
- if ($name != $profile_name && $this->featuresManager->isFeatureModule($extension)) {
- $profile_list = array_diff($profile_list, $this->featuresManager->listExtensionConfig($extension));
- }
- }
- }
- }
- // Load the names of any configuration objects provided by modules
- // having the namespace of the current package set.
- if ($module_namespace) {
- $modules = $this->featuresManager->getFeaturesModules($current_bundle);
- foreach ($modules as $extension) {
- // Only make exception for non-exported modules
- if (!empty($exclude_module['namespace_any']) || !isset($all_modules[$extension->getName()])) {
- $extension_list = array_merge($extension_list, $this->featuresManager->listExtensionConfig($extension));
- }
- }
- }
- // If any configuration was found, remove it from the list.
- $install_list = array_diff($install_list, $profile_list, $extension_list);
- }
- foreach ($install_list as $item_name) {
- if (isset($config_collection[$item_name])) {
- // Flag extension-provided configuration, which should not be added
- // to regular features but can be added to an install profile.
- $config_collection[$item_name]->setProviderExcluded(TRUE);
- }
- }
- }
- // Exclude configuration items on a curated list of site-specific
- // configuration.
- if ($settings['curated']) {
- $item_names = [
- 'core.extension',
- 'field.settings',
- 'field_ui.settings',
- 'filter.settings',
- 'forum.settings',
- 'image.settings',
- 'node.settings',
- 'system.authorize',
- 'system.date',
- 'system.file',
- 'system.diff',
- 'system.logging',
- 'system.maintenance',
- 'system.performance',
- 'system.site',
- 'update.settings',
- ];
- foreach ($item_names as $item_name) {
- unset($config_collection[$item_name]);
- }
- // Unset role-related actions that are automatically created by the
- // User module.
- // @see user_user_role_insert()
- $prefixes = [
- 'system.action.user_add_role_action.',
- 'system.action.user_remove_role_action.',
- ];
- foreach (array_keys($config_collection) as $item_name) {
- foreach ($prefixes as $prefix) {
- if (strpos($item_name, $prefix) === 0) {
- unset($config_collection[$item_name]);
- }
- }
- }
- }
- // Register the updated data.
- $this->featuresManager->setConfigCollection($config_collection);
- }
- }
|