ircsupport.py 8.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293
  1. # Copyright (c) Twisted Matrix Laboratories.
  2. # See LICENSE for details.
  3. """
  4. IRC support for Instance Messenger.
  5. """
  6. from twisted.words.protocols import irc
  7. from twisted.words.im.locals import ONLINE
  8. from twisted.internet import defer, reactor, protocol
  9. from twisted.internet.defer import succeed
  10. from twisted.words.im import basesupport, interfaces, locals
  11. from zope.interface import implementer
  12. class IRCPerson(basesupport.AbstractPerson):
  13. def imperson_whois(self):
  14. if self.account.client is None:
  15. raise locals.OfflineError
  16. self.account.client.sendLine("WHOIS %s" % self.name)
  17. ### interface impl
  18. def isOnline(self):
  19. return ONLINE
  20. def getStatus(self):
  21. return ONLINE
  22. def setStatus(self,status):
  23. self.status=status
  24. self.chat.getContactsList().setContactStatus(self)
  25. def sendMessage(self, text, meta=None):
  26. if self.account.client is None:
  27. raise locals.OfflineError
  28. for line in text.split('\n'):
  29. if meta and meta.get("style", None) == "emote":
  30. self.account.client.ctcpMakeQuery(self.name,[('ACTION', line)])
  31. else:
  32. self.account.client.msg(self.name, line)
  33. return succeed(text)
  34. @implementer(interfaces.IGroup)
  35. class IRCGroup(basesupport.AbstractGroup):
  36. def imgroup_testAction(self):
  37. pass
  38. def imtarget_kick(self, target):
  39. if self.account.client is None:
  40. raise locals.OfflineError
  41. reason = "for great justice!"
  42. self.account.client.sendLine("KICK #%s %s :%s" % (
  43. self.name, target.name, reason))
  44. ### Interface Implementation
  45. def setTopic(self, topic):
  46. if self.account.client is None:
  47. raise locals.OfflineError
  48. self.account.client.topic(self.name, topic)
  49. def sendGroupMessage(self, text, meta={}):
  50. if self.account.client is None:
  51. raise locals.OfflineError
  52. if meta and meta.get("style", None) == "emote":
  53. self.account.client.ctcpMakeQuery(self.name,[('ACTION', text)])
  54. return succeed(text)
  55. #standard shmandard, clients don't support plain escaped newlines!
  56. for line in text.split('\n'):
  57. self.account.client.say(self.name, line)
  58. return succeed(text)
  59. def leave(self):
  60. if self.account.client is None:
  61. raise locals.OfflineError
  62. self.account.client.leave(self.name)
  63. self.account.client.getGroupConversation(self.name,1)
  64. class IRCProto(basesupport.AbstractClientMixin, irc.IRCClient):
  65. def __init__(self, account, chatui, logonDeferred=None):
  66. basesupport.AbstractClientMixin.__init__(self, account, chatui,
  67. logonDeferred)
  68. self._namreplies={}
  69. self._ingroups={}
  70. self._groups={}
  71. self._topics={}
  72. def getGroupConversation(self, name, hide=0):
  73. name = name.lower()
  74. return self.chat.getGroupConversation(self.chat.getGroup(name, self),
  75. stayHidden=hide)
  76. def getPerson(self,name):
  77. return self.chat.getPerson(name, self)
  78. def connectionMade(self):
  79. # XXX: Why do I duplicate code in IRCClient.register?
  80. try:
  81. self.performLogin = True
  82. self.nickname = self.account.username
  83. self.password = self.account.password
  84. self.realname = "Twisted-IM user"
  85. irc.IRCClient.connectionMade(self)
  86. for channel in self.account.channels:
  87. self.joinGroup(channel)
  88. self.account._isOnline=1
  89. if self._logonDeferred is not None:
  90. self._logonDeferred.callback(self)
  91. self.chat.getContactsList()
  92. except:
  93. import traceback
  94. traceback.print_exc()
  95. def setNick(self,nick):
  96. self.name=nick
  97. self.accountName="%s (IRC)"%nick
  98. irc.IRCClient.setNick(self,nick)
  99. def kickedFrom(self, channel, kicker, message):
  100. """
  101. Called when I am kicked from a channel.
  102. """
  103. return self.chat.getGroupConversation(
  104. self.chat.getGroup(channel[1:], self), 1)
  105. def userKicked(self, kickee, channel, kicker, message):
  106. pass
  107. def noticed(self, username, channel, message):
  108. self.privmsg(username, channel, message, {"dontAutoRespond": 1})
  109. def privmsg(self, username, channel, message, metadata=None):
  110. if metadata is None:
  111. metadata = {}
  112. username = username.split('!',1)[0]
  113. if username==self.name: return
  114. if channel[0]=='#':
  115. group=channel[1:]
  116. self.getGroupConversation(group).showGroupMessage(username, message, metadata)
  117. return
  118. self.chat.getConversation(self.getPerson(username)).showMessage(message, metadata)
  119. def action(self,username,channel,emote):
  120. username = username.split('!',1)[0]
  121. if username==self.name: return
  122. meta={'style':'emote'}
  123. if channel[0]=='#':
  124. group=channel[1:]
  125. self.getGroupConversation(group).showGroupMessage(username, emote, meta)
  126. return
  127. self.chat.getConversation(self.getPerson(username)).showMessage(emote,meta)
  128. def irc_RPL_NAMREPLY(self,prefix,params):
  129. """
  130. RPL_NAMREPLY
  131. >> NAMES #bnl
  132. << :Arlington.VA.US.Undernet.Org 353 z3p = #bnl :pSwede Dan-- SkOyg AG
  133. """
  134. group = params[2][1:].lower()
  135. users = params[3].split()
  136. for ui in range(len(users)):
  137. while users[ui][0] in ["@","+"]: # channel modes
  138. users[ui]=users[ui][1:]
  139. if group not in self._namreplies:
  140. self._namreplies[group]=[]
  141. self._namreplies[group].extend(users)
  142. for nickname in users:
  143. try:
  144. self._ingroups[nickname].append(group)
  145. except:
  146. self._ingroups[nickname]=[group]
  147. def irc_RPL_ENDOFNAMES(self,prefix,params):
  148. group=params[1][1:]
  149. self.getGroupConversation(group).setGroupMembers(self._namreplies[group.lower()])
  150. del self._namreplies[group.lower()]
  151. def irc_RPL_TOPIC(self,prefix,params):
  152. self._topics[params[1][1:]]=params[2]
  153. def irc_333(self,prefix,params):
  154. group=params[1][1:]
  155. self.getGroupConversation(group).setTopic(self._topics[group],params[2])
  156. del self._topics[group]
  157. def irc_TOPIC(self,prefix,params):
  158. nickname = prefix.split("!")[0]
  159. group = params[0][1:]
  160. topic = params[1]
  161. self.getGroupConversation(group).setTopic(topic,nickname)
  162. def irc_JOIN(self,prefix,params):
  163. nickname = prefix.split("!")[0]
  164. group = params[0][1:].lower()
  165. if nickname!=self.nickname:
  166. try:
  167. self._ingroups[nickname].append(group)
  168. except:
  169. self._ingroups[nickname]=[group]
  170. self.getGroupConversation(group).memberJoined(nickname)
  171. def irc_PART(self,prefix,params):
  172. nickname = prefix.split("!")[0]
  173. group = params[0][1:].lower()
  174. if nickname!=self.nickname:
  175. if group in self._ingroups[nickname]:
  176. self._ingroups[nickname].remove(group)
  177. self.getGroupConversation(group).memberLeft(nickname)
  178. def irc_QUIT(self,prefix,params):
  179. nickname = prefix.split("!")[0]
  180. if nickname in self._ingroups:
  181. for group in self._ingroups[nickname]:
  182. self.getGroupConversation(group).memberLeft(nickname)
  183. self._ingroups[nickname]=[]
  184. def irc_NICK(self, prefix, params):
  185. fromNick = prefix.split("!")[0]
  186. toNick = params[0]
  187. if fromNick not in self._ingroups:
  188. return
  189. for group in self._ingroups[fromNick]:
  190. self.getGroupConversation(group).memberChangedNick(fromNick, toNick)
  191. self._ingroups[toNick] = self._ingroups[fromNick]
  192. del self._ingroups[fromNick]
  193. def irc_unknown(self, prefix, command, params):
  194. pass
  195. # GTKIM calls
  196. def joinGroup(self,name):
  197. self.join(name)
  198. self.getGroupConversation(name)
  199. @implementer(interfaces.IAccount)
  200. class IRCAccount(basesupport.AbstractAccount):
  201. gatewayType = "IRC"
  202. _groupFactory = IRCGroup
  203. _personFactory = IRCPerson
  204. def __init__(self, accountName, autoLogin, username, password, host, port,
  205. channels=''):
  206. basesupport.AbstractAccount.__init__(self, accountName, autoLogin,
  207. username, password, host, port)
  208. self.channels = [channel.strip() for channel in channels.split(',')]
  209. if self.channels == ['']:
  210. self.channels = []
  211. def _startLogOn(self, chatui):
  212. logonDeferred = defer.Deferred()
  213. cc = protocol.ClientCreator(reactor, IRCProto, self, chatui,
  214. logonDeferred)
  215. d = cc.connectTCP(self.host, self.port)
  216. d.addErrback(logonDeferred.errback)
  217. return logonDeferred