Issues (1577)

myems-api/reports/spaceload.py (3 issues)

1
import re
2
from datetime import datetime, timedelta, timezone
3
from decimal import Decimal
4
import falcon
5
import mysql.connector
6
import simplejson as json
7
import config
8
import excelexporters.spaceload
9
from core import utilities
10
from core.useractivity import access_control, api_key_control
11
12
13
class Reporting:
14
    def __init__(self):
15
        """"Initializes Reporting"""
16
        pass
17
18
    @staticmethod
19
    def on_options(req, resp):
20
        _ = req
21
        resp.status = falcon.HTTP_200
22
23
    ####################################################################################################################
24
    # PROCEDURES
25
    # Step 1: valid parameters
26
    # Step 2: query the space
27
    # Step 3: query energy categories
28
    # Step 4: query associated sensors
29
    # Step 5: query associated points
30
    # Step 6: query base period energy input
31
    # Step 7: query reporting period energy input
32
    # Step 8: query tariff data
33
    # Step 9: query associated sensors and points data
34
    # Step 10: construct the report
35
    ####################################################################################################################
36
    @staticmethod
37
    def on_get(req, resp):
38
        if 'API-KEY' not in req.headers or \
39
                not isinstance(req.headers['API-KEY'], str) or \
40
                len(str.strip(req.headers['API-KEY'])) == 0:
41
            access_control(req)
42
        else:
43
            api_key_control(req)
44
        print(req.params)
45
        space_id = req.params.get('spaceid')
46
        space_uuid = req.params.get('spaceuuid')
47
        period_type = req.params.get('periodtype')
48
        base_period_start_datetime_local = req.params.get('baseperiodstartdatetime')
49
        base_period_end_datetime_local = req.params.get('baseperiodenddatetime')
50
        reporting_period_start_datetime_local = req.params.get('reportingperiodstartdatetime')
51
        reporting_period_end_datetime_local = req.params.get('reportingperiodenddatetime')
52
        language = req.params.get('language')
53
        quick_mode = req.params.get('quickmode')
54
55
        ################################################################################################################
56
        # Step 1: valid parameters
57
        ################################################################################################################
58
        if space_id is None and space_uuid is None:
59
            raise falcon.HTTPError(status=falcon.HTTP_400,
60
                                   title='API.BAD_REQUEST',
61
                                   description='API.INVALID_SPACE_ID')
62
63
        if space_id is not None:
64
            space_id = str.strip(space_id)
65
            if not space_id.isdigit() or int(space_id) <= 0:
66
                raise falcon.HTTPError(status=falcon.HTTP_400,
67
                                       title='API.BAD_REQUEST',
68
                                       description='API.INVALID_SPACE_ID')
69
70
        if space_uuid is not None:
71
            regex = re.compile(r'^[a-f0-9]{8}-?[a-f0-9]{4}-?4[a-f0-9]{3}-?[89ab][a-f0-9]{3}-?[a-f0-9]{12}\Z', re.I)
72
            match = regex.match(str.strip(space_uuid))
73
            if not bool(match):
74
                raise falcon.HTTPError(status=falcon.HTTP_400,
75
                                       title='API.BAD_REQUEST',
76
                                       description='API.INVALID_SPACE_UUID')
77
78
        if period_type is None:
79
            raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
80
                                   description='API.INVALID_PERIOD_TYPE')
81
        else:
82
            period_type = str.strip(period_type)
83
            if period_type not in ['hourly', 'daily', 'weekly', 'monthly', 'yearly']:
84
                raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
85
                                       description='API.INVALID_PERIOD_TYPE')
86
87
        timezone_offset = int(config.utc_offset[1:3]) * 60 + int(config.utc_offset[4:6])
88
        if config.utc_offset[0] == '-':
89
            timezone_offset = -timezone_offset
90
91
        base_start_datetime_utc = None
92
        if base_period_start_datetime_local is not None and len(str.strip(base_period_start_datetime_local)) > 0:
93
            base_period_start_datetime_local = str.strip(base_period_start_datetime_local)
94
            try:
95
                base_start_datetime_utc = datetime.strptime(base_period_start_datetime_local, '%Y-%m-%dT%H:%M:%S')
