first commit

inc/console/rules/processsoftwarecategoryrulescommand.class.php

@@ -0,0 +1,133 @@
+<?php
+/**
+ * ---------------------------------------------------------------------
+ * GLPI - Gestionnaire Libre de Parc Informatique
+ * Copyright (C) 2015-2020 Teclib' and contributors.
+ *
+ * http://glpi-project.org
+ *
+ * based on GLPI - Gestionnaire Libre de Parc Informatique
+ * Copyright (C) 2003-2014 by the INDEPNET Development Team.
+ *
+ * ---------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of GLPI.
+ *
+ * GLPI is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * GLPI is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GLPI. If not, see <http://www.gnu.org/licenses/>.
+ * ---------------------------------------------------------------------
+ */
+
+namespace Glpi\Console\Rules;
+
+if (!defined('GLPI_ROOT')) {
+   die("Sorry. You can't access this file directly");
+}
+
+use Glpi\Console\AbstractCommand;
+
+use Symfony\Component\Console\Helper\ProgressBar;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+
+class ProcessSoftwareCategoryRulesCommand extends AbstractCommand {
+
+   protected function configure() {
+      parent::configure();
+
+      $this->setName('glpi:rules:process_software_category_rules');
+      $this->setAliases(['rules:process_software_category_rules']);
+      $this->setDescription(__('Process software category rules'));
+
+      $this->addOption(
+         'all',
+         'a',
+         InputOption::VALUE_NONE,
+         __('Process rule for all softwares, even those having already a defined category')
+      );
+   }
+
+   protected function execute(InputInterface $input, OutputInterface $output) {
+
+      $query = [
+         'SELECT' => [
+            'id',
+         ],
+         'FROM'   => \Software::getTable(),
+      ];
+      if (!$input->getOption('all')) {
+         $query['WHERE'] = [
+            'softwarecategories_id' => 0
+         ];
+      }
+
+      $software_iterator = $this->db->request($query);
+
+      $sofware_count = $software_iterator->count();
+      if ($sofware_count === 0) {
+         $output->writeln('<info>' . __('No software to process.') . '</info>');
+         return 0; // Success
+      }
+
+      $progress_bar = new ProgressBar($output, $sofware_count);
+      $progress_bar->start();
+
+      $processed_count = 0;
+      foreach ($software_iterator as $data) {
+         $progress_bar->advance(1);
+
+         $this->writelnOutputWithProgressBar(
+            sprintf(__('Processing software having id "%s".'), $data['id']),
+            $progress_bar,
+            OutputInterface::VERBOSITY_VERY_VERBOSE
+         );
+
+         $software = new \Software();
+
+         if (!$software->getFromDB($data['id'])) {
+            $this->writelnOutputWithProgressBar(
+               sprintf(__('Unable to load software having id "%s".'), $data['id']),
+               $progress_bar,
+               OutputInterface::VERBOSITY_NORMAL
+            );
+            continue;
+         }
+
+         $rule_collection = new \RuleSoftwareCategoryCollection();
+         $input = $rule_collection->processAllRules(
+            [],
+            $software->fields,
+            [
+               'name'             => $software->fields['name'],
+               'manufacturers_id' => $software->fields['manufacturers_id'],
+            ]
+         );
+
+         $software->update($input);
+
+         $processed_count++;
+      }
+
+      $progress_bar->finish();
+      $this->output->write(PHP_EOL);
+
+      $output->writeln(
+         '<info>' .sprintf(__('Number of softwares processed: %d.'), $processed_count) . '</info>'
+      );
+
+      return 0; // Success
+   }
+}

inc/console/rules/replaydictionnaryrulescommand.class.php

@@ -0,0 +1,129 @@
+<?php
+/**
+ * ---------------------------------------------------------------------
+ * GLPI - Gestionnaire Libre de Parc Informatique
+ * Copyright (C) 2015-2020 Teclib' and contributors.
+ *
+ * http://glpi-project.org
+ *
+ * based on GLPI - Gestionnaire Libre de Parc Informatique
+ * Copyright (C) 2003-2014 by the INDEPNET Development Team.
+ *
+ * ---------------------------------------------------------------------
+ *
+ * LICENSE
+ *
+ * This file is part of GLPI.
+ *
+ * GLPI is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * GLPI is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with GLPI. If not, see <http://www.gnu.org/licenses/>.
+ * ---------------------------------------------------------------------
+ */
+
+namespace Glpi\Console\Rules;
+
+if (!defined('GLPI_ROOT')) {
+   die("Sorry. You can't access this file directly");
+}
+
+use Glpi\Console\AbstractCommand;
+use Symfony\Component\Console\Exception\InvalidArgumentException;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ChoiceQuestion;
+
+class ReplayDictionnaryRulesCommand extends AbstractCommand {
+
+   protected function configure() {
+      parent::configure();
+
+      $this->setName('glpi:rules:replay_dictionnary_rules');
+      $this->setAliases(['rules:replay_dictionnary_rules']);
+      $this->setDescription(__('Replay dictionnary rules on existing items'));
+
+      $this->addOption(
+         'dictionnary',
+         'd',
+         InputOption::VALUE_REQUIRED,
+         sprintf(
+            __('Dictionnary to use. Possible values are: %s'),
+            implode(', ', $this->getDictionnaryTypes())
+         )
+      );
+
+      $this->addOption(
+         'manufacturer-id',
+         'm',
+         InputOption::VALUE_REQUIRED,
+         __('If option is set, only items having given manufacturer ID will be processed.')
+            . "\n" . __('Currently only available for Software dictionnary.')
+      );
+   }
+
+   protected function interact(InputInterface $input, OutputInterface $output) {
+
+      if (empty($input->getOption('dictionnary'))) {
+         // Ask for dictionnary argument is empty
+         /** @var \Symfony\Component\Console\Helper\QuestionHelper $question_helper */
+         $question_helper = $this->getHelper('question');
+         $question = new ChoiceQuestion(
+            __('Which dictionnary do you want to replay ?'),
+            $this->getDictionnaryTypes()
+         );
+         $answer = $question_helper->ask(
+            $input,
+            $output,
+            $question
+         );
+         $input->setOption('dictionnary', $answer);
+      }
+   }
+
+   protected function execute(InputInterface $input, OutputInterface $output) {
+
+      $dictionnary = $input->getOption('dictionnary');
+      $rulecollection = \RuleCollection::getClassByType($dictionnary);
+
+      if (!in_array($dictionnary, $this->getDictionnaryTypes())
+          || !($rulecollection instanceof \RuleCollection)) {
+         throw new InvalidArgumentException(
+            sprintf(__('Invalid "dictionnary" value.'))
+         );
+      }
+
+      $params = [];
+      if (null !== ($manufacturer_id = $input->getOption('manufacturer-id'))) {
+         $params['manufacturer'] = $manufacturer_id;
+      }
+
+      // Nota: implementations of RuleCollection::replayRulesOnExistingDB() are printing
+      // messages during execution on CLI mode.
+      // This could be improved by using the $output object to handle choosed verbosity level.
+      $rulecollection->replayRulesOnExistingDB(0, 0, [], $params);
+
+      return 0; // Success
+   }
+
+   /**
+    * Return list of available disctionnary types.
+    *
+    * @return string[]
+    */
+   private function getDictionnaryTypes(): array {
+      global $CFG_GLPI;
+      $types = $CFG_GLPI['dictionnary_types'];
+      sort($types);
+      return $types;
+   }
+}