# SPDX-License-Identifier: Apache-2.0 # Copyright 2020 Contributors to OpenLEADR # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # http://www.apache.org/licenses/LICENSE-2.0 # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. import asyncio import inspect import logging import ssl from datetime import datetime, timedelta, timezone from functools import partial from http import HTTPStatus import aiohttp from lxml.etree import XMLSyntaxError from signxml.exceptions import InvalidSignature from apscheduler.schedulers.asyncio import AsyncIOScheduler from openleadr import enums, objects, errors from openleadr.messaging import create_message, parse_message, \ validate_xml_schema, validate_xml_signature from openleadr import utils import tzlocal logger = logging.getLogger('openleadr') logger.setLevel(logging.INFO) class OpenADRClient: """ Main client class. Most of these methods will be called automatically, but you can always choose to call them manually. """ def __init__(self, ven_name, vtn_url, debug=False, cert=None, key=None, passphrase=None, vtn_fingerprint=None, show_fingerprint=True, ca_file=None, allow_jitter=True, ven_id=None, disable_signature=False, check_hostname=True): """ Initializes a new OpenADR Client (Virtual End Node) :param str ven_name: The name for this VEN :param str vtn_url: The URL of the VTN (Server) to connect to :param bool debug: Whether or not to print debugging messages :param str cert: The path to a PEM-formatted Certificate file to use for signing messages. :param str key: The path to a PEM-formatted Private Key file to use for signing messages. :param str passphrase: The passphrase for the Private Key :param str vtn_fingerprint: The fingerprint for the VTN's certificate to verify incomnig messages :param str show_fingerprint: Whether to print your own fingerprint on startup. Defaults to True. :param str ca_file: The path to the PEM-formatted CA file for validating the VTN server's certificate. :param str ven_id: The ID for this VEN. If you leave this blank, a VEN_ID will be assigned by the VTN. :param bool disable_signature: Whether or not to sign outgoing messages using a public-private key pair in PEM format. """ self.ven_name = ven_name self.vtn_url = vtn_url.rstrip("/") self.ven_id = ven_id self.registration_id = None self.poll_frequency = None self.vtn_fingerprint = vtn_fingerprint self.debug = debug self.check_hostname = check_hostname self.reports = [] self.report_callbacks = {} # Holds the callbacks for each specific report self.report_requests = [] # Keep track of the report requests from the VTN self.incomplete_reports = {} # Holds reports that are being populated over time self.pending_reports = asyncio.Queue() # Holds reports that are waiting to be sent self.scheduler = AsyncIOScheduler(timezone=str(tzlocal.get_localzone())) self.client_session = None self.report_queue_task = None self.received_events = [] # Holds the events that we received. self.responded_events = {} # Holds the events that we already saw. self.cert_path = cert self.key_path = key self.passphrase = passphrase self.ca_file = ca_file self.allow_jitter = allow_jitter if cert and key: with open(cert, 'rb') as file: cert = file.read() with open(key, 'rb') as file: key = file.read() if show_fingerprint: print("") print("*" * 80) print("Your VEN Certificate Fingerprint is ".center(80)) print(f"{utils.certificate_fingerprint(cert).center(80)}".center(80)) print("Please deliver this fingerprint to the VTN.".center(80)) print("You do not need to keep this a secret.".center(80)) print("*" * 80) print("") self._create_message = partial(create_message, cert=cert, key=key, passphrase=passphrase, disable_signature=disable_signature) self.hooks = {'before_send_xml': [], 'after_receive_xml': [], 'before_schema_validation': [], 'before_parse_xml': [], 'after_parse_xml': []} async def run(self): """ Run the client in full-auto mode. """ # if not hasattr(self, 'on_event'): # raise NotImplementedError("You must implement on_event.") self.loop = asyncio.get_event_loop() request_id = None response_type, response_payload = await self.query_registration() if 'registration_id' in response_payload: self.registration_id = response_payload['registration_id'] if response_payload and 'response' in response_payload and 'request_id' in response_payload['response']: request_id = response_payload['response']['request_id'] await self.create_party_registration(ven_id=self.ven_id, request_id=request_id) if not self.registration_id: logger.error("No RegistrationID received from the VTN, aborting.") await self.stop() return await self.register_reports(self.reports) if self.reports: self.report_queue_task = self.loop.create_task(self._report_queue_worker()) # Perform initial event sync await self.sync_events() # Perform an initial poll await self._poll() # Set up automatic polling if self.poll_frequency > timedelta(hours=24): logger.warning("Polling with intervals of more than 24 hours is not supported. " "Will use 24 hours as the polling interval.") self.poll_frequency = timedelta(hours=24) self.scheduler.add_job(self._poll, trigger='interval', seconds=self.poll_frequency.total_seconds()) self.scheduler.add_job(self._event_cleanup, trigger='interval', seconds=300) self.scheduler.start() async def stop(self): """ Cleanly stops the client. Run this coroutine before closing your event loop. """ if self.scheduler.running: self.scheduler.shutdown() if self.report_queue_task: self.report_queue_task.cancel() await self.client_session.close() await asyncio.sleep(0) def add_handler(self, handler, callback): """ Add a callback for the given situation """ if handler not in ('on_event', 'on_update_event'): logger.error("'handler' must be either on_event or on_update_event") return setattr(self, handler, callback) def add_report(self, callback, resource_id, measurement=None, data_collection_mode='incremental', report_specifier_id=None, r_id=None, report_name=enums.REPORT_NAME.TELEMETRY_USAGE, reading_type=enums.READING_TYPE.DIRECT_READ, report_type=enums.REPORT_TYPE.READING, report_duration=None, report_dtstart=None, sampling_rate=None, data_source=None, scale="none", unit=None, power_ac=True, power_hertz=50, power_voltage=230, market_context=None, end_device_asset_mrid=None, report_data_source=None): """ Add a new reporting capability to the client. :param callable callback: A callback or coroutine that will fetch the value for a specific report. This callback will be passed the report_id and the r_id of the requested value. :param str resource_id: A specific name for this resource within this report. :param str measurement: The quantity that is being measured (openleadr.enums.MEASUREMENTS). Optional for TELEMETRY_STATUS reports. :param str data_collection_mode: Whether you want the data to be collected incrementally or at once. If the VTN requests the sampling interval to be higher than the reporting interval, this setting determines if the callback should be called at the sampling rate (with no args, assuming it returns the current value), or at the reporting interval (with date_from and date_to as keyword arguments). Choose 'incremental' for the former case, or 'full' for the latter case. :param str report_specifier_id: A unique identifier for this report. Leave this blank for a random generated id, or fill it in if your VTN depends on this being a known value, or if it needs to be constant between restarts of the client. :param str r_id: A unique identifier for a datapoint in a report. The same remarks apply as for the report_specifier_id. :param str report_name: An OpenADR name for this report (one of openleadr.enums.REPORT_NAME) :param str reading_type: An OpenADR reading type (found in openleadr.enums.READING_TYPE) :param str report_type: An OpenADR report type (found in openleadr.enums.REPORT_TYPE) :param datetime.timedelta report_duration: The time span that can be provided in this report. :param datetime.datetime report_dtstart: The earliest available data for this report (defaults to now). :param datetime.timedelta sampling_rate: The sampling rate for the measurement. :param str unit: The unit for this measurement. :param boolean power_ac: Whether the power is AC (True) or DC (False). Only required when supplying a power-related measurement. :param int power_hertz: Grid frequency of the power. Only required when supplying a power-related measurement. :param int power_voltage: Voltage of the power. Only required when supplying a power-related measurement. :param str market_context: The Market Context that this report belongs to. :param str end_device_asset_mrid: the Meter ID for the end device that is measured by this report. :param report_data_source: A (list of) target(s) that this report is related to. """ # Verify input if report_name not in enums.REPORT_NAME.values and not report_name.startswith('x-'): raise ValueError(f"{report_name} is not a valid report_name. Valid options are " f"{', '.join(enums.REPORT_NAME.values)}", " or any name starting with 'x-'.") if reading_type not in enums.READING_TYPE.values and not reading_type.startswith('x-'): raise ValueError(f"{reading_type} is not a valid reading_type. Valid options are " f"{', '.join(enums.READING_TYPE.values)}" " or any name starting with 'x-'.") if report_type not in enums.REPORT_TYPE.values and not report_type.startswith('x-'): raise ValueError(f"{report_type} is not a valid report_type. Valid options are " f"{', '.join(enums.REPORT_TYPE.values)}" " or any name starting with 'x-'.") if scale not in enums.SI_SCALE_CODE.values: raise ValueError(f"{scale} is not a valid scale. Valid options are " f"{', '.join(enums.SI_SCALE_CODE.values)}") if report_duration is None: logger.warning("You did not provide a 'report_duration' parameter to 'add_report'. " "This parameter should indicate the size of the data buffer that " "can be built up. It will now default to 3600 seconds, which may " "or may not be appropriate for your use case.") report_duration = timedelta(seconds=3600) if report_dtstart is None: report_dtstart = datetime.now(timezone.utc) if sampling_rate is None: sampling_rate = objects.SamplingRate(min_period=timedelta(seconds=10), max_period=timedelta(hours=24), on_change=False) elif isinstance(sampling_rate, timedelta): sampling_rate = objects.SamplingRate(min_period=sampling_rate, max_period=sampling_rate, on_change=False) if data_collection_mode not in ('incremental', 'full'): raise ValueError("The data_collection_mode should be 'incremental' or 'full'.") if data_collection_mode == 'full': args = inspect.signature(callback).parameters if not ('date_from' in args and 'date_to' in args and 'sampling_interval' in args): raise TypeError("Your callback function must accept the 'date_from', 'date_to' " "and 'sampling_interval' arguments if used " "with data_collection_mode 'full'.") # Determine the correct item name, item description and unit if report_name == 'TELEMETRY_STATUS': item_base = None elif isinstance(measurement, objects.Measurement): item_base = measurement elif isinstance(measurement, dict): utils.validate_report_measurement_dict(measurement) power_attributes = object.PowerAttributes(**measurement.get('power_attributes')) or None item_base = objects.Measurement(name=measurement['name'], description=measurement['description'], unit=measurement['unit'], scale=measurement.get('scale'), power_attributes=power_attributes) elif measurement.upper() in enums.MEASUREMENTS.members: item_base = enums.MEASUREMENTS[measurement.upper()] else: item_base = objects.Measurement(name='customUnit', description=measurement, unit=unit, scale=scale) if report_name != 'TELEMETRY_STATUS' and scale is not None: if item_base.scale is not None: if scale in enums.SI_SCALE_CODE.values: item_base.scale = scale else: raise ValueError("The 'scale' argument must be one of '{'. ',join(enums.SI_SCALE_CODE.values)}") # Check if unit is compatible if unit is not None and unit != item_base.unit and unit not in item_base.acceptable_units: logger.warning(f"The supplied unit {unit} for measurement {measurement} " f"will be ignored, {item_base.unit} will be used instead. " f"Allowed units for this measurement are: " f"{', '.join(item_base.acceptable_units)}") # Get or create the relevant Report if report_specifier_id: report = utils.find_by(self.reports, 'report_name', report_name, 'report_specifier_id', report_specifier_id) else: report = utils.find_by(self.reports, 'report_name', report_name) if not report: report_specifier_id = report_specifier_id or utils.generate_id() report = objects.Report(created_date_time=datetime.now(), report_name=report_name, report_specifier_id=report_specifier_id, data_collection_mode=data_collection_mode, duration=report_duration, dtstart=report_dtstart) self.reports.append(report) # Add the new report description to the report target = objects.Target(resource_id=resource_id) r_id = r_id or utils.generate_id() report_description = objects.ReportDescription(r_id=r_id, reading_type=reading_type, report_data_source=target, report_subject=target, report_type=report_type, sampling_rate=sampling_rate, measurement=item_base, market_context=market_context) self.report_callbacks[(report.report_specifier_id, r_id)] = callback report.report_descriptions.append(report_description) return report_specifier_id, r_id def add_hook(self, hook_name, handler): """ You can add a hook at specific points in the request/reponse chain. Your choices are: before_send_xml: you get the actual XML message just before it is sent over the wire after_receive_xml: you get the actual XML immediately after it is received over the wire before_parse_xml: you get the actual XML after its schema has been validated, but before parsing after_parse_xml: you get the message name and message payload after parsing the message """ if hook_name not in self.hooks: raise ValueError(f"The hook_name should be one of {', '.join(self.hooks.keys())}. " f"You provided: {hook_name}.") self.hooks[hook_name].append(handler) ########################################################################### # # # POLLING METHODS # # # ########################################################################### async def poll(self): """ Request the next available message from the Server. This coroutine is called automatically. """ service = 'OadrPoll' message = self._create_message('oadrPoll', ven_id=self.ven_id) response_type, response_payload = await self._perform_request(service, message) return response_type, response_payload ########################################################################### # # # REGISTRATION METHODS # # # ########################################################################### async def query_registration(self): """ Request information about the VTN. """ request_id = utils.generate_id() service = 'EiRegisterParty' message = self._create_message('oadrQueryRegistration', request_id=request_id) response_type, response_payload = await self._perform_request(service, message) return response_type, response_payload async def create_party_registration(self, http_pull_model=True, xml_signature=False, report_only=False, profile_name='2.0b', transport_name='simpleHttp', transport_address=None, ven_id=None, request_id=None, registration_id=None): """ Take the neccessary steps to register this client with the server. :param bool http_pull_model: Whether to use the 'pull' model for HTTP. :param bool xml_signature: Whether to sign each XML message. :param bool report_only: Whether or not this is a reporting-only client which does not deal with Events. :param str profile_name: Which OpenADR profile to use. :param str transport_name: The transport name to use. Either 'simpleHttp' or 'xmpp'. :param str transport_address: Which public-facing address the server should use to communicate. """ if request_id is None: request_id = utils.generate_id() service = 'EiRegisterParty' payload = {'ven_name': self.ven_name, 'ven_id': self.ven_id, 'http_pull_model': http_pull_model, 'xml_signature': xml_signature, 'report_only': report_only, 'profile_name': profile_name, 'transport_name': transport_name, 'transport_address': transport_address, 'registration_id': registration_id} message = self._create_message('oadrCreatePartyRegistration', request_id=request_id, **payload) response_type, response_payload = await self._perform_request(service, message) if response_type is None: return if response_payload['response']['response_code'] != 200: status_code = response_payload['response']['response_code'] status_description = response_payload['response']['response_description'] logger.error(f"Got error on Create Party Registration: " f"{status_code} {status_description}") return if response_payload.get('registration_id'): self.registration_id = response_payload['registration_id'] else: logger.error("No registration ID received from the VTN during registration. " "Will assume that we are not or no longer registered.") self.registration_id = None if response_payload.get('ven_id'): if self.ven_id and response_payload['ven_id'] != self.ven_id: logger.warning(f"The venID that was received from the VTN {response_payload['ven_id']} " "did not match the venID the venID that was previously configured in the " f"OpenLEADR client ({self.ven_id}). Will update the venId in the OpenLEADR " "client to the value supplied by the VEN.") self.ven_id = response_payload['ven_id'] else: logger.error("No venID received from the VTN during registration. " "Will assume that we are not or no longer registered.") if self.registration_id: self.poll_frequency = response_payload.get('requested_oadr_poll_freq', timedelta(seconds=10)) logger.info(f"VEN is now registered with registration ID {self.registration_id} and venID {self.ven_id}.") logger.info(f"The polling frequency is {self.poll_frequency}") return response_type, response_payload async def create_party_reregistration(self, registration_id=None): """ Take the neccessary steps to re-register this client with the server. """ await self.create_party_registration(ven_id=self.ven_id, registration_id=registration_id) if not self.registration_id: logger.error("No RegistrationID received from the VTN, aborting.") await self.stop() return await self.register_reports(self.reports) if self.reports: self.report_queue_task = self.loop.create_task(self._report_queue_worker()) # Perform initial event sync await self.sync_events() async def cancel_party_registration(self): if self.registration_id is None: logger.info("VEN is not registered") return logger.info(f"VEN is registered with registration ID {self.registration_id} and venID {self.ven_id}, trying to un-register") request_id = utils.generate_id() payload = {'request_id': request_id, 'registration_id': self.registration_id, 'ven_id': self.ven_id} service = 'EiRegisterParty' message = self._create_message('oadrCancelPartyRegistration', **payload) response_type, response_payload = await self._perform_request(service, message) if response_type == 'oadrCanceledPartyRegistration' and response_payload['response']['response_code'] == 200: logger.info("VEN successfully un-registered") # Update/Delete all the registration and reports information self.registration_id = None self.report_requests = None self.reports = None self.report_callbacks = None self.report_requests = None self.incomplete_reports = None self.pending_reports = None self.scheduler.remove_all_jobs() else: logger.warning("The VEN couldn't cancel the registration") ########################################################################### # # # EVENT METHODS # # # ########################################################################### async def request_event(self, reply_limit=None): """ Request the next Event from the VTN, if it has any. """ payload = {'request_id': utils.generate_id(), 'ven_id': self.ven_id, 'reply_limit': reply_limit} message = self._create_message('oadrRequestEvent', **payload) service = 'EiEvent' response_type, response_payload = await self._perform_request(service, message) return response_type, response_payload async def created_event(self, request_id, event_id, opt_type, modification_number=0): """ Inform the VTN that we created an event. """ service = 'EiEvent' payload = {'ven_id': self.ven_id, 'response': {'response_code': 200, 'response_description': 'OK', 'request_id': request_id}, 'event_responses': [{'response_code': 200, 'response_description': 'OK', 'request_id': request_id, 'event_id': event_id, 'modification_number': modification_number, 'opt_type': opt_type}]} message = self._create_message('oadrCreatedEvent', **payload) response_type, response_payload = await self._perform_request(service, message) async def sync_events(self): """ Used to perform an initial sync of events after the client connects """ response_type, response_payload = await self.request_event() if 'events' in response_payload and len(response_payload['events']) > 0: await self._on_event(response_payload) ########################################################################### # # # REPORTING METHODS # # # ########################################################################### async def register_reports(self, reports): """ Tell the VTN about our reports. The VTN miht respond with an oadrCreateReport message that tells us which reports are to be sent. """ # When registering reports, they need to have the current time as the creation time for report in reports: report.created_date_time = datetime.now() request_id = utils.generate_id() payload = {'request_id': request_id, 'ven_id': self.ven_id, 'reports': reports, 'report_request_id': 0} for report in payload['reports']: utils.setmember(report, 'report_request_id', 0) service = 'EiReport' message = self._create_message('oadrRegisterReport', **payload) response_type, response_payload = await self._perform_request(service, message) # Handle the subscriptions that the VTN is interested in. if 'report_requests' in response_payload: for report_request in response_payload['report_requests']: await self.create_report(report_request) # Send the oadrCreatedReport message message_type = 'oadrCreatedReport' message_payload = {'pending_reports': [{'report_request_id': utils.getmember(report, 'report_request_id')} for report in self.report_requests]} message = self._create_message(message_type, response={'response_code': 200, 'response_description': 'OK', 'request_id': response_payload['response']['request_id']}, ven_id=self.ven_id, **message_payload) response_type, response_payload = await self._perform_request(service, message) async def create_report(self, report_request): """ Add the requested reports to the reporting mechanism. This is called when the VTN requests reports from us. :param report_request dict: The oadrReportRequest dict from the VTN. """ # Get the relevant variables from the report requests report_request_id = report_request['report_request_id'] report_specifier_id = report_request['report_specifier']['report_specifier_id'] report_back_duration = report_request['report_specifier'].get('report_back_duration') granularity = report_request['report_specifier']['granularity'] # Check if this report actually exists report = utils.find_by(self.reports, 'report_specifier_id', report_specifier_id) if not report: logger.error(f"A non-existant report with report_specifier_id " f"{report_specifier_id} was requested.") return False # Check and collect the requested r_ids for this report requested_r_ids = [] for specifier_payload in report_request['report_specifier']['specifier_payloads']: r_id = specifier_payload['r_id'] # Check if the requested r_id actually exists rd = utils.find_by(report.report_descriptions, 'r_id', r_id) if not rd: logger.error(f"A non-existant report with r_id {r_id} " f"inside report with report_specifier_id {report_specifier_id} " f"was requested.") continue # Check if the requested measurement exists and if the correct unit is requested if 'measurement' in specifier_payload: measurement = specifier_payload['measurement'] if measurement['description'] != rd.measurement.description: logger.error(f"A non-matching measurement description for report with " f"report_request_id {report_request_id} and r_id {r_id} was given " f"by the VTN. Offered: {rd.measurement.description}, " f"requested: {measurement['description']}") continue if measurement['unit'] != rd.measurement.unit: logger.error(f"A non-matching measurement unit for report with " f"report_request_id {report_request_id} and r_id {r_id} was given " f"by the VTN. Offered: {rd.measurement.unit}, " f"requested: {measurement['unit']}") continue if granularity is not None: if not rd.sampling_rate.min_period <= granularity <= rd.sampling_rate.max_period: logger.error(f"An invalid sampling rate {granularity} was requested for report " f"with report_specifier_id {report_specifier_id} and r_id {r_id}. " f"The offered sampling rate was between " f"{rd.sampling_rate.min_period} and " f"{rd.sampling_rate.max_period}") continue else: # If no granularity is specified, set it to the lowest sampling rate. granularity = rd.sampling_rate.max_period requested_r_ids.append(r_id) callback = partial(self.update_report, report_request_id=report_request_id) reporting_interval = report_back_duration or granularity job = self.scheduler.add_job(func=callback, trigger='cron', **utils.cron_config(reporting_interval)) self.report_requests.append({'report_request_id': report_request_id, 'report_specifier_id': report_specifier_id, 'report_back_duration': report_back_duration, 'r_ids': requested_r_ids, 'granularity': granularity, 'job': job}) async def create_single_report(self, report_request): """ Create a single report in response to a request from the VTN. """ async def update_report(self, report_request_id): """ Call the previously registered report callback and send the result as a message to the VTN. """ logger.debug(f"Running update_report for {report_request_id}") report_request = utils.find_by(self.report_requests, 'report_request_id', report_request_id) granularity = report_request['granularity'] report_back_duration = report_request['report_back_duration'] report_specifier_id = report_request['report_specifier_id'] report = utils.find_by(self.reports, 'report_specifier_id', report_specifier_id) data_collection_mode = report.data_collection_mode if report_request_id in self.incomplete_reports: logger.debug("We were already compiling this report") outgoing_report = self.incomplete_reports[report_request_id] else: logger.debug("There is no report in progress") outgoing_report = objects.Report(report_request_id=report_request_id, report_specifier_id=report.report_specifier_id, report_name=report.report_name, intervals=[]) intervals = outgoing_report.intervals or [] if data_collection_mode == 'full': if report_back_duration is None: report_back_duration = granularity date_to = datetime.now(timezone.utc) date_from = date_to - max(report_back_duration, granularity) for r_id in report_request['r_ids']: report_callback = self.report_callbacks[(report_specifier_id, r_id)] result = report_callback(date_from=date_from, date_to=date_to, sampling_interval=granularity) if asyncio.iscoroutine(result): result = await result for dt, value in result: report_payload = objects.ReportPayload(r_id=r_id, value=value) intervals.append(objects.ReportInterval(dtstart=dt, report_payload=report_payload)) else: for r_id in report_request['r_ids']: report_callback = self.report_callbacks[(report_specifier_id, r_id)] result = report_callback() if asyncio.iscoroutine(result): result = await result if isinstance(result, (int, float)): result = [(datetime.now(timezone.utc), result)] for dt, value in result: logger.info(f"Adding {dt}, {value} to report") report_payload = objects.ReportPayload(r_id=r_id, value=value) intervals.append(objects.ReportInterval(dtstart=dt, report_payload=report_payload)) outgoing_report.intervals = intervals logger.info(f"The number of intervals in the report is now {len(outgoing_report.intervals)}") # Always set the dtstart of the report to the earliest datetime of any of the intervals if outgoing_report.intervals: outgoing_report.dtstart = min(interval.dtstart for interval in outgoing_report.intervals) # Figure out if the report is complete after this sampling if data_collection_mode == 'incremental' and report_back_duration is not None\ and report_back_duration > granularity: report_interval = report_back_duration.total_seconds() sampling_interval = granularity.total_seconds() expected_len = len(report_request['r_ids']) * int(report_interval / sampling_interval) if len(outgoing_report.intervals) == expected_len: logger.info("The report is now complete with all the values. Will queue for sending.") await self.pending_reports.put(self.incomplete_reports.pop(report_request_id)) else: logger.debug("The report is not yet complete, will hold until it is.") self.incomplete_reports[report_request_id] = outgoing_report else: logger.info("Report will be sent now.") await self.pending_reports.put(outgoing_report) async def cancel_report(self, payload): """ Cancel this report. """ async def _report_queue_worker(self): """ A Queue worker that pushes out the pending reports. """ try: while True: report = await self.pending_reports.get() service = 'EiReport' message = self._create_message('oadrUpdateReport', ven_id=self.ven_id, request_id=utils.generate_id(), reports=[report]) try: response_type, response_payload = await self._perform_request(service, message) except Exception as err: logger.error(f"Unable to send the report to the VTN. Error: {err}") else: if 'cancel_report' in response_payload: await self.cancel_report(response_payload['cancel_report']) except asyncio.CancelledError: return ########################################################################### # # # PLACEHOLDER # # # ########################################################################### async def on_event(self, event): """ Placeholder for the on_event handler. """ logger.warning("You should implement your own on_event handler. This handler receives " "an Event dict and should return either 'optIn' or 'optOut' based on your " "choice. Will opt out of the event for now.") return 'optOut' async def on_update_event(self, event): """ Placeholder for the on_update_event handler. """ logger.warning("An Event was updated, but you don't have an on_updated_event handler configured. " "You should implement your own on_update_event handler. This handler receives " "an Event dict and should return either 'optIn' or 'optOut' based on your " "choice. Will re-use the previous opt status for this event_id for now") if event['event_descriptor']['event_id'] in self.responded_events: return self.responded_events.get(event['event_descriptor']['event_id']) async def on_cancel_party_registration(self, message): if self.registration_id is None: logger.info('VEN is not registered, doing nothing') return if 'registration_id' in message: if self.registration_id != message['registration_id']: logger.info( f"Cancel request is not for us: VEN registrationID is {self.registration_id}, requested for {message['registration_id']}") response = {'response_code': 452, 'response_description': 'ERROR', 'request_id': message['request_id']} message = self._create_message('oadrCanceledPartyRegistration', response=response, ven_id=self.ven_id, registration_id=self.registration_id) service = 'EiRegisterParty' response_type, response_payload = await self._perform_request(service, message) logger.info(response_type, response_payload) return else: response = {'response_code': 200, 'response_description': 'OK', 'request_id': message['request_id']} else: return # Update/Delete all the registration and reports information self.report_requests = None self.reports = None self.report_callbacks = None self.report_requests = None self.incomplete_reports = None self.pending_reports = None self.scheduler.remove_all_jobs() message = self._create_message('oadrCanceledPartyRegistration', response=response, ven_id=self.ven_id, registration_id=self.registration_id) service = 'EiRegisterParty' response_type, response_payload = await self._perform_request(service, message) self.registration_id = None logger.info(response_type, response_payload) ########################################################################### # # # EMPTY RESPONSES # # # ########################################################################### async def send_response(self, service, response_code=200, response_description="OK", request_id=None): """ Send an empty oadrResponse, for instance after receiving oadrRequestReregistration. """ msg = self._create_message('oadrResponse', ven_id=self.ven_id, response={'response_code': response_code, 'response_description': response_description, 'request_id': request_id}) await self._perform_request(service, msg) ########################################################################### # # # LOW LEVEL # # # ########################################################################### async def _perform_request(self, service, message): await self._ensure_client_session() url = f"{self.vtn_url}/{service}" try: await self._execute_hooks('before_send_xml', utils.ensure_str(message)) async with self.client_session.post(url, data=message) as req: content = await req.read() await self._execute_hooks('after_receive_xml', utils.ensure_str(content)) if req.status != HTTPStatus.OK: logger.warning(f"Non-OK status {req.status} when performing a request to {url} " f"with data {message}: {req.status} {content.decode('utf-8')}") return None, {} except aiohttp.client_exceptions.ClientConnectorError as err: # Could not connect to server logger.error(f"Could not connect to server with URL {self.vtn_url}:") logger.error(f"{err.__class__.__name__}: {str(err)}") return None, {} except Exception as err: logger.error(f"Request error {err.__class__.__name__}:{err}") return None, {} if len(content) == 0: return None try: await self._execute_hooks('before_schema_validation', utils.ensure_str(content)) tree = validate_xml_schema(content) if self.vtn_fingerprint: validate_xml_signature(tree, cert_fingerprint=self.vtn_fingerprint) await self._execute_hooks('before_parse_xml', utils.ensure_str(content)) message_type, message_payload = parse_message(content) await self._execute_hooks('after_parse_xml', message_type, message_payload) except XMLSyntaxError as err: logger.warning(f"Incoming message did not pass XML schema validation: {err}") return None, {} except errors.FingerprintMismatch as err: logger.warning(err) return None, {} except InvalidSignature: logger.warning("Incoming message had invalid signature, ignoring.") return None, {} except Exception as err: logger.error(f"The incoming message could not be parsed or validated: {err}") return None, {} if 'response' in message_payload and 'response_code' in message_payload['response']: if message_payload['response']['response_code'] != 200: logger.warning("We got a non-OK OpenADR response from the server: " f"{message_payload['response']['response_code']}: " f"{message_payload['response']['response_description']}") return message_type, message_payload async def _execute_hooks(self, hook_name, *args, **kwargs): for hook in self.hooks[hook_name]: try: await utils.await_if_required(hook(*args, **kwargs)) except Exception as err: logger.error(f"An error occurred while executing your '{hook_name}': {hook}:" f"{err.__class__.__name__}: {err}") async def _on_event(self, message): logger.debug("The VEN received an event") events = message['events'] try: results = [] for event in message['events']: event_id = event['event_descriptor']['event_id'] event_status = event['event_descriptor']['event_status'] modification_number = event['event_descriptor']['modification_number'] received_event = utils.find_by(self.received_events, 'event_descriptor.event_id', event_id) if received_event: if received_event['event_descriptor']['modification_number'] == modification_number: # Re-submit the same opt type as we already had previously result = self.responded_events[event_id] else: # Replace the event with the fresh copy utils.pop_by(self.received_events, 'event_descriptor.event_id', event_id) self.received_events.append(event) # Wait for the result of the on_update_event handler result = await utils.await_if_required(self.on_update_event(event)) else: # Wait for the result of the on_event self.received_events.append(event) result = self.on_event(event) if asyncio.iscoroutine(result): result = await result results.append(result) if event_status in (enums.EVENT_STATUS.COMPLETED, enums.EVENT_STATUS.CANCELLED) \ and event_id in self.responded_events: self.responded_events.pop(event_id) else: self.responded_events[event_id] = result for i, result in enumerate(results): if result not in ('optIn', 'optOut') and events[i]['response_required'] == 'always': logger.error("Your on_event or on_update_event handler must return 'optIn' or 'optOut'; " f"you supplied {result}. Please fix your on_event handler.") results[i] = 'optOut' except Exception as err: logger.error("Your on_event handler encountered an error. Will Opt Out of the event. " f"The error was {err.__class__.__name__}: {str(err)}") results = ['optOut'] * len(events) event_responses = [{'response_code': 200, 'response_description': 'OK', 'opt_type': results[i], 'request_id': message['request_id'], 'modification_number': events[i]['event_descriptor']['modification_number'], 'event_id': events[i]['event_descriptor']['event_id']} for i, event in enumerate(events) if event['response_required'] == 'always' and not utils.determine_event_status(event['active_period']) == 'completed'] if len(event_responses) > 0: logger.info(f"Total event_responses: {len(event_responses)}") response = {'response_code': 200, 'response_description': 'OK', 'request_id': message['request_id']} message = self._create_message('oadrCreatedEvent', response=response, event_responses=event_responses, ven_id=self.ven_id) service = 'EiEvent' response_type, response_payload = await self._perform_request(service, message) logger.info(response_type, response_payload) else: logger.info("Not sending any event responses, because a response was not required/allowed by the VTN.") async def _event_cleanup(self): """ Periodic task that will clean up completed and cancelled events in our memory. """ for event in self.received_events: if event['event_descriptor']['event_status'] == 'cancelled' or \ utils.determine_event_status(event['active_period']) == 'completed': logger.info(f"Removing event {event} because it is no longer relevant.") self.received_events.pop(self.received_events.index(event)) async def _poll(self): logger.debug("Now polling for new messages") response_type, response_payload = await self.poll() if response_type is None: return elif response_type == 'oadrResponse': logger.debug("Received empty response from the VTN.") return elif response_type == 'oadrRequestReregistration': logger.info("The VTN required us to re-register. Calling the registration procedure.") await self.send_response(service='EiRegisterParty') await self.create_party_registration() elif response_type == 'oadrDistributeEvent': if 'events' in response_payload and len(response_payload['events']) > 0: await self._on_event(response_payload) elif response_type == 'oadrUpdateReport': await self._on_report(response_payload) elif response_type == 'oadrCreateReport': if 'report_requests' in response_payload: for report_request in response_payload['report_requests']: await self.create_report(report_request) elif response_type == 'oadrRegisterReport': # We don't support receiving reports from the VTN at this moment logger.warning("The VTN offered reports, but OpenLEADR " "does not support reports in this direction.") message = self._create_message('oadrRegisteredReport', report_requests=[], ven_id=self.ven_id, response={'response_code': 200, 'response_description': 'OK', 'request_id': response_payload['request_id']}) service = 'EiReport' reponse_type, response_payload = await self._perform_request(service, message) elif response_type == 'oadrCancelPartyRegistration': logger.info("The VTN required us to cancel the registration. Calling the cancel party registration procedure.") await self.on_cancel_party_registration(response_payload) else: logger.warning(f"No handler implemented for incoming message " f"of type {response_type}, ignoring.") # Immediately poll again, because there might be more messages await self._poll() async def _ensure_client_session(self): if not self.client_session: headers = {'content-type': 'application/xml'} client_timeout = aiohttp.ClientTimeout(sock_connect=5, sock_read=10) if self.cert_path: ssl_context = ssl.SSLContext(ssl.PROTOCOL_TLS_CLIENT) ssl_context.load_verify_locations(self.ca_file) ssl_context.load_cert_chain(self.cert_path, self.key_path, self.passphrase) ssl_context.check_hostname = self.check_hostname connector = aiohttp.TCPConnector(ssl=ssl_context) self.client_session = aiohttp.ClientSession( connector=connector, headers=headers, timeout=client_timeout ) else: self.client_session = aiohttp.ClientSession( headers=headers, timeout=client_timeout )