firefly-iii/app/Services/Internal/Support/RecurringTransactionTrait.php

<?php
/**
 * RecurringTransactionTrait.php
 * Copyright (c) 2018 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\Services\Internal\Support;

use Exception;
use FireflyIII\Factory\BudgetFactory;
use FireflyIII\Factory\CategoryFactory;
use FireflyIII\Factory\PiggyBankFactory;
use FireflyIII\Factory\TransactionCurrencyFactory;
use FireflyIII\Models\Account;
use FireflyIII\Models\AccountType;
use FireflyIII\Models\Recurrence;
use FireflyIII\Models\RecurrenceMeta;
use FireflyIII\Models\RecurrenceRepetition;
use FireflyIII\Models\RecurrenceTransaction;
use FireflyIII\Models\RecurrenceTransactionMeta;
use FireflyIII\Models\TransactionType;
use Log;


/**
 * Trait RecurringTransactionTrait
 *
 */
trait RecurringTransactionTrait
{
    /**
     * @param Recurrence $recurrence
     * @param array      $repetitions
     */
    public function createRepetitions(Recurrence $recurrence, array $repetitions): void
    {
        /** @var array $array */
        foreach ($repetitions as $array) {
            RecurrenceRepetition::create(
                [
                    'recurrence_id'     => $recurrence->id,
                    'repetition_type'   => $array['type'],
                    'repetition_moment' => $array['moment'],
                    'repetition_skip'   => $array['skip'],
                    'weekend'           => $array['weekend'] ?? 1,
                ]
            );

        }
    }

    /**
     * Store transactions of a recurring transactions. It's complex but readable.
     *
     * @param Recurrence $recurrence
     * @param array      $transactions
     * @SuppressWarnings(PHPMD.CyclomaticComplexity)
     * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
     */
    public function createTransactions(Recurrence $recurrence, array $transactions): void
    {
        foreach ($transactions as $array) {
            $source      = null;
            $destination = null;
            switch ($recurrence->transactionType->type) {
                case TransactionType::WITHDRAWAL:
                    $source      = $this->findAccount(AccountType::ASSET, null, $array['source_id'], $array['source_name']);
                    $destination = $this->findAccount(AccountType::EXPENSE,null,  $array['destination_id'], $array['destination_name']);
                    break;
                case TransactionType::DEPOSIT:
                    $source      = $this->findAccount(AccountType::REVENUE, null, $array['source_id'], $array['source_name']);
                    $destination = $this->findAccount(AccountType::ASSET, null, $array['destination_id'], $array['destination_name']);
                    break;
                case TransactionType::TRANSFER:
                    $source      = $this->findAccount(AccountType::ASSET,null,  $array['source_id'], $array['source_name']);
                    $destination = $this->findAccount(AccountType::ASSET, null, $array['destination_id'], $array['destination_name']);
                    break;
            }

            /** @var TransactionCurrencyFactory $factory */
            $factory         = app(TransactionCurrencyFactory::class);
            $currency        = $factory->find($array['currency_id'] ?? null, $array['currency_code'] ?? null);
            $foreignCurrency = $factory->find($array['foreign_currency_id'] ?? null, $array['foreign_currency_code'] ?? null);
            if (null === $currency) {
                $currency = app('amount')->getDefaultCurrencyByUser($recurrence->user);
            }
            $transaction = new RecurrenceTransaction(
                [
                    'recurrence_id'           => $recurrence->id,
                    'transaction_currency_id' => $currency->id,
                    'foreign_currency_id'     => null === $foreignCurrency ? null : $foreignCurrency->id,
                    'source_id'               => $source->id,
                    'destination_id'          => $destination->id,
                    'amount'                  => $array['amount'],
                    'foreign_amount'          => '' === (string)$array['foreign_amount'] ? null : (string)$array['foreign_amount'],
                    'description'             => $array['description'],
                ]
            );
            $transaction->save();

            /** @var BudgetFactory $budgetFactory */
            $budgetFactory = app(BudgetFactory::class);
            $budgetFactory->setUser($recurrence->user);
            $budget = $budgetFactory->find($array['budget_id'], $array['budget_name']);

            /** @var CategoryFactory $categoryFactory */
            $categoryFactory = app(CategoryFactory::class);
            $categoryFactory->setUser($recurrence->user);
            $category = $categoryFactory->findOrCreate($array['category_id'], $array['category_name']);

            // create recurrence transaction meta:
            if (null !== $budget) {
                RecurrenceTransactionMeta::create(
                    [
                        'rt_id' => $transaction->id,
                        'name'  => 'budget_id',
                        'value' => $budget->id,
                    ]
                );
            }
            if (null !== $category) {
                RecurrenceTransactionMeta::create(
                    [
                        'rt_id' => $transaction->id,
                        'name'  => 'category_name',
                        'value' => $category->name,
                    ]
                );
            }
        }
    }

