app.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
import os
from flask import Flask, render_template, redirect, request, url_for, \
    flash, session
from flask_pymongo import PyMongo
from datetime import date
from bson.objectid import ObjectId
import bcrypt
if os.path.exists('env.py'):
    import env

# Assign Flask App Name
app = Flask('__name__')

# Setup Environment Variables
app.config['MONGO_DBNAME'] = os.environ.get('MONGO_DBNAME')
app.config['MONGO_URI'] = os.environ.get('MONGO_URI')
app.config['SECRET_KEY'] = os.environ.get('SECRET_KEY')

# Define global Variables
mongo = PyMongo(app)
users = mongo.db.users
gear = mongo.db.gear
categories = mongo.db.categories

# Index gear collection for search
gear.create_index([('model', 'text'), ('brand', 'text'),
                   ('description', 'text'),
                   ('category_name', 'text')])


@app.route('/')
def index():
    """
    Collects featured posts,
    Collects the most recent gear postings
    Return collections for rendering the landing page
    """

    get_featured_posts = \
        mongo.db.gear.aggregate([{'$match': {'is_featured': True}},
                                {'$sample': {'size': 3}}])
    gear_sorted = gear.find().sort('datecreated', -1).limit(6)
    return render_template('index.html',
                           rdm_feat=list(get_featured_posts),
                           gear_collection=list(gear_sorted),
                           categories=list(categories.find()))


@app.route('/', methods=['POST'])
def search():
    """
    Search functionality to search through the gear database
    Model-Name, Brand-Name, Description & Category are indexed for search
    If nothing is found the template responses accordingly
    """

    search_this_string = request.form['search']
    cursor = gear.find({'$text': {'$search': search_this_string}})
    return render_template('searchresults.html', result=list(cursor),
                           categories=list(categories.find()))


@app.route('/signup', methods=['POST', 'GET'])
def signup():
    """
    Handles the registration of a user
    Checks if chosen username is already taken
    Encryptes the password before storing it to the Database
    Sets the username for the session for future identification
    """

    created_on = date.today()
    if request.method == 'POST':
        existing_user = users.find_one({
                                       'name': request.form['username']})

        if existing_user is None:
            hashpass = bcrypt.hashpw(request.form['pass'].encode('utf-8'),
                                     bcrypt.gensalt())
            users.insert_one({
                'name': request.form['username'],
                'password': hashpass,
                'date_registered': created_on.isoformat(),
                'is_admin': False,
                })
            session['username'] = request.form['username']
            return redirect(url_for('index'))
        else:
            flash('... your chosen username already exists! Try another one.'
                  )
            return render_template('signup.html',
                                   categories=list(categories.find()))
    return render_template('signup.html',
                           categories=list(categories.find()))


@app.route('/login', methods=['POST', 'GET'])
def login():
    """
    Checks if user is already logged in
    Gets the username from the html form
    Checks if the entered Password is correct
    Give feedback if it fails
    Otherwise user will be forwarded to index page
    """

    if 'username' in session:
        return redirect(url_for('index'))

    if request.method == 'POST':
        login_user = users.find_one({'name': request.form['username']})

        if login_user:
            if bcrypt.hashpw(request.form['pass'].encode('utf-8'),
                             login_user['password']) \
                             == login_user['password']:
                session['username'] = request.form['username']
                return redirect(url_for('index'))
            else:
                flash('... it seems like you entered the wrong password'
                      )
                return redirect(url_for('login'))

        flash('... are you sure thats your username?')
        return redirect(url_for('login'))
    return render_template('login.html',
                           categories=list(categories.find()))


@app.route('/logout')
def logout():
    """
    Removes the username from the session
    https://stackoverflow.com/questions/27747578/how-do-i-clear-a-flask-session
    """
    if 'username' in session:
        session.pop('username', None)
        return redirect(url_for('login'))
    return redirect(url_for('index'))


@app.route('/myprofile/<user>')
def myprofile(user):
    """
    Collects the profile data of current user
    user is taken from session.username
    To render the my profile page
    """

    if 'username' in session:
        if session['username'] == user:
            myprofile = users.find_one({'name': user})
            user_postings = gear.find({'author': user})
            total_posts = user_postings.count()
            return render_template('myprofile.html',
                                   myprofile=myprofile,
                                   user_post=list(user_postings),
                                   total_posts=total_posts,
                                   categories=list(categories.find()))
            return redirect(url_for('index'))
    return redirect(url_for('index'))


