myems/myems-api/core/point.py

542 lines
24 KiB
Python

import falcon
import simplejson as json
import mysql.connector
import config
from core.userlogger import user_logger
class PointCollection:
@staticmethod
def __init__():
""""Initializes PointCollection"""
pass
@staticmethod
def on_options(req, resp):
resp.status = falcon.HTTP_200
@staticmethod
def on_get(req, resp):
cnx = mysql.connector.connect(**config.myems_system_db)
cursor = cnx.cursor(dictionary=True)
query = (" SELECT id, name, uuid "
" FROM tbl_data_sources ")
cursor.execute(query)
rows_data_sources = cursor.fetchall()
data_source_dict = dict()
if rows_data_sources is not None and len(rows_data_sources) > 0:
for row in rows_data_sources:
data_source_dict[row['id']] = {"id": row['id'],
"name": row['name'],
"uuid": row['uuid']}
query = (" SELECT id, name, data_source_id, object_type, units, "
" high_limit, low_limit, ratio, is_trend, is_virtual, address, description "
" FROM tbl_points ")
cursor.execute(query)
rows = cursor.fetchall()
cursor.close()
cnx.disconnect()
result = list()
if rows is not None and len(rows) > 0:
for row in rows:
data_source = data_source_dict.get(row['data_source_id'], None)
meta_result = {"id": row['id'],
"name": row['name'],
"data_source": data_source,
"object_type": row['object_type'],
"units": row['units'],
"high_limit": row['high_limit'],
"low_limit": row['low_limit'],
"ratio": float(row['ratio']),
"is_trend": bool(row['is_trend']),
"is_virtual": bool(row['is_virtual']),
"address": row['address'],
"description": row['description']}
result.append(meta_result)
resp.body = json.dumps(result)
@staticmethod
@user_logger
def on_post(req, resp):
"""Handles POST requests"""
try:
raw_json = req.stream.read().decode('utf-8')
except Exception as ex:
raise falcon.HTTPError(falcon.HTTP_400, 'API.ERROR', ex)
new_values = json.loads(raw_json)
if 'name' not in new_values['data'].keys() or \
not isinstance(new_values['data']['name'], str) or \
len(str.strip(new_values['data']['name'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_POINT_NAME')
name = str.strip(new_values['data']['name'])
if 'data_source_id' not in new_values['data'].keys() or \
not isinstance(new_values['data']['data_source_id'], int) or \
new_values['data']['data_source_id'] <= 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_DATA_SOURCE_ID')
data_source_id = new_values['data']['data_source_id']
if 'object_type' not in new_values['data'].keys() \
or str.strip(new_values['data']['object_type']) not in ('ENERGY_VALUE', 'ANALOG_VALUE', 'DIGITAL_VALUE'):
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.INVALID_OBJECT_TYPE')
object_type = str.strip(new_values['data']['object_type'])
if 'units' not in new_values['data'].keys() or \
not isinstance(new_values['data']['units'], str) or \
len(str.strip(new_values['data']['units'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_UNITS')
units = str.strip(new_values['data']['units'])
if 'high_limit' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['high_limit'], float) or
isinstance(new_values['data']['high_limit'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_LOW_LIMIT_VALUE')
high_limit = new_values['data']['high_limit']
if 'low_limit' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['low_limit'], float) or
isinstance(new_values['data']['low_limit'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_LOW_LIMIT_VALUE')
low_limit = new_values['data']['low_limit']
if 'ratio' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['ratio'], float) or
isinstance(new_values['data']['ratio'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_RATIO_VALUE')
ratio = new_values['data']['ratio']
if 'is_trend' not in new_values['data'].keys() or \
not isinstance(new_values['data']['is_trend'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_TREND_VALUE')
is_trend = new_values['data']['is_trend']
if 'is_virtual' not in new_values['data'].keys() or \
not isinstance(new_values['data']['is_virtual'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_VIRTUAL_VALUE')
if new_values['data']['is_virtual'] is True and object_type != 'ANALOG_VALUE':
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.VIRTUAL_POINT_SHOULD_BE_ANALOG_VALUE')
is_virtual = new_values['data']['is_virtual']
if 'address' not in new_values['data'].keys() or \
not isinstance(new_values['data']['address'], str) or \
len(str.strip(new_values['data']['address'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_ADDRESS')
address = str.strip(new_values['data']['address'])
if 'description' in new_values['data'].keys() and \
new_values['data']['description'] is not None and \
len(str(new_values['data']['description'])) > 0:
description = str.strip(new_values['data']['description'])
else:
description = None
cnx = mysql.connector.connect(**config.myems_system_db)
cursor = cnx.cursor()
cursor.execute(" SELECT name "
" FROM tbl_points "
" WHERE name = %s AND data_source_id = %s ", (name, data_source_id))
if cursor.fetchone() is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_404, title='API.BAD_REQUEST',
description='API.POINT_NAME_IS_ALREADY_IN_USE')
cursor.execute(" SELECT name "
" FROM tbl_data_sources "
" WHERE id = %s ", (data_source_id,))
if cursor.fetchone() is None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_DATA_SOURCE_ID')
add_value = (" INSERT INTO tbl_points (name, data_source_id, "
" object_type, units, high_limit, low_limit, ratio, "
" is_trend, is_virtual, address, description) "
" VALUES (%s, %s, %s, %s, %s, %s, %s, %s, %s, %s, %s) ")
cursor.execute(add_value, (name,
data_source_id,
object_type,
units,
high_limit,
low_limit,
ratio,
is_trend,
is_virtual,
address,
description))
new_id = cursor.lastrowid
cnx.commit()
cursor.close()
cnx.disconnect()
resp.status = falcon.HTTP_201
resp.location = '/points/' + str(new_id)
class PointItem:
@staticmethod
def __init__():
""""Initializes PointItem"""
pass
@staticmethod
def on_options(req, resp, id_):
resp.status = falcon.HTTP_200
@staticmethod
def on_get(req, resp, id_):
if not id_.isdigit() or int(id_) <= 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_POINT_ID')
cnx = mysql.connector.connect(**config.myems_system_db)
cursor = cnx.cursor(dictionary=True)
query = (" SELECT id, name, uuid "
" FROM tbl_data_sources ")
cursor.execute(query)
rows_data_sources = cursor.fetchall()
data_source_dict = dict()
if rows_data_sources is not None and len(rows_data_sources) > 0:
for row in rows_data_sources:
data_source_dict[row['id']] = {"id": row['id'],
"name": row['name'],
"uuid": row['uuid']}
query = (" SELECT id, name, data_source_id, object_type, units, "
" high_limit, low_limit, ratio, is_trend, is_virtual, address, description "
" FROM tbl_points "
" WHERE id = %s ")
cursor.execute(query, (id_,))
row = cursor.fetchone()
cursor.close()
cnx.disconnect()
if row is None:
raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND',
description='API.POINT_NOT_FOUND')
data_source = data_source_dict.get(row['data_source_id'], None)
result = {"id": row['id'],
"name": row['name'],
"data_source": data_source,
"object_type": row['object_type'],
"units": row['units'],
"high_limit": row['high_limit'],
"low_limit": row['low_limit'],
"ratio": float(row['ratio']),
"is_trend": bool(row['is_trend']),
"is_virtual": bool(row['is_virtual']),
"address": row['address'],
"description": row['description']}
resp.body = json.dumps(result)
@staticmethod
@user_logger
def on_delete(req, resp, id_):
if not id_.isdigit() or int(id_) <= 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_POINT_ID')
cnx = mysql.connector.connect(**config.myems_system_db)
cursor = cnx.cursor()
cursor.execute(" SELECT name "
" FROM tbl_points "
" WHERE id = %s ", (id_,))
if cursor.fetchone() is None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND',
description='API.POINT_NOT_FOUND')
# check if this point is being used by meters
cursor.execute(" SELECT meter_id "
" FROM tbl_meters_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_meter = cursor.fetchone()
if row_meter is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_METERS')
# check if this point is being used by sensors
cursor.execute(" SELECT sensor_id "
" FROM tbl_sensors_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_sensor = cursor.fetchone()
if row_sensor is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_SENSORS')
# check if this point is being used by shopfloors
cursor.execute(" SELECT shopfloor_id "
" FROM tbl_shopfloors_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_shopfloor = cursor.fetchone()
if row_shopfloor is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_SHOPFLOORS')
# check if this point is being used by stores
cursor.execute(" SELECT store_id "
" FROM tbl_stores_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_store = cursor.fetchone()
if row_store is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_STORES')
# check if this point is being used by spaces
cursor.execute(" SELECT space_id "
" FROM tbl_spaces_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_space = cursor.fetchone()
if row_space is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_SPACES')
# check if this point is being used by tenants
cursor.execute(" SELECT tenant_id "
" FROM tbl_tenants_points "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_tenant = cursor.fetchone()
if row_tenant is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_TENANTS')
# check if this point is being used by equipment parameters
cursor.execute(" SELECT equipment_id "
" FROM tbl_equipments_parameters "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_equipment = cursor.fetchone()
if row_equipment is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_EQUIPMENT_PARAMETERS')
# check if this point is being used by combined equipment parameters
cursor.execute(" SELECT combined_equipment_id "
" FROM tbl_combined_equipments_parameters "
" WHERE point_id = %s "
" LIMIT 1 ",
(id_,))
row_combined_equipment = cursor.fetchone()
if row_combined_equipment is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.THERE_IS_RELATION_WITH_COMBINED_EQUIPMENT_PARAMETERS')
cursor.execute(" DELETE FROM tbl_points WHERE id = %s ", (id_,))
cnx.commit()
cursor.close()
cnx.disconnect()
resp.status = falcon.HTTP_204
@staticmethod
@user_logger
def on_put(req, resp, id_):
"""Handles PUT requests"""
try:
raw_json = req.stream.read().decode('utf-8')
except Exception as ex:
raise falcon.HTTPError(falcon.HTTP_400, title='API.EXCEPTION', description=ex)
if not id_.isdigit() or int(id_) <= 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_POINT_ID')
new_values = json.loads(raw_json)
if 'name' not in new_values['data'].keys() or \
not isinstance(new_values['data']['name'], str) or \
len(str.strip(new_values['data']['name'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_POINT_NAME')
name = str.strip(new_values['data']['name'])
if 'data_source_id' not in new_values['data'].keys() or \
not isinstance(new_values['data']['data_source_id'], int) or \
new_values['data']['data_source_id'] <= 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_DATA_SOURCE_ID')
data_source_id = new_values['data']['data_source_id']
if 'object_type' not in new_values['data'].keys() \
or str.strip(new_values['data']['object_type']) not in ('ENERGY_VALUE', 'ANALOG_VALUE', 'DIGITAL_VALUE'):
raise falcon.HTTPError(falcon.HTTP_400,
title='API.BAD_REQUEST',
description='API.INVALID_OBJECT_TYPE')
object_type = str.strip(new_values['data']['object_type'])
if 'units' not in new_values['data'].keys() or \
not isinstance(new_values['data']['units'], str) or \
len(str.strip(new_values['data']['units'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_UNITS')
units = str.strip(new_values['data']['units'])
if 'high_limit' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['high_limit'], float) or
isinstance(new_values['data']['high_limit'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_LOW_LIMIT_VALUE')
high_limit = new_values['data']['high_limit']
if 'low_limit' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['low_limit'], float) or
isinstance(new_values['data']['low_limit'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_LOW_LIMIT_VALUE')
low_limit = new_values['data']['low_limit']
if 'ratio' not in new_values['data'].keys() or \
not (isinstance(new_values['data']['ratio'], float) or
isinstance(new_values['data']['ratio'], int)):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_RATIO_VALUE')
ratio = new_values['data']['ratio']
if 'is_trend' not in new_values['data'].keys() or \
not isinstance(new_values['data']['is_trend'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_TREND_VALUE')
is_trend = new_values['data']['is_trend']
if 'is_virtual' not in new_values['data'].keys() or \
not isinstance(new_values['data']['is_virtual'], bool):
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_IS_VIRTUAL_VALUE')
if new_values['data']['is_virtual'] is True and object_type != 'ANALOG_VALUE':
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.VIRTUAL_POINT_SHOULD_BE_ANALOG_VALUE')
is_virtual = new_values['data']['is_virtual']
if 'address' not in new_values['data'].keys() or \
not isinstance(new_values['data']['address'], str) or \
len(str.strip(new_values['data']['address'])) == 0:
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_ADDRESS')
address = str.strip(new_values['data']['address'])
if 'description' in new_values['data'].keys() and \
new_values['data']['description'] is not None and \
len(str(new_values['data']['description'])) > 0:
description = str.strip(new_values['data']['description'])
else:
description = None
cnx = mysql.connector.connect(**config.myems_system_db)
cursor = cnx.cursor()
cursor.execute(" SELECT name "
" FROM tbl_points "
" WHERE id = %s ", (id_,))
if cursor.fetchone() is None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_404, title='API.NOT_FOUND',
description='API.POINT_NOT_FOUND')
cursor.execute(" SELECT name "
" FROM tbl_data_sources "
" WHERE id = %s ", (data_source_id,))
if cursor.fetchone() is None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_400, title='API.BAD_REQUEST',
description='API.INVALID_DATA_SOURCE_ID')
cursor.execute(" SELECT name "
" FROM tbl_points "
" WHERE name = %s AND data_source_id = %s AND id != %s ", (name, data_source_id, id_))
if cursor.fetchone() is not None:
cursor.close()
cnx.disconnect()
raise falcon.HTTPError(falcon.HTTP_404, title='API.BAD_REQUEST',
description='API.POINT_NAME_IS_ALREADY_IN_USE')
update_row = (" UPDATE tbl_points "
" SET name = %s, data_source_id = %s, "
" object_type = %s, units = %s, "
" high_limit = %s, low_limit = %s, ratio = %s, "
" is_trend = %s, is_virtual = %s, address = %s, description = %s "
" WHERE id = %s ")
cursor.execute(update_row, (name,
data_source_id,
object_type,
units,
high_limit,
low_limit,
ratio,
is_trend,
is_virtual,
address,
description,
id_,))
cnx.commit()
cursor.close()
cnx.disconnect()
resp.status = falcon.HTTP_200