app.py

# ------- Library Imports -------

import os
from flask import (
    Flask, flash, render_template,
    redirect, request, session, url_for)
from flask_pymongo import PyMongo
from functools import wraps
from flask_paginate import Pagination, get_page_args
from bson.objectid import ObjectId
from werkzeug.security import generate_password_hash, check_password_hash
if os.path.exists("env.py"):
    import env


# ------- Flask App Configuration -------

app = Flask(__name__)

app.config["MONGO_DBNAME"] = os.environ.get("MONGO_DBNAME")
app.config["MONGO_URI"] = os.environ.get("MONGO_URI")
app.secret_key = os.environ.get("SECRET_KEY")

mongo = PyMongo(app)


# ------- Pagination -------

"""
Pagination adapted from:
    https://github.com/Sharon-B/Recipe-Box/blob/master/app.py
"""


PER_PAGE = 6


def paginated(recipes):

    # Set pagination configuration
    page, per_page, offset = get_page_args(page_parameter="page",
                                           per_page_parameter="per_page")

    offset = page * PER_PAGE - PER_PAGE

    return recipes[offset: offset + PER_PAGE]


def pagination_args(recipes):

    # Set pagination configuration
    page, per_page, offset = get_page_args(page_parameter="page",
                                           per_page_parameter="per_page")

    total = len(recipes)

    return Pagination(page=page,
                      per_page=PER_PAGE,
                      total=total,
                      css_framework="bootstrap4")


# ------- Check User Login Function -------


def login_required(f):
    """
    Using login_required decorator adapted from:
    https://flask.palletsprojects.com/en/2.0.x/patterns/viewdecorators/#login-required-decorator
    https://github.com/TravelTimN/flask-task-manager-project/blob/demo/app.py
    """
    @wraps(f)
    def decorated_function(*args, **kwargs):

        # User NOT logged in
        if "user" not in session:
            flash("Please log in to view this page!")
            return redirect(url_for("login"))

        # User IS logged in
        return f(*args, **kwargs)

    return decorated_function


# ------- Home Page -------

@app.route("/")
@app.route("/home")
def home():
    """
    Home page displays the 4 latest recipes
    """
    latest_recipes = mongo.db.recipes.find().sort("_id", -1).limit(4)

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        return render_template("index.html",
                               recipes=latest_recipes,
                               user=user,
                               title="Bake It Til You Make It")

    else:
        return render_template("index.html",
                               recipes=latest_recipes,
                               title="Bake It Til You Make It")


# ------- Find Recipes Page -------

@app.route("/find_recipes")
def find_recipes():
    """
    Find recipes page displays all recipes (with pagination).
    Providing search function for users.
    """
    recipes = list(mongo.db.recipes.find())

    # pagination code adapted from:
    # https://github.com/alandoherty95/reciprocate-app/blob/master/app.py
    recipes_paginated = paginated(recipes)
    pagination = pagination_args(recipes)

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        return render_template("recipe/find_recipes.html",
                               user=user,
                               recipes=recipes_paginated,
                               pagination=pagination,
                               title="Find Recipes")

    return render_template("recipe/find_recipes.html",
                           recipes=recipes_paginated,
                           pagination=pagination,
                           title="Find Recipes")


# ------- Search for Recipes -------

@app.route("/search", methods=['GET', 'POST'])
def search():
    """
    Search function allows users to search within text indices for:
    recipe_name and description
    """

    # query search index set out in MongoDB
    query = request.form.get("query")

    recipes = list(mongo.db.recipes.find({"$text": {"$search": query}}))
    results_count = len(recipes)

    # recommended functionality adapted from:
    # https://github.com/johnnycistudent/recipe-app/blob/master/app.py
    recommended = mongo.db.recipes.find().sort(
                "favourite_count", -1).limit(6)

    recipes_paginated = paginated(recipes)
    pagination = pagination_args(recipes)

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        return render_template("recipe/search.html",
                               recipes=recipes_paginated,
                               user=user,
                               recommended=recommended,
                               query=query,
                               results_count=results_count,
                               pagination=pagination,
                               title="Search Results")

    return render_template("recipe/search.html",
                           recipes=recipes_paginated,
                           recommended=recommended,
                           query=query,
                           results_count=results_count,
                           pagination=pagination,
                           title="Search Results")


