Merge pull request 'make short new transaction url even shorter' (!66) from feature/change-short-new-transaction-url into master

Reviewed-on: #66

composer.json

@@ -10,7 +10,7 @@
     }
   ],
   "require": {
-    "esoko/soko-web": "0.13",
+    "esoko/soko-web": "0.13.1",
     "firebase/php-jwt": "^6.4"
   },
   "require-dev": {

composer.lock

@@ -4,7 +4,7 @@
         "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
         "This file is @generated automatically"
     ],
-    "content-hash": "707bad5bd796500db300c5384f2ce378",
+    "content-hash": "59130fbd82b1c81275666b16adb0c1a1",
     "packages": [
         {
             "name": "cocur/slugify",
@@ -82,11 +82,11 @@
         },
         {
             "name": "esoko/soko-web",
-            "version": "v0.13",
+            "version": "v0.13.1",
             "source": {
                 "type": "git",
                 "url": "https://git.esoko.eu/esoko/soko-web.git",
-                "reference": "4283bc9bb15d17914393b4ba3463d83717487c53"
+                "reference": "8bf495c89b4ce1456da1133adc285003e544dd48"
             },
             "require": {
                 "cocur/slugify": "^4.3",
@@ -108,7 +108,7 @@
                 "GNU GPL 3.0"
             ],
             "description": "Lightweight web framework",
-            "time": "2023-06-17T12:32:56+00:00"
+            "time": "2023-07-08T12:38:40+00:00"
         },
         {
             "name": "firebase/php-jwt",

src/Controller/CommunityController.php

@@ -59,32 +59,21 @@ class CommunityController implements IAuthenticationRequired
 
         \Container::$persistentDataManager->loadRelationsFromDb($community, false, ['main_currency']);
 
-        $balanceCalculator = new BalanceCalculator($community);
-        $debts = $balanceCalculator->calculate();
-        $debtItems = [];
-        $debtBalance = 0.0;
-        $outstandingItems = [];
-        $outstandingBalance = 0.0;
-        foreach ($debts as $debt) {
-            if ($debt['payer']->getId() === \Container::$request->user()->getUniqueId()) {
-                $debtBalance += $debt['amount'];
-                $debtItems[] = $debt;
-            }
-            if ($debt['payee']->getId() === \Container::$request->user()->getUniqueId()) {
-                $outstandingBalance += $debt['amount'];
-                $outstandingItems[] = $debt;
-            }
-        }
-        $balance = $outstandingBalance - $debtBalance;
+        /**
+        * @var User $user
+        */
+        $user = \Container::$request->user();
+        $balanceCalculator = new BalanceCalculator($community, $user);
+        $balance = $balanceCalculator->calculate();
 
         return new HtmlContent('communities/community', [
             'community' => $community,
-            'upcomingEvents' => iterator_to_array($this->eventRepository->getUpcomingByCommunity($community, new DateTime(), 3)),
-            'debtItems' => $debtItems,
-            'debtBalance' => $debtBalance,
-            'outstandingItems' => $outstandingItems,
-            'outstandingBalance' => $outstandingBalance,
-            'balance' => $balance,
+            'upcomingAndRecentEvents' => iterator_to_array($this->eventRepository->getUpcomingAndRecentByCommunity($community, new DateTime(), 30, 3)),
+            'debtItems' => $balance['debtItems'],
+            'debtBalance' => $balance['debtBalance'],
+            'outstandingItems' => $balance['outstandingItems'],
+            'outstandingBalance' => $balance['outstandingBalance'],
+            'balance' => $balance['absoluteBalance'],
             'editPermission' => $ownCommunityMember->getOwner()
         ]);
     }

src/Controller/EventController.php

@@ -2,6 +2,7 @@
 
 use Container;
 use DateTime;
+use RVR\Finance\BalanceCalculator;
 use RVR\Finance\ExchangeRateCalculator;
 use RVR\PersistentData\Model\Community;
 use RVR\PersistentData\Model\CommunityMember;
@@ -105,10 +106,22 @@ class EventController implements IAuthenticationRequired, ISecured
         }
         Container::$persistentDataManager->loadRelationsFromDb($this->community, true, ['main_currency']);
 
