Merge pull request #17 from fredden/force

sprankhub · web-flow · commit d16dbebe976d · 2022-07-26T12:10:42.000+02:00
Add --force option
diff --git a/Console/Command/CleanUpAttributesAndValuesWithoutParentCommand.php b/Console/Command/CleanUpAttributesAndValuesWithoutParentCommand.php
@@ -42,19 +42,27 @@ protected function configure()
         $this
             ->setName('eav:clean:attributes-and-values-without-parent')
             ->setDescription($description)
-            ->addOption('dry-run');
+            ->addOption('dry-run')
+            ->addOption('force');
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $isDryRun = $input->getOption('dry-run');
+        $isForce = $input->getOption('force');
+
+        if (!$isDryRun && !$isForce) {
+            if (!$input->isInteractive()) {
+                $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');
+
+                return 1; // error.
+            }
 
-        if (!$isDryRun && $input->isInteractive()) {
             $output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');
             $question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);
 
             if (!$this->getHelper('question')->ask($input, $output, $question)) {
-                return;
+                return 1; // error.
             }
         }
 
@@ -66,12 +74,14 @@ public function execute(InputInterface $input, OutputInterface $output)
             CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER,
             AddressMetadataInterface::ENTITY_TYPE_ADDRESS
         ];
+
         foreach ($entityTypeCodes as $code) {
             $entityType = $this->eavEntityTypeCollectionFactory
                 ->create()
                 ->addFieldToFilter('entity_type_code', $code)
                 ->getFirstItem();
             $output->writeln("<info>Cleaning values for $code</info>");
+
             foreach ($types as $type) {
                 $eavTable         = $this->resourceConnection->getTableName('eav_attribute');
                 $entityValueTable = $this->resourceConnection->getTableName($code . '_entity_' . $type);
@@ -86,5 +96,7 @@ public function execute(InputInterface $input, OutputInterface $output)
                 }
             }
         }
+
+        return 0; // success.
     }
 }
diff --git a/Console/Command/RemoveUnusedAttributesCommand.php b/Console/Command/RemoveUnusedAttributesCommand.php
@@ -45,17 +45,27 @@ protected function configure()
         $this
             ->setName('eav:attributes:remove-unused')
             ->setDescription('Remove unused attributes (without values or not assigned to any attribute set')
-            ->addOption('dry-run');
+            ->addOption('dry-run')
+            ->addOption('force');
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $isDryRun = $input->getOption('dry-run');
-        if (!$isDryRun && $input->isInteractive()) {
+        $isForce = $input->getOption('force');
+
+        if (!$isDryRun && !$isForce) {
+            if (!$input->isInteractive()) {
+                $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');
+
+                return 1; // error.
+            }
+
             $output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');
             $question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);
+
             if (!$this->getHelper('question')->ask($input, $output, $question)) {
-                return;
+                return 1; // error.
             }
         }
 
@@ -70,35 +80,45 @@ public function execute(InputInterface $input, OutputInterface $output)
             ->getItems();
         $eavAttributeTable       = $this->resourceConnection->getTableName('eav_attribute');
         $eavEntityAttributeTable = $this->resourceConnection->getTableName('eav_entity_attribute');
+
         foreach ($attributes as $attribute) {
             $table = $this->resourceConnection->getTableName('catalog_product_entity_' . $attribute->getBackendType());
             /* Look for attributes that have no values set in products */
             $attributeValues = (int)$db->fetchOne('SELECT COUNT(*) FROM ' . $table . ' WHERE attribute_id = ?',
                 [$attribute->getAttributeId()]);
+
             if ($attributeValues === 0) {
                 $output->writeln($attribute->getAttributeCode() . ' has ' . $attributeValues
                     . ' values; deleting attribute');
+
                 if (!$isDryRun) {
                     $db->query('DELETE FROM ' . $eavAttributeTable . ' WHERE attribute_code = ?',
                         $attribute->getAttributeCode());
                 }
+
                 $deleted++;
             } else {
                 /* Look for attributes that are not assigned to attribute sets */
                 $attributeGroups = (int)$db->fetchOne('SELECT COUNT(*) FROM ' . $eavEntityAttributeTable
                     . ' WHERE attribute_id = ?', [$attribute->getAttributeId()]);
+
                 if ($attributeGroups === 0) {
                     $output->writeln($attribute->getAttributeCode()
                         . ' is not assigned to any attribute set; deleting attribute and its ' . $attributeValues
                         . ' orphaned value(s)');
+
                     if (!$isDryRun) {
                         $db->query('DELETE FROM ' . $eavAttributeTable . ' WHERE attribute_code = ?',
                             $attribute->getAttributeCode());
                     }
+
                     $deleted++;
                 }
             }
         }