# ------- Filtered Search for Recipes -------

@app.route("/category_filter/<id>")
def category_filter(id):
    """
    Allows for filtered search.
    In this case: by CATEGORY
    """
    recipes = list(mongo.db.recipes.find({"category": id}))

    recipes_paginated = paginated(recipes)
    pagination = pagination_args(recipes)

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        return render_template("recipe/find_recipes.html",
                               recipes=recipes_paginated,
                               user=user,
                               pagination=pagination,
                               title="Search Results")

    return render_template("recipe/find_recipes.html",
                           recipes=recipes_paginated,
                           pagination=pagination,
                           title="Search Results")


@app.route("/difficulty_filter/<id>")
def difficulty_filter(id):
    """
    Allows for filtered search.
    In this case: by DIFFICULTY
    """
    recipes = list(mongo.db.recipes.find({"difficulty": id}))

    recipes_paginated = paginated(recipes)
    pagination = pagination_args(recipes)

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        return render_template("recipe/find_recipes.html",
                               recipes=recipes_paginated,
                               user=user,
                               pagination=pagination,
                               title="Search Results")

    return render_template("recipe/find_recipes.html",
                           recipes=recipes_paginated,
                           pagination=pagination,
                           title="Search Results")


# ------- Register Page -------

@app.route("/register", methods=["GET", "POST"])
def register():
    """
    Allows user to register an account on the database,
    rendering register.html.

    Prevention of username duplicates included.
    """

    if "user" not in session:
        if request.method == "POST":
            # Checks if username already exists
            existing_user = mongo.db.users.find_one(
                {"username": request.form.get(
                    "username").lower()})

            # Prevents duplicates
            if existing_user:
                flash("Username already exists, try another")
                return redirect(url_for("register"))

            # Sends collected data to user collection
            register = {
                "username": request.form.get("username").lower(),
                "email": request.form.get("email").lower(),
                "password": generate_password_hash(
                    request.form.get("password")),
                "user_img": request.form.get("user_img"),
                "favourite_recipes": [],
                "is_admin": False
            }
            mongo.db.users.insert_one(register)

            # Welcomes user to session
            session["user"] = request.form.get("username").lower()
            flash("Welcome, Baker {}! Let's get started!".format(
                request.form.get("username")))
            return redirect(url_for("my_recipes",
                                    username=session["user"]))

        return render_template("user/register.html", title="Sign Up")

    else:
        # If user is logged in
        flash("You already have an account!")
        return redirect(url_for("my_recipes",
                                username=session["user"]))


# ------- Login Page -------

@app.route("/login", methods=["GET", "POST"])
def login():
    """
    Allows users to login to account
    """

    if "user" not in session:

        if request.method == "POST":
            # checking if user exists
            existing_user = mongo.db.users.find_one(
                {"username": request.form.get("username".lower())})

            if existing_user:
                # stored hash password must match user input
                if check_password_hash(
                    existing_user["password"], request.form.get(
                        "password")):
                    session["user"] = request.form.get("username").lower()
                    flash("Welcome back, {}! Let's get started!".format(
                        request.form.get("username")))
                    return redirect(url_for(
                        "my_recipes", username=session["user"]))
                else:
                    # if the password does not match
                    flash(
                        "Incorrect Username and/or Password, please try again")
                    return redirect(url_for("login"))
            else:
                # username does not exist
                flash(
                    "Incorrect Username and/or Password, please try again")
                return redirect(url_for("login"))

        return render_template("user/login.html", title="Login")

    else:
        # If user is logged in
        flash("You are already logged in!")
        return redirect(url_for("my_recipes",
                                username=session["user"]))


# ------- Logout Page -------

@app.route("/logout")
@login_required
def logout():
    """
    Allows current session user to log out.
    """

    # User session cookies removal
    session.pop("user")
    flash("Logged out. See you soon!")
    return redirect(url_for("login"))


# ------- Edit User Page -------

