Limnoria/src/Owner.py

768 lines
30 KiB
Python
Raw Normal View History

2003-08-28 18:33:45 +02:00
###
# Copyright (c) 2002-2004, Jeremiah Fincher
2003-08-28 18:33:45 +02:00
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# * Redistributions of source code must retain the above copyright notice,
# this list of conditions, and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions, and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the author of this software nor the name of
# contributors to this software may be used to endorse or promote products
# derived from this software without specific prior written consent.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
# POSSIBILITY OF SUCH DAMAGE.
###
2003-09-03 11:50:04 +02:00
"""
Provides commands useful to the owner of the bot; the commands here require
their caller to have the 'owner' capability. This plugin is loaded by default.
"""
import supybot
2003-11-25 09:38:19 +01:00
__revision__ = "$Id$"
__author__ = supybot.authors.jemfinch
2003-11-25 09:38:19 +01:00
2004-07-24 07:18:26 +02:00
import supybot.fix as fix
2003-09-12 20:07:04 +02:00
2003-08-28 18:33:45 +02:00
import gc
import os
2003-08-28 18:33:45 +02:00
import imp
import sre
2003-08-28 18:33:45 +02:00
import sys
2004-01-15 15:08:14 +01:00
import getopt
import socket
import logging
2003-08-28 18:33:45 +02:00
import linecache
2004-07-24 07:18:26 +02:00
import supybot.log as log
import supybot.conf as conf
import supybot.utils as utils
import supybot.world as world
import supybot.ircdb as ircdb
2004-10-22 07:35:05 +02:00
from supybot.commands import *
import supybot.irclib as irclib
import supybot.drivers as drivers
2004-07-24 07:18:26 +02:00
import supybot.ircmsgs as ircmsgs
import supybot.ircutils as ircutils
2004-07-24 07:18:26 +02:00
import supybot.privmsgs as privmsgs
import supybot.registry as registry
import supybot.callbacks as callbacks
import supybot.structures as structures
2003-08-28 18:33:45 +02:00
2004-01-15 15:08:14 +01:00
class Deprecated(ImportError):
pass
def loadPluginModule(name, ignoreDeprecation=False):
"""Loads (and returns) the module for the plugin with the given name."""
files = []
2004-01-18 08:58:26 +01:00
pluginDirs = conf.supybot.directories.plugins()
for dir in pluginDirs:
try:
files.extend(os.listdir(dir))
2004-01-15 15:08:14 +01:00
except EnvironmentError: # OSError, IOError superclass.
2004-07-28 04:58:10 +02:00
log.warning('Invalid plugin directory: %r; removing.', dir)
conf.supybot.directories.plugins().remove(dir)
loweredFiles = map(str.lower, files)
try:
index = loweredFiles.index(name.lower()+'.py')
name = os.path.splitext(files[index])[0]
2004-02-04 19:01:00 +01:00
if name in sys.modules:
m = sys.modules[name]
if not hasattr(m, 'Class'):
raise ImportError, 'Module is not a plugin.'
except ValueError: # We'd rather raise the ImportError, so we'll let go...
pass
2004-01-18 08:58:26 +01:00
moduleInfo = imp.find_module(name, pluginDirs)
try:
module = imp.load_module(name, *moduleInfo)
except:
2004-02-16 17:16:13 +01:00
if name in sys.modules:
del sys.modules[name]
raise
2004-01-15 15:08:14 +01:00
if 'deprecated' in module.__dict__ and module.deprecated:
if ignoreDeprecation:
log.warning('Deprecated plugin loaded: %s', name)
else:
2004-01-15 15:27:22 +01:00
raise Deprecated, 'Attempted to load deprecated plugin %r' % name
if module.__name__ in sys.modules:
sys.modules[module.__name__] = module
linecache.checkcache()
return module
2004-04-28 10:42:01 +02:00
def loadPluginClass(irc, module, register=None):
"""Loads the plugin Class from the given module into the given Irc."""
2004-08-02 01:19:59 +02:00
try:
cb = module.Class()
except AttributeError, e:
2004-08-02 01:19:59 +02:00
raise callbacks.Error, 'This plugin module doesn\'t have a "Class" ' \
'attribute to specify which plugin should be ' \
'instantiated. If you didn\'t write this ' \
'plugin, but received it with Supybot, file ' \
'a bug with us about this error. %s.' % e
plugin = cb.name()
2004-04-28 10:42:01 +02:00
public = True
if hasattr(cb, 'public'):
public = cb.public
conf.registerPlugin(plugin, register, public)
assert not irc.getCallback(plugin)
2004-09-11 18:16:16 +02:00
try:
renames = registerRename(plugin)()
if renames:
for command in renames:
v = registerRename(plugin, command)
newName = v()
assert newName
renameCommand(cb, command, newName)
else:
conf.supybot.commands.renames.unregister(plugin)
2004-09-11 18:16:16 +02:00
except registry.NonExistentRegistryEntry, e:
pass # The plugin isn't there.
2004-04-28 10:42:01 +02:00
irc.addCallback(cb)
return cb
conf.registerPlugin('Owner', True)
conf.supybot.plugins.Owner.register('public', registry.Boolean(True,
2004-08-19 01:15:27 +02:00
"""Determines whether this plugin is publicly visible."""))
###
# supybot.commands.
###
2004-08-11 14:57:52 +02:00
2004-09-11 18:16:16 +02:00
conf.registerGroup(conf.supybot.commands, 'renames', orderAlphabetically=True)
def registerDefaultPlugin(command, plugin):
command = callbacks.canonicalName(command)
conf.registerGlobalValue(conf.supybot.commands.defaultPlugins,
command, registry.String(plugin, ''))
# This must be set, or the quotes won't be removed.
conf.supybot.commands.defaultPlugins.get(command).set(plugin)
def registerRename(plugin, command=None, newName=None):
g = conf.registerGlobalValue(conf.supybot.commands.renames, plugin,
registry.SpaceSeparatedSetOfStrings([], """Determines what commands
in this plugin are to be renamed."""))
if command is not None:
g().add(command)
v = conf.registerGlobalValue(g, command, registry.String('', ''))
if newName is not None:
v.setValue(newName) # In case it was already registered.
return v
else:
return g
2004-09-11 18:16:16 +02:00
def renameCommand(cb, name, newName):
assert not hasattr(cb, newName), 'Cannot rename over existing attributes.'
assert newName == callbacks.canonicalName(newName), \
'newName must already be canonicalized.'
if name != newName:
method = getattr(cb.__class__, name)
setattr(cb.__class__, newName, method)
delattr(cb.__class__, name)
registerDefaultPlugin('list', 'Misc')
registerDefaultPlugin('help', 'Misc')
2004-09-11 18:16:16 +02:00
registerDefaultPlugin('ignore', 'Admin')
registerDefaultPlugin('reload', 'Owner')
2004-09-11 18:16:16 +02:00
registerDefaultPlugin('unignore', 'Admin')
registerDefaultPlugin('capabilities', 'User')
2004-09-11 18:16:16 +02:00
registerDefaultPlugin('addcapability', 'Admin')
registerDefaultPlugin('removecapability', 'Admin')
2004-02-07 12:48:03 +01:00
class holder(object):
pass
# This is used so we can support a "log" command as well as a "self.log"
# Logger.
2004-02-07 12:48:03 +01:00
class LogProxy(object):
"""<text>
Logs <text> to the global Supybot log at critical priority. Useful for
2004-02-07 12:48:03 +01:00
marking logfiles for later searching.
"""
2004-04-20 12:59:20 +02:00
__name__ = 'log' # Necessary for help.
2004-02-07 12:48:03 +01:00
def __init__(self, log):
self.log = log
self.im_func = holder()
self.im_func.func_name = 'log'
2004-10-22 07:35:05 +02:00
def __call__(self, irc, msg, args, text):
2004-02-07 12:48:03 +01:00
log.critical(text)
irc.replySuccess()
2004-10-22 07:35:05 +02:00
__call__ = wrap(__call__, ['text'])
2004-02-07 12:48:03 +01:00
def __getattr__(self, attr):
return getattr(self.log, attr)
2003-10-21 08:03:57 +02:00
class Owner(privmsgs.CapabilityCheckingPrivmsg):
# This plugin must be first; its priority must be lowest; otherwise odd
# things will happen when adding callbacks.
2003-08-28 18:33:45 +02:00
capability = 'owner'
_srcPlugins = ircutils.IrcSet(('Admin', 'Channel', 'Config',
'Misc', 'Owner', 'User'))
def __init__(self, *args, **kwargs):
self.__parent = super(Owner, self)
self.__parent.__init__()
# Setup log object/command.
2004-02-07 12:48:03 +01:00
self.log = LogProxy(self.log)
# Setup command flood detection.
self.commands = ircutils.FloodQueue(60)
# Setup exec command.
setattr(self.__class__, 'exec', self.__class__._exec)
# Setup Irc objects, connected to networks. If world.ircs is already
# populated, chances are that we're being reloaded, so don't do this.
if not world.ircs:
for network in conf.supybot.networks():
try:
self._connect(network)
except socket.error, e:
self.log.error('Could not connect to %s: %s.', network, e)
except Exception, e:
self.log.exception('Exception connecting to %s:', network)
self.log.error('Could not connect to %s: %s.', network, e)
# Setup plugins and default plugins for commands.
for (name, s) in registry._cache.iteritems():
2004-10-22 22:14:43 +02:00
if 'alwaysLoadDefault' in name or 'alwaysLoadImportant' in name:
continue
2004-01-18 08:58:26 +01:00
if name.startswith('supybot.plugins'):
try:
2004-07-24 23:40:47 +02:00
(_, _, name) = registry.split(name)
except ValueError: # unpack list of wrong size.
2004-01-18 08:58:26 +01:00
continue
# This is just for the prettiness of the configuration file.
# There are no plugins that are all-lowercase, so we'll at
# least attempt to capitalize them.
if name == name.lower():
name = name.capitalize()
conf.registerPlugin(name)
if name.startswith('supybot.commands.defaultPlugins'):
try:
2004-07-24 23:40:47 +02:00
(_, _, _, name) = registry.split(name)
except ValueError: # unpack list of wrong size.
continue
registerDefaultPlugin(name, s)
2004-01-18 08:58:26 +01:00
def callPrecedence(self, irc):
return ([], [cb for cb in irc.callbacks if cb is not self])
def outFilter(self, irc, msg):
if msg.command == 'PRIVMSG' and not world.testing:
if ircutils.strEqual(msg.args[0], irc.nick):
self.log.warning('Tried to send a message to myself: %r.', msg)
return None
return msg
def isCommand(self, name):
return name == 'log' or \
self.__parent.isCommand(name)
2004-02-07 12:48:03 +01:00
2004-02-13 08:24:30 +01:00
def reset(self):
# This has to be done somewhere, I figure here is as good place as any.
callbacks.Privmsg._mores.clear()
self.__parent.reset()
2004-02-13 08:24:30 +01:00
def _connect(self, network, serverPort=None):
try:
group = conf.supybot.networks.get(network)
(server, port) = group.servers()[0]
except (registry.NonExistentRegistryEntry, IndexError):
if serverPort is None:
raise ValueError, 'connect requires a (server, port) ' \
'if the network is not registered.'
conf.registerNetwork(network)
serverS = '%s:%s' % serverPort
conf.supybot.networks.get(network).servers.append(serverS)
assert conf.supybot.networks.get(network).servers()
self.log.info('Creating new Irc for %s.', network)
newIrc = irclib.Irc(network)
for irc in world.ircs:
if irc != newIrc:
newIrc.state.history = irc.state.history
driver = drivers.newDriver(newIrc)
return newIrc
2004-01-18 08:58:26 +01:00
def do001(self, irc, msg):
self.log.info('Loading plugins.')
alwaysLoadSrcPlugins = conf.supybot.plugins.alwaysLoadImportant()
for (name, value) in conf.supybot.plugins.getValues(fullNames=False):
if irc.getCallback(name) is None:
load = value()
2004-10-22 22:14:43 +02:00
# XXX This (_srcPlugins) should be changed to the configurable
# importantPlugins.
if not load and name in self._srcPlugins:
if alwaysLoadSrcPlugins:
s = '%s is configured not to be loaded, but is being '\
'loaded anyway because ' \
'supybot.plugins.alwaysLoadImportant is True.'
self.log.warning(s, name)
load = True
if load:
if not irc.getCallback(name):
2004-08-17 17:36:42 +02:00
# This is debug because each log logs its beginning.
self.log.debug('Loading %s.' % name)
try:
m = loadPluginModule(name)
loadPluginClass(irc, m)
except callbacks.Error, e:
# This is just an error message.
log.warning(str(e))
except ImportError, e:
2004-10-24 07:43:02 +02:00
log.warning('Failed to load %s: %s.', name, e)
if name in self._srcPlugins:
self.log.exception('Error loading %s:', name)
self.log.error('Error loading src/ plugin %s. '
'This is usually rather '
'serious; these plugins are '
2004-08-11 15:51:15 +02:00
'almost always be loaded.',name)
except Exception, e:
log.exception('Failed to load %s:', name)
else:
# Let's import the module so configuration is preserved.
try:
_ = loadPluginModule(name)
except Exception, e:
log.info('Attempted to load %s to preserve its '
'configuration, but load failed: %s',
name, e)
world.starting = False
2003-10-30 04:08:52 +01:00
def do376(self, irc, msg):
channels = ircutils.IrcSet(conf.supybot.channels())
channels |= conf.supybot.networks.get(irc.network).channels()
channels = list(channels)
if not channels:
return
utils.sortBy(lambda s: ',' not in s, channels)
keys = []
chans = []
for channel in channels:
if ',' in channel:
(channel, key) = channel.split(',', 1)
chans.append(channel)
keys.append(key)
else:
chans.append(channel)
irc.queueMsg(ircmsgs.joins(chans, keys))
do422 = do377 = do376
def doPrivmsg(self, irc, msg):
assert self is irc.callbacks[0], 'Owner isn\'t first callback.'
if ircmsgs.isCtcp(msg):
return
s = callbacks.addressed(irc.nick, msg)
if s:
ignored = ircdb.checkIgnored(msg.prefix)
2004-09-10 08:30:21 +02:00
if ignored:
self.log.info('Ignoring command from %s.' % msg.prefix)
return
try:
tokens = callbacks.tokenize(s, channel=msg.args[0])
self.Proxy(irc, msg, tokens)
except SyntaxError, e:
irc.queueMsg(callbacks.error(msg, str(e)))
2003-10-30 04:08:52 +01:00
if conf.allowEval:
2004-08-20 07:30:37 +02:00
_evalEnv = {'_': None,
'__': None,
'___': None,
}
_evalEnv.update(globals())
2004-10-22 07:35:05 +02:00
def eval(self, irc, msg, args, s):
"""<expression>
2003-09-02 21:55:53 +02:00
2004-04-15 08:22:01 +02:00
Evaluates <expression> (which should be a Python expression) and
returns its value. If an exception is raised, reports the
2004-10-10 05:17:18 +02:00
exception (and logs the traceback to the bot's logfile).
"""
if conf.allowEval:
try:
2004-08-20 07:30:37 +02:00
self._evalEnv.update(locals())
x = eval(s, self._evalEnv, self._evalEnv)
self._evalEnv['___'] = self._evalEnv['__']
self._evalEnv['__'] = self._evalEnv['_']
self._evalEnv['_'] = x
irc.reply(repr(x))
except SyntaxError, e:
irc.reply('%s: %r' % (utils.exnToString(e), s))
except Exception, e:
2004-10-10 05:17:18 +02:00
self.log.exception('Uncaught exception in Owner.eval. '
'This is not a bug. Please do not '
'report it.')
2004-10-10 05:48:33 +02:00
irc.reply(utils.exnToString(e))
else:
# There's a potential that allowEval got changed after we were
# loaded. Let's be extra-special-safe.
irc.error('You must run Supybot with the --allow-eval '
2004-02-05 08:53:00 +01:00
'option for this command to be enabled.')
2004-10-22 07:35:05 +02:00
eval = wrap(eval, ['text'])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def _exec(self, irc, msg, args, s):
"""<statement>
2003-09-02 21:55:53 +02:00
Execs <code>. Returns success if it didn't raise any exceptions.
"""
if conf.allowEval:
try:
exec s
irc.replySuccess()
except Exception, e:
irc.reply(utils.exnToString(e))
else:
# There's a potential that allowEval got changed after we were
# loaded. Let's be extra-special-safe.
irc.error('You must run Supybot with the --allow-eval '
2004-02-05 08:53:00 +01:00
'option for this command to be enabled.')
2004-10-22 07:35:05 +02:00
_exec = wrap(_exec, ['text'])
else:
def eval(self, irc, msg, args):
2004-02-05 08:53:00 +01:00
"""Run your bot with --allow-eval if you want this to work."""
irc.error('You must give your bot the --allow-eval option for '
'this command to be enabled.')
_exec = eval
2004-10-22 07:35:05 +02:00
def announce(self, irc, msg, args, text):
2004-04-18 02:38:20 +02:00
"""<text>
Sends <text> to all channels the bot is currently on and not
lobotomized in.
"""
u = ircdb.users.getUser(msg.prefix)
text = 'Announcement from my owner (%s): %s' % (u.name, text)
for channel in irc.state.channels:
c = ircdb.channels.getChannel(channel)
if not c.lobotomized:
irc.queueMsg(ircmsgs.privmsg(channel, text))
2004-10-22 07:35:05 +02:00
announce = wrap(announce, ['text'])
def defaultplugin(self, irc, msg, args):
"""[--remove] <command> [<plugin>]
2003-08-28 18:33:45 +02:00
Sets the default plugin for <command> to <plugin>. If --remove is
given, removes the current default plugin for <command>. If no plugin
is given, returns the current default plugin set for <command>.
"""
remove = False
(optlist, rest) = getopt.getopt(args, '', ['remove'])
for (option, arg) in optlist:
if option == '--remove':
remove = True
(command, plugin) = privmsgs.getArgs(rest, optional=1)
command = callbacks.canonicalName(command)
cbs = callbacks.findCallbackForCommand(irc, command)
if remove:
try:
conf.supybot.commands.defaultPlugins.unregister(command)
irc.replySuccess()
except registry.NonExistentRegistryEntry:
2004-07-31 08:15:19 +02:00
s = 'I don\'t have a default plugin set for that command.'
irc.error(s)
elif not cbs:
2004-10-22 07:35:05 +02:00
irc.errorInvalid('command', command)
elif plugin:
2004-07-31 08:15:19 +02:00
cb = irc.getCallback(plugin)
if cb is None:
2004-10-22 07:35:05 +02:00
irc.errorInvalid('plugin', plugin)
if not cb.isCommand(command):
irc.errorInvalid('command in the %s plugin' % plugin, command)
registerDefaultPlugin(command, plugin)
irc.replySuccess()
else:
2004-04-28 12:31:15 +02:00
try:
irc.reply(conf.supybot.commands.defaultPlugins.get(command)())
except registry.NonExistentRegistryEntry:
s = 'I don\'t have a default plugin set for that command.'
irc.error(s)
2004-10-22 07:35:05 +02:00
def ircquote(self, irc, msg, args, s):
2003-08-28 18:33:45 +02:00
"""<string to be sent to the server>
Sends the raw string given to the server.
"""
s = privmsgs.getArgs(args)
try:
m = ircmsgs.IrcMsg(s)
except Exception, e:
irc.error(utils.exnToString(e))
else:
2003-08-28 18:33:45 +02:00
irc.queueMsg(m)
2004-10-22 07:35:05 +02:00
ircquote = wrap(ircquote, ['text'])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def quit(self, irc, msg, args, text):
2004-08-19 22:32:07 +02:00
"""[<text>]
2003-08-28 18:33:45 +02:00
2004-08-19 22:32:07 +02:00
Exits the bot with the QUIT message <text>. If <text> is not given,
your nick will be substituted.
2003-08-28 18:33:45 +02:00
"""
2004-08-19 22:32:07 +02:00
if not text:
text = msg.nick
2004-10-01 00:48:54 +02:00
irc.noReply()
2004-08-19 22:32:07 +02:00
m = ircmsgs.quit(text)
world.upkeep()
for irc in world.ircs[:]:
2004-08-19 22:32:07 +02:00
irc.queueMsg(m)
irc.die()
2004-10-22 07:35:05 +02:00
quit = wrap(quit, [additional('text')])
2003-08-28 18:33:45 +02:00
def flush(self, irc, msg, args):
"""takes no arguments
Runs all the periodic flushers in world.flushers. This includes
flushing all logs and all configuration changes to disk.
2003-08-28 18:33:45 +02:00
"""
world.flush()
irc.replySuccess()
2004-10-22 07:35:05 +02:00
flush = wrap(flush)
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def upkeep(self, irc, msg, args, level):
"""[<level>]
2003-08-28 18:33:45 +02:00
Runs the standard upkeep stuff (flushes and gc.collects()). If given
a level, runs that level of upkeep (currently, the only supported
level is "high", which causes the bot to flush a lot of caches as well
as do normal upkeep stuff.
2003-08-28 18:33:45 +02:00
"""
L = []
if level == 'high':
L.append('Regexp cache flushed: %s cleared.' %
utils.nItems('regexp', len(sre._cache)))
sre.purge()
L.append('Pattern cache flushed: %s cleared.' %
utils.nItems('compiled pattern',
len(ircutils._patternCache)))
ircutils._patternCache.clear()
L.append('hostmaskPatternEqual cache flushed: %s cleared.' %
2004-08-21 10:53:29 +02:00
utils.nItems('result',
len(ircutils._hostmaskPatternEqualCache)))
ircutils._hostmaskPatternEqualCache.clear()
L.append('ircdb username cache flushed: %s cleared.' %
utils.nItems('username to id mapping',
len(ircdb.users._nameCache)))
ircdb.users._nameCache.clear()
L.append('ircdb hostmask cache flushed: %s cleared.' %
utils.nItems('hostmask to id mapping',
len(ircdb.users._hostmaskCache)))
ircdb.users._hostmaskCache.clear()
L.append('linecache line cache flushed: %s cleared.' %
utils.nItems('line', len(linecache.cache)))
linecache.clearcache()
sys.exc_clear()
collected = world.upkeep()
2003-08-28 18:33:45 +02:00
if gc.garbage:
L.append('Garbage! %r.' % gc.garbage)
L.append('%s collected.' % utils.nItems('object', collected))
irc.reply(' '.join(L))
2004-10-22 07:35:05 +02:00
upkeep = wrap(upkeep, [additional(('literal', ['high']))])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def load(self, irc, msg, args, optlist, name):
2004-01-15 15:08:14 +01:00
"""[--deprecated] <plugin>
2003-08-28 18:33:45 +02:00
Loads the plugin <plugin> from any of the directories in
2004-01-18 08:58:26 +01:00
conf.supybot.directories.plugins; usually this includes the main
installed directory and 'plugins' in the current directory.
--deprecated is necessary if you wish to load deprecated plugins.
2003-08-28 18:33:45 +02:00
"""
2004-01-15 15:08:14 +01:00
ignoreDeprecation = False
for (option, argument) in optlist:
2004-10-22 07:35:05 +02:00
if option == 'deprecated':
2004-01-15 15:08:14 +01:00
ignoreDeprecation = True
if name.endswith('.py'):
name = name[:-3]
2003-10-24 11:03:34 +02:00
if irc.getCallback(name):
2004-09-10 08:30:21 +02:00
irc.error('%s is already loaded.' % name.capitalize())
2003-10-24 11:03:34 +02:00
return
2003-08-28 18:33:45 +02:00
try:
2004-01-15 15:08:14 +01:00
module = loadPluginModule(name, ignoreDeprecation)
except Deprecated:
2004-09-10 08:30:21 +02:00
irc.error('%s is deprecated. Use --deprecated '
'to force it to load.' % name.capitalize())
2004-01-15 15:08:14 +01:00
return
except ImportError, e:
if name in str(e):
2004-09-10 08:30:21 +02:00
irc.error('No plugin named %s exists.' % utils.dqrepr(name))
else:
2004-02-04 19:01:00 +01:00
irc.error(str(e))
2003-08-28 18:33:45 +02:00
return
2004-04-30 20:24:35 +02:00
cb = loadPluginClass(irc, module)
name = cb.name() # Let's normalize this.
conf.registerPlugin(name, True)
irc.replySuccess()
2004-10-22 07:35:05 +02:00
load = wrap(load, [getopts({'deprecated': ''}), 'something'])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def reload(self, irc, msg, args, name):
2003-09-05 20:47:58 +02:00
"""<plugin>
2003-08-28 18:33:45 +02:00
2003-12-16 20:57:18 +01:00
Unloads and subsequently reloads the plugin by name; use the 'list'
command to see a list of the currently loaded plugins.
2003-08-28 18:33:45 +02:00
"""
callbacks = irc.removeCallback(name)
if callbacks:
module = sys.modules[callbacks[0].__module__]
if hasattr(module, 'reload'):
x = module.reload()
2003-08-28 18:33:45 +02:00
try:
module = loadPluginModule(name)
if hasattr(module, 'reload'):
module.reload(x)
2003-09-06 03:13:43 +02:00
for callback in callbacks:
callback.die()
del callback
gc.collect() # This makes sure the callback is collected.
callback = loadPluginClass(irc, module)
irc.replySuccess()
2003-08-28 18:33:45 +02:00
except ImportError:
for callback in callbacks:
irc.addCallback(callback)
irc.error('No plugin %s exists.' % name)
2003-08-28 18:33:45 +02:00
else:
2004-08-03 05:27:49 +02:00
irc.error('There was no plugin %s.' % name)
2004-10-22 07:35:05 +02:00
reload = wrap(reload, ['something'])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def unload(self, irc, msg, args, name):
2003-09-05 20:47:58 +02:00
"""<plugin>
2003-08-28 18:33:45 +02:00
Unloads the callback by name; use the 'list' command to see a list
2004-08-01 20:46:56 +02:00
of the currently loaded callbacks. Obviously, the Owner plugin can't
be unloaded.
2003-08-28 18:33:45 +02:00
"""
2004-08-01 20:46:56 +02:00
if ircutils.strEqual(name, self.name()):
irc.error('You can\'t unload the %s plugin.' % name)
2004-08-01 20:46:56 +02:00
return
# Let's do this so even if the plugin isn't currently loaded, it doesn't
# stay attempting to load.
conf.registerPlugin(name, False)
2003-08-28 18:33:45 +02:00
callbacks = irc.removeCallback(name)
if callbacks:
for callback in callbacks:
callback.die()
del callback
gc.collect()
irc.replySuccess()
2003-08-28 18:33:45 +02:00
else:
2004-08-03 05:27:49 +02:00
irc.error('There was no plugin %s.' % name)
2004-10-22 07:35:05 +02:00
unload = wrap(unload, ['something'])
2003-08-28 18:33:45 +02:00
2004-10-22 07:35:05 +02:00
def defaultcapability(self, irc, msg, args, action, capability):
"""{add|remove} <capability>
2004-08-27 07:00:40 +02:00
Adds or removes (according to the first argument) <capability> from the
default capabilities given to users (the configuration variable
supybot.capabilities stores these).
"""
if action == 'add':
conf.supybot.capabilities().add(capability)
irc.replySuccess()
elif action == 'remove':
try:
conf.supybot.capabilities().remove(capability)
irc.replySuccess()
except KeyError:
if ircdb.isAntiCapability(capability):
irc.error('That capability wasn\'t in '
'supybot.capabilities.')
else:
anticap = ircdb.makeAntiCapability(capability)
conf.supybot.capabilities().add(anticap)
irc.replySuccess()
2004-10-22 07:35:05 +02:00
defaultcapability = wrap(defaultcapability,
[('literal', ['add','remove']), 'capability'])
2004-08-27 07:00:40 +02:00
def disable(self, irc, msg, args):
"""[<plugin>] <command>
2004-08-27 06:31:53 +02:00
Disables the command <command> for all users (including the owners).
If <plugin> is given, only disables the <command> from <plugin>. If
you want to disable a command for most users but not for yourself, set
a default capability of -plugin.command or -command (if you want to
disable the command in all plugins).
"""
(plugin, command) = privmsgs.getArgs(args, optional=1)
if not command:
(plugin, command) = (None, plugin)
conf.supybot.commands.disabled().add(command)
else:
conf.supybot.commands.disabled().add('%s.%s' % (plugin, command))
if command in ('enable', 'identify'):
irc.error('You can\'t disable %s.' % command)
else:
self._disabled.add(command, plugin)
irc.replySuccess()
def enable(self, irc, msg, args):
"""[<plugin>] <command>
2004-08-27 06:31:53 +02:00
Enables the command <command> for all users. If <plugin>
if given, only enables the <command> from <plugin>. This command is
the inverse of disable.
"""
(plugin, command) = privmsgs.getArgs(args, optional=1)
try:
if not command:
(plugin, command) = (None, plugin)
conf.supybot.commands.disabled().remove(command)
else:
name = '%s.%s' % (plugin, command)
conf.supybot.commands.disabled().remove(name)
self._disabled.remove(command, plugin)
irc.replySuccess()
except KeyError:
irc.error('That command wasn\'t disabled.')
def rename(self, irc, msg, args):
"""<plugin> <command> <new name>
Renames <command> in <plugin> to the <new name>.
"""
(plugin, command, newName) = privmsgs.getArgs(args, required=3)
name = callbacks.canonicalName(newName)
if name != newName:
irc.errorInvalid('command name', name,
'Try making it lowercase and removing dashes '
'and underscores.', Raise=True)
cb = irc.getCallback(plugin)
if cb is None:
irc.errorInvalid('plugin', plugin, Raise=True)
if not cb.isCommand(command):
2004-09-11 18:16:16 +02:00
what = 'command in the %s plugin' % plugin
irc.errorInvalid(what, name, Raise=True)
if hasattr(cb, name):
irc.error('The %s plugin already has an attribute named %s.' %
(plugin, name))
return
2004-09-11 18:16:16 +02:00
registerRename(cb.name(), command, name)
renameCommand(cb, command, newName)
irc.replySuccess()
2004-08-11 14:57:52 +02:00
2004-09-11 18:16:16 +02:00
def unrename(self, irc, msg, args):
"""<plugin>
Removes all renames in <plugin>. The plugin will be reloaded after
this command is run.
"""
plugin = privmsgs.getArgs(args)
try:
conf.supybot.commands.renames.unregister(plugin)
except registry.NonExistentRegistryEntry:
irc.errorInvalid('plugin', plugin, Raise=True)
self.reload(irc, msg, args) # This makes the replySuccess.
2003-08-28 18:33:45 +02:00
2003-10-21 08:03:57 +02:00
Class = Owner
2003-08-28 18:33:45 +02:00
# vim:set shiftwidth=4 tabstop=8 expandtab textwidth=78: