#!/usr/bin/env python # -*- coding: utf-8 -*- # Blackmore's Enhanced IRC-Notification Collection (BEINC) v1.0 # Copyright (C) 2013-2014 Simeon Simeonov # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU General Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU General Public License for more details. # You should have received a copy of the GNU General Public License # along with this program. If not, see . import datetime import httplib import json import os import random import socket import ssl import sys import urllib import urllib2 import weechat __author__ = 'Simeon Simeonov' __version__ = '1.0' __license__ = 'GPL3' enabled = True global_values = dict() # few constants # BEINC_POLICY_NONE = 0 BEINC_POLICY_ALL = 1 BEINC_POLICY_LIST_ONLY = 2 class ValidHTTPSConnection(httplib.HTTPConnection): """ Implements a simple CERT verification functionality """ default_port = httplib.HTTPS_PORT def __init__(self, *args, **kwargs): httplib.HTTPConnection.__init__(self, *args, **kwargs) def connect(self): sock = socket.create_connection((self.host, self.port), self.timeout, self.source_address) if self._tunnel_host: self.sock = sock self._tunnel() self.sock = ssl.wrap_socket(sock, ca_certs=global_beinc_cert_file, cert_reqs=ssl.CERT_REQUIRED) class ValidHTTPSHandler(urllib2.HTTPSHandler): """ Implements a simple CERT verification functionality """ def https_open(self, req): return self.do_open(ValidHTTPSConnection, req) class WeechatTarget(object): """ """ def __init__(self, target_dict): """ target_dict: the config-dictionary node that represents this instance """ self.__name = target_dict.get( 'name', ''.join([chr(random.randrange(97, 123)) for x in range(4)])) self.__url = target_dict.get('target_url') self.__password = target_dict.get('target_password') self.__pm_title_template = target_dict.get('pm_title_template', '%s @ %S') self.__pm_message_template = target_dict.get('pm_message_template', '%m') self.__cm_title_template = target_dict.get('cm_title_template', '%c @ %S') self.__cm_message_template = target_dict.get('cm_message_template', '%s -> %m') self.__nm_title_template = target_dict.get('nm_title_template', '%c @ %S') self.__nm_message_template = target_dict.get('nm_message_template', '%s -> %m') self.__chans = set(target_dict.get('channel_list', list())) self.__nicks = set(target_dict.get('nick_list', list())) self.__chan_messages_policy = int(target_dict.get( 'channel_messages_policy', BEINC_POLICY_LIST_ONLY)) self.__priv_messages_policy = int(target_dict.get( 'private_messages_policy', BEINC_POLICY_ALL)) self.__notifications_policy = int(target_dict.get( 'notifications_policy', BEINC_POLICY_ALL)) self.__cert_file = target_dict.get('target_cert_file') self.__timestamp_format = target_dict.get('target_timestamp_format', '%H:%M:%S') self.__debug = bool(target_dict.get('debug', False)) self.__enabled = bool(target_dict.get('enabled', True)) @property def name(self): """ """ return self.__name @property def chans(self): """ """ return self.__chans @property def nicks(self): """ """ return self.__nicks @property def channel_messages_policy(self): """ """ return self.__chan_messages_policy @property def private_messages_policy(self): """ """ return self.__priv_messages_policy @property def notifications_policy(self): """ """ return self.__notifications_policy @property def enabled(self): """ """ return self.__enabled @enabled.setter def enabled(self, value): """ """ self.__enabled = value def __repr__(self): """ """ return 'name: {0}\nurl: {1}\nchannel_list: {2}\nnick_list: {3}\n'\ 'channel_messages_policy: {4}\nprivate_messages_policy: {5}\n'\ 'notifications_policy: {6}\nenabled: {7}\n\n'.format( self.__name, self.__url, ', '.join(self.__chans), ', '.join(self.__nicks), self.__chan_messages_policy, self.__priv_messages_policy, self.__notifications_policy, 'yes' if self.__enabled else 'no') def send_private_message_notification(self, values): """ """ try: title_str = self.__fetch_formatted_str(self.__pm_title_template, values) message_str = self.__fetch_formatted_str( self.__pm_message_template, values) post_values = {'title': title_str, 'message': message_str, 'password': self.__password} data = urllib.urlencode(post_values) if self.__send_beinc_message(data) and self.__debug: beinc_prnt( 'BEINC DEBUG: send_private_message_notification-ERROR ' 'for "{0}": __send_beinc_message -> False'.format( self.__name)) except Exception as e: if self.__debug: beinc_prnt( 'BEINC DEBUG: send_private_message_notification-ERROR ' 'for "{0}": {1}'.format(self.__name, e)) def send_channel_message_notification(self, values): """ """ try: title_str = self.__fetch_formatted_str(self.__cm_title_template, values) message_str = self.__fetch_formatted_str( self.__cm_message_template, values) post_values = {'title': title_str, 'message': message_str, 'password': self.__password} data = urllib.urlencode(post_values) if self.__send_beinc_message(data) and self.__debug: beinc_prnt( 'BEINC DEBUG: send_channel_message_notification-ERROR ' 'for "{0}": __send_beinc_message -> False'.format( self.__name)) except Exception as e: if self.__debug: beinc_prnt( 'BEINC DEBUG: send_channel_message_notification-ERROR ' 'for "{0}": {1}'.format(self.__name, e)) def send_notify_message_notification(self, values): """ """ try: title_str = self.__fetch_formatted_str(self.__nm_title_template, values) message_str = self.__fetch_formatted_str( self.__nm_message_template, values) post_values = {'title': title_str, 'message': message_str, 'password': self.__password} data = urllib.urlencode(post_values) if self.__send_beinc_message(data) and self.__debug: beinc_prnt( 'BEINC DEBUG: send_notify_message_notification-ERROR ' 'for "{0}": __send_beinc_message -> False'.format( self.__name)) except Exception as e: if self.__debug: beinc_prnt( 'BEINC DEBUG: send_notify_message_notification-ERROR ' 'for "{0}": {1}'.format(self.__name, e)) def __fetch_formatted_str(self, template, values): """ """ timestamp = datetime.datetime.now().strftime(self.__timestamp_format) replacements = {'%S': values['server'], '%s': values['source_nick'], '%c': values['channel'], '%m': values['message'], '%t': timestamp, '%p': 'BEINC', '%n': values['own_nick']} for key, value in replacements.items(): template = template.replace(key, value) return template def __send_beinc_message(self, data): """ the function implements the BEINC "protocol" by generating a simple HTTP request """ try: req = urllib2.Request(self.__url, data) if self.__cert_file: opener = urllib2.build_opener(ValidHTTPSHandler) response = opener.open(req) else: response = urllib2.urlopen(req) res_code = response.code response.close() if res_code == 200: return True except urllib2.HTTPError as e: if self.__debug: beinc_prnt( 'BEINC DEBUG: send_beinc_message-ERROR for "{0}": {1} ->' ' ({2} - {3})'.format(self.__name, e.url, e.code, e.reason)) # all other exception should be handled by the caller return False def beinc_prnt(message_str): """ wrapper around weechat.prnt """ if global_values['use_current_buffer']: weechat.prnt(weechat.current_buffer(), message_str) else: weechat.prnt('', message_str) def beinc_cmd_target_handler(cmd_tokens): """ handles: '/beinc target' command actions """ if not cmd_tokens or cmd_tokens[0] not in ['list', 'enable', 'disable']: beinc_prnt('beinc target [ list | enable | disable ]') return weechat.WEECHAT_RC_OK if cmd_tokens[0] == 'list': beinc_prnt('--- Targets ---') for target in target_list: beinc_prnt(str(target)) beinc_prnt('---------------') elif cmd_tokens[0] == 'enable': if not cmd_tokens[1:]: beinc_prnt('missing a name-argument') return weechat.WEECHAT_RC_OK name = ' '.join(cmd_tokens[1:]) for target in target_list: if target.name == name: target.enabled = True beinc_prnt('target "{0}" enabled'.format(name)) break else: beinc_prnt('no matching target for "{0}"'.format(name)) elif cmd_tokens[0] == 'disable': if not cmd_tokens[1:]: beinc_prnt('missing a name-argument') return weechat.WEECHAT_RC_OK name = ' '.join(cmd_tokens[1:]) for target in target_list: if target.name == name: target.enabled = False beinc_prnt('target "{0}" disabled'.format(name)) break else: beinc_prnt('no matching target for "{0}"'.format(name)) return weechat.WEECHAT_RC_OK def beinc_command(data, buffer_obj, args): global enabled cmd_tokens = args.split() if not cmd_tokens: return weechat.WEECHAT_RC_OK if args == 'on': enabled = True beinc_prnt('BEINC on') elif args == 'off': enabled = False beinc_prnt('BEINC off') elif args == 'reload': beinc_prnt('Reloading BEINC...') beinc_init() elif cmd_tokens[0] == 'target': return beinc_cmd_target_handler(cmd_tokens[1:]) else: beinc_prnt('data: {0}, cmd_tokens: {1}, args: {2}'.format( str(data), str(cmd_tokens), str(args))) return weechat.WEECHAT_RC_OK def beinc_privmsg_handler(data, signal, signal_data): if not enabled: return weechat.WEECHAT_RC_OK prvmsg_dict = weechat.info_get_hashtable('irc_message_parse', {'message': signal_data}) # packing the privmsg handler values ph_values = dict() ph_values['server'] = signal.split(',')[0] ph_values['own_nick'] = weechat.info_get('irc_nick', ph_values['server']) ph_values['channel'] = prvmsg_dict['arguments'].split(':')[0].strip() ph_values['source_nick'] = prvmsg_dict['nick'] ph_values['message'] = ':'.join( prvmsg_dict['arguments'].split(':')[1:]).strip() if ph_values['channel'] == ph_values['own_nick']: # priv messages are handled here if not global_values['global_private_messages_policy']: return weechat.WEECHAT_RC_OK p_messages_policy = global_values['global_private_messages_policy'] if p_messages_policy == BEINC_POLICY_LIST_ONLY and '{0}.{1}'.format( ph_values['server'], ph_values['source_nick'].lower() ) not in global_values['global_nicks']: return weechat.WEECHAT_RC_OK for target in target_list: if not target.enabled: continue if target.private_messages_policy == BEINC_POLICY_ALL or ( target.private_messages_policy == BEINC_POLICY_LIST_ONLY and '{0}.{1}'.format( ph_values['server'], ph_values['source_nick'].lower()) in target.nicks ): target.send_private_message_notification(ph_values) elif ph_values['own_nick'].lower() in ph_values['message'].lower(): # notify messages are handled here if not global_values['global_notifications_policy']: return weechat.WEECHAT_RC_OK notifications_policy = global_values['global_notifications_policy'] if notifications_policy == BEINC_POLICY_LIST_ONLY and ( '{0}.{1}'.format( ph_values['server'], ph_values['channel'].lower() ) not in global_values['global_chans'] ): return weechat.WEECHAT_RC_OK for target in target_list: if not target.enabled: continue if target.notifications_policy == BEINC_POLICY_ALL or ( target.notifications_policy == BEINC_POLICY_LIST_ONLY and '{0}.{1}'.format( ph_values['server'], ph_values['channel'].lower()) in target.chans ): target.send_notify_message_notification(ph_values) elif global_values['global_channel_messages_policy']: # chan messages are handled here if not global_values['global_notifications_policy']: return weechat.WEECHAT_RC_OK c_messages_policy = global_values['global_channel_messages_policy'] if c_messages_policy == BEINC_POLICY_LIST_ONLY and ( '{0}.{1}'.format( ph_values['server'], ph_values['channel'].lower() ) not in global_values['global_chans'] ): return weechat.WEECHAT_RC_OK for target in target_list: if not target.enabled: continue if target.channel_messages_policy == BEINC_POLICY_ALL or ( target.channel_messages_policy == BEINC_POLICY_LIST_ONLY and '{0}.{1}'.format( ph_values['server'], ph_values['channel'].lower()) in target.chans ): target.send_channel_message_notification(ph_values) return weechat.WEECHAT_RC_OK def beinc_init(): global enabled global target_list global global_values # global chans/nicks sets are used to speed up the filtering global_values = dict() global_values['global_chans'] = set() global_values['global_nicks'] = set() target_list = list() custom_error = '' global_values['global_channel_messages_policy'] = False global_values['global_private_messages_policy'] = False global_values['global_notifications_policy'] = False global_values['use_current_buffer'] = False try: beinc_config_file_str = os.path.join( weechat.info_get('weechat_dir', ''), 'beinc.json') beinc_prnt('Parsing {0}...'.format(beinc_config_file_str)) custom_error = 'load error' with open(beinc_config_file_str, 'r') as fp: config_dict = json.load(fp) custom_error = 'target parse error' global_values['use_current_buffer'] = bool( config_dict['irc_client'].get( 'use_current_buffer', False)) for target in config_dict['irc_client']['targets']: try: new_target = WeechatTarget(target) except Exception as e: beinc_prnt('Unable to add target: {0}'.format(e)) continue global_values['global_chans'].update(new_target.chans) global_values['global_nicks'].update(new_target.nicks) if new_target.channel_messages_policy: global_values['global_channel_messages_policy'] = True if new_target.private_messages_policy: global_values['global_private_messages_policy'] = True if new_target.notifications_policy: global_values['global_notifications_policy'] = True target_list.append(new_target) beinc_prnt('BEINC target "{0}" added'.format(new_target.name)) beinc_prnt('Done!') except Exception as e: beinc_prnt('ERROR: unable to parse {0}: {1} - {2}'.format( beinc_config_file_str, custom_error, e)) enabled = False # do not return error / exit the script # in order to give a smoother opportunity to fix a 'broken' config return weechat.WEECHAT_RC_OK return weechat.WEECHAT_RC_OK weechat.register( 'beinc_weechat', 'Simeon Simeonov', '1.0', 'GPL3', 'Blackmore\'s Extended IRC Notification Collection (Weechat Client)', '', '') version = weechat.info_get('version_number', '') or 0 if int(version) < 0x00040000: weechat.prnt('', 'WeeChat version >= 0.4.0 is required to run beinc') else: weechat.hook_command('beinc', 'beinc on off toggle', '', 'description...', 'None', 'beinc_command', '') weechat.hook_signal('*,irc_in2_privmsg', 'beinc_privmsg_handler', '') beinc_init() weechat.prnt('', 'beinc initiated!')