Blame view

flaskr/controllers/main_controller.py 24.9 KB
3ac083cb   Antoine Goutenoir   Add more details ...
1
import traceback
b935618e   Antoine Goutenoir   Count the number ...
2
3
from copy import deepcopy

314c65e2   Antoine Goutenoir   Implement Scenari...
4
5
import geopy
import sqlalchemy
51f564d3   Antoine Goutenoir   Add a big chunk o...
6

a4c03d8e   Antoine Goutenoir   Add the controlle...
7
from flask import Blueprint, render_template, flash, request, redirect, \
67f85bce   Antoine Goutenoir   Generate a CSV fi...
8
    url_for, abort, send_from_directory, Response
461850db   Antoine Goutenoir   Yet another joyfu...
9
from os.path import join
7b4d2926   Goutte   Rework the contro...
10

8ae021a2   Antoine Goutenoir   Merge shelved cha...
11
12
from os import unlink

c2a01bd2   Antoine Goutenoir   Prepare mail flas...
13
14
15
from flask_mail import Message

from flaskr.extensions import cache, basic_auth, mail
7b4d2926   Goutte   Rework the contro...
16
from flaskr.forms import LoginForm, EstimateForm
a1f12452   Antoine Goutenoir   Add the new conte...
17
from flaskr.models import db, User, Estimation, StatusEnum, ScenarioEnum
24f55cde   Antoine Goutenoir   Geocode destinati...
18
from flaskr.geocoder import CachedGeocoder
7b4d2926   Goutte   Rework the contro...
19

78eb2a62   Antoine Goutenoir   Use the counter.
20
21
from flaskr.core import generate_unique_id, \
    get_emission_models, increment_hit_counter
51f564d3   Antoine Goutenoir   Add a big chunk o...
22
from flaskr.content import content
7b4d2926   Goutte   Rework the contro...
23

f2fbbb72   Antoine Goutenoir   Display a nice er...
24
25
from wtforms import validators

70aa301f   Antoine Goutenoir   Implement another...
26
27
from yaml import safe_dump as yaml_dump

67f85bce   Antoine Goutenoir   Generate a CSV fi...
28
29
30
import csv
# from io import StringIO
from cStringIO import StringIO
24f55cde   Antoine Goutenoir   Geocode destinati...
31

9e44bb98   Antoine Goutenoir   Support file uplo...
32
33
34
import pandas
from pandas.compat import StringIO as PandasStringIO

7b4d2926   Goutte   Rework the contro...
35
36
37
main = Blueprint('main', __name__)


9621b8a5   Antoine Goutenoir   Fix the CSV gener...
38
39
40
OUT_ENCODING = 'utf-8'


67f85bce   Antoine Goutenoir   Generate a CSV fi...
41
# -----------------------------------------------------------------------------
78eb2a62   Antoine Goutenoir   Use the counter.
42
# -----------------------------------------------------------------------------
67f85bce   Antoine Goutenoir   Generate a CSV fi...
43
44


461850db   Antoine Goutenoir   Yet another joyfu...
45
@main.route('/favicon.ico')
7f7c6b10   Antoine Goutenoir   Disable RFI in th...
46
@cache.cached(timeout=10000)
461850db   Antoine Goutenoir   Yet another joyfu...
47
48
49
50
51
52
53
def favicon():  # we want it served from the root, not from static/
    return send_from_directory(
        join(main.root_path, '..', 'static', 'img'),
        'favicon.ico', mimetype='image/vnd.microsoft.icon'
    )


7b4d2926   Goutte   Rework the contro...
54
@main.route('/')
b0ffb1ba   Antoine Goutenoir   Review actively.
55
56
@main.route('/home')
@main.route('/home.html')
38375935   Antoine Goutenoir   Remove the cache ...
57
# @cache.cached(timeout=1000)
7b4d2926   Goutte   Rework the contro...
58
def home():
4c862b54   Antoine Goutenoir   Add a grouped bar...
59
    models = get_emission_models()
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
60
61
62
    models_dict = {}
    for model in models:
        models_dict[model.slug] = model.__dict__
78eb2a62   Antoine Goutenoir   Use the counter.
63
    increment_hit_counter()
4c862b54   Antoine Goutenoir   Add a grouped bar...
64
65
    return render_template(
        'home.html',
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
66
        models=models_dict,
4c862b54   Antoine Goutenoir   Add a grouped bar...
67
        colors=[model.color for model in models],
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
68
        labels=[model.name for model in models],
4c862b54   Antoine Goutenoir   Add a grouped bar...
69
    )
7b4d2926   Goutte   Rework the contro...
70
71