96
            except ValueError:
97
                raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
98
                                       description="API.INVALID_BASE_PERIOD_START_DATETIME")
99
            base_start_datetime_utc = \
100
                base_start_datetime_utc.replace(tzinfo=timezone.utc) - timedelta(minutes=timezone_offset)
101
            # nomalize the start datetime
102
            if config.minutes_to_count == 30 and base_start_datetime_utc.minute >= 30:
103
                base_start_datetime_utc = base_start_datetime_utc.replace(minute=30, second=0, microsecond=0)
104
            else:
105
                base_start_datetime_utc = base_start_datetime_utc.replace(minute=0, second=0, microsecond=0)
106
107
        base_end_datetime_utc = None
108
        if base_period_end_datetime_local is not None and len(str.strip(base_period_end_datetime_local)) > 0:
109
            base_period_end_datetime_local = str.strip(base_period_end_datetime_local)
110
            try:
111
                base_end_datetime_utc = datetime.strptime(base_period_end_datetime_local, '%Y-%m-%dT%H:%M:%S')
112
            except ValueError:
113
                raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
114
                                       description="API.INVALID_BASE_PERIOD_END_DATETIME")
115
            base_end_datetime_utc = \
116
                base_end_datetime_utc.replace(tzinfo=timezone.utc) - timedelta(minutes=timezone_offset)
117
118
        if base_start_datetime_utc is not None and base_end_datetime_utc is not None and \
119
                base_start_datetime_utc >= base_end_datetime_utc:
120
            raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
121
                                   description='API.INVALID_BASE_PERIOD_END_DATETIME')
122
123
        if reporting_period_start_datetime_local is None:
124
            raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
125
                                   description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
126
        else:
127
            reporting_period_start_datetime_local = str.strip(reporting_period_start_datetime_local)
128
            try:
129
                reporting_start_datetime_utc = datetime.strptime(reporting_period_start_datetime_local,
130
                                                                 '%Y-%m-%dT%H:%M:%S')
131
            except ValueError:
132
                raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
133
                                       description="API.INVALID_REPORTING_PERIOD_START_DATETIME")
134
            reporting_start_datetime_utc = \
135
                reporting_start_datetime_utc.replace(tzinfo=timezone.utc) - timedelta(minutes=timezone_offset)
136
            # nomalize the start datetime
137
            if config.minutes_to_count == 30 and reporting_start_datetime_utc.minute >= 30:
138
                reporting_start_datetime_utc = reporting_start_datetime_utc.replace(minute=30, second=0, microsecond=0)
139
            else:
140
                reporting_start_datetime_utc = reporting_start_datetime_utc.replace(minute=0, second=0, microsecond=0)
141
142
        if reporting_period_end_datetime_local is None:
143
            raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
144
                                   description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
145
        else:
146
            reporting_period_end_datetime_local = str.strip(reporting_period_end_datetime_local)
147
            try:
148
                reporting_end_datetime_utc = datetime.strptime(reporting_period_end_datetime_local,
149
                                                               '%Y-%m-%dT%H:%M:%S').replace(tzinfo=timezone.utc) - \
150
                                             timedelta(minutes=timezone_offset)
151
            except ValueError:
152
                raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
153
                                       description="API.INVALID_REPORTING_PERIOD_END_DATETIME")
154
155
        if reporting_start_datetime_utc >= reporting_end_datetime_utc:
156
            raise falcon.HTTPError(status=falcon.HTTP_400, title='API.BAD_REQUEST',
157
                                   description='API.INVALID_REPORTING_PERIOD_END_DATETIME')
158
159
        # if turn quick mode on, do not return parameters data and excel file
160
        is_quick_mode = False
161
        if quick_mode is not None and \
162
                len(str.strip(quick_mode)) > 0 and \
163
                str.lower(str.strip(quick_mode)) in ('true', 't', 'on', 'yes', 'y'):
164
            is_quick_mode = True
165
166
        trans = utilities.get_translation(language)
167
        trans.install()
168
        _ = trans.gettext
169
170
        ################################################################################################################
171
        # Step 2: query the space
172
        ################################################################################################################
