feat: enhance user registration flow with validation

This update vastly improves the user experience for registration and email confirmation processes within the app. By integrating Flask-WTF, the commit introduces form handling with enhanced data validation and user feedback. It also refactors the SMTP configuration to utilize dynamic sender selection and improves the handling of SSL settings, ensuring a more reliable email delivery setup.

To provide better security and a smoother user interface, we've implemented CSRF protection with FlaskForm and utilized WTForms for input fields, applying validators to ensure data integrity. The introduction of user existence checks before registration helps prevent duplicate usernames in the system, contributing to a cleaner and more manageable user database.

Email composition in the send_email function has been streamlined for readability, and several new templates were added to provide users with clear instructions after submitting requests or completing registration, enhancing overall usability.

By addressing these areas, the commit not only elevates the security posture of the application but also significantly enriches the user interaction, making the system more robust and user-friendly.

Relevant configurations for SMTP and system random secret key generation have been adjusted for better compliance and security standards.

Additionally, unnecessary scripts and redundant code blocks were removed for a cleaner code base, and CSS adjustments were made for improved form presentation and application aesthetics.

Overall, this comprehensive update lays a stronger foundation for user management and interaction within the application, setting the stage for future enhancements and a better end-user experience.

app.py

@@ -1,14 +1,24 @@
 from flask import Flask, request, redirect, url_for, render_template
-from plankapy import Planka
+from plankapy import Planka, User, InvalidToken
+from flask_wtf import FlaskForm
+from wtforms import StringField, SubmitField, PasswordField
+from wtforms.validators import DataRequired, Email, ValidationError
 
 from configparser import ConfigParser
+from random import SystemRandom
 
 import sqlite3
 import smtplib
 import uuid
+import string
 
 app = Flask(__name__, static_folder="static", template_folder="templates")
 
+app.config["SECRET_KEY"] = "".join(
+    SystemRandom().choice("".join([string.ascii_letters, string.digits]))
+    for _ in range(50)
+)
+
 config = ConfigParser()
 config.read("settings.ini")
 
@@ -52,7 +62,7 @@ def rate_limit(request):
 
 
 def get_mailserver():
-    if config["SMTP"]["ssl"] == "True":
+    if config.getboolean("SMTP", "ssl", fallback=True):
         port = config.getint("SMTP", "port", fallback=465)
         mailserver = smtplib.SMTP_SSL(config["SMTP"]["host"], port)
     else:
@@ -68,25 +78,26 @@ def get_mailserver():
 
 def send_email(email, token):
     mailserver = get_mailserver()