@app.route('/delete_account/<user_id>')
def delete_account(user_id):
    """
    User can delete their account
    Only the account but not the posts are removed
    Accounts can only be removed by the current user
    """

    if 'username' in session:
        if session['username'] \
                == users.find_one({'_id': ObjectId(user_id)})['name']:
            del_acc = users.find_one({'_id': ObjectId(user_id),
                                     'name': session['username']})
            if del_acc:
                session.pop('username', None)
                users.delete_one({'_id': ObjectId(user_id)})
                return redirect(url_for('index'))
        return redirect(url_for('index'))
    return redirect(url_for('index'))


@app.route('/get_gear')
def get_gear():
    """
    Collects all postings from the database
    Which are used to render the gear postings gallery
    """

    return render_template('gallery.html', gear_collection=gear.find(),
                           categories=list(categories.find()))


@app.route('/gear_details/<gear_id>')
def gear_details(gear_id):
    """
    Collects necessary information from gear collection
    to render the gear details page
    gear_id is taken from gear._id
    """

    gear_details = gear.find_one({'_id': ObjectId(gear_id)})
    return render_template('gear_details.html',
                           gear_details=gear_details,
                           categories=list(categories.find()))


@app.route('/browsecategory/<category>/')
def browsecategory(category):
    """
    Get all gear posting
    which belong to a certain category
    To render a category specific
    Overview of postings
    """

    h2_title = category
    category_posts = gear.find({'category_name': category})
    return render_template('browsecategory.html', h2_title=h2_title,
                           post_by_category=list(category_posts),
                           categories=list(categories.find()))


@app.route('/add_gear')
def add_gear():
    """
    Collects the gear categories for the Dropdown Menu
    """

    return render_template('add_gear.html',
                           category_sel=categories.find(),
                           categories=list(categories.find()))


@app.route('/insert_gear', methods=['POST'])
def insert_gear():
    """
    Insertion of new document to gear collection
    Input taken from form, session and date function
    """

    created_on = date.today()
    new_doc = {
        'datecreated': created_on.isoformat(),
        'model': request.form.get('model'),
        'brand': request.form.get('brand'),
        'category_name': request.form.get('category_name'),
        'description': request.form.get('description'),
        'score': request.form.get('score'),
        'img_url': request.form.get('img_url'),
        'is_featured': False,
        'author': session['username'],
        }
    gear.insert_one(new_doc)
    return redirect(url_for('get_gear'))


@app.route('/edit_gear/<gear_id>')
def edit_gear(gear_id):
    """
    Collects necessary information from gear collection
    to render and inject the edit page
    gear_id is taken from gear._id
    """

    the_gear = gear.find_one({'_id': ObjectId(gear_id)})
    all_categories = categories.find()
    return render_template('edit_gear.html', gear=the_gear,
                           category_sel=all_categories,
                           categories=list(categories.find()))


@app.route('/update_gear/<gear_id>', methods=['POST'])
def update_gear(gear_id):
    """
    Writes changes from edit page into the chose document
    from the gear collection
    Keeps basic data alive
    """

    date_created = \
        gear.find_one({'_id': ObjectId(gear_id)})['datecreated']
    is_featured = \
        gear.find_one({'_id': ObjectId(gear_id)})['is_featured']
    author = gear.find_one({'_id': ObjectId(gear_id)})['author']
    gear.update({'_id': ObjectId(gear_id)}, {
        'datecreated': date_created,
        'model': request.form.get('model'),
        'brand': request.form.get('brand'),
        'category_name': request.form.get('category_name'),
        'description': request.form.get('description'),
        'score': request.form.get('score'),
        'img_url': request.form.get('img_url'),
        'is_featured': is_featured,
        'author': author,
        })

    return redirect(url_for('get_gear'))


@app.route('/delete_gear/<gear_id>')
def delete_gear(gear_id):
    """
    Removes specific document from collection by
    _id
    """

    gear.delete_one({'_id': ObjectId(gear_id)})
    return redirect(url_for('get_gear'))


@app.route('/about')
def about():
    """
    Render about page
    """

    return render_template('about.html',
                           categories=list(categories.find()))


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