173
        cnx_system = mysql.connector.connect(**config.myems_system_db)
174
        cursor_system = cnx_system.cursor()
175
176
        cnx_energy = mysql.connector.connect(**config.myems_energy_db)
177
        cursor_energy = cnx_energy.cursor()
178
179
        cnx_historical = mysql.connector.connect(**config.myems_historical_db)
180
        cursor_historical = cnx_historical.cursor()
181
182
        if space_id is not None:
183
            cursor_system.execute(" SELECT id, name, area, number_of_occupants, cost_center_id "
184
                                  " FROM tbl_spaces "
185
                                  " WHERE id = %s ", (space_id,))
186
            row_space = cursor_system.fetchone()
187
        elif space_uuid is not None:
188
            cursor_system.execute(" SELECT id, name, area, number_of_occupants, cost_center_id "
189
                                  " FROM tbl_spaces "
190
                                  " WHERE uuid = %s ", (space_uuid,))
191
            row_space = cursor_system.fetchone()
192
193 View Code Duplication
        if row_space is None:
0 ignored issues
show
The variable row_space does not seem to be defined for all execution paths.
Loading history...
This code seems to be duplicated in your project.
Loading history...
194
            if cursor_system:
195
                cursor_system.close()
196
            if cnx_system:
197
                cnx_system.close()
198
199
            if cursor_energy:
200
                cursor_energy.close()
201
            if cnx_energy:
202
                cnx_energy.close()
203
204
            if cursor_historical:
205
                cursor_historical.close()
206
            if cnx_historical:
207
                cnx_historical.close()
208
            raise falcon.HTTPError(status=falcon.HTTP_404, title='API.NOT_FOUND', description='API.SPACE_NOT_FOUND')
209
210
        space = dict()
211
        space['id'] = row_space[0]
212
        space['name'] = row_space[1]
213
        space['area'] = row_space[2]
214
        space['number_of_occupants'] = row_space[3]
215
        space['cost_center_id'] = row_space[4]
216
217
        ################################################################################################################
218
        # Step 3: query energy categories
219
        ################################################################################################################
220
        energy_category_set = set()
221
        # query energy categories in base period
222
        cursor_energy.execute(" SELECT DISTINCT(energy_category_id) "
223
                              " FROM tbl_space_input_category_hourly "
224
                              " WHERE space_id = %s "
225
                              "     AND start_datetime_utc >= %s "
226
                              "     AND start_datetime_utc < %s ",
227
                              (space['id'], base_start_datetime_utc, base_end_datetime_utc))
228
        rows_energy_categories = cursor_energy.fetchall()
229
        if rows_energy_categories is not None and len(rows_energy_categories) > 0:
230
            for row_energy_category in rows_energy_categories:
231
                energy_category_set.add(row_energy_category[0])
232
233
        # query energy categories in reporting period
234
        cursor_energy.execute(" SELECT DISTINCT(energy_category_id) "
235
                              " FROM tbl_space_input_category_hourly "
236
                              " WHERE space_id = %s "
237
                              "     AND start_datetime_utc >= %s "
238
                              "     AND start_datetime_utc < %s ",
239
                              (space['id'], reporting_start_datetime_utc, reporting_end_datetime_utc))
240
        rows_energy_categories = cursor_energy.fetchall()
241
        if rows_energy_categories is not None and len(rows_energy_categories) > 0:
242
            for row_energy_category in rows_energy_categories:
243
                energy_category_set.add(row_energy_category[0])
244
245
        # query all energy categories in base period and reporting period
246
        cursor_system.execute(" SELECT id, name, unit_of_measure, kgce, kgco2e "
247
                              " FROM tbl_energy_categories "
248
                              " ORDER BY id ", )
249
        rows_energy_categories = cursor_system.fetchall()
250
        if rows_energy_categories is None or len(rows_energy_categories) == 0:
251
            if cursor_system:
252
                cursor_system.close()
253
            if cnx_system:
254
                cnx_system.close()
255
256
            if cursor_energy:
257
                cursor_energy.close()
258
            if cnx_energy:
259
                cnx_energy.close()
260
261
            if cursor_historical:
262
                cursor_historical.close()
263
            if cnx_historical:
