dreamirc/src/ircsupport.py

   1 # Copyright (c) 2001-2004 Twisted Matrix Laboratories.
   2 # See LICENSE for details.
   3
   4
   5 """IRC support for Instance Messenger."""
   6
   7 import string
   8
   9 from protocols import irc
  10 from twisted.internet import defer, reactor, protocol
  11 from twisted.internet.defer import succeed
  12 import e2support, interfaces,dreamIRCTools
  13 from zope.interface import implements
  14
  15 class IRCPerson(e2support.AbstractPerson):
  16
  17     def imperson_whois(self):
  18         if self.account.client is None:
  19             return 0
  20         self.account.client.sendLine("WHOIS %s" % self.name)
  21
  22     ### interface impl
  23
  24     def isOnline(self):
  25         return ONLINE
  26
  27     def getStatus(self):
  28         return ONLINE
  29
  30     def setStatus(self,status):
  31         self.status=status
  32         self.chat.getContactsList().setContactStatus(self)
  33
  34     def sendMessage(self, text, meta=None):
  35         if self.account.client is None:
  36             return 0
  37         for line in string.split(text, '\n'):
  38             if meta and meta.get("style", None) == "emote":
  39                 self.account.client.ctcpMakeQuery(self.name,[('ACTION', line)])
  40             else:
  41                 self.account.client.msg(self.name, line)
  42         return succeed(text)
  43
  44     def bye(self):
  45         if self.account.client is None:
  46             print "not connected"
  47         else:
  48                   self.account.client.quit("user logged off")
  49
  50
  51 class IRCGroup(e2support.AbstractGroup):
  52
  53     implements(interfaces.IGroup)
  54
  55     def imgroup_testAction(self):
  56         print 'action test!'
  57
  58     def imtarget_kick(self, target):
  59         if self.account.client is None:
  60             return 0
  61         reason = "... and justice for all!"
  62         self.account.client.sendLine("KICK #%s %s :%s" % (
  63             self.name, target.name, reason))
  64
  65     ### Interface Implementation
  66
  67     def setTopic(self, topic):
  68         if self.account.client is None:
  69             return 0
  70         self.account.client.topic(self.name, topic)
  71
  72     def sendGroupMessage(self, text, meta={}):
  73         if self.account.client is None:
  74             return 0
  75         if meta and meta.get("style", None) == "emote":
  76             self.account.client.me(self.name,text)
  77             return succeed(text)
  78         #standard shmandard, clients don't support plain escaped newlines!
  79         for line in string.split(text, '\n'):
  80             self.account.client.say(self.name, line)
  81         return succeed(text)
  82
  83     def leave(self):
  84         if self.account.client is None:
  85             return 0
  86         self.account.client.leave(self.name)
  87         self.account.client.getGroupConversation(self.name,1)
  88
  89     def bye(self):
  90         if self.account.client is None:
  91             print "not connected"
  92         else:
  93                 self.account.client.quit("user logged off")
  94
  95
  96 class IRCProto(e2support.AbstractClientMixin, irc.IRCClient):
  97     def __init__(self, account, chatui, logonDeferred=None):
  98         e2support.AbstractClientMixin.__init__(self, account, chatui,
  99                                                  logonDeferred)
 100         self._namreplies={}
 101         self._ingroups={}
 102         self._groups={}
 103         self._topics={}
 104
 105     def getGroupConversation(self, name, hide=0):
 106         name=string.lower(name)
 107         return self.chat.getGroupConversation(self.chat.getGroup(name, self),
 108                                               stayHidden=hide)
 109
 110     def getPerson(self,name):
 111         return self.chat.getPerson(name, self)
 112
 113     def connectionMade(self):
 114         # XXX: Why do I duplicate code in IRCClient.register?
 115         try:
 116             print 'connection made on irc service!?', self
 117             if self.account.password:
 118                 self.sendLine("PASS :%s" % self.account.password)
 119             self.setNick(self.account.username)
 120             self.sendLine("USER %s foo bar :dreamIRC e2 v1.0 user" % (self.nickname))
 121             for channel in self.account.channels:
 122                 print "joining channel: %s" % channel
 123                 self.joinGroup(channel)
 124             self.account._isOnline=1
 125             print 'uh, registering irc acct'
 126             if self._logonDeferred is not None:
 127                 self._logonDeferred.callback(self)
 128             self.chat.getContactsList()
 129         except:
 130             import traceback
 131             traceback.print_exc()
 132
 133     def setNick(self,nick):
 134         self.name=nick
 135         self.accountName="%s (IRC)"%nick
 136         irc.IRCClient.setNick(self,nick)
 137
 138     def quit(self,message='bye bye'):
 139 #         self.quit_str=str("QUIT :%s" % message)
 140          self.sendLine("QUIT :%s" % message)
 141
 142     def kickedFrom(self, channel, kicker, message):
 143         """Called when I am kicked from a channel.
 144         """
 145         print 'wow i was kicked', channel, kicker, message
 146         return self.chat.getGroupConversation(
 147             self.chat.getGroup(channel[1:], self), 1)
 148
 149     def userKicked(self, kickee, channel, kicker, message):
 150         print 'whew somebody else', kickee, channel, kicker, message
 151
 152     def noticed(self, username, channel, message):
 153         self.privmsg(username, channel, message, {"dontAutoRespond": 1})
 154
 155     def privmsg(self, username, channel, message, metadata=None):
 156         if metadata is None:
 157             metadata = {}
 158         username=string.split(username,'!',1)[0]
 159         if username==self.name: return
 160         if channel[0]=='#':
 161             group=channel[1:]
 162             self.getGroupConversation(group).showGroupMessage(username, message, metadata)
 163             return
 164         self.chat.getConversation(self.getPerson(username)).showMessage(message, metadata)
 165
 166     def action(self,username,channel,emote):
 167         username=string.split(username,'!',1)[0]
 168         if username==self.name: return
 169         meta={'style':'emote'}
 170         if channel[0]=='#':
 171             group=channel[1:]
 172             self.getGroupConversation(group).showGroupMessage(username, emote, meta)
 173             return
 174         self.chat.getConversation(self.getPerson(username)).showMessage(emote,meta)
 175
 176     def irc_RPL_NAMREPLY(self,prefix,params):
 177         """
 178         RPL_NAMREPLY
 179         >> NAMES #bnl
 180         << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
 181         """
 182         group=string.lower(params[2][1:])
 183         users=string.split(params[3])
 184         for ui in range(len(users)):
 185             while users[ui][0] in ["@","+"]: # channel modes
 186                 users[ui]=users[ui][1:]
 187         if not self._namreplies.has_key(group):
 188             self._namreplies[group]=[]
 189         self._namreplies[group].extend(users)
 190         for nickname in users:
 191                 try:
 192                     self._ingroups[nickname].append(group)
 193                 except:
 194                     self._ingroups[nickname]=[group]
 195
 196     def irc_RPL_ENDOFNAMES(self,prefix,params):
 197         group=params[1][1:]
 198         self.getGroupConversation(group).setGroupMembers(self._namreplies[string.lower(group)])
 199         del self._namreplies[string.lower(group)]
 200
 201     def irc_RPL_TOPIC(self,prefix,params):
 202         self._topics[params[1][1:]]=params[2]
 203
 204     def irc_333(self,prefix,params):
 205         group=params[1][1:]
 206         self.getGroupConversation(group).setTopic(self._topics[group],params[2])
 207         del self._topics[group]
 208
 209     def irc_TOPIC(self,prefix,params):
 210         nickname = string.split(prefix,"!")[0]
 211         group = params[0][1:]
 212         topic = params[1]
 213         self.getGroupConversation(group).setTopic(topic,nickname)
 214
 215     def irc_JOIN(self,prefix,params):
 216         nickname=string.split(prefix,"!")[0]
 217         group=string.lower(params[0][1:])
 218         if nickname!=self.nickname:
 219             try:
 220                 self._ingroups[nickname].append(group)
 221             except:
 222                 self._ingroups[nickname]=[group]
 223             self.getGroupConversation(group).memberJoined(nickname)
 224
 225     def irc_PART(self,prefix,params):
 226         nickname=string.split(prefix,"!")[0]
 227         group=string.lower(params[0][1:])
 228         if nickname!=self.nickname:
 229             if group in self._ingroups[nickname]:
 230                 self._ingroups[nickname].remove(group)
 231                 self.getGroupConversation(group).memberLeft(nickname)
 232             else:
 233                 print "%s left %s, but wasn't in the room."%(nickname,group)
 234
 235     def irc_QUIT(self,prefix,params):
 236         nickname=string.split(prefix,"!")[0]
 237         if self._ingroups.has_key(nickname):
 238             for group in self._ingroups[nickname]:
 239                 self.getGroupConversation(group).memberLeft(nickname)
 240             self._ingroups[nickname]=[]
 241         else:
 242             print '*** WARNING: ingroups had no such key %s' % nickname
 243
 244     def irc_NICK(self, prefix, params):
 245         fromNick = string.split(prefix, "!")[0]
 246         toNick = params[0]
 247         if not self._ingroups.has_key(fromNick):
 248             print "%s changed nick to %s. But she's not in any groups!?" % (fromNick, toNick)
 249             return
 250         for group in self._ingroups[fromNick]:
 251             self.getGroupConversation(group).memberChangedNick(fromNick, toNick)
 252         self._ingroups[toNick] = self._ingroups[fromNick]
 253         del self._ingroups[fromNick]
 254
 255     def irc_unknown(self, prefix, command, params):
 256         print "unknown message from IRCserver. prefix: %s, command: %s, params: %s" % (prefix, command, params)
 257
 258     # GTKIM calls
 259     def joinGroup(self,name):
 260         self.join(name)
 261         self.getGroupConversation(name)
 262
 263 class IRCAccount(e2support.AbstractAccount):
 264     implements(interfaces.IAccount)
 265     gatewayType = "IRC"
 266
 267     _groupFactory = IRCGroup
 268     _personFactory = IRCPerson
 269
 270     def __init__(self, accountName, autoLogin, username, password, host, port, channels=''):
 271         e2support.AbstractAccount.__init__(self, accountName, autoLogin, username, password, host, port)
 272         self.channels = map(string.strip,string.split(channels,','))
 273         if self.channels == ['']:
 274             self.channels = []
 275
 276     def _startLogOn(self, chatui):
 277         logonDeferred = defer.Deferred()
 278         cc = protocol.ClientCreator(reactor, IRCProto, self, chatui, logonDeferred)
 279         d = cc.connectTCP(self.host, self.port)
 280         d.addErrback(logonDeferred.errback)
 281         return logonDeferred
 282