diff --git a/src/app/Backends/LDAP.php b/src/app/Backends/LDAP.php --- a/src/app/Backends/LDAP.php +++ b/src/app/Backends/LDAP.php @@ -709,11 +709,11 @@ */ private static function setUserAttributes(User $user, array &$entry) { + $isDegraded = $user->isDegraded(true); $settings = $user->getSettings(['first_name', 'last_name', 'organization']); $firstName = $settings['first_name']; $lastName = $settings['last_name']; - $cn = "unknown"; $displayname = ""; @@ -773,12 +773,18 @@ $entry['nsroledn'][] = "cn=2fa-user,{$hostedRootDN}"; } - if (in_array("activesync", $roles)) { - $entry['nsroledn'][] = "cn=activesync-user,{$hostedRootDN}"; - } - if (!in_array("groupware", $roles)) { - $entry['nsroledn'][] = "cn=imap-user,{$hostedRootDN}"; + if ($isDegraded) { + $entry['nsroledn'][] = "cn=degraded-user,{$hostedRootDN}"; + $entry['mailquota'] = \config('app.storage.min_qty') * 1048576; + } else { + if (in_array("activesync", $roles)) { + $entry['nsroledn'][] = "cn=activesync-user,{$hostedRootDN}"; + } + + if (!in_array("groupware", $roles)) { + $entry['nsroledn'][] = "cn=imap-user,{$hostedRootDN}"; + } } } diff --git a/src/app/Console/Commands/User/DegradeCommand.php b/src/app/Console/Commands/User/DegradeCommand.php new file mode 100644 --- /dev/null +++ b/src/app/Console/Commands/User/DegradeCommand.php @@ -0,0 +1,39 @@ +getUser($this->argument('user')); + + if (!$user) { + $this->error('User not found.'); + return 1; + } + + $user->degrade(); + } +} diff --git a/src/app/Console/Commands/User/StatusCommand.php b/src/app/Console/Commands/User/StatusCommand.php --- a/src/app/Console/Commands/User/StatusCommand.php +++ b/src/app/Console/Commands/User/StatusCommand.php @@ -42,6 +42,7 @@ 'deleted' => User::STATUS_DELETED, 'ldapReady' => User::STATUS_LDAP_READY, 'imapReady' => User::STATUS_IMAP_READY, + 'degraded' => User::STATUS_DEGRADED, ]; $user_state = []; diff --git a/src/app/Console/Commands/User/UndegradeCommand.php b/src/app/Console/Commands/User/UndegradeCommand.php new file mode 100644 --- /dev/null +++ b/src/app/Console/Commands/User/UndegradeCommand.php @@ -0,0 +1,39 @@ +getUser($this->argument('user')); + + if (!$user) { + $this->error('User not found.'); + return 1; + } + + $user->undegrade(); + } +} diff --git a/src/app/Console/Commands/Wallet/ChargeCommand.php b/src/app/Console/Commands/Wallet/ChargeCommand.php --- a/src/app/Console/Commands/Wallet/ChargeCommand.php +++ b/src/app/Console/Commands/Wallet/ChargeCommand.php @@ -64,7 +64,8 @@ } if ($wallet->balance < 0) { - // Check the account balance, send notifications, suspend, delete + // Check the account balance, send notifications, (suspend, delete,) degrade + // Also sends reminders to the degraded account owners \App\Jobs\WalletCheck::dispatch($wallet); } } diff --git a/src/app/Http/Controllers/API/V4/OpenViduController.php b/src/app/Http/Controllers/API/V4/OpenViduController.php --- a/src/app/Http/Controllers/API/V4/OpenViduController.php +++ b/src/app/Http/Controllers/API/V4/OpenViduController.php @@ -213,7 +213,7 @@ $room = Room::where('name', $id)->first(); // Room does not exist, or the owner is deleted - if (!$room || !$room->owner) { + if (!$room || !$room->owner || $room->owner->isDegraded(true)) { return $this->errorResponse(404, \trans('meet.room-not-found')); } @@ -349,7 +349,7 @@ $room = Room::where('name', $id)->first(); // Room does not exist, or the owner is deleted - if (!$room || !$room->owner) { + if (!$room || !$room->owner || $room->owner->isDegraded(true)) { return $this->errorResponse(404); } diff --git a/src/app/Http/Controllers/API/V4/UsersController.php b/src/app/Http/Controllers/API/V4/UsersController.php --- a/src/app/Http/Controllers/API/V4/UsersController.php +++ b/src/app/Http/Controllers/API/V4/UsersController.php @@ -582,6 +582,8 @@ 'isSuspended' => $user->isSuspended(), 'isActive' => $user->isActive(), 'isDeleted' => $user->isDeleted() || $user->trashed(), + 'isDegraded' => $user->isDegraded(), + 'isAccountDegraded' => $user->isDegraded(true), ]; } diff --git a/src/app/Jobs/WalletCheck.php b/src/app/Jobs/WalletCheck.php --- a/src/app/Jobs/WalletCheck.php +++ b/src/app/Jobs/WalletCheck.php @@ -18,6 +18,9 @@ use Queueable; use SerializesModels; + public const THRESHOLD_DEGRADE = 'degrade'; + public const THRESHOLD_DEGRADE_REMINDER = 'degrade-reminder'; + public const THRESHOLD_BEFORE_DEGRADE = 'before_degrade'; public const THRESHOLD_DELETE = 'delete'; public const THRESHOLD_BEFORE_DELETE = 'before_delete'; public const THRESHOLD_SUSPEND = 'suspend'; @@ -63,62 +66,83 @@ } $now = Carbon::now(); - - // Delete the account - if (self::threshold($this->wallet, self::THRESHOLD_DELETE) < $now) { - $this->deleteAccount(); - return self::THRESHOLD_DELETE; - } - - // Warn about the upcomming account deletion - if (self::threshold($this->wallet, self::THRESHOLD_BEFORE_DELETE) < $now) { - $this->warnBeforeDelete(); - return self::THRESHOLD_BEFORE_DELETE; +/* + // Steps for old "first suspend then delete" approach + $steps = [ + // Send the initial reminder + self::THRESHOLD_INITIAL => 'initialReminder', + // Try to top-up the wallet before the second reminder + self::THRESHOLD_BEFORE_REMINDER => 'topUpWallet', + // Send the second reminder + self::THRESHOLD_REMINDER => 'secondReminder', + // Try to top-up the wallet before suspending the account + self::THRESHOLD_BEFORE_SUSPEND => 'topUpWallet', + // Suspend the account + self::THRESHOLD_SUSPEND => 'suspendAccount', + // Warn about the upcomming account deletion + self::THRESHOLD_BEFORE_DELETE => 'warnBeforeDelete', + // Delete the account + self::THRESHOLD_DELETE => 'deleteAccount', + ]; +*/ + // Steps for "demote instead of suspend+delete" approach + $steps = [ + // Send the initial reminder + self::THRESHOLD_INITIAL => 'initialReminderForDegrade', + // Try to top-up the wallet before the second reminder + self::THRESHOLD_BEFORE_REMINDER => 'topUpWallet', + // Send the second reminder + self::THRESHOLD_REMINDER => 'secondReminderForDegrade', + // Try to top-up the wallet before the account degradation + self::THRESHOLD_BEFORE_DEGRADE => 'topUpWallet', + // Degrade the account + self::THRESHOLD_DEGRADE => 'degradeAccount', + ]; + + if ($this->wallet->owner && $this->wallet->owner->isDegraded()) { + $this->degradedReminder(); + return self::THRESHOLD_DEGRADE_REMINDER; } - // Suspend the account - if (self::threshold($this->wallet, self::THRESHOLD_SUSPEND) < $now) { - $this->suspendAccount(); - return self::THRESHOLD_SUSPEND; + foreach (array_reverse($steps, true) as $type => $method) { + if (self::threshold($this->wallet, $type) < $now) { + $this->{$method}(); + return $type; + } } - // Try to top-up the wallet before suspending the account - if (self::threshold($this->wallet, self::THRESHOLD_BEFORE_SUSPEND) < $now) { - PaymentsController::topUpWallet($this->wallet); - return self::THRESHOLD_BEFORE_SUSPEND; - } + return null; + } - // Send the second reminder - if (self::threshold($this->wallet, self::THRESHOLD_REMINDER) < $now) { - $this->secondReminder(); - return self::THRESHOLD_REMINDER; + /** + * Send the initial reminder (for the suspend+delete process) + */ + protected function initialReminder() + { + if ($this->wallet->getSetting('balance_warning_initial')) { + return; } - // Try to top-up the wallet before the second reminder - if (self::threshold($this->wallet, self::THRESHOLD_BEFORE_REMINDER) < $now) { - PaymentsController::topUpWallet($this->wallet); - return self::THRESHOLD_BEFORE_REMINDER; - } + // TODO: Should we check if the account is already suspended? - // Send the initial reminder - if (self::threshold($this->wallet, self::THRESHOLD_INITIAL) < $now) { - $this->initialReminder(); - return self::THRESHOLD_INITIAL; - } + $this->sendMail(\App\Mail\NegativeBalance::class, false); - return null; + $now = \Carbon\Carbon::now()->toDateTimeString(); + $this->wallet->setSetting('balance_warning_initial', $now); } /** - * Send the initial reminder + * Send the initial reminder (for the process of degrading a account) */ - protected function initialReminder() + protected function initialReminderForDegrade() { if ($this->wallet->getSetting('balance_warning_initial')) { return; } - // TODO: Should we check if the account is already suspended? + if (!$this->wallet->owner || $this->wallet->owner->isDegraded()) { + return; + } $this->sendMail(\App\Mail\NegativeBalance::class, false); @@ -127,7 +151,7 @@ } /** - * Send the second reminder + * Send the second reminder (for the suspend+delete process) */ protected function secondReminder() { @@ -143,6 +167,25 @@ $this->wallet->setSetting('balance_warning_reminder', $now); } + /** + * Send the second reminder (for the process of degrading a account) + */ + protected function secondReminderForDegrade() + { + if ($this->wallet->getSetting('balance_warning_reminder')) { + return; + } + + if (!$this->wallet->owner || $this->wallet->owner->isDegraded()) { + return; + } + + $this->sendMail(\App\Mail\NegativeBalanceReminderDegrade::class, true); + + $now = \Carbon\Carbon::now()->toDateTimeString(); + $this->wallet->setSetting('balance_warning_reminder', $now); + } + /** * Suspend the account (and send the warning) */ @@ -194,6 +237,59 @@ $this->wallet->setSetting('balance_warning_before_delete', $now); } + /** + * Send the periodic reminder to the degraded account owners + */ + protected function degradedReminder() + { + // Sanity check + if (!$this->wallet->owner || !$this->wallet->owner->isDegraded()) { + return; + } + + $now = \Carbon\Carbon::now(); + $last = $this->wallet->getSetting('degraded_last_reminder'); + + if ($last) { + $last = new Carbon($last); + $period = 14; + + if ($last->addDays($period) > $now) { + return; + } + + $this->sendMail(\App\Mail\DegradedAccountReminder::class, true); + } + + $this->wallet->setSetting('degraded_last_reminder', $now->toDateTimeString()); + } + + /** + * Degrade the account + */ + protected function degradeAccount() + { + // The account may be already deleted, or degraded + if (!$this->wallet->owner || $this->wallet->owner->isDegraded()) { + return; + } + + $email = $this->wallet->owner->email; + + // The dirty work will be done by UserObserver + $this->wallet->owner->degrade(); + + \Log::info( + sprintf( + "[WalletCheck] Account degraded %s (%s)", + $this->wallet->id, + $email + ) + ); + + $this->sendMail(\App\Mail\NegativeBalanceDegraded::class, true); + } + /** * Delete the account */ @@ -265,47 +361,45 @@ $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); - } - - // A day before account suspension - if ($type == self::THRESHOLD_BEFORE_SUSPEND) { - return $negative_since->addDays($suspend + $remind - 1); - } - - // Second notification - if ($type == self::THRESHOLD_REMINDER) { - return $negative_since->addDays($remind); - } - - // A day before the second reminder - if ($type == self::THRESHOLD_BEFORE_REMINDER) { - return $negative_since->addDays($remind - 1); - } - // 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); } + $thresholds = [ + // A day before the second reminder + self::THRESHOLD_BEFORE_REMINDER => 7 - 1, + // Second notification + self::THRESHOLD_REMINDER => 7, + + // A day before account suspension + self::THRESHOLD_BEFORE_SUSPEND => 14 + 7 - 1, + // Account suspension + self::THRESHOLD_SUSPEND => 14 + 7, + // Warning about the upcomming account deletion + self::THRESHOLD_BEFORE_DELETE => 21 + 14 + 7 - 3, + // Acount deletion + self::THRESHOLD_DELETE => 21 + 14 + 7, + + // Last chance to top-up the wallet + self::THRESHOLD_BEFORE_DEGRADE => 13, + // Account degradation + self::THRESHOLD_DEGRADE => 14, + ]; + + if (!empty($thresholds[$type])) { + return $negative_since->addDays($thresholds[$type]); + } + return null; } + + /** + * Try to automatically top-up the wallet + */ + protected function topUpWallet(): void + { + PaymentsController::topUpWallet($this->wallet); + } } diff --git a/src/app/Mail/DegradedAccountReminder.php b/src/app/Mail/DegradedAccountReminder.php new file mode 100644 --- /dev/null +++ b/src/app/Mail/DegradedAccountReminder.php @@ -0,0 +1,82 @@ +wallet = $wallet; + $this->user = $user; + } + + /** + * Build the message. + * + * @return $this + */ + public function build() + { + $appName = Tenant::getConfig($this->user->tenant_id, 'app.name'); + $supportUrl = Tenant::getConfig($this->user->tenant_id, 'app.support_url'); + + $subject = \trans('mail.degradedaccountreminder-subject', ['site' => $appName]); + + $this->view('emails.html.degraded_account_reminder') + ->text('emails.plain.degraded_account_reminder') + ->subject($subject) + ->with([ + 'site' => $appName, + 'subject' => $subject, + 'username' => $this->user->name(true), + 'supportUrl' => $supportUrl, + 'walletUrl' => Utils::serviceUrl('/wallet', $this->user->tenant_id), + 'dashboardUrl' => Utils::serviceUrl('/dashboard', $this->user->tenant_id), + ]); + + return $this; + } + + /** + * Render the mail template with fake data + * + * @param string $type Output format ('html' or 'text') + * + * @return string HTML or Plain Text output + */ + public static function fakeRender(string $type = 'html'): string + { + $wallet = new Wallet(); + $user = new User(); + + $mail = new self($wallet, $user); + + return Helper::render($mail, $type); + } +} diff --git a/src/app/Mail/NegativeBalanceDegraded.php b/src/app/Mail/NegativeBalanceDegraded.php new file mode 100644 --- /dev/null +++ b/src/app/Mail/NegativeBalanceDegraded.php @@ -0,0 +1,82 @@ +wallet = $wallet; + $this->user = $user; + } + + /** + * Build the message. + * + * @return $this + */ + public function build() + { + $appName = Tenant::getConfig($this->user->tenant_id, 'app.name'); + $supportUrl = Tenant::getConfig($this->user->tenant_id, 'app.support_url'); + + $subject = \trans('mail.negativebalancedegraded-subject', ['site' => $appName]); + + $this->view('emails.html.negative_balance_degraded') + ->text('emails.plain.negative_balance_degraded') + ->subject($subject) + ->with([ + 'site' => $appName, + 'subject' => $subject, + 'username' => $this->user->name(true), + 'supportUrl' => $supportUrl, + 'walletUrl' => Utils::serviceUrl('/wallet', $this->user->tenant_id), + ]); + + return $this; + } + + /** + * Render the mail template with fake data + * + * @param string $type Output format ('html' or 'text') + * + * @return string HTML or Plain Text output + */ + public static function fakeRender(string $type = 'html'): string + { + $wallet = new Wallet(); + $user = new User(); + + $mail = new self($wallet, $user); + + return Helper::render($mail, $type); + } +} diff --git a/src/app/Mail/NegativeBalanceReminderDegrade.php b/src/app/Mail/NegativeBalanceReminderDegrade.php new file mode 100644 --- /dev/null +++ b/src/app/Mail/NegativeBalanceReminderDegrade.php @@ -0,0 +1,84 @@ +wallet = $wallet; + $this->user = $user; + } + + /** + * Build the message. + * + * @return $this + */ + public function build() + { + $appName = Tenant::getConfig($this->user->tenant_id, 'app.name'); + $supportUrl = Tenant::getConfig($this->user->tenant_id, 'app.support_url'); + $threshold = WalletCheck::threshold($this->wallet, WalletCheck::THRESHOLD_DEGRADE); + + $subject = \trans('mail.negativebalancereminder-subject', ['site' => $appName]); + + $this->view('emails.html.negative_balance_reminder_degrade') + ->text('emails.plain.negative_balance_reminder_degrade') + ->subject($subject) + ->with([ + 'site' => $appName, + 'subject' => $subject, + 'username' => $this->user->name(true), + 'supportUrl' => $supportUrl, + 'walletUrl' => Utils::serviceUrl('/wallet', $this->user->tenant_id), + 'date' => $threshold->toDateString(), + ]); + + return $this; + } + + /** + * Render the mail template with fake data + * + * @param string $type Output format ('html' or 'text') + * + * @return string HTML or Plain Text output + */ + public static function fakeRender(string $type = 'html'): string + { + $wallet = new Wallet(); + $user = new User(); + + $mail = new self($wallet, $user); + + return Helper::render($mail, $type); + } +} diff --git a/src/app/Observers/EntitlementObserver.php b/src/app/Observers/EntitlementObserver.php --- a/src/app/Observers/EntitlementObserver.php +++ b/src/app/Observers/EntitlementObserver.php @@ -108,6 +108,10 @@ $owner = $entitlement->wallet->owner; + if ($owner->isDegraded()) { + return; + } + // Determine if we're still within the free first month $freeMonthEnds = $owner->created_at->copy()->addMonthsWithoutOverflow(1); diff --git a/src/app/Observers/UserObserver.php b/src/app/Observers/UserObserver.php --- a/src/app/Observers/UserObserver.php +++ b/src/app/Observers/UserObserver.php @@ -335,14 +335,50 @@ } /** - * Handle the "updating" event. + * Handle the "updated" event. * * @param User $user The user that is being updated. * * @return void */ - public function updating(User $user) + public function updated(User $user) { \App\Jobs\User\UpdateJob::dispatch($user->id); + + $oldStatus = $user->getOriginal('status'); + $newStatus = $user->status; + + if (($oldStatus & User::STATUS_DEGRADED) !== ($newStatus & User::STATUS_DEGRADED)) { + $wallets = []; + $isDegraded = $user->isDegraded(); + + // Charge all entitlements as if they were being deleted, + // but don't delete them. Just debit the wallet and update + // entitlements' updated_at timestamp. On un-degrade we still + // update updated_at, but with no debit (the cost is 0 on a degraded account). + foreach ($user->wallets as $wallet) { + $wallet->updateEntitlements($isDegraded); + + // Remember time of the degradation for sending periodic reminders + // and reset it on un-degradation + $val = $isDegraded ? \Carbon\Carbon::now()->toDateTimeString() : null; + $wallet->setSetting('degraded_last_reminder', $val); + + $wallets[] = $wallet->id; + } + + // (Un-)degrade users by invoking an update job. + // LDAP backend will read the wallet owner's degraded status and + // set LDAP attributes accordingly. + // We do not change their status as their wallets have its own state + \App\Entitlement::whereIn('wallet_id', $wallets) + ->where('entitleable_id', '!=', $user->id) + ->where('entitleable_type', User::class) + ->pluck('entitleable_id') + ->unique() + ->each(function ($user_id) { + \App\Jobs\User\UpdateJob::dispatch($user_id); + }); + } } } diff --git a/src/app/Observers/WalletObserver.php b/src/app/Observers/WalletObserver.php --- a/src/app/Observers/WalletObserver.php +++ b/src/app/Observers/WalletObserver.php @@ -89,10 +89,15 @@ 'balance_warning_before_delete' => null, ]); - // Unsuspend the account/domains/users + // FIXME: Since we use account degradation, should we leave suspended state untouched? + + // Un-suspend and un-degrade the account owner if ($wallet->owner) { $wallet->owner->unsuspend(); + $wallet->owner->undegrade(); } + + // Un-suspend domains/users foreach ($wallet->entitlements as $entitlement) { if ( $entitlement->entitleable_type == \App\Domain::class diff --git a/src/app/User.php b/src/app/User.php --- a/src/app/User.php +++ b/src/app/User.php @@ -52,6 +52,8 @@ public const STATUS_LDAP_READY = 1 << 4; // user mailbox has been created in IMAP public const STATUS_IMAP_READY = 1 << 5; + // user in "limited feature-set" state + public const STATUS_DEGRADED = 1 << 6; /** * The attributes that are mass assignable. @@ -293,6 +295,21 @@ return $this->canDelete($object); } + /** + * Degrade the user + * + * @return void + */ + public function degrade(): void + { + if ($this->isDegraded()) { + return; + } + + $this->status |= User::STATUS_DEGRADED; + $this->save(); + } + /** * Return the \App\Domain for this user. * @@ -448,7 +465,7 @@ } /** - * Returns whether this domain is active. + * Returns whether this user is active. * * @return bool */ @@ -458,7 +475,28 @@ } /** - * Returns whether this domain is deleted. + * Returns whether this user (or its wallet owner) is degraded. + * + * @param bool $owner Check also the wallet owner instead just the user himself + * + * @return bool + */ + public function isDegraded(bool $owner = false): bool + { + if ($this->status & self::STATUS_DEGRADED) { + return true; + } + + if ($owner) { + $owner = $this->wallet()->owner; + return $owner && $owner->isDegraded(); + } + + return false; + } + + /** + * Returns whether this user is deleted. * * @return bool */ @@ -468,8 +506,7 @@ } /** - * Returns whether this (external) domain has been verified - * to exist in DNS. + * Returns whether this user is registered in IMAP. * * @return bool */ @@ -499,7 +536,7 @@ } /** - * Returns whether this domain is suspended. + * Returns whether this user is suspended. * * @return bool */ @@ -602,7 +639,17 @@ } /** - * Suspend this domain. + * Any (additional) properties of this user. + * + * @return \Illuminate\Database\Eloquent\Relations\HasMany + */ + public function settings() + { + return $this->hasMany('App\UserSetting', 'user_id'); + } + + /** + * Suspend this user. * * @return void */ @@ -617,7 +664,32 @@ } /** - * Unsuspend this domain. + * The tenant for this user account. + * + * @return \Illuminate\Database\Eloquent\Relations\BelongsTo + */ + public function tenant() + { + return $this->belongsTo('App\Tenant', 'tenant_id', 'id'); + } + + /** + * Un-degrade this user. + * + * @return void + */ + public function undegrade(): void + { + if (!$this->isDegraded()) { + return; + } + + $this->status ^= User::STATUS_DEGRADED; + $this->save(); + } + + /** + * Unsuspend this user. * * @return void */ @@ -719,6 +791,7 @@ self::STATUS_DELETED, self::STATUS_LDAP_READY, self::STATUS_IMAP_READY, + self::STATUS_DEGRADED, ]; foreach ($allowed_values as $value) { diff --git a/src/app/Wallet.php b/src/app/Wallet.php --- a/src/app/Wallet.php +++ b/src/app/Wallet.php @@ -82,7 +82,14 @@ } } - public function chargeEntitlements($apply = true) + /** + * Charge entitlements in the wallet + * + * @param bool $apply Set to false for a dry-run mode + * + * @return int Charged amount in cents + */ + public function chargeEntitlements($apply = true): int { // This wallet has been created less than a month ago, this is the trial period if ($this->owner->created_at >= Carbon::now()->subMonthsWithoutOverflow(1)) { @@ -103,13 +110,16 @@ $profit = 0; $charges = 0; $discount = $this->getDiscountRate(); + $isDegraded = $this->owner->isDegraded(); - DB::beginTransaction(); + if ($apply) { + DB::beginTransaction(); + } // used to parent individual entitlement billings to the wallet debit. $entitlementTransactions = []; - foreach ($this->entitlements()->get()->fresh() as $entitlement) { + foreach ($this->entitlements()->get() as $entitlement) { // This entitlement has been created less than or equal to 14 days ago (this is at // maximum the fourteenth 24-hour period). if ($entitlement->created_at > Carbon::now()->subDays(14)) { @@ -128,6 +138,10 @@ $cost = (int) ($entitlement->cost * $discount * $diff); $fee = (int) ($entitlement->fee * $diff); + if ($isDegraded) { + $cost = 0; + } + $charges += $cost; $profit += $cost - $fee; @@ -164,9 +178,9 @@ $wallet->{$method}(abs($profit), $desc); } } - } - DB::commit(); + DB::commit(); + } return $charges; } @@ -423,4 +437,72 @@ ] ); } + + /** + * Force-update entitlements' updated_at, charge if needed. + * + * @param bool $withCost When enabled the cost will be charged + * + * @return int Charged amount in cents + */ + public function updateEntitlements($withCost = true): int + { + $charges = 0; + $discount = $this->getDiscountRate(); + $now = Carbon::now(); + + DB::beginTransaction(); + + // used to parent individual entitlement billings to the wallet debit. + $entitlementTransactions = []; + + foreach ($this->entitlements()->get() as $entitlement) { + $cost = 0; + $diffInDays = $entitlement->updated_at->diffInDays($now); + + // This entitlement has been created less than or equal to 14 days ago (this is at + // maximum the fourteenth 24-hour period). + if ($entitlement->created_at > Carbon::now()->subDays(14)) { + // $cost=0 + } elseif ($withCost && $diffInDays > 0) { + // The price per day is based on the number of days in the last month + // or the current month if the period does not overlap with the previous month + // FIXME: This really should be simplified to constant $daysInMonth=30 + if ($now->day >= $diffInDays && $now->month == $entitlement->updated_at->month) { + $daysInMonth = $now->daysInMonth; + } else { + $daysInMonth = \App\Utils::daysInLastMonth(); + } + + $pricePerDay = $entitlement->cost / $daysInMonth; + + $cost = (int) (round($pricePerDay * $discount * $diffInDays, 0)); + } + + if ($diffInDays > 0) { + $entitlement->updated_at = $entitlement->updated_at->setDateFrom($now); + $entitlement->save(); + } + + if ($cost == 0) { + continue; + } + + $charges += $cost; + + // FIXME: Shouldn't we store also cost=0 transactions (to have the full history)? + $entitlementTransactions[] = $entitlement->createTransaction( + \App\Transaction::ENTITLEMENT_BILLED, + $cost + ); + } + + if ($charges > 0) { + $this->debit($charges, '', $entitlementTransactions); + } + + DB::commit(); + + return $charges; + } } diff --git a/src/config/app.php b/src/config/app.php --- a/src/config/app.php +++ b/src/config/app.php @@ -271,6 +271,10 @@ 'footer' => env('COMPANY_FOOTER', env('COMPANY_DETAILS')), ], + 'storage' => [ + 'min_qty' => (int) env('STORAGE_MIN_QTY', 5), // in GB + ], + 'vat' => [ 'countries' => env('VAT_COUNTRIES'), 'rate' => (float) env('VAT_RATE'), diff --git a/src/resources/js/app.js b/src/resources/js/app.js --- a/src/resources/js/app.js +++ b/src/resources/js/app.js @@ -339,6 +339,9 @@ return this.$t('status.active') }, + isDegraded() { + return store.state.authInfo.isAccountDegraded + }, pageName(path) { let page = this.$route.path @@ -375,7 +378,7 @@ return 'text-muted' } - if (user.isSuspended) { + if (user.isDegraded || user.isAccountDegraded || user.isSuspended) { return 'text-warning' } @@ -390,6 +393,10 @@ return this.$t('status.deleted') } + if (user.isDegraded || user.isAccountDegraded) { + return this.$t('status.degraded') + } + if (user.isSuspended) { return this.$t('status.suspended') } diff --git a/src/resources/lang/en/mail.php b/src/resources/lang/en/mail.php --- a/src/resources/lang/en/mail.php +++ b/src/resources/lang/en/mail.php @@ -17,6 +17,16 @@ 'more-info-html' => "See here for more information.", 'more-info-text' => "See :href for more information.", + 'degradedaccountreminder-subject' => ":site Reminder: Your account is free", + 'degradedaccountreminder-body1' => "Thanks for sticking around, we remind you your account is a free " + . "account and restricted to receiving email, and use of the web client and cockpit only.", + 'degradedaccountreminder-body2' => "This leaves you with an ideal account to use for account registration with third parties " + . "and password resets, notifications or even just subscriptions to newsletters and the like.", + 'degradedaccountreminder-body3' => "To regain functionality such as sending email, calendars, address books, phone synchronization " + . "and voice & video conferencing, log on to the cockpit and make sure you have a positive account balance.", + 'degradedaccountreminder-body4' => "You can also delete your account there, making sure your data disappears from our systems.", + 'degradedaccountreminder-body5' => "Thank you for your consideration!", + 'negativebalance-subject' => ":site Payment Required", 'negativebalance-body' => "This is a notification to let you know that your :site account balance has run into the negative and requires your attention. " . "Consider setting up an automatic payment to avoid messages like this in the future.", @@ -29,6 +39,14 @@ 'negativebalancereminder-body-warning' => "Please, be aware that your account will be suspended " . "if your account balance is not settled by :date.", + 'negativebalancereminderdegrade-body-warning' => "Please, be aware that your account will be degraded " + . "if your account balance is not settled by :date.", + + 'negativebalancedegraded-subject' => ":site Account Degraded", + 'negativebalancedegraded-body' => "Your :site account has been degraded for having a negative balance for too long. " + . "Consider setting up an automatic payment to avoid messages like this in the future.", + 'negativebalancedegraded-body-ext' => "Settle up now to undegrade your account:", + 'negativebalancesuspended-subject' => ":site Account Suspended", 'negativebalancesuspended-body' => "Your :site account has been suspended for having a negative balance for too long. " . "Consider setting up an automatic payment to avoid messages like this in the future.", diff --git a/src/resources/lang/en/ui.php b/src/resources/lang/en/ui.php --- a/src/resources/lang/en/ui.php +++ b/src/resources/lang/en/ui.php @@ -312,6 +312,7 @@ 'ready-user' => "The user account is almost ready.", 'verify' => "Verify your domain to finish the setup process.", 'verify-domain' => "Verify domain", + 'degraded' => "Degraded", 'deleted' => "Deleted", 'suspended' => "Suspended", 'notready' => "Not Ready", @@ -349,6 +350,8 @@ 'country' => "Country", 'create' => "Create user", 'custno' => "Customer No.", + 'degraded-warning' => "The account is degraded. Some features have been disabled.", + 'degraded-hint' => "Please, make a payment.", 'delete' => "Delete user", 'delete-account' => "Delete this account?", 'delete-email' => "Delete {email}", diff --git a/src/resources/lang/fr/mail.php b/src/resources/lang/fr/mail.php --- a/src/resources/lang/fr/mail.php +++ b/src/resources/lang/fr/mail.php @@ -17,6 +17,16 @@ 'more-info-html' => "Cliquez ici pour plus d'information.", 'more-info-text' => "Cliquez :href pour plus d'information.", + 'degradedaccountreminder-subject' => "Rappel du :site: Votre compte est gratuit", + 'degradedaccountreminder-body1' => "Merci de ne pas quitter le site, nous vous rappelons que votre compte est gratuit." + . " et limité à la réception d'emails, et à l'utilisation du client web et du cockpit uniquement.", + 'degradedaccountreminder-body2' => "Vous disposez ainsi d'un compte idéal à employer pour l'enregistrement de comptes auprès de tiers" + . " et les réinitialisations de mot de passe, les notifications ou même simplement les souscriptions aux newsletters et autres.", + 'degradedaccountreminder-body3' => "Pour récupérer les fonctionnalités telles que l'envoi de e-mail, les calendriers, les carnets d'adresses et la synchronisation des téléphones" + . " et les voix et vidéoconférences, connectez-vous au cockpit et assurez-vous que le solde de votre compte est positif.", + 'degradedaccountreminder-body4' => "Vous pouvez également y supprimer votre compte, afin que vos données disparaissent de nos systèmes.", + 'degradedaccountreminder-body5' => "Nous apprécions votre collaboration!", + 'negativebalance-subject' => ":site Paiement Requis", 'negativebalance-body' => "C'est une notification pour vous informer que votre :site le solde du compte est en négatif et nécessite votre attention." . " Veillez à mettre en place un auto-paiement pour éviter de tel avertissement comme celui-ci dans le future.", @@ -41,6 +51,14 @@ . " votre compte et toutes ses données seront supprimés si le solde de votre compte nest pas régler avant le :date.", 'negativebalancebeforedelete-body-ext' => "Régler votre compte immédiatement:", + 'negativebalancereminderdegrade-body-warning' => "Veuillez noter que votre compte sera dégradé" + . " si le solde de votre compte n'est pas réglé avant le :date.", + + 'negativebalancedegraded-subject' => ":site de Compte Dégradé", + 'negativebalancedegraded-body' => "Votre compte :site a été dégradé pour avoir un solde négatif depuis trop longtemps." + . " Envisagez de mettre en place un paiement automatique pour éviter des messages comme celui-ci à l'avenir.", + 'negativebalancedegraded-body-ext' => "Réglez maintenant pour rétablir votre compte:", + 'passwordreset-subject' => ":site Réinitialisation du mot de passe", 'passwordreset-body1' => "Quelqu'un a récemment demandé de changer votre :site mot de passe.", 'passwordreset-body2' => "Si vous êtes dans ce cas, veuillez utiliser ce code de vérification pour terminer le processus:", diff --git a/src/resources/lang/fr/ui.php b/src/resources/lang/fr/ui.php --- a/src/resources/lang/fr/ui.php +++ b/src/resources/lang/fr/ui.php @@ -312,6 +312,7 @@ 'ready-user' => "Le compte d'utilisateur est presque prêt.", 'verify' => "Veuillez vérifier votre domaine pour terminer le processus de configuration.", 'verify-domain' => "Vérifier domaine", + 'degraded' => "Dégradé", 'deleted' => "Supprimé", 'suspended' => "Suspendu", 'notready' => "Pas Prêt", @@ -349,6 +350,8 @@ 'country' => "Pays", 'create' => "Créer un utilisateur", 'custno' => "No. de Client.", + 'degraded-warning' => "Le compte est dégradé. Certaines fonctionnalités ont été désactivées.", + 'degraded-hint' => "Veuillez effectuer un paiement.", 'delete' => "Supprimer Utilisateur", 'delete-email' => "Supprimer {email}", 'delete-text' => "Voulez-vous vraiment supprimer cet utilisateur de façon permanente?" diff --git a/src/resources/views/emails/html/degraded_account_reminder.blade.php b/src/resources/views/emails/html/degraded_account_reminder.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/html/degraded_account_reminder.blade.php @@ -0,0 +1,19 @@ + + +
+ + + +{{ __('mail.header', ['name' => $username]) }}
+ +{{ __('mail.degradedaccountreminder-body1', ['site' => $site]) }}
+{{ __('mail.degradedaccountreminder-body2', ['site' => $site]) }}
+{{ __('mail.degradedaccountreminder-body3', ['site' => $site]) }}
+ +{{ __('mail.degradedaccountreminder-body4', ['site' => $site]) }}
+{{ __('mail.degradedaccountreminder-body5', ['site' => $site]) }}
+ +{{ __('mail.footer1') }}
+{{ __('mail.footer2', ['site' => $site]) }}
+ + diff --git a/src/resources/views/emails/html/negative_balance_degraded.blade.php b/src/resources/views/emails/html/negative_balance_degraded.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/html/negative_balance_degraded.blade.php @@ -0,0 +1,21 @@ + + + + + + +{{ __('mail.header', ['name' => $username]) }}
+ +{{ __('mail.negativebalancedegraded-body', ['site' => $site]) }}
+{{ __('mail.negativebalancedegraded-body-ext', ['site' => $site]) }}
+ + +@if ($supportUrl) +{{ __('mail.support', ['site' => $site]) }}
+ +@endif + +{{ __('mail.footer1') }}
+{{ __('mail.footer2', ['site' => $site]) }}
+ + diff --git a/src/resources/views/emails/html/negative_balance_reminder_degrade.blade.php b/src/resources/views/emails/html/negative_balance_reminder_degrade.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/html/negative_balance_reminder_degrade.blade.php @@ -0,0 +1,22 @@ + + + + + + +{{ __('mail.header', ['name' => $username]) }}
+ +{{ __('mail.negativebalancereminder-body', ['site' => $site]) }}
+{{ __('mail.negativebalancereminder-body-ext', ['site' => $site]) }}
+ +{{ __('mail.negativebalancereminderdegrade-body-warning', ['site' => $site, 'date' => $date]) }}
+ +@if ($supportUrl) +{{ __('mail.support', ['site' => $site]) }}
+ +@endif + +{{ __('mail.footer1') }}
+{{ __('mail.footer2', ['site' => $site]) }}
+ + diff --git a/src/resources/views/emails/plain/degraded_account_reminder.blade.php b/src/resources/views/emails/plain/degraded_account_reminder.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/plain/degraded_account_reminder.blade.php @@ -0,0 +1,17 @@ +{!! __('mail.header', ['name' => $username]) !!} + +{!! __('mail.degradedaccountreminder-body1', ['site' => $site]) !!} + +{!! __('mail.degradedaccountreminder-body2', ['site' => $site]) !!} + +{!! __('mail.degradedaccountreminder-body3', ['site' => $site]) !!} + +{!! $dashboardUrl !!} + +{!! __('mail.degradedaccountreminder-body4', ['site' => $site]) !!} + +{!! __('mail.degradedaccountreminder-body5', ['site' => $site]) !!} + +-- +{!! __('mail.footer1') !!} +{!! __('mail.footer2', ['site' => $site]) !!} diff --git a/src/resources/views/emails/plain/negative_balance_degraded.blade.php b/src/resources/views/emails/plain/negative_balance_degraded.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/plain/negative_balance_degraded.blade.php @@ -0,0 +1,17 @@ +{!! __('mail.header', ['name' => $username]) !!} + +{!! __('mail.negativebalancedegraded-body', ['site' => $site]) !!} + +{!! __('mail.negativebalancedegraded-body-ext', ['site' => $site]) !!} + +{!! $walletUrl !!} + +@if ($supportUrl) +{!! __('mail.support', ['site' => $site]) !!} + +{!! $supportUrl !!} +@endif + +-- +{!! __('mail.footer1') !!} +{!! __('mail.footer2', ['site' => $site]) !!} diff --git a/src/resources/views/emails/plain/negative_balance_reminder_degrade.blade.php b/src/resources/views/emails/plain/negative_balance_reminder_degrade.blade.php new file mode 100644 --- /dev/null +++ b/src/resources/views/emails/plain/negative_balance_reminder_degrade.blade.php @@ -0,0 +1,19 @@ +{!! __('mail.header', ['name' => $username]) !!} + +{!! __('mail.negativebalancereminder-body', ['site' => $site]) !!} + +{!! __('mail.negativebalancereminder-body-ext', ['site' => $site]) !!} + +{!! $walletUrl !!} + +{!! __('mail.negativebalancereminderdegrade-body-warning', ['site' => $site, 'date' => $date]) !!} + +@if ($supportUrl) +{!! __('mail.support', ['site' => $site]) !!} + +{!! $supportUrl !!} +@endif + +-- +{!! __('mail.footer1') !!} +{!! __('mail.footer2', ['site' => $site]) !!} diff --git a/src/resources/vue/App.vue b/src/resources/vue/App.vue --- a/src/resources/vue/App.vue +++ b/src/resources/vue/App.vue @@ -63,6 +63,22 @@ childMounted() { this.$root.updateBodyClass() this.getFAQ() + this.degradedWarning() + }, + degradedWarning() { + // Display "Account Degraded" warning on all pages + if (this.$root.isDegraded()) { + let message = this.$t('user.degraded-warning') + + if (this.$store.state.authInfo.isDegraded) { + message += ' ' + this.$t('user.degraded-hint') + } + + const html = `${message}