264
                cnx_historical.close()
265
            raise falcon.HTTPError(status=falcon.HTTP_404,
266
                                   title='API.NOT_FOUND',
267
                                   description='API.ENERGY_CATEGORY_NOT_FOUND')
268
        energy_category_dict = dict()
269
        for row_energy_category in rows_energy_categories:
270
            if row_energy_category[0] in energy_category_set:
271
                energy_category_dict[row_energy_category[0]] = {"name": row_energy_category[1],
272
                                                                "unit_of_measure": row_energy_category[2],
273
                                                                "kgce": row_energy_category[3],
274
                                                                "kgco2e": row_energy_category[4]}
275
276
        ################################################################################################################
277
        # Step 4: query associated sensors
278
        ################################################################################################################
279
        point_list = list()
280
        cursor_system.execute(" SELECT po.id, po.name, po.units, po.object_type  "
281
                              " FROM tbl_spaces sp, tbl_sensors se, tbl_spaces_sensors spse, "
282
                              "      tbl_points po, tbl_sensors_points sepo "
283
                              " WHERE sp.id = %s AND sp.id = spse.space_id AND spse.sensor_id = se.id "
284
                              "       AND se.id = sepo.sensor_id AND sepo.point_id = po.id "
285
                              " ORDER BY po.id ", (space['id'],))
286
        rows_points = cursor_system.fetchall()
287
        if rows_points is not None and len(rows_points) > 0:
288
            for row in rows_points:
289
                point_list.append({"id": row[0], "name": row[1], "units": row[2], "object_type": row[3]})
290
291
        ################################################################################################################
292
        # Step 5: query associated points
293
        ################################################################################################################
294
        cursor_system.execute(" SELECT po.id, po.name, po.units, po.object_type  "
295
                              " FROM tbl_spaces sp, tbl_spaces_points sppo, tbl_points po "
296
                              " WHERE sp.id = %s AND sp.id = sppo.space_id AND sppo.point_id = po.id "
297
                              " ORDER BY po.id ", (space['id'],))
298
        rows_points = cursor_system.fetchall()
299
        if rows_points is not None and len(rows_points) > 0:
300
            for row in rows_points:
301
                point_list.append({"id": row[0], "name": row[1], "units": row[2], "object_type": row[3]})
302
303
        ################################################################################################################
304
        # Step 6: query base period energy input
305
        ################################################################################################################
306
        base = dict()
307
        if energy_category_set is not None and len(energy_category_set) > 0:
308
            for energy_category_id in energy_category_set:
309
                base[energy_category_id] = dict()
310
                base[energy_category_id]['timestamps'] = list()
311
                base[energy_category_id]['sub_averages'] = list()
312
                base[energy_category_id]['sub_maximums'] = list()
313
                base[energy_category_id]['average'] = None
314
                base[energy_category_id]['maximum'] = None
315
                base[energy_category_id]['factor'] = None
316
317
                cursor_energy.execute(" SELECT start_datetime_utc, actual_value "
318
                                      " FROM tbl_space_input_category_hourly "
319
                                      " WHERE space_id = %s "
320
                                      "     AND energy_category_id = %s "
321
                                      "     AND start_datetime_utc >= %s "
322
                                      "     AND start_datetime_utc < %s "
323
                                      " ORDER BY start_datetime_utc ",
324
                                      (space['id'],
325
                                       energy_category_id,
326
                                       base_start_datetime_utc,
327
                                       base_end_datetime_utc))
328
                rows_space_hourly = cursor_energy.fetchall()
329
330
                rows_space_periodically, \
331
                    base[energy_category_id]['average'], \
332
                    base[energy_category_id]['maximum'] = \
333
                    utilities.averaging_hourly_data_by_period(rows_space_hourly,
334
                                                              base_start_datetime_utc,
335
                                                              base_end_datetime_utc,
336
                                                              period_type)
337
                base[energy_category_id]['factor'] = \
338
                    (base[energy_category_id]['average'] / base[energy_category_id]['maximum']
339
                     if (base[energy_category_id]['average'] is not None and
340
                         base[energy_category_id]['maximum'] is not None and
341
                         base[energy_category_id]['maximum'] > Decimal(0.0))
342
                     else None)