@app.route("/edit_user/<username>", methods=["GET", "POST"])
@login_required
def edit_user(username):
    """
    Allows user to edit profile
    """

    # user variable for user image
    user = mongo.db.users.find_one(
        {"username": session["user"]})

    if session["user"] == username:

        # Update profile function
        if request.method == "POST":

            mongo.db.users.update_one({'username': session['user']},
                                      {'$set': {
                                          'user_img': request.form.get(
                                              'user_img')
                                      }})

            flash("{}'s Profile Updated!".format(
                    session["user"]))
            return redirect(url_for("my_recipes",
                                    username=session["user"]))

        return render_template(
            "user/edit_user.html", user=user, title="Edit User")

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for("my_recipes",
                                username=session["user"]))


# ------- Edit Account Page -------

@app.route("/edit_account/<username>", methods=["GET", "POST"])
@login_required
def edit_account(username):
    """
    Allows user to edit their account settings
        - Change Password
        - Delete Account
    """

    # user variable for user image
    user = mongo.db.users.find_one(
        {"username": session["user"]})

    if session["user"] == username:

        # Update profile function
        if request.method == "POST":

            mongo.db.users.update_one({'username': session['user']},
                                      {'$set': {
                                          'password': generate_password_hash(
                                              request.form.get("password"))
                                      }})

            flash("Account Updated! Log back in to confirm changes.".format(
                    request.form.get("username")))
            session.pop("user")
            return render_template("user/login.html",
                                   title="Login")

        return render_template("user/edit_account.html",
                               user=user,
                               title="Edit Account")

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for("my_recipes",
                                username=session["user"]))


# ------- Delete Profile -------

@app.route("/delete_user/<username>")
@login_required
def delete_user(username):
    """
    Allows user to delete profile
    """

    if session["user"] == username:
        mongo.db.users.remove(
            {"username": username.lower()})
        flash("Profile Deleted")
        session.pop("user")

        return redirect(url_for("register"))

    else:
        # if wrong user
        flash("You do not have permission to do that!")
        return redirect(url_for("my_recipes",
                                username=session["user"]))


# ------- My Recipes Page -------

@app.route("/my_recipes/<username>", methods=["GET", "POST"])
@login_required
def my_recipes(username):
    """
    Displays User's recipes page with their own created recipes.
    Home page for logged in users.
    """

    if session["user"] == username:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        recipes = list(
            mongo.db.recipes.find(
                {"baker": username.lower()}))

        recipes_paginated = paginated(recipes)
        pagination = pagination_args(recipes)

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for("my_recipes",
                                username=session["user"]))

    return render_template("user/my_recipes.html",
                           user=user,
                           recipes=recipes_paginated,
                           pagination=pagination,
                           title="My Recipes")


# ------- My Favourites Page -------

@app.route("/my_favourites/<username>", methods=["GET", "POST"])
@login_required
def my_favourites(username):
    """
    Displays recipes the user has 'favourited'
    Favouriting functionality inspired by:
    https://github.com/johnnycistudent/recipe-app/blob/master/app.py
    """

    if session["user"] == username:

        # user variable for user image
        user = mongo.db.users.find_one(
                {"username": session["user"]})

        recipes = user["favourite_recipes"]

        favourites = mongo.db.recipes.find(
            {"_id": {"$in": recipes}})

        recommended = mongo.db.recipes.find().sort(
            "favourite_count", -1).limit(4)

        recipes_paginated = paginated(favourites)
        pagination = pagination_args(recipes)

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for("my_favourites",
                                username=session["user"]))

    return render_template("user/my_favourites.html",
                           user=user,
                           recommended=recommended,
                           favourites=recipes_paginated,
                           recipes=recipes,
                           pagination=pagination,
                           title="My Favourites")


# ------- Add to Favourites -------

