Blame view

flaskr/controllers/main_controller.py 33.6 KB
3bb89452   Antoine Goutenoir   feat: add a world...
1
2
import csv
import re
3aef85e1   Antoine Goutenoir   feat: improve err...
3
# from cStringIO import StringIO
b935618e   Antoine Goutenoir   Count the number ...
4
from copy import deepcopy
3aef85e1   Antoine Goutenoir   feat: improve err...
5
6
from io import StringIO
from os import unlink, getenv
3bb89452   Antoine Goutenoir   feat: add a world...
7
from os.path import join
b935618e   Antoine Goutenoir   Count the number ...
8

314c65e2   Antoine Goutenoir   Implement Scenari...
9
import geopy
3bb89452   Antoine Goutenoir   feat: add a world...
10
import pandas
314c65e2   Antoine Goutenoir   Implement Scenari...
11
import sqlalchemy
e2637443   Antoine Goutenoir   Send emails to ad...
12
13
14
15
from flask import (
    Blueprint,
    Response,
    render_template,
3aef85e1   Antoine Goutenoir   feat: improve err...
16
    request,
e2637443   Antoine Goutenoir   Send emails to ad...
17
    flash,
e2637443   Antoine Goutenoir   Send emails to ad...
18
19
20
21
22
    redirect,
    url_for,
    abort,
    send_from_directory,
)
edbfd01a   Antoine Goutenoir   fix: remove dep o...
23
# from pandas.compat import StringIO as PandasStringIO
3bb89452   Antoine Goutenoir   feat: add a world...
24
25
from wtforms import validators
from yaml import safe_dump as yaml_dump
7b4d2926   Goutte   Rework the contro...
26

3bb89452   Antoine Goutenoir   feat: add a world...
27
from flaskr.content import content, base_url
e2637443   Antoine Goutenoir   Send emails to ad...
28
from flaskr.core import (
e2637443   Antoine Goutenoir   Send emails to ad...
29
30
31
    get_emission_models,
    increment_hit_counter,
)
3ee4fd02   Antoine Goutenoir   fix: disable cache
32
from flaskr.extensions import send_email
3bb89452   Antoine Goutenoir   feat: add a world...
33
34
35
from flaskr.forms import EstimateForm
from flaskr.geocoder import CachedGeocoder
from flaskr.models import db, Estimation, StatusEnum, ScenarioEnum
9e44bb98   Antoine Goutenoir   Support file uplo...
36

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


ebfb50f0   Antoine Goutenoir   feat: rely on ful...
40
#OUT_ENCODING = 'utf-8'
9621b8a5   Antoine Goutenoir   Fix the CSV gener...
41
42


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

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

78eb2a62   Antoine Goutenoir   Use the counter.
48
# -----------------------------------------------------------------------------
67f85bce   Antoine Goutenoir   Generate a CSV fi...
49
50


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


