views.py 8.51 KB
Newer Older
1 2 3 4
#!/usr/bin/env python3
"""
    Routes
"""
5
import copy
6 7 8 9 10 11 12
import json
import os
from collections import OrderedDict
from pathlib import Path

from validata_ui_next import app
from validata_ui_next.util import flash_error, flash_info, flash_success, flash_warning
13
from validata_ui_next.validate_helper import ValidatorHelper
14

Pierre Dittgen's avatar
Pierre Dittgen committed
15
from flask import Flask, jsonify, redirect, render_template, request, url_for
16 17 18
import tabulator


19
def extract_source_data(source, preview_rows_nb=5):
20
    """ Computes table preview """
21 22 23 24 25 26 27

    def stringify(val):
        """ Transform value into string """
        if val is None:
            return ''
        return str(val)

28 29
    header = None
    rows = []
Pierre Dittgen's avatar
Pierre Dittgen committed
30
    nb_rows = 0
31 32 33 34 35
    with tabulator.Stream(source) as stream:
        for row in stream:
            if header is None:
                header = row
            else:
36
                rows.append(list(map(stringify, row)))
Pierre Dittgen's avatar
Pierre Dittgen committed
37
                nb_rows += 1
38 39 40 41
    return {'header': header,
            'data_rows': rows,
            'rows_nb': nb_rows,
            'preview_rows_nb': min(preview_rows_nb, nb_rows)}
42 43


Pierre Dittgen's avatar
Pierre Dittgen committed
44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
ERR_CODE_TO_CONTEXT = dict([
    # TODO: gets it from spec.json
    ('duplicate-header', 'head'),
    ('extra-value', 'body'),
    ('missing-value', 'body'),
    ('source-error', 'table'),
    ('schema-error', 'table'),
    ('non-matching-header', 'head'),
    ('blank-row', 'body'),
    ('blank-header', 'head'),
    ('enumerable-constraint', 'body'),
    ('http-error', 'table'),
    ('scheme-error', 'table'),
    ('type-or-format-error', 'body'),
    ('format-error', 'table'),
    ('extra-header', 'head'),
    ('pattern-constraint', 'body'),
    ('required-constraint', 'body'),
    ('missing-header', 'head'),
    ('maximum-length-constraint', 'body'),
    ('maximum-constraint', 'body'),
    ('minimum-length-constraint', 'body'),
    ('encoding-error', 'table'),
    ('io-error', 'table'),
    ('unique-constraint', 'body'),
    ('duplicate-row', 'body'),
    ('minimum-constraint', 'body'),

    # TODO: get it from validata_validate
73
    ('invalid-column-delimiter', 'table')
Pierre Dittgen's avatar
Pierre Dittgen committed
74 75 76 77 78

    # Custom checks fall in default case: body
])


79 80 81 82 83 84 85 86 87 88 89 90 91 92
def improve_messages(errors):
    """ Translates and improve error messages """

    def update_message(error, new_message):
        """ set a new error message """

        # Stores previous message if exists
        if 'message' in error:
            error['_original_message'] = error['message']
        error['message'] = new_message

    for error in errors:

        if error['code'] == 'blank-row':
Pierre Dittgen's avatar
Pierre Dittgen committed
93 94
            update_message(error, 'la ligne est vide')

95
        elif error['code'] == 'duplicate-row':
Pierre Dittgen's avatar
Pierre Dittgen committed
96 97 98 99 100 101 102 103 104
            msg_prefix = 'la ligne est identique '
            row_numbers = error['message-data']['row_numbers']
            if len(row_numbers) == 1:
                msg = msg_prefix + "à la ligne {}".format(row_numbers)
            else:
                idx = row_numbers.rfind(',')
                param_str = row_numbers[:idx] + ' et' + row_numbers[idx+1:]
                msg = msg_prefix + "aux lignes {}".format(param_str)
            update_message(error, msg)
105 106 107 108 109

    # Return updated error list
    return errors


110
def contextualize(errors):
Pierre Dittgen's avatar
Pierre Dittgen committed
111 112
    """ add context to errors """

113 114 115 116 117 118 119 120 121 122
    return [{**err, 'context': ERR_CODE_TO_CONTEXT.get(err['code'], 'body')} for err in errors]


def create_validata_report(goodtables_report):
    """ Creates an error report easier to handle and display in templates:
        - only one table
        - errors are contextualized
        - error-counts is ok
        - errors are grouped by lines
        - errors are separated into "structure" and "body"
123
        - error messages are improved
124 125 126 127 128 129 130 131 132 133 134
    """
    report = copy.deepcopy(goodtables_report)

    # One table is enough
    del report['table-count']
    report['table'] = report['tables'][0]
    del report['tables']
    del report['table']['error-count']
    del report['table']['time']
    del report['table']['valid']
    del report['valid']
135 136 137 138 139
    # use _ instead of - to ease information picking in jinja2 template
    report['table']['row_count'] = report['table']['row-count']

    # Shortcut
    report['table']['col_count'] = len(report['table']['headers'])
