channel related commands.
allow a command in the channel.
arguments: <plugname> - allow a plugin to be active in a channel.
arguments: <JID/channel> - add a target channel to the allowwatch list.
no arguments - recycle channel.
arguments: <channel> - remove channel from bot.state.data[‘joinedchannels’].
add a target channel to the allowout list.
arguments: <plugname> - deny a plugin to be active in a channel.
no arguments - enable current channel.
no arguments - enable current channel.
arguments: <channel> - join a channel/conference/wave
no arguments - channels .. show joined channels.
arguments: [<channel>] - enable output to the channel.
arguments: <cmnd> - allow output of a command in the channel.
arguments: [<channel>] - show channel mode.
arguments: [<channel>] - leave a channel (provided or current channel).
remove a command from the allowed list of a channel.
arguments [<channel>] - set silent mode of channel.
arguments: <cmnd> - silence a command in the channel. /msg the result of a command.
no arguments - request a token for the channel. used in channel API on GAE.
no arguments - upgrade the channel.
arguments: [<channel>] - make bot use notice in channel.
arguments: [<channel>] - make bot use privmsg in channel.
callback to detect change of channel key.
# jsb/plugs/core/chan.py # # """ channel related commands. """
from jsb.lib.persist import Persist from jsb.lib.commands import cmnds from jsb.lib.examples import examples from jsb.lib.callbacks import callbacks from jsb.lib.channelbase import ChannelBase from jsb.lib.datadir import getdatadir from jsb.utils.exception import handle_exception
import os import logging
def handle_chantoken(bot, event): """ no arguments - request a token for the channel. used in channel API on GAE. """ if not bot.isgae: event.reply("this command only works on the App Engine") ; return import google try: (chan, token) = event.chan.gae_create() logging.warn("chantoken - %s - %s" % (chan, token)) event.response.out.write(token) except google.appengine.runtime.DeadlineExceededError: handle_exception() #event.response.set_status(500) except google.appengine.api.channel.channel.InvalidChannelClientIdError, ex: handle_exception() #event.response.set_status(500) except Exception, ex: #event.response.set_status(500) #event.response.out.write("An exception occured: %s" % str(ex)) handle_exception() cmnds.add("chan-token", handle_chantoken, ['OPER', 'USER', "GUEST"]) examples.add("chan-token", "create a new token for the appengine channel API", "chan-token")
def handle_chanjoin(bot, ievent): """ arguments: <channel> - join a channel/conference/wave""" try: channel = ievent.rest except IndexError: ievent.missing("<channel> [password]") return try: password = ievent.args[1] except IndexError: password = None bot.join(channel, password=password) ievent.done() cmnds.add('chan-join', handle_chanjoin, ['OPER', 'JOIN']) cmnds.add('join', handle_chanjoin, ['OPER', 'JOIN']) examples.add('chan-join', 'chan-join <channel> [password]', '1) chan-join #test 2) chan-join #test mekker')
def handle_chandel(bot, ievent): """ arguments: <channel> - remove channel from bot.state.data['joinedchannels']. """ try: chan = ievent.args[0].lower() except IndexError: ievent.missing("<channel>") return try: if bot.state: bot.state.data['joinedchannels'].remove(chan) bot.state.save() except ValueError: pass ievent.done() cmnds.add('chan-del', handle_chandel, 'OPER') examples.add('chan-del', 'remove channel from bot.channels', 'chan-del #mekker')
def handle_chanpart(bot, ievent): """ arguments: [<channel>] - leave a channel (provided or current channel). """ if not ievent.rest: chan = ievent.channel else: chan = ievent.rest ievent.reply('leaving %s chan' % chan) bot.part(chan) ievent.done() cmnds.add('chan-part', handle_chanpart, 'OPER') cmnds.add('part', handle_chanpart, 'OPER') examples.add('chan-part', 'chan-part [<channel>]', '1) chan-part 2) chan-part #test')
def handle_chanlist(bot, ievent): """ no arguments - channels .. show joined channels. """ if bot.state: chans = bot.state['joinedchannels'] else: chans = [] if chans: ievent.reply("joined channels: ", chans) else: ievent.reply('no channels joined') cmnds.add('chan-list', handle_chanlist, ['USER', 'GUEST']) examples.add('chan-list', 'show what channels the bot is on', 'chan-list')
def handle_chancycle(bot, ievent): """ no arguments - recycle channel. """ ievent.reply('cycling %s' % ievent.channel) bot.part(ievent.channel) try: key = ievent.chan.data.password except (KeyError, TypeError): key = None bot.join(ievent.channel, password=key) ievent.done() cmnds.add('chan-cycle', handle_chancycle, 'OPER') examples.add('chan-cycle', 'part/join channel', 'chan-cycle')
def handle_chansilent(bot, ievent): """ arguments [<channel>] - set silent mode of channel. """ if ievent.rest: channel = ievent.rest.split()[0].lower() else: if ievent.cmnd == 'DCC': return channel = ievent.channel ievent.reply('putting %s to silent mode' % channel) ievent.chan.data.silent = True ievent.chan.save() ievent.done() cmnds.add('chan-silent', handle_chansilent, 'OPER') examples.add('chan-silent', 'set silent mode on channel the command was given in', 'chan-silent')
def handle_chanloud(bot, ievent): """ arguments: [<channel>] - enable output to the channel. """ if ievent.rest: channel = ievent.rest.split()[0].lower() else: if ievent.cmnd == 'DCC': return channel = ievent.channel ievent.reply('putting %s into loud mode' % ievent.channel) ievent.chan.data.silent= False ievent.chan.save() ievent.done() cmnds.add('chan-loud', handle_chanloud, 'OPER') examples.add('chan-loud', 'disable silent mode of channel command was given in', 'chan-loud')
def handle_chanwithnotice(bot, ievent): """ arguments: [<channel>] - make bot use notice in channel. """ if ievent.rest: channel = ievent.rest.split()[0].lower() else: if ievent.cmnd == 'DCC': return channel = ievent.channel ievent.reply('setting notice in %s' % channel) ievent.chan.data.how = "notice" ievent.chan.save() ievent.done() cmnds.add('chan-withnotice', handle_chanwithnotice, 'OPER') examples.add('chan-withnotice', 'make bot use notice on channel the command was given in', 'chan-withnotice')
def handle_chanwithprivmsg(bot, ievent): """ arguments: [<channel>] - make bot use privmsg in channel. """ if ievent.rest: channel = ievent.rest.split()[0].lower() else: if ievent.cmnd == 'DCC': return channel = ievent.channel ievent.reply('setting privmsg in %s' % ievent.channel) ievent.chan.data.how = "msg" ievent.chan.save() ievent.done() cmnds.add('chan-withprivmsg', handle_chanwithprivmsg, 'OPER') examples.add('chan-withprivmsg', 'make bot use privmsg on channel command was given in', 'chan-withprivmsg')
def handle_channelmode(bot, ievent): """ arguments: [<channel>] - show channel mode. """ if bot.type != 'irc': ievent.reply('channelmode only works on irc bots') return try: chan = ievent.args[0].lower() except IndexError: chan = ievent.channel.lower() if not chan in bot.state['joinedchannels']: ievent.reply("i'm not on channel %s" % chan) return ievent.reply('channel mode of %s is %s' % (chan, ievent.chan.data.mode)) cmnds.add('chan-mode', handle_channelmode, 'OPER') examples.add('chan-mode', 'show mode of channel', '1) chan-mode 2) chan-mode #test')
def modecb(bot, ievent): """ callback to detect change of channel key. """ if ievent.postfix.find('+k') != -1: key = ievent.postfix.split('+k')[1] ievent.chan.data.key = key ievent.chan.save() callbacks.add('MODE', modecb)
def handle_chandenyplug(bot, event): """ arguments: <plugname> - deny a plugin to be active in a channel. """ if not event.rest: event.missing("<plugin name>") ; return if not event.rest in event.chan.data.denyplug: event.chan.data.denyplug.append(event.rest) event.chan.save() event.done() else: event.reply("%s is already being denied in channel %s" % (event.rest, event.channel)) cmnds.add("chan-denyplug", handle_chandenyplug, 'OPER') examples.add("chan-denyplug", "deny a plugin command or callbacks to be executed in a channel", "chan-denyplug idle")
def handle_chanallowplug(bot, event): """ arguments: <plugname> - allow a plugin to be active in a channel. """ if not event.rest: event.missing("<plugin name>") ; return if event.rest in event.chan.data.denyplug: event.chan.data.denyplug.remove(event.rest) event.chan.save() event.done() else: event.reply("%s is already being allowed in channel %s" % (event.rest, event.channel)) cmnds.add("chan-allowplug", handle_chanallowplug, 'OPER') examples.add("chan-allowplug", "allow a plugin command or callbacks to be executed in a channel", "chan-denyplug idle")
def handle_chanallowcommand(bot, event): """ allow a command in the channel. """ try: cmnd = event.args[0] except (IndexError, KeyError): event.missing("<cmnd>") ; return if not cmnd in event.chan.data.allowcommands: event.chan.data.allowcommands.append(cmnd) ; event.chan.save() ; event.done() cmnds.add("chan-allowcommand", handle_chanallowcommand, ["OPER", ]) examples.add("chan-allowcommand", "add a command to the allow list. allows for all users.", "chan-allowcommand learn")
def handle_chansilentcommand(bot, event): """ arguments: <cmnd> - silence a command in the channel. /msg the result of a command.""" try: cmnd = event.args[0] except (IndexError, KeyError): event.missing("<cmnd>") ; return if not cmnd in event.chan.data.silentcommands: event.chan.data.silentcommands.append(cmnd) ; event.chan.save() ; event.done() cmnds.add("chan-silentcommand", handle_chansilentcommand, ["OPER", ]) examples.add("chan-silentcommand", "add a command to the allow list.", "chan-silentcommand learn")
def handle_chanloudcommand(bot, event): """ arguments: <cmnd> - allow output of a command in the channel. """ try: cmnd = event.args[0] ; event.chan.data.silentcommands.remove(cmnd) ; event.chan.save() ; event.done() except (IndexError, ValueError): event.reply("%s is not in the silencelist" % event.rest) cmnds.add("chan-loudcommand", handle_chanloudcommand, ["OPER", ]) examples.add("chan-loudcommand", "remove a command from the silence list.", "chan-loudcommand learn")
def handle_chanremovecommand(bot, event): """ remove a command from the allowed list of a channel. """ try: cmnd = event.args[0] ; event.chan.data.allowcommands.remove(cmnd) ; event.chan.save() ; event.done() except (IndexError, ValueError): event.reply("%s is not in the whitelist" % event.rest) cmnds.add("chan-removecommand", handle_chanremovecommand, ["OPER", ]) examples.add("chan-removecommand", "remove a command from the allow list.", "chan-removecommand learn")
def handle_chanupgrade(bot, event): """ no arguments - upgrade the channel. """ prevchan = event.channel # 0.4.1 if prevchan.startswith("-"): prevchan[0] = "+" prevchan = prevchan.replace("@", "+") prev = Persist(getdatadir() + os.sep + "channels" + os.sep + prevchan) if prev.data: event.chan.data.update(prev.data) ; event.chan.save() ; event.reply("done") else: prevchan = event.channel prevchan = prevchan.replace("-", "#") prevchan = prevchan.replace("+", "@") prev = Persist(getdatadir() + os.sep + "channels" + os.sep + prevchan) if prev.data: event.chan.data.update(prev.data) ; event.chan.save() ; event.reply("done") else: event.reply("can't find previous channel data") cmnds.add("chan-upgrade", handle_chanupgrade, ["OPER", ]) examples.add("chan-upgrade", "upgrade the channel.", "chan-upgrade")
def handle_chanallowwatch(bot, event): """ arguments: <JID/channel> - add a target channel to the allowwatch list. """ if not event.rest: event.missing("<JID/channel>") ; return if event.rest not in event.chan.data.allowwatch: event.chan.data.allowwatch.append(event.rest) ; event.chan.save() event.done() cmnds.add("chan-allowwatch", handle_chanallowwatch, "OPER") examples.add("chan-allowwatch", "allow channel events to be watch when forwarded", "chan-allowwatch bthate@gmail.com")
def handle_chandelwatch(bot, event): """ add a target channel to the allowout list. """ if not event.rest: event.missing("<JID>") ; return try: event.chan.data.allowwatch.remove(event.rest) ; event.chan.save() except: event.reply("%s is not in the allowout list" % event.rest) ; return event.done() cmnds.add("chan-delwatch", handle_chandelwatch, "OPER") examples.add("chan-delwatch", "deny channel events to be watched when forwarded", "chan-delwatch bthate@gmail.com")
def handle_chanenable(bot, event): """ no arguments - enable current channel. """ event.chan.data.enable = True event.chan.save() event.reply("%s channel enabled" % event.channel) cmnds.add("chan-enable", handle_chanenable, ["OPER", "USER"]) examples.add("chan-enable", "enable a channel (allow for handling of events concerning this channel (convore for now)", "chan-enable")
def handle_chandisable(bot, event): """ no arguments - enable current channel. """ event.chan.data.enable = False event.chan.save() event.reply("%s channel disabled" % event.channel) cmnds.add("chan-disable", handle_chandisable, ["OPER", "USER"]) examples.add("chan-disable", "disable a channel (disallow for handling of events concerning this channel (convore for now)", "chan-disable")