pysage3.py

# -----------------------------------------------------------------------------
#  Copyright (c) SAGE3 Development Team 2022. All Rights Reserved
#  University of Hawaii, University of Illinois Chicago, Virginia Tech
#
#  Distributed under the terms of the SAGE3 License.  The full license is in
#  the file LICENSE, distributed as part of this software.
# -----------------------------------------------------------------------------

# TODO: checking messages that are created at the same time and only executing the first
#  one keeping info in received_msg_log for now. These seems to be related to raised=True

# TODO: add a new validator function that takes a message received on a
#  channel and makes sure it's structurally valid, i.e., has all the required fields
#  and no unknown fields

# TODO prevent apps updates on fields that were touched?
import uuid
import json
import copy
from typing import List
from foresight.board import Board
from foresight.room import Room
from foresight.smartbitfactory import SmartBitFactory
from foresight.utils.sage_communication import SageCommunication
from foresight.smartbits.genericsmartbit import GenericSmartBit
from foresight.utils.sage_websocket import SageWebsocket
from foresight.json_templates.templates import create_app_template
# TODO import functions explicitely below
from foresight.alignment_strategies import *
from pydantic import BaseModel, Field


class PySage3:
    def __init__(self, conf, prod_type):
        print("Configuring ps3 client ... ")

        self.done_init = False
        self.conf = conf
        self.prod_type = prod_type
        self.__MSG_METHODS = {
            "CREATE": self.__handle_create,
            "UPDATE": self.__handle_update,
            "DELETE": self.__handle_delete,
        }

        self.rooms = {}
        self.s3_comm = SageCommunication(self.conf, self.prod_type)
        self.socket = SageWebsocket(on_message_fn=self.__process_messages)

        self.socket.subscribe(["/api/apps", "/api/rooms", "/api/boards"])
        # Grab and load info already on the board
        self.__populate_existing()
        self.room = None
        self.board = None
        self.done_init = True
        print("Completed configuring Sage3 Client")

    def __populate_existing(self):
        rooms_info = self.s3_comm.get_rooms()
        for room_info in rooms_info:
            self.__handle_create("ROOMS", room_info)
        # Populate existing boards
        boards_info = self.s3_comm.get_boards()
        for board_info in boards_info:
            self.__handle_create("BOARDS", board_info)
        # Populate existing apps
        apps_info = self.s3_comm.get_apps()
        for app_info in apps_info:

            self.__handle_create("APPS", app_info)

    def create_app(self, room_id, board_id, app_type, state, app=None):
        try:
            obj = create_app_template
            if app:
                obj.update(app)
            obj["type"] = app_type
            obj["roomId"] = room_id
            obj["boardId"] = board_id
            obj["state"].update(state)
            if app_type not in SmartBitFactory.class_names:
                raise Exception("Smartbit not supported in interactive mode")

            # just try to create to see if it's going to raise an error
            _ = SmartBitFactory.create_smartbit(
                {
                    "_id": str(uuid.uuid4()),
                    "data": obj,
                    "state": obj["state"],
                }
            )
            return self.s3_comm.create_app(obj)
        except Exception as e:
            print(f"Error during creation of app {e}")
            return None

    def upload_file(self, room_id, filename, filedata):
        try:
            payload = {"room": room_id}
            files = {"files": (filename, filedata)}
            return self.s3_comm.upload_file(files, payload)
        except Exception as e:
            print(f"Error during creation of app {e}")
            return None

    def get_tags(self, app_id):
        try:
            res = self.s3_comm.get_tags(app_id)
            info = res.json()
            if info["success"]:
                tags = info["data"][0]["data"]["labels"]
                return tags
            else:
                return []
        except Exception as e:
            print(f"Error during getting tags {e}")
            return []

    def update_tags(self, app_id, tags):
        try:
            return self.s3_comm.update_tags(app_id, {"labels": tags})
        except Exception as e:
            print(f"Error during updating tags {e}")
            return None

    def get_alltags(self):
        try:
            res = self.s3_comm.get_alltags()
            info = res.json()
            if info["success"]:
                alls = info["data"]
                tags = {}
                for a in alls:
                    # print(a)
                    tags[a["data"]["app_id"]] = a["data"]["labels"]
                return tags
            else:
                return []
        except Exception as e:
            print(f"Error during getting tags {e}")
            return []

    def __remove_keys_from_dict__(self, app_dict, keys_to_remove):
        def _remove_keys_from_dict(d, keys_to_remove):
            if isinstance(d, dict):
                for key in list(d.keys()):  # Use list() to avoid 'dictionary changed size during iteration' error
                    if key in keys_to_remove:
                        del d[key]
                    else:
                        _remove_keys_from_dict(d[key], keys_to_remove)
            elif isinstance(d, list):
                for item in d:
                    _remove_keys_from_dict(item, keys_to_remove)

        # Create a deep copy of the input dictionary
        app_dict_copy = copy.deepcopy(app_dict)
        # Remove keys from the copied dictionary
        _remove_keys_from_dict(app_dict_copy, keys_to_remove)
        return app_dict_copy

    def delete_app(self, app_id):
        try:
            return self.s3_comm.delete_app(app_id)
        except Exception as e:
            print(f"Error during delete of app {e}")
            return None

    # Handle Create Messages
    def __handle_create(self, collection, doc):
        # we need state to be at the same level as data
        if collection == "ROOMS":
            new_room = Room(doc)
            self.rooms[new_room.id] = new_room
        elif collection == "BOARDS":
            new_board = Board(doc)
            if new_board.roomId in self.rooms:
                self.rooms[new_board.roomId].boards[new_board.id] = new_board
        elif collection == "APPS":
            doc["state"] = doc["data"]["state"]
            del doc["data"]["state"]
            smartbit = SmartBitFactory.create_smartbit(doc)
            room_id = doc["data"]["roomId"]
            board_id = doc["data"]["boardId"]
            if room_id in self.rooms:
                if board_id in self.rooms[room_id].boards and smartbit:
                    self.rooms[room_id].boards[board_id].smartbits[
                        smartbit.app_id
                    ] = smartbit

    # Handle Update Messages
    def __handle_update(self, collection, doc, updates):
        # TODO: prevent updates to fields that were touched
        # TODO: this in a smarter way. For now, just overwrite the complete object

        id = doc["_id"]
        if collection == "ROOMS":
            self.rooms[id].handleUpdate(doc)
        elif collection == "BOARDS":
            room_id = doc["data"]["roomId"]
            # TODO: proceed to BOARD update with the updates field passed as param
        elif collection == "APPS":
            board_id = doc["data"]["boardId"]
            room_id = doc["data"]["roomId"]
            sb = self.rooms[room_id].boards[board_id].smartbits[id]

            if sb is not None and type(sb) is not GenericSmartBit:
                # Note that set_data_form_update clear touched field
                sb.refresh_data_form_update(doc, updates)

    # Handle Delete Messages
    def __handle_delete(self, collection, doc):
        """Delete not yet supported through API"""
        with open("/tmp/log.out", "w") as out_file:
            out_file.write(f"Deleting {doc} \n")
        room_id = doc['data']['roomId']
        board_id = doc['data']['boardId']
        smartbit_id = doc["_id"]
        del self.rooms[room_id].boards[board_id].smartbits[smartbit_id]

    def __process_messages(self, ws, msg):
        message = json.loads(msg)
        # Duplicate messages for the time being to allow python to work
        # event.doc is now an array of docs
        for doc in message["event"]["doc"]:
            msg = message.copy()
            msg["event"]["doc"] = doc
            # End of duplicating messages so old code can work
            collection = msg["event"]["col"]
            doc = msg["event"]["doc"]
            msg_type = msg["event"]["type"]
            app_id = doc["_id"]

            # Its a create message
            if msg_type == "CREATE":
                self.__MSG_METHODS[msg_type](collection, doc)
            # Its a delete message
            elif msg_type == "DELETE":
                self.__MSG_METHODS[msg_type](collection, doc)
            # Its an update message
            elif msg_type == "UPDATE":
                # all updates for this message [{id: string, updates: {}}, {id:string, updates: {}}...]
                all_updates = msg["event"]["updates"]
                msg_updates = {}
                # find the updates for this specific app
                for u in all_updates:
                    if u["id"] == app_id:
                        msg_updates = u["updates"]
                        break
                msg["event"]["updates"] = msg_updates

                if (
                    "updates" in msg["event"]
                    and "raised" in msg["event"]["updates"]
                    and msg["event"]["updates"]["raised"]
                ):
                    pass

                self.__MSG_METHODS[msg_type](collection, doc, msg_updates)

    def update_size(self, app, width=None, height=None, depth=None):
        if not isinstance(app, SmartBit):
            print(f"apps should be a smartbit. Found {type(app)}")
            return
        if width is None and height is None and depth is None:
            print("At last one of the parameters is required")
            return
        if width is not None:
            app.data.size.width = width
        if height is not None:
            app.data.size.height = width
        if depth is not None:
            app.data.size.depth = depth
        app.send_updates()

    def update_position(self, app, x=None, y=None, z=None):
        """
        Update the position of the app
        :param app: the smartbit of the app to update
        :param x: the x position
        :param y: the y position
        :param z: the z position
        """
        if not isinstance(app, SmartBit):
            print(f"apps should be a smartbit. Found {type(app)}")
            return
        if x is None and y is None and z is None:
            print("At last one of the parameters is required")
            return
        if x is not None:
            app.data.position.x = x
        if y is not None:
            app.data.position.y = y
        if z is not None:
            app.data.position.z = z  # changed from depth
        app.send_updates()

    def update_rotation(self, app, x=None, y=None, z=None):
        if not isinstance(app, SmartBit):
            print(f"Apps should be a smartbit. Found {type(app)}")
            return
        if x is None and y is None and z is None:
            print("At last one of the parameters is required")
            return
        if x is not None:
            app.data.rotation.x = x
        if y is not None:
            app.data.rotation.y = y
        if z is not None:
            app.data.rotation.z = z
        app.send_updates()

        
    def list_assets(self, room_id=None, board_id=None, asset_id=None):
        # TODO: clean this. Poorly written. Also handle baord_id
        assets = self.s3_comm.get_assets()
        if room_id is not None:
            assets = [x for x in assets if x["data"]["room"] == room_id]
        assets_info = []
        for asset in assets:
            if asset_id is not None:
                if asset["_id"] != asset_id:
                    continue

            assets_info.append(
                {
                    "_id": asset["_id"],
                    "filename": asset["data"]["originalfilename"],
                    "mimetype": asset["data"]["mimetype"],
                    "size": asset["data"]["size"],
                    "path": asset["data"]["path"]
                }
            )
        return assets_info

    def get_asset_id(self, file_name):
        assets = self.list_assets()
        if assets is not None:
            for asset in assets:
                if asset['filename'] == file_name:
                    return asset['_id']
        return None

        
    def get_public_url(self, asset_id):
        """Returns the public url for the asset with the given id"""
        return self.s3_comm.format_public_url(asset_id)

    def get_url_by_filename(self, filename):
        asset_id = self.get_asset_id(filename)
        if asset_id:
            return self.get_public_url(asset_id)
        else:
            return None
        

    
    def update_state_attrs(self, app, **kwargs):
        """Updates the state attributes of the given app.
        The attributes to be updated are passed as kwargs"""
        if not isinstance(app, SmartBit):
            print(f"Apps should be a smartbit. Found {type(app)}")
            return

        for k in kwargs.keys():
            # TODO also check that the values passed are valid values for that field
            if not hasattr(app.state, k):
                print(f"{k} is not a valid attribute of the {type(app)}'s state")
                return
        for k, v in kwargs.items():
            setattr(app.state, k, v)
        app.send_updates()

    # def set_room(self, room_id):
    #     if room_id in self.rooms:
    #         self.room = room_id
    #     else:
    #         print(f"Room {room_id} not found")

    # def set_board(self, board_id):
    #     if self.room is None:
    #         print("Please set current room first")
    #         return
    #     room_id = self.room
    #     if board_id in self.rooms[room_id].boards:
    #         self.board = board_id
    #     else:
    #         print(f"Board {board_id} not found")

    # def get_current_room(self):
    #     return self.room

    # def get_current_board(self):
    #     return self.board

    def get_app(self, app_id: str = None) -> dict:
        return self.s3_comm.get_app(app_id)

    def get_apps(self, room_id: str = None, board_id: str = None, add_tags=False, filter_tags=None) -> List[dict]:
        all_apps = self.s3_comm.get_apps(room_id, board_id)
        if add_tags:
            all_tags = self.get_alltags()
            for app in all_apps:
                if app['_id'] in all_tags:
                    app['tags'] = all_tags[app['_id']]
                else:
                    app['tags'] = []

        all_apps = {x['_id']: x for x in all_apps}
        if filter_tags:
            all_apps = self.__remove_keys_from_dict__(all_apps, filter_tags)

        return all_apps

    def get_apps_by_room(self, room_id: str = None) -> List[dict]:
        if room_id is None:
            print("Please provide a room id to filter by")
        return self.get_apps(room_id=room_id)

    def get_apps_by_board(self, board_id: str = None) -> List[dict]:
        if board_id is None:
            print("Please provide a board id to filter by")
        return self.get_apps(board_id=board_id)


    def get_apps_text(self, apps: list = None) -> list:
        #TODO: fix names below to class.__name__
        if apps is None:
            apps = self.get_apps()

        text = ""
        for app_id, app in apps.items():
            app_type = app.get('data', {}).get('type', None)

            if app_type is None:
                return "AppType Not Valid"
            elif app_type == 'Stickie':
                text += app.get('data', {}).get('state', {}).get('text', "")+"\n"
            elif app_type == 'PDFViewer':
                asset_id = app.get('data', {}).get('state', {}).get('assetid')
                asset_info = self.list_assets(asset_id=asset_id)
                asset_path = asset_info[asset_id]['data']["path"]
                text += self.s3_comm.get_pdf_text(asset_path)
            else:
                return "Cannot yet summarize {app_type}"
        return text



    # def format_smartbits_with_tags():
    #     all_tags = get_alltags()
    #     all_apps = [remove_keys_from_dict(x[1].dict(), keys_to_remove) for x in list(cb.smartbits)]
    #     for app in all_apps:
    #         if app['app_id'] in all_tags:
    #             app['tags'] = all_tags[app['app_id']]['labels']
    #         else:
    #             app['tags'] = []
    #
    #     all_apps = {x['app_id']: x for x in all_apps}
    #     return all_apps

    def get_smartbits(self, room_id: str = None, board_id: str = None,
                      add_tags = False) -> dict:
        if room_id is None or board_id is None:
            print("Please provide a room id and a board id")
            return
        # TODO: add option add_tags for the sake of consistency
        #   The get_apps does take that param and adds tags
        # TODO: fix the the return above (return sys error/)


        smartbits = self.rooms.get(room_id).boards.get(board_id).smartbits

        return smartbits

    # def get_smartbits_by_ids(self, app_ids: list, room_id: str = None, board_id: str = None) -> list:
    #     if room_id is None or board_id is None:
    #         print("Please provide a room id and a board id")
    #         return
    #     if app_ids is None:
    #         print("Please provide a list of app ids to filter by")
    #     smartbits = self.get_smartbits(room_id, board_id)
    #     return [smartbits[app_id] for app_id in app_ids]

    def get_smartbits_by_type(
        self, app_type: str, room_id: str = None, board_id: str = None
    ) -> list:
        if room_id is None or board_id is None:
            print("listing apps requires room and board ids")
            return
        if app_type is None:
            print("Please provide an app type to filter by")
        smartbits = self.get_smartbits(room_id, board_id)
        return [v for k, v in smartbits.items() if v.data.type == "Stickie"]

    # def sort_apps_by_creation_date(self, apps: list = None) -> dict:
    #     if apps is None:
    #         apps = self.get_apps()
    #     apps = sorted(apps, key=lambda x: x['_createdAt'], reverse=False)
    #     return apps

    # def sort_apps_by_type(self, apps: list = None) -> dict:
    #     if apps is None:
    #         apps = self.get_apps()
    #     apps = sorted(apps, key=lambda x: x['data']['type'], reverse=False)
    #     return apps

    # def sort_apps_by_size(self, apps: list = None) -> dict:
    #     if apps is None:
    #         apps = self.get_apps()
    #     apps = sorted(apps, key=lambda x: x['data']['size']['width'], reverse=False)
    #     apps = sorted(apps, key=lambda x: x['data']['size']['height'], reverse=False)
    #     return apps

    def get_types_count(self, apps: list = None) -> dict:
        """
        Returns a dictionary with the number of apps of each type

        :param apps: list of apps to be counted
        :return: dictionary with the number of apps of each type
        """
        if apps is None:
            apps = self.get_apps()
        count = {}
        for app in apps:
            if app["data"]["type"] in count:
                count[app["data"]["type"]] += 1
            else:
                count[app["data"]["type"]] = 1
        return count

    def align_selected_apps(
        self, smartbits: List[SmartBit] = None, align: str = "", gap=20, **kwargs
    ) -> None:
        """
        Aligns the apps in the list according to the given align_type

        :param apps: list of apps to be aligned
        :param align_type: type of alignment. Possible values: left, right, top, bottom
        :return: list of apps aligned
        """
        # sort smartbits by the word in parentheses in the state.text field
        # smartbits = sorted(smartbits, key=lambda sb: (sb.state.text.split('(')[1].split(')')[0]))

        by_dim = kwargs.get("by_dim", 1)  # number of rows or columns to use

        if smartbits is None:
            return

        if align == "left":
            align_to_left(smartbits)
        elif align == "right":
            align_to_right(smartbits)
        elif align == "top":
            align_to_top(smartbits)
        elif align == "bottom":
            align_to_bottom(smartbits)
        elif "column" in align:
            align_by_col(smartbits, num_cols=by_dim)
        elif "row" in align:
            align_by_row(smartbits, num_rows=by_dim)
        elif align == "stack":
            align_stack(smartbits)

    def clean_up(self):
        print("cleaning up client resources")
        for room_id in self.rooms.keys():
            for board_id in self.rooms[room_id].boards.keys():
                for app_info in self.rooms[room_id].boards[board_id].smartbits:
                    app_info[1].clean_up()


class RoomBoardInputs(BaseModel):
    """Input for Stock price check."""

    stockticker: str = Field(..., description="Asset")