9e44bb98   Antoine Goutenoir   Support file uplo...
78
def gather_addresses(from_list, from_file):
04d423cb   Antoine Goutenoir   Limit the amount ...
79
80
81
82
    """
    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...
83
84
85
    addresses = []
    if from_file:
        file_mimetype = from_file.mimetype
62cfd7a5   Antoine Goutenoir   fix: decode() the...
86
        file_contents = from_file.read().decode()
9e44bb98   Antoine Goutenoir   Support file uplo...
87
88
89
90

        rows_dicts = None

        if 'text/csv' == file_mimetype:
00accf5c   Antoine Goutenoir   fix: allow CSV de...
91
92
93
            delimiter = ','
            if ';' in file_contents:
                delimiter = ';'
9e44bb98   Antoine Goutenoir   Support file uplo...
94
            rows_dicts = pandas \
00accf5c   Antoine Goutenoir   fix: allow CSV de...
95
                .read_csv(StringIO(file_contents), delimiter=delimiter) \
9e44bb98   Antoine Goutenoir   Support file uplo...
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
                .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 \
edbfd01a   Antoine Goutenoir   fix: remove dep o...
116
                .read_excel(StringIO(file_contents)) \
9e44bb98   Antoine Goutenoir   Support file uplo...
117
118
119
120
121
                .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...
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
        #     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...
142
143
144
                    raise validators.ValidationError(
                        "We could not find Address data in the spreadsheet."
                    )
9e44bb98   Antoine Goutenoir   Support file uplo...
145
        else:
f2fbbb72   Antoine Goutenoir   Display a nice er...
146
147
148
            raise validators.ValidationError(
                "We could not find any data in the spreadsheet."
            )
9e44bb98   Antoine Goutenoir   Support file uplo...
149
150
151
152

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

68da7cd4   Antoine Goutenoir   Improve robustnes...
153
    clean_addresses = []
88c95474   Antoine Goutenoir   Improve perfs of ...
154
155
    # Ignore inevitable copy/paste bloopers
    to_ignore = re.compile(r"City\s*,\s*Country", re.I & re.U)
68da7cd4   Antoine Goutenoir   Improve robustnes...
156
157
158
    for address in addresses:
        if not address:
            continue
3d17c7c3   Antoine Goutenoir   chore: move to py...
159
160
161
        # if type(address).__name__ == 'str':
        #     address = str(address).encode('utf-8')
        address = str(address)
88c95474   Antoine Goutenoir   Improve perfs of ...
162
163
        if to_ignore.match(address) is not None:
            continue
8ba63c8d   Antoine Goutenoir   Ignore "City,Coun...
164
        clean_addresses.append(address)
68da7cd4   Antoine Goutenoir   Improve robustnes...
165
166
167
168
    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...
169

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


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

f2fbbb72   Antoine Goutenoir   Display a nice er...
180
    def show_form():
a7e8b345   Antoine Goutenoir   refactor: rename ...
181
        return render_template("estimation-request.html", form=form, models=models)
f2fbbb72   Antoine Goutenoir   Display a nice er...
182

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

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

        try:
            estimation.origin_addresses = gather_addresses(
                form.origin_addresses.data,
                form.origin_addresses_file.data
            )
        except validators.ValidationError as e:
00accf5c   Antoine Goutenoir   fix: allow CSV de...
199
            form.origin_addresses_file.errors.append(str(e))
f2fbbb72   Antoine Goutenoir   Display a nice er...
200
201
202
203
204
205
206
207
            return show_form()

        try:
            estimation.destination_addresses = gather_addresses(
                form.destination_addresses.data,
                form.destination_addresses_file.data
            )
        except validators.ValidationError as e:
00accf5c   Antoine Goutenoir   fix: allow CSV de...
208
            form.destination_addresses_file.errors.append(str(e))
f2fbbb72   Antoine Goutenoir   Display a nice er...
209
210
            return show_form()

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

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

04d423cb   Antoine Goutenoir   Limit the amount ...
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
        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...
238
239
240
        db.session.add(estimation)
        db.session.commit()

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

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

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

4392f295   Goutte   Update the Estima...
261

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


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

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

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

    def _handle_failure(_estimation, _failure_message):
a4c03d8e   Antoine Goutenoir   Add the controlle...
296
        _estimation.status = StatusEnum.failure
70aa301f   Antoine Goutenoir   Implement another...
297
        _estimation.errors = _failure_message
24f55cde   Antoine Goutenoir   Geocode destinati...
298
        db.session.commit()
3e6505e2   Antoine Goutenoir   Add content to th...
299
300
301
302
303
304
305
306
307
        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...
308

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

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

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

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

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

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

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

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

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

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

04d423cb   Antoine Goutenoir   Limit the amount ...
360
361
362
363
364
365
366
        # 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...
367
368

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

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

            if not origin_address:
                continue

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

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

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

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

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

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

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

04d423cb   Antoine Goutenoir   Limit the amount ...
413
414
415
416
417
418
419
420
421
422
        # 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...
423
424

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

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

            if not destination_address:
                continue

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

59125398   Antoine Goutenoir   Improve resilience.
434
            try:
c098cd65   Antoine Goutenoir   chore: move to py...
435
                destination = geocoder.geocode(destination_address)
59125398   Antoine Goutenoir   Improve resilience.
436
            except geopy.exc.GeopyError as e:
3d8865da   Antoine Goutenoir   Improve warnings ...
437
438
439
                warning = u"Ignoring destination `%s` " \
                          u"since we failed to geocode it.\n%s\n" % (
                            destination_address, e,
59125398   Antoine Goutenoir   Improve resilience.
440
                )
3d8865da   Antoine Goutenoir   Improve warnings ...
441
442
                response += warning
                _handle_warning(estimation, warning)
59125398   Antoine Goutenoir   Improve resilience.
443
444
                failed_addresses.append(destination_address)
                continue
24f55cde   Antoine Goutenoir   Geocode destinati...
445

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

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

59125398   Antoine Goutenoir   Improve resilience.
458
459
            destinations.append(destination)

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

8ae021a2   Antoine Goutenoir   Merge shelved cha...
465
466
        geocoder.close()

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

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

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

59125398   Antoine Goutenoir   Improve resilience.
480
481
        emission_models = estimation.get_models()
        # print(emission_models)
51f564d3   Antoine Goutenoir   Add a big chunk o...
482

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

e2637443   Antoine Goutenoir   Send emails to ad...
488
        # PREPARE RESULT DICTIONARY THAT WILL BE STORED #######################
59125398   Antoine Goutenoir   Improve resilience.
489
490
491

        results = {}

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

ebfb50f0   Antoine Goutenoir   feat: rely on ful...
494
495
496
497
498
499
500
        # _locations
        def _get_location_key(_location):
            return "%s, %s" % (
                _get_city_key(_location),
                _get_country_key(_location),
            )

e2e42156   Antoine Goutenoir   Add the country t...
501
        def _get_city_key(_location):
59125398   Antoine Goutenoir   Improve resilience.
502
503
504
505
506
507
508
509
510
511
512
            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...
513
514
515
        def _get_country_key(_location):
            return _location.address.split(',')[-1]

59125398   Antoine Goutenoir   Improve resilience.
516
517
518
519
520
521
522
523
        def compute_one_to_many(
                _origin,
                _destinations,
                _extra_config=None
        ):
            _results = {}
            footprints = {}

ebfb50f0   Antoine Goutenoir   feat: rely on ful...
524
            destinations_by_key = {}
59125398   Antoine Goutenoir   Improve resilience.
525
526
527
528
529
530
531
532
533
534
535
536
537
538

            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...
539

ebfb50f0   Antoine Goutenoir   feat: rely on ful...
540
541
                    _key = _get_location_key(_destination)
                    destinations_by_key[_key] = _destination
59125398   Antoine Goutenoir   Improve resilience.
542
543
544

                    if _key not in cities_dict:
                        cities_dict[_key] = {
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
545
546
                            'location': _get_location_key(_destination),
                            'city': _get_city_key(_destination),
e2e42156   Antoine Goutenoir   Add the country t...
547
                            'country': _get_country_key(_destination),
59125398   Antoine Goutenoir   Improve resilience.
548
                            'address': _destination.address,
82cd86ae   Antoine Goutenoir   feat: add the lat...
549
550
                            'latitude': _destination.latitude,
                            'longitude': _destination.longitude,
59125398   Antoine Goutenoir   Improve resilience.
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
586
587
588
589
                            '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] = {
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
590
591
592
593
594
595
                    'location': _get_location_key(destinations_by_key[city]),
                    'city': _get_city_key(destinations_by_key[city]),
                    'country': _get_country_key(destinations_by_key[city]),
                    'address': destinations_by_key[city].address,
                    'latitude': destinations_by_key[city].latitude,
                    'longitude': destinations_by_key[city].longitude,
59125398   Antoine Goutenoir   Improve resilience.
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
                    '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...
611
            }
59125398   Antoine Goutenoir   Improve resilience.
612
            _results['cities'] = cities_mean
1d48272e   Antoine Goutenoir   Compute the mean ...
613

59125398   Antoine Goutenoir   Improve resilience.
614
615
            _results['total'] = total_foot  # DEPRECATED
            _results['footprint'] = total_foot
584b13cc   Antoine Goutenoir   Order the results...
616

59125398   Antoine Goutenoir   Improve resilience.
617
618
619
            _results['distance'] = total_dist
            _results['train_trips'] = total_train_trips
            _results['plane_trips'] = total_plane_trips
70aa301f   Antoine Goutenoir   Implement another...
620

59125398   Antoine Goutenoir   Improve resilience.
621
            return _results
24f55cde   Antoine Goutenoir   Geocode destinati...
622

e2637443   Antoine Goutenoir   Send emails to ad...
623
        # SCENARIO A : One Origin, At Least One Destination ###################
59125398   Antoine Goutenoir   Improve resilience.
624
        #
e2637443   Antoine Goutenoir   Send emails to ad...
625
        # We compute the sum of each of the travels' footprint,
59125398   Antoine Goutenoir   Improve resilience.
626
627
628
629
630
631
632
633
634
        # 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...
635

e2637443   Antoine Goutenoir   Send emails to ad...
636
        # SCENARIO B : At Least One Origin, One Destination ###################
59125398   Antoine Goutenoir   Improve resilience.
637
638
639
640
641
642
643
        #
        # 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...
644
                _destinations=origins,
8a693e06   Antoine Goutenoir   Glue the extra co...
645
                _extra_config=extra_config,
314c65e2   Antoine Goutenoir   Implement Scenari...
646
            )
314c65e2   Antoine Goutenoir   Implement Scenari...
647

e2637443   Antoine Goutenoir   Send emails to ad...
648
        # SCENARIO C : At Least One Origin, At Least One Destination ##########
59125398   Antoine Goutenoir   Improve resilience.
649
650
        #
        # Run Scenario A for each Destination, and expose optimum Destination.
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
651
        # Skip destinations already visited.  (collapse duplicate destinations)
59125398   Antoine Goutenoir   Improve resilience.
652
653
654
        #
        else:
            estimation.scenario = ScenarioEnum.many_to_many
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
655
            unique_location_keys = []
59125398   Antoine Goutenoir   Improve resilience.
656
657
            result_cities = []
            for destination in destinations:
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
658
                location_key = _get_location_key(destination)
e2e42156   Antoine Goutenoir   Add the country t...
659
660
                city_key = _get_city_key(destination)
                country_key = _get_country_key(destination)
59125398   Antoine Goutenoir   Improve resilience.
661

ebfb50f0   Antoine Goutenoir   feat: rely on ful...
662
                if location_key in unique_location_keys:
59125398   Antoine Goutenoir   Improve resilience.
663
664
                    continue
                else:
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
665
                    unique_location_keys.append(location_key)
1d48272e   Antoine Goutenoir   Compute the mean ...
666

59125398   Antoine Goutenoir   Improve resilience.
667
668
669
670
671
672
                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...
673
                city_results['country'] = country_key
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
674
                city_results['location'] = location_key
59125398   Antoine Goutenoir   Improve resilience.
675
                city_results['address'] = destination.address
82cd86ae   Antoine Goutenoir   feat: add the lat...
676
677
                city_results['latitude'] = destination.latitude
                city_results['longitude'] = destination.longitude
59125398   Antoine Goutenoir   Improve resilience.
678
679
680
681
682
683
684
                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...
685
        # WRITE RESULTS INTO THE DATABASE #####################################
a4c03d8e   Antoine Goutenoir   Add the controlle...
686

59125398   Antoine Goutenoir   Improve resilience.
687
        estimation.status = StatusEnum.success
e2637443   Antoine Goutenoir   Send emails to ad...
688
        # Don't use YAML, it is too slow for big data.
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
689
        # estimation.output_yaml = u"%s" % yaml_dump(results)
3d8865da   Antoine Goutenoir   Improve warnings ...
690
        estimation.informations = response
f48f4a8f   Antoine Goutenoir   Optimize a bottle...
691
        estimation.set_output_dict(results)
59125398   Antoine Goutenoir   Improve resilience.
692
693
        db.session.commit()

e2637443   Antoine Goutenoir   Send emails to ad...
694
695
696
697
698
        # SEND AN EMAIL #######################################################

        send_email(
            to_recipient=pi_email,
            subject="[TCFM] Run completed: %s" % estimation.public_id,
3e6505e2   Antoine Goutenoir   Add content to th...
699
700
701
702
703
            message=render_template(
                'email/run_completed.html',
                base_url=base_url,
                estimation=estimation,
            )
e2637443   Antoine Goutenoir   Send emails to ad...
704
705
706
        )

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

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

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

59125398   Antoine Goutenoir   Improve resilience.
713
    except Exception as e:
e144bb1b   Antoine Goutenoir   Fix encoding.
714
        errmsg = u"Computation failed : %s" % (e,)
3aef85e1   Antoine Goutenoir   feat: improve err...
715
716
717
        if 'production' != getenv('FLASK_ENV', 'production'):
            import traceback
            errmsg = u"%s\n\n%s" % (errmsg, traceback.format_exc())
59125398   Antoine Goutenoir   Improve resilience.
718
719
720
        if estimation:
            _handle_failure(estimation, errmsg)
        return _respond(errmsg)
a4c03d8e   Antoine Goutenoir   Add the controlle...
721
722


3bb89452   Antoine Goutenoir   feat: add a world...
723
724
725
unavailable_statuses = [StatusEnum.pending, StatusEnum.working]


b9fc86c3   Antoine Goutenoir   Secure the admin ...
726
727
@main.route("/estimation/<public_id>.<extension>")
def consult_estimation(public_id, extension):
a4c03d8e   Antoine Goutenoir   Add the controlle...
728
729
730
731
732
733
734
    try:
        estimation = Estimation.query \
            .filter_by(public_id=public_id) \
            .one()
    except sqlalchemy.orm.exc.NoResultFound:
        return abort(404)
    except Exception as e:
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
735
        # log? (or not)
a4c03d8e   Antoine Goutenoir   Add the controlle...
736
737
738
739
740
741
        return abort(500)

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

b9fc86c3   Antoine Goutenoir   Secure the admin ...
742
    if extension in ['xhtml', 'html', 'htm']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
743
744

        if estimation.status in unavailable_statuses:
a4c03d8e   Antoine Goutenoir   Add the controlle...
745
746
747
748
749
            return render_template(
                "estimation-queue-wait.html",
                estimation=estimation
            )
        else:
40382971   Antoine Goutenoir   Add the sum of es...
750
751
            estimation_output = estimation.get_output_dict()
            estimation_sum = 0
37e28f2c   Antoine Goutenoir   Improve resilience.
752
753
754
            if estimation_output:
                for city in estimation_output['cities']:
                    estimation_sum += city['footprint']
40382971   Antoine Goutenoir   Add the sum of es...
755

a4c03d8e   Antoine Goutenoir   Add the controlle...
756
757
            return render_template(
                "estimation.html",
91751451   Antoine Goutenoir   Shift the API to ...
758
                estimation=estimation,
40382971   Antoine Goutenoir   Add the sum of es...
759
760
                estimation_output=estimation_output,
                estimation_sum=estimation_sum,
a4c03d8e   Antoine Goutenoir   Add the controlle...
761
762
            )

b9fc86c3   Antoine Goutenoir   Secure the admin ...
763
    elif extension in ['yaml', 'yml']:
e721cb31   Antoine Goutenoir   Provide a YAML fi...
764
765
766
767

        if estimation.status in unavailable_statuses:
            abort(404)

f48f4a8f   Antoine Goutenoir   Optimize a bottle...
768
769
        return u"%s" % yaml_dump(estimation.get_output_dict())
        # return estimation.output_yaml
e721cb31   Antoine Goutenoir   Provide a YAML fi...
770

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

e721cb31   Antoine Goutenoir   Provide a YAML fi...
773
774
775
        if estimation.status in unavailable_statuses:
            abort(404)

a4c03d8e   Antoine Goutenoir   Add the controlle...
776
777
        si = StringIO()
        cw = csv.writer(si, quoting=csv.QUOTE_ALL)
b935618e   Antoine Goutenoir   Count the number ...
778
        cw.writerow([
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
779
            u"location",
e2e42156   Antoine Goutenoir   Add the country t...
780
            u"city", u"country", u"address",
82cd86ae   Antoine Goutenoir   feat: add the lat...
781
            u"latitude", u"longitude",
29a1d1c1   Antoine Goutenoir   Rename columns in...
782
783
784
785
            u"co2_kg",
            u"distance_km",
            u"plane trips_amount",
            u'train trips_amount',
b935618e   Antoine Goutenoir   Count the number ...
786
        ])
a4c03d8e   Antoine Goutenoir   Add the controlle...
787
788

        results = estimation.get_output_dict()
5634c975   Antoine Goutenoir   Expose travel dis...
789
790
        for city in results['cities']:
            cw.writerow([
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
791
792
793
794
795
                # city['location'].encode(OUT_ENCODING),
                city['location'],
                city['city'],
                city['country'],
                city['address'],
67db4e6a   Antoine Goutenoir   fix: backward-com...
796
797
                city.get('latitude', 0.0),
                city.get('longitude', 0.0),
5634c975   Antoine Goutenoir   Expose travel dis...
798
799
                round(city['footprint'], 3),
                round(city['distance'], 3),
b935618e   Antoine Goutenoir   Count the number ...
800
801
                city['plane_trips'],
                city['train_trips'],
5634c975   Antoine Goutenoir   Expose travel dis...
802
803
            ])

67f85bce   Antoine Goutenoir   Generate a CSV fi...
804
805
806
807
808
809
810
811
        # 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...
812
813
814

    else:
        abort(404)
b9fc86c3   Antoine Goutenoir   Secure the admin ...
815
816


3bb89452   Antoine Goutenoir   feat: add a world...
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
def get_locations(addresses):
    geocoder = CachedGeocoder()

    warnings = []
    addresses_count = len(addresses)
    failed_addresses = []
    locations = []

    for i in range(addresses_count):

        address = addresses[i].strip()
        unicode_address = address.encode('utf-8')

        if not address:
            continue

        if address in failed_addresses:
            continue

        try:
            location = geocoder.geocode(unicode_address)
        except geopy.exc.GeopyError as e:
            warning = u"Ignoring address `%s` " \
                      u"since we failed to geocode it.\n%s\n" % (
                          address, e,
                      )
            warnings.append(warning)
            failed_addresses.append(address)
            continue

        if location is None:
            warning = u"Ignoring address `%s` " \
                      u"since we failed to geocode it.\n" % (
                          address,
                      )
            warnings.append(warning)
            failed_addresses.append(address)
            failed_addresses.append(address)
            continue

        print("Geocoded Location:\n", repr(location.raw))
        locations.append(location)

        # response += u"Location `%s` geocoded to `%s` (%f, %f).\n" % (
        #     location_address, location.address,
        #     location.latitude, location.longitude,
        # )

    return locations, warnings


@main.route("/estimation/<public_id>/trips_to_destination_<destination_index>.csv")
def get_trips_csv(public_id, destination_index=0):
    destination_index = int(destination_index)
    try:
        estimation = Estimation.query \
            .filter_by(public_id=public_id) \
            .one()
    except sqlalchemy.orm.exc.NoResultFound:
        return abort(404)
    except Exception as e:
        return abort(500)

    if estimation.status in unavailable_statuses:
        abort(404)

    si = StringIO()
    cw = csv.writer(si, quoting=csv.QUOTE_ALL)
    cw.writerow([
        u"origin_lon",
        u"origin_lat",
        u"destination_lon",
        u"destination_lat",
    ])
    results = estimation.get_output_dict()

    if not 'cities' in results:
        abort(500)

    cities_length = len(results['cities'])

    if 0 == cities_length:
        abort(500, Response("No cities in results."))

    destination_index = min(destination_index, cities_length - 1)
    destination_index = max(destination_index, 0)

    city = results['cities'][destination_index]
    # >>> yaml_dump(city)
    # address: Paris, Ile - de - France, Metropolitan
    # France, France
    # city: Paris
    # country: ' France'
    # distance: 1752.7481921181325
    # footprint: 824.9628320703453
    # plane_trips: 1
    # train_trips: 0

    geocoder = CachedGeocoder()
    try:
        city_location = geocoder.geocode(city['address'].encode('utf-8'))
    except geopy.exc.GeopyError as e:
        return Response(
            response=si.getvalue().strip('\r\n'),
        )

    other_locations, _warnings = get_locations(estimation.origin_addresses.split("\n"))
    # destination_locations = get_locations(estimation.destination_addresses.split("\n"))
    for other_location in other_locations:
        cw.writerow([
            u"%.8f" % city_location.longitude,
            u"%.8f" % city_location.latitude,
            u"%.8f" % other_location.longitude,
            u"%.8f" % other_location.latitude,
        ])

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


67f85bce   Antoine Goutenoir   Generate a CSV fi...
943
944
@main.route("/scaling_laws.csv")
def get_scaling_laws_csv():
a728e600   Antoine Goutenoir   Allow configurati...
945
    distances = content.laws_plot.distances
67f85bce   Antoine Goutenoir   Generate a CSV fi...
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
    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',
        },
    )


ebfb50f0   Antoine Goutenoir   feat: rely on ful...
969
970
971
972
973
974
975
976
977
978
@main.route('/geocode')
@main.route('/geocode.html')
def query_geocode():
    requested = request.args.getlist('address')
    if not requested:
        requested = request.args.getlist('address[]')
    if not requested:
        requested = request.args.getlist('a')
    if not requested:
        requested = request.args.getlist('a[]')
27141fbc   Antoine Goutenoir   chore: review
979
    # requested = _collect_request_args_list(('address', 'a'))
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
980
981
982
983
984
985
986
987
988
989
    if not requested:
        return Response(
            response="""