343
344
                for row_space_periodically in rows_space_periodically:
345
                    current_datetime_local = row_space_periodically[0].replace(tzinfo=timezone.utc) + \
346
                                             timedelta(minutes=timezone_offset)
347
                    if period_type == 'hourly':
348
                        current_datetime = current_datetime_local.isoformat()[0:19]
349
                    elif period_type == 'daily':
350
                        current_datetime = current_datetime_local.isoformat()[0:10]
351
                    elif period_type == 'weekly':
352
                        current_datetime = current_datetime_local.isoformat()[0:10]
353
                    elif period_type == 'monthly':
354
                        current_datetime = current_datetime_local.isoformat()[0:7]
355
                    elif period_type == 'yearly':
356
                        current_datetime = current_datetime_local.isoformat()[0:4]
357
358
                    base[energy_category_id]['timestamps'].append(current_datetime)
0 ignored issues
show
The variable current_datetime does not seem to be defined for all execution paths.
Loading history...
359
                    base[energy_category_id]['sub_averages'].append(row_space_periodically[1])
360
                    base[energy_category_id]['sub_maximums'].append(row_space_periodically[2])
361
362
        ################################################################################################################
363
        # Step 7: query reporting period energy input
364
        ################################################################################################################
365
        reporting = dict()
366
        if energy_category_set is not None and len(energy_category_set) > 0:
367
            for energy_category_id in energy_category_set:
368
                reporting[energy_category_id] = dict()
369
                reporting[energy_category_id]['timestamps'] = list()
370
                reporting[energy_category_id]['sub_averages'] = list()
371
                reporting[energy_category_id]['sub_maximums'] = list()
372
                reporting[energy_category_id]['average'] = None
373
                reporting[energy_category_id]['maximum'] = None
374
                reporting[energy_category_id]['factor'] = None
375
376
                cursor_energy.execute(" SELECT start_datetime_utc, actual_value "
377
                                      " FROM tbl_space_input_category_hourly "
378
                                      " WHERE space_id = %s "
379
                                      "     AND energy_category_id = %s "
380
                                      "     AND start_datetime_utc >= %s "
381
                                      "     AND start_datetime_utc < %s "
382
                                      " ORDER BY start_datetime_utc ",
383
                                      (space['id'],
384
                                       energy_category_id,
385
                                       reporting_start_datetime_utc,
386
                                       reporting_end_datetime_utc))
387
                rows_space_hourly = cursor_energy.fetchall()
388
389
                rows_space_periodically, \
390
                    reporting[energy_category_id]['average'], \
391
                    reporting[energy_category_id]['maximum'] = \
392
                    utilities.averaging_hourly_data_by_period(rows_space_hourly,
393
                                                              reporting_start_datetime_utc,
394
                                                              reporting_end_datetime_utc,
395
                                                              period_type)
396
                reporting[energy_category_id]['factor'] = \
397
                    (reporting[energy_category_id]['average'] / reporting[energy_category_id]['maximum']
398
                     if (reporting[energy_category_id]['average'] is not None and
399
                         reporting[energy_category_id]['maximum'] is not None and
400
                         reporting[energy_category_id]['maximum'] > Decimal(0.0))
401
                     else None)
402
403
                for row_space_periodically in rows_space_periodically:
404
                    current_datetime_local = row_space_periodically[0].replace(tzinfo=timezone.utc) + \
405
                                             timedelta(minutes=timezone_offset)
406
                    if period_type == 'hourly':
407
                        current_datetime = current_datetime_local.isoformat()[0:19]
408
                    elif period_type == 'daily':
409
                        current_datetime = current_datetime_local.isoformat()[0:10]
410
                    elif period_type == 'weekly':
411
                        current_datetime = current_datetime_local.isoformat()[0:10]
412
                    elif period_type == 'monthly':
413
                        current_datetime = current_datetime_local.isoformat()[0:7]
414
                    elif period_type == 'yearly':
415
                        current_datetime = current_datetime_local.isoformat()[0:4]
416
417
                    reporting[energy_category_id]['timestamps'].append(current_datetime)
418
                    reporting[energy_category_id]['sub_averages'].append(row_space_periodically[1])