@app.route("/add_to_favourites/<recipe_id>", methods=["GET", "POST"])
@login_required
def add_to_favourites(recipe_id):
    """
    Adds recipe to the current users 'favourites'
    Favouriting functionality inspired by:
    https://github.com/johnnycistudent/recipe-app/blob/master/app.py
    """
    recipe = mongo.db.recipes.find_one(
        {"_id": ObjectId(recipe_id)})

    if session["user"] != recipe["baker"]:
        user = mongo.db.users.find_one(
            {"username": session["user"]})

        favourite_recipes = user["favourite_recipes"]

        # Checks if recipe is already in favourites
        if ObjectId(recipe_id) not in favourite_recipes:
            # Adds recipe_id to users favourite_recipes
            mongo.db.users.update_one({"username": session["user"]},
                                      {"$push": {
                                          "favourite_recipes": ObjectId(
                                              recipe_id)}})

            # Increments recipes favourite_count by 1
            mongo.db.recipes.update_one({"_id": ObjectId(recipe_id)},
                                        {"$inc": {"favourite_count": 1}})
        else:
            # If recipe is already favourited
            flash("Already Added to favourites")
            return redirect(url_for("recipe",
                                    recipe_id=recipe_id))

        flash("Recipe added to My Favourites")
        return redirect(url_for("recipe",
                                recipe_id=recipe_id))
    else:
        # if user created recipe, they cannot favourite
        flash("This creation is yours!")
        return redirect(url_for("recipe",
                                recipe_id=recipe_id))


# ------- Remove From Favourites -------
@app.route("/remove_from_favourites/<recipe_id>", methods=['GET', 'POST'])
@login_required
def remove_from_favourites(recipe_id):
    """
    Allows user to remove favourited recipe from favourites
    Favouriting functionality inspired by:
    https://github.com/johnnycistudent/recipe-app/blob/master/app.py
    """

    recipe = mongo.db.recipes.find_one(
        {"_id": ObjectId(recipe_id)})

    if session["user"] != recipe["baker"]:

        user = mongo.db.users.find_one({"username": session["user"]})

        favourites = user["favourite_recipes"]

        # Checks if the recipe is in favourites
        if ObjectId(recipe_id) in favourites:
            # Removes recipe_id from users favourite_recipes
            mongo.db.users.update({"username": session['user']}, {"$pull": {
                "favourite_recipes": ObjectId(recipe_id)}})

            # Decrement recipes favourite_count by 1
            mongo.db.recipes.update({"_id": ObjectId(recipe_id)},
                                    {'$inc': {
                                        'favourite_count': -1
                                    }})

            flash("Recipe removed from My Favourites")

        else:
            flash("Recipe is not in My Favourites!")

        return redirect(url_for('recipe', recipe_id=recipe_id))
    else:
        # if user created recipe they cannot favourite
        flash("This creation is yours!")
        return redirect(url_for("recipe",
                                recipe_id=recipe_id))


# ------- Individual Recipe Page -------

@app.route("/recipe/<recipe_id>")
def recipe(recipe_id):
    """
    Displays the full recipe
    """

    recipe = mongo.db.recipes.find_one(
        {"_id": ObjectId(recipe_id)})

    # checking that the user is in session
    if "user" not in session:

        # If user is not logged in
        favourited = False

        return render_template(
            "recipe/recipe.html", recipe=recipe,
            favourited=favourited, title="Recipe")

    else:
        # If user is logged in
        user = mongo.db.users.find_one({"username": session["user"]})
        favourites = user['favourite_recipes']

        # Checking if recipe is in favourites
        if ObjectId(recipe_id) in favourites:
            favourited = True

        else:
            favourited = False

        return render_template("recipe/recipe.html",
                               recipe=recipe,
                               favourited=favourited,
                               user=user,
                               title="Recipe")


# ------- Create Recipe Page -------