+        /**
+        * @var User $user
+        */
+        $user = \Container::$request->user();
+        $balanceCalculator = new BalanceCalculator($this->community, $user, $event);
+        $balance = $balanceCalculator->calculate();
+
         return new HtmlContent('events/event', [
             'community' => $this->community,
             'event' => $event,
-            'totalCost' => $this->sumTransactions($event)
+            'totalCost' => $this->sumTransactions($event),
+            'debtItems' => $balance['debtItems'],
+            'debtBalance' => $balance['debtBalance'],
+            'outstandingItems' => $balance['outstandingItems'],
+            'outstandingBalance' => $balance['outstandingBalance'],
+            'balance' => $balance['absoluteBalance'],
         ]);
     }
 

src/Controller/EventRedirectController.php

@@ -0,0 +1,70 @@
+<?php namespace RVR\Controller;
+
+use DateTime;
+use Container;
+use RVR\PersistentData\Model\Event;
+use RVR\PersistentData\Model\User;
+use RVR\Repository\EventRepository;
+use SokoWeb\Interfaces\Authentication\IAuthenticationRequired;
+use SokoWeb\Interfaces\Response\IRedirect;
+use SokoWeb\Response\HtmlContent;
+use SokoWeb\Response\Redirect;
+
+class EventRedirectController implements IAuthenticationRequired
+{
+    private EventRepository $eventRepository;
+
+    public function __construct()
+    {
+        $this->eventRepository = new EventRepository();
+    }
+
+    public function isAuthenticationRequired(): bool
+    {
+        return true;
+    }
+
+    public function getEvent()
+    {
+        $currentEvent = $this->getCurrentEvent();
+        if ($currentEvent === null) {
+            return new HtmlContent('event_redirect/no_event');
+        }
+
+        return new Redirect(
+            \Container::$routeCollection->getRoute('community.event')
+                ->generateLink([
+                    'communitySlug' => $currentEvent->getCommunity()->getSlug(),
+                    'eventSlug' => $currentEvent->getSlug()
+                ]),
+            IRedirect::TEMPORARY
+        );
+    }
+
+    public function getEventNewTransaction()
+    {
+        $currentEvent = $this->getCurrentEvent();
+        if ($currentEvent === null) {
+            return new HtmlContent('event_redirect/no_event');
+        }
+
+        return new Redirect(
+            \Container::$routeCollection->getRoute('community.transactions.new')
+                ->generateLink([
+                    'communitySlug' => $currentEvent->getCommunity()->getSlug(),
+                    'event' => $currentEvent->getSlug()
+                ]),
+            IRedirect::TEMPORARY
+        );
+    }
+
+    private function getCurrentEvent(): ?Event
+    {
+        /**
+         * @var User $user
+         */
+        $user = Container::$request->user();
+
+        return $this->eventRepository->getCurrentByUser($user, new DateTime(), 30, true, ['community']);
+    }
+}

src/Controller/HomeController.php

@@ -44,7 +44,7 @@ class HomeController implements IAuthenticationRequired
 
         return new HtmlContent('home', [
             'communities' => $communities,
-            'upcomingEvents' => iterator_to_array($this->eventRepository->getUpcomingByUser($user, new DateTime(), 3, true, ['community']))
+            'upcomingAndRecentEvents' => iterator_to_array($this->eventRepository->getUpcomingAndRecentByUser($user, new DateTime(), 30, 3, true, ['community']))
         ]);
     }
 }

src/Finance/BalanceCalculator.php

@@ -2,6 +2,8 @@
 
 use Container;
 use RVR\PersistentData\Model\Community;
