feat: customize name of Shield Tables w/o constant

docs/customization.md

@@ -1,18 +1,40 @@
 # Customizing Shield
 
--   [Customizing Shield](#customizing-shield)
-    -   [Route Configuration](#route-configuration)
-    -   [Custom Redirect URLs](#custom-redirect-urls)
-        -   [Customize Login Redirect](#customize-login-redirect)
-        -   [Customize Register Redirect](#customize-register-redirect)
-        -   [Customize Logout Redirect](#customize-logout-redirect)
-    -   [Extending the Controllers](#extending-the-controllers)
-    -   [Integrating Custom View Libraries](#integrating-custom-view-libraries)
-    -   [Custom Validation Rules](#custom-validation-rules)
-        -   [Registration](#registration)
-        -   [Login](#login)
-    -   [Custom User Provider](#custom-user-provider)
-    -   [Custom Login Identifier](#custom-login-identifier)
+- [Customizing Shield](#customizing-shield)
+  - [Custom Table Names](#custom-table-names)
+  - [Route Configuration](#route-configuration)
+  - [Custom Redirect URLs](#custom-redirect-urls)
+    - [Customize Login Redirect](#customize-login-redirect)
+    - [Customize Register Redirect](#customize-register-redirect)
+    - [Customize Logout Redirect](#customize-logout-redirect)
+  - [Extending the Controllers](#extending-the-controllers)
+  - [Integrating Custom View Libraries](#integrating-custom-view-libraries)
+  - [Custom Validation Rules](#custom-validation-rules)
+    - [Registration](#registration)
+    - [Login](#login)
+  - [Custom User Provider](#custom-user-provider)
+  - [Custom Login Identifier](#custom-login-identifier)
+
+## Custom Table Names
+
+If you want to change the default table names, you can change the table names
+in **app/Config/Auth.php**.
+
+```php
+public array $tables = [
+    'users'             => 'users',
+    'identities'        => 'auth_identities',
+    'logins'            => 'auth_logins',
+    'token_logins'      => 'auth_token_logins',
+    'remember_tokens'   => 'auth_remember_tokens',
+    'groups_users'      => 'auth_groups_users',
+    'permissions_users' => 'auth_permissions_users',
+];
+```
+
+Set the table names that you want in the array values.
+
+> **Note** You must change the table names before running database migrations.
 
 ## Route Configuration
 
@@ -149,24 +171,40 @@ Shield has the following rules for registration:
 ```php
 [
     'username' => [
-        'label' =>  'Auth.username',
-        'rules' => 'required|max_length[30]|min_length[3]|regex_match[/\A[a-zA-Z0-9\.]+\z/]|is_unique[users.username]',
+        'label' => 'Auth.username',
+        'rules' => [
+            'required',
+            'max_length[30]',
+            'min_length[3]',
+            'regex_match[/\A[a-zA-Z0-9\.]+\z/]',
+            'is_unique[users.username]',
+        ],
     ],
     'email' => [
-        'label' =>  'Auth.email',
-        'rules' => 'required|max_length[254]|valid_email|is_unique[auth_identities.secret]',
+        'label' => 'Auth.email',
+        'rules' => [
+            'required',
+            'max_length[254]',
+            'valid_email',
+            'is_unique[auth_identities.secret]',
+        ],
     ],
     'password' => [
-        'label' =>  'Auth.password',
+        'label' => 'Auth.password',
         'rules' => 'required|strong_password',
     ],
     'password_confirm' => [
-        'label' =>  'Auth.passwordConfirm',
+        'label' => 'Auth.passwordConfirm',
         'rules' => 'required|matches[password]',
     ],
 ];
 ```
 
+> **Note** If you customize the table names, the table names
+> (`users` and `auth_identities`) in the above rules will be automatically
+> changed. The rules are implemented in
+> `RegisterController::getValidationRules()`.
+
 If you need a different set of rules for registration, you can specify them in your `Validation` configuration (**app/Config/Validation.php**) like:
 
 ```php
@@ -175,24 +213,38 @@ If you need a different set of rules for registration, you can specify them in y
     //--------------------------------------------------------------------
     public $registration = [
         'username' => [
-            'label' =>  'Auth.username',
-            'rules' => 'required|max_length[30]|min_length[3]|regex_match[/\A[a-zA-Z0-9\.]+\z/]|is_unique[users.username]',
+            'label' => 'Auth.username',
+            'rules' => [
+                'required',
+                'max_length[30]',
+                'min_length[3]',
+                'regex_match[/\A[a-zA-Z0-9\.]+\z/]',
+                'is_unique[users.username]',
+            ],
         ],
         'email' => [
-            'label' =>  'Auth.email',
-            'rules' => 'required|max_length[254]|valid_email|is_unique[auth_identities.secret]',
+            'label' => 'Auth.email',
+            'rules' => [
+                'required',
+                'max_length[254]',
+                'valid_email',
+                'is_unique[auth_identities.secret]',
+            ],
         ],
         'password' => [
-            'label' =>  'Auth.password',
+            'label' => 'Auth.password',
             'rules' => 'required|strong_password',
         ],
         'password_confirm' => [
-            'label' =>  'Auth.passwordConfirm',
+            'label' => 'Auth.passwordConfirm',
             'rules' => 'required|matches[password]',
         ],
     ];
 ```
 
+> **Note** If you customize the table names, set the correct table names in the
+> rules.
+
 ### Login
 
 Similar to the process for validation rules in the **Registration** section, you can add rules for the login form to **app/Config/Validation.php** and change the rules.

docs/install.md

@@ -74,6 +74,10 @@ Require it with an explicit version constraint allowing its desired stability.
     php spark shield:setup
     ```
 
+    > **Note** If you want to customize table names, you must change the table names
+    > before running database migrations.
+    > See [Customizing Shield](./customization.md#custom-table-names).
+
 2. Configure **app/Config/Email.php** to allow Shield to send emails with the [Email Class](https://codeigniter.com/user_guide/libraries/email.html).
 
     ```php
@@ -145,6 +149,10 @@ your project.
 
 5. **Migration** Run the migrations.
 
+    > **Note** If you want to customize table names, you must change the table names
+    > before running database migrations.
+    > See [Customizing Shield](./customization.md#custom-table-names).
+
     ```console
     php spark migrate --all
     ```
@@ -278,4 +286,4 @@ public $globals = [
     ]
 ]
 ```
-The same should apply for the Rate Limiting and Forcing Password Reset.
+The same should apply for the Rate Limiting and Forcing Password Reset.

src/Config/Auth.php

@@ -37,6 +37,36 @@ class Auth extends BaseConfig
         'magic-link-email'            => '\CodeIgniter\Shield\Views\Email\magic_link_email',
     ];
 
+    /**
+     * --------------------------------------------------------------------
+     * Customize Name of Shield Tables
+     * --------------------------------------------------------------------
+     * Only change if you want to rename the default Shield table names
+     *
+     * It may be necessary to change the names of the tables for
+     * security reasons, to prevent the conflict of table names,
+     * the internal policy of the companies or any other reason.
+     *
+     * - users                  Auth Users Table, the users info is stored.
+     * - auth_identities        Auth Identities Table, Used for storage of passwords, access tokens, social login identities, etc.
+     * - auth_logins            Auth Login Attempts, Table records login attempts.
+     * - auth_token_logins      Auth Token Login Attempts Table, Records Bearer Token type login attempts.
+     * - auth_remember_tokens   Auth Remember Tokens (remember-me) Table.
+     * - auth_groups_users      Groups Users Table.
+     * - auth_permissions_users Users Permissions Table.
+     *
+     * @var array<string, string>
+     */
+    public array $tables = [
+        'users'             => 'users',
+        'identities'        => 'auth_identities',
+        'logins'            => 'auth_logins',
+        'token_logins'      => 'auth_token_logins',
+        'remember_tokens'   => 'auth_remember_tokens',
+        'groups_users'      => 'auth_groups_users',
+        'permissions_users' => 'auth_permissions_users',
+    ];
+
     /**
      * --------------------------------------------------------------------
      * Redirect URLs

src/Controllers/RegisterController.php

@@ -7,11 +7,15 @@
 use App\Controllers\BaseController;
 use CodeIgniter\Events\Events;
 use CodeIgniter\HTTP\RedirectResponse;
+use CodeIgniter\HTTP\RequestInterface;
+use CodeIgniter\HTTP\ResponseInterface;
 use CodeIgniter\Shield\Authentication\Authenticators\Session;
+use CodeIgniter\Shield\Config\Auth;
 use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Exceptions\ValidationException;
 use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Shield\Traits\Viewable;
+use Psr\Log\LoggerInterface;
 
 /**
  * Class RegisterController
@@ -25,6 +29,27 @@ class RegisterController extends BaseController
 
     protected $helpers = ['setting'];
 
+    /**
+     * Auth Table names
+     */
+    private array $tables;
+
+    public function initController(
+        RequestInterface $request,
+        ResponseInterface $response,
+        LoggerInterface $logger
+    ): void {
+        parent::initController(
+            $request,
+            $response,
+            $logger
+        );
+
+        /** @var Auth $authConfig */
+        $authConfig   = config('Auth');
+        $this->tables = $authConfig->tables;
+    }
+
     /**
      * Displays the registration form.
      *
@@ -153,11 +178,11 @@ protected function getValidationRules(): array
     {
         $registrationUsernameRules = array_merge(
             config('AuthSession')->usernameValidationRules,
-            ['is_unique[users.username]']
+            [sprintf('is_unique[%s.username]', $this->tables['users'])]
         );
         $registrationEmailRules = array_merge(
             config('AuthSession')->emailValidationRules,
-            ['is_unique[auth_identities.secret]']
+            [sprintf('is_unique[%s.secret]', $this->tables['identities'])]
         );
 
         return setting('Validation.registration') ?? [

src/Database/Migrations/2020-12-28-223112_create_auth_tables.php

@@ -4,10 +4,26 @@
 
 namespace CodeIgniter\Shield\Database\Migrations;
 
+use CodeIgniter\Database\Forge;
 use CodeIgniter\Database\Migration;
+use CodeIgniter\Shield\Config\Auth;
 
 class CreateAuthTables extends Migration
 {
+    /**
+     * Auth Table names
+     */
+    private array $tables;
+
+    public function __construct(?Forge $forge = null)
+    {
+        parent::__construct($forge);
+
+        /** @var Auth $authConfig */
+        $authConfig   = config('Auth');
+        $this->tables = $authConfig->tables;
+    }
+
     public function up(): void
     {
         // Users Table
@@ -24,7 +40,7 @@ public function up(): void
         ]);
         $this->forge->addPrimaryKey('id');
         $this->forge->addUniqueKey('username');
-        $this->forge->createTable('users');
+        $this->forge->createTable($this->tables['users']);
 
         /*
          * Auth Identities Table
@@ -47,8 +63,8 @@ public function up(): void
         $this->forge->addPrimaryKey('id');
         $this->forge->addUniqueKey(['type', 'secret']);
         $this->forge->addKey('user_id');
-        $this->forge->addForeignKey('user_id', 'users', 'id', '', 'CASCADE');
-        $this->forge->createTable('auth_identities');
+        $this->forge->addForeignKey('user_id', $this->tables['users'], 'id', '', 'CASCADE');
+        $this->forge->createTable($this->tables['identities']);
 
         /**
          * Auth Login Attempts Table
@@ -69,7 +85,7 @@ public function up(): void
         $this->forge->addKey(['id_type', 'identifier']);
         $this->forge->addKey('user_id');
         // NOTE: Do NOT delete the user_id or identifier when the user is deleted for security audits
-        $this->forge->createTable('auth_logins');
+        $this->forge->createTable($this->tables['logins']);
 
         /*
          * Auth Token Login Attempts Table
@@ -89,7 +105,7 @@ public function up(): void
         $this->forge->addKey(['id_type', 'identifier']);
         $this->forge->addKey('user_id');
         // NOTE: Do NOT delete the user_id or identifier when the user is deleted for security audits
-        $this->forge->createTable('auth_token_logins');
+        $this->forge->createTable($this->tables['token_logins']);
 
         /*
          * Auth Remember Tokens (remember-me) Table
@@ -106,8 +122,8 @@ public function up(): void
         ]);
         $this->forge->addPrimaryKey('id');
         $this->forge->addUniqueKey('selector');
-        $this->forge->addForeignKey('user_id', 'users', 'id', '', 'CASCADE');
-        $this->forge->createTable('auth_remember_tokens');
+        $this->forge->addForeignKey('user_id', $this->tables['users'], 'id', '', 'CASCADE');
+        $this->forge->createTable($this->tables['remember_tokens']);
 
         // Groups Users Table
         $this->forge->addField([
@@ -117,8 +133,8 @@ public function up(): void
             'created_at' => ['type' => 'datetime', 'null' => false],
         ]);
         $this->forge->addPrimaryKey('id');
-        $this->forge->addForeignKey('user_id', 'users', 'id', '', 'CASCADE');
-        $this->forge->createTable('auth_groups_users');
+        $this->forge->addForeignKey('user_id', $this->tables['users'], 'id', '', 'CASCADE');
+        $this->forge->createTable($this->tables['groups_users']);
 
         // Users Permissions Table
         $this->forge->addField([
@@ -128,8 +144,8 @@ public function up(): void
             'created_at' => ['type' => 'datetime', 'null' => false],
         ]);
         $this->forge->addPrimaryKey('id');
-        $this->forge->addForeignKey('user_id', 'users', 'id', '', 'CASCADE');
-        $this->forge->createTable('auth_permissions_users');
+        $this->forge->addForeignKey('user_id', $this->tables['users'], 'id', '', 'CASCADE');
+        $this->forge->createTable($this->tables['permissions_users']);
     }
 
     // --------------------------------------------------------------------
@@ -138,13 +154,13 @@ public function down(): void
     {
         $this->db->disableForeignKeyChecks();
 
-        $this->forge->dropTable('auth_logins', true);
-        $this->forge->dropTable('auth_token_logins', true);
-        $this->forge->dropTable('auth_remember_tokens', true);
-        $this->forge->dropTable('auth_identities', true);
-        $this->forge->dropTable('auth_groups_users', true);
-        $this->forge->dropTable('auth_permissions_users', true);
-        $this->forge->dropTable('users', true);
+        $this->forge->dropTable($this->tables['logins'], true);
+        $this->forge->dropTable($this->tables['token_logins'], true);
+        $this->forge->dropTable($this->tables['remember_tokens'], true);
+        $this->forge->dropTable($this->tables['identities'], true);
+        $this->forge->dropTable($this->tables['groups_users'], true);
+        $this->forge->dropTable($this->tables['permissions_users'], true);
+        $this->forge->dropTable($this->tables['users'], true);
 
         $this->db->enableForeignKeyChecks();
     }