From d227111b0cce67bd0abddfa9fca030c03c0da4f5 Mon Sep 17 00:00:00 2001 From: Jeremy Fincher Date: Wed, 17 Sep 2003 22:38:03 +0000 Subject: [PATCH] Added privmsgs.name, privmsgs.channel, and privmsgs.checkChannelCapability. Converted the Topic plugin to use some of them. --- plugins/Topic.py | 119 ++++++++++++++++++++++------------------------- src/privmsgs.py | 39 ++++++++++++++++ 2 files changed, 94 insertions(+), 64 deletions(-) diff --git a/plugins/Topic.py b/plugins/Topic.py index cab702a00..07fe20928 100644 --- a/plugins/Topic.py +++ b/plugins/Topic.py @@ -68,54 +68,48 @@ class Topic(callbacks.Privmsg): topicSeparator = ' || ' topicFormatter = '%s (%s)' topicUnformatter = re.compile('(.*) \((\S+)\)') - def addtopic(self, irc, msg, args): + def addtopic(self, irc, msg, args, channel): """[] Adds to the topics for . is only necessary if the message isn't sent in the channel itself. """ - channel = privmsgs.getChannel(msg, args) - capability = ircdb.makeChannelCapability(channel, 'topic') topic = privmsgs.getArgs(args) - if ircdb.checkCapability(msg.prefix, capability): - if self.topicSeparator in topic: - s = 'You can\'t have %s in your topic' % self.topicSeparator - irc.error(msg, s) - return - currentTopic = irc.state.getTopic(channel) - try: - name = ircdb.users.getUser(msg.prefix).name - except KeyError: - name = msg.nick - formattedTopic = self.topicFormatter % (topic, name) - if currentTopic: - newTopic = self.topicSeparator.join((currentTopic, - formattedTopic)) - else: - newTopic = formattedTopic - irc.queueMsg(ircmsgs.topic(channel, newTopic)) + if self.topicSeparator in topic: + s = 'You can\'t have %s in your topic' % self.topicSeparator + irc.error(msg, s) + return + currentTopic = irc.state.getTopic(channel) + try: + name = ircdb.users.getUser(msg.prefix).name + except KeyError: + name = msg.nick + formattedTopic = self.topicFormatter % (topic, name) + if currentTopic: + newTopic = self.topicSeparator.join((currentTopic, + formattedTopic)) else: - irc.error(msg, conf.replyNoCapability % capability) + newTopic = formattedTopic + irc.queueMsg(ircmsgs.topic(channel, newTopic)) + addtopic = privmsgs.checkChannelCapability(addtopic, 'topic') - def shuffletopic(self, irc, msg, args): + def shuffletopic(self, irc, msg, args, channel): """[] Shuffles the topics in . is only necessary if the message isn't sent in the channel itself. """ - channel = privmsgs.getChannel(msg, args) - capability = ircdb.makeChannelCapability(channel, 'topic') - if ircdb.checkCapability(msg.prefix, capability): - newtopic = irc.state.getTopic(channel) - while newtopic == irc.state.getTopic(channel): - topics = irc.state.getTopic(channel).split(self.topicSeparator) - random.shuffle(topics) - newtopic = self.topicSeparator.join(topics) - irc.queueMsg(ircmsgs.topic(channel, newtopic)) - else: - irc.error(msg, conf.replyNoCapability % capability) + newtopic = irc.state.getTopic(channel) + topics = newtopic.split(self.topicSeparator) + random.shuffle(topics) + newtopic = self.topicSeparator.join(topics) + while len(topics) > 1 and newtopic == irc.state.getTopic(channel): + random.shuffle(topics) + newtopic = self.topicSeparator.join(topics) + irc.queueMsg(ircmsgs.topic(channel, newtopic)) + shuffletopic = privmsgs.checkChannelCapability(shuffletopic, 'topic') - def topic(self, irc, msg, args): + def gettopic(self, irc, msg, args, channel): """[] Returns topic number from . is a zero-based @@ -128,14 +122,15 @@ class Topic(callbacks.Privmsg): except ValueError: irc.error(msg, 'The argument must be a valid integer.') return - topics = irc.state.getTopic(msg.args[0]).split(self.topicSeparator) + topics = irc.state.getTopic(channel).split(self.topicSeparator) try: irc.reply(msg, topics[i]) except IndexError: irc.error(msg, 'That\'s not a valid index.') return + gettopic = privmsgs.channel(topicget) - def changetopic(self, irc, msg, args): + def changetopic(self, irc, msg, args, channel): """[] Changes the topic number on according to the regular @@ -144,7 +139,6 @@ class Topic(callbacks.Privmsg): s/regexp/replacement/flags. is only necessary if the message isn't sent in the channel itself. """ - channel = privmsgs.getChannel(msg, args) (number, regexp) = privmsgs.getArgs(args, needed=2) try: number = int(number) @@ -180,8 +174,9 @@ class Topic(callbacks.Privmsg): topics.insert(number, newTopic) newTopic = self.topicSeparator.join(topics) irc.queueMsg(ircmsgs.topic(channel, newTopic)) + changetopic = privmsgs.checkChannelCapability(changetopic, 'topic') - def removetopic(self, irc, msg, args): + def removetopic(self, irc, msg, args, channel): """[] Removes topic from the topic for Topics are @@ -189,38 +184,34 @@ class Topic(callbacks.Privmsg): to topics starting the from the end of the topic. is only necessary if the message isn't sent in the channel itself. """ - channel = privmsgs.getChannel(msg, args) - capability = ircdb.makeChannelCapability(channel, 'topic') try: number = int(privmsgs.getArgs(args)) except ValueError: irc.error(msg, 'The argument must be a number.') return - if ircdb.checkCapability(msg.prefix, capability): - topics = irc.state.getTopic(channel).split(self.topicSeparator) - try: - topic = topics.pop(number) - except IndexError: - irc.error(msg, 'That\'s not a valid topic number.') - return - ## debug.printf(topic) - match = self.topicUnformatter.match(topic) - if match is None: - name = '' - else: - (topic, name) = match.groups() - try: - username = ircdb.users.getUser(msg.prefix).name - except KeyError: - username = msg.nick - if name and name != username and \ - not ircdb.checkCapabilities(msg.prefix, ('op', 'admin')): - irc.error(msg, 'You can only remove your own topics.') - return - newTopic = self.topicSeparator.join(topics) - irc.queueMsg(ircmsgs.topic(channel, newTopic)) + topics = irc.state.getTopic(channel).split(self.topicSeparator) + try: + topic = topics.pop(number) + except IndexError: + irc.error(msg, 'That\'s not a valid topic number.') + return + ## debug.printf(topic) + match = self.topicUnformatter.match(topic) + if match is None: + name = '' else: - irc.error(msg, conf.replyNoCapability % capability) + (topic, name) = match.groups() + try: + username = ircdb.users.getUser(msg.prefix).name + except KeyError: + username = msg.nick + if name and name != username and \ + not ircdb.checkCapabilities(msg.prefix, ('op', 'admin')): + irc.error(msg, 'You can only remove your own topics.') + return + newTopic = self.topicSeparator.join(topics) + irc.queueMsg(ircmsgs.topic(channel, newTopic)) + removetopic = privmsgs.checkChannelCapability(removetopic, 'topic') Class = Topic diff --git a/src/privmsgs.py b/src/privmsgs.py index b86847800..cd83c4070 100644 --- a/src/privmsgs.py +++ b/src/privmsgs.py @@ -86,6 +86,19 @@ def checkCapability(f, capability): newf.__doc__ = f.__doc__ return newf +def checkChannelCapability(f, capability): + """Makes sure a user has a certain channel capability before running f.""" + def newf(self, irc, msg, args): + channel = getChannel(msg, args) # Make a copy, f might getChannel. + chancap = ircdb.makeChannelCapability(channel, capability) + if ircdb.checkCapability(msg.prefix, chancap): + ff = new.instancemethod(f, self, self.__class__) + ff(irc, msg, args, channel) + else: + irc.error(msg, conf.replyNoCapability % chancap) + newf.__doc__ = f.__doc__ + return newf + def thread(f): """Makes sure a command spawns a thread when called.""" def newf(self, irc, msg, args): @@ -95,6 +108,32 @@ def thread(f): newf.__doc__ = f.__doc__ return newf +def name(f): + """Makes sure a name is available based on conf.requireRegistration.""" + def newf(self, irc, msg, args): + try: + name = ircdb.users.getUser(msg.prefix).name + except KeyError: + if conf.requireRegistration: + irc.error(msg, conf.replyNotRegistered) + return + else: + name = msg.prefix + ff = new.instancemethod(f, self, self.__class__) + ff(irc, msg, args, name) + newf.__doc__ = f.__doc__ + return newf + +def channel(f): + """Gives the command an extra channel arg as if it had called getChannel""" + def newf(self, irc, msg, args): + channel = getChannel(msg, args) + ff = new.instancemethod(f, self, self.__class__) + ff(irc, msg, args, channel) + newf.__doc__ = f.__doc__ + return newf + + class CapabilityCheckingPrivmsg(callbacks.Privmsg): """A small subclass of callbacks.Privmsg that checks self.capability before allowing any command to be called.