+use RVR\PersistentData\Model\Event;
+use RVR\PersistentData\Model\User;
 use RVR\Repository\CommunityMemberRepository;
 use RVR\Repository\TransactionRepository;
 
@@ -9,6 +11,10 @@ class BalanceCalculator
 {
     private Community $community;
 
+    private User $user;
+
+    private ?Event $event;
+
     private TransactionRepository $transactionRepository;
 
     private CommunityMemberRepository $communityMemberRepository;
@@ -19,9 +25,13 @@ class BalanceCalculator
 
     private array $payments;
 
-    public function __construct(Community $community)
+    private array $actualDebts;
+
+    public function __construct(Community $community, User $user, ?Event $event = null)
     {
         $this->community = $community;
+        $this->user = $user;
+        $this->event = $event;
         $this->transactionRepository = new TransactionRepository();
         $this->communityMemberRepository = new CommunityMemberRepository();
         $this->exchangeRateCalculator = new ExchangeRateCalculator($this->community->getMainCurrency());
@@ -32,7 +42,8 @@ class BalanceCalculator
         $this->collectMembers();
         $this->createPaymentsMatrix();
         $this->sumTransactions();
-        return $this->calculateActualDebts();
+        $this->calculateActualDebts();
+        return $this->calculateBalanceForUser();
     }
 
     private function collectMembers(): void
@@ -57,7 +68,11 @@ class BalanceCalculator
     private function sumTransactions(): void
     {
         $membersCount = count($this->members);
-        $transactions = iterator_to_array($this->transactionRepository->getAllByCommunity($this->community, true, ['currency']));
+        if ($this->event !== null) {
+            $transactions = iterator_to_array($this->transactionRepository->getAllByEvent($this->event, true, ['currency']));
+        } else {
+            $transactions = iterator_to_array($this->transactionRepository->getAllByCommunity($this->community, true, ['currency']));
+        }
         Container::$persistentDataManager->loadMultiRelationsFromDb($transactions, 'payees');
 
         foreach ($transactions as $transaction) {
@@ -77,20 +92,45 @@ class BalanceCalculator
         }
     }
 
-    private function calculateActualDebts(): array
+    private function calculateActualDebts(): void
     {
-        $actualDebts = [];
+        $this->actualDebts = [];
 
         foreach ($this->payments as $payerUserId => $paymentsOfPayer) {
             foreach ($paymentsOfPayer as $payeeUserId => $sum) {
                 $actualDebt = $this->payments[$payeeUserId][$payerUserId] - $sum;
 
                 if (round($actualDebt, $this->community->getMainCurrency()->getRoundDigits()) > 0.0) {
-                    $actualDebts[] = ['payer' => $this->members[$payerUserId], 'payee' => $this->members[$payeeUserId], 'amount' => $actualDebt];
+                    $this->actualDebts[] = ['payer' => $this->members[$payerUserId], 'payee' => $this->members[$payeeUserId], 'amount' => $actualDebt];
                 }
             }
         }
+    }
 
-        return $actualDebts;
+    private function calculateBalanceForUser(): array
+    {
+        $debtItems = [];
+        $debtBalance = 0.0;
+        $outstandingItems = [];
+        $outstandingBalance = 0.0;
+        foreach ($this->actualDebts as $debt) {
+            if ($debt['payer']->getId() === $this->user->getId()) {
+                $debtBalance += $debt['amount'];
+                $debtItems[] = $debt;
+            }
+            if ($debt['payee']->getId() === $this->user->getId()) {
+                $outstandingBalance += $debt['amount'];
+                $outstandingItems[] = $debt;
+            }
+        }
+        $absoluteBalance = $outstandingBalance - $debtBalance;
+
+        return [
+            'absoluteBalance' => $absoluteBalance,
+            'debtItems' => $debtItems,
+            'debtBalance' => $debtBalance,
+            'outstandingItems' => $outstandingItems,
+            'outstandingBalance' => $outstandingBalance
+        ];
     }
 }

