utilities.py

# Copyright 2018 Calum Loudon
#
# Licensed under the Apache License, Version 2.0 (the "License"). You may not 
# use this file except in compliance with the License. A copy of the License
# is located at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR 
# CONDITIONS OF ANY KIND, express or implied. See the License for the specific
# language governing permissions and limitations under the License.

# This file contains a number of utilities.

import time
import uuid

from logutilities import log_info, log_debug, log_error
#from userDetails import USER_DETAILS

def get_utc_timestamp(seconds=None):
    return time.strftime("%Y-%m-%dT%H:%M:%S.00Z", time.gmtime(seconds))

def get_uuid():
    return str(uuid.uuid4())

def verify_static_user(user):
    # Check we know about this user
    #if user in USER_DETAILS:
    #    log_debug("Recognise user %s", user)
    #else:
        log_error("Don't recognise user %s", user)

def verify_request(primitives, endpoint, capability, directive):
    # Check we know about this endpoint
    if endpoint in primitives:
        log_debug("Recognise endpoint %s", endpoint)

        if capability in primitives[endpoint]:
            log_debug("Recognise capability %s", capability)

            if directive in primitives[endpoint][capability]:
                log_debug("Recognise directive %s", directive)
            else:
                log_error("Don't recognise directive %s", directive)
        else:
            log_error("Don't recognise capability %s", capability)
    else:
        log_error("Don't recognise endpoint %s", endpoint)

def verify_devices(devices, database):
    # Check we recognise the list of devices the user has.  As we'er running
    # as a lambda, don't worry too much about raising and catching exceptions;
    # the important thing is to log it.
    log_debug("Validate user devices exist in DB")
    bad_device = False
    for device in devices:
        log_debug("Check user device %s", device['friendly_name']) 
        manu = device['manufacturer']
        model = device['model']
        if manu in database:
            if model in database[manu]:
                log_debug("Manu %s, model %s found OK", manu, model)
            else:
                log_error("Device %s with manu %s has incorrect model %s", device['friendly_name'], manu, model)
                bad_device = True
        else:
            log_error("Device %s has incorrect manu %s", device['friendly_name'], manu)
            bad_device = True

def find_target(device, targets):
    # Check which target is associated with this device
    if 'target' in device:
        target = device['target']
        log_debug("This device is associated with target %s", target)
    else:
        target = 'primary'
        log_debug("No target specified - assume primary")

    if target in targets:
        t = targets[target]
    else:
        t = None

    return t

def get_repeats(device_details):
    if 'IRrepeats' in device_details:
        repeats = device_details['IRrepeats']
    else:
        repeats = 0

    return repeats

def get_connected_device(user_devices, global_database, device):
    next_device_name = device['connected_to']['next_device']
    log_debug("Next connected device is %s", next_device_name)
    device  = find_device_from_friendly_name(user_devices, next_device_name)
    device_details = find_user_device_in_DB(device, global_database)
    return next_device_name, device, device_details

def find_user_device_in_DB(device, database):
    # Given a user device, return the details in the device DB
    manu = device['manufacturer']
    model = device['model']
    return database[manu][model]

def find_device_from_friendly_name(devices, friendly_name):
    # Given a device friendly name, find it in the list of user devices
    for d in devices:
        if d['friendly_name'] == friendly_name:
            return d