Blame view

flaskr/controllers/main_controller.py 27.5 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

461850db   Antoine Goutenoir   Yet another joyfu...
7
from os.path import join
e2637443   Antoine Goutenoir   Send emails to ad...
8
9
10
11
12
13
14
15
16
17
18
19
20
21
from os import unlink, getenv

from flask import (
    Blueprint,
    Response,
    render_template,
    flash,
    request,
    redirect,
    url_for,
    abort,
    send_from_directory,
)
from flaskr.extensions import cache, basic_auth, mail, send_email
7b4d2926   Goutte   Rework the contro...
22
from flaskr.forms import LoginForm, EstimateForm
a1f12452   Antoine Goutenoir   Add the new conte...
23
from flaskr.models import db, User, Estimation, StatusEnum, ScenarioEnum
24f55cde   Antoine Goutenoir   Geocode destinati...
24
from flaskr.geocoder import CachedGeocoder
7b4d2926   Goutte   Rework the contro...
25

e2637443   Antoine Goutenoir   Send emails to ad...
26
27
28
29
30
from flaskr.core import (
    generate_unique_id,
    get_emission_models,
    increment_hit_counter,
)
07c07af5   Antoine Goutenoir   Add an email temp...
31
from flaskr.content import content, base_url
7b4d2926   Goutte   Rework the contro...
32

f2fbbb72   Antoine Goutenoir   Display a nice er...
33
34
from wtforms import validators

70aa301f   Antoine Goutenoir   Implement another...
35
36
from yaml import safe_dump as yaml_dump

67f85bce   Antoine Goutenoir   Generate a CSV fi...
37
38
39
import csv
# from io import StringIO
from cStringIO import StringIO
24f55cde   Antoine Goutenoir   Geocode destinati...
40

9e44bb98   Antoine Goutenoir   Support file uplo...
41
42
43
import pandas
from pandas.compat import StringIO as PandasStringIO

7b4d2926   Goutte   Rework the contro...
44
45
46
main = Blueprint('main', __name__)


9621b8a5   Antoine Goutenoir   Fix the CSV gener...
47
48
49
OUT_ENCODING = 'utf-8'


67f85bce   Antoine Goutenoir   Generate a CSV fi...
50
# -----------------------------------------------------------------------------
e2637443   Antoine Goutenoir   Send emails to ad...
51

6318fdba   Antoine Goutenoir   Change PI email.
52
pi_email = "didier.barret@gmail.com"  # todo: move to content YAML or .env
3e6505e2   Antoine Goutenoir   Add content to th...
53
# pi_email = "goutte@protonmail.com"
e2637443   Antoine Goutenoir   Send emails to ad...
54

78eb2a62   Antoine Goutenoir   Use the counter.
55
# -----------------------------------------------------------------------------
67f85bce   Antoine Goutenoir   Generate a CSV fi...
56
57


461850db   Antoine Goutenoir   Yet another joyfu...
58
@main.route('/favicon.ico')
7f7c6b10   Antoine Goutenoir   Disable RFI in th...
59
@cache.cached(timeout=10000)
461850db   Antoine Goutenoir   Yet another joyfu...
60
61
62
63
64
65
66
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...
67
@main.route('/')
b0ffb1ba   Antoine Goutenoir   Review actively.
68
69
@main.route('/home')
@main.route('/home.html')
38375935   Antoine Goutenoir   Remove the cache ...
70
# @cache.cached(timeout=1000)
7b4d2926   Goutte   Rework the contro...
71
def home():
4c862b54   Antoine Goutenoir   Add a grouped bar...
72
    models = get_emission_models()
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
73
74
75
    models_dict = {}
    for model in models:
        models_dict[model.slug] = model.__dict__
78eb2a62   Antoine Goutenoir   Use the counter.
76
    increment_hit_counter()
4c862b54   Antoine Goutenoir   Add a grouped bar...
77
78
    return render_template(
        'home.html',
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
79
        models=models_dict,
4c862b54   Antoine Goutenoir   Add a grouped bar...
80
        colors=[model.color for model in models],
a3e9d0fc   Antoine Goutenoir   Fix home plot leg...
81
        labels=[model.name for model in models],
4c862b54   Antoine Goutenoir   Add a grouped bar...
82
    )
