Added Errors Pages and Authentication Module

Author: yubarajshrestha

app/__init__.py

@@ -5,11 +5,13 @@
 from celery import Celery
 from flask_caching import Cache
 from depot.manager import DepotManager
+from flask_login import LoginManager
 
 mail = Mail()
 db = Orator()
 celery = Celery(__name__, broker=DevelopmentConfig.CELERY_BROKER_URL, result_backend=DevelopmentConfig.RESULT_BACKEND)
 cache = Cache()
+login_manager = LoginManager()
 
 
 def factory(config=DevelopmentConfig) -> Flask:
@@ -35,6 +37,9 @@ def factory(config=DevelopmentConfig) -> Flask:
     db.init_app(app)
     db.app = app
 
+    # initialize login_manager
+    register_login_manager(app)
+
     # configure depotmanager
     DepotManager.configure(name='default', config={
         'depot.storage_path': 'storage/public'
@@ -46,14 +51,33 @@ def factory(config=DevelopmentConfig) -> Flask:
 
     register_blueprints(app)
     register_logging(app)
+    register_error_handlers(app)
 
     return app
 
 
+def register_login_manager(app):
+    login_manager.login_view = 'auth.login_page'
+    login_manager.init_app(app)
+    login_manager.session_protection = 'strong'
+    login_manager.login_message = 'Please login to access this page.'
+    login_manager.login_message_category = 'info'
+    login_manager.needs_refresh_message = 'To protect your account, please reauthenticate to access this page.'
+    login_manager.needs_refresh_message_category = 'info'
+    login_manager.refresh_view = 'login'
+
+    @login_manager.user_loader
+    def load_user(user_id):
+        from app.models.User import User
+        return User.find(user_id)
+
+
 def register_blueprints(app):
+    from routes.auth import router as auth_router
     from routes.web import router as web_router
     from routes.api import router as api_router
 
+    app.register_blueprint(auth_router)
     app.register_blueprint(web_router)
     app.register_blueprint(api_router)
 
@@ -86,24 +110,39 @@ def register_error_handlers(app) -> None:
     # 400 - Bad Request
     @app.errorhandler(400)
     def bad_request(e):
-        return render_template('errors/400.html'), 400
+        return render_template('errors/400.html', context={
+            "title": 400,
+            "message": "Bad Request"
+        }), 400
 
     # 403 - Forbidden
     @app.errorhandler(403)
     def forbidden(e):
-        return render_template('errors/403.html'), 403
+        return render_template('errors/403.html', context={
+            "title": 403,
+            "message": "Forbidden"
+        }), 403
 
     # 404 - Page Not Found
     @app.errorhandler(404)
     def page_not_found(e):
-        return render_template('errors/404.html'), 404
+        return render_template('errors/404.html', context={
+            "title": 404,
+            "message": "Page not found"
+        }), 404
 
     # 405 - Method Not Allowed
     @app.errorhandler(405)
     def method_not_allowed(e):
-        return render_template('errors/405.html'), 405
+        return render_template('errors/405.html', context={
+            "title": 405,
+            "message": "Method Not Allowed"
+        }), 405
 
     # 500 - Internal Server Error
     @app.errorhandler(500)
     def server_error(e):
-        return render_template('errors/500.html'), 500
+        return render_template('errors/500.html', context={
+            "title": 500,
+            "message": "Internal Server Error"
+        }), 500

app/controllers/AuthController.py

@@ -0,0 +1,63 @@
+from app.models.User import User
+from app.forms import ForgotPasswordForm, LoginForm
+from flask import render_template, redirect, request
+from flask_login import login_user, logout_user, login_required, current_user
+
+
+class AuthController():
+
+    @staticmethod
+    def login():
+        form = LoginForm()
+        if request.method == 'GET':
+            return render_template('pages/auth/login.html', title='Login', form=form)
+        else:
+            if form.validate_on_submit():
+                email = form.data['email']
+                password = form.data['password']
+
+                user = User.where("email", email).first()
+                if user is None:
+                    return render_template('pages/auth/login.html', title='Login', form=form, message="User not found!")
+
+                if user.check_password(password):
+                    login_user(user)
+                    return redirect('/home')
+
+            return render_template('pages/auth/login.html', title='Login', form=form, message="User not found!")
+
+    def register():
+        """
+        Register a user
+        """
+        return redirect('/')
+
+    def forgot_password():
+        """
+        Forgot password
+        """
+        form = ForgotPasswordForm()
+        if request.method == 'GET':
+            return render_template('pages/auth/forgot_password.html', title='Forgot Password', form=form)
+        else:
+            if form.validate_on_submit():
+                email = form.data['email']
+                user = User.where("email", email).first()
+                if user is None:
+                    return render_template('pages/auth/forgot_password.html', title="Forgot Password", form=form, message="User not found!")
+                user.send_password_reset_email()
+                return render_template('pages/auth/forgot_password.html', title="Forgot Password", form=form, message="User not found!")
+            return render_template('pages/auth/forgot_password.html', title="Forgot Password", form=form, message="Invalid parameters!")
+
+    @login_required
+    def logout():
+        logout_user()
+        return redirect('/')
+
+    @login_required
+    def profile():
+        return render_template('pages/auth/profile.html', title='Profile', user=current_user)
+
+    @login_required
+    def home():
+        return render_template('pages/auth/home.html', title='Home', user=current_user)

app/controllers/WelcomeController.py

@@ -1,26 +1,15 @@
-from app.services import sign
 from flask import render_template, request
-from app import cache
 from app.services.Storage import Storage
-import json
 
 
 class WelcomeController():
 
     @staticmethod
-    @cache.memoize(timeout=60)
     def index():
-        # cache.set('name', 'Yubaraj Shrestha')
-        # print(cache.get('name'))
-
         return render_template("pages/index.html")
 
     @staticmethod
     def about():
-        encrypted = sign().sign(json.dumps({
-            "name": "Yubaraj Shrestha"
-        }))
-        print(encrypted)
         return render_template("pages/about.html")
 
     @staticmethod

app/forms/__init__.py

@@ -0,0 +1,35 @@
+from flask_wtf import FlaskForm
+from wtforms import StringField, PasswordField, SubmitField, BooleanField, TextAreaField
+from wtforms.validators import DataRequired, Length, Email, EqualTo, ValidationError
+from app.models.User import User
+
+
+class RegistrationForm(FlaskForm):
+
+    username = StringField('Username', validators=[DataRequired(), Length(min=2, max=20)])
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    password = PasswordField('Password', validators=[DataRequired()])
+    confirm_password = PasswordField('Confirm Password', validators=[DataRequired(), EqualTo('password')])
+    submit = SubmitField('Sign Up')
+
+    def validate_username(self, username):
+        user = User.where("username", username.data).first()
+        if user:
+            raise ValidationError('That username is taken. Please choose a different one.')
+
+    def validate_email(self, email):
+        user = User.where("email", email.data).first()
+        if user:
+            raise ValidationError('That email is taken. Please choose a different one.')
+
+
+class LoginForm(FlaskForm):
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    password = PasswordField('Password', validators=[DataRequired()])
+    remember = BooleanField('Remember Me')
+    submit = SubmitField('Login')
+
+
+class ForgotPasswordForm(FlaskForm):
+    email = StringField('Email', validators=[DataRequired(), Email()])
+    submit = SubmitField('Send Reset Link')

app/jobs/MailJob.py

@@ -0,0 +1,18 @@
+from flask_mail import Message
+from app import mail, celery
+from flask import current_app
+
+
+@celery.task(name='app.jobs.MailJob.send_mail_job')
+def send_mail_job(message_data):
+    """
+    This function is used to send a test email to the user.
+    """
+    app = current_app._get_current_object()
+
+    message = Message(subject=message_data['subject'],
+                      recipients=[message_data['recipients']],
+                      body=message_data['body'],
+                      sender=app.config['MAIL_DEFAULT_SENDER'])
+
+    mail.send(message)

app/models/User.py

@@ -1,9 +1,23 @@
 from app import db
+from flask_login import UserMixin
 
 
-class User(db.Model):
+class User(db.Model, UserMixin):
 
     __fillable__ = ['name', 'email']
 
+    def check_password(self, password):
+        return True
+
+    def send_password_reset_email(self):
+        from app.jobs.MailJob import send_mail_job
+        message_data = {
+            'subject': 'Reset Password',
+            'body': 'This email was sent asynchronously using Celery.',
+            'recipients': self.email,
+
+        }
+        send_mail_job.apply_async(args=[message_data])
+
     def __repr__(self) -> str:
         return '<User %r>' % self.name

app/views/errors/400.html

@@ -1 +1,68 @@
-400 Error
+{% extends 'layouts/base.html' %}
+
+{% block content %}
+
+<!-- component -->
+<style>
+    .emoji-404 {
+
+        position: relative;
+        animation: mymove 2.5s infinite;
+    }
+
+    @keyframes mymove {
+        33% {
+            top: 0px;
+        }
+
+        66% {
+            top: 20px;
+        }
+
+        100% {
+            top: 0px
+        }
+
+
+
+    }
+</style>
+<div class="bg-gray-100 h-screen flex justify-center items-center">
+    <div>
+        <center class="m-auto">
+            <svg class="emoji-404 " enable-background="new 0 0 226 249.135" height="249.135" id="Layer_1"
+                overflow="visible" version="1.1" viewBox="0 0 226 249.135" width="226" xml:space="preserve">
+                <circle cx="113" cy="113" fill="#FFE585" r="109" />
+                <line enable-background="new    " fill="none" opacity="0.29" stroke="#6E6E96" stroke-linecap="round"
+                    stroke-linejoin="round" stroke-width="8" x1="88.866" x2="136.866" y1="245.135" y2="245.135" />
+                <line enable-background="new    " fill="none" opacity="0.17" stroke="#6E6E96" stroke-linecap="round"
+                    stroke-linejoin="round" stroke-width="8" x1="154.732" x2="168.732" y1="245.135" y2="245.135" />
+                <line enable-background="new    " fill="none" opacity="0.17" stroke="#6E6E96" stroke-linecap="round"
+                    stroke-linejoin="round" stroke-width="8" x1="69.732" x2="58.732" y1="245.135" y2="245.135" />
+                <circle cx="68.732" cy="93" fill="#6E6E96" r="9" />
+                <path
+                    d="M115.568,5.947c-1.026,0-2.049,0.017-3.069,0.045  c54.425,1.551,98.069,46.155,98.069,100.955c0,55.781-45.219,101-101,101c-55.781,0-101-45.219-101-101  c0-8.786,1.124-17.309,3.232-25.436c-3.393,10.536-5.232,21.771-5.232,33.436c0,60.199,48.801,109,109,109s109-48.801,109-109  S175.768,5.947,115.568,5.947z"
+                    enable-background="new    " fill="#FF9900" opacity="0.24" />
+                <circle cx="156.398" cy="93" fill="#6E6E96" r="9" />
+                <ellipse cx="67.732" cy="140.894" enable-background="new    " fill="#FF0000" opacity="0.18" rx="17.372"
+                    ry="8.106" />
+                <ellipse cx="154.88" cy="140.894" enable-background="new    " fill="#FF0000" opacity="0.18" rx="17.371"
+                    ry="8.106" />
+                <path
+                    d="M13,118.5C13,61.338,59.338,15,116.5,15c55.922,0,101.477,44.353,103.427,99.797  c0.044-1.261,0.073-2.525,0.073-3.797C220,50.802,171.199,2,111,2S2,50.802,2,111c0,50.111,33.818,92.318,79.876,105.06  C41.743,201.814,13,163.518,13,118.5z"
+                    fill="#FFEFB5" />
+                <circle cx="113" cy="113" fill="none" r="109" stroke="#6E6E96" stroke-width="8" />
+            </svg>
+            <div class=" tracking-widest mt-4">
+                <span class="text-gray-500 text-6xl block"><span>{{ title }}</span></span>
+                <span class="text-gray-500 text-xl">{{ message }}</span>
+
+            </div>
+        </center>
+        <center class="mt-6">
+            <a href="/" class="text-gray-500 font-mono text-xl bg-gray-200 p-3 rounded-md hover:shadow-md">Go back </a>
+        </center>
+    </div>
+</div>
+
+{% endblock %}