src/Repository/EventRepository.php

@@ -2,6 +2,7 @@
 
 use Container;
 use DateTime;
+use DateInterval;
 use Generator;
 use RVR\PersistentData\Model\Community;
 use RVR\PersistentData\Model\Event;
@@ -32,26 +33,36 @@ class EventRepository
         return $this->selectAllByCommunity($community)->count();
     }
 
-    public function getUpcomingByCommunity(Community $community, DateTime $from, int $limit, bool $useRelations = false, array $withRelations = []): Generator
+    public function getUpcomingAndRecentByCommunity(Community $community, DateTime $from, int $days, int $limit, bool $useRelations = false, array $withRelations = []): Generator
     {
         $select = $this->selectAllByCommunity($community);
-        $select->where('end', '>', $from->format('Y-m-d H:i:s'));
-        $select->orderBy('start', 'ASC');
+        $this->selectUpcomingAndRecent($select, $from, $days);
+        $select->orderBy('start', 'DESC');
         $select->limit($limit, 0);
 
         yield from Container::$persistentDataManager->selectMultipleFromDb($select, Event::class, $useRelations, $withRelations);
     }
 
-    public function getUpcomingByUser(User $user, DateTime $from, int $limit, bool $useRelations = false, array $withRelations = []): Generator
+    public function getUpcomingAndRecentByUser(User $user, DateTime $from, int $days, int $limit, bool $useRelations = false, array $withRelations = []): Generator
     {
         $select = $this->selectAllByUser($user);
-        $select->where('end', '>', $from->format('Y-m-d H:i:s'));
-        $select->orderBy('start', 'ASC');
+        $this->selectUpcomingAndRecent($select, $from, $days);
+        $select->orderBy('start', 'DESC');
         $select->limit($limit, 0);
 
         yield from Container::$persistentDataManager->selectMultipleFromDb($select, Event::class, $useRelations, $withRelations);
     }
 
+    public function getCurrentByUser(User $user, DateTime $from, int $days, bool $useRelations = false, array $withRelations = []): ?Event
+    {
+        $select = $this->selectAllByUser($user);
+        $this->selectUpcomingAndRecent($select, $from, $days);
+        $select->orderBy('start', 'DESC');
+        $select->limit(1, 0);
+
+        return Container::$persistentDataManager->selectFromDb($select, Event::class, $useRelations, $withRelations);
+    }
+
     public function getPagedByCommunity(Community $community, int $page, int $itemsPerPage, bool $useRelations = false, array $withRelations = []): Generator
     {
         $select = $this->selectAllByCommunity($community);
@@ -86,4 +97,16 @@ class EventRepository
         $select->where(['community_members', 'user_id'], '=', $user->getId());
         return $select;
     }
+
+    private function selectUpcomingAndRecent(Select $select, DateTime $from, int $days)
+    {
+        $select->where(function (Select $select) use ($from, $days) {
+            $select->where('start', '<', (clone $from)->add(DateInterval::createFromDateString("$days days"))->format('Y-m-d H:i:s'));
+            $select->where('end', '>', $from->format('Y-m-d H:i:s'));
+        });
+        $select->orWhere(function (Select $select) use ($from, $days) {
+            $select->where('end', '>', (clone $from)->sub(DateInterval::createFromDateString("$days days"))->format('Y-m-d H:i:s'));
+            $select->where('start', '<', $from->format('Y-m-d H:i:s'));
+        });
+    }
 }

views/communities/community.php

@@ -12,16 +12,16 @@
 
     <div class="gridContainer marginTop">
         <div>