419
                    reporting[energy_category_id]['sub_maximums'].append(row_space_periodically[2])
420
421
        ################################################################################################################
422
        # Step 8: query tariff data
423
        ################################################################################################################
424
        parameters_data = dict()
425
        parameters_data['names'] = list()
426
        parameters_data['timestamps'] = list()
427
        parameters_data['values'] = list()
428
        if config.is_tariff_appended and not is_quick_mode:
429
            if energy_category_set is not None and len(energy_category_set) > 0:
430
                for energy_category_id in energy_category_set:
431
                    energy_category_tariff_dict = utilities.get_energy_category_tariffs(space['cost_center_id'],
432
                                                                                        energy_category_id,
433
                                                                                        reporting_start_datetime_utc,
434
                                                                                        reporting_end_datetime_utc)
435
                    tariff_timestamp_list = list()
436
                    tariff_value_list = list()
437
                    for k, v in energy_category_tariff_dict.items():
438
                        # convert k from utc to local
439
                        k = k + timedelta(minutes=timezone_offset)
440
                        tariff_timestamp_list.append(k.isoformat()[0:19])
441
                        tariff_value_list.append(v)
442
443
                    parameters_data['names'].append(_('Tariff') + '-' +
444
                                                    energy_category_dict[energy_category_id]['name'])
445
                    parameters_data['timestamps'].append(tariff_timestamp_list)
446
                    parameters_data['values'].append(tariff_value_list)
447
448
        ################################################################################################################
449
        # Step 9: query associated sensors and points data
450
        ################################################################################################################
451
        if not is_quick_mode:
452
            for point in point_list:
453
                point_values = []
454
                point_timestamps = []
455
                if point['object_type'] == 'ENERGY_VALUE':
456
                    query = (" SELECT utc_date_time, actual_value "
457
                             " FROM tbl_energy_value "
458
                             " WHERE point_id = %s "
459
                             "       AND utc_date_time BETWEEN %s AND %s "
460
                             " ORDER BY utc_date_time ")
461
                    cursor_historical.execute(query, (point['id'],
462
                                                      reporting_start_datetime_utc,
463
                                                      reporting_end_datetime_utc))
464
                    rows = cursor_historical.fetchall()
465
466
                    if rows is not None and len(rows) > 0:
467
                        for row in rows:
468
                            current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
469
                                                     timedelta(minutes=timezone_offset)
470
                            current_datetime = current_datetime_local.isoformat()[0:19]
471
                            point_timestamps.append(current_datetime)
472
                            point_values.append(row[1])
473
                elif point['object_type'] == 'ANALOG_VALUE':
474
                    query = (" SELECT utc_date_time, actual_value "
475
                             " FROM tbl_analog_value "
476
                             " WHERE point_id = %s "
477
                             "       AND utc_date_time BETWEEN %s AND %s "
478
                             " ORDER BY utc_date_time ")
479
                    cursor_historical.execute(query, (point['id'],
480
                                                      reporting_start_datetime_utc,
481
                                                      reporting_end_datetime_utc))
482
                    rows = cursor_historical.fetchall()
483
484
                    if rows is not None and len(rows) > 0:
485
                        for row in rows:
486
                            current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
487
                                                     timedelta(minutes=timezone_offset)
488
                            current_datetime = current_datetime_local.isoformat()[0:19]
489
                            point_timestamps.append(current_datetime)
490
                            point_values.append(row[1])
491
                elif point['object_type'] == 'DIGITAL_VALUE':
492
                    query = (" SELECT utc_date_time, actual_value "
493
                             " FROM tbl_digital_value "
494
                             " WHERE point_id = %s "
495
                             "       AND utc_date_time BETWEEN %s AND %s "
496
                             " ORDER BY utc_date_time ")
497
                    cursor_historical.execute(query, (point['id'],
498
                                                      reporting_start_datetime_utc,
499
                                                      reporting_end_datetime_utc))
500
                    rows = cursor_historical.fetchall()
501
502
                    if rows is not None and len(rows) > 0:
503
                        for row in rows:
504
                            current_datetime_local = row[0].replace(tzinfo=timezone.utc) + \
