Differential D1558 Diff 4165 src/app/Jobs/WalletCheck.php

Changeset View

Standalone View

src/app/Jobs/WalletCheck.php

This file was added.

				<?php

				namespace App\Jobs;

				use App\Wallet;
				use Carbon\Carbon;
				use Illuminate\Bus\Queueable;
				use Illuminate\Contracts\Queue\ShouldQueue;
				use Illuminate\Foundation\Bus\Dispatchable;
				use Illuminate\Queue\InteractsWithQueue;
				use Illuminate\Queue\SerializesModels;
				use Illuminate\Support\Facades\Mail;

				class WalletCheck implements ShouldQueue
				{
				use Dispatchable;
				use InteractsWithQueue;
				use Queueable;
				use SerializesModels;

				public const THRESHOLD_DELETE = 'delete';
				public const THRESHOLD_BEFORE_DELETE = 'before_delete';
				public const THRESHOLD_SUSPEND = 'suspend';
				public const THRESHOLD_REMINDER = 'reminder';
				public const THRESHOLD_INITIAL = 'initial';

				/** @var int The number of seconds to wait before retrying the job. */
				public $retryAfter = 10;

				/** @var int How many times retry the job if it fails. */
				public $tries = 5;

				/** @var bool Delete the job if the wallet no longer exist. */
				public $deleteWhenMissingModels = true;

				/** @var \App\Wallet A wallet object */
				protected $wallet;


				/**
				* Create a new job instance.
				*
				* @param \App\Wallet $wallet The wallet that has been charged.
				*
				* @return void
				*/
				public function __construct(Wallet $wallet)
				{
				$this->wallet = $wallet;
				}

				/**
				* Execute the job.
				*
				* @return void
				*/
				public function handle()
				{
				vanmeeuwenUnsubmitted Not Done Inline Actions For consistency, should we use `balance_negative_since`? vanmeeuwen: For consistency, should we use `balance_negative_since`?
				machniakAuthorUnsubmitted Not Done Inline Actions Sure. machniak: Sure.
				if ($this->wallet->balance >= 0) {
				return;
				}

				$now = Carbon::now();

				// Delete the account
				if (self::threshold($this->wallet, self::THRESHOLD_DELETE) < $now) {
				$this->deleteAccount();
				return;
				}

				// Warn about the upcomming account deletion
				if (self::threshold($this->wallet, self::THRESHOLD_BEFORE_DELETE) < $now) {
				$this->warnBeforeDelete();
				vanmeeuwenUnsubmitted Not Done Inline Actions "comming" -> "upcoming" vanmeeuwen: "comming" -> "upcoming"
				return;
				}

				// Suspend the account
				if (self::threshold($this->wallet, self::THRESHOLD_SUSPEND) < $now) {
				$this->suspendAccount();
				return;
				}

				// Send the second reminder
				if (self::threshold($this->wallet, self::THRESHOLD_REMINDER) < $now) {
				$this->secondReminder();
				return;
				}

				// Send the initial reminder
				if (self::threshold($this->wallet, self::THRESHOLD_INITIAL) < $now) {
				$this->initialReminder();
				return;
				}
				}

				/**
				* Send the initial reminder
				*/
				protected function initialReminder()
				{
				if ($this->wallet->getSetting('balance_warning_initial')) {
				return;
				}

				// TODO: Should we check if the account is already suspended?

				$this->sendMail(\App\Mail\NegativeBalance::class);

				$now = \Carbon\Carbon::now()->toDateTimeString();
				$this->wallet->setSetting('balance_warning_initial', $now);

				\Log::info("[WalletCheck] Notification sent for {$this->wallet->owner->email}");
				}

				/**
				* Send the second reminder
				*/
				protected function secondReminder()
				{
				if ($this->wallet->getSetting('balance_warning_reminder')) {
				return;
				}

				// TODO: Should we check if the account is already suspended?

				$this->sendMail(\App\Mail\NegativeBalanceReminder::class);

				$now = \Carbon\Carbon::now()->toDateTimeString();
				$this->wallet->setSetting('balance_warning_reminder', $now);

				\Log::info("[WalletCheck] Reminder sent for {$this->wallet->owner->email}");
				}

				/**
				* Suspend the account (and send the warning)
				*/
				protected function suspendAccount()
				{
				if ($this->wallet->getSetting('balance_warning_suspended')) {
				return;
				}

				// Sanity check, already deleted
				if (!$this->wallet->owner) {
				return;
				}

				\Log::info("[WalletCheck] Suspend account {$this->wallet->owner->email}");

				// Suspend the account
				$this->wallet->owner->suspend();
				foreach ($this->wallet->entitlements as $entitlement) {
				if (
				$entitlement->entitleable_type == \App\Domain::class
				\|\| $entitlement->entitleable_type == \App\User::class
				) {
				$entitlement->entitleable->suspend();
				}
				}

				$this->sendMail(\App\Mail\NegativeBalanceSuspended::class);

				$now = \Carbon\Carbon::now()->toDateTimeString();
				$this->wallet->setSetting('balance_warning_suspended', $now);
				}

				/**
				* Send the last warning before delete
				*/
				protected function warnBeforeDelete()
				{
				if ($this->wallet->getSetting('balance_warning_before_delete')) {
				return;
				}

				machniakAuthorUnsubmitted Done Inline Actions @vanmeeuwen what do you think about storing entries like these in `transactions` table? I mean we'd have "for free" a wallet history including sent mail notifications. Of course, it would appear in UI for admins only. machniak: @vanmeeuwen what do you think about storing entries like these in `transactions` table? I mean…
				vanmeeuwenUnsubmitted Not Done Inline Actions I would suppose this could get in as a future development, such that it would more generically be a log of "what happened". In this case, we can use system logs and possibly even nginx imap/smtp proxy requests, as well as actions such as these and the actions of users, in a more complete timeline. vanmeeuwen: I would suppose this could get in as a future development, such that it would more generically…
				// Sanity check, already deleted
				if (!$this->wallet->owner) {
				return;
				}

				$this->sendMail(\App\Mail\NegativeBalanceBeforeDelete::class, true);

				$now = \Carbon\Carbon::now()->toDateTimeString();
				$this->wallet->setSetting('balance_warning_before_delete', $now);

				\Log::info("[WalletCheck] Last warning sent for {$this->wallet->owner->email}");
				}

				/**
				* Delete the account
				*/
				protected function deleteAccount()
				{
				// TODO: This will not work when we actually allow multiple-wallets per account
				// but in this case we anyway have to change the whole thing
				// and calculate summarized balance from all wallets.
				// The dirty work will be done by UserObserver
				if ($this->wallet->owner) {
				\Log::info("[WalletCheck] Delete account {$this->wallet->owner->email}");
				$this->wallet->owner->delete();
				}
				}

				/**
				* Send the email
				*
				* @param string $class Mailable class name
				* @param bool $with_external Use users's external email
				*/
				protected function sendMail($class, $with_external = false): void
				{
				// TODO: Send the email to all wallet controllers?

				$mail = new $class($this->wallet, $this->wallet->owner);

				list($to, $cc) = \App\Mail\Helper::userEmails($this->wallet->owner, $with_external);

				if (!empty($to) \|\| !empty($cc)) {
				Mail::to($to)->cc($cc)->send($mail);
				}
				}

				/**
				* Get the date-time for an action threshold. Calculated using
				* the date when a wallet balance turned negative.
				*
				* @param \App\Wallet $wallet A wallet
				* @param string $type Action type (one of self::THRESHOLD_*)
				*
				* @return \Carbon\Carbon The threshold date-time object
				*/
				public static function threshold(Wallet $wallet, string $type): ?Carbon
				{
				$negative_since = $wallet->getSetting('balance_negative_since');

				// Migration scenario: balance<0, but no balance_negative_since set
				if (!$negative_since) {
				$negative_since = Carbon::now();
				$wallet->setSetting('balance_negative_since', $negative_since->toDateTimeString());
				} else {
				$negative_since = new Carbon($negative_since);
				}

				$remind = 7; // remind after first X days
				$suspend = 14; // suspend after next X days
				$delete = 21; // delete after next X days
				$warn = 3; // warn about delete on X days before delete

				// Acount deletion
				if ($type == self::THRESHOLD_DELETE) {
				return $negative_since->addDays($delete + $suspend + $remind);
				}

				// Warning about the upcomming account deletion
				if ($type == self::THRESHOLD_BEFORE_DELETE) {
				return $negative_since->addDays($delete + $suspend + $remind - $warn);
				}

				// Account suspension
				if ($type == self::THRESHOLD_SUSPEND) {
				return $negative_since->addDays($suspend + $remind);
				}

				// Second notification
				if ($type == self::THRESHOLD_REMINDER) {
				return $negative_since->addDays($remind);
				}

				// Initial notification
				// Give it an hour so the async recurring payment has a chance to be finished
				if ($type == self::THRESHOLD_INITIAL) {
				return $negative_since->addHours(1);
				}

				return null;
				}
				}