chore: Refactor registration and user creation

Author: marienfressinaud

docs/production.md

@@ -367,7 +367,7 @@ locale of a user created via the CLI or seeds for instance.
 If you need to configure a demo server (this is probably NOT the case), you can
 simply set the `APP_DEMO` variable to `true` in the `.env` file. It will add a
 banner at the top of the screen to warn users that data are reset every night.
-It will also consider the account with the `demo@flus.io` email as the demo
+It will also consider the account with the `demo@flus.fr` email as the demo
 account. The reset is done through a scheduled job managed by Flus.
 
 ## Optional: Enable subscriptions

src/Configuration.php

@@ -40,6 +40,11 @@ class Configuration extends \Minz\Configuration
      */
     public static array $application;
 
+    public static function areRegistrationsOpened(): bool
+    {
+        return self::$application['registrations_opened'];
+    }
+
     public static function areSubscriptionsEnabled(): bool
     {
         return self::$application['subscriptions_enabled'];

src/cli/Users.php

@@ -74,13 +74,20 @@ public function create(Request $request): Response
         $email = $request->parameters->getString('email', '');
         $password = $request->parameters->getString('password', '');
 
-        try {
-            $user = services\UserCreator::create($username, $email, $password);
-        } catch (services\UserCreatorError $e) {
-            $errors = implode(' ', $e->errors());
+        $user = new models\User();
+        $user->setUsername($username);
+        $user->setEmail($email);
+        $user->setPassword($password);
+
+        if (!$user->validate()) {
+            $errors = implode(' ', $user->errors());
             return Response::text(400, "User creation failed: {$errors}");
         }
 
+        $user->save();
+
+        services\UserService::initializeData($user);
+
         // Immediately validate the user since we created it manually
         $user->validated_at = \Minz\Time::now();
         $user->save();

src/controllers/Registrations.php

@@ -3,6 +3,7 @@
 namespace App\controllers;
 
 use App\auth;
+use App\forms;
 use App\mailers;
 use App\models;
 use App\services;
@@ -21,118 +22,73 @@ class Registrations extends BaseController
     /**
      * Show the registration form.
      *
-     * @response 302 / if connected
-     * @response 302 /login if registrations are closed
+     * @response 302 /
+     *     If the user is connected.
+     * @response 302 /login
+     *     If the registrations are closed.
      * @response 200
-     *
-     * @return \Minz\Response
+     *     On sucess.
      */
     public function new(): Response
     {
         if (auth\CurrentUser::get()) {
             return Response::redirect('home');
         }
 
-        $app_conf = \App\Configuration::$application;
-        if (!$app_conf['registrations_opened']) {
+        if (!\App\Configuration::areRegistrationsOpened()) {
             return Response::redirect('login');
         }
 
-        $app_path = \App\Configuration::$app_path;
-        $terms_path = $app_path . '/policies/terms.html';
-        $has_terms = file_exists($terms_path);
+        $form = new forms\Registration();
 
         return Response::ok('registrations/new.phtml', [
-            'has_terms' => $has_terms,
-            'username' => '',
-            'email' => '',
-            'password' => '',
-            'subscriptions_enabled' => $app_conf['subscriptions_enabled'],
-            'subscriptions_host' => $app_conf['subscriptions_host'],
+            'form' => $form,
         ]);
     }
 
     /**
      * Create a user.
      *
-     * @request_param string csrf
      * @request_param string email
      * @request_param string username
      * @request_param string password
      * @request_param bool accept_terms
      * @request_param bool accept_contact
+     * @request_param string csrf_token
      *
-     * @response 302 / if already connected
-     * @response 302 /login if registrations are closed
-     * @response 400 if CSRF token is wrong
-     * @response 400 if email, username or password is missing/invalid
-     * @response 400 if the service has terms of service and accept_terms is false
-     * @response 400 if email already exists
+     * @response 302 /
+     *     If the user is connected.
+     * @response 302 /login
+     *     If the registrations are closed.
+     * @response 400
+     *     If at least one of the parameters is invalid.
      * @response 302 /onboarding
+     *     On sucess.
      */
     public function create(Request $request): Response
     {
         if (auth\CurrentUser::get()) {
             return Response::redirect('home');
         }
 
-        $app_conf = \App\Configuration::$application;
-        if (!$app_conf['registrations_opened']) {
+        if (!\App\Configuration::areRegistrationsOpened()) {
             return Response::redirect('login');
         }
 
-        $app_path = \App\Configuration::$app_path;
-        $terms_path = $app_path . '/policies/terms.html';
-        $has_terms = file_exists($terms_path);
-
-        $username = $request->parameters->getString('username', '');
-        $email = $request->parameters->getString('email', '');
-        $password = $request->parameters->getString('password', '');
-        $accept_terms = $request->parameters->getBoolean('accept_terms');
-        $accept_contact = $request->parameters->getBoolean('accept_contact');
-        $csrf = $request->parameters->getString('csrf', '');
-
-        if (!\App\Csrf::validate($csrf)) {
-            return Response::badRequest('registrations/new.phtml', [
-                'has_terms' => $has_terms,
-                'username' => $username,
-                'email' => $email,
-                'password' => $password,
-                'subscriptions_enabled' => $app_conf['subscriptions_enabled'],
-                'subscriptions_host' => $app_conf['subscriptions_host'],
-                'error' => _('A security verification failed: you should retry to submit the form.'),
-            ]);
-        }
+        $user = new models\User();
+        $form = new forms\Registration(model: $user);
+        $form->handleRequest($request);
 
-        if ($has_terms && !$accept_terms) {
+        if (!$form->validate()) {
             return Response::badRequest('registrations/new.phtml', [
-                'has_terms' => $has_terms,
-                'username' => $username,
-                'email' => $email,
-                'password' => $password,
-                'subscriptions_enabled' => $app_conf['subscriptions_enabled'],
-                'subscriptions_host' => $app_conf['subscriptions_host'],
-                'errors' => [
-                    'accept_terms' => _('You must accept the terms of service.'),
-                ],
+                'form' => $form,
             ]);
         }
 
-        try {
-            $user = services\UserCreator::create($username, $email, $password);
-        } catch (services\UserCreatorError $e) {
-            return Response::badRequest('registrations/new.phtml', [
-                'has_terms' => $has_terms,
-                'username' => $username,
-                'email' => $email,
-                'password' => $password,
-                'subscriptions_enabled' => $app_conf['subscriptions_enabled'],
-                'subscriptions_host' => $app_conf['subscriptions_host'],
-                'errors' => $e->errors(),
-            ]);
-        }
+        $user = $form->model();
+        $user->save();
 
-        $user->accept_contact = $accept_contact;
+        services\UserService::initializeData($user);
 
         // Initialize the validation token
         $validation_token = new models\Token(1, 'day', 16);

src/forms/DemoDisabler.php

@@ -15,7 +15,7 @@ trait DemoDisabler
     public function checkNotDemoAccount(): void
     {
         $user = auth\CurrentUser::get();
-        if (\App\Configuration::isDemoEnabled() && $user && $user->isDemoAccount()) {
+        if (\App\Configuration::isDemoEnabled() && $user && $user->isDemoUser()) {
             $this->addError(
                 '@base',
                 'demo_account',

src/forms/Login.php

@@ -27,9 +27,9 @@ class Login extends BaseForm
      */
     public function __construct(array $default_values = [])
     {
-        if (\App\Configuration::$application['demo']) {
-            $default_values['email'] = 'demo@flus.io';
-            $default_values['password'] = 'demo';
+        if (\App\Configuration::isDemoEnabled()) {
+            $default_values['email'] = models\User::DEMO_EMAIL;
+            $default_values['password'] = models\User::DEMO_PASSWORD;
         }
 
         parent::__construct($default_values);

src/forms/Registration.php

@@ -0,0 +1,56 @@
+<?php
+
+namespace App\forms;
+
+use App\models;
+use App\utils;
+use Minz\Form;
+use Minz\Validable;
+
+/**
+ * @extends BaseForm<models\User>
+ *
+ * @author  Marien Fressinaud <dev@marienfressinaud.fr>
+ * @license http://www.gnu.org/licenses/agpl-3.0.en.html AGPL
+ */
+class Registration extends BaseForm
+{
+    use utils\Memoizer;
+
+    #[Form\Field(bind: 'setUsername')]
+    public string $username = '';
+
+    #[Form\Field(bind: 'setEmail')]
+    public string $email = '';
+
+    #[Form\Field(bind: 'setPassword')]
+    public string $password = '';
+
+    #[Form\Field]
+    public bool $accept_contact = false;
+
+    #[Form\Field(bind: false)]
+    public bool $accept_terms = false;
+
+    public int $username_max_length = models\User::USERNAME_MAX_LENGTH;
+
+    public function hasTerms(): bool
+    {
+        return $this->memoize('has_terms', function (): bool {
+            $terms_path = \App\Configuration::$app_path . '/policies/terms.html';
+            return file_exists($terms_path);
+        });
+    }
+
+    #[Validable\Check]
+    public function checkTermsAreAccepted(): void
+    {
+        if ($this->hasTerms() && !$this->accept_terms) {
+            $this->addError(
+                'accept_terms',
+                'terms_not_accepted',
+                _('You must accept the terms of service.'),
+            );
+        }
+    }
+}

src/forms/security/Credentials.php

@@ -19,7 +19,7 @@ class Credentials extends BaseForm
 {
     use DemoDisabler;
 
-    #[Form\Field(transform: '\Minz\Email::sanitize')]
+    #[Form\Field(bind: 'setEmail')]
     public string $email = '';
 
     #[Form\Field(bind: 'changePassword')]

src/forms/users/Profile.php

@@ -14,7 +14,7 @@
  */
 class Profile extends BaseForm
 {
-    #[Form\Field(transform: 'trim')]
+    #[Form\Field(bind: 'setUsername')]
     public string $username = '';
 
     public int $username_max_length = models\User::USERNAME_MAX_LENGTH;

src/jobs/scheduled/Cleaner.php

@@ -68,10 +68,10 @@ public function perform(): void
             // reinitialize the support user
             models\User::supportUser();
 
-            // Initialize a default (validated) user
-            $user = services\UserCreator::create('Alix', 'demo@flus.io', 'demo');
-            $user->validated_at = \Minz\Time::now();
+            // Initialize a default user
+            $user = models\User::demoUser();
             $user->save();
+            services\UserService::initializeData($user);
         }
     }
 }