-            <h3 class="marginBottom">Upcoming events</h3>
-            <?php if (count($upcomingEvents) > 0): ?>
-                <?php foreach ($upcomingEvents as $event): ?>
+            <h3 class="marginBottom">Upcoming and recent events</h3>
+            <?php if (count($upcomingAndRecentEvents) > 0): ?>
+                <?php foreach ($upcomingAndRecentEvents as $event): ?>
                     <p>
                         <a href="<?= Container::$routeCollection->getRoute('community.event')->generateLink(['communitySlug' => $community->getSlug(), 'eventSlug' => $event->getSlug()]) ?>"><?= $event->getTitle() ?></a>
                         <span class="small"><?= $event->getStartDate()->format('Y-m-d') ?> – <?= $event->getEndDate()->format('Y-m-d') ?></span>
                     </p>
                 <?php endforeach; ?>
             <?php else: ?>
-                <p>There is no upcoming event.</p>
+                <p>There is no event to show.</p>
             <?php endif; ?>
             <p class="marginTop"><a href="<?= Container::$routeCollection->getRoute('community.events')->generateLink(['communitySlug' => $community->getSlug()]) ?>">All events</a> | <a href="<?= Container::$routeCollection->getRoute('community.events.new')->generateLink(['communitySlug' => $community->getSlug()]) ?>">New event</a></p>
         </div>

views/communities/transaction_edit.php

@@ -7,11 +7,11 @@
 @section(main)
     <h2>
         <a href="<?= Container::$routeCollection->getRoute('community')->generateLink(['communitySlug' => $community->getSlug()]) ?>"><?= $community->getName() ?></a> »
-        <a href="<?= Container::$routeCollection->getRoute('community.transactions')->generateLink(['communitySlug' => $community->getSlug()]) ?>">Transactions</a> »
         <?php if (isset($event)): ?>
             <a href="<?= Container::$routeCollection->getRoute('community.events')->generateLink(['communitySlug' => $community->getSlug()]) ?>">Events</a> »
             <a href="<?= Container::$routeCollection->getRoute('community.event')->generateLink(['communitySlug' => $community->getSlug(), 'eventSlug' => $event->getSlug()]) ?>"><?= $event->getTitle() ?></a> »
         <?php endif; ?>
+        <a href="<?= Container::$routeCollection->getRoute('community.transactions')->generateLink(['communitySlug' => $community->getSlug(), 'event' => isset($event) ? $event->getSlug() : null]) ?>">Transactions</a> »
         <?php if (isset($transaction)): ?>
             Edit transaction
         <?php else: ?>
@@ -36,7 +36,12 @@
             <select class="big fullWidth" name="payer_user_id" required>
                 <option value="" hidden></option>
                 <?php foreach ($members as $member): ?>
-                    <option value="<?= $member->getUser()->getId() ?>" <?= isset($transaction) && $transaction->getPayerUserId() === $member->getUser()->getId() ? 'selected' : '' ?>><?= $member->getUser()->getDisplayName() ?></option>
+                    <option value="<?= $member->getUser()->getId() ?>"
+                        <?= isset($transaction) ?
+                            ($transaction->getPayerUserId() === $member->getUser()->getId() ? 'selected' : '') :
+                            (Container::$request->user()->getUniqueId() == $member->getUser()->getId() ? 'selected' : '') ?>>
+                        <?= $member->getUser()->getDisplayName() ?>
+                    </option>
                 <?php endforeach; ?>
             </select>
             <p class="formLabel marginTop">Payee(s)</p>

views/event_redirect/no_event.php

@@ -0,0 +1,8 @@
+@extends(templates/layout_normal)
+
+@section(main)
+    <h2>No event found</h2>
+    <div class="box compactBox">
+        <p class="error justify">No upcoming or recent event was found. <a href="<?= Container::$routeCollection->getRoute('home')->generateLink() ?>" title="<?= $_ENV['APP_NAME'] ?>">Back to start.</a></p>
+    </div>
+@endsection

views/events/event.php

