/usr/share/weechat/python/keepnick.py

# -*- coding: utf-8 -*-
#
# Copyright (c) 2012-2017 by nils_2 <weechatter@arcor.de>
# Copyright (c) 2006 by EgS <i@egs.name>
#
# script to keep your nick and recover it in case it's occupied
#
# 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/>.
#
# 2017-10-19: nils_2 (freenode.#weechat)
#       1.6 : fix parsing error, now using weechat.info_get_hashtable() (reported by Mikaela)
#
# 2017-10-14: Kaijo & nils_2 (freenode.#weechat)
#       1.5 : fix empty string breaks output
#           : add evaluation for option "text" and use variable "$server" instead of "%s"
#
# 2017-09-06: nils_2 (freenode.#weechat)
#      1.4.2: fix missing weechat.config_string()
#
# 2017-08-17: nils_2 (freenode.#weechat)
#      1.4.1: fix eval_expression for nicks
#           : add evaluation for options
#
# 2017-08-17: nils_2 (freenode.#weechat)
#       1.4 : eval_expression for nicks
#           : use irc.server.<servername>.password
#           : add short /help
#
# 2016-05-12: picasso (freenode.#weechat)
#       1.3 : monitor quits and nick changes
#
# 2014-10-30: nils_2 (freenode.#weechat)
#       1.2 : support of regular expression for server option (idea by michele)
#
# 2013-09-17: nils_2 (freenode.#weechat)
#       1.1 : format of weechat_string_eval_expression() changed
#
# 2013-07-29: nils_2 (freenode.#weechat)
#       1.0 : support of /secure for passwords
#
# 2013-01-29: nils_2 (freenode.#weechat)
#       0.9 : script optimized
#
# 2013-01-27: nils_2 (freenode.#weechat)
#       0.8 : make script compatible with Python 3.x
#
# 2012-10-05: nils_2, (freenode.#weechat)
#       0.7 : add options "plugins.var.python.keepnick.nickserv", "plugins.var.python.keepnick.<server>.password"
#           : changed default "delay" value from 60 to 600 seconds.
#
# 2012-10-04: nils_2, (freenode.#weechat)
#       0.6 : fix bug with case-sensitive nicks (reported by Faethor)
#
# 2012-02-08: nils_2, (freenode.#weechat)
#       0.5 : sync with 0.3.x API (requested by CAHbI4)
#
# requires: WeeChat version 1.3
#
# Development is currently hosted at
# https://github.com/weechatter/weechat-scripts
#
#######################################################################
#                                                                     #
# This script enables the user to keep their nicks and recover it in  #
# case it get's stolen. It uses the servers prefered nicks, so there  #
# is no need for any kind of setup.                                   #
#                                                                     #
# Name:    Keepnick                                                   #
# Licence: GPL v2                                                     #
# Author:  Marcus Eggenberger <i@egs.name>                            #
#
#  Changelog:                                                         #
#   0.4: now starts on load and features user defined check intervals #
#   0.3: Fixed major bug with continuous nickchanges                  #
#   0.2: Fixed Bug: now only checks connected servers                 #
#   0.1: first version released                                       #
#                                                                     #
#######################################################################

try:
    from string import Template
    import weechat,sys,re


except Exception:
    print("This script must be run under WeeChat.")
    print("Get WeeChat now at: http://www.weechat.org/")
    quit()

# -------------------------------[ Constants ]-------------------------------------
SCRIPT_NAME     = "keepnick"
SCRIPT_AUTHOR   = "nils_2 <weechatter@arcor.de>"
SCRIPT_VERSION  = "1.6"
SCRIPT_LICENCE  = "GPL3"
SCRIPT_DESC     = "keep your nick and recover it in case it's occupied"

ISON            = '/ison %s'

OPTIONS         =       { 'delay'       : ('600','delay (in seconds) to look at occupied nick (0 means OFF). It is not recommended to flood the server with /ison requests)'),
                          'timeout'     : ('60','timeout (in seconds) to wait for an answer from server.'),
                          'serverlist'  : ('','comma separated list of servers to look at. Try to register a nickname on server (see: /msg NickServ help).regular expression are allowed (eg. ".*" = matches ALL server,"freen.*" = matches freenode, freenet....) (this option is evaluated).'),
                          'text'        : ('Nickstealer left Network: $server!','text to display, when you get your nick back. (\"$server and $nick\" can be used) (this option is evaluated).'),
                          'nickserv'    : ('/msg -server $server NICKSERV IDENTIFY $passwd','Use SASL authentification, if possible. This command will be used to IDENTIFY you on server (following placeholder can be used: \"$server\" for servername; \"$passwd\" for password). You can create an option for every server to store password: \"plugins.var.python.%s.<servername>.password\", otherwise the \"irc.server.<servername>.password\" option will be used (this option is evaluated).' % SCRIPT_NAME),
                          'command'     : ('/nick %s','This command will be used to rename your nick (\"%s\" will be replaced with your nickname)'),
                          'debug'       : ('off', 'When enabled, will output verbose debugging information during script operation'),
                        }