505
                                                     timedelta(minutes=timezone_offset)
506
                            current_datetime = current_datetime_local.isoformat()[0:19]
507
                            point_timestamps.append(current_datetime)
508
                            point_values.append(row[1])
509
510
                parameters_data['names'].append(point['name'] + ' (' + point['units'] + ')')
511
                parameters_data['timestamps'].append(point_timestamps)
512
                parameters_data['values'].append(point_values)
513
514
        ################################################################################################################
515
        # Step 10: construct the report
516
        ################################################################################################################
517
        if cursor_system:
518
            cursor_system.close()
519
        if cnx_system:
520
            cnx_system.close()
521
522
        if cursor_energy:
523
            cursor_energy.close()
524
        if cnx_energy:
525
            cnx_energy.close()
526
527
        if cursor_historical:
528
            cursor_historical.close()
529
        if cnx_historical:
530
            cnx_historical.close()
531
532
        result = dict()
533
534
        result['space'] = dict()
535
        result['space']['name'] = space['name']
536
        result['space']['area'] = space['area']
537
        result['space']['number_of_occupants'] = space['number_of_occupants']
538
539
        result['base_period'] = dict()
540
        result['base_period']['names'] = list()
541
        result['base_period']['units'] = list()
542
        result['base_period']['timestamps'] = list()
543
        result['base_period']['sub_averages'] = list()
544
        result['base_period']['sub_maximums'] = list()
545
        result['base_period']['averages'] = list()
546
        result['base_period']['maximums'] = list()
547
        result['base_period']['factors'] = list()
548
        if energy_category_set is not None and len(energy_category_set) > 0:
549
            for energy_category_id in energy_category_set:
550
                result['base_period']['names'].append(energy_category_dict[energy_category_id]['name'])
551
                result['base_period']['units'].append(energy_category_dict[energy_category_id]['unit_of_measure'])
552
                result['base_period']['timestamps'].append(base[energy_category_id]['timestamps'])
553
                result['base_period']['sub_averages'].append(base[energy_category_id]['sub_averages'])
554
                result['base_period']['sub_maximums'].append(base[energy_category_id]['sub_maximums'])
555
                result['base_period']['averages'].append(base[energy_category_id]['average'])
556
                result['base_period']['maximums'].append(base[energy_category_id]['maximum'])
557
                result['base_period']['factors'].append(base[energy_category_id]['factor'])
558
559
        result['reporting_period'] = dict()
560
        result['reporting_period']['names'] = list()
561
        result['reporting_period']['energy_category_ids'] = list()
562
        result['reporting_period']['units'] = list()
563
        result['reporting_period']['timestamps'] = list()
564
        result['reporting_period']['sub_averages'] = list()
565
        result['reporting_period']['sub_maximums'] = list()
566
        result['reporting_period']['rates_of_sub_maximums'] = list()
567
        result['reporting_period']['averages'] = list()
568
        result['reporting_period']['averages_per_unit_area'] = list()
569
        result['reporting_period']['averages_per_capita'] = list()
570
        result['reporting_period']['averages_increment_rate'] = list()
571
        result['reporting_period']['maximums'] = list()
572
        result['reporting_period']['maximums_per_unit_area'] = list()
573
        result['reporting_period']['maximums_per_capita'] = list()
574
        result['reporting_period']['maximums_increment_rate'] = list()
575
        result['reporting_period']['factors'] = list()
576
        result['reporting_period']['factors_increment_rate'] = list()
577
578
        if energy_category_set is not None and len(energy_category_set) > 0:
579
            for energy_category_id in energy_category_set:
580
                result['reporting_period']['names'].append(energy_category_dict[energy_category_id]['name'])
581
                result['reporting_period']['energy_category_ids'].append(energy_category_id)
582
                result['reporting_period']['units'].append(energy_category_dict[energy_category_id]['unit_of_measure'])
583
                result['reporting_period']['timestamps'].append(reporting[energy_category_id]['timestamps'])
584
                result['reporting_period']['sub_averages'].append(reporting[energy_category_id]['sub_averages'])
585
                result['reporting_period']['sub_maximums'].append(reporting[energy_category_id]['sub_maximums'])
