Merge remote-tracking branch 'upstream/develop' into feat/expression-engine

2025-10-31 02:36:28 +00:00 · 2024-03-07 13:09:43 -05:00
parent bee219ebf7 429e72e681
commit 41fc1e8f82
79 changed files with 1463 additions and 1777 deletions
--- a/app/Api/V2/Controllers/Model/Account/IndexController.php
+++ b/app/Api/V2/Controllers/Model/Account/IndexController.php
@@ -0,0 +1,101 @@
+<?php
+/*
+ * IndexController.php
+ * Copyright (c) 2024 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\Api\V2\Controllers\Model\Account;
+
+use FireflyIII\Api\V2\Controllers\Controller;
+use FireflyIII\Api\V2\Request\Model\Account\IndexRequest;
+use FireflyIII\Api\V2\Request\Model\Transaction\InfiniteListRequest;
+use FireflyIII\Repositories\UserGroups\Account\AccountRepositoryInterface;
+use FireflyIII\Transformers\V2\AccountTransformer;
+use Illuminate\Http\JsonResponse;
+use Illuminate\Pagination\LengthAwarePaginator;
+
+class IndexController extends Controller
+{
+    public const string RESOURCE_KEY = 'accounts';
+
+    private AccountRepositoryInterface $repository;
+
+    /**
+     * AccountController constructor.
+     */
+    public function __construct()
+    {
+        parent::__construct();
+        $this->middleware(
+            function ($request, $next) {
+                $this->repository = app(AccountRepositoryInterface::class);
+                // new way of user group validation
+                $userGroup        = $this->validateUserGroup($request);
+                if (null !== $userGroup) {
+                    $this->repository->setUserGroup($userGroup);
+                }
+
+                return $next($request);
+            }
+        );
+    }
+
+    /**
+     * TODO see autocomplete/accountcontroller for list.
+     */
+    public function index(IndexRequest $request): JsonResponse
+    {
+        $this->repository->resetAccountOrder();
+        $types       = $request->getAccountTypes();
+        $accounts    = $this->repository->getAccountsByType($types);
+        $pageSize    = $this->parameters->get('limit');
+        $count       = $accounts->count();
+        $accounts    = $accounts->slice(($this->parameters->get('page') - 1) * $pageSize, $pageSize);
+        $paginator   = new LengthAwarePaginator($accounts, $count, $pageSize, $this->parameters->get('page'));
+        $transformer = new AccountTransformer();
+        $transformer->setParameters($this->parameters); // give params to transformer
+
+        return response()
+            ->json($this->jsonApiList('accounts', $paginator, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE)
+        ;
+    }
+
+    public function infiniteList(InfiniteListRequest $request): JsonResponse
+    {
+        $this->repository->resetAccountOrder();
+
+        // get accounts of the specified type, and return.
+        $types       = $request->getAccountTypes();
+
+        // get from repository
+        $accounts    = $this->repository->getAccountsInOrder($types, $request->getSortInstructions('accounts'), $request->getStartRow(), $request->getEndRow());
+        $total       = $this->repository->countAccounts($types);
+        $count       = $request->getEndRow() - $request->getStartRow();
+        $paginator   = new LengthAwarePaginator($accounts, $total, $count, $this->parameters->get('page'));
+        $transformer = new AccountTransformer();
+        $transformer->setParameters($this->parameters); // give params to transformer
+
+        return response()
+            ->json($this->jsonApiList(self::RESOURCE_KEY, $paginator, $transformer))
+            ->header('Content-Type', self::CONTENT_TYPE)
+        ;
+    }
+}
--- a/app/Api/V2/Controllers/Transaction/List/TransactionController.php
+++ b/app/Api/V2/Controllers/Transaction/List/TransactionController.php
@@ -35,6 +35,47 @@ use Illuminate\Http\JsonResponse;
 */
 class TransactionController extends Controller
 {
+    public function infiniteList(InfiniteListRequest $request): JsonResponse
+    {
+        // get sort instructions
+        $instructions = $request->getSortInstructions('transactions');
+
+        // collect transactions:
+        /** @var GroupCollectorInterface $collector */
+        $collector    = app(GroupCollectorInterface::class);
+        $collector->setUserGroup(auth()->user()->userGroup)
+            ->withAPIInformation()
+            ->setStartRow($request->getStartRow())
+            ->setEndRow($request->getEndRow())
+            ->setTypes($request->getTransactionTypes())
+            ->setSorting($instructions)
+        ;
+
+        $start        = $this->parameters->get('start');
+        $end          = $this->parameters->get('end');
+        if (null !== $start) {
+            $collector->setStart($start);
+        }
+        if (null !== $end) {
+            $collector->setEnd($end);
+        }
+
+        $paginator    = $collector->getPaginatedGroups();
+        $params       = $request->buildParams();
+        $paginator->setPath(
+            sprintf(
+                '%s?%s',
+                route('api.v2.infinite.transactions.list'),
+                $params
+            )
+        );
+
+        return response()
+            ->json($this->jsonApiList('transactions', $paginator, new TransactionGroupTransformer()))
+            ->header('Content-Type', self::CONTENT_TYPE)
+        ;
+    }
+
    public function list(ListRequest $request): JsonResponse
    {
        // collect transactions:
@@ -75,45 +116,4 @@ class TransactionController extends Controller
            ->header('Content-Type', self::CONTENT_TYPE)
        ;
    }
-
-    public function infiniteList(InfiniteListRequest $request): JsonResponse
-    {
-        // get sort instructions
-        $instructions = $request->getSortInstructions();
-
-        // collect transactions:
-        /** @var GroupCollectorInterface $collector */
-        $collector    = app(GroupCollectorInterface::class);
-        $collector->setUserGroup(auth()->user()->userGroup)
-            ->withAPIInformation()
-            ->setStartRow($request->getStartRow())
-            ->setEndRow($request->getEndRow())
-            ->setTypes($request->getTransactionTypes())
-            ->setSorting($instructions)
-        ;
-
-        $start        = $this->parameters->get('start');
-        $end          = $this->parameters->get('end');
-        if (null !== $start) {
-            $collector->setStart($start);
-        }
-        if (null !== $end) {
-            $collector->setEnd($end);
-        }
-
-        $paginator    = $collector->getPaginatedGroups();
-        $params       = $request->buildParams();
-        $paginator->setPath(
-            sprintf(
-                '%s?%s',
-                route('api.v2.infinite.transactions.list'),
-                $params
-            )
-        );
-
-        return response()
-            ->json($this->jsonApiList('transactions', $paginator, new TransactionGroupTransformer()))
-            ->header('Content-Type', self::CONTENT_TYPE)
-        ;
-    }
 }
