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

Pierre Dittgen's avatar
Pierre Dittgen committed
13
from commonmark import commonmark
Pierre Dittgen's avatar
Pierre Dittgen committed
14
from flask import Flask, jsonify, redirect, render_template, request, url_for
15

16
import tabulator
Pierre Dittgen's avatar
Pierre Dittgen committed
17
from validata_ui import app
18
19
20
21
22
from validata_ui.util import (ValidataSource, flash_error, flash_info,
                              flash_success, flash_warning)
from validata_ui.validate_helper import ValidatorHelper
from validata_validate import csv_helpers
from validata_validate.loaders import custom_loaders
23

24
25

def extract_source_data(source: ValidataSource, preview_rows_nb=5):
26
    """ Computes table preview """
27
28
29

    def stringify(val):
        """ Transform value into string """
Pierre Dittgen's avatar
Pierre Dittgen committed
30
        return '' if val is None else str(val)
31

32
33
    header = None
    rows = []
Pierre Dittgen's avatar
Pierre Dittgen committed
34
    nb_rows = 0
35

36
    options = {}
37
    if source.format == "csv":
38
39
        options['delimiter'] = csv_helpers.detect_dialect(source.data, format=source.format, scheme=source.scheme,
                                                          custom_loaders=custom_loaders).delimiter
40
    with tabulator.Stream(source.data, format=source.format, scheme=source.scheme, custom_loaders=custom_loaders,
41
                          **options) as stream:
42
43
        for row in stream:
            if header is None:
44
                header = ['' if v is None else v for v in row]
45
            else:
46
                rows.append(list(map(stringify, row)))
Pierre Dittgen's avatar
Pierre Dittgen committed
47
                nb_rows += 1
48
    preview_rows_nb = min(preview_rows_nb, nb_rows)
49
50
    return {'header': header,
            'rows_nb': nb_rows,
51
52
53
            'data_rows': rows,
            'preview_rows_nb': preview_rows_nb,
            'preview_rows': rows[:preview_rows_nb]}
54
55


Pierre Dittgen's avatar
Pierre Dittgen committed
56
57
def improve_errors(errors):
    """Add context to errors, converts markdown content to HTML"""
58

Pierre Dittgen's avatar
Pierre Dittgen committed
59
60
    def improve_err(err):
        """Adds context info based on row-nb presence and converts content to HTML"""
61

Pierre Dittgen's avatar
Pierre Dittgen committed
62
63
64
65
        # Context
        update_keys = {
            'context': 'body' if 'row-number' in err and not err['row-number'] is None else 'table',
        }
Pierre Dittgen's avatar
Pierre Dittgen committed
66

Pierre Dittgen's avatar
Pierre Dittgen committed
67
        # markdown to HTML (with default values for 'title' and 'content')
Pierre Dittgen's avatar
Pierre Dittgen committed
68

Pierre Dittgen's avatar
Pierre Dittgen committed
69
70
71
        # Set default title if no title
        if not 'title' in err:
            update_keys['title'] = '[{}]'.format(err['code'])
Pierre Dittgen's avatar
Pierre Dittgen committed
72

Pierre Dittgen's avatar
Pierre Dittgen committed
73
74
75
76
        # Convert message to markdown only if no content
        # => for pre-checks errors
        if 'message' in err and not 'content' in err:
            update_keys['message'] = commonmark(err['message'])
Pierre Dittgen's avatar
Pierre Dittgen committed
77

Pierre Dittgen's avatar
Pierre Dittgen committed
78
79
80
        # Else, default message
        elif not 'message' in err or err['message'] is None:
            update_keys['message'] = '[{}]'.format(err['code'])
Pierre Dittgen's avatar
Pierre Dittgen committed
81

Pierre Dittgen's avatar
Pierre Dittgen committed
82
83
84
        # Message content
        md_content = '*content soon available*' if not 'content' in err else err['content']
        update_keys['content'] = commonmark(md_content)
85

Pierre Dittgen's avatar
Pierre Dittgen committed
86
        return {**err, **update_keys}
87

Pierre Dittgen's avatar
Pierre Dittgen committed
88
    return list(map(improve_err, errors))
89
90


91
def create_validata_report(goodtables_report, schema):
92
93
94
95
96
97
    """ 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"
98
        - error messages are improved
99
100
101
102
103
104
105
106
107
108
109
    """
    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']
110
111
112
    # use _ instead of - to ease information picking in jinja2 template
    report['table']['row_count'] = report['table']['row-count']

Pierre Dittgen's avatar
Pierre Dittgen committed
113
114
115
116
    # Handy col_count info
    headers = report['table'].get('headers', [])
    report['table']['col_count'] = len(headers)

Pierre Dittgen's avatar
Pierre Dittgen committed
117
    # Computes column info
