diff --git a/app/Handlers/Events/StoredJournalEventHandler.php b/app/Handlers/Events/StoredJournalEventHandler.php index ade9536765..2378bcf70d 100644 --- a/app/Handlers/Events/StoredJournalEventHandler.php +++ b/app/Handlers/Events/StoredJournalEventHandler.php @@ -16,6 +16,7 @@ namespace FireflyIII\Handlers\Events; use FireflyIII\Events\StoredTransactionJournal; use FireflyIII\Models\PiggyBank; use FireflyIII\Models\PiggyBankEvent; +use FireflyIII\Models\PiggyBankRepetition; use FireflyIII\Models\Rule; use FireflyIII\Models\RuleGroup; use FireflyIII\Models\TransactionJournal; @@ -33,79 +34,40 @@ class StoredJournalEventHandler /** * This method connects a new transfer to a piggy bank. * - * @param StoredTransactionJournal $storedJournalEvent + * @param StoredTransactionJournal $event * * @return bool */ - public function connectToPiggyBank(StoredTransactionJournal $storedJournalEvent): bool + public function connectToPiggyBank(StoredTransactionJournal $event): bool { /** @var TransactionJournal $journal */ - $journal = $storedJournalEvent->journal; - $piggyBankId = $storedJournalEvent->piggyBankId; - + $journal = $event->journal; + $piggyBankId = $event->piggyBankId; Log::debug(sprintf('Trying to connect journal %d to piggy bank %d.', $journal->id, $piggyBankId)); - /** @var PiggyBank $piggyBank */ - $piggyBank = $journal->user->piggyBanks()->where('piggy_banks.id', $piggyBankId)->first(['piggy_banks.*']); - - if (is_null($piggyBank)) { - Log::error('No such piggy bank!'); - - return true; - } - Log::debug(sprintf('Found piggy bank #%d: "%s"', $piggyBank->id, $piggyBank->name)); - // update piggy bank rep for date of transaction journal. - $repetition = $piggyBank->piggyBankRepetitions()->relevantOnDate($journal->date)->first(); - if (is_null($repetition)) { - Log::error(sprintf('No piggy bank repetition on %s!', $journal->date->format('Y-m-d'))); + /* + * Verify existence of piggy bank: + */ + if (!$this->verifyExistence($event)) { + Log::error('No such piggy bank or no repetition on %s', $journal->date->format('Y-m-d')); return true; } - $amount = TransactionJournal::amountPositive($journal); - Log::debug(sprintf('Will add/remove %f to piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); - // if piggy account matches source account, the amount is positive - $sources = TransactionJournal::sourceAccountList($journal)->pluck('id')->toArray(); - if (in_array($piggyBank->account_id, $sources)) { - $amount = bcmul($amount, '-1'); - Log::debug(sprintf('Account #%d is the source, so will remove amount from piggy bank.', $piggyBank->account_id)); - } - - // if the amount is positive: - // make sure it fits in piggy bank: - if (bccomp($amount, '0') === 1) { - // amount is positive - $room = bcsub(strval($piggyBank->targetamount), strval($repetition->currentamount)); - Log::debug(sprintf('Room in piggy bank for extra money is %f', $room)); - if (bccomp($room, $amount) === -1) { - // $room is smaller than $amount - Log::debug(sprintf('There is NO room to add %f to piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); - Log::debug(sprintf('New amount is %f', $room)); - $amount = $room; - } - } - - if (bccomp($amount, '0') === -1) { - // amount is negative - Log::debug(sprintf('Max amount to remove is %f', $repetition->currentamount)); - $compare = bcmul($repetition->currentamount, '-1'); - if (bccomp($compare, $amount) === 1) { - // $currentamount is smaller than $amount - Log::debug(sprintf('Cannot remove %f from piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); - Log::debug(sprintf('New amount is %f', $compare)); - $amount = $compare; - } - } - - + /* + * Get relevant data: + */ + $piggyBank = $journal->user->piggyBanks()->where('piggy_banks.id', $piggyBankId)->first(['piggy_banks.*']); + $repetition = $piggyBank->piggyBankRepetitions()->relevantOnDate($journal->date)->first(); + $amount = $this->getExactAmount($journal, $piggyBank, $repetition); $repetition->currentamount = bcadd($repetition->currentamount, $amount); $repetition->save(); - /** @var PiggyBankEvent $storedJournalEvent */ - $storedJournalEvent = PiggyBankEvent::create( + /** @var PiggyBankEvent $event */ + $event = PiggyBankEvent::create( ['piggy_bank_id' => $piggyBank->id, 'transaction_journal_id' => $journal->id, 'date' => $journal->date, 'amount' => $amount] ); - Log::debug(sprintf('Created piggy bank event #%d', $storedJournalEvent->id)); + Log::debug(sprintf('Created piggy bank event #%d', $event->id)); return true; } @@ -161,4 +123,78 @@ class StoredJournalEventHandler return true; } + + /** + * @param TransactionJournal $journal + * @param PiggyBank $piggyBank + * @param PiggyBankRepetition $repetition + * + * @return string + */ + private function getExactAmount(TransactionJournal $journal, PiggyBank $piggyBank, PiggyBankRepetition $repetition): string + { + $amount = TransactionJournal::amountPositive($journal); + $sources = TransactionJournal::sourceAccountList($journal)->pluck('id')->toArray(); + $room = bcsub(strval($piggyBank->targetamount), strval($repetition->currentamount)); + $compare = bcmul($repetition->currentamount, '-1'); + + Log::debug(sprintf('Will add/remove %f to piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); + + // if piggy account matches source account, the amount is positive + if (in_array($piggyBank->account_id, $sources)) { + $amount = bcmul($amount, '-1'); + Log::debug(sprintf('Account #%d is the source, so will remove amount from piggy bank.', $piggyBank->account_id)); + } + + + // if the amount is positive, make sure it fits in piggy bank: + if (bccomp($amount, '0') === 1 && bccomp($room, $amount) === -1) { + // amount is positive and $room is smaller than $amount + Log::debug(sprintf('Room in piggy bank for extra money is %f', $room)); + Log::debug(sprintf('There is NO room to add %f to piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); + Log::debug(sprintf('New amount is %f', $room)); + $amount = $room; + } + + // amount is negative and $currentamount is smaller than $amount + if (bccomp($amount, '0') === -1 && bccomp($compare, $amount) === 1) { + Log::debug(sprintf('Max amount to remove is %f', $repetition->currentamount)); + Log::debug(sprintf('Cannot remove %f from piggy bank #%d ("%s")', $amount, $piggyBank->id, $piggyBank->name)); + Log::debug(sprintf('New amount is %f', $compare)); + $amount = $compare; + } + + return $amount; + } + + /** + * @param StoredTransactionJournal $event + * + * @return bool + */ + private function verifyExistence(StoredTransactionJournal $event): bool + { + /** @var TransactionJournal $journal */ + $journal = $event->journal; + $piggyBankId = $event->piggyBankId; + + /** @var PiggyBank $piggyBank */ + $piggyBank = $journal->user->piggyBanks()->where('piggy_banks.id', $piggyBankId)->first(['piggy_banks.*']); + + if (is_null($piggyBank)) { + Log::error('No such piggy bank!'); + + return false; + } + Log::debug(sprintf('Found piggy bank #%d: "%s"', $piggyBank->id, $piggyBank->name)); + // update piggy bank rep for date of transaction journal. + $repetition = $piggyBank->piggyBankRepetitions()->relevantOnDate($journal->date)->first(); + if (is_null($repetition)) { + Log::error(sprintf('No piggy bank repetition on %s!', $journal->date->format('Y-m-d'))); + + return false; + } + + return true; + } }