From d31f9eb2cc35eec3b48cb1af567949d0cf7a3298 Mon Sep 17 00:00:00 2001 From: Wes Copeland Date: Sun, 3 Dec 2023 13:01:08 -0500 Subject: [PATCH 1/2] feat: add 'missable' type (#2065) --- app/Helpers/database/achievement.php | 7 +- app/Helpers/database/game.php | 10 +- app/Platform/AppServiceProvider.php | 4 + .../MigrateMissableAchievementsToType.php | 55 +++++++++ app/Platform/Enums/AchievementType.php | 3 + app/Platform/Models/Achievement.php | 9 ++ app/Platform/Models/Game.php | 2 +- database/factories/AchievementFactory.php | 7 ++ lang/en/achievement-type.php | 1 + public/achievementInfo.php | 36 +++--- public/achievementinspector.php | 12 +- public/gameInfo.php | 4 - public/reportissue.php | 2 - public/request/achievement/update-type.php | 11 +- public/ticketmanager.php | 3 +- .../views/components/icon/missable.blade.php | 3 + .../views/components/modal-trigger.blade.php | 6 +- .../components/achievement/title.blade.php | 12 -- .../developer/inspector-toolbox.blade.php | 32 +++-- .../achievements-list-item.blade.php | 6 - .../game/achievements-list/root.blade.php | 10 -- .../type-indicator.blade.php | 111 +++++++++++------- .../Feature/Connect/UploadAchievementTest.php | 4 +- 23 files changed, 226 insertions(+), 124 deletions(-) create mode 100644 app/Platform/Commands/MigrateMissableAchievementsToType.php create mode 100644 resources/views/components/icon/missable.blade.php diff --git a/app/Helpers/database/achievement.php b/app/Helpers/database/achievement.php index ba3f5738f6..0a121d7fc3 100644 --- a/app/Helpers/database/achievement.php +++ b/app/Helpers/database/achievement.php @@ -210,8 +210,11 @@ function UploadNewAchievement( ); $isEventGame = $gameData['ConsoleID'] == 101; - if ($isForSubsetOrTestKit || $isEventGame) { - $errorOut = "Cannot set type on achievement in subset, test kit, or event."; + if ( + ($isForSubsetOrTestKit || $isEventGame) + && ($type === AchievementType::Progression || $type === AchievementType::WinCondition) + ) { + $errorOut = "Cannot set progression or win condition type on achievement in subset, test kit, or event."; return false; } diff --git a/app/Helpers/database/game.php b/app/Helpers/database/game.php index 65cbedf260..7add6f7f15 100644 --- a/app/Helpers/database/game.php +++ b/app/Helpers/database/game.php @@ -65,8 +65,9 @@ function getGameMetadata( CASE WHEN ach.type = 'progression' THEN 0 WHEN ach.type = 'win_condition' THEN 1 - WHEN ach.type IS NULL THEN 2 - ELSE 3 + WHEN ach.type = 'missable' THEN 2 + WHEN ach.type IS NULL THEN 3 + ELSE 4 END, ach.DisplayOrder, ach.ID ASC ", @@ -75,8 +76,9 @@ function getGameMetadata( CASE WHEN ach.type = 'progression' THEN 0 WHEN ach.type = 'win_condition' THEN 1 - WHEN ach.type IS NULL THEN 2 - ELSE 3 + WHEN ach.type = 'missable' THEN 2 + WHEN ach.type IS NULL THEN 3 + ELSE 4 END DESC, ach.DisplayOrder DESC, ach.ID DESC ", diff --git a/app/Platform/AppServiceProvider.php b/app/Platform/AppServiceProvider.php index 71b692c558..c97b080b1e 100644 --- a/app/Platform/AppServiceProvider.php +++ b/app/Platform/AppServiceProvider.php @@ -5,6 +5,7 @@ namespace App\Platform; use App\Platform\Commands\DeleteOrphanedLeaderboardEntries; +use App\Platform\Commands\MigrateMissableAchievementsToType; use App\Platform\Commands\NoIntroImport; use App\Platform\Commands\ResetPlayerAchievement; use App\Platform\Commands\SyncAchievements; @@ -68,6 +69,9 @@ public function boot(): void // Game Hashes NoIntroImport::class, + // Achievements + MigrateMissableAchievementsToType::class, + // Leaderboards UpdateLeaderboardMetrics::class, DeleteOrphanedLeaderboardEntries::class, diff --git a/app/Platform/Commands/MigrateMissableAchievementsToType.php b/app/Platform/Commands/MigrateMissableAchievementsToType.php new file mode 100644 index 0000000000..89cc5fb4f2 --- /dev/null +++ b/app/Platform/Commands/MigrateMissableAchievementsToType.php @@ -0,0 +1,55 @@ +argument('achievementId'); + + if ($achievementId !== null) { + $achievement = Achievement::findOrFail($achievementId); + + $this->info('Updating missable type for achievement [' . $achievement->id . ']'); + + $this->syncMissableTypeForAchievement($achievement); + } else { + $allTaggedMissables = Achievement::where('Title', 'like', '%[m]%')->get(); + + $this->info('Updating missable types for ' . $allTaggedMissables->count() . ' achievements.'); + + foreach ($allTaggedMissables as $achievement) { + $this->syncMissableTypeForAchievement($achievement); + } + + $this->info('All achievements have been updated.'); + } + } + + private function syncMissableTypeForAchievement(Achievement $achievement): void + { + $usesLegacyMissableTag = mb_strpos($achievement->Title, '[m]'); + + // Is this achievement eligible for syncing? It must contain the legacy + // missable tag and must not already have a type. + if ($usesLegacyMissableTag && !$achievement->type) { + $achievement->type = AchievementType::Missable; + + // Remove the [m] tag and trim whitespace + $achievement->Title = trim(str_replace('[m]', '', $achievement->Title)); + } + + $achievement->save(); + } +} diff --git a/app/Platform/Enums/AchievementType.php b/app/Platform/Enums/AchievementType.php index a228dea74a..01b6b176e8 100644 --- a/app/Platform/Enums/AchievementType.php +++ b/app/Platform/Enums/AchievementType.php @@ -10,11 +10,14 @@ abstract class AchievementType public const WinCondition = 'win_condition'; + public const Missable = 'missable'; + public static function cases(): array { return [ self::Progression, self::WinCondition, + self::Missable, ]; } diff --git a/app/Platform/Models/Achievement.php b/app/Platform/Models/Achievement.php index c9c1b5ed59..376748f2cb 100644 --- a/app/Platform/Models/Achievement.php +++ b/app/Platform/Models/Achievement.php @@ -304,6 +304,15 @@ public function scopeWinCondition(Builder $query): Builder return $this->scopeType($query, AchievementType::WinCondition); } + /** + * @param Builder $query + * @return Builder + */ + public function scopeMissable(Builder $query): Builder + { + return $this->scopeType($query, AchievementType::Missable); + } + /** * @param Builder $query * @return Builder diff --git a/app/Platform/Models/Game.php b/app/Platform/Models/Game.php index 96137bb8cc..278ca2188b 100644 --- a/app/Platform/Models/Game.php +++ b/app/Platform/Models/Game.php @@ -165,7 +165,7 @@ public function shouldBeSearchable(): bool // == accessors - public function getCanHaveTypes(): bool + public function getCanHaveBeatenTypes(): bool { $isSubsetOrTestKit = ( mb_strpos($this->Title, "[Subset") !== false diff --git a/database/factories/AchievementFactory.php b/database/factories/AchievementFactory.php index ce1fd33e78..95ada5f5be 100644 --- a/database/factories/AchievementFactory.php +++ b/database/factories/AchievementFactory.php @@ -62,4 +62,11 @@ public function winCondition(): static 'type' => AchievementType::WinCondition, ]); } + + public function missable(): static + { + return $this->state(fn (array $attributes) => [ + 'type' => AchievementType::Missable, + ]); + } } diff --git a/lang/en/achievement-type.php b/lang/en/achievement-type.php index b1087183e3..81c5a096a4 100644 --- a/lang/en/achievement-type.php +++ b/lang/en/achievement-type.php @@ -3,6 +3,7 @@ use App\Platform\Enums\AchievementType; return [ + AchievementType::Missable => __('Missable'), AchievementType::Progression => __('Progression'), AchievementType::WinCondition => __('Win Condition'), ]; diff --git a/public/achievementInfo.php b/public/achievementInfo.php index 26f6cbe6cc..a48bfe52f1 100644 --- a/public/achievementInfo.php +++ b/public/achievementInfo.php @@ -122,7 +122,7 @@ function generateAchievementMetaDescription( ?> = Permissions::Developer || ($permissions >= Permissions::JuniorDeveloper && $isAuthor)): ?> ', [ 'rawTitle' => $achievementTitle, - 'isDisplayingTags' => false, ]); echo "
"; @@ -342,9 +340,9 @@ function ResetProgress() { echo ""; echo ""; - if ($canHaveTypes) { - $typeHelperContent = "A game is considered beaten if ALL " . __('achievement-type.' . AchievementType::Progression) . " achievements are unlocked and ANY " . __('achievement-type.' . AchievementType::WinCondition) . " achievements are unlocked."; - echo ""; + $typeHelperContent = "A game is considered beaten if ALL " . __('achievement-type.' . AchievementType::Progression) . " achievements are unlocked and ANY " . __('achievement-type.' . AchievementType::WinCondition) . " achievements are unlocked."; + echo ""; + if ($canHaveBeatenTypes) { echo ""; - echo ""; - echo ""; + } else { + echo ""; } + echo ""; + echo ""; echo ""; echo " 

"; diff --git a/public/achievementinspector.php b/public/achievementinspector.php index 47904613f6..97739d2be1 100644 --- a/public/achievementinspector.php +++ b/public/achievementinspector.php @@ -31,7 +31,7 @@ $gameIcon = null; $gameTitle = null; $gameIDSpecified = isset($gameID) && $gameID != 0; -$canHaveTypes = false; +$canHaveBeatenTypes = false; if ($gameIDSpecified) { getGameMetadata($gameID, null, $achievementData, $gameData, 0, null, $flag); $gameTitle = $gameData['Title']; @@ -41,7 +41,7 @@ getCodeNotes($gameID, $codeNotes); - $canHaveTypes = ( + $canHaveBeatenTypes = ( mb_strpos($gameTitle, "[Subset") === false && mb_strpos($gameTitle, "~Test Kit~") === false && $gameData['ConsoleID'] !== 101 @@ -102,7 +102,7 @@ function updateDisplayOrder(objID) {

HTML; - if ($canHaveTypes) { + if ($canHaveBeatenTypes) { echo << You can mark multiple achievements as '$progressionLabel' or '$winConditionLabel'. To do this, check the desired @@ -192,7 +192,7 @@ function updateDisplayOrder(objID) { $typeLabelClassNames = !$achType ? "text-muted" : ""; - if ($canHaveTypes) { + if ($canHaveBeatenTypes) { echo << Type: @@ -258,13 +258,13 @@ function updateDisplayOrder(objID) { echo "
"; echo Blade::render(' ', [ - 'canHaveTypes' => $canHaveTypes, + 'canHaveBeatenTypes' => $canHaveBeatenTypes, 'gameId' => $gameID, 'isManagingCoreAchievements' => $flag === AchievementFlag::OfficialCore, 'modificationLevel' => $modificationLevel, diff --git a/public/gameInfo.php b/public/gameInfo.php index e663930af1..d6ff512d7e 100644 --- a/public/gameInfo.php +++ b/public/gameInfo.php @@ -1343,19 +1343,15 @@ class="mt-1" :achievements="$achievements" :beatenGameCreditDialogContext="$beatenGameCreditDialogContext" :isCreditDialogEnabled="$isCreditDialogEnabled" - :progressionTypeValue="$progressionTypeValue" :showAuthorNames="$showAuthorNames" :totalPlayerCount="$totalPlayerCount" - :winConditionTypeValue="$winConditionTypeValue" /> ', [ 'achievements' => $achievementData, 'beatenGameCreditDialogContext' => $beatenGameCreditDialogContext, 'isCreditDialogEnabled' => $user && $flagParam != $unofficialFlag, - 'progressionTypeValue' => AchievementType::Progression, 'showAuthorNames' => !$isOfficial && isset($user) && $permissions >= Permissions::JuniorDeveloper, 'totalPlayerCount' => $numDistinctPlayers, - 'winConditionTypeValue' => AchievementType::WinCondition, ]); } } diff --git a/public/reportissue.php b/public/reportissue.php index f8b2fae244..520d560ae5 100644 --- a/public/reportissue.php +++ b/public/reportissue.php @@ -80,10 +80,8 @@ function reportIssueComponent() { Blade::render(' ', [ 'rawTitle' => $achievementTitle, - 'isDisplayingTags' => false, ]); ?> » Issue Report diff --git a/public/request/achievement/update-type.php b/public/request/achievement/update-type.php index 0703c1a77a..6c5137a4a8 100644 --- a/public/request/achievement/update-type.php +++ b/public/request/achievement/update-type.php @@ -23,9 +23,13 @@ $foundAchievements = Achievement::find($achievementIds); -// Don't allow adding types to subsets or test kits. +// Don't allow adding beaten types to subsets or test kits. $game = Game::find($foundAchievements->get(0)->GameID); -if ($game && !$game->getCanHaveTypes()) { +if ( + $game + && !$game->getCanHaveBeatenTypes() + && ($value === AchievementType::Progression || $value === AchievementType::WinCondition) +) { abort(400); } @@ -43,6 +47,9 @@ if ($value === AchievementType::WinCondition) { $commentText = "set this achievement's type to Win Condition"; } + if ($value === AchievementType::Missable) { + $commentText = "set this achievement's type to Missable"; + } if (!$value) { $commentText = "removed this achievement's type"; } diff --git a/public/ticketmanager.php b/public/ticketmanager.php index ebf055c3c8..43b8fa59d5 100644 --- a/public/ticketmanager.php +++ b/public/ticketmanager.php @@ -140,10 +140,9 @@ echo " » $gameTitle ($consoleName)"; if (!empty($achievementIDGiven)) { echo " » " . Blade::render(' - + ', [ 'rawTitle' => $achievementTitle, - 'isDisplayingTags' => false, ]); } } diff --git a/resources/views/components/icon/missable.blade.php b/resources/views/components/icon/missable.blade.php new file mode 100644 index 0000000000..501a389b4b --- /dev/null +++ b/resources/views/components/icon/missable.blade.php @@ -0,0 +1,3 @@ + + + diff --git a/resources/views/components/modal-trigger.blade.php b/resources/views/components/modal-trigger.blade.php index 1a5cf9df74..69a46194c5 100644 --- a/resources/views/components/modal-trigger.blade.php +++ b/resources/views/components/modal-trigger.blade.php @@ -10,8 +10,10 @@ ])
@isset ($trigger) diff --git a/resources/views/platform/components/achievement/title.blade.php b/resources/views/platform/components/achievement/title.blade.php index 5ca5193b2a..4a9c638d82 100644 --- a/resources/views/platform/components/achievement/title.blade.php +++ b/resources/views/platform/components/achievement/title.blade.php @@ -1,16 +1,9 @@ @props([ - 'isDisplayingTags' => true, 'rawTitle' => '', ]) tags. @@ -18,8 +11,3 @@ ?> {{ $processedTitle }} -@if ($isDisplayingTags && $containsMissableTag) - - [m] - -@endif diff --git a/resources/views/platform/components/developer/inspector-toolbox.blade.php b/resources/views/platform/components/developer/inspector-toolbox.blade.php index 5f5ad7efb8..77caf3172d 100644 --- a/resources/views/platform/components/developer/inspector-toolbox.blade.php +++ b/resources/views/platform/components/developer/inspector-toolbox.blade.php @@ -1,5 +1,5 @@ @props([ - 'canHaveTypes' => true, + 'canHaveBeatenTypes' => true, 'gameId' => 0, 'modificationLevel' => 'none', // 'none' | 'partial' | 'full' 'isManagingCoreAchievements' => true, @@ -11,6 +11,7 @@ $progressionType = AchievementType::Progression; $winConditionType = AchievementType::WinCondition; +$missableType = AchievementType::Missable; $officialFlag = AchievementFlag::OfficialCore; $unofficialFlag = AchievementFlag::Unofficial; ?> @@ -23,7 +24,7 @@ function toolboxComponent() { /** * @param {'flag' | 'type'} property - * @param {3 | 5 | 'progression' | 'win_condition' | null} newValue + * @param {3 | 5 | 'progression' | 'win_condition' | 'missable' | null} newValue * @param {number} selectedCount */ getConfirmMessage(property, newValue, selectedCount) { @@ -42,6 +43,8 @@ function toolboxComponent() { message = `Are you sure you want to set ${selectedCount === 1 ? 'this achievement' : 'these achievements'} to Progression?`; } else if (newValue === '{{ $winConditionType }}') { message = `Are you sure you want to set ${selectedCount === 1 ? 'this achievement' : 'these achievements'} to Win Condition?`; + } else if (newValue === '{{ $missableType }}') { + message = `Are you sure you want to set ${selectedCount === 1 ? 'this achievement' : 'these achievements'} to Missable?`; } else { message = `Are you sure you want to remove the type from ${selectedCount === 1 ? 'this achievement' : 'these achievements'}?`; } @@ -70,7 +73,7 @@ function toolboxComponent() { /** * @param {'flag' | 'type'} property - * @param {3 | 5 | 'progression' | 'win_condition' | null} newValue + * @param {3 | 5 | 'progression' | 'win_condition' | 'missable' | null} newValue */ updateAchievementsProperty(property, newValue) { // Creates an array of checked achievement IDs and sends it to the updateAchievements function @@ -135,7 +138,7 @@ class="btn" @endif - @if ($canHaveTypes) + @if ($canHaveBeatenTypes) - - @endif + + + + @if ($modificationLevel === 'full') @endif diff --git a/resources/views/platform/components/game/achievements-list/achievements-list-item.blade.php b/resources/views/platform/components/game/achievements-list/achievements-list-item.blade.php index 65dc7436ae..a1f1e84c08 100644 --- a/resources/views/platform/components/game/achievements-list/achievements-list-item.blade.php +++ b/resources/views/platform/components/game/achievements-list/achievements-list-item.blade.php @@ -2,8 +2,6 @@ 'achievement' => [], 'beatenGameCreditDialogContext' => 's:|h:', 'totalPlayerCount' => 0, - 'progressionTypeValue' => 'progression', // `AchievementType` - 'winConditionTypeValue' => 'win_condition', // `AchievementType` 'useMinimalLayout' => false, 'isUnlocked' => false, 'isUnlockedHardcore' => false, @@ -72,8 +70,6 @@
@@ -108,8 +104,6 @@ "; - - echo "

New Message

"; - - if ($messageContextData !== null) { - echo "In reply to "; - echo userAvatar($messageContextData['UserFrom']); - echo " who wrote:

"; - echo "
$messageContextPayload
"; - } - - echo "
"; - echo csrf_field(); - - echo ""; - echo ""; - - $destUser = mb_strlen($messageTo) > 2 ? $messageTo : '_User'; - echo ""; - echo ""; - echo ""; - echo ""; - echo ""; - echo ""; - echo ""; - - $loadingIconSrc = asset('assets/images/icon/loading.gif'); - - echo << - - - - HTML; - - echo ""; - echo "
User:
Subject:
Message:"; - RenderShortcodeButtons(); - echo "
-
- Loading... - - -
-
"; - echo "
"; - - echo "
"; - ?> - - diff --git a/public/friends.php b/public/friends.php index 1c1645318d..49adfd3d5c 100644 --- a/public/friends.php +++ b/public/friends.php @@ -124,7 +124,7 @@ function RenderUserList(string $header, array $users, int $friendshipType, array echo ""; echo "
"; - echo "Message"; + echo "Message"; echo "
"; echo csrf_field(); diff --git a/public/inbox.php b/public/inbox.php deleted file mode 100644 index 259f439ac8..0000000000 --- a/public/inbox.php +++ /dev/null @@ -1,187 +0,0 @@ -input('u'); -$displayCount = requestInputSanitized('c', 10, 'integer'); -$offset = requestInputSanitized('o', 0, 'integer'); - -if (!authenticateFromCookie($user, $permissions, $userDetails)) { - abort(401); -} - -if ($outbox) { - $unreadMessageCount = 0; - $totalMessageCount = GetSentMessageCount($user); - $allMessages = GetSentMessages($user, $offset, $displayCount); - RenderContentStart('Outbox'); -} else { - $unreadMessageCount = GetMessageCount($user, $totalMessageCount); - $allMessages = GetAllMessages($user, $offset, $displayCount, $unreadOnly); - RenderContentStart('Inbox'); -} -?> - -
-
- Outbox"; - - echo "
You have $totalMessageCount sent messages.
"; - - echo "
"; - echo "Inbox"; - echo "
"; - echo "Create New Message"; - echo "
"; - echo "
"; - } else { - echo "

Inbox

"; - - echo "
"; - echo "
You have $unreadMessageCount unread of $totalMessageCount total messages.
"; - echo "
"; - - echo "
"; - echo "Outbox"; - echo "
"; - if ($unreadOnly) { - echo "View All Messages"; - } else { - echo "View Unread Only"; - } - echo "Create New Message"; - echo "
"; - echo "
"; - } - - echo ""; - - echo ""; - echo ""; - if ($outbox) { - echo ""; - } else { - echo ""; - } - echo ""; - echo ""; - - $totalMsgs = count($allMessages); - - for ($i = 0; $i < $totalMsgs; $i++) { - $msgID = $allMessages[$i]['ID']; - $msgTime = $allMessages[$i]['TimeSent']; - $msgSentAtNice = date("d/m/y, H:i ", strtotime($msgTime)); - // $msgTo = $allMessages[$i]['UserTo']; - $msgTitle = $allMessages[$i]['Title']; - $msgPayload = $allMessages[$i]['Payload']; - $msgType = $allMessages[$i]['Type']; - - if ($outbox) { - $msgUser = $allMessages[$i]['UserTo']; - $msgUnread = false; - } else { - $msgUser = $allMessages[$i]['UserFrom']; - $msgUnread = ($allMessages[$i]['Unread'] == 1); - } - - sanitize_outputs( - $msgUser, - $msgTitle, - $msgPayload, - ); - - $msgPayload = Shortcode::render($msgPayload); - - $styleAlt = $i % 2 == 1 ? "alt" : ""; - - echo ""; - - echo ""; - - echo ""; - echo ""; - - // echo ""; - - echo ""; - - echo ""; - - echo ""; - echo ""; - echo ""; - } - - echo "
DateToFromTitle
"; - echo "$msgSentAtNice"; - echo ""; - echo userAvatar($msgUser, label: false); - echo ""; - echo userAvatar($msgUser, icon: false); - echo "" . $msgTo . ""; - echo $msgTitle; - echo "
"; - echo "
$msgPayload
"; - - if (!$outbox) { - echo "
"; - - echo ""; - echo csrf_field(); - echo ""; - echo ""; - echo ""; - - echo ""; - - echo "Reply"; - - echo "
"; - } - - echo "
"; - - // Get message count and build paginator URL from current GET parameters - $messageCount = $unreadOnly ? $unreadMessageCount : $totalMessageCount; - unset($_GET['o']); - $urlPrefix = '/inbox.php?' . http_build_query($_GET) . '&o='; - - echo "
"; - RenderPaginator($messageCount, $displayCount, $offset, $urlPrefix); - echo "
"; - - ?> -
-
- diff --git a/public/managehashes.php b/public/managehashes.php index 1199bb3756..bd11cf4fab 100644 --- a/public/managehashes.php +++ b/public/managehashes.php @@ -113,7 +113,7 @@ function UnlinkHash(user, gameID, hash, elem) { } echo "
"; - echo "
Warning: PLEASE be careful with this tool. If in doubt, leave a message for admins and they'll help sort it.
"; + echo "
Warning: PLEASE be careful with this tool. If in doubt, leave a message for admins and they'll help sort it.
"; echo "
Currently this game has $numLinks unique hashes registered for it:
"; diff --git a/public/request/message/delete.php b/public/request/message/delete.php deleted file mode 100644 index 650d940d3d..0000000000 --- a/public/request/message/delete.php +++ /dev/null @@ -1,18 +0,0 @@ -withErrors(__('legacy.error.permissions')); -} - -$input = Validator::validate(Arr::wrap(request()->post()), [ - 'message' => 'required|integer|exists:Messages,ID', -]); - -if (DeleteMessage($user, (int) $input['message'])) { - return back()->with('success', __('legacy.success.delete')); -} - -return back()->withErrors(__('legacy.error.error')); diff --git a/public/request/message/read.php b/public/request/message/read.php deleted file mode 100644 index 332ebe4eb3..0000000000 --- a/public/request/message/read.php +++ /dev/null @@ -1,19 +0,0 @@ -post()), [ - 'message' => 'required|integer|exists:Messages,ID', - 'status' => 'required|integer|in:0,1', -]); - -if (markMessageAsRead($user, $input['message'], $input['status'])) { - return true; -} - -abort(400); diff --git a/public/request/message/send.php b/public/request/message/send.php deleted file mode 100644 index c35b776a59..0000000000 --- a/public/request/message/send.php +++ /dev/null @@ -1,26 +0,0 @@ -withErrors(__('legacy.error.permissions')); -} - -$input = Validator::validate(Arr::wrap(request()->post()), [ - 'recipient' => 'required|string|exists:UserAccounts,User', - 'subject' => 'required|string|max:255', - 'message' => 'required|string|max:60000', -]); - -$recipient = $input['recipient']; - -if (isUserBlocking($recipient, $username)) { - return redirect(url('inbox.php?s=1'))->with('success', __('legacy.success.message_send')); -} - -if (CreateNewMessage($username, $recipient, $input['subject'], $input['message'])) { - return redirect(url('inbox.php?s=1'))->with('success', __('legacy.success.message_send')); -} - -return back()->withErrors(__('legacy.error.error')); diff --git a/public/ticketmanager.php b/public/ticketmanager.php index 43b8fa59d5..21bb4325de 100644 --- a/public/ticketmanager.php +++ b/public/ticketmanager.php @@ -725,10 +725,10 @@ echo "Reporter:"; echo ""; echo "
"; - $msgPayload = "Hi [user=$reportedBy], I'm contacting you about ticket retroachievements.org/ticketmanager.php?i=$ticketID "; + $msgPayload = "Hi [user=$reportedBy], I'm contacting you about [ticket=$ticketID]"; $msgPayload = rawurlencode($msgPayload); $msgTitle = rawurlencode("Bug Report ($gameTitle)"); - echo "Contact the reporter - $reportedBy"; + echo "Contact the reporter - $reportedBy"; echo "
"; echo ""; echo ""; diff --git a/public/userInfo.php b/public/userInfo.php index e3c12cdab6..7d117189fb 100644 --- a/public/userInfo.php +++ b/public/userInfo.php @@ -248,7 +248,7 @@ function resize() { echo ""; echo ""; } - echo "Message"; + echo "Message"; echo "
"; if ($areTheyFollowingMe) { diff --git a/resources/views/community/components/message/icon.blade.php b/resources/views/community/components/message/icon.blade.php index df81809308..ff8fff9289 100644 --- a/resources/views/community/components/message/icon.blade.php +++ b/resources/views/community/components/message/icon.blade.php @@ -1,6 +1,5 @@
- {{----}} - + @if($count ?? 0)
diff --git a/resources/views/community/components/user/breadcrumbs.blade.php b/resources/views/community/components/user/breadcrumbs.blade.php index fe2429f147..29167cf648 100644 --- a/resources/views/community/components/user/breadcrumbs.blade.php +++ b/resources/views/community/components/user/breadcrumbs.blade.php @@ -1,5 +1,7 @@ @props([ 'targetUsername' => '', + 'parentPage' => '', + 'parentPageUrl' => '', 'currentPage' => '', ]) @@ -11,6 +13,10 @@ @else {{ $targetUsername }} » + @if (!empty($parentPage)) + {{ $parentPage }} + » + @endif {{ $currentPage }} @endif
diff --git a/resources/views/community/contact.blade.php b/resources/views/community/contact.blade.php index a4b137d984..e51baf3774 100644 --- a/resources/views/community/contact.blade.php +++ b/resources/views/community/contact.blade.php @@ -5,7 +5,7 @@

Admins and Moderators

- Send a message to RAdmin for: + Send a message to RAdmin for:

    @@ -20,7 +20,7 @@

    Developer Compliance

    - Send a message to DevCompliance for: + Send a message to DevCompliance for:

      @@ -34,7 +34,7 @@

      Quality Assurance

      - Send a message to QATeam for: + Send a message to QATeam for:

        @@ -51,7 +51,7 @@

        DevQuest

        - Send a message to DevQuest for + Send a message to DevQuest for submissions, questions, ideas, or reporting issues related to DevQuest.

        @@ -63,7 +63,7 @@

        Cheating Reports

        - Send a message to RACheats + Send a message to RACheats if you believe someone is in violation of our Global Leaderboard and Achievement Hunting Rules.

        @@ -81,7 +81,7 @@

        RANews

        - Send a message to RANews for: + Send a message to RANews for:

          @@ -96,13 +96,13 @@

          RAEvents

          - Send a message to RAEvents for + Send a message to RAEvents for submissions, questions, ideas, or reporting issues related to community events.

          - Send a message to TheUnwanted for + Send a message to TheUnwanted for submissions, questions, ideas, or reporting issues specifically related to The Unwanted.

          diff --git a/resources/views/community/message-thread/index.blade.php b/resources/views/community/message-thread/index.blade.php new file mode 100644 index 0000000000..2247f240b7 --- /dev/null +++ b/resources/views/community/message-thread/index.blade.php @@ -0,0 +1,109 @@ +@props([ + 'messages' => [], + 'currentPage' => 1, + 'totalPages' => 1, + 'unreadCount' => 0, + 'totalMessages' => 0, +]) + +user(); +$isShowAbsoluteDatesPreferenceSet = BitSet($user->websitePrefs, UserPreference::Forum_ShowAbsoluteDates); +$monthAgo = Carbon::now()->subMonth(1); + +?> + + + + +

          Messages

          + +
          + You have {{ $unreadCount }} unread @choice('message|messages', $unreadCount) + in {{ $totalMessages }} @choice('message thread|message threads', $totalMessages). +
          + +
          +
          + +
          +
          + +
          +
          + +
          + + + + + + + + @foreach ($messages as $message) + last_message_at); + $humanDate = $mostRecentUpdate->format('F j Y, g:ia'); + + $num_unread = $message->num_unread; + ?> + + + + + + + + + + @endforeach +
          WithTitleMessagesLast Message
          0) class="font-bold" @endif> + @if (empty($message->other_participants)) + {!! userAvatar($user, iconSize: 24) !!} + @else + @foreach ($message->other_participants as $participant) + {!! userAvatar($participant, iconSize: 24) !!} + @endforeach + @endif + 0) class="font-bold" @endif> + + {{ $message->title }} + + + @if ($num_unread == 0) + {{ $message->num_messages }} + @elseif ($num_unread == $message->num_messages) + {{ $num_unread }} (unread) + @else + {{ $message->num_messages }} ({{ $num_unread }} unread) + @endif + + @if ($isShowAbsoluteDatesPreferenceSet || $mostRecentUpdate < $monthAgo) + {{ $humanDate }} + @else + {{ $mostRecentUpdate->diffForHumans() }} + @endif +
          + +
          + +
          + +           diff --git a/resources/views/community/message-thread/show.blade.php b/resources/views/community/message-thread/show.blade.php new file mode 100644 index 0000000000..331026266f --- /dev/null +++ b/resources/views/community/message-thread/show.blade.php @@ -0,0 +1,111 @@ +@props([ + 'thread' => null, + 'messages' => [], + 'participants' => [], + 'currentPage' => 1, + 'totalPages' => 1, + 'canReply' => true, +]) + +user(); +$isShowAbsoluteDatesPreferenceSet = BitSet(request()->user()->websitePrefs, UserPreference::Forum_ShowAbsoluteDates); +$monthAgo = Carbon::now()->subMonth(1); + +$participantModels = []; +if (empty($participants)) { + foreach ($messages as $message) { + if (!array_key_exists($message->author_id, $participants)) { + $participantModel = User::withTrashed()->firstWhere('id', $message->author_id); + if ($participantModel) { + $participantModels[$message->author_id] = $participantModel; + $participants[$participantModel->ID] = $participantModel->User; + } + } + } +} else { + foreach ($participants as $id => $participant) { + $participantModel = User::withTrashed()->firstWhere('id', $id); + if ($participantModel) { + $participantModels[$id] = $participantModel; + } + } +} +$pageDescription = "Conversation between " . implode(' and ', $participants); + +?> + + + + +
          +

          {!! $thread->title !!}

          +
          + +
          +
          +
          + {{ method_field('DELETE') }} + {{ csrf_field() }} + +
          +
          +
          + +
          +
          + +
          + @foreach ($messages as $message) +
          +
          +
          + {!! userAvatar($participants[$message->author_id], iconSize: 24) !!} + created_at->format('F j Y, g:ia'); ?> + @if ($isShowAbsoluteDatesPreferenceSet || $message->created_at < $monthAgo) + {{ $humanDate }} + @else + {{ $message->created_at->diffForHumans() }} + @endif +
          +
          +
          + +

          {!! Shortcode::render($message->body) !!}

          +
          + @endforeach +
          + +
          + @if (!$canReply) + Cannot reply to deleted user. + @else +
          + {{ csrf_field() }} + + + + + @endif +
          + +
          + +
          + +           diff --git a/resources/views/community/message/create.blade.php b/resources/views/community/message/create.blade.php new file mode 100644 index 0000000000..63ce9bf17a --- /dev/null +++ b/resources/views/community/message/create.blade.php @@ -0,0 +1,50 @@ +@props([ + 'toUser' => '', + 'subject' => '', + 'message' => '', +]) + + + + +
          +

          New Message

          +
          + +
          + {{ csrf_field() }} +
          + + + + + + + + + + + + + + +
          +
          +
          +
          +
          +
          + {{ $message }} +
          +
          + +           diff --git a/resources/views/components/input/shortcode.blade.php b/resources/views/components/input/shortcode-buttons.blade.php similarity index 100% rename from resources/views/components/input/shortcode.blade.php rename to resources/views/components/input/shortcode-buttons.blade.php diff --git a/resources/views/components/input/shortcode-textarea.blade.php b/resources/views/components/input/shortcode-textarea.blade.php new file mode 100644 index 0000000000..68a5ac89c2 --- /dev/null +++ b/resources/views/components/input/shortcode-textarea.blade.php @@ -0,0 +1,52 @@ +@props([ + 'name' => 'body', + 'enabled' => true, + 'placeholder' => '', + 'maxLength' => 60000, +]) + + + +
          +
          + {!! RenderShortcodeButtons(); !!} +
          + + + + + +
          + 0 / 60000 + +
          + Loading... + + +
          +
          + +
          +
          diff --git a/resources/views/components/input/user-select-image.blade.php b/resources/views/components/input/user-select-image.blade.php new file mode 100644 index 0000000000..05dda24ac4 --- /dev/null +++ b/resources/views/components/input/user-select-image.blade.php @@ -0,0 +1,15 @@ +@props([ + 'for' => '', + 'user' => '', + 'size' => 64, +]) + + + + diff --git a/resources/views/components/input/user-select.blade.php b/resources/views/components/input/user-select.blade.php new file mode 100644 index 0000000000..5788573863 --- /dev/null +++ b/resources/views/components/input/user-select.blade.php @@ -0,0 +1,20 @@ +@props([ + 'name' => '', + 'user' => '', +]) + + + + diff --git a/resources/views/components/menu/account.blade.php b/resources/views/components/menu/account.blade.php index e506dc7af7..9f1aa49813 100644 --- a/resources/views/components/menu/account.blade.php +++ b/resources/views/components/menu/account.blade.php @@ -82,8 +82,7 @@ History {{--{{ __res('follower') }}--}} Following - {{--{{ __('Inbox') }}--}} - Messages + {{ __res('message') }}
          Reorder Site Awards {{--{{ __res('setting') }}--}} diff --git a/resources/views/platform/components/completion-progress-page/paginator.blade.php b/resources/views/components/paginator.blade.php similarity index 97% rename from resources/views/platform/components/completion-progress-page/paginator.blade.php rename to resources/views/components/paginator.blade.php index b5c5915980..3345cc26eb 100644 --- a/resources/views/platform/components/completion-progress-page/paginator.blade.php +++ b/resources/views/components/paginator.blade.php @@ -4,6 +4,10 @@ ]) url(); $queryParams = request()->query(); diff --git a/resources/views/platform/completion-progress-page.blade.php b/resources/views/platform/completion-progress-page.blade.php index aa0b70e82f..6cc1a9f0f4 100644 --- a/resources/views/platform/completion-progress-page.blade.php +++ b/resources/views/platform/completion-progress-page.blade.php @@ -82,7 +82,7 @@ @if ($totalPages > 0)
          - +
          @endif
          diff --git a/tests/Feature/Community/MessagesTest.php b/tests/Feature/Community/MessagesTest.php new file mode 100644 index 0000000000..7ea727be65 --- /dev/null +++ b/tests/Feature/Community/MessagesTest.php @@ -0,0 +1,619 @@ +floorSecond(); + Carbon::setTestNow($now); + + /** @var User $user1 */ + $user1 = User::factory()->create(); + /** @var User $user2 */ + $user2 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + + // user1 sends message to user2 + $this->captureEmails(); + $thread = (new CreateMessageThreadAction())->execute($user1, $user2, 'This is a message', 'This is the message body.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 1, + 'last_message_id' => 1, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 1, + 'thread_id' => 1, + 'author_id' => $user1->ID, + 'body' => 'This is the message body.', + 'created_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(0, $user1->UnreadMessageCount); + $user2->refresh(); + $this->assertEquals(1, $user2->UnreadMessageCount); + + $this->assertEmailSent($user2, "New Private Message from {$user1->User}"); + + // user2 responds + (new ReadMessageThreadAction())->execute($thread, $user2); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $user2->refresh(); + $this->assertEquals(0, $user2->UnreadMessageCount); + + $now2 = $now->clone()->addMinutes(5); + Carbon::setTestNow($now2); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user2, 'This is a response.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 2, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 2, + 'thread_id' => 1, + 'author_id' => $user2->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(1, $user1->UnreadMessageCount); + + $this->assertEmailNotSent($user1); + + // user2 responds again + $now3 = $now2->clone()->addMinutes(5); + Carbon::setTestNow($now3); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user2, 'This is another response.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 3, + 'last_message_id' => 3, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 3, + 'thread_id' => 1, + 'author_id' => $user2->ID, + 'body' => 'This is another response.', + 'created_at' => $now3, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 2, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(2, $user1->UnreadMessageCount); + + $this->assertEmailNotSent($user1); + + // user1 responds + (new ReadMessageThreadAction())->execute($thread, $user1); + $user1->refresh(); + $this->assertEquals(0, $user1->UnreadMessageCount); + + $now4 = $now3->clone()->addMinutes(5); + Carbon::setTestNow($now4); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user1, 'This is a third response.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 4, + 'last_message_id' => 4, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 4, + 'thread_id' => 1, + 'author_id' => $user1->ID, + 'body' => 'This is a third response.', + 'created_at' => $now4->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + + $user2->refresh(); + $this->assertEquals(1, $user2->UnreadMessageCount); + + $this->assertEmailSent($user2, "New Private Message from {$user1->User}"); + + // user1 deletes + $now5 = $now4->clone()->addMinutes(5); + Carbon::setTestNow($now5); + + $this->captureEmails(); + (new DeleteMessageThreadAction())->execute($thread, $user1); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 4, + 'last_message_id' => 4, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => $now5->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + + $user2->refresh(); + $this->assertEquals(1, $user2->UnreadMessageCount); + + $this->assertEmailNotSent($user1); + $this->assertEmailNotSent($user2); + + // user2 deletes - when both users delete the message, it's removed from the DB + $now6 = $now5->clone()->addMinutes(5); + Carbon::setTestNow($now6); + + $this->captureEmails(); + (new DeleteMessageThreadAction())->execute($thread, $user2); + $this->assertDatabaseMissing('message_threads', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 2]); + $this->assertDatabaseMissing('messages', ['id' => 3]); + $this->assertDatabaseMissing('messages', ['id' => 4]); + $this->assertDatabaseMissing('message_thread_participants', ['id' => 1]); + $this->assertDatabaseMissing('message_thread_participants', ['id' => 2]); + + $user2->refresh(); + $this->assertEquals(0, $user2->UnreadMessageCount); + + $this->assertEmailNotSent($user1); + $this->assertEmailNotSent($user2); + } + + public function testBlockedUser(): void + { + $now = Carbon::now()->floorSecond(); + Carbon::setTestNow($now); + + /** @var User $user1 */ + $user1 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + /** @var User $user2 */ + $user2 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + + // user1 has user2 blocked + $relation = new UserRelation([ + 'User' => $user1->User, + 'Friend' => $user2->User, + 'Friendship' => UserRelationship::Blocked, + ]); + $relation->save(); + + // message from user2 is automatically marked as deleted by user1 + $this->captureEmails(); + $thread = (new CreateMessageThreadAction())->execute($user2, $user1, 'This is a message', 'This is the message body.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 1, + 'last_message_id' => 1, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 1, + 'thread_id' => $thread->id, + 'author_id' => $user2->ID, + 'body' => 'This is the message body.', + 'created_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(0, $user1->UnreadMessageCount); + $this->assertEmailNotSent($user1); + + // additional message from user2 is also marked as deleted by user1 + $now2 = $now->clone()->addMinutes(5); + Carbon::setTestNow($now2); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user2, 'This is a response.'); + + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 2, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 2, + 'thread_id' => $thread->id, + 'author_id' => $user2->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => $now->toDateTimeString(), /* deleted timestamp not updated */ + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(0, $user1->UnreadMessageCount); + $this->assertEmailNotSent($user1); + + // message from user1 is delivered to user2 + Carbon::setTestNow($now); + + $this->captureEmails(); + $thread = (new CreateMessageThreadAction())->execute($user1, $user2, 'This is a message', 'This is the message body.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 2, + 'title' => 'This is a message', + 'num_messages' => 1, + 'last_message_id' => 3, + ]); + $message = Message::firstWhere('id', 1); + $this->assertDatabaseHas('messages', [ + 'id' => 3, + 'thread_id' => $thread->id, + 'author_id' => $user1->ID, + 'body' => 'This is the message body.', + 'created_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user2->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + + $user2->refresh(); + $this->assertEquals(1, $user2->UnreadMessageCount); + $this->assertEmailSent($user2, "New Private Message from {$user1->User}"); + + // additional message from user1 is also delivered + Carbon::setTestNow($now2); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user1, 'This is a response.'); + + $this->assertDatabaseHas('message_threads', [ + 'id' => 2, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 4, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 4, + 'thread_id' => $thread->id, + 'author_id' => $user1->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user2->ID, + 'num_unread' => 2, + 'deleted_at' => null, + ]); + + $user2->refresh(); + $this->assertEquals(2, $user2->UnreadMessageCount); + $this->assertEmailSent($user2, "New Private Message from {$user1->User}"); + + // response from user2 is ignored (no unread counter or email, but not deleted) + $now3 = $now2->clone()->addMinutes(5); + Carbon::setTestNow($now3); + + $this->captureEmails(); + (new AddToMessageThreadAction())->execute($thread, $user2, 'This is another response.'); + + $this->assertDatabaseHas('message_threads', [ + 'id' => 2, + 'title' => 'This is a message', + 'num_messages' => 3, + 'last_message_id' => 5, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 5, + 'thread_id' => $thread->id, + 'author_id' => $user2->ID, + 'body' => 'This is another response.', + 'created_at' => $now3->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => $thread->id, + 'user_id' => $user2->ID, + 'num_unread' => 2, + 'deleted_at' => null, + ]); + + $user1->refresh(); + $this->assertEquals(0, $user1->UnreadMessageCount); + $this->assertEmailNotSent($user1); + } + + public function testDeleteUserDeletesThread(): void + { + $now = Carbon::now()->floorSecond(); + Carbon::setTestNow($now); + + /** @var User $user1 */ + $user1 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + /** @var User $user2 */ + $user2 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + + // user1 sends message to user2 + $thread = (new CreateMessageThreadAction())->execute($user1, $user2, 'This is a message', 'This is the message body.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 1, + 'last_message_id' => 1, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 1, + 'thread_id' => 1, + 'author_id' => $user1->ID, + 'body' => 'This is the message body.', + 'created_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + + // user2 responds + (new ReadMessageThreadAction())->execute($thread, $user2); + $now2 = $now->clone()->addMinutes(5); + Carbon::setTestNow($now2); + + (new AddToMessageThreadAction())->execute($thread, $user2, 'This is a response.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 2, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 2, + 'thread_id' => 1, + 'author_id' => $user2->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + // user2 is deleted + $now3 = $now2->clone()->addMinutes(5); + Carbon::setTestNow($now3); + (new ClearAccountDataAction())->execute($user2); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 2, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 2, + 'thread_id' => 1, + 'author_id' => $user2->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 1, + 'deleted_at' => null, + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user2->ID, + 'num_unread' => 0, + 'deleted_at' => $now3, + ]); + + // user1 is deleted + (new ClearAccountDataAction())->execute($user1); + $this->assertDatabaseMissing('message_threads', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 2]); + $this->assertDatabaseMissing('message_thread_participants', ['id' => 1]); + $this->assertDatabaseMissing('message_thread_participants', ['id' => 2]); + } + + public function testMessageToSelf(): void + { + $now = Carbon::now()->floorSecond(); + Carbon::setTestNow($now); + + /** @var User $user1 */ + $user1 = User::factory()->create(['websitePrefs' => (1 << UserPreference::EmailOn_PrivateMessage)]); + + // user1 sends message to user1 + $thread = (new CreateMessageThreadAction())->execute($user1, $user1, 'This is a message', 'This is the message body.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 1, + 'last_message_id' => 1, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 1, + 'thread_id' => 1, + 'author_id' => $user1->ID, + 'body' => 'This is the message body.', + 'created_at' => $now->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + // user1 responds + $now2 = $now->clone()->addMinutes(5); + Carbon::setTestNow($now2); + + (new AddToMessageThreadAction())->execute($thread, $user1, 'This is a response.'); + $this->assertDatabaseHas('message_threads', [ + 'id' => 1, + 'title' => 'This is a message', + 'num_messages' => 2, + 'last_message_id' => 2, + ]); + $this->assertDatabaseHas('messages', [ + 'id' => 2, + 'thread_id' => 1, + 'author_id' => $user1->ID, + 'body' => 'This is a response.', + 'created_at' => $now2->toDateTimeString(), + ]); + $this->assertDatabaseHas('message_thread_participants', [ + 'thread_id' => 1, + 'user_id' => $user1->ID, + 'num_unread' => 0, + 'deleted_at' => null, + ]); + + // user1 deletes message + (new DeleteMessageThreadAction())->execute($thread, $user1); + $this->assertDatabaseMissing('message_threads', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 1]); + $this->assertDatabaseMissing('messages', ['id' => 2]); + $this->assertDatabaseMissing('message_thread_participants', ['id' => 1]); + } +} diff --git a/tests/Feature/Site/Concerns/TestsMail.php b/tests/Feature/Site/Concerns/TestsMail.php new file mode 100644 index 0000000000..628241caff --- /dev/null +++ b/tests/Feature/Site/Concerns/TestsMail.php @@ -0,0 +1,90 @@ +put('test:emails', []); + } + + protected function assertEmailSent(User $user, string $subject, ?string $body = null): void + { + $emails = Cache::store('array')->get('test:emails') ?? []; + $matchUser = null; + $matchSubject = null; + $matchBoth = null; + foreach ($emails as $email) { + if ($email['to'] === $user->EmailAddress && $email['subject'] === $subject) { + if ($body === null || $body === $email['message']) { + return; + } + + $matchBoth = $email; + } elseif ($email['to'] === $user->EmailAddress) { + $matchUser = $email; + } elseif ($email['subject'] === $subject) { + $matchSubject = $email; + } + } + + $expected = [ + 'to' => $user->EmailAddress, + 'subject' => $subject, + 'message' => $body, + ]; + + if ($matchBoth) { + $this->assertEquals($expected, $matchBoth); + } elseif ($matchUser) { + $this->assertEquals($expected, $matchUser); + } elseif ($matchSubject) { + $this->assertEquals($expected, $matchSubject); + } else { + $this->fail("Expected email sent to {$user->EmailAddress}. No emails captured."); + } + } + + protected function assertEmailNotSent(User $user, ?string $subject = null, ?string $body = null): void + { + $emails = Cache::store('array')->get('test:emails') ?? []; + $matchUser = null; + $matchUserAndSubject = null; + $matchAll = null; + foreach ($emails as $email) { + if ($email['to'] === $user->EmailAddress) { + if ($subject !== null && $subject === $email['subject']) { + if ($body !== null && $body === $email['message']) { + $matchAll = $email; + } else { + $matchUserAndSubject = $email; + } + } else { + $matchUser = $email; + } + } + } + + $expected = [ + 'to' => $user->EmailAddress, + 'subject' => $subject, + 'message' => $body, + ]; + + if ($matchAll) { + $this->fail("Found email sent to {$user->EmailAddress} with specified subject and body"); + } elseif ($matchUserAndSubject) { + $this->fail("Found email sent to {$user->EmailAddress} with specified subject"); + } elseif ($matchUser) { + $this->fail("Found email sent to {$user->EmailAddress}"); + } + } +}