118
    schema_fields = schema.get('fields', [])
Pierre Dittgen's avatar
Pierre Dittgen committed
119
120
121
122
    fields_dict = {f['name']: (f.get('title', 'titre non défini'), f.get('description', '')) for f in schema_fields}
    report['table']['headers_title'] = [fields_dict[h][0] if h in fields_dict else 'colonne inconnue' for h in headers]
    report['table']['headers_description'] = [fields_dict[h][1]
                                              if h in fields_dict else 'Cette colonne n\'est pas définie dans le schema' for h in headers]
123

124
    # Provide better (french) messages
Pierre Dittgen's avatar
Pierre Dittgen committed
125
126
    errors = improve_errors(report['table']['errors'])
    del report['table']['errors']
127

128
129
130
131
132
133
134
135
136
137
138
139
    # 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)

Pierre Dittgen's avatar
Pierre Dittgen committed
140
    # Checks if there are structure errors different to invalid-column-delimiter
141
142
143
    report['table']['display_body_errors'] = all(err['code'] == 'invalid-column-delimiter'
                                                 for err in report['table']['errors']['structure'])

Pierre Dittgen's avatar
Pierre Dittgen committed
144
145
146
147
    # Group body errors by row id
    rows = []
    current_row_id = 0
    for err in report['table']['errors']['body']:
148
149
        if not 'row-number' in err:
            print('ERR', err)
Pierre Dittgen's avatar
Pierre Dittgen committed
150
151
152
153
154
155
156
157
158
159
160
161
162
        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': {}})

        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
Pierre Dittgen's avatar
Pierre Dittgen committed
163
    report['table']['errors']['body_by_rows'] = rows
Pierre Dittgen's avatar
Pierre Dittgen committed
164
165
166
167

    return report


168
def validate(schema_code, source: ValidataSource):
169
170
    """ Validate source and display report """

Pierre Dittgen's avatar
Pierre Dittgen committed
171
172
173
174
175
    try:
        goodtables_report = ValidatorHelper.validate(schema_code, **source.get_goodtables_source())
    except tabulator.exceptions.FormatError:
        flash_error('Erreur : format de fichier non supporté')
        return redirect(url_for('scdl_validator', val_code=schema_code))
176
177

    source_data = extract_source_data(source)
178

179
    validata_report = create_validata_report(goodtables_report, ValidatorHelper.schema(schema_code))
180

181
    # return jsonify(validata_report)
Pierre Dittgen's avatar
Pierre Dittgen committed
182

Pierre Dittgen's avatar
Pierre Dittgen committed
183
184
    # Complete report
    val_info = ValidatorHelper.schema_info(schema_code)
185
    return render_template('validation_report.html', title='Rapport de validation',
186
                           val_info=ValidatorHelper.schema_info(schema_code), report=validata_report,
187
                           validation_date=datetime.now().strftime('le %d/%m/%Y à %Hh%M'),
188
                           source=source, source_type=source.type, source_data=source_data,
189
                           report_str=json.dumps(validata_report, sort_keys=True, indent=2),
Pierre Dittgen's avatar
Pierre Dittgen committed
190
                           breadcrumbs=[{'url': url_for('home'), 'title': 'Accueil'},
Pierre Dittgen's avatar
Pierre Dittgen committed
191
192
                                        {'url': url_for('scdl_validator', val_code=schema_code),
                                         'title': val_info['title']}])
193
194


195
196
197
198
199
200
201
202
def bytes_data(f):
    """ Gets bytes data from Werkzeug FileStorage instance """
    iob = BytesIO()
    f.save(iob)
    iob.seek(0)
    return iob.getvalue()


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()
Pierre Dittgen's avatar
Pierre Dittgen committed
210
    flash_warning('Ce service est fourni en mode beta - certains problèmes peuvent subsister - nous mettons tout en œuvre pour améliorer son fonctionnement en continu')
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
    return render_template('home.html', title='Accueil', validators=validators)


@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
230
        val_info = ValidatorHelper.schema_info(val_code)
231
232
233
234
        input_param = request.args.get('input')

        # First form display
        if input_param is None or input_param not in ('url', 'example'):
235
            return render_template('validation_form.html', title=val_info['title'],
236
237
238
239
240
241
242
243
244
                                   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))
245
            return validate(val_code, ValidataSource(url, url, 'url'))
246
247
248
249

    else:  # POST
        input_param = request.form.get('input')
        if input_param is None:
Pierre Dittgen's avatar
Pierre Dittgen committed
250
            flash_error('Aucun fichier à valider')
251
252
253
254
255
256
257
258
            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))
259
260

            return validate(val_code, ValidataSource(bytes_data(f), f.filename, 'file'))
261
262

        return 'Bizarre, vous avez dit bizarre ?'