+
         $output->writeln('Deleted ' . $deleted . ' attributes.');
+
+        return 0; // success.
     }
 }
diff --git a/Console/Command/RemoveUnusedMediaCommand.php b/Console/Command/RemoveUnusedMediaCommand.php
@@ -39,22 +39,31 @@ protected function configure()
         $this
             ->setName('eav:media:remove-unused')
             ->setDescription('Remove unused product images')
-            ->addOption('dry-run');
+            ->addOption('dry-run')
+            ->addOption('force');
     }
 
-    public function execute(InputInterface $input, OutputInterface $output): void
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $fileSize   = 0;
         $countFiles = 0;
         $isDryRun   = $input->getOption('dry-run');
+        $isForce    = $input->getOption('force');
+
+        if (!$isDryRun && !$isForce) {
+            if (!$input->isInteractive()) {
+                $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');
+
+                return 1; // error.
+            }
 
-        if (!$isDryRun && $input->isInteractive()) {
             $output->writeln(
                 '<comment>WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.</comment>'
             );
             $question = new ConfirmationQuestion('<comment>Are you sure you want to continue? [No]</comment>', false);
+
             if (!$this->getHelper('question')->ask($input, $output, $question)) {
-                return;
+                return 1; // error.
             }
         }
 
@@ -89,6 +98,7 @@ public function execute(InputInterface $input, OutputInterface $output): void
 
             $fileSize += filesize($file);
             $countFiles++;
+
             if (!$isDryRun) {
                 unlink($file);
                 $output->writeln('## REMOVING: ' . $filePath . ' ##');
@@ -98,14 +108,18 @@ public function execute(InputInterface $input, OutputInterface $output): void
         }
 
         $this->printResult($output, $isDryRun, $countFiles, $fileSize);
+
+        return 0; // success.
     }
 
     private function printResult(OutputInterface $output, $isDryRun, int $countFiles, int $filesize): void
     {
         $actionName = 'Deleted';
+
         if ($isDryRun) {
             $actionName = 'Would delete';
         }
+
         $fileSizeInMB = number_format($filesize / 1024 / 1024, '2');
 
         $output->writeln("<info>{$actionName} {$countFiles} unused images. {$fileSizeInMB} MB</info>");
diff --git a/Console/Command/RestoreUseDefaultConfigValueCommand.php b/Console/Command/RestoreUseDefaultConfigValueCommand.php
@@ -39,19 +39,27 @@ protected function configure()
         $this
             ->setName('eav:config:restore-use-default-value')
             ->setDescription($description)
-            ->addOption('dry-run');
+            ->addOption('dry-run')
+            ->addOption('force');
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $isDryRun = $input->getOption('dry-run');
+        $isForce = $input->getOption('force');
+
+        if (!$isDryRun && !$isForce) {
+            if (!$input->isInteractive()) {
+                $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');
+
+                return 1; // error.
+            }
 
-        if (!$isDryRun && $input->isInteractive()) {
             $output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');
             $question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);
 
             if (!$this->getHelper('question')->ask($input, $output, $question)) {
-                return;
+                return 1; // error.
             }
         }
 
@@ -61,18 +69,22 @@ public function execute(InputInterface $input, OutputInterface $output)
         $tableName = $this->resourceConnection->getTableName('core_config_data');
         $configData = $db->fetchAll('SELECT DISTINCT path, value FROM ' . $tableName
             . ' WHERE scope_id = 0');
+
         foreach ($configData as $config) {
             $count = $db->fetchOne('SELECT COUNT(*) FROM ' . $tableName
                 . ' WHERE path = ? AND BINARY value = ?', [$config['path'], $config['value']]);
+
             if ($count > 1) {
                 $output->writeln('Config path ' . $config['path'] . ' with value ' . $config['value'] . ' has ' . $count
                     . ' values; deleting non-default values');
+
                 if (!$isDryRun) {
                     $db->query(
                         'DELETE FROM ' . $tableName . ' WHERE path = ? AND BINARY value = ? AND scope_id != ?',
                         [$config['path'], $config['value'], 0]
                     );
                 }
+
                 $removedConfigValues += ($count - 1);
             }
 
@@ -98,6 +110,8 @@ public function execute(InputInterface $input, OutputInterface $output)
         }
 
         $output->writeln('Removed ' . $removedConfigValues . ' values from core_config_data table.');
+
+        return 0; // success.
     }
 
     /**
diff --git a/Console/Command/RestoreUseDefaultValueCommand.php b/Console/Command/RestoreUseDefaultValueCommand.php
@@ -39,6 +39,7 @@ protected function configure()
             ->setName('eav:attributes:restore-use-default-value')
             ->setDescription($description)
             ->addOption('dry-run')
+            ->addOption('force')
             ->addOption(
                 'entity',
                 null,
@@ -48,23 +49,30 @@ protected function configure()
             );
     }
 
-    public function execute(InputInterface $input, OutputInterface $output)
+    public function execute(InputInterface $input, OutputInterface $output): int
     {
         $isDryRun = $input->getOption('dry-run');
+        $isForce  = $input->getOption('force');
         $entity   = $input->getOption('entity');
 
         if (!in_array($entity, ['product', 'category'])) {
             $output->writeln('Please specify the entity with --entity. Possible options are product or category');
 
-            return;
+            return 1;
         }
 
-        if (!$isDryRun && $input->isInteractive()) {
+        if (!$isDryRun && !$isForce) {
+            if (!$input->isInteractive()) {
+                $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');
+
+                return 1; // error.
+            }
+
             $output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');
             $question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);
 
             if (!$this->getHelper('question')->ask($input, $output, $question)) {
-                return;
+                return 1; // error.
             }
         }
 
@@ -101,9 +109,11 @@ public function execute(InputInterface $input, OutputInterface $output)
                             . $result['value_id']
                             . ' for attribute ' . $row['attribute_id'] . ' in table ' . $fullTableName
                         );
+
                         if (!isset($counts[$row['attribute_id']])) {
                             $counts[$row['attribute_id']] = 0;
                         }
+
                         $counts[$row['attribute_id']]++;
                     }
                 }
@@ -127,5 +137,7 @@ public function execute(InputInterface $input, OutputInterface $output)
                 $output->writeln('There were no attribute values to clean up');
             }
         }
+
+        return 0; // success.
     }
 }
diff --git a/README.md b/README.md
@@ -17,6 +17,9 @@ Run `bin/magento` in the Magento 2 root and look for the `eav:` commands.
 ## Dry run
 Use `--dry-run` to check result without modifying data.
 
+## Force
+Use `--force` to skip the confirmation prompt before modifying data.
+
 ## Installation
 Installation with composer:
 

Original file line number	Diff line number	Diff line change
`@@ -42,19 +42,27 @@ protected function configure()`
`42`	`42`	`$this`
`43`	`43`	`->setName('eav:clean:attributes-and-values-without-parent')`
`44`	`44`	`->setDescription($description)`
`45`		`- ->addOption('dry-run');`
	`45`	`+ ->addOption('dry-run')`
	`46`	`+ ->addOption('force');`
`46`	`47`	`}`
`47`	`48`
`48`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`49`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`49`	`50`	`{`
`50`	`51`	`$isDryRun = $input->getOption('dry-run');`
	`52`	`+ $isForce = $input->getOption('force');`
	`53`	`+`
	`54`	`+ if (!$isDryRun && !$isForce) {`
	`55`	`+ if (!$input->isInteractive()) {`
	`56`	`+ $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');`
	`57`	`+`
	`58`	`+ return 1; // error.`
	`59`	`+ }`
`51`	`60`
`52`		`- if (!$isDryRun && $input->isInteractive()) {`
`53`	`61`	`$output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');`
`54`	`62`	`$question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);`
`55`	`63`
`56`	`64`	`if (!$this->getHelper('question')->ask($input, $output, $question)) {`
`57`		`- return;`
	`65`	`+ return 1; // error.`
`58`	`66`	`}`
`59`	`67`	`}`
`60`	`68`
`@@ -66,12 +74,14 @@ public function execute(InputInterface $input, OutputInterface $output)`
`66`	`74`	`CustomerMetadataInterface::ENTITY_TYPE_CUSTOMER,`
`67`	`75`	`AddressMetadataInterface::ENTITY_TYPE_ADDRESS`
`68`	`76`	`];`
	`77`	`+`
`69`	`78`	`foreach ($entityTypeCodes as $code) {`
`70`	`79`	`$entityType = $this->eavEntityTypeCollectionFactory`
`71`	`80`	`->create()`
`72`	`81`	`->addFieldToFilter('entity_type_code', $code)`
`73`	`82`	`->getFirstItem();`
`74`	`83`	`$output->writeln("<info>Cleaning values for $code</info>");`
	`84`	`+`
`75`	`85`	`foreach ($types as $type) {`
`76`	`86`	`$eavTable = $this->resourceConnection->getTableName('eav_attribute');`
`77`	`87`	`$entityValueTable = $this->resourceConnection->getTableName($code . '_entity_' . $type);`
`@@ -86,5 +96,7 @@ public function execute(InputInterface $input, OutputInterface $output)`
`86`	`96`	`}`
`87`	`97`	`}`
`88`	`98`	`}`
	`99`	`+`
	`100`	`+ return 0; // success.`
`89`	`101`	`}`
`90`	`102`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ protected function configure()`
`39`	`39`	`->setName('eav:attributes:restore-use-default-value')`
`40`	`40`	`->setDescription($description)`
`41`	`41`	`->addOption('dry-run')`
	`42`	`+ ->addOption('force')`
`42`	`43`	`->addOption(`
`43`	`44`	`'entity',`
`44`	`45`	`null,`
`@@ -48,23 +49,30 @@ protected function configure()`
`48`	`49`	`);`
`49`	`50`	`}`
`50`	`51`
`51`		`- public function execute(InputInterface $input, OutputInterface $output)`
	`52`	`+ public function execute(InputInterface $input, OutputInterface $output): int`
`52`	`53`	`{`
`53`	`54`	`$isDryRun = $input->getOption('dry-run');`
	`55`	`+ $isForce = $input->getOption('force');`
`54`	`56`	`$entity = $input->getOption('entity');`
`55`	`57`
`56`	`58`	`if (!in_array($entity, ['product', 'category'])) {`
`57`	`59`	`$output->writeln('Please specify the entity with --entity. Possible options are product or category');`
`58`	`60`
`59`		`- return;`
	`61`	`+ return 1;`
`60`	`62`	`}`
`61`	`63`
`62`		`- if (!$isDryRun && $input->isInteractive()) {`
	`64`	`+ if (!$isDryRun && !$isForce) {`
	`65`	`+ if (!$input->isInteractive()) {`
	`66`	`+ $output->writeln('ERROR: neither --dry-run nor --force options were supplied, and we are not running interactively.');`
	`67`	`+`
	`68`	`+ return 1; // error.`
	`69`	`+ }`
	`70`	`+`
`63`	`71`	`$output->writeln('WARNING: this is not a dry run. If you want to do a dry-run, add --dry-run.');`
`64`	`72`	`$question = new ConfirmationQuestion('Are you sure you want to continue? [No] ', false);`
`65`	`73`
`66`	`74`	`if (!$this->getHelper('question')->ask($input, $output, $question)) {`
`67`		`- return;`
	`75`	`+ return 1; // error.`
`68`	`76`	`}`
`69`	`77`	`}`
`70`	`78`
`@@ -101,9 +109,11 @@ public function execute(InputInterface $input, OutputInterface $output)`
`101`	`109`	`. $result['value_id']`
`102`	`110`	`. ' for attribute ' . $row['attribute_id'] . ' in table ' . $fullTableName`
`103`	`111`	`);`
	`112`	`+`
`104`	`113`	`if (!isset($counts[$row['attribute_id']])) {`
`105`	`114`	`$counts[$row['attribute_id']] = 0;`
`106`	`115`	`}`
	`116`	`+`
`107`	`117`	`$counts[$row['attribute_id']]++;`
`108`	`118`	`}`
`109`	`119`	`}`
`@@ -127,5 +137,7 @@ public function execute(InputInterface $input, OutputInterface $output)`
`127`	`137`	`$output->writeln('There were no attribute values to clean up');`
`128`	`138`	`}`
`129`	`139`	`}`
	`140`	`+`
	`141`	`+ return 0; // success.`
`130`	`142`	`}`
`131`	`143`	`}`