• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Copyright (c) 2010 Google Inc. All rights reserved.
2#
3# Redistribution and use in source and binary forms, with or without
4# modification, are permitted provided that the following conditions are
5# met:
6#
7#     * Redistributions of source code must retain the above copyright
8# notice, this list of conditions and the following disclaimer.
9#     * Redistributions in binary form must reproduce the above
10# copyright notice, this list of conditions and the following disclaimer
11# in the documentation and/or other materials provided with the
12# distribution.
13#     * Neither the name of Google Inc. nor the names of its
14# contributors may be used to endorse or promote products derived from
15# this software without specific prior written permission.
16#
17# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
29from webkitpy.common.config import irc as config_irc
30
31from webkitpy.common.thread.messagepump import MessagePump, MessagePumpDelegate
32from webkitpy.thirdparty.autoinstalled.irc import ircbot
33from webkitpy.thirdparty.autoinstalled.irc import irclib
34
35
36class IRCBotDelegate(object):
37    def irc_message_received(self, nick, message):
38        raise NotImplementedError, "subclasses must implement"
39
40    def irc_nickname(self):
41        raise NotImplementedError, "subclasses must implement"
42
43    def irc_password(self):
44        raise NotImplementedError, "subclasses must implement"
45
46
47class IRCBot(ircbot.SingleServerIRCBot, MessagePumpDelegate):
48    # FIXME: We should get this information from a config file.
49    def __init__(self,
50                 message_queue,
51                 delegate):
52        self._message_queue = message_queue
53        self._delegate = delegate
54        ircbot.SingleServerIRCBot.__init__(
55            self,
56            [(
57                config_irc.server,
58                config_irc.port,
59                self._delegate.irc_password()
60            )],
61            self._delegate.irc_nickname(),
62            self._delegate.irc_nickname())
63        self._channel = config_irc.channel
64
65    # ircbot.SingleServerIRCBot methods
66
67    def on_nicknameinuse(self, connection, event):
68        connection.nick(connection.get_nickname() + "_")
69
70    def on_welcome(self, connection, event):
71        connection.join(self._channel)
72        self._message_pump = MessagePump(self, self._message_queue)
73
74    def on_pubmsg(self, connection, event):
75        nick = irclib.nm_to_n(event.source())
76        request = event.arguments()[0].split(":", 1)
77        if len(request) > 1 and irclib.irc_lower(request[0]) == irclib.irc_lower(self.connection.get_nickname()):
78            response = self._delegate.irc_message_received(nick, request[1])
79            if response:
80                connection.privmsg(self._channel, response)
81
82    # MessagePumpDelegate methods
83
84    def schedule(self, interval, callback):
85        self.connection.execute_delayed(interval, callback)
86
87    def message_available(self, message):
88        self.connection.privmsg(self._channel, message)
89
90    def final_message_delivered(self):
91        self.die()
92