new: Allow user to accept to be contacted

flusio · Mar 10, 2024 · eabce91 · eabce91
1 parent bbbc5cb
commit eabce91
Show file tree

Hide file tree

Showing 15 changed files with 238 additions and 75 deletions.
diff --git a/locales/fr_FR/LC_MESSAGES/main.mo b/locales/fr_FR/LC_MESSAGES/main.mo
diff --git a/locales/fr_FR/LC_MESSAGES/main.po b/locales/fr_FR/LC_MESSAGES/main.po
diff --git a/src/Application.php b/src/Application.php
@@ -132,6 +132,8 @@ public function run(\Minz\Request $request): mixed
                 $autoload_modal_url = \Minz\Url::for('showcase', ['id' => 'navigation']);
             } elseif ($current_user->autoload_modal === 'showcase link') {
                 $autoload_modal_url = \Minz\Url::for('showcase', ['id' => 'link']);
+            } elseif ($current_user->autoload_modal === 'showcase contact') {
+                $autoload_modal_url = \Minz\Url::for('showcase', ['id' => 'contact']);
             }
 
             // Force CSRF token to avoid weird issues when user did nothing for a while

diff --git a/src/cli/Help.php b/src/cli/Help.php
@@ -92,6 +92,7 @@ public function show(): Response
         $usage .= "      --url=TEXT           where TEXT is an external URL\n";
         $usage .= "\n";
         $usage .= "  users                    List all the users\n";
+        $usage .= "      [--to-contact=BOOL]  list only the users who accepted to be contacted (default: false)\n";
         $usage .= "  users create             Create a user\n";
         $usage .= "      --email=EMAIL\n";
         $usage .= "      --password=PASSWORD\n";