HOOK            =       { 'timer': '', 'redirect': '', 'quit': '', 'nick': '' }


# ================================[ redirection ]===============================
# calling /ison all x seconds using hook:timer()
def ison(servername,nick,nicklist):
    command = ISON % ' '.join(nicklist)
    debug_print("Checking nicks on server %s with command: %s" % (servername, command) )
    weechat.hook_hsignal_send('irc_redirect_command',
                                  { 'server': servername, 'pattern': 'ison', 'signal': SCRIPT_NAME, 'count': '1', 'string': servername, 'timeout': OPTIONS['timeout'], 'cmd_filter': '' })
    weechat.hook_signal_send('irc_input_send', weechat.WEECHAT_HOOK_SIGNAL_STRING, '%s;;;;%s' % (servername,command))

def redirect_isonhandler(data, signal, hashtable):
    debug_print("ISON response: %s" % hashtable['output'])
    if hashtable['output'] == '':
        return weechat.WEECHAT_RC_OK

    parsed = weechat.info_get_hashtable( "irc_message_parse",dict(message=hashtable['output']) )
    # variable ISON_nicks contains online nicks on server (separated with space)
    # nicks in variable ISON_nicks are lowercase and 'text' contains the nick
    ISON_nicks = [ nick.lower() for nick in parsed['text'].split() ]

    for nick in server_nicks(hashtable['server']):
        mynick = weechat.info_get('irc_nick',hashtable['server'])           # current nick on server

        if nick.lower() == mynick.lower():
            debug_print("I already have nick %s; not changing" % mynick)
            return weechat.WEECHAT_RC_OK
        elif nick.lower() not in ISON_nicks and nick != '':
            grabnick_and_auth(hashtable['server'], nick)
            return weechat.WEECHAT_RC_OK
    return weechat.WEECHAT_RC_OK

# ================================[ functions ]===============================
# nicks used on server
def server_nicks(servername):
    infolist = weechat.infolist_get('irc_server','',servername)
    weechat.infolist_next(infolist)
    nicks = string_eval_expression( weechat.infolist_string(infolist, 'nicks') )    # nicks in config
    weechat.infolist_free(infolist)
    return nicks.split(',')

def server_enabled(servername):
    serverlist = string_eval_expression( OPTIONS['serverlist'] ).split(',')

    server_matched = re.search(r"\b({})\b".format("|".join(serverlist)),servername)

    if servername in serverlist or server_matched:
        return True
    else:
        return False

def check_nicks(data, remaining_calls):
    infolist = weechat.infolist_get('irc_server','','')

    while weechat.infolist_next(infolist):
        servername = weechat.infolist_string(infolist, 'name')
        ptr_buffer = weechat.infolist_pointer(infolist,'buffer')
        nick = weechat.infolist_string(infolist, 'nick')
        ssl_connected = weechat.infolist_integer(infolist,'ssl_connected')
        is_connected = weechat.infolist_integer(infolist,'is_connected')

        if server_enabled(servername):
            if nick and ssl_connected + is_connected:
                ison(servername,nick,server_nicks(servername))
    weechat.infolist_free(infolist)
    return weechat.WEECHAT_RC_OK

def check_quit(data, signal, signal_data):
    servername = signal.split(',')[0]
    hostmask = signal_data.split(':')[1].split(' ')[0]
    nick = hostmask.split('!')[0]
    nicks = server_nicks(servername)
    if server_enabled(servername) and nick in nicks:
        debug_print("Saw %s quit on %s; checking nick" % (nick, servername))
        ison(servername, nick, nicks)
    return weechat.WEECHAT_RC_OK

def check_nick_change(data, signal, signal_data):
    servername = signal.split(',')[0]
    hostmask = signal_data.split(':')[1].split(' ')[0]
    nick = hostmask.split('!')[0]
    nicks = server_nicks(servername)

    if server_enabled(servername) and nick in nicks:
        my_nick = my_nick_on_server(servername)
        if my_nick.lower() != nick.lower():
            debug_print("Saw %s change nick on %s; checking nick" %
                        (nick, servername))
            ison(servername, nick, nicks)
        else:
            debug_print("Saw my own nick change on server (%s); ignoring"
                        % nick)
    return weechat.WEECHAT_RC_OK

def my_nick_on_server(servername):
    nick = weechat.info_get("irc_nick", servername)
    return nick

