Add temporary console command to fix workerqueue row with corrupted parameter data

- It should be reverted just before the 2020.12 release

diff --git a/src/Console/FixAPDeliveryWorkerTaskParameters.php b/src/Console/FixAPDeliveryWorkerTaskParameters.php
new file mode 100644 (file)
index 0000000..9023d84
--- /dev/null
+++ b/src/Console/FixAPDeliveryWorkerTaskParameters.php
@@ -0,0 +1,163 @@
+<?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace Friendica\Console;
+
+use Friendica\App;
+use Friendica\Database\Database;
+use Friendica\Database\DBA;
+use Friendica\DI;
+use Friendica\Model\Contact;
+use Friendica\Util\Strings;
+use RuntimeException;
+
+/**
+ * License: AGPLv3 or later, same as Friendica
+ */
+class FixAPDeliveryWorkerTaskParameters extends \Asika\SimpleConsole\Console
+{
+       protected $helpOptions = ['h', 'help', '?'];
+
+       /**
+        * @var App\Mode
+        */
+       private $appMode;
+       /**
+        * @var Database
+        */
+       private $dba;
+       /**
+        * @var int
+        */
+       private $examined;
+       /**
+        * @var int
+        */
+       private $processed;
+       /**
+        * @var int
+        */
+       private $errored;
+
+       protected function getHelp()
+       {
+               $help = <<<HELP
+console fixapdeliveryworkertaskparameters - fix APDelivery worker task parameters corrupted during the 2020.12 RC period
+Usage
+       bin/console fixapdeliveryworkertaskparameters [-h|--help|-?] [-v]
+
+Description
+       During the 2020.12 RC period some worker task parameters have been corrupted, resulting in the impossibility to execute them.
+       This command restores their expected parameters.
+       If you didn't run Friendica during the 2020.12 RC period, you do not need to use this command. 
+
+Options
+    -h|--help|-? Show help information
+    -v           Show more debug information.
+HELP;
+               return $help;
+       }
+
+       public function __construct(App\Mode $appMode, Database $dba, \Friendica\Core\L10n $l10n, array $argv = null)
+       {
+               parent::__construct($argv);
+
+               $this->appMode = $appMode;
+               $this->dba = $dba;
+               $this->l10n = $l10n;
+       }
+
+       protected function doExecute()
+       {
+               if ($this->getOption('v')) {
+                       $this->out('Class: ' . __CLASS__);
+                       $this->out('Arguments: ' . var_export($this->args, true));
+                       $this->out('Options: ' . var_export($this->options, true));
+               }
+
+               if (count($this->args) > 0) {
+                       throw new \Asika\SimpleConsole\CommandArgsException('Too many arguments');
+               }
+
+               if ($this->appMode->isInstall()) {
+                       throw new RuntimeException('Friendica isn\'t properly installed yet.');
+               }
+
+               $this->examined = 0;
+               $this->processed = 0;
+               $this->errored = 0;
+
+               do {
+                       $result = $this->dba->p('SELECT `id`, `parameter` FROM `workerqueue` WHERE `command` = "APDelivery" AND `parameter` LIKE "[\"%\",\"\",%" LIMIT ' . $this->examined . ', 100');
+                       while ($row = $this->dba->fetch($result)) {
+                               $this->examined++;
+                               $this->processRow($row);
+                       }
+               } while ($this->dba->isResult($result));
+
+               if ($this->getOption('v')) {
+                       $this->out('Examined: ' . $this->examined);
+                       $this->out('Processed: ' . $this->processed);
+                       $this->out('Errored: ' . $this->errored);
+               }
+
+               return 0;
+       }
+
+       private function processRow(array $workerqueueItem)
+       {
+               $parameters = json_decode($workerqueueItem['parameter'], true);
+
+               if (!$parameters) {
+                       $this->errored++;
+                       if ($this->getOption('v')) {
+                               $this->out('Unabled to parse parameter JSON of the row with id ' . $workerqueueItem['id']);
+                               $this->out('JSON: ' . var_export($workerqueueItem['parameter'], true));
+                       }
+               }
+
+               if ($parameters[1] !== '' && !is_array($parameters[2])) {
+                       // Nothing to do, we save a write
+                       return;
+               }
+
+               if ($parameters[1] === '') {
+                       $parameters[1] = 0;
+               }
+
+               if (is_array($parameters[2])) {
+                       $parameters[4] = $parameters[2];
+                       $contact = Contact::getById(current($parameters[2]), ['url']);
+                       $parameters[2] = $contact['url'];
+               }
+
+               $fields = ['parameter' => json_encode($parameters)];
+               if ($this->dba->update('workerqueue', $fields, ['id' => $workerqueueItem['id']])) {
+                       $this->processed++;
+               } else {
+                       $this->errored++;
+                       if ($this->getOption('v')) {
+                               $this->out('Unabled to update the row with id ' . $workerqueueItem['id']);
+                               $this->out('Fields: ' . var_export($fields, true));
+                       }
+               }
+       }
+}

diff --git a/src/Core/Console.php b/src/Core/Console.php
index 4a4dc13ef77d56acb40ce978a047784784da7e7b..f43b89e9e67cc1832090d00ad10598a6b40e5bcf 100644 (file)
--- a/src/Core/Console.php
+++ b/src/Core/Console.php
@@ -94,6 +94,7 @@ HELP;
                'serverblock'            => Friendica\Console\ServerBlock::class,
                'storage'                => Friendica\Console\Storage::class,
                'relay'                  => Friendica\Console\Relay::class,
+               'fixapdeliveryworkertaskparameters' => Friendica\Console\FixAPDeliveryWorkerTaskParameters::class,
        ];
 
        /**