functions.py

import hashlib
import locale
import math
import os
import re
import pandas as pd
from datetime import datetime
from flask_login import login_required
from fpdf import FPDF


class CertificationPDF(FPDF):
    """
    Class for the PDF to be made
    """
    def header(self):
        pass

    def footer(self):
        pass


def clean_string(text):
    """
    Function to clean strings of invalid filename characters

    :param text: String to be cleaned
    :return: String with invalid filename characters removed
    """
    invalid_characters = '\\/:*?"<>|'
    for ic in invalid_characters:
        text = text.replace(ic, "")
    return text


def build_role(role):
    """
    Function to build the part of the certificate text that
    identifies the type of certificate, if the person was a
    role for the event or not

    :param role: name of the role the person did in the event
    :return: string stating the role the person did
    """
    if role == "ouvinte":
        return ""
    else:
        return " como " + role


def check_hour(hour):
    """
    Function to validate the hour formatting
    :param hour: string to be checked
    :return: True/False depending if the string follows the HHhMM format
    """
    try:
        if re.compile(r"\d{2}h\d{2}").match(hour):
            return True
        else:
            return False
    except ValueError:
        return False


def check_pronoun(pronoun):
    """
    Function to validate the pronoun formatting
    :param pronoun: string to be checked
    :return: True/False depending if the string follows the A/O format
    """
    pronouns = ['a', 'o', 'e', 'x']
    try:
        if not pronoun.lower() in pronouns:
            return False
    except ValueError:
        return False
    return True


def check_date(date_text):
    """
    Function to validate the date formatting
    :param date_text: string to be checked
    :return: True/False depending if the string follows the dd/mm/yyyy format
    """
    try:
        if not pd.isnull(date_text):
            datetime.strptime(date_text, '%d/%m/%Y')
        else:
            return True
    except ValueError:
        return False
    return True


def check_role(role, possible_values):
    """
    Function to validate the role formatting
    :param possible_values: string from the allowed values
    :param role: string to be checked
    :return: True/False depending if the string is among the valid values
    """

    try:
        if role.lower() not in possible_values:
            return False
    except ValueError:
        return False
    return True


def check_columns(table):
    """

    :param table:
    :return:
    """
    columns = ["name", "username", "pronoun", "event", "date_start", "date_end", "hours"]
    for col in columns:
        if col not in list(table.columns):
            return False
    return True


