Token -> RouteToken

Author: riasvdv

CHANGELOG-WIP.md

@@ -356,8 +356,8 @@ Moved the following controllers:
 
 ## Tokens
 
-- Deprecated `craft\services\Tokens`. `CraftCms\Cms\Token\Tokens` should be used instead.
-- Deprecated `craft\records\Token`. `CraftCms\Cms\Token\Models\Token` should be used instead.
+- Deprecated `craft\services\Tokens`. `CraftCms\Cms\RouteToken\RouteTokens` should be used instead.
+- Deprecated `craft\records\Token`. `CraftCms\Cms\RouteToken\Models\RouteToken` should be used instead.
 
 ## Translations
 

src/Database/Migrations/0000_00_00_000005_rename_tokens_to_route_tokens.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+use CraftCms\Cms\Database\Migration;
+use Illuminate\Support\Facades\Schema;
+
+return new class extends Migration
+{
+    public function up(): void
+    {
+        Schema::rename('tokens', 'routetokens');
+    }
+
+    public function down(): void
+    {
+        Schema::rename('routetokens', 'tokens');
+    }
+};

src/Database/Migrations/Install.php

@@ -581,6 +581,18 @@ public function createTables(): void
             $table->char('uid', 36)->default('0');
         });
 
+        Schema::create('routetokens', function (Blueprint $table) {
+            $table->integer('id', true);
+            $table->char('token', 32);
+            $table->text('route')->nullable();
+            $table->unsignedTinyInteger('usageLimit')->nullable();
+            $table->unsignedTinyInteger('usageCount')->nullable();
+            $table->dateTime('expiryDate');
+            $table->dateTime('dateCreated');
+            $table->dateTime('dateUpdated');
+            $table->char('uid', 36)->default('0');
+        });
+
         Schema::create(Table::SEARCHINDEXQUEUE, function (Blueprint $table) {
             $table->integer('id', true);
             $table->integer('elementId');
@@ -739,18 +751,6 @@ public function createTables(): void
             $table->dateTime('dateUpdated');
         });
 