9e44bb98   Antoine Goutenoir   Support file uplo...
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
def gather_addresses(from_list, from_file):
    addresses = []
    if from_file:
        file_mimetype = from_file.mimetype
        file_contents = from_file.read()

        rows_dicts = None

        if 'text/csv' == file_mimetype:

            rows_dicts = pandas \
                .read_csv(PandasStringIO(file_contents)) \
                .rename(str.lower, axis='columns') \
                .to_dict(orient="row")

        # Here are just *some* of the mimetypes that Microsoft's
        # garbage spreadsheet files may have.
        # application/vnd.ms-excel (official)
        # application/msexcel
        # application/x-msexcel
        # application/x-ms-excel
        # application/x-excel
        # application/x-dos_ms_excel
        # application/xls
        # application/x-xls
        # application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
        # ... Let's check extension instead.

        elif from_file.filename.endswith('xls') \
                or from_file.filename.endswith('xlsx'):

            rows_dicts = pandas \
                .read_excel(PandasStringIO(file_contents)) \
                .rename(str.lower, axis='columns') \
                .to_dict(orient="row")

        # Python 3.7 only
        # elif from_file.filename.endswith('ods'):
        #
        #     rows_dicts = read_ods(PandasStringIO(file_contents), 1) \
        #         .rename(str.lower, axis='columns') \
        #         .to_dict(orient="row")

        if rows_dicts is not None:
            for row_dict in rows_dicts:
                if 'address' in row_dict:
                    addresses.append(row_dict['address'])
                    continue
                address = None
                if 'city' in row_dict:
                    address = row_dict['city']
                if 'country' in row_dict:
                    if address is None:
                        address = row_dict['country']
                    else:
                        address += "," + row_dict['country']
                if address is not None:
                    addresses.append(address)
                else:
f2fbbb72   Antoine Goutenoir   Display a nice er...
131
132
133
                    raise validators.ValidationError(
                        "We could not find Address data in the spreadsheet."
                    )
9e44bb98   Antoine Goutenoir   Support file uplo...
134
        else:
f2fbbb72   Antoine Goutenoir   Display a nice er...
135
136
137
            raise validators.ValidationError(
                "We could not find any data in the spreadsheet."
            )
9e44bb98   Antoine Goutenoir   Support file uplo...
138
139
140
141

    else:
        addresses = from_list.replace("\r", '').split("\n")

68da7cd4   Antoine Goutenoir   Improve robustnes...
142
143
144
145
146
147
148
149
150
151
152
153
    clean_addresses = []
    for address in addresses:
        if not address:
            continue
        elif type(address).__name__ == 'str':
            clean_addresses.append(unicode(address, 'utf-8'))
        else:
            clean_addresses.append(address)
    addresses = clean_addresses

    # Remove empty lines (if any) and white characters
    addresses = [a.strip() for a in addresses if a]
8ec0ce68   Antoine Goutenoir   Improve robustnes...
154

9e44bb98   Antoine Goutenoir   Support file uplo...
155
156
157
    return "\n".join(addresses)


7b4d2926   Goutte   Rework the contro...
158
@main.route("/estimate", methods=["GET", "POST"])
b0ffb1ba   Antoine Goutenoir   Review actively.
159
@main.route("/estimate.html", methods=["GET", "POST"])
7b4d2926   Goutte   Rework the contro...
160
def estimate():
77e86148   Antoine Goutenoir   Fake support for ...
161
    models = get_emission_models()
7b4d2926   Goutte   Rework the contro...
162
163
    form = EstimateForm()

f2fbbb72   Antoine Goutenoir   Display a nice er...
164
165
166
    def show_form():
        return render_template("estimate.html", form=form, models=models)

7b4d2926   Goutte   Rework the contro...
167
168
    if form.validate_on_submit():

7b4d2926   Goutte   Rework the contro...
169
        estimation = Estimation()
a4c03d8e   Antoine Goutenoir   Add the controlle...
170
        # estimation.email = form.email.data
8ae021a2   Antoine Goutenoir   Merge shelved cha...
171
        estimation.run_name = form.run_name.data
7b4d2926   Goutte   Rework the contro...
172
173
        estimation.first_name = form.first_name.data
        estimation.last_name = form.last_name.data
