__init__.py 3.19 KB
Newer Older
Pierre Dittgen's avatar
Pierre Dittgen committed
1
import json
Christophe Benz's avatar
Christophe Benz committed
2
import logging
3
import os
4
import re
5
from pathlib import Path
6
from urllib.parse import quote_plus
7

8
import cachecontrol
9 10
import flask
import jinja2
11
import pkg_resources
12 13
import requests
import tableschema
Pierre Dittgen's avatar
Pierre Dittgen committed
14
from commonmark import commonmark
15

16 17
import opendataschema

18
from . import config
19

Christophe Benz's avatar
Christophe Benz committed
20 21
log = logging.getLogger(__name__)

22 23 24
distribution = pkg_resources.get_distribution("validata-ui")
VERSION = distribution.version

25

26 27 28
def generate_schema_from_url_func(session):
    """Generates a function that encloses session"""

29 30 31 32 33
    def tableschema_from_url(url):
        response = session.get(url)
        response.raise_for_status()
        descriptor = response.json()
        return tableschema.Schema(descriptor)
34

35 36 37
    return tableschema_from_url


38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55
def is_http_url(ref) -> bool:
    return isinstance(ref, str) and re.match("https?://", ref)


class SchemaCatalogRegistry:
    """Retain section_name -> catalog url matching
    and creates SchemaCatalog instance on demand"""

    def __init__(self, session):
        self.session = session
        self.url_map = {}

    def add_ref(self, name, url):
        self.url_map[name] = url

    def build_schema_catalog(self, name):
        if name in self.url_map:
            catalog_url = self.url_map[name]
56 57 58 59 60 61
            try:
                catalog = opendataschema.SchemaCatalog(catalog_url, session=self.session)
            except requests.exceptions.RequestException as exc:
                log.exception(exc)
                return None
            return catalog
62 63 64
        return None


65 66
caching_session = cachecontrol.CacheControl(requests.Session())
tableschema_from_url = generate_schema_from_url_func(caching_session)
67

68
# And load schema catalogs which URLs are found in homepage_config.json
69
schema_catalog_registry = SchemaCatalogRegistry(caching_session)
70
if config.HOMEPAGE_CONFIG:
Christophe Benz's avatar
Christophe Benz committed
71
    log.info("Initializing homepage sections...")
72
    for section in config.HOMEPAGE_CONFIG['sections']:
Christophe Benz's avatar
Christophe Benz committed
73 74
        name = section['name']
        log.info('Initializing homepage section "{}"...'.format(name))
75 76 77
        catalog_ref = section.get('catalog')
        if is_http_url(catalog_ref):
            schema_catalog_registry.add_ref(name, catalog_ref)
78
    log.info("...done")
79 80

# Flask things
81
app = flask.Flask(__name__)
82 83
app.secret_key = config.SECRET_KEY

Christophe Benz's avatar
Christophe Benz committed
84 85 86 87 88
matomo = None
if config.MATOMO_AUTH_TOKEN and config.MATOMO_BASE_URL and config.MATOMO_SITE_ID:
    from flask_matomo import Matomo
    matomo = Matomo(app, matomo_url=config.MATOMO_BASE_URL,
                    id_site=config.MATOMO_SITE_ID, token_auth=config.MATOMO_AUTH_TOKEN)
89

90 91 92 93
# Jinja2 url_quote_plus custom filter
# https://stackoverflow.com/questions/12288454/how-to-import-custom-jinja2-filters-from-another-file-and-using-flask
blueprint = flask.Blueprint('filters', __name__)

94

95 96 97 98 99 100
@jinja2.contextfilter
@blueprint.app_template_filter()
def urlencode(context, value):
    return quote_plus(value)


Pierre Dittgen's avatar
Pierre Dittgen committed
101 102 103 104 105 106 107 108 109
@jinja2.contextfilter
@blueprint.app_template_filter()
def commonmark2html(context, value):
    return commonmark(value)


app.register_blueprint(blueprint)


110 111
@app.context_processor
def inject_version():
112
    global VERSION
113 114 115
    return {"validata_ui_version": VERSION}


116
# Keep this import after app initialisation (to avoid cyclic imports)
117
from . import views  # noqa isort:skip