For multiple subscriptions payment missed warning #11544

2026-05-02 23:40:25 -05:00 · 2026-01-18 10:17:50 +01:00
parent 64325fbce7
commit a08ba43c23
4 changed files with 95 additions and 73 deletions
@@ -0,0 +1,33 @@
+<?php
+/*
+ * SubscriptionIsOverdueForPayment.php
+ * Copyright (c) 2026 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/>.
+ */
+
+namespace FireflyIII\Events\Model\Subscription;
+
+use FireflyIII\Events\Event;
+use FireflyIII\User;
+use Illuminate\Queue\SerializesModels;
+
+class SubscriptionsAreOverdueForPayment extends Event
+{
+    use SerializesModels;
+
+    public function __construct(public User $user, public array $overdue) {}
+}
@@ -25,7 +25,6 @@ declare(strict_types=1);
 namespace FireflyIII\Jobs;

 use Carbon\Carbon;
-use FireflyIII\Events\Model\Bill\WarnUserAboutBill;
 use FireflyIII\Events\Model\Bill\WarnUserAboutOverdueSubscriptions;
 use FireflyIII\Events\Model\Subscription\SubscriptionNeedsExtensionOrRenewal;
 use FireflyIII\Models\Bill;
@@ -57,12 +56,12 @@ class WarnAboutBills implements ShouldQueue
     */
    public function __construct(?Carbon $date)
    {
-        $newDate     = new Carbon();
+        $newDate = new Carbon();
        $newDate->startOfDay();
-        $this->date  = $newDate;
+        $this->date = $newDate;

        if ($date instanceof Carbon) {
-            $newDate    = clone $date;
+            $newDate = clone $date;
            $newDate->startOfDay();
            $this->date = $newDate;
        }
@@ -149,7 +148,7 @@ class WarnAboutBills implements ShouldQueue

    public function setDate(Carbon $date): void
    {
-        $newDate    = clone $date;
+        $newDate = clone $date;
        $newDate->startOfDay();
        $this->date = $newDate;
    }
@@ -171,7 +170,7 @@ class WarnAboutBills implements ShouldQueue
        $enrichment->setEnd($end);

        /** @var Bill $single */
-        $single     = $enrichment->enrichSingle($bill);
+        $single = $enrichment->enrichSingle($bill);

        return [
            'pay_dates'  => $single->meta['pay_dates'] ?? [],
@@ -181,7 +180,7 @@ class WarnAboutBills implements ShouldQueue

    private function needsOverdueAlert(array $dates): bool
    {
-        $count    = count($dates['pay_dates']) - count($dates['paid_dates']);
+        $count = count($dates['pay_dates']) - count($dates['paid_dates']);
        if (0 === $count || 0 === count($dates['pay_dates'])) {
            return false;
        }
@@ -189,7 +188,7 @@ class WarnAboutBills implements ShouldQueue
        $earliest = new Carbon($dates['pay_dates'][0]);
        $earliest->startOfDay();
        Log::debug(sprintf('Earliest expected pay date is %s', $earliest->toAtomString()));
-        $diff     = $earliest->diffInDays($this->date);
+        $diff = $earliest->diffInDays($this->date);
        Log::debug(sprintf('Difference in days is %s', $diff));

        return $diff >= 6; // FIXME hard coded value.
@@ -1,8 +1,7 @@
 <?php
-
 /*
- * BillEventHandler.php
- * Copyright (c) 2022 james@firefly-iii.org
+ * NotifiesAboutOverdueSubscription.php
+ * Copyright (c) 2026 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
@@ -20,41 +19,32 @@
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */

-declare(strict_types=1);
-
-namespace FireflyIII\Handlers\Events;
+namespace FireflyIII\Listeners\Model\Subscription;

 use Exception;
-use FireflyIII\Events\Model\Bill\WarnUserAboutBill;
-use FireflyIII\Events\Model\Bill\WarnUserAboutOverdueSubscriptions;
-use FireflyIII\Events\Model\Subscription\SubscriptionNeedsExtensionOrRenewal;
+use FireflyIII\Events\Model\Subscription\SubscriptionsAreOverdueForPayment;
 use FireflyIII\Models\Bill;
-use FireflyIII\Notifications\User\BillReminder;
 use FireflyIII\Notifications\User\SubscriptionsOverdueReminder;
 use FireflyIII\Support\Facades\Preferences;
+use Illuminate\Contracts\Queue\ShouldQueue;
 use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Notification;

-use function Safe\json_encode;
-
-/**
- * Class BillEventHandler
- */
-class BillEventHandler
+class NotifiesAboutOverdueSubscriptions implements ShouldQueue
 {
-    public function warnAboutOverdueSubscriptions(WarnUserAboutOverdueSubscriptions $event): void
+    public function handle(SubscriptionsAreOverdueForPayment $event): void
    {
        Log::debug(sprintf('Now in %s', __METHOD__));
        // make sure user does not get the warning twice.
-        $overdue          = $event->overdue;
-        $user             = $event->user;
-        $toBeWarned       = [];
-        Log::debug(sprintf('%d bills to warn about.', count($overdue)));
+        $overdue    = $event->overdue;
+        $user       = $event->user;
+        $toBeWarned = [];
+        Log::debug(sprintf('%d subscriptions to warn about.', count($overdue)));
        foreach ($overdue as $item) {
            /** @var Bill $bill */
-            $bill         = $item['bill'];
-            $key          = sprintf('bill_overdue_%s_%s', $bill->id, substr(hash('sha256', json_encode($item['dates']['pay_dates'], JSON_THROW_ON_ERROR)), 0, 10));
-            $pref         = Preferences::getForUser($bill->user, $key, false);
+            $bill = $item['bill'];
+            $key  = sprintf('bill_overdue_%s_%s', $bill->id, substr(hash('sha256', json_encode($item['dates']['pay_dates'], JSON_THROW_ON_ERROR)), 0, 10));
+            $pref = Preferences::getForUser($bill->user, $key, false);
            if (true === $pref->data) {
                Log::debug(sprintf('User #%d has already been warned about overdue subscription #%d.', $bill->user->id, $bill->id));

@@ -63,12 +53,12 @@ class BillEventHandler
            $toBeWarned[] = $item;
        }
        unset($bill);
-        Log::debug(sprintf('Now %d bills to warn about.', count($toBeWarned)));
+        Log::debug(sprintf('Now %d subscription(s) to warn about.', count($toBeWarned)));

        /** @var bool $sendNotification */
        $sendNotification = Preferences::getForUser($user, 'notification_bill_reminder', true)->data;
        if (false === $sendNotification) {
-            Log::debug('User has disabled bill reminders.');
+            Log::debug('User has disabled subscription reminders.');

            return;
        }
@@ -106,4 +96,5 @@ class BillEventHandler


    }
+
 }
@@ -27,7 +27,6 @@ use FireflyIII\Events\ActuallyLoggedIn;
 use FireflyIII\Events\Admin\InvitationCreated;
 use FireflyIII\Events\DestroyedTransactionGroup;
 use FireflyIII\Events\DetectedNewIPAddress;
-use FireflyIII\Events\Model\Bill\WarnUserAboutOverdueSubscriptions;
 use FireflyIII\Events\Model\PiggyBank\ChangedAmount;
 use FireflyIII\Events\Model\PiggyBank\ChangedName;
 use FireflyIII\Events\Model\Rule\RuleActionFailedOnArray;
@@ -72,90 +71,90 @@ class EventServiceProvider extends ServiceProvider
    protected $listen
        = [
            // is a User related event.
-            RegisteredUser::class                    => [
+            RegisteredUser::class                  => [
                'FireflyIII\Handlers\Events\UserEventHandler@sendRegistrationMail',
                'FireflyIII\Handlers\Events\UserEventHandler@sendAdminRegistrationNotification',
                'FireflyIII\Handlers\Events\UserEventHandler@attachUserRole',
                'FireflyIII\Handlers\Events\UserEventHandler@createGroupMembership',
                'FireflyIII\Handlers\Events\UserEventHandler@createExchangeRates',
            ],
-            UserAttemptedLogin::class                => [
+            UserAttemptedLogin::class              => [
                'FireflyIII\Handlers\Events\UserEventHandler@sendLoginAttemptNotification',
            ],
            // is a User related event.
-            Login::class                             => [
+            Login::class                           => [
                'FireflyIII\Handlers\Events\UserEventHandler@checkSingleUserIsAdmin',
                'FireflyIII\Handlers\Events\UserEventHandler@demoUserBackToEnglish',
            ],
-            ActuallyLoggedIn::class                  => [
+            ActuallyLoggedIn::class                => [
                'FireflyIII\Handlers\Events\UserEventHandler@storeUserIPAddress',
            ],
-            DetectedNewIPAddress::class              => [
+            DetectedNewIPAddress::class            => [
                'FireflyIII\Handlers\Events\UserEventHandler@notifyNewIPAddress',
            ],
-            RequestedVersionCheckStatus::class       => [
+            RequestedVersionCheckStatus::class     => [
                'FireflyIII\Handlers\Events\VersionCheckEventHandler@checkForUpdates',
            ],
-            RequestedReportOnJournals::class         => [
+            RequestedReportOnJournals::class       => [
                'FireflyIII\Handlers\Events\AutomationHandler@reportJournals',
            ],

            // is a User related event.
-            RequestedNewPassword::class              => [
+            RequestedNewPassword::class            => [
                'FireflyIII\Handlers\Events\UserEventHandler@sendNewPassword',
            ],
-            UserTestNotificationChannel::class       => [
+            UserTestNotificationChannel::class     => [
                'FireflyIII\Handlers\Events\UserEventHandler@sendTestNotification',
            ],
            // is a User related event.
-            UserChangedEmail::class                  => [
+            UserChangedEmail::class                => [
                'FireflyIII\Handlers\Events\UserEventHandler@sendEmailChangeConfirmMail',
                'FireflyIII\Handlers\Events\UserEventHandler@sendEmailChangeUndoMail',
            ],
            // admin related
-            OwnerTestNotificationChannel::class      => [
+            OwnerTestNotificationChannel::class    => [
                'FireflyIII\Handlers\Events\AdminEventHandler@sendTestNotification',
            ],
-            NewVersionAvailable::class               => [
+            NewVersionAvailable::class             => [
                'FireflyIII\Handlers\Events\AdminEventHandler@sendNewVersion',
            ],
-            InvitationCreated::class                 => [
+            InvitationCreated::class               => [
                'FireflyIII\Handlers\Events\AdminEventHandler@sendInvitationNotification',
                'FireflyIII\Handlers\Events\UserEventHandler@sendRegistrationInvite',
            ],
-            UnknownUserAttemptedLogin::class         => [
+            UnknownUserAttemptedLogin::class       => [
                'FireflyIII\Handlers\Events\AdminEventHandler@sendLoginAttemptNotification',
            ],

            // is a Transaction Journal related event.
-            StoredTransactionGroup::class            => [
+            StoredTransactionGroup::class          => [
                'FireflyIII\Handlers\Events\StoredGroupEventHandler@runAllHandlers',
            ],
-            TriggeredStoredTransactionGroup::class   => [
+            TriggeredStoredTransactionGroup::class => [
                'FireflyIII\Handlers\Events\StoredGroupEventHandler@triggerRulesManually',
            ],
            // is a Transaction Journal related event.
-            UpdatedTransactionGroup::class           => [
+            UpdatedTransactionGroup::class         => [
                'FireflyIII\Handlers\Events\UpdatedGroupEventHandler@runAllHandlers',
            ],
-            DestroyedTransactionGroup::class         => [
+            DestroyedTransactionGroup::class       => [
                'FireflyIII\Handlers\Events\DestroyedGroupEventHandler@runAllHandlers',
            ],
            // API related events:
-            AccessTokenCreated::class                => [
+            AccessTokenCreated::class              => [
                'FireflyIII\Handlers\Events\APIEventHandler@accessTokenCreated',
            ],

            // Webhook related event:
-            RequestedSendWebhookMessages::class      => [
+            RequestedSendWebhookMessages::class    => [
                'FireflyIII\Handlers\Events\WebhookEventHandler@sendWebhookMessages',
            ],

            // account related events:
-            StoredAccount::class                     => [
+            StoredAccount::class                   => [
                'FireflyIII\Handlers\Events\StoredAccountEventHandler@recalculateCredit',
            ],
-            UpdatedAccount::class                    => [
+            UpdatedAccount::class                  => [
                'FireflyIII\Handlers\Events\UpdatedAccountEventHandler@recalculateCredit',
            ],

@@ -163,54 +162,54 @@ class EventServiceProvider extends ServiceProvider
            //            SubscriptionNeedsExtensionOrRenewal::class                 => [
            //                'FireflyIII\Handlers\Events\BillEventHandler@warnAboutBill',
            //            ],
-            WarnUserAboutOverdueSubscriptions::class => [
-                'FireflyIII\Handlers\Events\BillEventHandler@warnAboutOverdueSubscriptions',
-            ],
+            //            WarnUserAboutOverdueSubscriptions::class => [
+            //                'FireflyIII\Handlers\Events\BillEventHandler@warnAboutOverdueSubscriptions',
+            //            ],

            // audit log events:
-            TriggeredAuditLog::class                 => [
+            TriggeredAuditLog::class               => [
                'FireflyIII\Handlers\Events\AuditEventHandler@storeAuditEvent',
            ],
            // piggy bank related events:
-            ChangedAmount::class                     => [
+            ChangedAmount::class                   => [
                'FireflyIII\Handlers\Events\Model\PiggyBankEventHandler@changePiggyAmount',
            ],
-            ChangedName::class                       => [
+            ChangedName::class                     => [
                'FireflyIII\Handlers\Events\Model\PiggyBankEventHandler@changedPiggyBankName',
            ],

            // rule actions
-            RuleActionFailedOnArray::class           => [
+            RuleActionFailedOnArray::class         => [
                'FireflyIII\Handlers\Events\Model\RuleHandler@ruleActionFailedOnArray',
            ],
-            RuleActionFailedOnObject::class          => [
+            RuleActionFailedOnObject::class        => [
                'FireflyIII\Handlers\Events\Model\RuleHandler@ruleActionFailedOnObject',
            ],

            // security related
-            EnabledMFA::class                        => [
+            EnabledMFA::class                      => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendMFAEnabledMail',
            ],
-            DisabledMFA::class                       => [
+            DisabledMFA::class                     => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendMFADisabledMail',
            ],
-            MFANewBackupCodes::class                 => [
+            MFANewBackupCodes::class               => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendNewMFABackupCodesMail',
            ],
-            MFAUsedBackupCode::class                 => [
+            MFAUsedBackupCode::class               => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendUsedBackupCodeMail',
            ],
-            MFABackupFewLeft::class                  => [
+            MFABackupFewLeft::class                => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendBackupFewLeftMail',
            ],
-            MFABackupNoLeft::class                   => [
+            MFABackupNoLeft::class                 => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendBackupNoLeftMail',
            ],
-            MFAManyFailedAttempts::class             => [
+            MFAManyFailedAttempts::class           => [
                'FireflyIII\Handlers\Events\Security\MFAHandler@sendMFAFailedAttemptsMail',
            ],
            // preferences
-            UserGroupChangedPrimaryCurrency::class   => [
+            UserGroupChangedPrimaryCurrency::class => [
                'FireflyIII\Handlers\Events\PreferencesEventHandler@resetPrimaryCurrencyAmounts',
            ],
        ];