.. _fbf.lib.container:

container
~~~~~~~~~

.. automodule:: fbf.lib.container
        :show-inheritance:
        :members:
        :undoc-members:

CODE
----

    ::

        # fbf/container.py
        #
        #
        
        """ container for bot to bot communication. """
        
        __version__ = "1"
        
.. _fbf.lib.container_fbf_imports:

fbf imports
--------------

    ::

        
        from fbf.lib.persist import Persist
        from fbf.utils.name import stripname
        from fbf.lib.eventbase import EventBase
        from fbf.imports import getjson
        
.. _fbf.lib.container_basic_imports:

basic imports
----------------

    ::

        
        import hmac
        import uuid
        import time
        import hashlib
        
.. _fbf.lib.container_defines_:

defines
----------

    ::

        
        idattributes = ['createtime', 'origin', 'type', 'idtime', 'payload']
        
.. _fbf.lib.container_functions_:

functions
------------

    ::

        
        def getid(container):
            name = ""
            for attr in idattributes:
                try: name += str(container[attr])
                except KeyError: pass
            return uuid.uuid3(uuid.NAMESPACE_URL, name).hex
        
.. _fbf.lib.container_classes_:

classes
----------

    ::

        
        class Container(EventBase):
        
            """ Container for bot to bot communication. Provides a hmac id that can be checked. """
        
            def __init__(self, origin=None, payload=None, type="event", key=None, how="direct"):
                EventBase.__init__(self)
                self.createtime = time.time()
                self.origin = origin
                self.type = type
                self.hashkey = key
                if payload:
                    self.payload = payload
                    self.makeid()
                    if key: self.makehmac(key)
                    else:
                        self.hashkey = self.id
                        self.makehmac(self.id)
        
            def makeid(self):
                self.idtime = time.time()
                self.id = getid(self)
        
            def makehmac(self, key):
                self.hash = "sha512"
                self.hashkey = key
                self.digest = hmac.new(bytes(self.hashkey, "utf-8"), bytes(self.payload, "utf-8"), hashlib.sha512).hexdigest()
        
            def save(self, attributes=[]):
                target = {}
                if attributes:
                    for key in attributes: target[key] = self[key]
                else: target = cpy(self)
                targetfile = getdatadir() + os.sep + "containers" + os.sep + str(self.createtime) + "_" + stripname(self.origin)
                p = Persist(targetfile)
                p.data = getjson().dumps(target)
                p.save()