7b4d2926   Goutte   Rework the contro...
83
84


9e44bb98   Antoine Goutenoir   Support file uplo...
85
def gather_addresses(from_list, from_file):
04d423cb   Antoine Goutenoir   Limit the amount ...
86
87
88
89
    """
    Gather a list of addresses from the provided list and file.
    If the file is provided the list is ignored.
    """
9e44bb98   Antoine Goutenoir   Support file uplo...
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
    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'):
9e44bb98   Antoine Goutenoir   Support file uplo...
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
        #     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...
147
148
149
                    raise validators.ValidationError(
                        "We could not find Address data in the spreadsheet."
                    )
9e44bb98   Antoine Goutenoir   Support file uplo...
150
        else:
f2fbbb72   Antoine Goutenoir   Display a nice er...
151
152
153
            raise validators.ValidationError(
                "We could not find any data in the spreadsheet."
            )
9e44bb98   Antoine Goutenoir   Support file uplo...
154
155
156
157

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

68da7cd4   Antoine Goutenoir   Improve robustnes...
158
159
160
161
162
163
164
165
166
167
168
169
    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...
170

9e44bb98   Antoine Goutenoir   Support file uplo...
171
172
173
    return "\n".join(addresses)


7b4d2926   Goutte   Rework the contro...
174
@main.route("/estimate", methods=["GET", "POST"])
b0ffb1ba   Antoine Goutenoir   Review actively.
175
@main.route("/estimate.html", methods=["GET", "POST"])
e2637443   Antoine Goutenoir   Send emails to ad...
176
def estimate():  # register new estimation request, more accurately
04d423cb   Antoine Goutenoir   Limit the amount ...
177
    maximum_travels_to_compute = 1000000
77e86148   Antoine Goutenoir   Fake support for ...
178
    models = get_emission_models()
7b4d2926   Goutte   Rework the contro...
179
180
    form = EstimateForm()

f2fbbb72   Antoine Goutenoir   Display a nice er...
181
    def show_form():
cb22e72e   Antoine Goutenoir   Add a Captcha and...
182
        return render_template("request-estimation.html", form=form, models=models)
f2fbbb72   Antoine Goutenoir   Display a nice er...
183

7b4d2926   Goutte   Rework the contro...
184
185
    if form.validate_on_submit():

7b4d2926   Goutte   Rework the contro...
186
        estimation = Estimation()
a4c03d8e   Antoine Goutenoir   Add the controlle...
187
        # estimation.email = form.email.data
8ae021a2   Antoine Goutenoir   Merge shelved cha...
188
        estimation.run_name = form.run_name.data
7b4d2926   Goutte   Rework the contro...
189
190
        estimation.first_name = form.first_name.data
        estimation.last_name = form.last_name.data
