Chris@14: <?php
Chris@14: 
Chris@14: namespace Drupal\migrate_drupal;
Chris@14: 
Chris@14: use Drupal\Core\Cache\CacheBackendInterface;
Chris@14: use Drupal\Core\Config\ConfigFactoryInterface;
Chris@14: use Drupal\Core\Extension\ModuleHandlerInterface;
Chris@14: use Drupal\Core\Language\LanguageManagerInterface;
Chris@14: use Drupal\migrate\Plugin\Exception\BadPluginDefinitionException;
Chris@14: use Drupal\migrate\Plugin\MigrateSourcePluginManager;
Chris@14: use Drupal\migrate\Plugin\MigrationPluginManager as BaseMigrationPluginManager;
Chris@14: 
Chris@14: /**
Chris@14:  * Manages migration plugins.
Chris@14:  *
Chris@14:  * Analyzes migration definitions to ensure that the source plugin of any
Chris@14:  * migration tagged with particular tags ('Drupal 6' or 'Drupal 7' by default)
Chris@14:  * defines a source_module property in its plugin annotation. This is done in
Chris@14:  * order to support the Migrate Drupal UI, which needs to know which modules
Chris@14:  * "own" the data being migrated into Drupal 8, on both the source and
Chris@14:  * destination sides.
Chris@14:  *
Chris@14:  * @todo Enforce the destination_module property too, in
Chris@14:  * https://www.drupal.org/project/drupal/issues/2923810.
Chris@14:  */
Chris@14: class MigrationPluginManager extends BaseMigrationPluginManager {
Chris@14: 
Chris@14:   /**
Chris@14:    * The Migrate source plugin manager service.
Chris@14:    *
Chris@14:    * @var \Drupal\migrate\Plugin\MigrateSourcePluginManager
Chris@14:    */
Chris@14:   protected $sourceManager;
Chris@14: 
Chris@14:   /**
Chris@14:    * The config factory service.
Chris@14:    *
Chris@14:    * @var \Drupal\Core\Config\ConfigFactoryInterface
Chris@14:    */
Chris@14:   protected $configFactory;
Chris@14: 
Chris@14:   /**
Chris@14:    * The migration tags which will trigger source_module enforcement.
Chris@14:    *
Chris@14:    * @var string[]
Chris@14:    */
Chris@14:   protected $enforcedSourceModuleTags;
Chris@14: 
Chris@14:   /**
Chris@14:    * MigrationPluginManager constructor.
Chris@14:    *
Chris@14:    * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
Chris@14:    *   The module handler service.
Chris@14:    * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
Chris@14:    *   The cache backend.
Chris@14:    * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
Chris@14:    *   The language manager service.
Chris@14:    * @param \Drupal\migrate\Plugin\MigrateSourcePluginManager $source_manager
Chris@14:    *   The Migrate source plugin manager service.
Chris@14:    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
Chris@14:    *   The config factory service.
Chris@14:    */
Chris@14:   public function __construct(ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, MigrateSourcePluginManager $source_manager, ConfigFactoryInterface $config_factory) {
Chris@14:     parent::__construct($module_handler, $cache_backend, $language_manager);
Chris@14:     $this->sourceManager = $source_manager;
Chris@14:     $this->configFactory = $config_factory;
Chris@14:   }
Chris@14: 
Chris@14:   /**
Chris@14:    * Returns the migration tags that trigger source_module enforcement.
Chris@14:    *
Chris@14:    * @return string[]
Chris@14:    */
Chris@14:   protected function getEnforcedSourceModuleTags() {
Chris@14:     if ($this->enforcedSourceModuleTags === NULL) {
Chris@14:       $this->enforcedSourceModuleTags = $this->configFactory
Chris@14:         ->get('migrate_drupal.settings')
Chris@14:         ->get('enforce_source_module_tags') ?: [];
Chris@14:     }
Chris@14:     return $this->enforcedSourceModuleTags;
Chris@14:   }
Chris@14: 
Chris@14:   /**
Chris@14:    * {@inheritdoc}
Chris@14:    */
Chris@14:   public function processDefinition(&$definition, $plugin_id) {
Chris@14:     parent::processDefinition($definition, $plugin_id);
Chris@14: 
Chris@14:     // If the migration has no tags, we don't need to enforce the source_module
Chris@14:     // annotation property.
Chris@14:     if (empty($definition['migration_tags'])) {
Chris@14:       return;
Chris@14:     }
Chris@14: 
Chris@14:     // Check if the migration has any of the tags that trigger source_module
Chris@14:     // enforcement.
Chris@14:     $applied_tags = array_intersect($this->getEnforcedSourceModuleTags(), $definition['migration_tags']);
Chris@14:     if ($applied_tags) {
Chris@14:       // Throw an exception if the source plugin definition does not define a
Chris@14:       // source_module.
Chris@14:       $source_id = $definition['source']['plugin'];
Chris@14:       $source_definition = $this->sourceManager->getDefinition($source_id);
Chris@14:       if (empty($source_definition['source_module'])) {
Chris@14:         throw new BadPluginDefinitionException($source_id, 'source_module');
Chris@14:       }
Chris@14:     }
Chris@14:   }
Chris@14: 
Chris@14: }