Skip to content

feat: full D10 support and revamp #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
d70rr3s wants to merge 4 commits into
base: master
Choose a base branch
from
Open

feat: full D10 support and revamp #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
25a2d0d
fix: runtime warnings (invalid array offset)
d70rr3s Dec 5, 2023
089fa37
fix: invalid array offset in menu
d70rr3s Dec 5, 2023
5da0769
feat: allow URL pattern to be update or skipped
d70rr3s Dec 19, 2023
d268699
Updated drush supported version in composer file
jvalero-hiberuscom Mar 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
],
"require": {
"cweagans/composer-patches": "^1.6",
"drush/drush": "^10.3 || ^11",
"drush/drush": "^10.3 || ^12",
"google/apiclient": "^2.8"
},
"require-dev": {
Expand Down
167 changes: 121 additions & 46 deletions src/BaseEntityGenerate.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,13 @@

namespace Drupal\dst_entity_generate;

use BadMethodCallException;
use Drupal;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\pathauto\PathautoPatternInterface;
use Drush\Commands\DrushCommands;
use Exception;

/**
* Base class for all entity generate commands.
Expand All @@ -13,6 +17,8 @@ abstract class BaseEntityGenerate extends DrushCommands {

use StringTranslationTrait;

protected const SKIP_VALUE = '-';

/**
* Machine name of entity which is going to import.
*
Expand Down Expand Up @@ -70,15 +76,15 @@ abstract class BaseEntityGenerate extends DrushCommands {
* @throws \Exception
*/
public function validateGoogleSheetCreds() {
$keyValueStorage = \Drupal::service('keyvalue');
$keyValueStorage = Drupal::service('keyvalue');

$googleSheetStorage = $keyValueStorage->get('dst_google_sheet_storage');

$requiredConfigs = ['name', 'credentials', 'access_token', 'spreadsheet_id'];

foreach ($requiredConfigs as $config) {
if (empty($googleSheetStorage->get($config))) {
throw new \Exception("Please configure $config in google sheet credentials configurations.");
throw new Exception("Please configure $config in google sheet credentials configurations.");
}
}
}
Expand All @@ -91,7 +97,7 @@ public function validateGoogleSheetCreds() {
* @param string $entity
* Entity name on which exception occurred.
*/
public function displayAndLogException(\Exception $exception, string $entity) {
public function displayAndLogException(Exception $exception, string $entity) {
$message = $this->t('Exception occurred while generating @entity: @exception', [
'@exception' => $exception->getMessage(),
'@entity' => $entity,
Expand All @@ -108,7 +114,7 @@ public function displayAndLogException(\Exception $exception, string $entity) {
* @throws \Exception
*/
public function validateEntityForImport() {
$enabled_entities = \Drupal::configFactory()->get('dst_entity_generate.settings')->get('sync_entities');
$enabled_entities = Drupal::configFactory()->get('dst_entity_generate.settings')->get('sync_entities');
if ($enabled_entities[$this->dstEntityName] !== $this->dstEntityName && $this->dstEntityName !== 'all') {
$choice = $this->io()->choice("Entity $this->dstEntityName is not enabled for import. Do you want to enable it?",
['Yes', 'No'],
Expand All @@ -120,7 +126,7 @@ public function validateEntityForImport() {
break;

case 1:
throw new \Exception("Entity $this->dstEntityName is not enabled for import. Aborting...");
throw new Exception("Entity $this->dstEntityName is not enabled for import. Aborting...");
}
}
}
Expand All @@ -132,7 +138,7 @@ public function validateEntityForImport() {
* Entity name to enable sync.
*/
public function enableEntitySync(string $entity_name) {
$dst_entity_generate_settings = \Drupal::configFactory()->getEditable('dst_entity_generate.settings');
$dst_entity_generate_settings = Drupal::configFactory()->getEditable('dst_entity_generate.settings');
$sync_entities = $dst_entity_generate_settings->get('sync_entities');
$sync_entities[$entity_name] = $entity_name;
$dst_entity_generate_settings->set('sync_entities', $sync_entities)->save();
Expand All @@ -143,14 +149,14 @@ public function enableEntitySync(string $entity_name) {
*
* @hook validate
*
* @throws \Exception
* @throws Exception
*/
public function validateModulesStatus() {
if (empty($this->dependentModules)) {
return;
}

$moduleHandler = \Drupal::moduleHandler();
$moduleHandler = Drupal::moduleHandler();
$disabledModules = [];
foreach ($this->dependentModules as $module) {
if (!$moduleHandler->moduleExists($module)) {
Expand All @@ -160,7 +166,7 @@ public function validateModulesStatus() {

if (!empty($disabledModules)) {
$disabledModules = \implode(',', $disabledModules);
throw new \Exception("Please enable $disabledModules to continue with this operation. Aborting...");
throw new Exception("Please enable $disabledModules to continue with this operation. Aborting...");
}
}

Expand All @@ -177,13 +183,13 @@ public function validateModulesStatus() {
*/
protected function getDataFromSheet(string $sheet, $filter = TRUE) {
$cache_key = 'dst_sheet_data.' . \strtolower($sheet);
$cache_api = \Drupal::cache();
$cache_api = Drupal::cache();

if (!empty($cache_api->get($cache_key))) {
$data = $cache_api->get($cache_key)->data;
}
else {
$google_sheet_api = \Drupal::service('dst_entity_generate.google_sheet_api');
$google_sheet_api = Drupal::service('dst_entity_generate.google_sheet_api');
$data = $google_sheet_api->getData($sheet);
// Store cached data for 6 hours.
$cache_api->set($cache_key, $data, microtime(TRUE) + 21600);
Expand All @@ -200,7 +206,7 @@ protected function getDataFromSheet(string $sheet, $filter = TRUE) {
* @param string $key
* Key of the DST sheet to filter the data.
*
* @return array|null
* @return array
* Filtered data or empty.
*/
protected function filterEntityTypeSpecificData(array $data, string $key = 'type') {
Expand Down Expand Up @@ -231,15 +237,15 @@ protected function filterEntityTypeSpecificData(array $data, string $key = 'type
* @param array $data
* Data fetched from google sheet.
*
* @return array|null
* @return array
* Approved data.
*/
private function filterApprovedData(array $data) {
if (empty($data)) {
return;
return [];
}

$config = \Drupal::config('dst_entity_generate.settings');
$config = Drupal::config('dst_entity_generate.settings');
$this->implementationFlagColumn = $config->get('column_name');
$column_value = $config->get('column_value');
$this->updateFlag = $config->get('update_flag');
Expand Down Expand Up @@ -280,43 +286,41 @@ private function converToMachineName($name) {
* Helper function to generate pathauto pattern.
*/
public function generatePathautoPattern($bundle, $alias, $entity) {
$patternStatus = FALSE;
$moduleHandler = \Drupal::moduleHandler();
if (!$moduleHandler->moduleExists('pathauto')) {
$this->io()->warning($this->t('Please install pathauto module.'));
return FALSE;
}
if (isset($alias)) {
$patternStatus = TRUE;
try {
$moduleHandler = Drupal::moduleHandler();
if (!$moduleHandler->moduleExists('pathauto')) {
throw new BadMethodCallException('Pathauto module is not enabled.');
}

if (empty($alias) || $alias === self::SKIP_VALUE) {
$this->io()->warning($this->t('No alias set for @bundle, skipping.', ['@bundle' => $bundle]));
return;
}

$pattern_id = $bundle . '_pattern';
$pattern = $this->entityTypeManager->getStorage('pathauto_pattern')->load($pattern_id);
if ($pattern) {
$this->io()->warning($this->t('Alias for @bundle is already present, skipping.', ['@bundle' => $bundle]));
return FALSE;

if (!$pattern) {
$this->createPathautoPattern($pattern_id, $bundle, $entity, $alias);

return;
}

if ($patternStatus) {
$pattern = $this->entityTypeManager->getStorage('pathauto_pattern')->create([
'id' => $pattern_id,
'label' => $bundle . ' pattern',
'type' => 'canonical_entities:' . $entity,
'pattern' => $alias,
'weight' => -5,
]);

// Add the bundle condition.
$pattern->addSelectionCondition([
'id' => 'entity_bundle:' . $entity,
'bundles' => [$bundle => $bundle],
'negate' => FALSE,
]);

$pattern->save();
$this->io()->success($this->t('Alias for @bundle is created.', ['@bundle' => $bundle]));
if ($pattern->get('pattern') === $alias) {
$this->io()->warning($this->t('Alias for @bundle already set to @alias, skipping.', [
'@bundle' => $bundle,
'@alias' => $alias,
]));
return;
}

$this->updatePathautoPattern($pattern, $alias, $bundle);
}
else {
$this->io()->warning($this->t('Alias for @bundle is not available, skipping.', ['@bundle' => $bundle]));
catch (\Throwable $e) {
$this->io()->error($this->t('Exception occurred while generating pathauto pattern for @bundle: @exception', [
'@exception' => str_replace(['"', "'"], '', $e->getMessage()),
'@bundle' => $bundle,
]));
}
}

Expand Down Expand Up @@ -394,4 +398,75 @@ public function validateMachineName(string $machine_name, int $length = 32, stri
return $result;
}

/**
* Create new pathauto pattern.
*
* @param string $pattern_id
* The pattern id.
* @param string $bundle
* The bundle name.
* @param string $entity
* The entity type.
* @param string $alias
* The alias pattern.
*
* @return void
*/
private function createPathautoPattern(
string $pattern_id,
string $bundle,
syring $entity,
string $alias
): void {
$pattern = $this->entityTypeManager->getStorage('pathauto_pattern')->create(
[
'id' => $pattern_id,
'label' => $bundle.' pattern',
'type' => 'canonical_entities:'.$entity,
'pattern' => $alias,
'weight' => -5,
]
);

// Add the bundle condition.
$pattern->addSelectionCondition([
'id' => 'entity_bundle:'.$entity,
'bundles' => [$bundle => $bundle],
'negate' => FALSE,
]);

$pattern->save();
$this->io()->success(
$this->t('Alias for @bundle is created.', ['@bundle' => $bundle])
);
}

/**
* Update existing pathauto pattern.
*
* @param PathautoPatternInterface $pattern
* The pattern entity.
* @param string $alias
* The alias pattern.
* @param string $bundle
* The bundle name.
*
* @return void
*/
private function updatePathautoPattern(
PathautoPatternInterface $pattern,
string $alias,
string $bundle
): void {
$pattern->set('pattern', $alias);
$pattern->save();
$this->io()->warning(
$this->t('Alias for @bundle updated from @previous to @current.', [
'@bundle' => $bundle,
'@previous' => $pattern->get('pattern'),
'@current' => $alias,
])
);
}

}
2 changes: 1 addition & 1 deletion src/Commands/Menu.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ public function generateMenus($options = ['update' => FALSE]) {
$menus = $menu_storage->loadMultiple();
foreach ($menus_data as $index => $menu) {
$menu_name = $menu['label'];
if ($menus[$menu['id']]) {
if (!empty($menus[$menu['id']])) {
if ($this->updateMode && $data[$index][$this->implementationFlagColumn] === $this->updateFlag) {
$this->updateEntityType($menus[$menu['id']], $menu);
$this->io()->success("Menu $menu_name updated.");
Expand Down
17 changes: 8 additions & 9 deletions src/Commands/Vocabulary.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,22 +84,21 @@ public function generateVocabularies($options = ['update' => FALSE]) {
$vocabularies = $vocab_storage->loadMultiple();
foreach ($vocab_types as $index => $vocab) {
$vocab_name = $vocab['vid'];
$vocan_url_alias = $vocab['url_alias_pattern'];
$type = $vocab['type'];
if ($vocabularies[$vocab['vid']]) {
$this->generatePathautoPattern($vocab_name, $vocan_url_alias, $entity);
$vocab_url_alias = $vocab['url_alias_pattern'];
if (!empty($vocabularies[$vocab['vid']])) {
$this->generatePathautoPattern($vocab_name, $vocab_url_alias, $entity);
if ($this->updateMode && $data[$index][$this->implementationFlagColumn] === $this->updateFlag) {
$this->updateEntityType($vocabularies[$vocab['vid']], $vocab);
$this->io()->success("Vocabulary $vocab_name updated.");
$this->io()->success("Vocabulary {$vocab_name} updated.");
continue;
}
$this->io()->warning("Vocabulary $vocab_name Already exists. Skipping creation...");
$this->io()->warning("Vocabulary {$vocab_name} Already exists. Skipping creation...");
continue;
}
$status = $vocab_storage->create($vocab)->save();
if ($status === SAVED_NEW) {
$this->io()->success("Vocabulary $type is successfully created...");
$this->generatePathautoPattern($vocab_name, $vocan_url_alias, $entity);
$this->io()->success("Vocabulary {$vocab_name} is successfully created...");
$this->generatePathautoPattern($vocab_name, $vocab_url_alias, $entity);
}
}

Expand Down Expand Up @@ -141,7 +140,7 @@ private function getVocabTypeData(array $data) {
$vocabs['vid'] = $item['machine_name'];
$vocabs['description'] = $description;
$vocabs['name'] = $item['name'];
$vocabs['url_alias_pattern'] = $item['url_alias_pattern'];
$vocabs['url_alias_pattern'] = $item['url_alias_pattern'] ?? self::SKIP_VALUE;

\array_push($vocab_types, $vocabs);
}
Expand Down