views.py 22.5 KB
Newer Older
1 2 3
"""
    Routes
"""
4
import copy
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
5
import io
Pierre Dittgen's avatar
Pierre Dittgen committed
6
import itertools
7
import json
Christophe Benz's avatar
Christophe Benz committed
8
import logging
9
import subprocess
Christophe Benz's avatar
Christophe Benz committed
10
import tempfile
11
from datetime import datetime
12
from operator import itemgetter
13
from pathlib import Path
14
from urllib.parse import quote_plus, urlencode
15

Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
16
import requests
17
import tableschema
18
import tabulator
19
from backports.datetime_fromisoformat import MonkeyPatch
20
from commonmark import commonmark
21
from flask import abort, make_response, redirect, render_template, request, url_for
Pierre Dittgen's avatar
Pierre Dittgen committed
22
from validata_core import messages
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
23

24 25 26
from opendataschema import GitSchemaReference

from . import app, config, schema_catalog_map, tableschema_from_url
27
from .ui_util import flash_error, flash_warning
28
from .validata_util import UploadedFileValidataResource, URLValidataResource, ValidataResource
29

30 31
MonkeyPatch.patch_fromisoformat()

Christophe Benz's avatar
Christophe Benz committed
32 33
log = logging.getLogger(__name__)

34

35 36 37 38 39 40 41 42 43 44 45 46 47 48
class SchemaInstance:
    """Handy class to handle schema information"""

    def __init__(self, parameter_dict, schema_catalog_map):
        """Initializes schema instance from requests dict and tableschema catalog (for name ref)"""
        self.section_name = None
        self.section_title = None
        self.name = None
        self.url = None
        self.ref = None
        self.reference = None
        self.doc_url = None
        self.branches = None
        self.tags = None
49 50

        # From schema_url
Christophe Benz's avatar
Christophe Benz committed
51
        if parameter_dict.get("schema_url"):
52 53
            self.url = parameter_dict["schema_url"]
            self.section_title = "Autre schéma"
54 55

        # from schema_name (and schema_ref)
Christophe Benz's avatar
Christophe Benz committed
56
        elif parameter_dict.get('schema_name'):
57 58
            self.schema_and_section_name = parameter_dict['schema_name']
            self.ref = parameter_dict.get('schema_ref')
59

Pierre Dittgen's avatar
Pierre Dittgen committed
60
            # Check schema name
61
            chunks = self.schema_and_section_name.split('.')
Pierre Dittgen's avatar
Pierre Dittgen committed
62
            if len(chunks) != 2:
63
                abort(400, "Paramètre 'schema_name' invalide")
Pierre Dittgen's avatar
Pierre Dittgen committed
64

65 66
            self.section_name, self.name = chunks
            self.section_title = self.find_section_title(self.section_name)
Pierre Dittgen's avatar
Pierre Dittgen committed
67 68

            # Look for schema catalog first
69
            table_schema_catalog = schema_catalog_map.get(self.section_name)
Pierre Dittgen's avatar
Pierre Dittgen committed
70
            if table_schema_catalog is None:
71 72 73 74 75 76 77
                abort(400, "Section '{}' non trouvée dans la configuration".format(self.section_name))

            schema_reference = table_schema_catalog.reference_by_name.get(self.name)
            if schema_reference is None:
                abort(400, "Schéma '{}' non trouvé dans le catalogue de la section '{}'".format(self.name, self.section_name))

            self.doc_url = schema_reference.doc_url
Pierre Dittgen's avatar
Pierre Dittgen committed
78

79 80 81 82 83 84 85 86 87 88 89
            if isinstance(schema_reference, GitSchemaReference):
                if self.ref is None:
                    schema_ref = schema_reference.get_latest_tag() or schema_reference.get_default_branch()
                    abort(redirect(compute_validation_form_url({
                        'schema_name': self.schema_and_section_name,
                        'schema_ref': schema_ref.name
                    })))
                self.tags = list(schema_reference.iter_tags())
                tag_names = [tag.name for tag in self.tags]
                self.branches = [branch for branch in schema_reference.iter_branches()
                                 if branch.name not in tag_names]
90

91
            self.url = schema_reference.get_schema_url(ref=self.ref)
92 93

        else:
94 95
            # Neither schema_name or schema_url were given.
            abort(400, "L'un des paramètres est nécessaire : 'schema_name', 'schema_url'")
96

