mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-02-16 10:14:58 -06:00
Remove references to old command + remove old command.
This commit is contained in:
James Cole
parent
6675749349
commit
9e2a2bca0a
@ -64,7 +64,8 @@ php artisan firefly-iii:decrypt-all
|
||||
# upgrade database commands:
|
||||
php artisan firefly-iii:transaction-identifiers
|
||||
php artisan firefly-iii:account-currencies
|
||||
php artisan firefly-iii:journal-currencies
|
||||
php artisan firefly-iii:transfer-currencies
|
||||
php artisan firefly-iii:other-currencies
|
||||
php artisan firefly-iii:migrate-notes
|
||||
php artisan firefly-iii:migrate-attachments
|
||||
php artisan firefly-iii:bills-to-rules
|
||||
|
||||
@ -1,519 +0,0 @@
|
||||
<?php
|
||||
/**
|
||||
* JournalCurrencies.php
|
||||
* Copyright (c) 2019 thegrumpydictator@gmail.com
|
||||
*
|
||||
* This file is part of Firefly III.
|
||||
*
|
||||
* Firefly III 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 3 of the License, or
|
||||
* (at your option) any later version.
|
||||
*
|
||||
* Firefly III 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 Firefly III. If not, see <http://www.gnu.org/licenses/>.
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace FireflyIII\Console\Commands\Upgrade;
|
||||
|
||||
use FireflyIII\Models\Account;
|
||||
use FireflyIII\Models\AccountType;
|
||||
use FireflyIII\Models\Transaction;
|
||||
use FireflyIII\Models\TransactionCurrency;
|
||||
use FireflyIII\Models\TransactionJournal;
|
||||
use FireflyIII\Models\TransactionType;
|
||||
use FireflyIII\Repositories\Account\AccountRepositoryInterface;
|
||||
use FireflyIII\Repositories\Currency\CurrencyRepositoryInterface;
|
||||
use FireflyIII\Repositories\Journal\JournalRepositoryInterface;
|
||||
use Illuminate\Console\Command;
|
||||
use Log;
|
||||
|
||||
/**
|
||||
* Class JournalCurrencies
|
||||
*/
|
||||
class JournalCurrencies extends Command
|
||||
{
|
||||
|
||||
public const CONFIG_NAME = '4780_journal_currencies';
|
||||
/**
|
||||
* The console command description.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $description = 'Update all transaction and journal currencies.';
|
||||
/**
|
||||
* The name and signature of the console command.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected $signature = 'firefly-iii:journal-currencies {--F|force : Force the execution of this command.}';
|
||||
/** @var array */
|
||||
private $accountCurrencies;
|
||||
/** @var AccountRepositoryInterface */
|
||||
private $accountRepos;
|
||||
/** @var CurrencyRepositoryInterface */
|
||||
private $currencyRepos;
|
||||
/** @var JournalRepositoryInterface */
|
||||
private $journalRepos;
|
||||
/** @var int */
|
||||
private $count;
|
||||
|
||||
/**
|
||||
* JournalCurrencies constructor.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
parent::__construct();
|
||||
$this->count = 0;
|
||||
$this->accountRepos = app(AccountRepositoryInterface::class);
|
||||
$this->currencyRepos = app(CurrencyRepositoryInterface::class);
|
||||
$this->journalRepos = app(JournalRepositoryInterface::class);
|
||||
}
|
||||
|
||||
/**
|
||||
* Execute the console command.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function handle(): int
|
||||
{
|
||||
$this->accountCurrencies = [];
|
||||
|
||||
|
||||
$start = microtime(true);
|
||||
// @codeCoverageIgnoreStart
|
||||
if ($this->isExecuted() && true !== $this->option('force')) {
|
||||
$this->warn('This command has already been executed.');
|
||||
|
||||
return 0;
|
||||
}
|
||||
// @codeCoverageIgnoreEnd
|
||||
|
||||
$this->updateTransferCurrencies();
|
||||
$this->updateOtherJournalsCurrencies();
|
||||
$this->markAsExecuted();
|
||||
|
||||
if (0 === $this->count) {
|
||||
$this->line('All transactions are correct.');
|
||||
}
|
||||
if (0 !== $this->count) {
|
||||
$this->line(sprintf('Verified %d transaction(s) and journal(s).', $this->count));
|
||||
}
|
||||
$end = round(microtime(true) - $start, 2);
|
||||
$this->info(sprintf('Verified and fixed transaction currencies in %s seconds.', $end));
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Account $account
|
||||
*
|
||||
* @return TransactionCurrency|null
|
||||
*/
|
||||
private function getCurrency(Account $account): ?TransactionCurrency
|
||||
{
|
||||
$accountId = $account->id;
|
||||
if (isset($this->accountCurrencies[$accountId]) && 0 === $this->accountCurrencies[$accountId]) {
|
||||
return null;
|
||||
}
|
||||
if (isset($this->accountCurrencies[$accountId]) && $this->accountCurrencies[$accountId] instanceof TransactionCurrency) {
|
||||
return $this->accountCurrencies[$accountId];
|
||||
}
|
||||
$currencyId = (int)$this->accountRepos->getMetaValue($account, 'currency_id');
|
||||
$result = $this->currencyRepos->findNull($currencyId);
|
||||
if (null === $result) {
|
||||
$this->accountCurrencies[$accountId] = 0;
|
||||
|
||||
return null;
|
||||
}
|
||||
$this->accountCurrencies[$accountId] = $result;
|
||||
|
||||
return $result;
|
||||
|
||||
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TransactionJournal $transfer
|
||||
*
|
||||
* @return Transaction|null
|
||||
*/
|
||||
private function getDestinationTransaction(TransactionJournal $transfer): ?Transaction
|
||||
{
|
||||
return $transfer->transactions->firstWhere('amount', '>', 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TransactionJournal $journal
|
||||
*
|
||||
* @return Transaction|null
|
||||
*/
|
||||
private function getFirstAssetTransaction(TransactionJournal $journal): ?Transaction
|
||||
{
|
||||
$result = $journal->transactions->first(
|
||||
static function (Transaction $transaction) {
|
||||
// type can also be liability.
|
||||
return AccountType::ASSET === $transaction->account->accountType->type;
|
||||
}
|
||||
);
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TransactionJournal $transfer
|
||||
*
|
||||
* @return Transaction|null
|
||||
*/
|
||||
private function getSourceTransaction(TransactionJournal $transfer): ?Transaction
|
||||
{
|
||||
return $transfer->transactions->firstWhere('amount', '<', 0);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return bool
|
||||
*/
|
||||
private function isExecuted(): bool
|
||||
{
|
||||
$configVar = app('fireflyconfig')->get(self::CONFIG_NAME, false);
|
||||
if (null !== $configVar) {
|
||||
return (bool)$configVar->data;
|
||||
}
|
||||
|
||||
return false; // @codeCoverageIgnore
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
private function markAsExecuted(): void
|
||||
{
|
||||
app('fireflyconfig')->set(self::CONFIG_NAME, true);
|
||||
}
|
||||
|
||||
/**
|
||||
* This method makes sure that the transaction journal uses the currency given in the transaction.
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
* @param Transaction $transaction
|
||||
*/
|
||||
private function updateJournalCurrency(TransactionJournal $journal, Transaction $transaction): void
|
||||
{
|
||||
$currency = $this->getCurrency($transaction->account);
|
||||
$currencyCode = $journal->transactionCurrency->code ?? '(nothing)';
|
||||
|
||||
if (null === $currency) {
|
||||
return;
|
||||
}
|
||||
|
||||
if (!((int)$currency->id === (int)$journal->transaction_currency_id)) {
|
||||
$this->count++;
|
||||
$this->line(
|
||||
sprintf(
|
||||
'Transfer #%d ("%s") has been updated to use %s instead of %s.',
|
||||
$journal->id,
|
||||
$journal->description,
|
||||
$currency->code,
|
||||
$currencyCode
|
||||
)
|
||||
);
|
||||
$journal->transaction_currency_id = $currency->id;
|
||||
$journal->save();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TransactionJournal $journal
|
||||
*/
|
||||
private function updateOtherJournalCurrency(TransactionJournal $journal): void
|
||||
{
|
||||
$transaction = $this->getFirstAssetTransaction($journal);
|
||||
if (null === $transaction) {
|
||||
return;
|
||||
}
|
||||
/** @var Account $account */
|
||||
$account = $transaction->account;
|
||||
$currency = $this->getCurrency($account);
|
||||
if (null === $currency) {
|
||||
return;
|
||||
}
|
||||
|
||||
$journal->transactions->each(
|
||||
static function (Transaction $transaction) use ($currency) {
|
||||
if (null === $transaction->transaction_currency_id) {
|
||||
$transaction->transaction_currency_id = $currency->id;
|
||||
$transaction->save();
|
||||
$this->count++;
|
||||
}
|
||||
|
||||
// when mismatch in transaction:
|
||||
if (!((int)$transaction->transaction_currency_id === (int)$currency->id)) {
|
||||
$transaction->foreign_currency_id = (int)$transaction->transaction_currency_id;
|
||||
$transaction->foreign_amount = $transaction->amount;
|
||||
$transaction->transaction_currency_id = $currency->id;
|
||||
$transaction->save();
|
||||
$this->count++;
|
||||
}
|
||||
}
|
||||
);
|
||||
// also update the journal, of course:
|
||||
$journal->transaction_currency_id = $currency->id;
|
||||
$this->count++;
|
||||
$journal->save();
|
||||
}
|
||||
|
||||
/**
|
||||
* This routine verifies that withdrawals, deposits and opening balances have the correct currency settings for
|
||||
* the accounts they are linked to.
|
||||
*
|
||||
* Both source and destination must match the respective currency preference of the related asset account.
|
||||
* So FF3 must verify all transactions.
|
||||
*
|
||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
||||
*/
|
||||
private function updateOtherJournalsCurrencies(): void
|
||||
{
|
||||
$set =
|
||||
$this->journalRepos->getAllJournals(
|
||||
[
|
||||
TransactionType::WITHDRAWAL,
|
||||
TransactionType::DEPOSIT,
|
||||
TransactionType::OPENING_BALANCE,
|
||||
TransactionType::RECONCILIATION,
|
||||
]
|
||||
);
|
||||
|
||||
/** @var TransactionJournal $journal */
|
||||
foreach ($set as $journal) {
|
||||
$this->updateOtherJournalCurrency($journal);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This method makes sure that the transaction uses the same currency as the source account does.
|
||||
* If not, the currency is updated to include a reference to its original currency as the "foreign" currency.
|
||||
*
|
||||
* The transaction that is sent to this function MUST be the source transaction (amount negative).
|
||||
*
|
||||
* Method is long and complex but I'll allow it. https://imgur.com/gallery/dVDJiez
|
||||
*
|
||||
* @SuppressWarnings(PHPMD.CyclomaticComplexity)
|
||||
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
||||
* @SuppressWarnings(PHPMD.NPathComplexity)
|
||||
*
|
||||
* @param TransactionJournal $journal
|
||||
* @param Transaction $source
|
||||
* @param Transaction $destination
|
||||
*/
|
||||
private function updateTransactionCurrency(TransactionJournal $journal, Transaction $source, Transaction $destination): void
|
||||
{
|
||||
$user = $journal->user;
|
||||
$sourceAccount = $source->account;
|
||||
$destAccount = $destination->account;
|
||||
$this->accountRepos->setUser($user);
|
||||
$this->journalRepos->setUser($user);
|
||||
$this->currencyRepos->setUser($user);
|
||||
|
||||
$sourceCurrency = $this->getCurrency($sourceAccount);
|
||||
$destCurrency = $this->getCurrency($destAccount);
|
||||
if (null === $sourceCurrency) {
|
||||
$message = sprintf('Account #%d ("%s") must have currency preference but has none.', $sourceAccount->id, $sourceAccount->name);
|
||||
Log::error($message);
|
||||
$this->error($message);
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
$this->noSourceAccountCurrency($source, $sourceCurrency);
|
||||
$this->unmatchedSourceTransaction($source, $sourceCurrency);
|
||||
$this->noDestAccountCurrency($destAccount, $destCurrency);
|
||||
|
||||
// if the destination account currency is the same, both foreign_amount and foreign_currency_id must be NULL for both transactions:
|
||||
if ((int)$destCurrency->id === (int)$sourceCurrency->id) {
|
||||
// update both transactions to match:
|
||||
$source->foreign_amount = null;
|
||||
$source->foreign_currency_id = null;
|
||||
$destination->foreign_amount = null;
|
||||
$destination->foreign_currency_id = null;
|
||||
$source->save();
|
||||
$destination->save();
|
||||
Log::debug(
|
||||
sprintf(
|
||||
'Currency for account "%s" is %s, and currency for account "%s" is also
|
||||
%s, so %s #%d (#%d and #%d) has been verified to be to %s exclusively.',
|
||||
$destAccount->name, $destCurrency->code,
|
||||
$sourceAccount->name, $sourceCurrency->code,
|
||||
$journal->transactionType->type, $journal->id,
|
||||
$source->id, $destination->id, $sourceCurrency->code
|
||||
)
|
||||
);
|
||||
$this->count++;
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
// if destination account currency is different, both transactions must have this currency as foreign currency id.
|
||||
if (!((int)$destCurrency->id === (int)$sourceCurrency->id)) {
|
||||
$source->foreign_currency_id = $destCurrency->id;
|
||||
$destination->foreign_currency_id = $destCurrency->id;
|
||||
$source->save();
|
||||
$destination->save();
|
||||
$this->count++;
|
||||
Log::debug(sprintf('Verified foreign currency ID of transaction #%d and #%d', $source->id, $destination->id));
|
||||
}
|
||||
|
||||
// if foreign amount of one is null and the other is not, use this to restore:
|
||||
if (null === $source->foreign_amount && null !== $destination->foreign_amount) {
|
||||
$source->foreign_amount = bcmul((string)$destination->foreign_amount, '-1');
|
||||
$source->save();
|
||||
$this->count++;
|
||||
Log::debug(sprintf('Restored foreign amount of source transaction (1) #%d to %s', $source->id, $source->foreign_amount));
|
||||
}
|
||||
|
||||
// if foreign amount of one is null and the other is not, use this to restore (other way around)
|
||||
if (null === $destination->foreign_amount && null !== $destination->foreign_amount) {
|
||||
$destination->foreign_amount = bcmul((string)$destination->foreign_amount, '-1');
|
||||
$destination->save();
|
||||
$this->count++;
|
||||
Log::debug(sprintf('Restored foreign amount of destination transaction (2) #%d to %s', $destination->id, $destination->foreign_amount));
|
||||
}
|
||||
|
||||
// when both are zero, try to grab it from journal:
|
||||
if (null === $source->foreign_amount && null === $destination->foreign_amount) {
|
||||
$foreignAmount = $this->journalRepos->getMetaField($journal, 'foreign_amount');
|
||||
if (null === $foreignAmount) {
|
||||
Log::debug(sprintf('Journal #%d has missing foreign currency data, forced to do 1:1 conversion :(.', $source->transaction_journal_id));
|
||||
$source->foreign_amount = $source->amount;
|
||||
$destination->foreign_amount = $destination->amount;
|
||||
$source->save();
|
||||
$destination->save();
|
||||
$this->count++;
|
||||
|
||||
return;
|
||||
}
|
||||
$foreignPositive = app('steam')->positive((string)$foreignAmount);
|
||||
Log::debug(
|
||||
sprintf(
|
||||
'Journal #%d has missing foreign currency info, try to restore from meta-data ("%s").',
|
||||
$source->transaction_journal_id,
|
||||
$foreignAmount
|
||||
)
|
||||
);
|
||||
$this->count++;
|
||||
$source->foreign_amount = bcmul($foreignPositive, '-1');
|
||||
$destination->foreign_amount = $foreignPositive;
|
||||
$source->save();
|
||||
$destination->save();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* This routine verifies that transfers have the correct currency settings for the accounts they are linked to.
|
||||
* For transfers, this is can be a destructive routine since we FORCE them into a currency setting whether they
|
||||
* like it or not. Previous routines MUST have set the currency setting for both accounts for this to work.
|
||||
*
|
||||
* A transfer always has the
|
||||
*
|
||||
* Both source and destination must match the respective currency preference. So FF3 must verify ALL
|
||||
* transactions.
|
||||
*/
|
||||
private function updateTransferCurrencies(): void
|
||||
{
|
||||
$set = $this->journalRepos->getAllJournals([TransactionType::TRANSFER]);
|
||||
/** @var TransactionJournal $journal */
|
||||
foreach ($set as $journal) {
|
||||
$this->updateTransferCurrency($journal);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param TransactionJournal $transfer
|
||||
*/
|
||||
private function updateTransferCurrency(TransactionJournal $transfer): void
|
||||
{
|
||||
$sourceTransaction = $this->getSourceTransaction($transfer);
|
||||
$destTransaction = $this->getDestinationTransaction($transfer);
|
||||
|
||||
// @codeCoverageIgnoreStart
|
||||
if (null === $sourceTransaction) {
|
||||
$this->info(sprintf('Source transaction for journal #%d is null.', $transfer->id));
|
||||
|
||||
return;
|
||||
}
|
||||
if (null === $destTransaction) {
|
||||
$this->info(sprintf('Destination transaction for journal #%d is null.', $transfer->id));
|
||||
|
||||
return;
|
||||
}
|
||||
// @codeCoverageIgnoreEnd
|
||||
|
||||
$this->updateTransactionCurrency($transfer, $sourceTransaction, $destTransaction);
|
||||
$this->updateJournalCurrency($transfer, $sourceTransaction);
|
||||
}
|
||||
|
||||
/**
|
||||
* Has no currency ID? Must have, so fill in using account preference.
|
||||
*
|
||||
* @param Transaction $source
|
||||
* @param TransactionCurrency $sourceCurrency
|
||||
*/
|
||||
private function noSourceAccountCurrency(Transaction $source, ?TransactionCurrency $sourceCurrency): void
|
||||
{
|
||||
if (null === $source->transaction_currency_id && null !== $sourceCurrency) {
|
||||
$source->transaction_currency_id = (int)$sourceCurrency->id;
|
||||
$message = sprintf('Transaction #%d has no currency setting, now set to %s.', $source->id, $sourceCurrency->code);
|
||||
Log::debug($message);
|
||||
$this->line($message);
|
||||
$this->count++;
|
||||
$source->save();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Does not match the source account (see above)? Can be fixed
|
||||
* when mismatch in transaction and NO foreign amount is set.
|
||||
*
|
||||
* @param Transaction $source
|
||||
* @param TransactionCurrency $sourceCurrency|null
|
||||
*/
|
||||
private function unmatchedSourceTransaction(Transaction $source, ?TransactionCurrency $sourceCurrency): void
|
||||
{
|
||||
if (null !== $sourceCurrency && !((int)$source->transaction_currency_id === (int)$sourceCurrency->id) && null === $source->foreign_amount) {
|
||||
$message = sprintf(
|
||||
'Transaction #%d has a currency setting #%d that should be #%d. Amount remains %s, currency is changed.',
|
||||
$source->id,
|
||||
$source->transaction_currency_id,
|
||||
$sourceCurrency->id,
|
||||
$source->amount
|
||||
);
|
||||
Log::debug($message);
|
||||
$this->line($message);
|
||||
$this->count++;
|
||||
$source->transaction_currency_id = (int)$sourceCurrency->id;
|
||||
$source->save();
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Account $destAccount
|
||||
* @param TransactionCurrency|null $destCurrency
|
||||
*/
|
||||
private function noDestAccountCurrency(Account $destAccount, ?TransactionCurrency $destCurrency): void
|
||||
{
|
||||
if (null === $destCurrency) {
|
||||
$message = sprintf('Account #%d ("%s") must have currency preference but has none.', $destAccount->id, $destAccount->name);
|
||||
Log::error($message);
|
||||
$this->line($message);
|
||||
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -64,7 +64,8 @@ class UpgradeDatabase extends Command
|
||||
$commands = [
|
||||
'firefly-iii:transaction-identifiers',
|
||||
'firefly-iii:account-currencies',
|
||||
'firefly-iii:journal-currencies',
|
||||
'firefly-iii:transfer-currencies',
|
||||
'firefly-iii:other-currencies',
|
||||
'firefly-iii:migrate-notes',
|
||||
'firefly-iii:migrate-attachments',
|
||||
'firefly-iii:bills-to-rules',
|
||||
|
||||
@ -67,13 +67,14 @@ class InstallController extends Controller
|
||||
$this->upgradeCommands = [
|
||||
// there are x initial commands
|
||||
'migrate' => ['--seed' => true, '--force' => true],
|
||||
'firefly-iii:decrypt-all' => [],
|
||||
'firefly-iii:decrypt-all' => [],
|
||||
'generate-keys' => [], // an exception :(
|
||||
|
||||
// there are 10 upgrade commands.
|
||||
'firefly-iii:transaction-identifiers' => [],
|
||||
'firefly-iii:account-currencies' => [],
|
||||
'firefly-iii:journal-currencies' => [],
|
||||
'firefly-iii:transfer-currencies' => [],
|
||||
'firefly-iii:other-currencies' => [],
|
||||
'firefly-iii:migrate-notes' => [],
|
||||
'firefly-iii:migrate-attachments' => [],
|
||||
'firefly-iii:bills-to-rules' => [],
|
||||
|
||||
@ -132,11 +132,12 @@
|
||||
],
|
||||
"post-update-cmd": [
|
||||
"@php artisan cache:clear",
|
||||
"@php artisan firefly:decrypt-all",
|
||||
"@php artisan firefly-iii:decrypt-all",
|
||||
|
||||
"@php artisan firefly-iii:transaction-identifiers",
|
||||
"@php artisan firefly-iii:account-currencies",
|
||||
"@php artisan firefly-iii:journal-currencies",
|
||||
"@php artisan firefly-iii:transfer-currencies",
|
||||
"@php artisan firefly-iii:other-currencies",
|
||||
"@php artisan firefly-iii:migrate-notes",
|
||||
"@php artisan firefly-iii:migrate-attachments",
|
||||
"@php artisan firefly-iii:bills-to-rules",
|
||||
|
||||
Loading…
Reference in New Issue
Block a user