def grabnick_and_auth(servername, nick):
    global OPTIONS

    password = string_eval_expression( weechat.config_get_plugin('%s.password' % servername) )
    if not password:
        password = string_eval_expression( weechat.config_string(weechat.config_get("irc.server.%s.password" % servername)) )

    grabnick(servername, nick)  # get your nick back

    if password != '' and OPTIONS['nickserv'] != '':
        # command stored in "keepnick.nickserv" option
        t = Template(string_eval_expression( OPTIONS['nickserv']) )
        run_msg = t.safe_substitute(server=servername, passwd=password)
        weechat.command('', run_msg)

def string_eval_expression(string):
    return weechat.string_eval_expression(string,{},{},{})

def grabnick(servername, nick):
    if nick and servername:
        if OPTIONS['text']:
            t = Template( string_eval_expression(OPTIONS['text']) )
            text = t.safe_substitute(server=servername, nick=nick)
            weechat.prnt(weechat.current_buffer(), text)
        weechat.command(weechat.buffer_search('irc','%s.%s' % ('server',servername)), OPTIONS['command'] % nick)

# ================================[ weechat hook ]===============================
def install_hooks():
    global HOOK,OPTIONS

    # Should never happen
    if any([HOOK[k] != '' for k in HOOK]):
        return

    if not OPTIONS['delay'] or not OPTIONS['timeout']:
        return

    debug_print("Installing timer with delay %s seconds" % OPTIONS['delay'])
    HOOK['timer'] = weechat.hook_timer(int(OPTIONS['delay']) * 1000, 0, 0, 'check_nicks', '')
    HOOK['redirect'] = weechat.hook_hsignal('irc_redirection_%s_ison' % SCRIPT_NAME, 'redirect_isonhandler', '' )
    HOOK['quit'] = weechat.hook_signal('*,irc_raw_in_quit', 'check_quit', '')
    HOOK['nick'] = weechat.hook_signal('*,irc_raw_in_nick', 'check_nick_change', '')

    for k in HOOK:
        if HOOK[k] == 0:
            weechat.prnt('', "%s: can't enable %s, hook_timer() failed" %
                         (weechat.prefix('error'), SCRIPT_NAME))

def remove_hooks():
    global HOOK

    for k in HOOK:
        if HOOK[k] != '':
            weechat.unhook(HOOK[k])
            HOOK[k] = ''

def debug_print(msg):
    global OPTIONS
    if OPTIONS['debug'] != 'off':
        weechat.prnt('', "%s DEBUG: %s" % (SCRIPT_NAME, msg))

# ================================[ weechat options and description ]===============================
def init_options():
    global HOOK,OPTIONS
    for option,value in list(OPTIONS.items()):
        weechat.config_set_desc_plugin(option, '%s (default: "%s")' % (value[1], value[0]))
        if not weechat.config_is_set_plugin(option):
            weechat.config_set_plugin(option, value[0])
            OPTIONS[option] = value[0]
        else:
            OPTIONS[option] = weechat.config_get_plugin(option)

def toggle_refresh(pointer, name, value):
    global HOOK,OPTIONS
    option = name[len('plugins.var.python.' + SCRIPT_NAME + '.'):]              # get optionname
    OPTIONS[option] = value                                                     # save new value

    if option == 'delay' or option == 'timeout':
        if int(OPTIONS['delay']) > 0 or int(OPTIONS['timeout']) > 0:
            remove_hooks()
            install_hooks()
        else:
            remove_hooks()                                                  # user switched timer off
    return weechat.WEECHAT_RC_OK

def print_usage(data, buffer, args):
    weechat.prnt(buffer, "%s\t%s: script already running..." % ( string_eval_expression(weechat.config_string(weechat.config_get("weechat.look.prefix_error"))), SCRIPT_NAME) )
    return weechat.WEECHAT_RC_OK

# ================================[ main ]===============================
if __name__ == '__main__':
    if weechat.register(SCRIPT_NAME, SCRIPT_AUTHOR, SCRIPT_VERSION, SCRIPT_LICENCE, SCRIPT_DESC, '',''):
        weechat.hook_command(SCRIPT_NAME,SCRIPT_DESC,
                        '',
                        'You have to edit options with: /set *keepnick*\n'
                        'I suggest using /iset script or /fset plugin.\n',
                        '',
                        'print_usage',
                        '')

        version = weechat.info_get("version_number", "") or 0
        if int(version) >= 0x01030000:
            if int(OPTIONS['delay'][0]) > 0 and int(OPTIONS['timeout'][0]) > 0:
                init_options()
                install_hooks()
                weechat.hook_config( 'plugins.var.python.' + SCRIPT_NAME + '.*', 'toggle_refresh', '' )
        else:
            weechat.prnt('','%s%s %s' % (weechat.prefix('error'),SCRIPT_NAME,': needs version 1.3 or higher'))
            weechat.command('','/wait 1ms /python unload %s' % SCRIPT_NAME)
weechat-scripts 20180330-1 / usr / share / weechat / python / keepnick.py