97 98 99 100 101 102 103 104 105 106
        try:
            self.schema = tableschema_from_url(self.url)
        except json.JSONDecodeError as e:
            log.exception(e)
            flash_error("Format de schéma non reconnu")
            abort(redirect(url_for('home')))
        except Exception as e:
            log.exception(e)
            flash_error("Erreur lors de l'obtention du schéma")
            abort(redirect(url_for('home')))
107 108 109 110

    def request_parameters(self):
        if self.name:
            return {
111
                'schema_name': self.schema_and_section_name,
112 113 114 115 116 117
                'schema_ref': '' if self.ref is None else self.ref
            }
        return {
            'schema_url': self.url
        }

118
    def find_section_title(self, section_name):
Christophe Benz's avatar
Christophe Benz committed
119 120 121 122 123 124
        if config.HOMEPAGE_CONFIG:
            for section in config.HOMEPAGE_CONFIG['sections']:
                if section["name"] == section_name:
                    return section.get("title")
        return None

125

126
def extract_source_data(source: ValidataResource, preview_rows_nb=5):
127
    """ Computes table preview """
128 129 130

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

133 134
    header = None
    rows = []
Pierre Dittgen's avatar
Pierre Dittgen committed
135
    nb_rows = 0
136

137
    tabulator_source, tabulator_options = source.build_tabulator_stream_args()
Pierre Dittgen's avatar
Pierre Dittgen committed
138
    with tabulator.Stream(tabulator_source, **tabulator_options) as stream:
139 140
        for row in stream:
            if header is None:
141
                header = ['' if v is None else v for v in row]
142
            else:
143
                rows.append(list(map(stringify, row)))
Pierre Dittgen's avatar
Pierre Dittgen committed
144
                nb_rows += 1
145
    preview_rows_nb = min(preview_rows_nb, nb_rows)
146 147
    return {'header': header,
            'rows_nb': nb_rows,
148 149 150
            'data_rows': rows,
            'preview_rows_nb': preview_rows_nb,
            'preview_rows': rows[:preview_rows_nb]}
151 152


Pierre Dittgen's avatar
Pierre Dittgen committed
153 154
def improve_errors(errors):
    """Add context to errors, converts markdown content to HTML"""
155

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

Pierre Dittgen's avatar
Pierre Dittgen committed
159 160 161 162
        # 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
163

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

Pierre Dittgen's avatar
Pierre Dittgen committed
166 167 168
        # Set default title if no title
        if not 'title' in err:
            update_keys['title'] = '[{}]'.format(err['code'])
Pierre Dittgen's avatar
Pierre Dittgen committed
169

Pierre Dittgen's avatar
Pierre Dittgen committed
170 171 172 173
        # 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
174

Pierre Dittgen's avatar
Pierre Dittgen committed
175 176 177
        # 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
178

Pierre Dittgen's avatar
Pierre Dittgen committed
179 180 181
        # Message content
        md_content = '*content soon available*' if not 'content' in err else err['content']
        update_keys['content'] = commonmark(md_content)
182

Pierre Dittgen's avatar
Pierre Dittgen committed
183
        return {**err, **update_keys}
184

Pierre Dittgen's avatar
Pierre Dittgen committed
185
    return list(map(improve_err, errors))
186 187


Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
188
def create_validata_ui_report(validata_core_report, schema_dict):
189 190 191 192 193 194
    """ 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"
195
        - error messages are improved
196
    """
Pierre Dittgen's avatar
Pierre Dittgen committed
197
    report = copy.deepcopy(validata_core_report)
198 199 200 201 202 203 204 205 206

    # 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']
207 208 209
    # 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
210 211 212 213
    # Handy col_count info
    headers = report['table'].get('headers', [])
    report['table']['col_count'] = len(headers)

Pierre Dittgen's avatar
Pierre Dittgen committed
214
    # Computes column info
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
215 216
    fields_dict = {f['name']: (f.get('title', 'titre non défini'), f.get('description', ''))
                   for f in schema_dict.get('fields', [])}
Pierre Dittgen's avatar
Pierre Dittgen committed
217 218 219
    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]
220

221
    # Provide better (french) messages
Pierre Dittgen's avatar
Pierre Dittgen committed
222 223
    errors = improve_errors(report['table']['errors'])
    del report['table']['errors']
224

225 226 227 228 229 230 231
    # 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:
232
        if err['tag'] == 'structure':
233 234 235 236
            report['table']['errors']['structure'].append(err)
        else:
            report['table']['errors']['body'].append(err)