--- a/app/Api/V2/Request/Model/Account/IndexRequest.php
+++ b/app/Api/V2/Request/Model/Account/IndexRequest.php
@@ -0,0 +1,67 @@
+<?php
+/*
+ * IndexRequest.php
+ * Copyright (c) 2024 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\Api\V2\Request\Model\Account;
+
+use Carbon\Carbon;
+use FireflyIII\Support\Http\Api\AccountFilter;
+use FireflyIII\Support\Request\ChecksLogin;
+use FireflyIII\Support\Request\ConvertsDataTypes;
+use Illuminate\Foundation\Http\FormRequest;
+
+/**
+ * Class IndexRequest
+ *
+ * Lots of code stolen from the SingleDateRequest.
+ */
+class IndexRequest extends FormRequest
+{
+    use AccountFilter;
+    use ChecksLogin;
+    use ConvertsDataTypes;
+
+    /**
+     * Get all data from the request.
+     */
+    public function getDate(): Carbon
+    {
+        return $this->getCarbonDate('date');
+    }
+
+    public function getAccountTypes(): array
+    {
+        $type = (string)$this->get('type', 'default');
+
+        return $this->mapAccountTypes($type);
+    }
+
+    /**
+     * The rules that the incoming request must be matched against.
+     */
+    public function rules(): array
+    {
+        return [
+            'date' => 'date|after:1900-01-01|before:2099-12-31',
+        ];
+    }
+}
--- a/app/Api/V2/Request/Model/Transaction/InfiniteListRequest.php
+++ b/app/Api/V2/Request/Model/Transaction/InfiniteListRequest.php
@@ -25,6 +25,7 @@ declare(strict_types=1);
 namespace FireflyIII\Api\V2\Request\Model\Transaction;

 use Carbon\Carbon;
+use FireflyIII\Support\Http\Api\AccountFilter;
 use FireflyIII\Support\Http\Api\TransactionFilter;
 use FireflyIII\Support\Request\ChecksLogin;
 use FireflyIII\Support\Request\ConvertsDataTypes;
@@ -36,6 +37,7 @@ use Illuminate\Foundation\Http\FormRequest;
 */
 class InfiniteListRequest extends FormRequest
 {
+    use AccountFilter;
    use ChecksLogin;
    use ConvertsDataTypes;
    use TransactionFilter;
@@ -81,6 +83,13 @@ class InfiniteListRequest extends FormRequest
        return $this->getCarbonDate('end');
    }

+    public function getAccountTypes(): array
+    {
+        $type = (string)$this->get('type', 'default');
+
+        return $this->mapAccountTypes($type);
+    }
+
    public function getPage(): int
    {
        $page = $this->convertInteger('page');
@@ -88,9 +97,9 @@ class InfiniteListRequest extends FormRequest
        return 0 === $page || $page > 65536 ? 1 : $page;
    }

-    public function getSortInstructions(): array
+    public function getSortInstructions(string $key): array
    {
-        $allowed = config('firefly.sorting.allowed.transactions');
+        $allowed = config(sprintf('firefly.sorting.allowed.%s', $key));
        $set     = $this->get('sorting', []);
        $result  = [];
        if (0 === count($set)) {