    /**
     * @param Recurrence $recurrence
     */
    public function deleteRepetitions(Recurrence $recurrence): void
    {
        $recurrence->recurrenceRepetitions()->delete();
    }

    /**
     * @param Recurrence $recurrence
     */
    public function deleteTransactions(Recurrence $recurrence): void
    {
        /** @var RecurrenceTransaction $transaction */
        foreach ($recurrence->recurrenceTransactions as $transaction) {
            $transaction->recurrenceTransactionMeta()->delete();
            try {
                $transaction->delete();
            } catch (Exception $e) {
                Log::debug($e->getMessage());
            }
        }
    }

    /**
     * @param null|string  $expectedType
     * @param Account|null $account
     * @param int|null     $accountId
     * @param null|string  $accountName
     *
     * @return Account|null
     */
    abstract public function findAccount(?string $expectedType, ?Account $account, ?int $accountId, ?string $accountName): ?Account;

    /**
     * Update meta data for recurring transaction.
     *
     * @param Recurrence $recurrence
     * @param array      $data
     */
    public function updateMetaData(Recurrence $recurrence, array $data): void
    {
        // only two special meta fields right now. Let's just hard code them.
        $piggyId   = (int)($data['meta']['piggy_bank_id'] ?? 0.0);
        $piggyName = $data['meta']['piggy_bank_name'] ?? '';
        $this->updatePiggyBank($recurrence, $piggyId, $piggyName);


        $tags = $data['meta']['tags'] ?? [];
        $this->updateTags($recurrence, $tags);

    }

    /**
     * @param Recurrence $recurrence
     * @param int        $piggyId
     * @param string     $piggyName
     */
    protected function updatePiggyBank(Recurrence $recurrence, int $piggyId, string $piggyName): void
    {

        /** @var PiggyBankFactory $factory */
        $factory = app(PiggyBankFactory::class);
        $factory->setUser($recurrence->user);
        $piggyBank = $factory->find($piggyId, $piggyName);
        if (null !== $piggyBank) {
            /** @var RecurrenceMeta $entry */
            $entry = $recurrence->recurrenceMeta()->where('name', 'piggy_bank_id')->first();
            if (null === $entry) {
                $entry = RecurrenceMeta::create(['recurrence_id' => $recurrence->id, 'name' => 'piggy_bank_id', 'value' => $piggyBank->id]);
            }
            $entry->value = $piggyBank->id;
            $entry->save();
        }
        if (null === $piggyBank) {
            // delete if present
            $recurrence->recurrenceMeta()->where('name', 'piggy_bank_id')->delete();
        }
    }

    /**
     * @param Recurrence $recurrence
     * @param array      $tags
     */
    protected function updateTags(Recurrence $recurrence, array $tags): void
    {
        if (\count($tags) > 0) {
            /** @var RecurrenceMeta $entry */
            $entry = $recurrence->recurrenceMeta()->where('name', 'tags')->first();
            if (null === $entry) {
                $entry = RecurrenceMeta::create(['recurrence_id' => $recurrence->id, 'name' => 'tags', 'value' => implode(',', $tags)]);
            }
            $entry->value = implode(',', $tags);
            $entry->save();
        }
        if (0 === \count($tags)) {
            // delete if present
            $recurrence->recurrenceMeta()->where('name', 'tags')->delete();
        }
    }
}