Pierre Dittgen's avatar
Pierre Dittgen committed
237
    # Checks if there are structure errors different to invalid-column-delimiter
Pierre Dittgen's avatar
Pierre Dittgen committed
238 239 240
    structure_errors = report['table']['errors']['structure']
    report['table']['do_display_body_errors'] = len(structure_errors) == 0 or \
        all(err['code'] == 'invalid-column-delimiter' for err in structure_errors)
241

Pierre Dittgen's avatar
Pierre Dittgen committed
242 243 244 245 246 247 248 249
    # Checks if a column comparison is needed
    header_errors = ('missing-headers', 'extra-headers', 'wrong-headers-order')
    structure_errors = [{**err, 'in_column_comp': err['code'] in header_errors} for err in structure_errors]
    report['table']['errors']['structure'] = structure_errors
    column_comparison_needed = any(err['in_column_comp'] == True for err in structure_errors)
    column_comparison_table = []
    if column_comparison_needed:
        column_comparison_table = []
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
250
        field_names = [f['name'] for f in schema_dict.get('fields', [])]
251
        has_case_errors = False
Pierre Dittgen's avatar
Pierre Dittgen committed
252 253
        for t in itertools.zip_longest(headers, field_names, fillvalue=''):
            status = 'ok' if t[0] == t[1] else 'ko'
254 255
            if not has_case_errors and status == 'ko' and t[0].lower() == t[1].lower():
                has_case_errors = True
Pierre Dittgen's avatar
Pierre Dittgen committed
256
            column_comparison_table.append((*t, status))
257 258 259 260 261
        info = {}
        info['table'] = column_comparison_table
        info['has_missing'] = len(headers) < len(field_names)
        info['has_case_errors'] = has_case_errors
        report['table']['column_comparison_info'] = info
Pierre Dittgen's avatar
Pierre Dittgen committed
262 263
    report['table']['column_comparison_needed'] = column_comparison_needed

Pierre Dittgen's avatar
Pierre Dittgen committed
264 265 266 267
    # Group body errors by row id
    rows = []
    current_row_id = 0
    for err in report['table']['errors']['body']:
268 269
        if not 'row-number' in err:
            print('ERR', err)
Pierre Dittgen's avatar
Pierre Dittgen committed
270 271 272 273 274 275 276 277 278 279 280 281 282
        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
283
    report['table']['errors']['body_by_rows'] = rows
Pierre Dittgen's avatar
Pierre Dittgen committed
284

285 286 287 288 289 290
    # Sort by error names in statistics
    stats = report['table']['error-stats']
    code_title_map = messages.ERROR_MESSAGE_DEFAULT_TITLE
    for key in ('structure-errors', 'value-errors'):
        # convert dict into tuples with french title instead of error code
        # and sorts by title
Christophe Benz's avatar
Christophe Benz committed
291 292
        stats[key]['count-by-code'] = sorted(((code_title_map.get(k, k), v)
                                              for k, v in stats[key]['count-by-code'].items()), key=itemgetter(0))
293

Pierre Dittgen's avatar
Pierre Dittgen committed
294 295 296
    return report


Pierre Dittgen's avatar
Pierre Dittgen committed
297 298 299 300 301 302 303
def compute_badge_message_and_color(badge):
    """Computes message and color from badge information"""
    structure = badge['structure']
    body = badge.get('body')

    # Bad structure, stop here
    if structure == 'KO':
304
        return ('structure invalide', 'red')
Pierre Dittgen's avatar
Pierre Dittgen committed
305 306 307 308 309 310

    # No body error
    if body == 'OK':
        return ('structure invalide', 'orange') if structure == 'WARN' else ('valide', 'green')

    # else compute quality ratio percent
Christophe Benz's avatar
Christophe Benz committed
311
    p = (1 - badge['error-ratio']) * 100.0
Pierre Dittgen's avatar
Pierre Dittgen committed
312 313 314 315 316 317 318 319
    msg = 'cellules valides : {:.1f}%'.format(p)
    return (msg, 'red') if body == 'KO' else (msg, 'orange')


def get_badge_url_and_message(badge):
    """Gets badge url from badge information"""

    msg, color = compute_badge_message_and_color(badge)
320 321
    return ('{}static/v1.svg?label=Validata&message={}&color={}'.format(
        config.SHIELDS_IO_BASE_URL, quote_plus(msg), color), msg)
Pierre Dittgen's avatar
Pierre Dittgen committed
322 323


324
def validate(schema_instance: SchemaInstance, source: ValidataResource):
325 326
    """ Validate source and display report """

