# Copyright 2010-2015 Josh Kearney # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at # # http://www.apache.org/licenses/LICENSE-2.0 # # Unless required by applicable law or agreed to in writing, software # distributed under the License is distributed on an "AS IS" BASIS, # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. # See the License for the specific language governing permissions and # limitations under the License. """IRC Client Class""" import random import ssl import time import irc.client as irclib from irc import connection from pyhole.core import logger from pyhole.core import plugin from pyhole.core import queue from pyhole.core import utils from pyhole.core import version from pyhole.core.irc import message class Client(irclib.SimpleIRCClient): """An IRClib connection.""" def __init__(self, network): irclib.SimpleIRCClient.__init__(self) logger.setup_logger(str(network)) pyhole_config = utils.get_config() network_config = utils.get_config(network) self.log = logger.get_logger(str(network)) self.version = version.version_string() self.source = None self.target = None self.addressed = False self.admins = pyhole_config.get("admins", type="list") self.command_prefix = pyhole_config.get("command_prefix") self.reconnect_delay = pyhole_config.get("reconnect_delay", type="int") self.rejoin_delay = pyhole_config.get("rejoin_delay", type="int") self.server = network_config.get("server") self.password = network_config.get("password", default=None) self.port = network_config.get("port", type="int", default=6667) self.ssl = network_config.get("ssl", type="bool", default=False) self.ipv6 = network_config.get("ipv6", type="bool", default=False) self.bind_to = network_config.get("bind_to", default=None) self.nick = network_config.get("nick") self.username = network_config.get("username", default=None) self.identify_password = network_config.get("identify_password", default=None) self.channels = network_config.get("channels", type="list") self.load_plugins() self.log.info("Connecting to %s:%d as %s" % (self.server, self.port, self.nick)) self.connect(self.server, self.port, self.nick, self.password, username=self.username, connect_factory=connection.Factory( wrapper=ssl.wrap_socket, ipv6=self.ipv6).connect if self.ssl else connection.Factory()) def load_plugins(self, reload_plugins=False): """Load plugins and their commands respectively.""" if reload_plugins: plugin.reload_plugins(session=self) else: plugin.load_plugins(session=self) self.log.info("Loaded Plugins: %s" % plugin.active_plugins()) plugin.run_hook_polls(self) def notice(self, target, msg): """Send a notice.""" self.connection.notice(target, msg) def reply(self, target, msg): """Reply to a target.""" self.connection.privmsg(target, msg) def op_user(self, params): """Op a user.""" params = params.split(" ", 1) self.connection.mode(params[0], "+o %s" % params[1]) def deop_user(self, params): """De-op a user.""" params = params.split(" ", 1) self.connection.mode(params[0], "-o %s" % params[1]) def set_nick(self, params): """Set IRC nick.""" self.nick = params self.connection.nick(params) def join_channel(self, params): """Join a channel.""" channel = params.split(" ", 1) self.log.info("Joining %s" % channel[0]) if irclib.is_channel(channel[0]): self.channels.append(channel[0]) if len(channel) > 1: self.connection.join(channel[0], channel[1]) else: self.connection.join(channel[0]) def part_channel(self, params): """Part a channel.""" self.channels.remove(params) self.log.info("Parting %s" % params) self.connection.part(params) def on_nicknameinuse(self, connection, _event): """Ensure the use of unique IRC nick.""" random_int = random.randint(1, 100) self.log.info("IRC nick '%s' is currently in use" % self.nick) self.nick = "%s%d" % (self.nick, random_int) self.log.info("Setting IRC nick to '%s'" % self.nick) connection.nick("%s" % self.nick) # Try to prevent nick flooding time.sleep(1) def on_welcome(self, connection, _event): """Join channels upon successful connection.""" if self.identify_password: self.reply("NickServ", "IDENTIFY %s" % self.identify_password) for channel in self.channels: channel = channel.split(" ", 1) if irclib.is_channel(channel[0]): if len(channel) > 1: connection.join(channel[0], channel[1]) else: connection.join(channel[0]) q = queue.MessageQueue() q.watch(self) def on_disconnect(self, _connection, _event): """Attempt to reconnect after disconnection.""" self.log.info("Disconnected from %s:%d." % (self.server, self.port)) self.log.info("Reconnecting in %d seconds." % self.reconnect_delay) time.sleep(self.reconnect_delay) self.log.info("Connecting to %s:%d as %s." % (self.server, self.port, self.nick)) self.connect(self.server, self.port, self.nick, self.password, username=self.username, connect_factory=connection.Factory( wrapper=ssl.wrap_socket, ipv6=self.ipv6).connect if self.ssl else connection.Factory()) def on_kick(self, connection, event): """Automatically rejoin channel if kicked.""" source = event.source.nick target = event.target nick, reason = event.arguments if nick == self.nick: self.log.info("-%s- kicked by %s: %s" % (target, source, reason)) self.log.info("-%s- rejoining in %d seconds" % (target, self.rejoin_delay)) time.sleep(self.rejoin_delay) connection.join(target) else: self.log.info("-%s- %s was kicked by %s: %s" % (target, nick, source, reason)) def on_invite(self, _connection, event): """Join a channel upon invitation.""" source = event.source.split("@", 1)[0] if source in self.admins: self.join_channel(event.arguments[0]) def on_ctcp(self, connection, event): """Respond to CTCP events.""" source = event.source.nick ctcp = event.arguments[0] if ctcp == "VERSION": self.log.info("Received CTCP VERSION from %s" % source) connection.ctcp_reply(source, "VERSION %s" % self.version) elif ctcp == "PING": if len(event.arguments) > 1: self.log.info("Received CTCP PING from %s" % source) connection.ctcp_reply(source, "PING %s" % event.arguments[1]) def on_join(self, _connection, event): """Handle joins.""" target = event.target source = event.source.nick self.log.info("-%s- %s joined" % (target, source)) def on_part(self, _connection, event): """Handle parts.""" target = event.target source = event.source.nick self.log.info("-%s- %s left" % (target, source)) def on_quit(self, _connection, event): """Handle quits.""" source = event.source.nick self.log.info("%s quit" % source) def on_action(self, _connection, event): """Handle IRC actions.""" target = event.target source = event.source.nick msg = event.arguments[0] self.log.info("-%s- * %s %s" % (target, source, msg)) def on_privnotice(self, _connection, event): """Handle private notices.""" if event.source is not None: source = event.source.nick else: source = None msg = event.arguments[0] self.log.info("-%s- %s" % (source, msg)) def on_pubnotice(self, _connection, event): """Handle public notices.""" target = event.target if event.source is not None: source = event.source.nick else: source = None msg = event.arguments[0] self.log.info("-%s- <%s> %s" % (target, source, msg)) def on_privmsg(self, _connection, event): """Handle private messages.""" msg = event.arguments[0] source = event.source.split("@", 1)[0] target = event.source.nick _msg = message.Reply(self, msg, source, target) if self.target != self.nick: self.log.info("<%s> %s" % (target, msg)) plugin.poll_messages(self, _msg, private=True) def on_pubmsg(self, _connection, event): """Handle public messages.""" nick = event.source.nick msg = event.arguments[0] source = event.source.split("@", 1)[0] target = event.target self.log.info("-%s- <%s> %s" % (target, nick, msg)) _msg = message.Reply(self, msg, source, target) plugin.poll_messages(self, _msg)