-        Schema::create('tokens', function (Blueprint $table) {
-            $table->integer('id', true);
-            $table->char('token', 32);
-            $table->text('route')->nullable();
-            $table->unsignedTinyInteger('usageLimit')->nullable();
-            $table->unsignedTinyInteger('usageCount')->nullable();
-            $table->dateTime('expiryDate');
-            $table->dateTime('dateCreated');
-            $table->dateTime('dateUpdated');
-            $table->char('uid', 36)->default('0');
-        });
-
         Schema::create(Table::USERGROUPS, function (Blueprint $table) {
             $table->integer('id', true);
             $table->string('name');
@@ -996,8 +996,8 @@ public function createIndexes(): void
         Schema::createIndex(Table::TAGGROUPS, ['handle']);
         Schema::createIndex(Table::TAGGROUPS, ['dateDeleted']);
         Schema::createIndex(Table::TAGS, ['groupId']);
-        Schema::createIndex(Table::TOKENS, ['token'], unique: true);
-        Schema::createIndex(Table::TOKENS, ['expiryDate']);
+        Schema::createIndex(Table::ROUTETOKENS, ['token'], unique: true);
+        Schema::createIndex(Table::ROUTETOKENS, ['expiryDate']);
         Schema::createIndex(Table::USERGROUPS, ['handle']);
         Schema::createIndex(Table::USERGROUPS, ['name']);
         Schema::createIndex(Table::USERGROUPS_USERS, ['groupId', 'userId'], unique: true);

src/Database/Table.php

@@ -93,6 +93,8 @@
 
     public const string REVISIONS = 'revisions';
 
+    public const string ROUTETOKENS = 'routetokens';
+
     public const string SEARCHINDEX = 'searchindex';
 
     public const string SEARCHINDEXQUEUE = 'searchindexqueue';
@@ -127,8 +129,6 @@
 
     public const string TAGS = 'tags';
 
-    public const string TOKENS = 'tokens';
-
     public const string USERGROUPS = 'usergroups';
 
     public const string USERGROUPS_USERS = 'usergroups_users';

src/Http/Controllers/PreviewController.php

@@ -7,8 +7,8 @@
 use craft\helpers\ElementHelper;
 use CraftCms\Cms\Http\EnforcesPermissions;
 use CraftCms\Cms\Http\Middleware\HandleTokenRequest;
-use CraftCms\Cms\Token\Data\Token;
-use CraftCms\Cms\Token\Tokens;
+use CraftCms\Cms\RouteToken\Data\RouteToken;
+use CraftCms\Cms\RouteToken\RouteTokens;
 use Illuminate\Contracts\Http\Kernel;
 use Illuminate\Http\JsonResponse;
 use Illuminate\Http\RedirectResponse;
@@ -22,7 +22,7 @@
 {
     use EnforcesPermissions;
 
-    public function createToken(Request $request, Tokens $tokens, Token $tokenData): JsonResponse|RedirectResponse
+    public function createToken(Request $request, RouteTokens $tokens, RouteToken $tokenData): JsonResponse|RedirectResponse
     {
         match (true) {
             isset($tokenData->draftId) => $this->requirePermission("previewDraft:{$tokenData->draftId}"),
@@ -50,7 +50,7 @@ public function createToken(Request $request, Tokens $tokens, Token $tokenData):
         return new JsonResponse(compact('token'));
     }
 
-    public function preview(Request $request, Kernel $kernel, Token $tokenData): mixed
+    public function preview(Request $request, Kernel $kernel, RouteToken $tokenData): mixed
     {
         $query = $tokenData->elementType::find()
             ->siteId($tokenData->siteId)

src/Http/Middleware/HandleTokenRequest.php

@@ -6,7 +6,7 @@
 
 use Closure;
 use CraftCms\Cms\Config\GeneralConfig;
-use CraftCms\Cms\Token\Tokens;
+use CraftCms\Cms\RouteToken\RouteTokens;
 use Illuminate\Foundation\Http\Middleware\VerifyCsrfToken;
 use Illuminate\Http\Request;
 use Illuminate\Support\Facades\Context;
@@ -21,7 +21,7 @@
 
     public function __construct(
         private GeneralConfig $generalConfig,
-        private Tokens $tokens,
+        private RouteTokens $tokens,
     ) {}
 
     public function handle(Request $request, Closure $next): mixed

src/Token/Data/Token.php src/RouteToken/Data/RouteToken.phpsrc/Token/Data/Token.php renamed to src/RouteToken/Data/RouteToken.php

@@ -2,12 +2,12 @@
 
 declare(strict_types=1);
 
-namespace CraftCms\Cms\Token\Data;
+namespace CraftCms\Cms\RouteToken\Data;
 
 use Spatie\LaravelData\Attributes\Validation\RequiredWithout;
 use Spatie\LaravelData\Dto;
 
-final class Token extends Dto
+final class RouteToken extends Dto
 {
     public function __construct(
         /** @var class-string<\craft\base\ElementInterface> */

src/Token/Model/Token.php src/RouteToken/Model/RouteToken.phpsrc/Token/Model/Token.php renamed to src/RouteToken/Model/RouteToken.php

@@ -2,17 +2,17 @@
 
 declare(strict_types=1);
 
-namespace CraftCms\Cms\Token\Model;
+namespace CraftCms\Cms\RouteToken\Model;
 
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Shared\BaseModel;
 use CraftCms\Cms\Shared\Concerns\HasUid;
 
-final class Token extends BaseModel
+final class RouteToken extends BaseModel
 {
     use HasUid;
 
-    protected $table = Table::TOKENS;
+    protected $table = Table::ROUTETOKENS;
 
     protected $casts = [
         'usageLimit' => 'int',

src/Token/Tokens.php src/RouteToken/RouteTokens.phpsrc/Token/Tokens.php renamed to src/RouteToken/RouteTokens.php

@@ -2,13 +2,13 @@
 
 declare(strict_types=1);
 
-namespace CraftCms\Cms\Token;
+namespace CraftCms\Cms\RouteToken;
 
 use CraftCms\Cms\Cms;
 use CraftCms\Cms\Database\Table;
 use CraftCms\Cms\Http\Middleware\HandleTokenRequest;
+use CraftCms\Cms\RouteToken\Model\RouteToken;
 use CraftCms\Cms\Support\Json;
-use CraftCms\Cms\Token\Model\Token;
 use DateTime;
 use Illuminate\Container\Attributes\Singleton;
 use Illuminate\Support\Facades\Context;
@@ -17,7 +17,7 @@
 use yii\base\InvalidArgumentException;
 
 #[Singleton]
-final class Tokens
+final class RouteTokens
 {
     private bool $deletedExpiredTokens = false;
 
@@ -56,7 +56,7 @@ public function createToken(array|string $route, ?int $usageLimit = null, ?DateT
             throw new InvalidArgumentException("Invalid token: $token");
         }
 
-        $tokenModel = new Token;
+        $tokenModel = new RouteToken;
         $tokenModel->token = $token ?? \Craft::$app->getSecurity()->generateRandomString();
         $tokenModel->route = $route;
         $tokenModel->expiryDate = Date::parse($expiryDate ?? now()->addSeconds(Cms::config()->defaultTokenDuration));
@@ -95,7 +95,7 @@ public function getTokenRoute(string $token): array|false
         // Take the opportunity to delete any expired tokens
         $this->deleteExpiredTokens();
 
-        $result = Token::where('token', $token)->first();
+        $result = RouteToken::where('token', $token)->first();
 
         if (! $result) {
             // Remove it from the request  so it doesn’t get added to generated URLs
@@ -123,14 +123,14 @@ public function getTokenRoute(string $token): array|false
 
     public function incrementTokenUsageCountById(int $tokenId): bool
     {
-        return (bool) DB::table(Table::TOKENS)
+        return (bool) DB::table(Table::ROUTETOKENS)
             ->where('id', $tokenId)
             ->increment('usageCount');
     }
 
     public function deleteTokenById(int $tokenId): bool
     {
-        DB::table(Table::TOKENS)->delete($tokenId);
+        DB::table(Table::ROUTETOKENS)->delete($tokenId);
 
         return true;
     }
@@ -142,7 +142,7 @@ public function deleteExpiredTokens(): bool
             return false;
         }
 
-        $affectedRows = DB::table(Table::TOKENS)
+        $affectedRows = DB::table(Table::ROUTETOKENS)
             ->where('expiryDate', '<=', now())
             ->delete();
 

src/User/Actions/GetImpersonationUrlAction.php

@@ -5,7 +5,7 @@
 namespace CraftCms\Cms\User\Actions;
 
 use craft\helpers\UrlHelper;
-use CraftCms\Cms\Token\Tokens;
+use CraftCms\Cms\RouteToken\RouteTokens;
 use CraftCms\Cms\User\Models\User;
 use Illuminate\Support\Facades\Auth;
 
@@ -14,7 +14,7 @@
 final readonly class GetImpersonationUrlAction
 {
     public function __construct(
-        private Tokens $tokens,
+        private RouteTokens $tokens,
     ) {}
 
     public function __invoke(User $user): string|false