327
    # Useful to receive response as JSON
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
328 329
    headers = {"Accept": "application/json"}

Pierre Dittgen's avatar
Pierre Dittgen committed
330
    try:
331
        if source.type == 'url':
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
332
            params = {
333
                "schema": schema_instance.url,
334
                "url": source.url,
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
335
            }
336
            response = requests.get(config.API_VALIDATE_ENDPOINT, params=params, headers=headers)
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
337
        else:
338
            files = {'file': (source.filename, source.build_reader())}
339
            data = {"schema": schema_instance.url}
340
            response = requests.post(config.API_VALIDATE_ENDPOINT, data=data, files=files, headers=headers)
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
341 342
    except requests.ConnectionError as err:
        logging.exception(err)
Christophe Benz's avatar
Christophe Benz committed
343
        flash_error("Erreur technique lors de la validation")
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
344
        return redirect(url_for('home'))
345

346 347 348
    if not response.ok:
        flash_error("Erreur technique lors de la validation")
        return redirect(compute_validation_form_url(schema_instance.request_parameters()))
349

350
    json_response = response.json()
351
    validata_core_report = json_response['report']
Pierre Dittgen's avatar
Pierre Dittgen committed
352
    badge_info = json_response.get('badge')
353

Pierre Dittgen's avatar
Pierre Dittgen committed
354
    # Computes badge from report and badge configuration
Pierre Dittgen's avatar
Pierre Dittgen committed
355 356 357 358
    badge_url, badge_msg = None, None
    display_badge = badge_info and config.SHIELDS_IO_BASE_URL
    if display_badge:
        badge_url, badge_msg = get_badge_url_and_message(badge_info)
Pierre Dittgen's avatar
Pierre Dittgen committed
359

360 361 362 363 364
    source_errors = [
        err
        for err in validata_core_report['tables'][0]['errors']
        if err['code'] in {'source-error', 'unknown-csv-dialect'}
    ]
365 366 367 368 369
    if source_errors:
        err = source_errors[0]
        msg = "l'encodage du fichier est invalide. Veuillez le corriger" if 'charmap' in err[
            'message'] else err['message']
        flash_error('Erreur de source : {}'.format(msg))
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
370
        return redirect(url_for('custom_validator'))
371

372
    source_data = extract_source_data(source)
373

Pierre Dittgen's avatar
Pierre Dittgen committed
374
    # handle report date
375
    report_datetime = datetime.fromisoformat(validata_core_report['date']).astimezone()
376

Pierre Dittgen's avatar
Pierre Dittgen committed
377
    # Enhance validata_core_report
Pierre Dittgen's avatar
Pierre Dittgen committed
378
    validata_report = create_validata_ui_report(validata_core_report, schema_instance.schema.descriptor)
Pierre Dittgen's avatar
Pierre Dittgen committed
379

Pierre Dittgen's avatar
Pierre Dittgen committed
380
    # Display report to the user
381
    validator_form_url = compute_validation_form_url(schema_instance.request_parameters())
Christophe Benz's avatar
Christophe Benz committed
382
    schema_info = compute_schema_info(schema_instance.schema, schema_instance.url)
383 384
    pdf_report_url = url_for('pdf_report') + '?' + urlencode(schema_instance.request_parameters())

Christophe Benz's avatar
Christophe Benz committed
385
    return render_template('validation_report.html',
386 387 388 389 390 391 392 393 394
                           badge_msg=badge_msg,
                           badge_url=badge_url,
                           breadcrumbs=[
                               {'title': 'Accueil', 'url': url_for('home')},
                               {'title': schema_instance.section_title},
                               {'title': schema_info['title'], 'url': validator_form_url},
                               {'title': 'Rapport de validation'},
                           ],
                           display_badge=display_badge,
395
                           doc_url=schema_instance.doc_url,
396
                           pdf_report_url=pdf_report_url,
397
                           print_mode=request.args.get('print', 'false') == 'true',
398
                           report_str=json.dumps(validata_report, sort_keys=True, indent=2),
399 400 401
                           report=validata_report,
                           schema_current_version=schema_instance.ref,
                           schema_info=schema_info,
Christophe Benz's avatar
Christophe Benz committed
402
                           section_title=schema_instance.section_title,
403 404 405 406
                           source_data=source_data,
                           source=source,
                           validation_date=report_datetime.strftime('le %d/%m/%Y à %Hh%M'),
                           )
407 408