<p>
Usage example: <a href="/geocode.html?address=Toulouse,France&amp;address=Paris,France">/geocode?address=Toulouse,France</a>
</p>

<p>
Please do not request this endpoint more than every two seconds.
</p>
ebfb50f0   Antoine Goutenoir   feat: rely on ful...
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
"""
        )

    response = u""

    geocoder = CachedGeocoder()
    for address in requested:
        location = geocoder.geocode(address)

        response += """
<pre>
Requested: `%s'
Geocoded: `%s'
Longitude: `%f`
Latitude: `%f`
Altitude: `%f` (unreliable)
</pre>
""" % (address, location, location.longitude, location.latitude, location.altitude)

    return Response(response=response)


b9fc86c3   Antoine Goutenoir   Secure the admin ...
1012
@main.route("/test")
c2a01bd2   Antoine Goutenoir   Prepare mail flas...
1013
# @basic_auth.required
b9fc86c3   Antoine Goutenoir   Secure the admin ...
1014
def dev_test():
e2637443   Antoine Goutenoir   Send emails to ad...
1015
    # email_content = render_template(
3e6505e2   Antoine Goutenoir   Add content to th...
1016
    #     'email/run_completed.html',
e2637443   Antoine Goutenoir   Send emails to ad...
1017
1018
1019
1020
1021
1022
1023
1024
1025
    #     # run=run,
    # )
    # send_email(
    #     'goutte@protonmail.com',
    #     subject=u"[TCFC] New run request",
    #     message=email_content
    # )

    return "ok"