mirror of
https://github.com/firefly-iii/firefly-iii.git
synced 2025-10-31 02:36:28 +00:00
316 lines
14 KiB
PHP
316 lines
14 KiB
PHP
<?php
|
|
|
|
/*
|
|
* TransactionGroupTransformer.php
|
|
* Copyright (c) 2022 james@firefly-iii.org
|
|
*
|
|
* This file is part of Firefly III (https://github.com/firefly-iii).
|
|
*
|
|
* 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/>.
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace FireflyIII\Transformers\V2;
|
|
|
|
use Carbon\Carbon;
|
|
use FireflyIII\Exceptions\FireflyException;
|
|
use FireflyIII\Models\Note;
|
|
use FireflyIII\Models\TransactionCurrency;
|
|
use FireflyIII\Models\TransactionJournal;
|
|
use FireflyIII\Models\TransactionJournalMeta;
|
|
use FireflyIII\Models\TransactionType;
|
|
use FireflyIII\Support\Http\Api\ExchangeRateConverter;
|
|
use FireflyIII\Support\NullArrayObject;
|
|
use Illuminate\Support\Collection;
|
|
use Illuminate\Support\Facades\DB;
|
|
use Illuminate\Support\Facades\Log;
|
|
|
|
/**
|
|
* Class TransactionGroupTransformer
|
|
*/
|
|
class TransactionGroupTransformer extends AbstractTransformer
|
|
{
|
|
private ExchangeRateConverter $converter;
|
|
private array $currencies = [];
|
|
private TransactionCurrency $default;
|
|
private array $meta;
|
|
private array $notes;
|
|
private array $tags;
|
|
|
|
public function collectMetaData(Collection $objects): void
|
|
{
|
|
// start with currencies:
|
|
$currencies = [];
|
|
$journals = [];
|
|
|
|
/** @var array $object */
|
|
foreach ($objects as $object) {
|
|
foreach ($object['sums'] as $sum) {
|
|
$id = (int) $sum['currency_id'];
|
|
$currencies[$id] ??= TransactionCurrency::find($sum['currency_id']);
|
|
}
|
|
|
|
/** @var array $transaction */
|
|
foreach ($object['transactions'] as $transaction) {
|
|
$id = (int) $transaction['transaction_journal_id'];
|
|
$journals[$id] = [];
|
|
}
|
|
}
|
|
$this->currencies = $currencies;
|
|
$this->default = app('amount')->getDefaultCurrency();
|
|
|
|
// grab meta for all journals:
|
|
$meta = TransactionJournalMeta::whereIn('transaction_journal_id', array_keys($journals))->get();
|
|
|
|
/** @var TransactionJournalMeta $entry */
|
|
foreach ($meta as $entry) {
|
|
$id = $entry->transaction_journal_id;
|
|
$this->meta[$id][$entry->name] = $entry->data;
|
|
}
|
|
|
|
// grab all notes for all journals:
|
|
$notes = Note::whereNoteableType(TransactionJournal::class)->whereIn('noteable_id', array_keys($journals))->get();
|
|
|
|
/** @var Note $note */
|
|
foreach ($notes as $note) {
|
|
$id = $note->noteable_id;
|
|
$this->notes[$id] = $note;
|
|
}
|
|
|
|
// grab all tags for all journals:
|
|
$tags = DB::table('tag_transaction_journal')
|
|
->leftJoin('tags', 'tags.id', 'tag_transaction_journal.tag_id')
|
|
->whereIn('tag_transaction_journal.transaction_journal_id', array_keys($journals))
|
|
->get(['tag_transaction_journal.transaction_journal_id', 'tags.tag'])
|
|
;
|
|
|
|
/** @var \stdClass $tag */
|
|
foreach ($tags as $tag) {
|
|
$id = (int) $tag->transaction_journal_id;
|
|
$this->tags[$id][] = $tag->tag;
|
|
}
|
|
|
|
// create converter
|
|
Log::debug(sprintf('Created new ExchangeRateConverter in %s', __METHOD__));
|
|
$this->converter = new ExchangeRateConverter();
|
|
}
|
|
|
|
public function transform(array $group): array
|
|
{
|
|
$first = reset($group['transactions']);
|
|
|
|
return [
|
|
'id' => (string) $group['id'],
|
|
'created_at' => $first['created_at']->toAtomString(),
|
|
'updated_at' => $first['updated_at']->toAtomString(),
|
|
'user' => (string) $first['user_id'],
|
|
'user_group' => (string) $first['user_group_id'],
|
|
'group_title' => $group['title'] ?? null,
|
|
'transactions' => $this->transformTransactions($group['transactions'] ?? []),
|
|
'links' => [
|
|
[
|
|
'rel' => 'self',
|
|
'uri' => sprintf('/transactions/%d', $group['id']),
|
|
],
|
|
],
|
|
];
|
|
}
|
|
|
|
private function transformTransactions(array $transactions): array
|
|
{
|
|
$return = [];
|
|
|
|
/** @var array $transaction */
|
|
foreach ($transactions as $transaction) {
|
|
$return[] = $this->transformTransaction($transaction);
|
|
}
|
|
|
|
return $return;
|
|
}
|
|
|
|
/**
|
|
* @throws FireflyException
|
|
*
|
|
* @SuppressWarnings(PHPMD.ExcessiveMethodLength)
|
|
*/
|
|
private function transformTransaction(array $transaction): array
|
|
{
|
|
$transaction = new NullArrayObject($transaction);
|
|
$type = $this->stringFromArray($transaction, 'transaction_type_type', TransactionType::WITHDRAWAL);
|
|
$journalId = (int) $transaction['transaction_journal_id'];
|
|
$meta = new NullArrayObject($this->meta[$journalId] ?? []);
|
|
|
|
/**
|
|
* Convert and use amount:
|
|
*/
|
|
$amount = app('steam')->positive((string) ($transaction['amount'] ?? '0'));
|
|
$currencyId = (int) $transaction['currency_id'];
|
|
$nativeAmount = $this->converter->convert($this->default, $this->currencies[$currencyId], $transaction['date'], $amount);
|
|
$foreignAmount = null;
|
|
$nativeForeignAmount = null;
|
|
if (null !== $transaction['foreign_amount']) {
|
|
$foreignCurrencyId = (int) $transaction['foreign_currency_id'];
|
|
$foreignAmount = app('steam')->positive($transaction['foreign_amount']);
|
|
$nativeForeignAmount = $this->converter->convert($this->default, $this->currencies[$foreignCurrencyId], $transaction['date'], $foreignAmount);
|
|
}
|
|
$this->converter->summarize();
|
|
|
|
return [
|
|
'user' => (string) $transaction['user_id'],
|
|
'user_group' => (string) $transaction['user_group_id'],
|
|
'transaction_journal_id' => (string) $transaction['transaction_journal_id'],
|
|
'type' => strtolower($type),
|
|
'date' => $transaction['date']->toAtomString(),
|
|
'order' => $transaction['order'],
|
|
'amount' => $amount,
|
|
'native_amount' => $nativeAmount,
|
|
'foreign_amount' => $foreignAmount,
|
|
'native_foreign_amount' => $nativeForeignAmount,
|
|
'currency_id' => (string) $transaction['currency_id'],
|
|
'currency_code' => $transaction['currency_code'],
|
|
'currency_name' => $transaction['currency_name'],
|
|
'currency_symbol' => $transaction['currency_symbol'],
|
|
'currency_decimal_places' => (int) $transaction['currency_decimal_places'],
|
|
|
|
// converted to native currency
|
|
'native_currency_id' => (string) $this->default->id,
|
|
'native_currency_code' => $this->default->code,
|
|
'native_currency_name' => $this->default->name,
|
|
'native_currency_symbol' => $this->default->symbol,
|
|
'native_currency_decimal_places' => $this->default->decimal_places,
|
|
|
|
// foreign currency amount:
|
|
'foreign_currency_id' => $this->stringFromArray($transaction, 'foreign_currency_id', null),
|
|
'foreign_currency_code' => $transaction['foreign_currency_code'],
|
|
'foreign_currency_name' => $transaction['foreign_currency_name'],
|
|
'foreign_currency_symbol' => $transaction['foreign_currency_symbol'],
|
|
'foreign_currency_decimal_places' => $transaction['foreign_currency_decimal_places'],
|
|
|
|
// foreign converted to native:
|
|
'description' => $transaction['description'],
|
|
'source_id' => (string) $transaction['source_account_id'],
|
|
'source_name' => $transaction['source_account_name'],
|
|
'source_iban' => $transaction['source_account_iban'],
|
|
'source_type' => $transaction['source_account_type'],
|
|
'destination_id' => (string) $transaction['destination_account_id'],
|
|
'destination_name' => $transaction['destination_account_name'],
|
|
'destination_iban' => $transaction['destination_account_iban'],
|
|
'destination_type' => $transaction['destination_account_type'],
|
|
'budget_id' => $this->stringFromArray($transaction, 'budget_id', null),
|
|
'budget_name' => $transaction['budget_name'],
|
|
'category_id' => $this->stringFromArray($transaction, 'category_id', null),
|
|
'category_name' => $transaction['category_name'],
|
|
'bill_id' => $this->stringFromArray($transaction, 'bill_id', null),
|
|
'bill_name' => $transaction['bill_name'],
|
|
'reconciled' => $transaction['reconciled'],
|
|
'notes' => $this->notes[$journalId] ?? null,
|
|
'tags' => $this->tags[$journalId] ?? [],
|
|
'internal_reference' => $meta['internal_reference'],
|
|
'external_id' => $meta['external_id'],
|
|
'original_source' => $meta['original_source'],
|
|
'recurrence_id' => $meta['recurrence_id'],
|
|
'recurrence_total' => $meta['recurrence_total'],
|
|
'recurrence_count' => $meta['recurrence_count'],
|
|
'external_url' => $meta['external_url'],
|
|
'import_hash_v2' => $meta['import_hash_v2'],
|
|
'sepa_cc' => $meta['sepa_cc'],
|
|
'sepa_ct_op' => $meta['sepa_ct_op'],
|
|
'sepa_ct_id' => $meta['sepa_ct_id'],
|
|
'sepa_db' => $meta['sepa_db'],
|
|
'sepa_country' => $meta['sepa_country'],
|
|
'sepa_ep' => $meta['sepa_ep'],
|
|
'sepa_ci' => $meta['sepa_ci'],
|
|
'sepa_batch_id' => $meta['sepa_batch_id'],
|
|
'interest_date' => $this->date($meta['interest_date']),
|
|
'book_date' => $this->date($meta['book_date']),
|
|
'process_date' => $this->date($meta['process_date']),
|
|
'due_date' => $this->date($meta['due_date']),
|
|
'payment_date' => $this->date($meta['payment_date']),
|
|
'invoice_date' => $this->date($meta['invoice_date']),
|
|
|
|
// location data
|
|
// 'longitude' => $longitude,
|
|
// 'latitude' => $latitude,
|
|
// 'zoom_level' => $zoomLevel,
|
|
//
|
|
// 'has_attachments' => $this->hasAttachments((int) $row['transaction_journal_id']),
|
|
];
|
|
}
|
|
|
|
/**
|
|
* TODO also in the old transformer.
|
|
*
|
|
* Used to extract a value from the given array, and fall back on a sensible default or NULL
|
|
* if it can't be helped.
|
|
*/
|
|
private function stringFromArray(NullArrayObject $array, string $key, ?string $default): ?string
|
|
{
|
|
// app('log')->debug(sprintf('%s: %s', $key, var_export($array[$key], true)));
|
|
if (null === $array[$key] && null === $default) {
|
|
return null;
|
|
}
|
|
if (0 === $array[$key]) {
|
|
return $default;
|
|
}
|
|
if ('0' === $array[$key]) {
|
|
return $default;
|
|
}
|
|
if (null !== $array[$key]) {
|
|
return (string) $array[$key];
|
|
}
|
|
|
|
if (null !== $default) {
|
|
return $default;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private function date(?string $string): ?Carbon
|
|
{
|
|
if (null === $string) {
|
|
return null;
|
|
}
|
|
// app('log')->debug(sprintf('Now in date("%s")', $string));
|
|
if (10 === strlen($string)) {
|
|
$res = Carbon::createFromFormat('Y-m-d', $string, config('app.timezone'));
|
|
if (false === $res) {
|
|
return null;
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
if (25 === strlen($string)) {
|
|
return Carbon::parse($string, config('app.timezone'));
|
|
}
|
|
if (19 === strlen($string) && str_contains($string, 'T')) {
|
|
$res = Carbon::createFromFormat('Y-m-d\TH:i:s', substr($string, 0, 19), config('app.timezone'));
|
|
if (false === $res) {
|
|
return null;
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
|
|
// 2022-01-01 01:01:01
|
|
$res = Carbon::createFromFormat('Y-m-d H:i:s', substr($string, 0, 19), config('app.timezone'));
|
|
if (false === $res) {
|
|
return null;
|
|
}
|
|
|
|
return $res;
|
|
}
|
|
}
|