@app.route("/create_recipe", methods=["GET", "POST"])
@login_required
def create_recipe():
    """
    Registered users can upload their favourite recipes.
    """

    # user variable for user image
    user = mongo.db.users.find_one(
        {"username": session["user"]})

    if request.method == "POST":
        recipe = {
            "recipe_name": request.form.get("recipe_name"),
            "recipe_img": request.form.get("recipe_img"),
            "recipe_url": request.form.get("recipe_url"),
            "description": request.form.get("description"),
            "category": request.form.get("category"),
            "difficulty": request.form.get("difficulty"),
            "serving": request.form.get("serving"),
            "total_time": request.form.get("total_time"),
            "ingredients": request.form.getlist("ingredients"),
            "directions": request.form.getlist("directions"),
            "baker": session["user"],
            "favourite_count": int(0)
        }
        mongo.db.recipes.insert_one(recipe)
        flash("Recipe Shared! Let's get baking!")
        return redirect(url_for(
            "my_recipes", username=session["user"]))

    categories = mongo.db.categories.find().sort("category", 1)
    difficulty = mongo.db.level.find().sort("difficulty", 1)

    return render_template(
        "recipe/create_recipe.html", categories=categories,
        difficulty=difficulty, user=user, title="Create Recipe")


# ------- Edit Recipe Page -------

@app.route("/edit_recipe/<recipe_id>", methods=["GET", "POST"])
@login_required
def edit_recipe(recipe_id):
    """
    User can edit the recipe they uploaded
    """

    # user variable for user image/admin functionality
    user = mongo.db.users.find_one(
        {"username": session["user"]})

    recipe = mongo.db.recipes.find_one(
        {"_id": ObjectId(recipe_id)})

    if session["user"] == recipe["baker"] or user["is_admin"]:

        if request.method == "POST":
            mongo.db.recipes.update_one(
                {"_id": ObjectId(recipe_id)}, {
                    '$set': {
                            "recipe_name": request.form.get("recipe_name"),
                            "recipe_img": request.form.get("recipe_img"),
                            "recipe_url": request.form.get("recipe_url"),
                            "description": request.form.get("description"),
                            "category": request.form.get("category"),
                            "difficulty": request.form.get("difficulty"),
                            "serving": request.form.get("serving"),
                            "total_time": request.form.get("total_time"),
                            "ingredients": request.form.getlist("ingredients"),
                            "directions": request.form.getlist("directions"),
                        }
                })
            flash("{} Recipe Updated!".format(
                        request.form.get("recipe_name")))

            return redirect(url_for("recipe", recipe_id=recipe_id))

        categories = mongo.db.categories.find().sort("category", 1)
        difficulty = mongo.db.level.find().sort("difficulty", 1)

        return render_template(
                                "recipe/edit_recipe.html",
                                recipe=recipe,
                                categories=categories,
                                difficulty=difficulty,
                                user=user,
                                title="Edit Recipe")

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for('recipe',
                                recipe_id=recipe_id))


# ------- Delete Recipe -------

@app.route("/delete_recipe/<recipe_id>")
@login_required
def delete_recipe(recipe_id):
    """
    Allows user to delete their uploaded
    """

    # user variable for user image/admin functionality
    user = mongo.db.users.find_one(
        {"username": session["user"]})

    recipe = mongo.db.recipes.find_one(
        {"_id": ObjectId(recipe_id)})

    if session["user"] == recipe["baker"] or user["is_admin"]:

        mongo.db.recipes.remove({"_id": ObjectId(recipe_id)})

        mongo.db.users.update({},
                              {"$pull": {
                                  "favourite_recipes": ObjectId(recipe_id)}},
                              multi=True)

        flash("Recipe Deleted")
        return redirect(url_for("my_recipes",
                                username=session["user"]))

    else:
        # if wrong user
        flash("You do not have permission to view this page")
        return redirect(url_for('recipe',
                                recipe_id=recipe_id))


# ------- Error Handlers -------
# adapted from: https://flask.palletsprojects.com/en/1.1.x/errorhandling/

@app.errorhandler(404)
def page_not_found(e):

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})
        return render_template("error_handlers/404.html", user=user), 404
    else:
        return render_template("error_handlers/404.html"), 404


@app.errorhandler(500)
def server_error(e):

    if "user" in session:

        # user variable for user image
        user = mongo.db.users.find_one(
            {"username": session["user"]})
        return render_template("error_handlers/500.html", user=user), 500
    else:
        return render_template("error_handlers/500.html"), 500


# ------- Declaration of special variables -------

if __name__ == "__main__":
    app.run(host=os.environ.get("IP"),
            port=int(os.environ.get("PORT")),
            debug=False)