140 141 142 143 144

    # Add context to errors
    errors = contextualize(report['table']['errors'])
    del report['table']['errors']

145 146 147
    # Provide better (french) messages
    errors = improve_messages(errors)

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
    # Count errors
    report['error_count'] = len(errors)
    del report['error-count']

    # Then group them in 2 groups : structure and body
    report['table']['errors'] = {'structure': [], 'body': []}
    for err in errors:
        if err['context'] != 'body':
            report['table']['errors']['structure'].append(err)
        else:
            report['table']['errors']['body'].append(err)

    # and group body errors by row id
    rows = []
    current_row_id = 0
    for err in report['table']['errors']['body']:
        row_id = err['row-number']
        del err['row-number']
        del err['context']
        if row_id != current_row_id:
            current_row_id = row_id
            rows.append({'row_id': current_row_id, 'errors': {}})
170 171 172 173 174 175 176

        column_id = err.get('column-number')
        if column_id is not None:
            del err['column-number']
            rows[-1]['errors'][column_id] = err
        else:
            rows[-1]['errors']['row'] = err
177
    report['table']['errors']['by_rows'] = rows
Pierre Dittgen's avatar
Pierre Dittgen committed
178 179 180 181

    return report


182 183 184
def validate(schema_code, source, source_type):
    """ Validate source and display report """

185 186 187 188
    goodtables_report = ValidatorHelper.validate(schema_code, source, source_type)

    validata_report = create_validata_report(goodtables_report)

189
    # return jsonify(validata_report)
Pierre Dittgen's avatar
Pierre Dittgen committed
190

191
    source_data = extract_source_data(source)
192

Pierre Dittgen's avatar
Pierre Dittgen committed
193 194
    # Complete report
    val_info = ValidatorHelper.schema_info(schema_code)
195
    return render_template('validation_report.html', title='Rapport de validation',
196
                           val_info=ValidatorHelper.schema_info(schema_code), report=validata_report,
197
                           source=source, source_type=source_type, source_data=source_data,
198
                           report_str=json.dumps(validata_report, sort_keys=True, indent=2),
Pierre Dittgen's avatar
Pierre Dittgen committed
199 200
                           breadcrumbs=[{'url': url_for('home'), 'title': 'Accueil'},
                                        {'url': url_for('scdl_validator', val_code=schema_code), 'title': val_info['title']}])
201 202 203 204 205 206 207 208


# Routes


@app.route('/')
def home():
    """ Home page """
Pierre Dittgen's avatar
Pierre Dittgen committed
209
    validators = ValidatorHelper.schema_info_list()
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
    return render_template('home.html', title='Accueil', validators=validators)


@app.route('/about')
def about():
    """ Help -> About page """
    return render_template('about.html', title='À propos',
                           breadcrumbs=[{'url': url_for('home'), 'title': 'Accueil'}, ])


@app.route('/validators')
def validators():
    """ No validators page """
    return redirect(url_for('home'))


@app.route('/validators/<val_code>', methods=['GET', 'POST'])
def scdl_validator(val_code):
    """ Validator page """

    if not ValidatorHelper.schema_exist(val_code):
        flash_error('Validateur [{}] inconnu'.format(val_code))
        return redirect(url_for('home'))

    if request.method == 'GET':

Pierre Dittgen's avatar
Pierre Dittgen committed
236
        val_info = ValidatorHelper.schema_info(val_code)
237 238 239 240 241 242 243 244 245 246 247 248 249 250
        input_param = request.args.get('input')

        # First form display
        if input_param is None or input_param not in ('url', 'example'):
            return render_template('validator.html', title=val_info['title'],
                                   val_info=val_info,
                                   breadcrumbs=[{'url': url_for('home'), 'title': 'Accueil'}, ])

        # Process URL
        else:
            url = request.args.get('url')
            if url is None or url == '':
                flash_error("Vous n'avez pas indiqué d'url à valider")
                return redirect(url_for('scdl_validator', val_code=val_code))
Pierre Dittgen's avatar
Pierre Dittgen committed
251
            return validate(val_code, url, 'url')
252 253 254 255 256 257 258 259 260 261 262 263 264

    else:  # POST
        input_param = request.form.get('input')
        if input_param is None:
            flash_error('Source non définie')
            return redirect(url_for('scdl_validator', val_code=val_code))

        # File validation
        if input_param == 'file':
            f = request.files.get('file')
            if f is None:
                flash_warning("Vous n'avez pas indiqué de fichier à valider")
                return redirect(url_for('scdl_validator', val_code=val_code))
Pierre Dittgen's avatar
Pierre Dittgen committed
265 266 267
            fpath = os.path.join('/tmp', f.filename)
            f.save(fpath)
            return validate(val_code, fpath, 'file')
268 269

        return 'Bizarre, vous avez dit bizarre ?'