.. _fbf.plugs.extra.idle:

idle
~~~~

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

CODE
----

    ::

        # fbf/plugs/common/idle.py
        #
        #
        
        """ show how long someone has been idle. """
        
.. _fbf.plugs.extra.idle_fbf_imports:

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

    ::

        
        from fbf.utils.timeutils import elapsedstring
        from fbf.utils.generic import getwho
        from fbf.lib.commands import cmnds
        from fbf.lib.callbacks import callbacks
        from fbf.lib.examples import examples
        from fbf.lib.persist import PlugPersist
        
.. _fbf.plugs.extra.idle_basic_imports:

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

    ::

        
        import time
        import os
        import logging
        
.. _fbf.plugs.extra.idle_defines_:

defines
----------

    ::

        
        changed = False
        
        idle = PlugPersist('idle.data')
        if not idle.data:
            idle.data = {}
        
.. _fbf.plugs.extra.idle_save_on_shutdown:

save on shutdown
-------------------

    ::

        
        def ticksave(bot, event):
            global idle
            global changed
            if changed: idle.save() ; changed = False
        
        callbacks.add("TICK60", ticksave)
        
.. _fbf.plugs.extra.idle_callbacks_:

callbacks
------------

    ::

        
        def preidle(bot, event):
            """ idle precondition aka check if it is not a command """
            if not event.iscmnd() and event.inchan and not event.isoutput: return True
                
        def idlecb(bot, event):
            """ idle PRIVMSG callback .. set time for channel and nick """
            ttime = time.time()
            idle.data[event.userhost] = ttime
            idle.data[event.channel] = ttime
            idle.sync()
            global changed
            changed = True
            
        callbacks.add('PRIVMSG', idlecb, preidle)
        
.. _fbf.plugs.extra.idle_idle_command:

idle command
---------------

    ::

        
        def handle_idle(bot, ievent):
            """ arguments: [<nick>] .. show how idle an channel/user has been """
            try:
                who = ievent.args[0]
            except IndexError:
                handle_idle2(bot, ievent)
                return
            userhost = getwho(bot, who)
            if not userhost:
                ievent.reply("can't get userhost of %s" % who)
                return
            logging.warn("idle - userhost is %s" % userhost)
            try:
                elapsed = elapsedstring(time.time() - idle.data[userhost])
            except KeyError:
                ievent.reply("i haven't seen %s" % who)
                return
            if elapsed:
                ievent.reply("%s is idle for %s" % (who, elapsed))
                return
            else:
                ievent.reply("%s is not idle" % who)
                return   
        
        def handle_idle2(bot, ievent):
            """ show how idle a channel has been """
            chan = ievent.channel
            try:
                elapsed = elapsedstring(time.time()-idle.data[chan])
            except KeyError:
                ievent.reply("nobody said anything on channel %s yet" % chan)
                return
            if elapsed:
                ievent.reply("channel %s is idle for %s" % (chan, elapsed))
            else:
                ievent.reply("channel %s is not idle" % chan)
        
        cmnds.add('idle', handle_idle, ['OPER', 'USER', 'GUEST'])
        examples.add('idle', 'show how idle the channel is or show how idle <nick> is', '1) idle 2) idle test')