AIL-framework/bin/importer/feeders/abstract_chats_feeder.py

#!/usr/bin/env python3
# -*-coding:UTF-8 -*
"""
Abstract Chat JSON Feeder Importer Module
================

Process Feeder Json (example: Twitter feeder)

"""
import datetime
import os
import sys

from abc import abstractmethod, ABC

sys.path.append(os.environ['AIL_BIN'])
##################################
# Import Project packages
##################################
from importer.feeders.Default import DefaultFeeder
from lib.objects.Chats import Chat
from lib.objects import ChatSubChannels
from lib.objects import Messages
from lib.objects import UsersAccount
from lib.objects.Usernames import Username
from lib import chats_viewer

import base64
import io
import gzip

# TODO remove compression ???
def _gunzip_bytes_obj(bytes_obj):
    gunzipped_bytes_obj = None
    try:
        in_ = io.BytesIO()
        in_.write(bytes_obj)
        in_.seek(0)

        with gzip.GzipFile(fileobj=in_, mode='rb') as fo:
            gunzipped_bytes_obj = fo.read()
    except Exception as e:
        print(f'Global; Invalid Gzip file: {e}')

    return gunzipped_bytes_obj

class AbstractChatFeeder(DefaultFeeder, ABC):

    def __init__(self, name, json_data):
        super().__init__(json_data)
        self.obj = None
        self.name = name

    def get_chat_protocol(self):  # TODO # # # # # # # # # # # # #
        return self.name

    def get_chat_network(self):
        self.json_data['meta'].get('network', None)

    def get_chat_address(self):
        self.json_data['meta'].get('address', None)

    def get_chat_instance_uuid(self):
        chat_instance_uuid = chats_viewer.create_chat_service_instance(self.get_chat_protocol(),
                                                                       network=self.get_chat_network(),
                                                                       address=self.get_chat_address())
        # TODO SET
        return chat_instance_uuid

    def get_chat_id(self):  # TODO RAISE ERROR IF NONE
        return self.json_data['meta']['chat']['id']

    def get_channel_id(self):
        pass

    def get_subchannels(self):
        pass

    def get_thread_id(self):
        pass

    def get_message_timestamp(self):
        return self.json_data['meta']['date']['timestamp']  # TODO CREATE DEFAULT TIMESTAMP
        # if self.json_data['meta'].get('date'):
        #     date = datetime.datetime.fromtimestamp( self.json_data['meta']['date']['timestamp'])
        #     date = date.strftime('%Y/%m/%d')
        # else:
        #     date = datetime.date.today().strftime("%Y/%m/%d")

    def get_message_date_timestamp(self):
        timestamp = self.get_message_timestamp()
        date = datetime.datetime.fromtimestamp(timestamp)
        date = date.strftime('%Y%m%d')
        return date, timestamp

    def get_message_sender_id(self):
        return self.json_data['meta']['sender']['id']

    def get_message_reply(self):
        return self.json_data['meta'].get('reply_to')  # TODO change to reply ???

    def get_message_reply_id(self):
        return self.json_data['meta'].get('reply_to', None)

    def get_message_content(self):
        decoded = base64.standard_b64decode(self.json_data['data'])
        return _gunzip_bytes_obj(decoded)

    def get_obj(self):  # TODO handle others objects -> images, pdf, ...
        #### TIMESTAMP ####
        timestamp = self.get_message_timestamp()

        #### Create Object ID ####
        chat_id = str(self.json_data['meta']['chat']['id'])
        message_id = str(self.json_data['meta']['id'])
        # channel id
        # thread id

        obj_id = Messages.create_obj_id(self.get_chat_instance_uuid(), chat_id, message_id, timestamp)
        self.obj = Messages.Message(obj_id)
        return self.obj

    def process_chat(self, message, date, timestamp, reply_id=None):  # TODO threads
        meta = self.json_data['meta']['chat']
        chat = Chat(self.get_chat_id(), self.get_chat_instance_uuid())
        chat.add(date)  # TODO ### Dynamic subtype ???

        if meta.get('name'):
            chat.set_name(meta['name'])

        if meta.get('date'): # TODO check if already exists
            chat.set_created_at(int(meta['date']['timestamp']))

        if meta.get('username'):
            username = Username(meta['username'], self.get_chat_protocol())
            chat.update_username_timeline(username.get_global_id(), timestamp)

        if meta.get('subchannel'):
            subchannel = self.process_subchannel(message, date, timestamp, reply_id=reply_id)
            chat.add_children(obj_global_id=subchannel.get_global_id())
        else:
            chat.add_message(message.get_global_id(), message.id, timestamp, reply_id=reply_id)

        # if meta.get('subchannels'): # TODO Update icon + names

        return chat

    # def process_subchannels(self):
    #     pass

    def process_subchannel(self, message, date, timestamp, reply_id=None):  # TODO CREATE DATE
        meta = self.json_data['meta']['chat']['subchannel']
        subchannel = ChatSubChannels.ChatSubChannel(f'{self.get_chat_id()}/{meta["id"]}', self.get_chat_instance_uuid())
        subchannel.add(date)

        if meta.get('date'): # TODO check if already exists
            subchannel.set_created_at(int(meta['date']['timestamp']))

        if meta.get('name'):
            subchannel.set_name(meta['name'])
            # subchannel.update_name(meta['name'], timestamp) # TODO #################

        subchannel.add_message(message.get_global_id(), message.id, timestamp, reply_id=reply_id)
        return subchannel

    def process_sender(self, date, timestamp):
        meta = self.json_data['meta']['sender']
        user_account = UsersAccount.UserAccount(meta['id'], self.get_chat_instance_uuid())

        if meta.get('username'):
            username = Username(meta['username'], self.get_chat_protocol())
            # TODO timeline or/and correlation ????
            user_account.add_correlation(username.type, username.get_subtype(r_str=True), username.id)
            user_account.update_username_timeline(username.get_global_id(), timestamp)

            # Username---Message
            username.add(date)  # TODO # correlation message ???

        # ADDITIONAL METAS
        if meta.get('firstname'):
            user_account.set_first_name(meta['firstname'])
        if meta.get('lastname'):
            user_account.set_last_name(meta['lastname'])
        if meta.get('phone'):
            user_account.set_phone(meta['phone'])

        return user_account

    # Create abstract class: -> new API endpoint ??? => force field, check if already imported ?
    # 1) Create/Get MessageInstance                     - # TODO uuidv5 + text like discord and telegram for default
    # 2) Create/Get CHAT ID                             - Done
    # 3) Create/Get Channel IF is in channel
    # 4) Create/Get Thread IF is in thread
    # 5) Create/Update Username and User-account        - Done
    def process_meta(self):  # TODO CHECK MANDATORY FIELDS
        """
        Process JSON meta filed.
        """
        # meta = self.get_json_meta()

        date, timestamp = self.get_message_date_timestamp()

        # REPLY
        reply_id = self.get_message_reply_id()

        # TODO Translation

        # Content
        content = self.get_message_content()

        message = Messages.create(self.obj.id, content)  # TODO translation

        # CHAT
        chat = self.process_chat(message, date, timestamp, reply_id=reply_id)

        # SENDER # TODO HANDLE NULL SENDER
        user_account = self.process_sender(date, timestamp)

        # UserAccount---Message
        user_account.add(date, obj=message)
        # UserAccount---Chat
        user_account.add_correlation(chat.type, chat.get_subtype(r_str=True), chat.id)

        # if chat: # TODO Chat---Username correlation ???
        #     # Chat---Username
        #     chat.add_correlation(username.type, username.get_subtype(r_str=True), username.id)