View source
<?php
namespace Drupal\varbase\Config;
use Symfony\Component\Yaml\Yaml;
use Drupal\Core\Config\Config;
use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Config\ConfigManagerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Database\Connection;
use Drupal\Core\DependencyInjection\ContainerInjectionInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Utility\DiffArray;
use Drupal\Core\Plugin\CachedDiscoveryClearerInterface;
class ConfigBit implements EventSubscriberInterface, ContainerInjectionInterface {
protected $configFactory;
protected $configManager;
protected $moduleHandler;
protected $database;
protected $pluginCacheClearer;
public function __construct(ConfigFactoryInterface $config_factory, ConfigManagerInterface $config_manager, ModuleHandlerInterface $module_handler, Connection $database, CachedDiscoveryClearerInterface $plugin_cache_clearer) {
$this->configFactory = $config_factory;
$this->configManager = $config_manager;
$this->moduleHandler = $module_handler;
$this->database = $database;
$this->pluginCacheClearer = $plugin_cache_clearer;
}
public static function create(ContainerInterface $container) {
return new static($container
->get('config.factory'), $container
->get('config.manager'), $container
->get('module_handler'), $container
->get('database'), $container
->get('plugin.cache_clearer'));
}
protected static function supportedConfigTypes() {
return [
'node.type' => [
'config_name_match' => "/^node.type.*\$/",
'token' => 'CONTENT_TYPE',
'token_variant' => 'type',
'config_template_file' => 'node.type.CONTENT_TYPE.bit.yml',
'targetEntityType' => 'node',
'plugin.cache_clearer' => TRUE,
],
'core.entity_form_display.node.CONTENT_TYPE.default' => [
'config_name_match' => "/^core.entity_form_display.node.*.default\$/",
'token' => 'CONTENT_TYPE',
'token_variant' => 'bundle',
'config_template_file' => 'core.entity_form_display.node.CONTENT_TYPE.default.bit.yml',
'targetEntityType' => 'node',
'mode' => 'default',
'plugin.cache_clearer' => TRUE,
],
'entityqueue.entity_queue.ENTITYQUEUE_NAME' => [
'config_name_match' => "/^entityqueue.entity_queue.*\$/",
'token' => 'ENTITYQUEUE_NAME',
'token_variant' => 'id',
'config_template_file' => 'entityqueue.entity_queue.ENTITYQUEUE_NAME.bit.yml',
'targetEntityType' => 'entity_subqueue',
],
'core.entity_form_display.entityqueue.entity_queue.ENTITYQUEUE_NAME.default' => [
'config_name_match' => "/^core.entity_form_display.entityqueue.entity_queue.*.default\$/",
'token' => 'ENTITYQUEUE_NAME',
'token_variant' => 'id',
'config_template_file' => 'core.entity_form_display.entityqueue.entity_queue.ENTITYQUEUE_NAME.default.bit.yml',
'targetEntityType' => 'entity_subqueue',
'mode' => 'default',
],
];
}
public static function getSubscribedEvents() {
$events[ConfigEvents::SAVE][] = [
'configSave',
-9000,
];
return $events;
}
public function configSave(ConfigCrudEvent $event) {
$saved_config = $event
->getConfig();
$saved_config_name = $saved_config
->getName();
$supportedConfigTypes = $this
->supportedConfigTypes();
foreach ($supportedConfigTypes as $supportedConfigType) {
if (preg_match($supportedConfigType['config_name_match'], $saved_config_name)) {
$this
->processConfigBits($supportedConfigType, $saved_config);
}
}
}
protected function processConfigBits(array $supportedConfigType, Config $saved_config) {
$saved_config_name = $saved_config
->getName();
$token_variant = $this->configFactory
->getEditable($saved_config_name)
->get($supportedConfigType['token_variant']);
$config_template_file = DRUPAL_ROOT . '/' . drupal_get_path('profile', 'varbase') . '/configbit/varbase_config_templates/' . $supportedConfigType['config_template_file'];
if (file_exists($config_template_file)) {
$config_template_file_contents = file_get_contents($config_template_file);
$config_template_file_contents = str_replace($supportedConfigType['token'], $token_variant, $config_template_file_contents);
$config_template_file_data = (array) Yaml::parse($config_template_file_contents);
if (isset($config_template_file_data['config_bits']) && is_array($config_template_file_data['config_bits'])) {
foreach ($config_template_file_data['config_bits'] as $target_config_bit_name => $target_config_bit_actions) {
$target_config_bit_factory = $this->configFactory
->getEditable($target_config_bit_name);
$save_actions = 0;
if (isset($target_config_bit_actions) && is_array($target_config_bit_actions) && count($target_config_bit_actions) > 0) {
foreach ($target_config_bit_actions as $config_action) {
if (isset($config_action['add']) && $this
->validateDependencies($config_action['add']) && $this
->applyConfigActionAdd($config_action['add'], $target_config_bit_name, $target_config_bit_factory)) {
$save_actions++;
}
if (isset($config_action['remove']) && $this
->validateDependencies($config_action['remove']) && $this
->applyConfigActionRemove($config_action['remove'], $target_config_bit_name, $target_config_bit_factory)) {
$save_actions++;
}
if (isset($config_action['import']) && $this
->validateDependencies($config_action['import']) && $this
->applyConfigActionImport($config_action['import'], $target_config_bit_name, $target_config_bit_factory)) {
$save_actions++;
}
}
if ($save_actions > 0) {
$target_config_bit_factory
->save(TRUE);
if (isset($supportedConfigType['plugin.cache_clearer']) && $supportedConfigType['plugin.cache_clearer'] == TRUE) {
$this->pluginCacheClearer
->clearCachedDefinitions();
}
}
}
}
}
}
}
protected function applyConfigActionAdd(array $config_action, string $target_config_bit_name, Config &$target_config_bit_factory) {
if (isset($config_action['target_config_path']) && isset($config_action['target_config_value'])) {
$target_config_data = $target_config_bit_factory
->get($config_action['target_config_path']);
if (isset($target_config_data) && $this
->expectedTargetConfig($config_action, $target_config_data)) {
$final_config_data = NestedArray::mergeDeep($target_config_data, $config_action['target_config_value']);
$target_config_bit_factory
->set($config_action['target_config_path'], $final_config_data);
return TRUE;
}
}
return FALSE;
}
protected function applyConfigActionRemove(array $config_action, string $target_config_bit_name, Config &$target_config_bit_factory) {
if (isset($config_action['target_config_path']) && is_string($config_action['target_config_path']) && isset($config_action['target_config_remove_index'])) {
$target_config_data = $target_config_bit_factory
->get($config_action['target_config_path']);
if (isset($target_config_data) && $this
->expectedTargetConfig($config_action, $target_config_data)) {
if (isset($target_config_data[$config_action['target_config_remove_index']])) {
unset($target_config_data[$config_action['target_config_remove_index']]);
$target_config_bit_factory
->set($config_action['target_config_path'], $target_config_data);
return TRUE;
}
}
}
return FALSE;
}
protected function applyConfigActionImport(array $config_action, string $target_config_bit_name, Config &$target_config_bit_factory) {
if (!$this
->configExists($target_config_bit_name) && isset($config_action['target_config_value'])) {
$target_config_bit_factory
->setData($config_action['target_config_value']);
return TRUE;
}
return FALSE;
}
protected function validateDependencies(array $config_template_data) {
if (isset($config_template_data['dependencies']) && is_array($config_template_data['dependencies'])) {
$dependencies = $config_template_data['dependencies'];
if (isset($dependencies['module']) && is_array($dependencies['module'])) {
foreach ($dependencies['module'] as $module) {
if (!$this->moduleHandler
->moduleExists($module)) {
return FALSE;
}
}
}
if (isset($dependencies['config']) && is_array($dependencies['config'])) {
$all_config = $this->configFactory
->listAll();
if (!empty($all_config)) {
$missing = [];
$missing = array_merge($missing, array_diff($dependencies['config'], $all_config));
if (!empty($missing) && count($missing) > 0) {
return FALSE;
}
}
}
}
return TRUE;
}
protected function configExists(string $config_name) {
$query = $this->database
->select('config', 'c');
$query
->condition('c.name', $config_name, '=');
$query
->addExpression('COUNT(*)', 'count');
$config_count = $query
->execute()
->fetchField();
if ($config_count == 1) {
return TRUE;
}
return FALSE;
}
protected function expectedTargetConfig(array $config_action, array $target_config_data) {
return $this
->targetConfigExpectedToHave($config_action, $target_config_data) && $this
->targetConfigExpectedNotToHave($config_action, $target_config_data) && $this
->targetConfigExpectedToHaveIndex($config_action, $target_config_data) && $this
->targetConfigExpectedNotToHaveIndex($config_action, $target_config_data);
}
protected function targetConfigExpectedToHave(array $config_action, array $target_config_data) {
$target_config_expected_to_have = TRUE;
if (isset($config_action['target_config_expected_to_have'])) {
if (isset($config_action['expected_config_wild_card'])) {
$wild_card_configs = $this->configFactory
->listAll($config_action['expected_config_wild_card']);
foreach ($wild_card_configs as $wild_card_name) {
$wild_card_factory = $this->configFactory
->getEditable($wild_card_name);
$wild_card_data = $wild_card_factory
->get($config_action['target_config_path']);
$wild_card_expected_to_have_diff = DiffArray::diffAssocRecursive($config_action['target_config_expected_not_to_have'], $wild_card_data);
if (isset($wild_card_expected_to_have_diff) && count($wild_card_expected_to_have_diff) > 0) {
$target_config_expected_to_have = FALSE;
break;
}
}
}
else {
$expected_to_have_diff = DiffArray::diffAssocRecursive($config_action['target_config_expected_to_have'], $target_config_data);
if (isset($expected_to_have_diff) && count($expected_to_have_diff) > 0) {
$target_config_expected_to_have = FALSE;
}
}
}
else {
$target_config_expected_to_have = TRUE;
}
return $target_config_expected_to_have;
}
protected function targetConfigExpectedNotToHave(array $config_action, array $target_config_data) {
$target_config_expected_not_to_have = TRUE;
if (isset($config_action['target_config_expected_not_to_have'])) {
if (isset($config_action['expected_config_wild_card'])) {
$wild_card_configs = $this->configFactory
->listAll($config_action['expected_config_wild_card']);
foreach ($wild_card_configs as $wild_card_name) {
$wild_card_factory = $this->configFactory
->getEditable($wild_card_name);
$wild_card_data = $wild_card_factory
->get($config_action['target_config_path']);
$wild_card_expected_not_to_have_diff = DiffArray::diffAssocRecursive($config_action['target_config_expected_not_to_have'], $wild_card_data);
if (isset($wild_card_expected_not_to_have_diff) && count($wild_card_expected_not_to_have_diff) == 0) {
$target_config_expected_not_to_have = FALSE;
break;
}
}
}
else {
$expected_not_to_have_diff = DiffArray::diffAssocRecursive($config_action['target_config_expected_not_to_have'], $target_config_data);
if (isset($expected_not_to_have_diff) && count($expected_not_to_have_diff) == 0) {
$target_config_expected_not_to_have = FALSE;
}
}
}
return $target_config_expected_not_to_have;
}
protected function targetConfigExpectedToHaveIndex(array $config_action, array $target_config_data) {
if (isset($config_action['target_config_expected_to_have_index'])) {
if (isset($target_config_data[$config_action['target_config_expected_to_have_index']])) {
return TRUE;
}
else {
return FALSE;
}
}
return TRUE;
}
protected function targetConfigExpectedNotToHaveIndex(array $config_action, array $target_config_data) {
if (isset($config_action['target_config_expected_not_to_have_index'])) {
if (!isset($target_config_data[$config_action['target_config_expected_not_to_have_index']])) {
return TRUE;
}
else {
return FALSE;
}
}
return TRUE;
}
public static function getConfigBit($config_bit_file_name, $type = 'profile', $project = 'varbase') {
$full_config_bit_file_name = drupal_get_path($type, $project) . '/' . $config_bit_file_name;
if (file_exists($full_config_bit_file_name)) {
$config_bit_data = (array) Yaml::parse(file_get_contents($full_config_bit_file_name));
if (isset($config_bit_data['config_bit'])) {
return $config_bit_data['config_bit'];
}
else {
return FALSE;
}
}
else {
throw new \Exception('Config bit file does not exist!');
}
}
public static function doWeHaveThisConfigBit($config_bit_file_name, $type = 'profile', $project = 'varbase') {
$full_config_bit_file_name = drupal_get_path($type, $project) . '/' . $config_bit_file_name;
return file_exists($full_config_bit_file_name);
}
public static function getList($config_bit_file_name, $condition_name, $condition_value, $sublist = NULL, $type = 'profile', $project = 'varbase') {
$config_bit_data = ConfigBit::getConfigBit($config_bit_file_name, $type, $project);
if (isset($config_bit_data['type']) && $config_bit_data['type'] == 'list' && isset($config_bit_data['when']) && isset($config_bit_data['when'][$condition_name]) && $config_bit_data['when'][$condition_name] == $condition_value && isset($config_bit_data['when']['list'])) {
if (isset($sublist) && $sublist !== '') {
return $config_bit_data['when']['list'][$sublist];
}
else {
return $config_bit_data['when']['list'];
}
}
else {
return [];
}
}
public static function actionArchiveFiles($config_bit_file_name, $condition_name, $condition_value, $type = 'profile', $project = 'varbase') {
$config_bit_data = ConfigBit::getConfigBit($config_bit_file_name, $type, $project);
if (isset($config_bit_data['type']) && ($config_bit_data['type'] = 'action' && isset($config_bit_data['action']) && isset($config_bit_data['action']['archive_files']) && isset($config_bit_data['action']['archive_files']['when']) && isset($config_bit_data['action']['archive_files']['when'][$condition_name]) && $config_bit_data['action']['archive_files']['when'][$condition_name] == $condition_value && isset($config_bit_data['action']['archive_files']['files']))) {
foreach ($config_bit_data['action']['archive_files']['files'] as $language_config_file) {
$config_file = drupal_get_path($type, $project) . '/' . $language_config_file;
if (file_exists($config_file)) {
$config_file_backup = $config_file . $config_bit_data['action']['archive_files']['archive_extensiton'];
\Drupal::service('file_system')
->move($config_file, $config_file_backup);
}
}
}
}
public static function actionUnArchiveFiles($config_bit_file_name, $condition_name, $condition_value, $type = 'profile', $project = 'varbase') {
$config_bit_data = ConfigBit::getConfigBit($config_bit_file_name, $type, $project);
if (isset($config_bit_data['type']) && ($config_bit_data['type'] = 'action' && isset($config_bit_data['action']) && isset($config_bit_data['action']['unarchive_files']) && isset($config_bit_data['action']['unarchive_files']['when']) && isset($config_bit_data['action']['unarchive_files']['when'][$condition_name]) && $config_bit_data['action']['unarchive_files']['when'][$condition_name] == $condition_value && isset($config_bit_data['action']['unarchive_files']['files']))) {
foreach ($config_bit_data['action']['unarchive_files']['files'] as $language_config_file) {
$config_file = drupal_get_path($type, $project) . '/' . $language_config_file;
$config_file_backup = $config_file . $config_bit_data['action']['unarchive_files']['archive_extensiton'];
if (!file_exists($config_file) && file_exists($config_file_backup)) {
\Drupal::service('file_system')
->move($config_file_backup, $config_file);
}
}
}
}
public static function actionAdd($config_bit_file_name, $condition_name, $condition_value, $target, $type = 'profile', $project = 'varbase') {
$config_bit_data = ConfigBit::getConfigBit($config_bit_file_name, $type, $project);
if (isset($config_bit_data['type']) && $config_bit_data['type'] == 'action' && isset($config_bit_data['for']) && !empty($config_bit_data['for']) && file_exists(drupal_get_path($type, $project) . '/' . $config_bit_data['for']) && isset($config_bit_data['action']) && isset($config_bit_data['action']['add']) && isset($config_bit_data['action']['add']['when']) && isset($config_bit_data['action']['add']['when'][$condition_name]) && $config_bit_data['action']['add']['when'][$condition_name] == $condition_value && isset($config_bit_data['action']['add']['target']) && $config_bit_data['action']['add']['target'] == $target && isset($config_bit_data['action']['add'][$target])) {
$config_target_data = Yaml::parse(file_get_contents(drupal_get_path($type, $project) . '/' . $config_bit_data['for']));
$configs_to_add = $config_bit_data['action']['add'][$target];
foreach ($configs_to_add as $config_to_add) {
if (!in_array($config_to_add, $config_target_data[$target])) {
$config_target_data[$target][] = (string) $config_to_add;
}
}
$updated_config_target = Yaml::dump($config_target_data, 2, 2);
file_put_contents(drupal_get_path($type, $project) . '/' . $config_bit_data['for'], $updated_config_target);
}
}
public static function actionRemove($config_bit_file_name, $condition_name, $condition_value, $target, $type = 'profile', $project = 'varbase') {
$config_bit_data = ConfigBit::getConfigBit($config_bit_file_name, $type, $project);
if (isset($config_bit_data['type']) && $config_bit_data['type'] == 'action' && isset($config_bit_data['for']) && $config_bit_data['for'] !== '' && file_exists(drupal_get_path($type, $project) . '/' . $config_bit_data['for']) && isset($config_bit_data['action']) && isset($config_bit_data['action']['remove']) && isset($config_bit_data['action']['remove']['when']) && isset($config_bit_data['action']['remove']['when'][$condition_name]) && $config_bit_data['action']['remove']['when'][$condition_name] == $condition_value && isset($config_bit_data['action']['remove']['target']) && $config_bit_data['action']['remove']['target'] == $target && isset($config_bit_data['action']['remove'][$target])) {
$config_target_data = Yaml::parse(file_get_contents(drupal_get_path($type, $project) . '/' . $config_bit_data['for']));
$configs_to_remove = $config_bit_data['action']['remove'][$target];
foreach ($configs_to_remove as $config_to_remove) {
$config_to_remove_key = array_search((string) $config_to_remove, $config_target_data[$target], TRUE);
if ($config_to_remove_key !== FALSE) {
unset($config_target_data[$target][$config_to_remove_key]);
}
}
$updated_config_target = Yaml::dump($config_target_data, 2, 2);
file_put_contents(drupal_get_path($type, $project) . '/' . $config_bit_data['for'], $updated_config_target);
}
}
}