forms.py

"""
Define the forms used in the views.

Forms are defined using FlaskForm class of Flask-WTF module.
They have several fields defined, and a CSRF token hidden field that is created
automatically.
"""
from flask_wtf import FlaskForm
from wtforms.fields import TextField, BooleanField, PasswordField, RadioField, SubmitField, TextField, IntegerField, TextAreaField
from wtforms.validators import Optional,  Required, Email, EqualTo, Length
from wtforms.widgets.html5 import NumberInput
from flask_uploads import UploadSet, IMAGES
from flask_wtf.file import FileField, FileAllowed, FileRequired

import app



class RequiredIf(Optional, Required):
    """ A validator which makes a field required if
        another field is set and has a truthy value

        Adapted from : http://stackoverflow.com/a/8464478
    """
    def __init__(self, other_field_name, *args, **kwargs):
        self.other_field_name = other_field_name
        super().__init__(*args, **kwargs)

    def __call__(self, form, field):
        # Why use the __call__ special method : http://stackoverflow.com/a/5826283
        other_field = form._fields.get(self.other_field_name)
        if other_field is None:
            raise Exception('no field named "%s" in form' % self.other_field_name)
        if len(other_field.data) != 0:
            Required()(form, field)
        else :
            Optional()(form, field)


class UploadForm(FlaskForm):
    """
    Form for image upload.
    """
    sample = FileField('Sample image file', validators=[
        FileRequired(),
        FileAllowed( app.samples_set, 'Not supported type : jpeg only.')
    ])

    smear_type = RadioField('Blood smear type', choices=[
            ('thick',  'Thick'),
            ('thin',  'Thin')
            ], validators=[Required()] )
    comment = TextAreaField('Comment', render_kw={"placeholder": "URL, legend, etc...", "rows": 3, "cols": 70})
    license = RadioField('License', choices=[
            ('CC0',  'CC0 / Public Domain: Freeing content globally without restrictions'),
            ('BY',  'CC-BY: Attribution')
            ], validators=[Required()], default='BY' )
    provider = TextAreaField('Provider', render_kw={"rows": 3, "cols": 70}, validators=[Required()])
    magnification =IntegerField ('Microscope magnification factor', widget=NumberInput(), render_kw={"placeholder": "e.g. 100"}, validators=[Optional()], default=None )
    patient_ref = TextField('Patient reference', validators=[Length(max=50)])
    patient_year_of_birth = IntegerField ('Patient year of birth', widget=NumberInput(), validators=[RequiredIf('patient_ref')], default=None )
    patient_gender =RadioField('Patient gender', validators=[RequiredIf('patient_ref')], default=None, choices=[
            ('M',  'Male'),
            ('F',  'Female')
    ])
    patient_city = TextField('Patient city', validators=[Length(max=50), RequiredIf('patient_ref')], default=None)
    patient_country = TextField('Patient country', validators=[Length(max=50), RequiredIf('patient_ref')], default=None)

    submit = SubmitField('Upload new blood smear', render_kw={"class": "btn btn-info btn-lg", "id": "submit-button"})


class LoginForm(FlaskForm):
    """
    Form for user login.
    """
    username = TextField('Username', validators=[Required(), Length(min=4, max=80)])
    password = PasswordField('Password', validators=[Required()])
    idle_ttl = RadioField('Idle Session Timeout', default='tmp', choices=[
            ('tmp',  '20 minutes'),
            ('day',  '8 hours (a normal business day)'),
            ('week', '8 days (Monday to Monday)'),
            ])
    submit = SubmitField('Login')


class ProfileForm(FlaskForm):
    """
    For for the user to change infos of his own account.
    """
    email = TextField('Email Adress', validators=[Optional(), Email() ])
    password = PasswordField('New Password', validators=[
            Optional(),
            Length(min=8, max=80),
            EqualTo('confirm', message='Passwords must match')
            ])
    confirm = PasswordField('Repeat Password')

    submit = SubmitField('Update Profile')


class RegisterForm(FlaskForm):
    """
    For for new user registration.
    """
    username = TextField('Username', validators=[Required(), Length(min=8, max=80)])

    email = TextField('Email Address', validators = [Required(), Email()])
    password = PasswordField('New Password', validators=[
            Required(),
            Length(min=8, max=80),
            EqualTo('confirm', message='Passwords must match')
    ])
    confirm = PasswordField('Repeat Password')
    accept_tos = BooleanField('I accept the TOS', validators = [Required()])

    submit = SubmitField('Register')