Files
firefly-iii/app/Console/Commands/Upgrade/UpgradesJournalNotes.php

101 lines
2.9 KiB
PHP
Raw Normal View History

2019-03-20 18:31:00 +01:00
<?php
2019-03-20 18:31:00 +01:00
/**
2019-06-13 06:39:05 +02:00
* MigrateJournalNotes.php
2020-01-23 20:35:02 +01:00
* Copyright (c) 2020 james@firefly-iii.org
2019-03-20 18:31:00 +01:00
*
* This file is part of Firefly III (https://github.com/firefly-iii).
2019-03-20 18:31:00 +01:00
*
* 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.
2019-03-20 18:31:00 +01:00
*
* This program is distributed in the hope that it will be useful,
2019-03-20 18:31:00 +01:00
* 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.
2019-03-20 18:31:00 +01:00
*
* 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/>.
2019-03-20 18:31:00 +01:00
*/
declare(strict_types=1);
namespace FireflyIII\Console\Commands\Upgrade;
use FireflyIII\Console\Commands\ShowsFriendlyMessages;
2019-03-20 18:31:00 +01:00
use FireflyIII\Models\Note;
use FireflyIII\Models\TransactionJournalMeta;
use Illuminate\Console\Command;
2024-12-27 06:48:58 +01:00
class UpgradesJournalNotes extends Command
2019-03-20 18:31:00 +01:00
{
use ShowsFriendlyMessages;
2023-12-02 12:56:48 +01:00
public const string CONFIG_NAME = '480_migrate_notes';
2023-11-05 09:54:53 +01:00
protected $description = 'Migrate notes for transaction journals.';
2023-11-05 09:54:53 +01:00
2024-12-27 06:48:58 +01:00
protected $signature = 'upgrade:480-notes {--F|force : Force the execution of this command.}';
2019-03-20 18:31:00 +01:00
/**
* Execute the console command.
*/
public function handle(): int
{
2019-03-23 18:58:06 +01:00
$start = microtime(true);
2021-04-07 07:28:43 +02:00
2019-03-20 18:31:00 +01:00
if ($this->isExecuted() && true !== $this->option('force')) {
$this->friendlyInfo('This command has already been executed.');
2019-03-20 18:31:00 +01:00
return 0;
}
2021-04-07 07:28:43 +02:00
2019-06-13 06:39:05 +02:00
$count = 0;
$set = TransactionJournalMeta::whereName('notes')->get();
2023-12-20 19:35:52 +01:00
2019-03-20 18:31:00 +01:00
/** @var TransactionJournalMeta $meta */
foreach ($set as $meta) {
$journal = $meta->transactionJournal;
$note = $journal->notes()->first();
2019-03-20 18:31:00 +01:00
if (null === $note) {
$note = new Note();
$note->noteable()->associate($journal);
}
$note->text = $meta->data;
$note->save();
2023-10-29 06:33:43 +01:00
app('log')->debug(sprintf('Migrated meta note #%d to Note #%d', $meta->id, $note->id));
2023-01-03 06:48:53 +01:00
$meta->delete();
2021-04-07 07:28:43 +02:00
2023-12-20 19:35:52 +01:00
++$count;
2019-06-13 06:39:05 +02:00
}
if (0 !== $count) {
$this->friendlyInfo(sprintf('Migrated %d note(s).', $count));
2019-06-13 06:39:05 +02:00
}
$end = round(microtime(true) - $start, 2);
$this->friendlyInfo(sprintf('Migrated notes in %s seconds.', $end));
2019-03-20 18:31:00 +01:00
$this->markAsExecuted();
2020-03-21 15:43:41 +01:00
2019-03-20 18:31:00 +01:00
return 0;
}
private function isExecuted(): bool
{
$configVar = app('fireflyconfig')->get(self::CONFIG_NAME, false);
if (null !== $configVar) {
2024-12-22 08:43:12 +01:00
return (bool) $configVar->data;
2019-03-20 18:31:00 +01:00
}
return false;
2019-03-20 18:31:00 +01:00
}
private function markAsExecuted(): void
{
app('fireflyconfig')->set(self::CONFIG_NAME, true);
}
2019-08-17 12:09:03 +02:00
}