/usr/share/weechat/python/beinc.py is in weechat-scripts 20180330-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 | # -*- coding: utf-8 -*-
# Blackmore's Enhanced IRC-Notification Collection (BEINC) v1.1
# Copyright (C) 2013-2015 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 <http://www.gnu.org/licenses/>.
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.1'
__license__ = 'GPL3'
enabled = True
global_values = dict()
# few constants #
BEINC_POLICY_NONE = 0
BEINC_POLICY_ALL = 1
BEINC_POLICY_LIST_ONLY = 2
BEINC_CURRENT_CONFIG_VERSION = 1
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):
"""
The target (destination) class
Each remote destination is represented as a 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))
self.__socket_timeout = int(target_dict.get('socket_timeout', 3))
@property
def name(self):
"""
Target name (read-only property)
"""
return self.__name
@property
def chans(self):
"""
Target channel list (read-only property)
"""
return self.__chans
@property
def nicks(self):
"""
Target nick list (read-only property)
"""
return self.__nicks
@property
def channel_messages_policy(self):
"""
The target's channel messages policy (read-only property)
"""
return self.__chan_messages_policy
@property
def private_messages_policy(self):
"""
The target's private messages policy (read-only property)
"""
return self.__priv_messages_policy
@property
def notifications_policy(self):
"""
The target's notifications policy (read-only property)
"""
return self.__notifications_policy
@property
def enabled(self):
"""
The target's enabled status (bool property)
"""
return self.__enabled
@enabled.setter
def enabled(self, value):
"""
The target's enabled status (bool property)
"""
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}\ndebug: {8}\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',
'yes' if self.__debug else 'no')
def send_private_message_notification(self, values):
"""
sends a private message notification to the represented target
values: dict pupulated by the irc msg-handler
"""
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 not 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):
"""
sends a channel message notification to the represented target
values: dict pupulated by the irc msg-handler
"""
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 not 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):
"""
sends a notify message notification to the represented target
values: dict pupulated by the irc msg-handler
"""
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 not 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 send_broadcast_notification(self, message):
"""
sends a 'pure' broadcast / test message notification
to the represented target
message: a single message string
"""
try:
post_values = {'title': 'BEINC broadcast',
'message': message,
'password': self.__password}
data = urllib.urlencode(post_values)
if not self.__send_beinc_message(data) and self.__debug:
beinc_prnt(
'BEINC DEBUG: send_broadcast_notification-ERROR '
'for "{0}": __send_beinc_message -> False'.format(
self.__name))
except Exception as e:
if self.__debug:
beinc_prnt(
'BEINC DEBUG: send_broadcast_notification-ERROR '
'for "{0}": {1}'.format(self.__name, e))
def __fetch_formatted_str(self, template, values):
"""
returns a formatted string by replacing the defined
macros in 'template' the the corresponding values from 'values'
values: dict
template: str
"""
template = unicode(template)
timestamp = datetime.datetime.now().strftime(self.__timestamp_format)
replacements = {u'%S': values['server'].decode('utf-8'),
u'%s': values['source_nick'].decode('utf-8'),
u'%c': values['channel'].decode('utf-8'),
u'%m': values['message'].decode('utf-8'),
u'%t': timestamp.decode('utf-8'),
u'%p': u'BEINC',
u'%n': values['own_nick'].decode('utf-8')}
for key, value in replacements.items():
template = template.replace(key, value)
return template.encode('utf-8')
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:
global global_beinc_cert_file
global_beinc_cert_file = self.__cert_file
opener = urllib2.build_opener(ValidHTTPSHandler)
response = opener.open(req, timeout=self.__socket_timeout)
else:
response = urllib2.urlopen(req, self.__socket_timeout)
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_broadcast_handler(cmd_tokens):
"""
handles: '/beinc broadcast' command actions
"""
if not cmd_tokens:
beinc_prnt('beinc broadcast <message>')
return weechat.WEECHAT_RC_OK
for target in target_list:
if target.enabled:
target.send_broadcast_notification(' '.join(cmd_tokens))
return weechat.WEECHAT_RC_OK
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 <name> | disable <name> ]')
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):
"""
Callback function handling the Weechat's /beinc command
"""
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] in ('broadcast', 'test'):
return beinc_cmd_broadcast_handler(cmd_tokens[1:])
elif cmd_tokens[0] == 'target':
return beinc_cmd_target_handler(cmd_tokens[1:])
else:
beinc_prnt('syntax: /beinc < on | off | reload |'
' broadcast <text> | target <action> >')
return weechat.WEECHAT_RC_OK
def beinc_privmsg_handler(data, signal, signal_data):
"""
Callback function the *PRIVMSG* IRC messages hooked by Weechat
"""
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
p_messages_policy = target.private_messages_policy
if p_messages_policy == BEINC_POLICY_ALL or (
p_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
c_messages_policy = target.channel_messages_policy
if c_messages_policy == BEINC_POLICY_ALL or (
c_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():
"""
Ran every time the script is (re)loaded
It loads the config (.json) file and (re)loads its contents into memory
beinc_init() will disable all notifications on failure
"""
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_weechat.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, encoding='utf-8')
custom_error = 'target parse error'
global_values['use_current_buffer'] = bool(
config_dict['irc_client'].get(
'use_current_buffer', False))
if config_dict.get('config_version',
0) != BEINC_CURRENT_CONFIG_VERSION:
beinc_prnt('WARNING: The version of the config-file: {0} ({1}) '
'does not correspond to the latest version supported '
'by this program ({2})\nCheck beinc_config_sample.json '
'for the newest features!'.format(
beinc_config_file_str,
config_dict.get('config_version', 0),
BEINC_CURRENT_CONFIG_VERSION))
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}\n'
'BEINC is now disabled'.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.1',
'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', '<on | off | reload>',
'description...',
'None',
'beinc_command',
'')
weechat.hook_signal('*,irc_in2_privmsg', 'beinc_privmsg_handler', '')
beinc_init()
weechat.prnt('', 'beinc initiated!')
|