@@ -22,6 +22,33 @@
                     <td class="mono" style="text-align: right;"><?= number_format($totalCost, $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
                 </tr>
             </table>
+            <table class="fullWidth marginTop">
+                <tr>
+                    <td class="bold">You owe*</td>
+                    <td class="mono red" style="text-align: right;"><?= number_format($debtBalance, $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
+                </tr>
+                <?php foreach ($debtItems as $item): ?>
+                    <tr>
+                        <td class="small"><?= $item['payee']->getUser()->getDisplayName() ?></td>
+                        <td class="small mono red" style="text-align: right;"><?= number_format($item['amount'], $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
+                    </tr>
+                <?php endforeach; ?>
+                <tr>
+                    <td class="bold">You're owed*</td>
+                    <td class="mono green" style="text-align: right;"><?= number_format($outstandingBalance, $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
+                </tr>
+                <?php foreach ($outstandingItems as $item): ?>
+                    <tr>
+                        <td class="small"><?= $item['payer']->getUser()->getDisplayName() ?></td>
+                        <td class="small mono green" style="text-align: right;"><?= number_format($item['amount'], $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
+                    </tr>
+                <?php endforeach; ?>
+                <tr>
+                    <td class="bold">Your balance*</td>
+                    <td class="mono <?= $balance < 0 ? 'red' : ($balance > 0 ? 'green' : '') ?>" style="text-align: right;;"><?= number_format($balance, $mainCurrencyRoundDigits) ?> <?= $mainCurrencyCode ?></td>
+                </tr>
+            </table>
+            <p class="small right">* Virtual balance only for this event. Check <a href="<?= Container::$routeCollection->getRoute('community')->generateLink(['communitySlug' => $community->getSlug()]) ?>">community</a> finances for your real balance.</p>
         </div>
     </div>
 @endsection

views/home.php

@@ -16,9 +16,9 @@
             <?php endif; ?>
         </div>
         <div>
-            <h3 class="marginBottom">Upcoming events</h3>
-            <?php if (count($upcomingEvents) > 0): ?>
-                <?php foreach ($upcomingEvents as $event): ?>
+            <h3 class="marginBottom">Upcoming and recent events</h3>
+            <?php if (count($upcomingAndRecentEvents) > 0): ?>
+                <?php foreach ($upcomingAndRecentEvents as $event): ?>
                     <p>
                         <a href="<?= Container::$routeCollection->getRoute('community.event')->generateLink(['communitySlug' => $event->getCommunity()->getSlug(), 'eventSlug' => $event->getSlug()]) ?>"><?= $event->getTitle() ?></a>
                         <span class="small">
@@ -28,7 +28,7 @@
                     </p>
                 <?php endforeach; ?>
             <?php else: ?>
-                <p>There is no upcoming event.</p>
+                <p>There is no event to show.</p>
             <?php endif; ?>
         </div>
     </div>

web.php

@@ -13,6 +13,7 @@ use RVR\Controller\UserController;
 use RVR\Controller\UserSearchController;
 use RVR\Controller\CommunityController;
 use RVR\Controller\TransactionController;
+use RVR\Controller\EventRedirectController;
 use RVR\Controller\EventController;
 use RVR\Repository\UserRepository;
 
@@ -62,6 +63,10 @@ Container::$routeCollection->group('account', function (RouteCollection $routeCo
     $routeCollection->get('account.googleAuthenticate-action', 'googleAuthenticate/code', [UserController::class, 'authenticateWithGoogle']);
 });
 Container::$routeCollection->get('searchUser', 'searchUser', [UserSearchController::class, 'searchUser']);
+Container::$routeCollection->group('now', function (RouteCollection $routeCollection) {
+    $routeCollection->get('now.event', '', [EventRedirectController::class, 'getEvent']);
+    $routeCollection->get('now.transactions.new', 'transaction', [EventRedirectController::class, 'getEventNewTransaction']);
+});
 Container::$routeCollection->group('communities', function (RouteCollection $routeCollection) {
     $routeCollection->get('community.new', 'new', [CommunityController::class, 'getCommunityNew']);
     $routeCollection->post('community.new-action', 'new', [CommunityController::class, 'saveCommunity']);