16f69d07   Antoine Goutenoir   Add an (unsecured...
191
        estimation.institution = form.institution.data
24f55cde   Antoine Goutenoir   Geocode destinati...
192
        estimation.status = StatusEnum.pending
f2fbbb72   Antoine Goutenoir   Display a nice er...
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

        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...
212
        estimation.use_train_below_km = form.use_train_below_km.data
f2fbbb72   Antoine Goutenoir   Display a nice er...
213

77e86148   Antoine Goutenoir   Fake support for ...
214
        models_slugs = []
04d423cb   Antoine Goutenoir   Limit the amount ...
215
        models_count = 0
77e86148   Antoine Goutenoir   Fake support for ...
216
        for model in models:
35fbac1f   Antoine Goutenoir   Fix a blooper.
217
            if getattr(form, 'use_model_%s' % model.slug).data:
77e86148   Antoine Goutenoir   Fake support for ...
218
                models_slugs.append(model.slug)
04d423cb   Antoine Goutenoir   Limit the amount ...
219
                models_count += 1
6b9c0dd2   Antoine Goutenoir   Force Unicode.
220
        estimation.models_slugs = u"\n".join(models_slugs)
7b4d2926   Goutte   Rework the contro...
221

04d423cb   Antoine Goutenoir   Limit the amount ...
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
        travels_to_compute = \
            models_count * \
            (estimation.origin_addresses.count("\n") + 1) * \
            (estimation.destination_addresses.count("\n") + 1)
        if travels_to_compute > maximum_travels_to_compute:
            message = """
            Too many travels to compute. (%d > %d)
            We're working on increasing this limitation.
            Please contact us directly if you wish to boost this issue
            or get a dedicated estimation.
            """ % (travels_to_compute, maximum_travels_to_compute)
            form.origin_addresses.errors.append(message)
            form.destination_addresses.errors.append(message)
            # form.origin_addresses_file.errors.append(message)
            # form.destination_addresses_file.errors.append(message)
            return show_form()

7b4d2926   Goutte   Rework the contro...
239
240
241
        db.session.add(estimation)
        db.session.commit()

e2637443   Antoine Goutenoir   Send emails to ad...
242
243
        send_email(
            to_recipient=pi_email,
3e6505e2   Antoine Goutenoir   Add content to th...
244
            subject="[TCFM] New Estimation Request: %s" % estimation.public_id,
07c07af5   Antoine Goutenoir   Add an email temp...
245
246
247
248
249
            message=render_template(
                'email/run_requested.html',
                base_url=base_url,
                estimation=estimation,
            )
e2637443   Antoine Goutenoir   Send emails to ad...
250
251
        )

7b4d2926   Goutte   Rework the contro...
252
        flash("Estimation request submitted successfully.", "success")
a4c03d8e   Antoine Goutenoir   Add the controlle...
253
254
255
        return redirect(url_for(
            endpoint=".consult_estimation",
            public_id=estimation.public_id,
91751451   Antoine Goutenoir   Shift the API to ...
256
            extension='html'
a4c03d8e   Antoine Goutenoir   Add the controlle...
257
        ))
7b4d2926   Goutte   Rework the contro...
258
259
        # return render_template("estimate-debrief.html", form=form)

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

4392f295   Goutte   Update the Estima...
262

15e57dca   Antoine Goutenoir   Naming things and...
263
@main.route("/invalidate")
4276f1aa   Antoine Goutenoir   Support train emi...
264
@main.route("/invalidate.html")
15e57dca   Antoine Goutenoir   Naming things and...
265
266
267
268
269
270
271
272
273
274
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...
275
276
277
278
279
280
281
282
283
284
285
    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...
286
287


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

04d423cb   Antoine Goutenoir   Limit the amount ...
291
    # maximum_addresses_to_compute = 30000
dca2b847   Antoine Goutenoir   Cap the amount of...
292

24f55cde   Antoine Goutenoir   Geocode destinati...
293
294
295
296
    def _respond(_msg):
        return "<pre>%s</pre>" % _msg

    def _handle_failure(_estimation, _failure_message):
a4c03d8e   Antoine Goutenoir   Add the controlle...
297
        _estimation.status = StatusEnum.failure
70aa301f   Antoine Goutenoir   Implement another...
298
        _estimation.errors = _failure_message
24f55cde   Antoine Goutenoir   Geocode destinati...
299
        db.session.commit()
3e6505e2   Antoine Goutenoir   Add content to th...
300
301
302
303
304
305
306
307
308
        send_email(
            to_recipient=pi_email,
            subject="[TCFM] Run failed: %s" % _estimation.public_id,
            message=render_template(
                'email/run_failed.html',
                base_url=base_url,
                estimation=_estimation,
            )
        )
24f55cde   Antoine Goutenoir   Geocode destinati...
309

72460978   Antoine Goutenoir   Use warnings inst...
310
    def _handle_warning(_estimation, _warning_message):
3d8865da   Antoine Goutenoir   Improve warnings ...
311
312
313
        if not _estimation.warnings:
            _estimation.warnings = _warning_message
        else:
ac935afa   Antoine Goutenoir   Make warnings mor...
314
            _estimation.warnings += _warning_message
3d8865da   Antoine Goutenoir   Improve warnings ...
315
316
            # _estimation.warnings = u"%s\n%s" % \
            #                        (_estimation.warnings, _warning_message)
72460978   Antoine Goutenoir   Use warnings inst...
317
318
        db.session.commit()

3d8865da   Antoine Goutenoir   Improve warnings ...
319
    estimation = None
59125398   Antoine Goutenoir   Improve resilience.
320
321
    try:
        response = ""
4392f295   Goutte   Update the Estima...
322

59125398   Antoine Goutenoir   Improve resilience.
323
324
325
        count_working = Estimation.query \
            .filter_by(status=StatusEnum.working) \
            .count()
03c194bf   Antoine Goutenoir   Actually implemen...
326

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

59125398   Antoine Goutenoir   Improve resilience.
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
        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...
345

59125398   Antoine Goutenoir   Improve resilience.
346
347
348
        response += u"Processing estimation `%s`...\n" % (
            estimation.public_id
        )
24f55cde   Antoine Goutenoir   Geocode destinati...
349

6b9c0dd2   Antoine Goutenoir   Force Unicode.
350
351
        # GEOCODE ADDRESSES ###################################################

59125398   Antoine Goutenoir   Improve resilience.
352
353
        failed_addresses = []
        geocoder = CachedGeocoder()
03c194bf   Antoine Goutenoir   Actually implemen...
354

e2637443   Antoine Goutenoir   Send emails to ad...
355
        # GEOCODE ORIGINS #####################################################
24f55cde   Antoine Goutenoir   Geocode destinati...
356

59125398   Antoine Goutenoir   Improve resilience.
357
        origins_addresses = estimation.origin_addresses.strip().split("\n")
dca2b847   Antoine Goutenoir   Cap the amount of...
358
        origins_addresses_count = len(origins_addresses)
59125398   Antoine Goutenoir   Improve resilience.
359
        origins = []
24f55cde   Antoine Goutenoir   Geocode destinati...
360

04d423cb   Antoine Goutenoir   Limit the amount ...
361
362
363
364
365
366
367
        # if origins_addresses_count > maximum_addresses_to_compute:
        #     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)
        #     _handle_failure(estimation, errmsg)
        #     return _respond(errmsg)
dca2b847   Antoine Goutenoir   Cap the amount of...
368
369

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

59125398   Antoine Goutenoir   Improve resilience.
371
            origin_address = origins_addresses[i].strip()
3d8865da   Antoine Goutenoir   Improve warnings ...
372
373
374
375

            if not origin_address:
                continue

59125398   Antoine Goutenoir   Improve resilience.
376
377
            if origin_address in failed_addresses:
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
378

59125398   Antoine Goutenoir   Improve resilience.
379
380
381
            try:
                origin = geocoder.geocode(origin_address.encode('utf-8'))
            except geopy.exc.GeopyError as e:
3d8865da   Antoine Goutenoir   Improve warnings ...
382
383
384
                warning = u"Ignoring origin `%s` " \
                          u"since we failed to geocode it.\n%s\n" % (
                            origin_address, e,
59125398   Antoine Goutenoir   Improve resilience.
385
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
386
387
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
388
389
                failed_addresses.append(origin_address)
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
390

59125398   Antoine Goutenoir   Improve resilience.
391
            if origin is None:
3d8865da   Antoine Goutenoir   Improve warnings ...
392
393
394
                warning = u"Ignoring origin `%s` " \
                          u"since we failed to geocode it.\n" % (
                            origin_address,
59125398   Antoine Goutenoir   Improve resilience.
395
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
396
397
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
398
399
                failed_addresses.append(origin_address)
                continue
51f564d3   Antoine Goutenoir   Add a big chunk o...
400

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

3d8865da   Antoine Goutenoir   Improve warnings ...
403
            response += u"Origin `%s` geocoded to `%s` (%f, %f).\n" % (
59125398   Antoine Goutenoir   Improve resilience.
404
405
                origin_address, origin.address,
                origin.latitude, origin.longitude,
51f564d3   Antoine Goutenoir   Add a big chunk o...
406
            )
51f564d3   Antoine Goutenoir   Add a big chunk o...
407

e2637443   Antoine Goutenoir   Send emails to ad...
408
        # GEOCODE DESTINATIONS ################################################
51f564d3   Antoine Goutenoir   Add a big chunk o...
409

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

04d423cb   Antoine Goutenoir   Limit the amount ...
414
415
416
417
418
419
420
421
422
423
        # if destinations_addresses_count > maximum_addresses_to_compute:
        #     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,
        #              )
        #     _handle_failure(estimation, errmsg)
        #     return _respond(errmsg)
dca2b847   Antoine Goutenoir   Cap the amount of...
424
425

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

59125398   Antoine Goutenoir   Improve resilience.
427
            destination_address = destinations_addresses[i].strip()
3d8865da   Antoine Goutenoir   Improve warnings ...
428
429
430
431

            if not destination_address:
                continue

59125398   Antoine Goutenoir   Improve resilience.
432
433
            if destination_address in failed_addresses:
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
434

59125398   Antoine Goutenoir   Improve resilience.
435
            try:
e2637443   Antoine Goutenoir   Send emails to ad...
436
437
438
                destination = geocoder.geocode(
                    destination_address.encode('utf-8')
                )
59125398   Antoine Goutenoir   Improve resilience.
439
            except geopy.exc.GeopyError as e:
3d8865da   Antoine Goutenoir   Improve warnings ...
440
441
442
                warning = u"Ignoring destination `%s` " \
                          u"since we failed to geocode it.\n%s\n" % (
                            destination_address, e,
59125398   Antoine Goutenoir   Improve resilience.
443
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
444
445
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
446
447
                failed_addresses.append(destination_address)
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
448

59125398   Antoine Goutenoir   Improve resilience.
449
            if destination is None:
3d8865da   Antoine Goutenoir   Improve warnings ...
450
451
452
                warning = u"Ignoring destination `%s` " \
                          u"since we failed to geocode it.\n" % (
                            destination_address,
59125398   Antoine Goutenoir   Improve resilience.
453
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
454
455
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
456
457
                failed_addresses.append(destination_address)
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
458

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

59125398   Antoine Goutenoir   Improve resilience.
461
462
            destinations.append(destination)

3d8865da   Antoine Goutenoir   Improve warnings ...
463
            response += u"Destination `%s` geocoded to `%s` (%f, %f).\n" % (
59125398   Antoine Goutenoir   Improve resilience.
464
465
                destination_address, destination.address,
                destination.latitude, destination.longitude,
24f55cde   Antoine Goutenoir   Geocode destinati...
466
            )
24f55cde   Antoine Goutenoir   Geocode destinati...
467

8ae021a2   Antoine Goutenoir   Merge shelved cha...
468
469
        geocoder.close()

e2637443   Antoine Goutenoir   Send emails to ad...
470
        # GTFO IF NO ORIGINS OR NO DESTINATIONS ###############################
314c65e2   Antoine Goutenoir   Implement Scenari...
471

59125398   Antoine Goutenoir   Improve resilience.
472
        if 0 == len(origins):
3d8865da   Antoine Goutenoir   Improve warnings ...
473
            response += u"Failed to geocode ALL the origin(s).\n"
59125398   Antoine Goutenoir   Improve resilience.
474
475
476
            _handle_failure(estimation, response)
            return _respond(response)
        if 0 == len(destinations):
3d8865da   Antoine Goutenoir   Improve warnings ...
477
            response += u"Failed to geocode ALL the destination(s).\n"
59125398   Antoine Goutenoir   Improve resilience.
478
479
            _handle_failure(estimation, response)
            return _respond(response)
24f55cde   Antoine Goutenoir   Geocode destinati...
480

e2637443   Antoine Goutenoir   Send emails to ad...
481
        # GRAB AND CONFIGURE THE EMISSION MODELS ##############################
24f55cde   Antoine Goutenoir   Geocode destinati...
482

59125398   Antoine Goutenoir   Improve resilience.
483
484
        emission_models = estimation.get_models()
        # print(emission_models)
51f564d3   Antoine Goutenoir   Add a big chunk o...
485

59125398   Antoine Goutenoir   Improve resilience.
486
487
488
489
        extra_config = {
            'use_train_below_distance': estimation.use_train_below_km,
            # 'use_train_below_distance': 300,
        }
70aa301f   Antoine Goutenoir   Implement another...
490

e2637443   Antoine Goutenoir   Send emails to ad...
491
        # PREPARE RESULT DICTIONARY THAT WILL BE STORED #######################
59125398   Antoine Goutenoir   Improve resilience.
492
493
494

        results = {}

e2637443   Antoine Goutenoir   Send emails to ad...
495
        # UTILITY PRIVATE FUNCTION(S) #########################################
59125398   Antoine Goutenoir   Improve resilience.
496

e2e42156   Antoine Goutenoir   Add the country t...
497
        def _get_city_key(_location):
59125398   Antoine Goutenoir   Improve resilience.
498
499
500
501
502
503
504
505
506
507
508
            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

e2e42156   Antoine Goutenoir   Add the country t...
509
510
511
        def _get_country_key(_location):
            return _location.address.split(',')[-1]

59125398   Antoine Goutenoir   Improve resilience.
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
        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...
535

e2e42156   Antoine Goutenoir   Add the country t...
536
                    _key = _get_city_key(_destination)
59125398   Antoine Goutenoir   Improve resilience.
537
538
539
540
541
542

                    destinations_by_city_key[_key] = _destination

                    if _key not in cities_dict:
                        cities_dict[_key] = {
                            'city': _key,
e2e42156   Antoine Goutenoir   Add the country t...
543
                            'country': _get_country_key(_destination),
59125398   Antoine Goutenoir   Improve resilience.
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
                            '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,
e2e42156   Antoine Goutenoir   Add the country t...
586
                    'country': _get_country_key(destinations_by_city_key[city]),
59125398   Antoine Goutenoir   Improve resilience.
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
                    '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...
602
            }
59125398   Antoine Goutenoir   Improve resilience.
603
            _results['cities'] = cities_mean
1d48272e   Antoine Goutenoir   Compute the mean ...
604

59125398   Antoine Goutenoir   Improve resilience.
605
606
            _results['total'] = total_foot  # DEPRECATED
            _results['footprint'] = total_foot
584b13cc   Antoine Goutenoir   Order the results...
607

59125398   Antoine Goutenoir   Improve resilience.
608
609
610
            _results['distance'] = total_dist
            _results['train_trips'] = total_train_trips
            _results['plane_trips'] = total_plane_trips
70aa301f   Antoine Goutenoir   Implement another...
611

59125398   Antoine Goutenoir   Improve resilience.
612
            return _results
24f55cde   Antoine Goutenoir   Geocode destinati...
613

e2637443   Antoine Goutenoir   Send emails to ad...
614
        # SCENARIO A : One Origin, At Least One Destination ###################
59125398   Antoine Goutenoir   Improve resilience.
615
        #
e2637443   Antoine Goutenoir   Send emails to ad...
616
        # We compute the sum of each of the travels' footprint,
59125398   Antoine Goutenoir   Improve resilience.
617
618
619
620
621
622
623
624
625
        # 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...
626

e2637443   Antoine Goutenoir   Send emails to ad...
627
        # SCENARIO B : At Least One Origin, One Destination ###################
59125398   Antoine Goutenoir   Improve resilience.
628
629
630
631
632
633
634
        #
        # 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...
635
                _destinations=origins,
8a693e06   Antoine Goutenoir   Glue the extra co...
636
                _extra_config=extra_config,
314c65e2   Antoine Goutenoir   Implement Scenari...
637
            )
314c65e2   Antoine Goutenoir   Implement Scenari...
638

e2637443   Antoine Goutenoir   Send emails to ad...
639
        # SCENARIO C : At Least One Origin, At Least One Destination ##########
59125398   Antoine Goutenoir   Improve resilience.
640
641
642
643
644
645
646
647
        #
        # 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:
e2e42156   Antoine Goutenoir   Add the country t...
648
649
                city_key = _get_city_key(destination)
                country_key = _get_country_key(destination)
59125398   Antoine Goutenoir   Improve resilience.
650
651
652
653
654

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

59125398   Antoine Goutenoir   Improve resilience.
656
657
658
659
660
661
                city_results = compute_one_to_many(
                    _origin=destination,
                    _destinations=origins,
                    _extra_config=extra_config,
                )
                city_results['city'] = city_key
e2e42156   Antoine Goutenoir   Add the country t...
662
                city_results['country'] = country_key
59125398   Antoine Goutenoir   Improve resilience.
663
664
665
666
667
668
669
670
                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,
            }

e2637443   Antoine Goutenoir   Send emails to ad...
671
        # WRITE RESULTS INTO THE DATABASE #####################################
a4c03d8e   Antoine Goutenoir   Add the controlle...
672

59125398   Antoine Goutenoir   Improve resilience.
673
        estimation.status = StatusEnum.success
e2637443   Antoine Goutenoir   Send emails to ad...
674
        # Don't use YAML, it is too slow for big data.
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
675
        # estimation.output_yaml = u"%s" % yaml_dump(results)
3d8865da   Antoine Goutenoir   Improve warnings ...
676
        estimation.informations = response
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
677
        estimation.set_output_dict(results)
59125398   Antoine Goutenoir   Improve resilience.
678
679
        db.session.commit()

e2637443   Antoine Goutenoir   Send emails to ad...
680
681
682
683
684
        # SEND AN EMAIL #######################################################

        send_email(
            to_recipient=pi_email,
            subject="[TCFM] Run completed: %s" % estimation.public_id,
3e6505e2   Antoine Goutenoir   Add content to th...
685
686
687
688
689
            message=render_template(
                'email/run_completed.html',
                base_url=base_url,
                estimation=estimation,
            )
e2637443   Antoine Goutenoir   Send emails to ad...
690
691
692
        )

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

3e6505e2   Antoine Goutenoir   Add content to th...
694
        # YAML is too expensive, let's not
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
695
        # response += yaml_dump(results) + "\n"
a4c03d8e   Antoine Goutenoir   Add the controlle...
696

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

59125398   Antoine Goutenoir   Improve resilience.
699
    except Exception as e:
e144bb1b   Antoine Goutenoir   Fix encoding.
700
        errmsg = u"Computation failed : %s" % (e,)
ce850e3a   Antoine Goutenoir   Revert traceback.
701
        # errmsg = u"%s\n\n%s" % (errmsg, traceback.format_exc())
59125398   Antoine Goutenoir   Improve resilience.
702
703
704
        if estimation:
            _handle_failure(estimation, errmsg)
        return _respond(errmsg)
a4c03d8e   Antoine Goutenoir   Add the controlle...
705
706


b9fc86c3   Antoine Goutenoir   Secure the admin ...
707
708
@main.route("/estimation/<public_id>.<extension>")
def consult_estimation(public_id, extension):
a4c03d8e   Antoine Goutenoir   Add the controlle...
709
710
711
712
713
714
715
    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.
716
        # TODO: log?
a4c03d8e   Antoine Goutenoir   Add the controlle...
717
718
719
720
721
722
        return abort(500)

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

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

b9fc86c3   Antoine Goutenoir   Secure the admin ...
725
    if extension in ['xhtml', 'html', 'htm']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
726
727

        if estimation.status in unavailable_statuses:
a4c03d8e   Antoine Goutenoir   Add the controlle...
728
729
730
731
732
            return render_template(
                "estimation-queue-wait.html",
                estimation=estimation
            )
        else:
40382971   Antoine Goutenoir   Add the sum of es...
733
734
            estimation_output = estimation.get_output_dict()
            estimation_sum = 0
37e28f2c   Antoine Goutenoir   Improve resilience.
735
736
737
            if estimation_output:
                for city in estimation_output['cities']:
                    estimation_sum += city['footprint']
40382971   Antoine Goutenoir   Add the sum of es...
738

a4c03d8e   Antoine Goutenoir   Add the controlle...
739
740
            return render_template(
                "estimation.html",
91751451   Antoine Goutenoir   Shift the API to ...
741
                estimation=estimation,
40382971   Antoine Goutenoir   Add the sum of es...
742
743
                estimation_output=estimation_output,
                estimation_sum=estimation_sum,
a4c03d8e   Antoine Goutenoir   Add the controlle...
744
745
            )

b9fc86c3   Antoine Goutenoir   Secure the admin ...
746
    elif extension in ['yaml', 'yml']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
747
748
749
750

        if estimation.status in unavailable_statuses:
            abort(404)

f48f4a8f   Antoine Goutenoir   Optimize a bottle...
751
752
        return u"%s" % yaml_dump(estimation.get_output_dict())
        # return estimation.output_yaml
e721cb31   Antoine Goutenoir   Provide a YAML fi...
753

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

e721cb31   Antoine Goutenoir   Provide a YAML fi...
756
757
758
        if estimation.status in unavailable_statuses:
            abort(404)

a4c03d8e   Antoine Goutenoir   Add the controlle...
759
760
        si = StringIO()
        cw = csv.writer(si, quoting=csv.QUOTE_ALL)
b935618e   Antoine Goutenoir   Count the number ...
761
        cw.writerow([
e2e42156   Antoine Goutenoir   Add the country t...
762
            u"city", u"country", u"address",
29a1d1c1   Antoine Goutenoir   Rename columns in...
763
764
765
766
            u"co2_kg",
            u"distance_km",
            u"plane trips_amount",
            u'train trips_amount',
b935618e   Antoine Goutenoir   Count the number ...
767
        ])
a4c03d8e   Antoine Goutenoir   Add the controlle...
768
769

        results = estimation.get_output_dict()
5634c975   Antoine Goutenoir   Expose travel dis...
770
771
772
        for city in results['cities']:
            cw.writerow([
                city['city'].encode(OUT_ENCODING),
e2e42156   Antoine Goutenoir   Add the country t...
773
                city['country'].encode(OUT_ENCODING),
5634c975   Antoine Goutenoir   Expose travel dis...
774
775
776
                city['address'].encode(OUT_ENCODING),
                round(city['footprint'], 3),
                round(city['distance'], 3),
b935618e   Antoine Goutenoir   Count the number ...
777
778
                city['plane_trips'],
                city['train_trips'],
5634c975   Antoine Goutenoir   Expose travel dis...
779
780
            ])

67f85bce   Antoine Goutenoir   Generate a CSV fi...
781
782
783
784
785
786
787
788
        # 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...
789
790
791

    else:
        abort(404)
b9fc86c3   Antoine Goutenoir   Secure the admin ...
792
793


67f85bce   Antoine Goutenoir   Generate a CSV fi...
794
795
@main.route("/scaling_laws.csv")
def get_scaling_laws_csv():
a728e600   Antoine Goutenoir   Allow configurati...
796
    distances = content.laws_plot.distances
67f85bce   Antoine Goutenoir   Generate a CSV fi...
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
    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 ...
820
@main.route("/test")
c2a01bd2   Antoine Goutenoir   Prepare mail flas...
821
# @basic_auth.required
b9fc86c3   Antoine Goutenoir   Secure the admin ...
822
823
824
def dev_test():
    import os

e2637443   Antoine Goutenoir   Send emails to ad...
825
    # email_content = render_template(
3e6505e2   Antoine Goutenoir   Add content to th...
826
    #     'email/run_completed.html',
e2637443   Antoine Goutenoir   Send emails to ad...
827
828
829
830
831
832
833
834
835
    #     # run=run,
    # )
    # send_email(
    #     'goutte@protonmail.com',
    #     subject=u"[TCFC] New run request",
    #     message=email_content
    # )

    return "ok"