409 410
def bytes_data(f):
    """ Gets bytes data from Werkzeug FileStorage instance """
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
411
    iob = io.BytesIO()
412 413 414 415 416
    f.save(iob)
    iob.seek(0)
    return iob.getvalue()


417
def homepage_config_with_schema_metadata(ui_config, schema_catalog_map):
Pierre Dittgen's avatar
Pierre Dittgen committed
418 419 420 421 422
    """Replace catalog url within ui_config by schema references
    containing schema metadata properties"""

    extended_ui_config = ui_config.copy()
    for section in extended_ui_config['sections']:
Christophe Benz's avatar
Christophe Benz committed
423 424
        section_name = section['name']
        if section_name not in schema_catalog_map:
Pierre Dittgen's avatar
Pierre Dittgen committed
425
            continue
Christophe Benz's avatar
Christophe Benz committed
426
        schema_catalog = schema_catalog_map[section_name]
Pierre Dittgen's avatar
Pierre Dittgen committed
427 428 429
        schema_list = []
        for ref in schema_catalog.references:
            # Loads default table schema for each schema reference
430
            table_schema = tableschema_from_url(ref.get_schema_url())
Pierre Dittgen's avatar
Pierre Dittgen committed
431
            schema_list.append({
Christophe Benz's avatar
Christophe Benz committed
432
                'name': '{}.{}'.format(section_name, ref.name),
Pierre Dittgen's avatar
Pierre Dittgen committed
433 434 435 436 437
                # Extracts title, description, ...
                **extract_schema_metadata(table_schema)
            })
        section['catalog'] = schema_list
    return extended_ui_config
438

439 440 441 442 443 444
# Routes


@app.route('/')
def home():
    """ Home page """
445
    home_config = homepage_config_with_schema_metadata(config.HOMEPAGE_CONFIG, schema_catalog_map)
Christophe Benz's avatar
Christophe Benz committed
446
    return render_template('home.html', config=home_config)
447 448


Pierre Dittgen's avatar
Pierre Dittgen committed
449 450
@app.route('/pdf')
def pdf_report():
451
    """PDF report generation"""
452
    err_prefix = 'Erreur de génération du rapport PDF'
453 454 455

    url_param = request.args.get('url')
    if not url_param:
456
        flash_error(err_prefix + ' : URL non fournie')
Pierre Dittgen's avatar
Pierre Dittgen committed
457
        return redirect(url_for('home'))
458

459
    schema_instance = SchemaInstance(request.args, schema_catalog_map)
Pierre Dittgen's avatar
Pierre Dittgen committed
460

461 462 463 464 465 466 467 468 469 470 471
    # Compute pdf url report
    base_url = url_for('custom_validator', _external=True)
    parameter_dict = {
        'input': 'url',
        'print': 'true',
        'url': url_param,
        **schema_instance.request_parameters()
    }
    validation_url = base_url + '?' + urlencode(parameter_dict)

    # Create temp file to save validation report
Pierre Dittgen's avatar
Pierre Dittgen committed
472
    with tempfile.NamedTemporaryFile(prefix='validata_{}_report_'.format(datetime.now().timestamp()), suffix='.pdf') as tmpfile:
Christophe Benz's avatar
Christophe Benz committed
473
        tmp_pdf_report = Path(tmpfile.name)
474

475
    # Use chromium headless to generate PDF from validation report page
476 477 478 479
    cmd = ['chromium', '--headless', '--disable-gpu',
           '--print-to-pdf={}'.format(str(tmp_pdf_report)), validation_url]
    result = subprocess.run(cmd, stdout=subprocess.PIPE, stderr=subprocess.STDOUT)
    if result.returncode != 0:
480 481
        flash_error(err_prefix)
        log.error("Command %r returned an error: %r", cmd, result.stdout.decode('utf-8'))
482 483
        if tmp_pdf_report.exists():
            tmp_pdf_report.unlink()
Pierre Dittgen's avatar
Pierre Dittgen committed
484
        return redirect(url_for('home'))
485

486
    # Send PDF report
Pierre Dittgen's avatar
Pierre Dittgen committed
487
    pdf_filename = 'Rapport de validation {}.pdf'.format(datetime.now().strftime('%d-%m-%Y %Hh%M'))
Christophe Benz's avatar
Christophe Benz committed
488
    response = make_response(tmp_pdf_report.read_bytes())
Pierre Dittgen's avatar
Pierre Dittgen committed
489
    response.headers.set('Content-disposition', 'attachment', filename=pdf_filename)