@login_required
def make_pdf_of_user(user, app):
    # Create page
    pdf = CertificationPDF(orientation='L', unit='mm', format='A4')
    pdf.add_page()
    pdf.set_text_color(0, 0, 0)
    pdf.image(os.path.join(app.config['UPLOAD_FOLDER'], user.background), x=0, y=0, w=297, h=210)

    #######################################################################################################
    # Header
    #######################################################################################################
    pdf.set_y(15)  # Start the letter text at the 10x42mm point

    pdf.add_font('Merriweather', '', os.path.join(app.static_folder, 'fonts/Merriweather-Regular.ttf'), uni=True)
    pdf.add_font('Merriweather-Bold', '', os.path.join(app.static_folder, 'fonts/Merriweather-Bold.ttf'), uni=True)
    pdf.set_font('Merriweather', '', 35)  # Text of the body in Times New Roman, regular, 13 pt

    locale.setlocale(locale.LC_TIME, "pt_BR")  # Setting the language to portuguese for the date
    pdf.cell(w=0, h=10, border=0, ln=1, align='C', txt='CERTIFICADO')

    pdf.set_font('Merriweather', '', 13)
    pdf.cell(w=0, h=5, ln=1)  # New line
    pdf.cell(w=0, h=5, border=0, ln=1, align='C', txt='O grupo de usuários Wiki Movimento Brasil '
                                                       '(CNPJ 29.801.908/0001-86) certifica que')
    pdf.cell(w=0, h=5, ln=1)  # New line

    #######################################################################################################
    # User name
    #######################################################################################################
    name = user.name  # User full name
    pdf.set_font('Merriweather', '', 30)
    name_size = pdf.get_string_width(name)

    if name_size > 287:
        # Try to eliminate the prepositions
        name_split = [name_part for name_part in name.split(' ') if not name_part.islower()]
        # There's a first and last names and at least one middle name
        if len(name_split) > 2:
            first_name = name_split[0]
            last_name = name_split[-1]
            middle_names = [md_name[0] + '.' for md_name in name_split[1:-1]]
            name = first_name + ' ' + ' '.join(middle_names) + ' ' + last_name
            name_size = pdf.get_string_width(name)

        # Even abbreviating, there is still the possibility that the name is too big, so
        # we need to adjust it to the proper size
        if name_size > 287:
            pdf.set_font('Merriweather', '', math.floor(287 * 35 / name_size))

    pdf.cell(w=0, h=10, border=0, ln=1, align='C', txt=name)
    pdf.cell(w=0, h=5, ln=1)  # New line

    #######################################################################################################
    # por ter completado as leituras e as 6 tarefas do curso online
    #######################################################################################################
    pdf.set_font('Merriweather', '', 13)
    phrase_participation = "participou" + build_role(user.role) + " do evento"
    pdf.cell(w=0, h=5, border=0, ln=1, align='C', txt=phrase_participation)
    pdf.cell(w=0, h=5, ln=1)  # New line

    #######################################################################################################
    # Introdução ao Jornalismo Científico
    #######################################################################################################
    pdf.set_font('Merriweather-Bold', '', 20)
    pdf.cell(w=0, h=10, border=0, ln=1, align='C', txt=user.event)
    pdf.cell(w=0, h=5, ln=1)  # New line

    #######################################################################################################
    # no dia X/entre os dias X e Y (Carga horária: Z horas)
    #######################################################################################################
    pdf.set_font('Merriweather', '', 13)

    if not user.date_end:
        date = datetime.strptime(user.date_start, "%d/%m/%Y").date()
        phrase_time = "no dia " + date.strftime("%d de %B de %Y") + " (Carga horária: " + user.hours + ")."
    else:
        date_start = datetime.strptime(user.date_start, "%d/%m/%Y").date()
        date_end = datetime.strptime(user.date_end, "%d/%m/%Y").date()

        if date_start.year == date_end.year:
            if date_start.month == date_end.month:
                start_format = "%d"
            else:
                start_format = "%d de %B"
        else:
            start_format = "%d de %B de %Y"

        phrase_time = "entre os dias " + date_start.strftime(start_format) + " e " + \
                      date_end.strftime("%d de %B de %Y") + " (Carga horária: " + user.hours + ")."

    pdf.cell(w=0, h=5, border=0, ln=1, align='C', txt=phrase_time)
    pdf.cell(w=0, h=15, ln=1)  # New line

    y = pdf.get_y()
    pdf.image(os.path.join(app.static_folder, app.config["SIGNATURE"]), x=131, y=y-5, w=35, h=16)
    pdf.cell(w=0, h=5, border=0, ln=1, align='C', txt="______________________")
    pdf.cell(w=0, h=10, border=0, ln=1, align='C', txt="VALÉRIO ANDRADE MELO")
    pdf.set_font('Merriweather', '', 11)
    pdf.cell(w=0, h=5, border=0, ln=1, align='C', txt="Presidente do Wiki Movimento Brasil")

    user_hash = hashlib.sha1(
        bytes("Certificate " + user.name + user.event + user.hours + str(user.role), 'utf-8')).hexdigest()
    pdf.in_footer = 1
    pdf.set_y(-16.5)
    pdf.set_font('Merriweather', '', 8.8)
    pdf.cell(w=0, h=5, border=0, ln=1, align='C',
             txt='A validade deste documento pode ser checada em https://wmb.toolforge.org/. '
                 'O código de validação é:' + user_hash)
    pdf.in_footer = 0

    return pdf