diff --git a/src/cli/Users.php b/src/cli/Users.php
@@ -19,11 +19,20 @@ class Users
     /**
      * List all the users ordered by created_at.
      *
+     * @request_param bool to-contact
+     *
      * @response 200
      */
     public function index(Request $request): Response
     {
-        $users = models\User::listAll();
+        $to_contact = $request->paramBoolean('to-contact');
+
+        if ($to_contact) {
+            $users = models\User::listBy(['accept_contact' => true]);
+        } else {
+            $users = models\User::listAll();
+        }
+
         usort($users, function ($user1, $user2) {
             if ($user1->created_at == $user2->created_at) {
                 return 0;

diff --git a/src/controllers/Registrations.php b/src/controllers/Registrations.php
@@ -59,7 +59,8 @@ public function new(): Response
      * @request_param string email
      * @request_param string username
      * @request_param string password
-     * @request_param string accept_terms
+     * @request_param bool accept_terms
+     * @request_param bool accept_contact
      *
      * @response 302 / if already connected
      * @response 302 /login if registrations are closed
@@ -68,10 +69,6 @@ public function new(): Response
      * @response 400 if the service has terms of service and accept_terms is false
      * @response 400 if email already exists
      * @response 302 /onboarding
-     *
-     * @param \Minz\Request $request
-     *
-     * @return \Minz\Response
      */
     public function create(Request $request): Response
     {
@@ -91,7 +88,8 @@ public function create(Request $request): Response
         $username = $request->param('username', '');
         $email = $request->param('email', '');
         $password = $request->param('password', '');
-        $accept_terms = $request->param('accept_terms', false);
+        $accept_terms = $request->paramBoolean('accept_terms');
+        $accept_contact = $request->paramBoolean('accept_contact');
         $csrf = $request->param('csrf', '');
 
         if (!\Minz\Csrf::validate($csrf)) {
@@ -134,6 +132,8 @@ public function create(Request $request): Response
             ]);
         }
 
+        $user->accept_contact = $accept_contact;
+
         // Initialize the validation token
         $validation_token = new models\Token(1, 'day', 16);
         $validation_token->save();

diff --git a/src/controllers/Showcases.php b/src/controllers/Showcases.php
@@ -29,6 +29,8 @@ public function show(Request $request): Response
             return Response::ok('showcases/show_navigation.phtml');
         } elseif ($id === 'link') {
             return Response::ok('showcases/show_link.phtml');
+        } elseif ($id === 'contact') {
+            return Response::ok('showcases/show_contact.phtml');
         } else {
             return Response::notFound('not_found.phtml');
         }

diff --git a/src/controllers/my/Preferences.php b/src/controllers/my/Preferences.php
@@ -34,6 +34,7 @@ public function edit(Request $request): Response
         return Response::ok('my/preferences/edit.phtml', [
             'locale' => $user->locale,
             'option_compact_mode' => $user->option_compact_mode,
+            'accept_contact' => $user->accept_contact,
             // Don't name it "beta_enabled" because there's already a global
             // view variable named like this.
             'is_beta_enabled' => models\FeatureFlag::isEnabled('beta', $user->id),
@@ -45,8 +46,9 @@ public function edit(Request $request): Response
      *
      * @request_param string csrf
      * @request_param string locale
-     * @request_param boolean option_compact_mode
-     * @request_param boolean beta_enabled
+     * @request_param bool option_compact_mode
+     * @request_param bool accept_contact
+     * @request_param bool beta_enabled
      * @request_param string from
      *
      * @response 302 /login?redirect_to=:from
@@ -59,8 +61,9 @@ public function edit(Request $request): Response
     public function update(Request $request): Response
     {
         $locale = $request->param('locale', '');
-        $option_compact_mode = $request->paramBoolean('option_compact_mode', false);
-        $beta_enabled = $request->paramBoolean('beta_enabled', false);
+        $option_compact_mode = $request->paramBoolean('option_compact_mode');
+        $accept_contact = $request->paramBoolean('accept_contact');
+        $beta_enabled = $request->paramBoolean('beta_enabled');
         $csrf = $request->param('csrf', '');
         $from = $request->param('from', '');
 
@@ -73,6 +76,7 @@ public function update(Request $request): Response
             return Response::badRequest('my/preferences/edit.phtml', [
                 'locale' => $locale,
                 'option_compact_mode' => $option_compact_mode,
+                'accept_contact' => $accept_contact,
                 'is_beta_enabled' => $beta_enabled,
                 'from' => $from,
                 'error' => _('A security verification failed: you should retry to submit the form.'),
@@ -82,13 +86,15 @@ public function update(Request $request): Response
         $old_locale = $user->locale;
         $user->locale = trim($locale);
         $user->option_compact_mode = $option_compact_mode;
+        $user->accept_contact = $accept_contact;
 
         $errors = $user->validate();
         if ($errors) {
             $user->locale = $old_locale;
             return Response::badRequest('my/preferences/edit.phtml', [
                 'locale' => $locale,
                 'option_compact_mode' => $option_compact_mode,
+                'accept_contact' => $accept_contact,
                 'is_beta_enabled' => $beta_enabled,
                 'from' => $from,
                 'errors' => $errors,

diff --git a/src/migrations/Migration202403100001AddAcceptContactToUsers.php b/src/migrations/Migration202403100001AddAcceptContactToUsers.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace flusio\migrations;
+
+class Migration202403100001AddAcceptContactToUsers
+{
+    public function migrate(): bool
+    {
+        $database = \Minz\Database::get();
+
+        $database->exec(<<<'SQL'
+            ALTER TABLE users
+            ADD COLUMN accept_contact BOOLEAN NOT NULL DEFAULT false;
+        SQL);
+
+        return true;
+    }
+
+    public function rollback(): bool
+    {
+        $database = \Minz\Database::get();
+
+        $database->exec(<<<'SQL'
+            ALTER TABLE users
+            DROP COLUMN accept_contact;
+        SQL);
+
+        return true;
+    }
+}
diff --git a/src/migrations/Migration202403100002SetAutoloadModalToShowcaseContact.php b/src/migrations/Migration202403100002SetAutoloadModalToShowcaseContact.php
@@ -0,0 +1,28 @@
+<?php
+
+namespace flusio\migrations;
+
+class Migration202403100002SetAutoloadModalToShowcaseContact
+{
+    public function migrate(): bool
+    {
+        $database = \Minz\Database::get();
+
+        $database->exec(<<<'SQL'
+            UPDATE users SET autoload_modal = 'showcase contact';
+        SQL);
+
+        return true;
+    }
+
+    public function rollback(): bool
+    {
+        $database = \Minz\Database::get();
+
+        $database->exec(<<<'SQL'
+            UPDATE users SET autoload_modal = '';
+        SQL);
+
+        return true;
+    }
+}
diff --git a/src/models/User.php b/src/models/User.php
@@ -91,6 +91,9 @@ class User
     #[Database\Column]
     public bool $option_compact_mode;
 
+    #[Database\Column]
+    public bool $accept_contact;
+
     public function __construct(string $username, string $email, string $password)
     {
         $this->id = \Minz\Random::timebased();

diff --git a/src/schema.sql b/src/schema.sql
@@ -38,6 +38,7 @@ CREATE TABLE users (
     csrf TEXT NOT NULL DEFAULT '',
     autoload_modal TEXT NOT NULL DEFAULT '',
     option_compact_mode BOOLEAN NOT NULL DEFAULT false,
+    accept_contact BOOLEAN NOT NULL DEFAULT false,
 
     validated_at TIMESTAMPTZ,
     validation_token TEXT REFERENCES tokens ON DELETE SET NULL ON UPDATE CASCADE,

diff --git a/src/views/my/preferences/edit.phtml b/src/views/my/preferences/edit.phtml
@@ -63,6 +63,19 @@
             </p>
         </div>
 
+        <div class="form-group">
+            <input
+                type="checkbox"
+                id="accept-contact"
+                name="accept_contact"
+                <?= $accept_contact ? 'checked' : '' ?>
+            />
+
+            <label class="label--checkbox" for="accept-contact">
+                <?= _('Accept to be contacted by email to help improve the service (optional).') ?>
+            </label>
+        </div>
+
         <div class="form-group">
             <input
                 type="checkbox"

diff --git a/src/views/registrations/new.phtml b/src/views/registrations/new.phtml
@@ -126,6 +126,18 @@
             </div>
         </div>
 
+        <div class="form-group">
+            <input
+                type="checkbox"
+                id="accept-contact"
+                name="accept_contact"
+            />
+
+            <label class="label--checkbox" for="accept-contact">
+                <?= _('Accept to be contacted by email to help improve the service (optional).') ?>
+            </label>
+        </div>
+
         <?php if ($has_terms): ?>
             <div class="form-group form-group--terms <?= isset($errors['accept_terms']) ? 'form-group--invalid' : '' ?>">
                 <div id="accept-terms-desc">

diff --git a/src/views/showcases/show_contact.phtml b/src/views/showcases/show_contact.phtml
@@ -0,0 +1,31 @@
+<?php
+    $this->layout('base.phtml', [
+        'title' => _('You can help to improve the service'),
+        'canonical' => url_full('showcase', ['id' => 'contact']),
+        'modal_enabled' => true,
+    ]);
+?>
+
+<div class="section section--small">
+    <div class="section__title">
+        <h1><?= _('You can help to improve the service') ?></h1>
+    </div>
+
+    <p>
+        <?= _f('To help us improve %s, you can now accept to be contacted by email.', $brand) ?>
+    </p>
+
+    <p class="text--centered">
+        <a href="<?= url('preferences') ?>" class="anchor--action" data-turbo-frame="_top">
+            <?= _('Go to your preferences') ?>
+        </a>
+    </p>
+
+    <form method="get" action="" data-turbo-frame="_top">
+        <div class="form__actions">
+            <button type="submit" class="button--ghost">
+                <?= _('No thanks!') ?>
+            </button>
+        </div>
+    </form>
+</div>