From 3403569ac2eceb1d82b6ce38bb354612381db806 Mon Sep 17 00:00:00 2001 From: Chris Harding Date: Tue, 15 Aug 2017 23:32:31 +0000 Subject: [PATCH] Remove IRC agent, moved to halibot-extra/irc --- packages/irc/__init__.py | 2 - packages/irc/config.json | 3 - packages/irc/irc.py | 151 --------------------------------------- 3 files changed, 156 deletions(-) delete mode 100644 packages/irc/__init__.py delete mode 100644 packages/irc/config.json delete mode 100644 packages/irc/irc.py diff --git a/packages/irc/__init__.py b/packages/irc/__init__.py deleted file mode 100644 index ec292be..0000000 --- a/packages/irc/__init__.py +++ /dev/null @@ -1,2 +0,0 @@ -from .irc import IrcAgent -Default = IrcAgent diff --git a/packages/irc/config.json b/packages/irc/config.json deleted file mode 100644 index 5891b34..0000000 --- a/packages/irc/config.json +++ /dev/null @@ -1,3 +0,0 @@ -{ - "main": "irc.py:IrcAgent" -} diff --git a/packages/irc/irc.py b/packages/irc/irc.py deleted file mode 100644 index 7495caf..0000000 --- a/packages/irc/irc.py +++ /dev/null @@ -1,151 +0,0 @@ -# -# Reference Halibot IRC Agent -# Connects to an IRC server and relays messages to and from the base -# -from halibot import HalAgent, HalConfigurer, Context, Message -from collections import OrderedDict -import pydle, threading - -# Haliot Reference IRC Agent -# Creates a Pydle IRC Client and connects to a server -# Receives messages from the server, relays them to the Halibot base -# Receives messages from the Halibot base, relays them to the IRC server -class IrcAgent(HalAgent): - - class Configurer(HalConfigurer): - def configure(self): - self.optionString('nickname', prompt='Nickname', default='halibot') - self.optionString('hostname', prompt='Server hostname', default='irc.freenode.net') - self.optionInt('port', prompt='Server port', default=6697) - self.optionString('channel', prompt='Channel to join') - - self.optionBoolean('tls', prompt='Enable TLS', default=True) - if self.options['tls']: - self.optionBoolean('tls-verify', prompt='Verify server TLS certificate', default=False) - if self.options['tls-verify']: - self.optionString('tls-certificate-file', prompt='TLS certificate file') - self.optionString('tls-certificate-keyfile', prompt='TLS certificate keyfile') - self.optionString('tls-certificate-file', prompt='TLS certificate password') - - self.optionString('sasl-username', prompt='SASL username') - if 'sasl-username' in self.options: - self.optionString('sasl-password', prompt='SASL password') - self.optionString('sasl-identity', prompt='SASL identity') - - # Handle to the Pydle IRC Client object as defined below - client = None - - # Called when the IrcAgent is instantiated. - # Anything needed to get the agent running should go in here, - # NOT in __init__()! - def init(self): - # Create the IRC client object as defined/extended below - self.client = IrcClient( - nickname = self.config['nickname'], - tls_certificate_file = self.config.get('tls-certificate-file'), - tls_certificate_keyfile = self.config.get('tls-certificate-keyfile'), - tls_certificate_password = self.config.get('tls-certificate-file'), - sasl_username = self.config.get('sasl-username'), - sasl_password = self.config.get('sasl-password'), - sasl_identity = self.config.get('sasl-identity'), - ) - - # Give the client object a handle to talk back to this agent class - self.client.agent = self - - self.client.connect( - hostname = self.config['hostname'], - port = self.config['port'], - tls = self.config.get('tls', True), - tls_verify = self.config.get('tls-verify', False), - ) - - self._start_client() - - # Implement the receive() function as defined in the HalModule class - # This is called when the Halibot wants to send a message out using this agent. - # In this case, the logic for sending a message to the IRC channel is put here, - # using the whom as the "channel", which is the tail end of the resource - # identifier for this target (e.g. the "#foo" in "irc/#foo"). - def receive(self, msg): - self.client.message(msg.whom(), msg.body) - - - def shutdown(self): - self.client.disconnect() - self.client.eventloop.stop() - self.thread.join() - - # Start the thread the IRC client will live in - # This is so the client does not block on halibot's instantiation (main) thread, - # thus causing to stop there and never finish starting up - def _start_client(self): - self.thread = threading.Thread(target=self.client.handle_forever) - self.thread.start() - - # NOTE: The Module() base class implements a send() function, do NOT override this. - # The function is used to send to the Halibot base for module processing. - # Simply implementing the receive() function is enough to get messages from the modules, - # to get messages from your agent targer (IRC, XMPP, etc), that is up to the developer. - - - -# Pydle IRC Client class. -# This will handle all the IRC work, and talks to the base via the IRCAgent -# The following is for reference, some of which will be pydle-specific -class IrcClient(pydle.Client): - - # Handle to the IRC Agent above - agent = None - - # Cache of whois lookups - whois_cache = {} - - # Pydle calls this when the client connects to the server. - # Sets the channel(s) to join from the agent's config. - # NOTE: the config field is automatically populated from the relevant - # config files when the module is loaded - def on_connect(self): - super().on_connect() - - channel = self.agent.config['channel'] - if isinstance(channel, str): - # Is a string, join that channel - self.join(channel) - else: - # Persume a list of channels, join those - for c in channel: - self.join(c) - - def on_quit(self, channel, user): - # Invalidate the WHOIS cache entry - if user in self.whois_cache: self.whois_cache.pop(user) - - def on_nick_change(self, old, new): - # Invalidate the WHOIS cache entries - if old in self.whois_cache: self.whois_cache.pop(old) - if new in self.whois_cache: self.whois_cache.pop(new) - - @pydle.coroutine - def identity(self, nick): - # Do the WHOIS if the result is not cached - if not nick in self.whois_cache: - self.whois_cache[nick] = yield self.whois(nick) - - # If they are identified, return the account name - if self.whois_cache[nick]['identified']: - return self.whois_cache[nick]['account'] - - # Not identified - return None - - # Pydle calls this when a message is received from the server - # The purpose of this agent is to communicate with IRC, - # so this repackages the message from Pydle into a Halibot-friendly message - @pydle.coroutine - def on_channel_message(self, target, by, text): - org = self.agent.name + '/' + target - msg = Message(body=text, author=by, identity=self.identity(by), origin=org) - - # Send the Halibot-friendly message to the Halibot base for module processing - self.agent.dispatch(msg)