+    sender = config.get("SMTP", "from", fallback=config["SMTP"]["username"])
 
     message = f"""
-        From: {config['SMTP']['from']}
-        To: {email}
-        Subject: Confirm your email address
+From: {sender}
+To: {email}
+Subject: {config['App']['name']} - Confirm your email address
 
-        Hi,
+Hi,
 
-        Thank you for registering with {config['App']['name']}! Please click the link below to confirm your email address:
+Thank you for registering with {config['App']['name']}! Please click the link below to confirm your email address:
 
-        https://{config['App']['domain']}/confirm/{token}
+https://{config['App']['host']}/confirm/{token}
 
-        If you did not register with {config['App']['name']}, please ignore this email.
+If you did not register with {config['App']['name']}, please ignore this email.
 
-        Thanks,
-        The {config['App']['name']} Team
-    """
+Thanks,
+The {config['App']['name']} Team
+    """.strip()
 
-    mailserver.sendmail(config["SMTP"]["from"], email, message)
+    mailserver.sendmail(sender, email, message)
 
     mailserver.quit()
 
@@ -135,12 +146,19 @@ def process_request(request):
     return redirect(url_for("post_request"))
 
 
+class EmailForm(FlaskForm):
+    email = StringField("Email", validators=[DataRequired(), Email()])
+    submit = SubmitField("Submit")
+
+
 @app.route("/", methods=["GET", "POST"])
 def start_request():
     if rate_limit(request):
         return render_template("rate_limit.html")
 
-    if request.method == "POST":
+    form = EmailForm()
+
+    if form.validate_on_submit():
         return process_request(request)
 
     return render_template(
@@ -148,12 +166,126 @@ def start_request():
         app=config["App"]["name"],
         title="Request Access",
         subtitle="Please enter your email address to request access.",
+        form=form,
     )
 
 
-@app.route("/check", methods=["GET"])
-def check():
-    return render_template("check.html")
+@app.route("/post_request")
+def post_request():
+    return render_template(
+        "post_request.html",
+        app=config["App"]["name"],
+        title="Request Received",
+        subtitle="Your request has been received. Please check your email for further instructions.",
+    )
+
+
+class SignupForm(FlaskForm):
+    email = StringField("Email")
+    name = StringField("Your Name", validators=[DataRequired()])
+    username = StringField("Username", validators=[DataRequired()])
+    password = PasswordField("Password", validators=[DataRequired()])
+    submit = SubmitField("Submit")
+
+    email.render_kw = {"readonly": True}
+
+    def validate_username(self, field):
+        planka = Planka(
+            url=config["Planka"]["url"],
+            username=config["Planka"]["username"],
+            password=config["Planka"]["password"],
+        )
+
+        users = User(planka)
+
+        try:
+            user = users.get(username=field.data)
+
+            if user:
+                raise ValidationError(f"User with username {field.data} already exists")
+
+        except InvalidToken:
+            # This error *should* be specific at this point, but I still don't trust it
+            pass
+
+
+@app.route("/confirm/<token>", methods=["GET", "POST"])
+def confirm_request(token):
+    conn = sqlite3.connect("db.sqlite3")
+    cursor = conn.cursor()
+
+    cursor.execute(
+        """
+        SELECT email
+        FROM requests
+        WHERE token = ?
+    """,
+        (token,),
+    )
+
+    row = cursor.fetchone()
+
+    if row is None:
+        return render_template(
+            "unknown.html",
+            app=config["App"]["name"],
+            title="Invalid Token",
+            subtitle="The token you provided is invalid.",
+        )
+
+    email = row[0]
+
+    form = SignupForm()
+
+    if form.validate_on_submit():
+        planka = Planka(
+            url=config["Planka"]["url"],
+            username=config["Planka"]["username"],
+            password=config["Planka"]["password"],
+        )
+
+        users = User(planka)
+        new_user = users.build(
+            username=form.username.data,
+            name=form.name.data,
+            password=form.password.data,
+            email=email,
+        )
+
+        users.create(new_user)
+
+        cursor.execute(
+            """
+            DELETE FROM requests
+            WHERE token = ?
+        """,
+            (token,),
+        )
+
+        conn.commit()
+        conn.close()
+
+        return redirect(url_for("post_signup"))
+
+    return render_template(
+        "signup.html",
+        app=config["App"]["name"],
+        title="Complete Signup",
+        subtitle="Please confirm your email address by filling out the form below.",
+        email=email,
+        form=form,
+    )
+
+
+@app.route("/post_signup")
+def post_signup():
+    return render_template(
+        "post_signup.html",
+        app=config["App"]["name"],
+        title="Signup Complete",
+        subtitle="Your account has been created. You may now log in.",
+        planka=config["Planka"]["url"],
+    )
 
 
 initialize_database()

requirements.txt

@@ -1,2 +1,4 @@
 Flask
+Flask-WTF
+email-validator
 git+https://git.private.coffee/PrivateCoffee/plankapy.git

static/style.css

@@ -6,7 +6,7 @@
 }
 
 body {
-    font-family: 'Roboto', sans-serif;
+  font-family: "Roboto", sans-serif;
   background-color: #f7f7f7;
   color: #333;
   line-height: 1.6;
@@ -31,7 +31,7 @@ a:hover {
 /* Header */
 header {
   background-color: #fff;
-    box-shadow: 0 2px 4px rgba(0,0,0,0.1);
+  box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
   padding: 20px 0;
 }
 
@@ -91,7 +91,7 @@ header nav ul li a {
 .ip-card {
   background-color: #fff;
   padding: 30px 10px;
-    box-shadow: 0 2px 5px rgba(0,0,0,0.1);
+  box-shadow: 0 2px 5px rgba(0, 0, 0, 0.1);
   border-radius: 8px;
   flex-basis: calc(50% - 10px);
   text-align: center;
@@ -146,9 +146,13 @@ header nav ul li a {
 }
 
 /* Footer */
+main {
+  margin-bottom: 20px;
+}
+
 footer {
   background-color: #fff;
-    box-shadow: 0 -2px 4px rgba(0,0,0,0.1);
+  box-shadow: 0 -2px 4px rgba(0, 0, 0, 0.1);
   text-align: center;
   padding: 20px;
   position: relative;
@@ -164,6 +168,8 @@ footer a {
   font-weight: 700;
 }
 
+/* Form Styles */
+
 input {
   padding: 10px;
   margin: 10px 0;
@@ -189,8 +195,9 @@ button:hover {
   background-color: #5d5d5d;
 }
 
-input:focus, button:focus {
+input:focus,
+button:focus {
   outline: none;
   border-color: #5d5d5d;
-    box-shadow: 0 0 0 2px rgba(93,93,93,0.5);
+  box-shadow: 0 0 0 2px rgba(93, 93, 93, 0.5);
 }

templates/base.html

@@ -29,6 +29,5 @@
         </p>
       </div>
     </footer>
-    <script src="script.js"></script>
   </body>
 </html>

templates/post_request.html

@@ -0,0 +1,4 @@
+{% extends "base.html" %} {% block content %}
+<div class="container">
+</div>
+{% endblock %}

templates/post_signup.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %} {% block content %}
+<div class="container">
+    <p>Thank you for signing up!</p>
+    <p>Click <a href="{{ planka }}">here</a> to log in.</p>
+</div>
+{% endblock %}

templates/request.html

@@ -18,8 +18,12 @@
     </small>
   </p>
   <form method="post">
-    <input type="email" name="email" placeholder="Email address" required />
-    <button type="submit">Request</button>
+    {{ form.hidden_tag() }} {{ form.email.label }}: {{ form.email(size=20) }}<br />
+    {% for error in form.email.errors %}
+    <span style="color: red">[{{ error }}]</span>
+    {% endfor %}
+    <br />
+    {{ form.submit() }}
   </form>
 </div>
 {% endblock %}

templates/signup.html

@@ -0,0 +1,36 @@
+{% extends "base.html" %} {% block content %}
+<div class="container">
+  <p>Please fill the form below to sign up on our Planka instance.</p>
+  <br />
+  <p>
+    <small>
+      <strong>Privacy notice:</strong>
+      The provided data will be stored in our database to allow you to log in to
+      our Planka instance. Your data will not be used for any other purpose.
+      Note that your name will be visible to other users of the Planka instance.
+    </small>
+  </p>
+  <form method="post">
+    {{ form.hidden_tag() }} {{ form.email.label }}: {{ form.email(size=20, disabled="disabled", value=email) }}<br />
+    {% for error in form.email.errors %}
+    <span style="color: red">[{{ error }}]</span>
+    {% endfor %}
+    <br />
+    {{ form.name.label }}: {{ form.name(size=20) }}<br />
+    {% for error in form.name.errors %}
+    <span style="color: red">[{{ error }}]</span>
+    {% endfor %}
+    <br />
+    {{ form.username.label }}: {{ form.username(size=20) }}<br />
+    {% for error in form.username.errors %}
+    <span style="color: red">[{{ error }}]</span>
+    {% endfor %}
+    <br />
+    {{ form.password.label }}: {{ form.password(size=20) }}<br />
+    {% for error in form.password.errors %}
+    <span style="color: red">[{{ error }}]</span>
+    {% endfor %}
+    {{ form.submit() }}
+  </form>
+</div>
+{% endblock %}

templates/unknown.html

@@ -0,0 +1,6 @@
+{% extends "base.html" %} {% block content %}
+<div class="container">
+  <p>Unfortunately, we could not find your email address in our database.</p>
+  <p>If you think this is an error, please contact the administrator.</p>
+</div>
+{% endblock %}