16f69d07   Antoine Goutenoir   Add an (unsecured...
174
        estimation.institution = form.institution.data
24f55cde   Antoine Goutenoir   Geocode destinati...
175
        estimation.status = StatusEnum.pending
f2fbbb72   Antoine Goutenoir   Display a nice er...
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194

        try:
            estimation.origin_addresses = gather_addresses(
                form.origin_addresses.data,
                form.origin_addresses_file.data
            )
        except validators.ValidationError as e:
            form.origin_addresses_file.errors.append(e.message)
            return show_form()

        try:
            estimation.destination_addresses = gather_addresses(
                form.destination_addresses.data,
                form.destination_addresses_file.data
            )
        except validators.ValidationError as e:
            form.destination_addresses_file.errors.append(e.message)
            return show_form()

4276f1aa   Antoine Goutenoir   Support train emi...
195
        estimation.use_train_below_km = form.use_train_below_km.data
f2fbbb72   Antoine Goutenoir   Display a nice er...
196

77e86148   Antoine Goutenoir   Fake support for ...
197
198
        models_slugs = []
        for model in models:
35fbac1f   Antoine Goutenoir   Fix a blooper.
199
            if getattr(form, 'use_model_%s' % model.slug).data:
77e86148   Antoine Goutenoir   Fake support for ...
200
                models_slugs.append(model.slug)
6b9c0dd2   Antoine Goutenoir   Force Unicode.
201
        estimation.models_slugs = u"\n".join(models_slugs)
7b4d2926   Goutte   Rework the contro...
202
203
204
205
206

        db.session.add(estimation)
        db.session.commit()

        flash("Estimation request submitted successfully.", "success")
a4c03d8e   Antoine Goutenoir   Add the controlle...
207
208
209
        return redirect(url_for(
            endpoint=".consult_estimation",
            public_id=estimation.public_id,
91751451   Antoine Goutenoir   Shift the API to ...
210
            extension='html'
a4c03d8e   Antoine Goutenoir   Add the controlle...
211
        ))
7b4d2926   Goutte   Rework the contro...
212
213
        # return render_template("estimate-debrief.html", form=form)

f2fbbb72   Antoine Goutenoir   Display a nice er...
214
    return show_form()
7b4d2926   Goutte   Rework the contro...
215

4392f295   Goutte   Update the Estima...
216

15e57dca   Antoine Goutenoir   Naming things and...
217
@main.route("/invalidate")
4276f1aa   Antoine Goutenoir   Support train emi...
218
@main.route("/invalidate.html")
15e57dca   Antoine Goutenoir   Naming things and...
219
220
221
222
223
224
225
226
227
228
def invalidate():
    stuck_estimations = Estimation.query \
        .filter_by(status=StatusEnum.working) \
        .all()

    for estimation in stuck_estimations:
        estimation.status = StatusEnum.failure
        estimation.errors = "Invalidated. Try again."
        db.session.commit()

8ae021a2   Antoine Goutenoir   Merge shelved cha...
229
230
231
232
233
234
235
236
237
238
239
    return "Estimations invalidated: %d" % len(stuck_estimations)


@main.route("/invalidate-geocache")
@main.route("/invalidate-geocache.html")
def invalidate_geocache():
    geocache = 'geocache.db'

    unlink(geocache)

    return "Geocache invalidated."
15e57dca   Antoine Goutenoir   Naming things and...
240
241


4392f295   Goutte   Update the Estima...
242
@main.route("/compute")
51f564d3   Antoine Goutenoir   Add a big chunk o...
243
def compute():  # process the queue of estimation requests
24f55cde   Antoine Goutenoir   Geocode destinati...
244

dca2b847   Antoine Goutenoir   Cap the amount of...
245
246
    maximum_addresses_to_compute = 30000

24f55cde   Antoine Goutenoir   Geocode destinati...
247
248
249
250
    def _respond(_msg):
        return "<pre>%s</pre>" % _msg

    def _handle_failure(_estimation, _failure_message):
a4c03d8e   Antoine Goutenoir   Add the controlle...
251
        _estimation.status = StatusEnum.failure
70aa301f   Antoine Goutenoir   Implement another...
252
        _estimation.errors = _failure_message
24f55cde   Antoine Goutenoir   Geocode destinati...
253
254
        db.session.commit()

72460978   Antoine Goutenoir   Use warnings inst...
255
    def _handle_warning(_estimation, _warning_message):
3d8865da   Antoine Goutenoir   Improve warnings ...
256
257
258
        if not _estimation.warnings:
            _estimation.warnings = _warning_message
        else:
ac935afa   Antoine Goutenoir   Make warnings mor...
259
            _estimation.warnings += _warning_message
3d8865da   Antoine Goutenoir   Improve warnings ...
260
261
            # _estimation.warnings = u"%s\n%s" % \
            #                        (_estimation.warnings, _warning_message)
72460978   Antoine Goutenoir   Use warnings inst...
262
263
        db.session.commit()

3d8865da   Antoine Goutenoir   Improve warnings ...
264
    estimation = None
59125398   Antoine Goutenoir   Improve resilience.
265
266
    try:
        response = ""
4392f295   Goutte   Update the Estima...
267

59125398   Antoine Goutenoir   Improve resilience.
268
269
270
        count_working = Estimation.query \
            .filter_by(status=StatusEnum.working) \
            .count()
03c194bf   Antoine Goutenoir   Actually implemen...
271

59125398   Antoine Goutenoir   Improve resilience.
272
273
        if 0 < count_working:
            return _respond("Already working on estimation.")
03c194bf   Antoine Goutenoir   Actually implemen...
274

59125398   Antoine Goutenoir   Improve resilience.
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
        try:
            estimation = Estimation.query \
                .filter_by(status=StatusEnum.pending) \
                .order_by(Estimation.id.asc()) \
                .first()
        except sqlalchemy.orm.exc.NoResultFound:
            return _respond("No estimation in the queue.")
        except Exception as e:
            return _respond("Database error: %s" % (e,))

        if not estimation:
            return _respond("No estimation in the queue.")

        estimation.status = StatusEnum.working
        db.session.commit()
51f564d3   Antoine Goutenoir   Add a big chunk o...
290

59125398   Antoine Goutenoir   Improve resilience.
291
292
293
        response += u"Processing estimation `%s`...\n" % (
            estimation.public_id
        )
24f55cde   Antoine Goutenoir   Geocode destinati...
294

6b9c0dd2   Antoine Goutenoir   Force Unicode.
295
296
        # GEOCODE ADDRESSES ###################################################

59125398   Antoine Goutenoir   Improve resilience.
297
298
        failed_addresses = []
        geocoder = CachedGeocoder()
03c194bf   Antoine Goutenoir   Actually implemen...
299

59125398   Antoine Goutenoir   Improve resilience.
300
        # GEOCODE ORIGINS #########################################################
24f55cde   Antoine Goutenoir   Geocode destinati...
301

59125398   Antoine Goutenoir   Improve resilience.
302
        origins_addresses = estimation.origin_addresses.strip().split("\n")
dca2b847   Antoine Goutenoir   Cap the amount of...
303
        origins_addresses_count = len(origins_addresses)
59125398   Antoine Goutenoir   Improve resilience.
304
        origins = []
24f55cde   Antoine Goutenoir   Geocode destinati...
305

dca2b847   Antoine Goutenoir   Cap the amount of...
306
        if origins_addresses_count > maximum_addresses_to_compute:
3d8865da   Antoine Goutenoir   Improve warnings ...
307
308
309
310
            errmsg = u"Too many origins. (%d > %d) \n" \
                     u"Please contact us " \
                     u"for support of more origins." % \
                     (origins_addresses_count, maximum_addresses_to_compute)
dca2b847   Antoine Goutenoir   Cap the amount of...
311
312
313
314
            _handle_failure(estimation, errmsg)
            return _respond(errmsg)

        for i in range(origins_addresses_count):
51f564d3   Antoine Goutenoir   Add a big chunk o...
315

59125398   Antoine Goutenoir   Improve resilience.
316
            origin_address = origins_addresses[i].strip()
3d8865da   Antoine Goutenoir   Improve warnings ...
317
318
319
320

            if not origin_address:
                continue

59125398   Antoine Goutenoir   Improve resilience.
321
322
            if origin_address in failed_addresses:
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
323

59125398   Antoine Goutenoir   Improve resilience.
324
325
326
            try:
                origin = geocoder.geocode(origin_address.encode('utf-8'))
            except geopy.exc.GeopyError as e:
3d8865da   Antoine Goutenoir   Improve warnings ...
327
328
329
                warning = u"Ignoring origin `%s` " \
                          u"since we failed to geocode it.\n%s\n" % (
                            origin_address, e,
59125398   Antoine Goutenoir   Improve resilience.
330
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
331
332
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
333
334
                failed_addresses.append(origin_address)
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
335

59125398   Antoine Goutenoir   Improve resilience.
336
            if origin is None:
3d8865da   Antoine Goutenoir   Improve warnings ...
337
338
339
                warning = u"Ignoring origin `%s` " \
                          u"since we failed to geocode it.\n" % (
                            origin_address,
59125398   Antoine Goutenoir   Improve resilience.
340
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
341
342
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
343
344
                failed_addresses.append(origin_address)
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
345

59125398   Antoine Goutenoir   Improve resilience.
346
            origins.append(origin)
51f564d3   Antoine Goutenoir   Add a big chunk o...
347

3d8865da   Antoine Goutenoir   Improve warnings ...
348
            response += u"Origin `%s` geocoded to `%s` (%f, %f).\n" % (
59125398   Antoine Goutenoir   Improve resilience.
349
350
                origin_address, origin.address,
                origin.latitude, origin.longitude,
51f564d3   Antoine Goutenoir   Add a big chunk o...
351
            )
51f564d3   Antoine Goutenoir   Add a big chunk o...
352

59125398   Antoine Goutenoir   Improve resilience.
353
        # GEOCODE DESTINATIONS ####################################################
51f564d3   Antoine Goutenoir   Add a big chunk o...
354

59125398   Antoine Goutenoir   Improve resilience.
355
        destinations_addresses = estimation.destination_addresses.strip().split("\n")
dca2b847   Antoine Goutenoir   Cap the amount of...
356
        destinations_addresses_count = len(destinations_addresses)
59125398   Antoine Goutenoir   Improve resilience.
357
        destinations = []
51f564d3   Antoine Goutenoir   Add a big chunk o...
358

dca2b847   Antoine Goutenoir   Cap the amount of...
359
        if destinations_addresses_count > maximum_addresses_to_compute:
3d8865da   Antoine Goutenoir   Improve warnings ...
360
361
362
363
364
365
366
            errmsg = u"Too many destinations. (%d > %d) \n" \
                     u"Please contact us " \
                     u"for support of that many destinations." \
                     % (
                         destinations_addresses_count,
                         maximum_addresses_to_compute,
                     )
dca2b847   Antoine Goutenoir   Cap the amount of...
367
368
369
370
            _handle_failure(estimation, errmsg)
            return _respond(errmsg)

        for i in range(destinations_addresses_count):
51f564d3   Antoine Goutenoir   Add a big chunk o...
371

59125398   Antoine Goutenoir   Improve resilience.
372
            destination_address = destinations_addresses[i].strip()
3d8865da   Antoine Goutenoir   Improve warnings ...
373
374
375
376

            if not destination_address:
                continue

59125398   Antoine Goutenoir   Improve resilience.
377
378
            if destination_address in failed_addresses:
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
379

59125398   Antoine Goutenoir   Improve resilience.
380
381
382
            try:
                destination = geocoder.geocode(destination_address.encode('utf-8'))
            except geopy.exc.GeopyError as e:
3d8865da   Antoine Goutenoir   Improve warnings ...
383
384
385
                warning = u"Ignoring destination `%s` " \
                          u"since we failed to geocode it.\n%s\n" % (
                            destination_address, e,
59125398   Antoine Goutenoir   Improve resilience.
386
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
387
388
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
389
390
                failed_addresses.append(destination_address)
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
391

59125398   Antoine Goutenoir   Improve resilience.
392
            if destination is None:
3d8865da   Antoine Goutenoir   Improve warnings ...
393
394
395
                warning = u"Ignoring destination `%s` " \
                          u"since we failed to geocode it.\n" % (
                            destination_address,
59125398   Antoine Goutenoir   Improve resilience.
396
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
397
398
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
399
400
                failed_addresses.append(destination_address)
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
401

59125398   Antoine Goutenoir   Improve resilience.
402
            # print(repr(destination.raw))
24f55cde   Antoine Goutenoir   Geocode destinati...
403

59125398   Antoine Goutenoir   Improve resilience.
404
405
            destinations.append(destination)

3d8865da   Antoine Goutenoir   Improve warnings ...
406
            response += u"Destination `%s` geocoded to `%s` (%f, %f).\n" % (
59125398   Antoine Goutenoir   Improve resilience.
407
408
                destination_address, destination.address,
                destination.latitude, destination.longitude,
24f55cde   Antoine Goutenoir   Geocode destinati...
409
            )
24f55cde   Antoine Goutenoir   Geocode destinati...
410

8ae021a2   Antoine Goutenoir   Merge shelved cha...
411
412
        geocoder.close()

59125398   Antoine Goutenoir   Improve resilience.
413
        # GTFO IF NO ORIGINS OR NO DESTINATIONS ###################################
314c65e2   Antoine Goutenoir   Implement Scenari...
414

59125398   Antoine Goutenoir   Improve resilience.
415
        if 0 == len(origins):
3d8865da   Antoine Goutenoir   Improve warnings ...
416
            response += u"Failed to geocode ALL the origin(s).\n"
59125398   Antoine Goutenoir   Improve resilience.
417
418
419
            _handle_failure(estimation, response)
            return _respond(response)
        if 0 == len(destinations):
3d8865da   Antoine Goutenoir   Improve warnings ...
420
            response += u"Failed to geocode ALL the destination(s).\n"
59125398   Antoine Goutenoir   Improve resilience.
421
422
            _handle_failure(estimation, response)
            return _respond(response)
24f55cde   Antoine Goutenoir   Geocode destinati...
423

59125398   Antoine Goutenoir   Improve resilience.
424
        # GRAB AND CONFIGURE THE EMISSION MODELS ##################################
24f55cde   Antoine Goutenoir   Geocode destinati...
425

59125398   Antoine Goutenoir   Improve resilience.
426
427
        emission_models = estimation.get_models()
        # print(emission_models)
51f564d3   Antoine Goutenoir   Add a big chunk o...
428

59125398   Antoine Goutenoir   Improve resilience.
429
430
431
432
        extra_config = {
            'use_train_below_distance': estimation.use_train_below_km,
            # 'use_train_below_distance': 300,
        }
70aa301f   Antoine Goutenoir   Implement another...
433

59125398   Antoine Goutenoir   Improve resilience.
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
        # PREPARE RESULT DICTIONARY THAT WILL BE STORED ###########################

        results = {}

        # UTILITY PRIVATE FUNCTION(S) #############################################

        def get_city_key(_location):
            # Will this hack hold?  Suspense...
            return _location.address.split(',')[0]

            # _city_key = _location.address
            # # if 'address100' in _location.raw['address']:
            # #     _city_key = _location.raw['address']['address100']
            # if 'city' in _location.raw['address']:
            #     _city_key = _location.raw['address']['city']
            # elif 'state' in _location.raw['address']:
            #     _city_key = _location.raw['address']['state']
            # return _city_key

        def compute_one_to_many(
                _origin,
                _destinations,
                _extra_config=None
        ):
            _results = {}
            footprints = {}

            destinations_by_city_key = {}

            cities_sum_foot = {}
            cities_sum_dist = {}
            cities_dict_first_model = None
            for model in emission_models:
                cities_dict = {}
                for _destination in _destinations:
                    footprint = model.compute_travel_footprint(
                        origin_latitude=_origin.latitude,
                        origin_longitude=_origin.longitude,
                        destination_latitude=_destination.latitude,
                        destination_longitude=_destination.longitude,
                        extra_config=_extra_config,
                    )
51f564d3   Antoine Goutenoir   Add a big chunk o...
476

59125398   Antoine Goutenoir   Improve resilience.
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
                    _key = get_city_key(_destination)

                    destinations_by_city_key[_key] = _destination

                    if _key not in cities_dict:
                        cities_dict[_key] = {
                            'city': _key,
                            'address': _destination.address,
                            'footprint': 0.0,
                            'distance': 0.0,
                            'train_trips': 0,
                            'plane_trips': 0,
                        }
                    cities_dict[_key]['footprint'] += footprint['co2eq_kg']
                    cities_dict[_key]['distance'] += footprint['distance_km']
                    cities_dict[_key]['train_trips'] += footprint['train_trips']
                    cities_dict[_key]['plane_trips'] += footprint['plane_trips']
                    if _key not in cities_sum_foot:
                        cities_sum_foot[_key] = 0.0
                    cities_sum_foot[_key] += footprint['co2eq_kg']
                    if _key not in cities_sum_dist:
                        cities_sum_dist[_key] = 0.0
                    cities_sum_dist[_key] += footprint['distance_km']

                cities = sorted(cities_dict.values(), key=lambda c: c['footprint'])

                footprints[model.slug] = {
                    'cities': cities,
                }

                if cities_dict_first_model is None:
                    cities_dict_first_model = deepcopy(cities_dict)

            _results['footprints'] = footprints

            total_foot = 0.0
            total_dist = 0.0
            total_train_trips = 0
            total_plane_trips = 0

            cities_mean_dict = {}
            for city in cities_sum_foot.keys():
                city_mean_foot = 1.0 * cities_sum_foot[city] / len(emission_models)
                city_mean_dist = 1.0 * cities_sum_dist[city] / len(emission_models)
                city_train_trips = cities_dict_first_model[city]['train_trips']
                city_plane_trips = cities_dict_first_model[city]['plane_trips']
                cities_mean_dict[city] = {
                    'address': destinations_by_city_key[city].address,
                    'city': city,
                    'footprint': city_mean_foot,
                    'distance': city_mean_dist,
                    'train_trips': city_train_trips,
                    'plane_trips': city_plane_trips,
                }
                total_foot += city_mean_foot
                total_dist += city_mean_dist
                total_train_trips += city_train_trips
                total_plane_trips += city_plane_trips

            cities_mean = [cities_mean_dict[k] for k in cities_mean_dict.keys()]
            cities_mean = sorted(cities_mean, key=lambda c: c['footprint'])

            _results['mean_footprint'] = {  # DEPRECATED?
                'cities': cities_mean
584b13cc   Antoine Goutenoir   Order the results...
541
            }
59125398   Antoine Goutenoir   Improve resilience.
542
            _results['cities'] = cities_mean
1d48272e   Antoine Goutenoir   Compute the mean ...
543

59125398   Antoine Goutenoir   Improve resilience.
544
545
            _results['total'] = total_foot  # DEPRECATED
            _results['footprint'] = total_foot
584b13cc   Antoine Goutenoir   Order the results...
546

59125398   Antoine Goutenoir   Improve resilience.
547
548
549
            _results['distance'] = total_dist
            _results['train_trips'] = total_train_trips
            _results['plane_trips'] = total_plane_trips
70aa301f   Antoine Goutenoir   Implement another...
550

59125398   Antoine Goutenoir   Improve resilience.
551
            return _results
24f55cde   Antoine Goutenoir   Geocode destinati...
552

59125398   Antoine Goutenoir   Improve resilience.
553
554
555
556
557
558
559
560
561
562
563
564
        # SCENARIO A : One Origin, At Least One Destination #######################
        #
        # In this scenario, we compute the sum of each of the travels' footprint,
        # for each of the Emission Models, and present a mean of all Models.
        #
        if 1 == len(origins):
            estimation.scenario = ScenarioEnum.one_to_many
            results = compute_one_to_many(
                _origin=origins[0],
                _destinations=destinations,
                _extra_config=extra_config,
            )
94ae2730   Antoine Goutenoir   Ignore duplicates...
565

59125398   Antoine Goutenoir   Improve resilience.
566
567
568
569
570
571
572
573
        # SCENARIO B : At Least One Origin, One Destination #######################
        #
        # Same as A for now.
        #
        elif 1 == len(destinations):
            estimation.scenario = ScenarioEnum.many_to_one
            results = compute_one_to_many(
                _origin=destinations[0],
314c65e2   Antoine Goutenoir   Implement Scenari...
574
                _destinations=origins,
8a693e06   Antoine Goutenoir   Glue the extra co...
575
                _extra_config=extra_config,
314c65e2   Antoine Goutenoir   Implement Scenari...
576
            )
314c65e2   Antoine Goutenoir   Implement Scenari...
577

59125398   Antoine Goutenoir   Improve resilience.
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
        # SCENARIO C : At Least One Origin, At Least One Destination ##############
        #
        # Run Scenario A for each Destination, and expose optimum Destination.
        #
        else:
            estimation.scenario = ScenarioEnum.many_to_many
            unique_city_keys = []
            result_cities = []
            for destination in destinations:
                city_key = get_city_key(destination)

                if city_key in unique_city_keys:
                    continue
                else:
                    unique_city_keys.append(city_key)
1d48272e   Antoine Goutenoir   Compute the mean ...
593

59125398   Antoine Goutenoir   Improve resilience.
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
                city_results = compute_one_to_many(
                    _origin=destination,
                    _destinations=origins,
                    _extra_config=extra_config,
                )
                city_results['city'] = city_key
                city_results['address'] = destination.address
                result_cities.append(city_results)

            result_cities = sorted(result_cities, key=lambda c: int(c['footprint']))
            results = {
                'cities': result_cities,
            }

        # WRITE RESULTS INTO THE DATABASE #########################################
a4c03d8e   Antoine Goutenoir   Add the controlle...
609

59125398   Antoine Goutenoir   Improve resilience.
610
        estimation.status = StatusEnum.success
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
611
        # estimation.output_yaml = u"%s" % yaml_dump(results)
3d8865da   Antoine Goutenoir   Improve warnings ...
612
        estimation.informations = response
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
613
        estimation.set_output_dict(results)
59125398   Antoine Goutenoir   Improve resilience.
614
615
616
        db.session.commit()

        # FINALLY, RESPOND ########################################################
a4c03d8e   Antoine Goutenoir   Add the controlle...
617

f48f4a8f   Antoine Goutenoir   Optimize a bottle...
618
        # response += yaml_dump(results) + "\n"
a4c03d8e   Antoine Goutenoir   Add the controlle...
619

59125398   Antoine Goutenoir   Improve resilience.
620
        return _respond(response)
4392f295   Goutte   Update the Estima...
621

59125398   Antoine Goutenoir   Improve resilience.
622
    except Exception as e:
e144bb1b   Antoine Goutenoir   Fix encoding.
623
        errmsg = u"Computation failed : %s" % (e,)
ce850e3a   Antoine Goutenoir   Revert traceback.
624
        # errmsg = u"%s\n\n%s" % (errmsg, traceback.format_exc())
59125398   Antoine Goutenoir   Improve resilience.
625
626
627
        if estimation:
            _handle_failure(estimation, errmsg)
        return _respond(errmsg)
a4c03d8e   Antoine Goutenoir   Add the controlle...
628
629


b9fc86c3   Antoine Goutenoir   Secure the admin ...
630
631
@main.route("/estimation/<public_id>.<extension>")
def consult_estimation(public_id, extension):
a4c03d8e   Antoine Goutenoir   Add the controlle...
632
633
634
635
636
637
638
    try:
        estimation = Estimation.query \
            .filter_by(public_id=public_id) \
            .one()
    except sqlalchemy.orm.exc.NoResultFound:
        return abort(404)
    except Exception as e:
59125398   Antoine Goutenoir   Improve resilience.
639
        # TODO: log?
a4c03d8e   Antoine Goutenoir   Add the controlle...
640
641
642
643
644
645
        return abort(500)

    # allowed_formats = ['html']
    # if format not in allowed_formats:
    #     abort(404)

e721cb31   Antoine Goutenoir   Provide a YAML fi...
646
    unavailable_statuses = [StatusEnum.pending, StatusEnum.working]
314c65e2   Antoine Goutenoir   Implement Scenari...
647

b9fc86c3   Antoine Goutenoir   Secure the admin ...
648
    if extension in ['xhtml', 'html', 'htm']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
649
650

        if estimation.status in unavailable_statuses:
a4c03d8e   Antoine Goutenoir   Add the controlle...
651
652
653
654
655
            return render_template(
                "estimation-queue-wait.html",
                estimation=estimation
            )
        else:
40382971   Antoine Goutenoir   Add the sum of es...
656
657
            estimation_output = estimation.get_output_dict()
            estimation_sum = 0
37e28f2c   Antoine Goutenoir   Improve resilience.
658
659
660
            if estimation_output:
                for city in estimation_output['cities']:
                    estimation_sum += city['footprint']
40382971   Antoine Goutenoir   Add the sum of es...
661

a4c03d8e   Antoine Goutenoir   Add the controlle...
662
663
            return render_template(
                "estimation.html",
91751451   Antoine Goutenoir   Shift the API to ...
664
                estimation=estimation,
40382971   Antoine Goutenoir   Add the sum of es...
665
666
                estimation_output=estimation_output,
                estimation_sum=estimation_sum,
a4c03d8e   Antoine Goutenoir   Add the controlle...
667
668
            )

b9fc86c3   Antoine Goutenoir   Secure the admin ...
669
    elif extension in ['yaml', 'yml']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
670
671
672
673

        if estimation.status in unavailable_statuses:
            abort(404)

f48f4a8f   Antoine Goutenoir   Optimize a bottle...
674
675
        return u"%s" % yaml_dump(estimation.get_output_dict())
        # return estimation.output_yaml
e721cb31   Antoine Goutenoir   Provide a YAML fi...
676

b9fc86c3   Antoine Goutenoir   Secure the admin ...
677
    elif 'csv' == extension:
a4c03d8e   Antoine Goutenoir   Add the controlle...
678

e721cb31   Antoine Goutenoir   Provide a YAML fi...
679
680
681
        if estimation.status in unavailable_statuses:
            abort(404)

a4c03d8e   Antoine Goutenoir   Add the controlle...
682
683
        si = StringIO()
        cw = csv.writer(si, quoting=csv.QUOTE_ALL)
b935618e   Antoine Goutenoir   Count the number ...
684
685
686
687
688
        cw.writerow([
            u"city", u"address",
            u"co2 (kg)", u"distance (km)",
            u"plane trips", u'train trips',
        ])
a4c03d8e   Antoine Goutenoir   Add the controlle...
689
690

        results = estimation.get_output_dict()
5634c975   Antoine Goutenoir   Expose travel dis...
691
692
693
694
695
696
        for city in results['cities']:
            cw.writerow([
                city['city'].encode(OUT_ENCODING),
                city['address'].encode(OUT_ENCODING),
                round(city['footprint'], 3),
                round(city['distance'], 3),
b935618e   Antoine Goutenoir   Count the number ...
697
698
                city['plane_trips'],
                city['train_trips'],
5634c975   Antoine Goutenoir   Expose travel dis...
699
700
            ])

67f85bce   Antoine Goutenoir   Generate a CSV fi...
701
702
703
704
705
706
707
708
        # return si.getvalue().strip('\r\n')
        return Response(
            response=si.getvalue().strip('\r\n'),
            headers={
                'Content-type': 'text/csv',
                'Content-disposition': "attachment; filename=%s.csv"%public_id,
            },
        )
a4c03d8e   Antoine Goutenoir   Add the controlle...
709
710
711

    else:
        abort(404)
b9fc86c3   Antoine Goutenoir   Secure the admin ...
712
713


67f85bce   Antoine Goutenoir   Generate a CSV fi...
714
715
@main.route("/scaling_laws.csv")
def get_scaling_laws_csv():
a728e600   Antoine Goutenoir   Allow configurati...
716
    distances = content.laws_plot.distances
67f85bce   Antoine Goutenoir   Generate a CSV fi...
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
    models = get_emission_models()

    si = StringIO()
    cw = csv.writer(si, quoting=csv.QUOTE_ALL)

    header = ['distance'] + [model.slug for model in models]
    cw.writerow(header)

    for distance in distances:
        row = [distance]
        for model in models:
            row.append(model.compute_airplane_distance_footprint(distance))
        cw.writerow(row)

    return Response(
        response=si.getvalue().strip('\r\n'),
        headers={
            'Content-type': 'text/csv',
            'Content-disposition': 'attachment; filename=scaling_laws.csv',
        },
    )


b9fc86c3   Antoine Goutenoir   Secure the admin ...
740
@main.route("/test")
c2a01bd2   Antoine Goutenoir   Prepare mail flas...
741
# @basic_auth.required
b9fc86c3   Antoine Goutenoir   Secure the admin ...
742
743
744
def dev_test():
    import os

c2a01bd2   Antoine Goutenoir   Prepare mail flas...
745
746
747
748
749
750
751
752
753
754
755
756
757
758
    # return os.getenv('ADMIN_USERNAME')


def send_email(to_recipient, subject, message):
    try:
        msg = Message(
            subject=subject,
            html=message,
            sender="bot-noreply@travel-carbon-footprint.irap.omp.eu",
            recipients=[to_recipient],
        )
        mail.send(msg)
    except:
        pass