Skip to content

Latest commit

 

History

History
81 lines (67 loc) · 3.32 KB

helpers_functions.md

File metadata and controls

81 lines (67 loc) · 3.32 KB
Raw

helpers.py

Decorators

admin_only:

admin_only goes before route handler function and prevent access for users that are not administrators, redirects to home page if not admin tries to view the route.

login_required:

login_required goes before route handler function and prevent access of not logged in visitors to the route, redirects to /signin if not logged in.

not_loged_only(f):

not_loged_only goes before route handler and prevents access of logged in users to the route, redirects to home page if logged in

Functions

does_user_exist(login, db_cursor):

does_user_exist checks if login (email) is in database, gets two parameters:

  • login - email, string
  • db_cursor - cursor of connected database. So before using this function a connection to database should be set, Cursor object. The function returns count of login in database: 1 or 0. Query:
"SELECT COUNT (id) FROM users WHERE email=?;", (login,)

get_service_name(is_manicure, is_pedicure):

It returns service name, that is one of the following strings: combo, manicure or pedicure It gets two parameters:

  • is_manicure - 1 or 0, int
  • is_pedicure - 1 or 0, int This values can be found in database table appointments

log_user_in(login, password, cursor):

It checks username and password (hash), logs user in if ok, returns True if ok, returns False if login or password are not correct It gets 3 parameters:

  • login - email, string
  • password - password, string
  • cursor - cursor of connected database. So before using this function a connection to database should be set, Cursor object. When logs user in the following session values are set:
        session["user_id"]
        session["is_admin"]
        session["is_editor"]
        session["name"]
        session["login"]
        session["lang"]
        session["instagram"]
        session["tell"]
        session["is_subscribed"]
        session["avatar"]

As long as Flask-Session extension for Flask is used in the app the Session is Server-side. The data that is required to be saved in the Session is stored in a temporary directory on the server.

log_user_out():

Clears current Session.

page_not_found(e):

It is a error handler for error 404 It is registered

app.register_error_handler(404, page_not_found)

It uses existing template apology.html to show error "404 - page not fond".

validate_recaptcha (token):

It validates Google reCAPTCHA v.2, returns True if reCAPTCHA passed successfully or False if not. It gets one parameter token. Token comes with submitted form where reCAPTCHA was exposed. The function requests secret from environment:

os.environ.get('SECRET_RECAPTCHA')

SECRET_RECAPTCHA variable is declared in .env file.

validate_password (password):

It checks if the password string contains all required symbols and is proper length. It gets one parameter password, string. It returns True if validation passed or False if not.