490 491 492 493 494 495 496 497
    response.headers.set('Content-type', 'application/pdf')
    response.headers.set('Content-length', tmp_pdf_report.stat().st_size)

    tmp_pdf_report.unlink()

    return response


Pierre Dittgen's avatar
Pierre Dittgen committed
498 499 500 501 502
def extract_schema_metadata(table_schema: tableschema.Schema):
    """Gets author, contibutor, version...metadata from schema header"""
    return {k: v for k, v in table_schema.descriptor.items() if k != 'fields'}


Pierre Dittgen's avatar
Pierre Dittgen committed
503
def compute_schema_info(table_schema: tableschema.Schema, schema_url):
Pierre Dittgen's avatar
Pierre Dittgen committed
504
    """Factor code for validator form page"""
505

Pierre Dittgen's avatar
Pierre Dittgen committed
506 507
    # Schema URL + schema metadata info
    schema_info = {
Christophe Benz's avatar
Christophe Benz committed
508 509 510
        'path': schema_url,
        # a "path" metadata property can be found in Table Schema, and we'd like it to override the `schema_url`
        # given by the user (in case schema was given by URL)
Pierre Dittgen's avatar
Pierre Dittgen committed
511 512
        **extract_schema_metadata(table_schema)
    }
Christophe Benz's avatar
Christophe Benz committed
513
    return schema_info
514 515


516
def compute_validation_form_url(request_parameters: dict):
517 518
    """Computes validation form url with schema URL parameter"""
    url = url_for('custom_validator')
519
    param_list = ['{}={}'.format(k, quote_plus(v)) for k, v in request_parameters.items()]
520
    return "{}?{}".format(url, '&'.join(param_list))
Pierre Dittgen's avatar
Pierre Dittgen committed
521 522


523
@app.route('/table-schema', methods=['GET', 'POST'])
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
524
def custom_validator():
525
    """Validator form"""
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
526 527 528

    if request.method == 'GET':

529 530
        # input is a hidden form parameter to know
        # if this is the initial page display or if the validation has been asked for
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
531
        input_param = request.args.get('input')
532 533

        # url of resource to be validated
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
534 535
        url_param = request.args.get("url")

536
        schema_instance = SchemaInstance(request.args, schema_catalog_map)
Pierre Dittgen's avatar
Pierre Dittgen committed
537

Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
538 539
        # First form display
        if input_param is None:
Christophe Benz's avatar
Christophe Benz committed
540 541 542
            schema_info = compute_schema_info(schema_instance.schema, schema_instance.url)
            return render_template('validation_form.html',
                                   schema_info=schema_info,
543 544
                                   branches=schema_instance.branches,
                                   tags=schema_instance.tags,
Pierre Dittgen's avatar
Pierre Dittgen committed
545
                                   schema_current_version=schema_instance.ref,
546
                                   doc_url=schema_instance.doc_url,
547
                                   schema_params=schema_instance.request_parameters(),
Christophe Benz's avatar
Christophe Benz committed
548 549 550 551 552 553
                                   section_title=schema_instance.section_title,
                                   breadcrumbs=[
                                       {'url': url_for('home'), 'title': 'Accueil'},
                                       {'title': schema_instance.section_title},
                                       {'title': schema_info['title']},
                                   ])
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
554 555 556

        # Process URL
        else:
557
            if not url_param:
Christophe Benz's avatar
Christophe Benz committed
558
                flash_error("Vous n'avez pas indiqué d'URL à valider")
559 560 561 562 563 564
                return redirect(compute_validation_form_url(schema_instance.request_parameters()))
            return validate(schema_instance, URLValidataResource(url_param))

    elif request.method == 'POST':

        schema_instance = SchemaInstance(request.form, schema_catalog_map)
Pierre Dittgen's avatar
Pierre Dittgen committed
565 566 567 568

        input_param = request.form.get('input')
        if input_param is None:
            flash_error("Vous n'avez pas indiqué de fichier à valider")
569
            return redirect(compute_validation_form_url(schema_instance.request_parameters()))
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
570 571 572 573 574 575

        # 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")
576
                return redirect(compute_validation_form_url(schema_instance.request_parameters()))
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
577

578
            return validate(schema_instance, UploadedFileValidataResource(f.filename, bytes_data(f)))
Pierre Dittgen's avatar
wip  
Pierre Dittgen committed
579

580 581 582 583
        return 'Combinaison de paramètres non supportée', 400

    else:
        return "Method not allowed", 405