.. _fbf.plugs.extra.seen:

seen
~~~~

.. automodule:: fbf.plugs.extra.seen
        :show-inheritance:
        :members:
        :undoc-members:

CODE
----

    ::

        # fbf/plugs/common/seen.py
        #
        #
        # Description: tracks when a nick is last seen
        # Author: Wijnand 'tehmaze' Modderman
        # Website: http://tehmaze.com
        # License: BSD
        
        """ nick tracking. """
        
        from fbf.lib.callbacks import callbacks
        from fbf.lib.commands import cmnds
        from fbf.lib.datadir import getdatadir
        from fbf.utils.pdod import Pdod
        from fbf.lib.persistconfig import PersistConfig
        from fbf.lib.examples import examples
        
.. _fbf.plugs.extra.seen_basic_imports:

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

    ::

        
        import os
        import time
        
.. _fbf.plugs.extra.seen_defines_:

defines
----------

    ::

        
        cfg = PersistConfig()
        cfg.define('tz', '+0100')
        
.. _fbf.plugs.extra.seen_Seen-class_:

Seen-class
-------------

    ::

        
        class Seen(Pdod):
        
            """ maintain last seen information. """
        
            def __init__(self):
                self.datadir = os.path.join(getdatadir(), 'plugs', 'fbf.plugs.extra.seen')
                Pdod.__init__(self, os.path.join(self.datadir, 'seen.data'))
        
            def privmsgcb(self, bot, ievent):
                self.data[ievent.nick.lower()] = {
                    'time':    time.time(),
                    'text':    ievent.origtxt,
                    'bot':     bot.cfg.name,
                    'server':  bot.cfg.server,
                    'channel': ievent.channel,
                    'what':    'saying',
                    }
        
            def joincb(self, bot, ievent):
                self.data[ievent.nick.lower()] = {
                    'time':    time.time(),
                    'text':    '',
                    'bot':     bot.cfg.name,
                    'server':  bot.cfg.server,
                    'channel': ievent.channel,
                    'what':    'joining %s' % ievent.channel,
                    }
            
            def partcb(self, bot, ievent):
                self.data[ievent.nick.lower()] = {
                    'time':    time.time(),
                    'text':    ievent.txt,
                    'bot':     bot.cfg.name,
                    'server':  bot.cfg.server,
                    'channel': ievent.channel,
                    'what':    'parting %s' % ievent.channel,
                    }
            
            def quitcb(self, bot, ievent):
                self.data[ievent.nick.lower()] = {
                    'time':    time.time(),
                    'text':    ievent.txt,
                    'bot':     bot.cfg.name,
                    'server':  bot.cfg.server,
                    'channel': ievent.channel,
                    'what':    'quitting',
                    }
           
            def xmppcb(self, bot, ievent):
                if ievent.type == 'unavailable':
                   self.data[ievent.nick.lower()] = {
                       'time':    time.time(),
                       'text':    ievent.userhost,
                       'bot':     bot.cfg.name,
                       'server':  bot.cfg.server,
                       'channel': ievent.channel,
                       'what':    'saindo da sala %s' % ievent.channel,
                       }
                else:
                   self.data[ievent.nick.lower()] = {
                       'time':    time.time(),
                       'text':    ievent.userhost,
                       'bot':     bot.cfg.name,
                       'server':  bot.cfg.server,
                       'channel': ievent.channel,
                       'what':    'entrando na sala %s' % ievent.channel,
                       }
        
          
            def size(self):
                return len(list(self.data.keys()))
        
.. _fbf.plugs.extra.seen_init_:

init
-------

    ::

        
        seen = Seen()
        
.. _fbf.plugs.extra.seen_callbacks_and_commands_register:

callbacks and commands register
----------------------------------

    ::

        
        callbacks.add('PRIVMSG', seen.privmsgcb)
        callbacks.add('JOIN', seen.joincb)
        callbacks.add('PART', seen.partcb)
        callbacks.add('QUIT', seen.quitcb)
        
.. _fbf.plugs.extra.seen_seen_command:

seen command
---------------

    ::

        
        def handle_seen(bot, ievent):
            """ arguments: <nick> - lookup last seen information. """
            if not ievent.args: ievent.missing('<nick>') ; return
            if True:
                nick = ievent.args[0].lower()
                if nick not in seen.data:
                    alts = [x for x in list(seen.data.keys()) if nick in x]
                    if alts:
                        alts.sort()
                        if len(alts) > 10:
                            nums = len(alts) - 10
                            alts = ', '.join(alts[:10]) + ' + %d others' % nums
                        else:
                            alts = ', '.join(alts)
                        ievent.reply('no logs for %s, however, I remember seeing: %s' % (nick, alts))
                    else:
                        ievent.reply('no logs for %s' % nick)
                else:
                    text = seen.data[nick]['text'] and ': %s' % seen.data[nick]['text'] or ''
                    try:
                        ievent.reply('%s was last seen on %s (%s) at %s, %s%s' % (nick, seen.data[nick]['channel'], seen.data[nick]['server'], 
                            time.strftime('%a, %d %b %Y %H:%M:%S '+ str(cfg.get('tz')), time.localtime(seen.data[nick]['time'])),
                            seen.data[nick]['what'], text))
                    except KeyError:
                        ievent.reply('%s was last seen at %s, %s%s' % (nick, 
                            time.strftime('%a, %d %b %Y %H:%M:%S '+ str(cfg.get('tz')), time.localtime(seen.data[nick]['time'])),
                            seen.data[nick]['what'], text))
        
        cmnds.add('seen', handle_seen, ['OPER', 'USER', 'GUEST'])
        examples.add('seen', 'show last spoken txt of a user', 'seen dunker')
        
.. _fbf.plugs.extra.seen_shutdown_:

shutdown
-----------

    ::

        
        def shutdown(): seen.save()
        
.. _fbf.plugs.extra.seen_size_:

size
-------

    ::

        
        def size(): return seen.size()