586
                result['reporting_period']['averages'].append(reporting[energy_category_id]['average'])
587
                result['reporting_period']['averages_per_unit_area'].append(
588
                    reporting[energy_category_id]['average'] / space['area']
589
                    if reporting[energy_category_id]['average'] is not None and
590
                    space['area'] is not None and
591
                    space['area'] > Decimal(0.0)
592
                    else None)
593
                result['reporting_period']['averages_per_capita'].append(
594
                    reporting[energy_category_id]['average'] / space['number_of_occupants']
595
                    if reporting[energy_category_id]['average'] is not None and
596
                    space['number_of_occupants'] is not None and
597
                    space['number_of_occupants'] > Decimal(0.0)
598
                    else None)
599
                result['reporting_period']['averages_increment_rate'].append(
600
                    (reporting[energy_category_id]['average'] - base[energy_category_id]['average']) /
601
                    base[energy_category_id]['average'] if (reporting[energy_category_id]['average'] is not None and
602
                                                            base[energy_category_id]['average'] is not None and
603
                                                            base[energy_category_id]['average'] > Decimal(0.0))
604
                    else None)
605
                result['reporting_period']['maximums'].append(reporting[energy_category_id]['maximum'])
606
                result['reporting_period']['maximums_increment_rate'].append(
607
                    (reporting[energy_category_id]['maximum'] - base[energy_category_id]['maximum']) /
608
                    base[energy_category_id]['maximum'] if (reporting[energy_category_id]['maximum'] is not None and
609
                                                            base[energy_category_id]['maximum'] is not None and
610
                                                            base[energy_category_id]['maximum'] > Decimal(0.0))
611
                    else None)
612
                result['reporting_period']['maximums_per_unit_area'].append(
613
                    reporting[energy_category_id]['maximum'] / space['area']
614
                    if reporting[energy_category_id]['maximum'] is not None and
615
                    space['area'] is not None and
616
                    space['area'] > Decimal(0.0)
617
                    else None)
618
                result['reporting_period']['maximums_per_capita'].append(
619
                    reporting[energy_category_id]['maximum'] / space['number_of_occupants']
620
                    if reporting[energy_category_id]['maximum'] is not None and
621
                    space['number_of_occupants'] is not None and
622
                    space['number_of_occupants'] > Decimal(0.0)
623
                    else None)
624
                result['reporting_period']['factors'].append(reporting[energy_category_id]['factor'])
625
                result['reporting_period']['factors_increment_rate'].append(
626
                    (reporting[energy_category_id]['factor'] - base[energy_category_id]['factor']) /
627
                    base[energy_category_id]['factor'] if (reporting[energy_category_id]['factor'] is not None and
628
                                                           base[energy_category_id]['factor'] is not None and
629
                                                           base[energy_category_id]['factor'] > Decimal(0.0))
630
                    else None)
631
632
                rate = list()
633
                for index, value in enumerate(reporting[energy_category_id]['sub_maximums']):
634
                    if index < len(base[energy_category_id]['sub_maximums']) \
635
                            and base[energy_category_id]['sub_maximums'][index] != 0 and value != 0\
636
                            and base[energy_category_id]['sub_maximums'][index] is not None and value is not None:
637
                        rate.append((value - base[energy_category_id]['sub_maximums'][index])
638
                                    / base[energy_category_id]['sub_maximums'][index])
639
                    else:
640
                        rate.append(None)
641
                result['reporting_period']['rates_of_sub_maximums'].append(rate)
642
643
        result['parameters'] = {
644
            "names": parameters_data['names'],
645
            "timestamps": parameters_data['timestamps'],
646
            "values": parameters_data['values']
647
        }
648
        # export result to Excel file and then encode the file to base64 string
649
        if not is_quick_mode:
650
            result['excel_bytes_base64'] = excelexporters.spaceload.export(result,
651
                                                                           space['name'],
652
                                                                           base_period_start_datetime_local,
653
                                                                           base_period_end_datetime_local,
654
                                                                           reporting_period_start_datetime_local,
655
                                                                           reporting_period_end_datetime_local,
656
                                                                           period_type,
657
                                                                           language)
658
659
        resp.text = json.dumps(result)
660