"autofocus": ("on", "Focus the clone_scanner buffer in the current window if it isn't already displayed by a window."),

"compare_idents": ("off", "Match against ident@host.name instead of just the hostname. Useful if you don't want different people from bouncers marked as clones"),

"display_join_messages": ("off", "Display all joins in the clone_scanner buffer"),

"display_onjoin_alert_clone_buffer": ("on", "Display an on-join clone alert in the clone_scanner buffer"),

"display_onjoin_alert_target_buffer": ("on", "Display an on-join clone alert in the buffer where the clone was detected"),

"display_onjoin_alert_current_buffer": ("off", "Display an on-join clone alert in the current buffer"),

"display_scan_report_clone_buffer": ("on", "Display manual scan reports in the clone buffer"),

"display_scan_report_target_buffer": ("off", "Display manual scan reports in the buffer of the scanned channel"),

"display_scan_report_current_buffer": ("on", "Display manual scan reports in the current buffer"),

"clone_report_key": ("mask", "Which 'key' to display in the clone report: 'mask' for full hostmasks, or 'nick' for nicks"),

"clone_onjoin_alert_key": ("mask", "Which 'key' to display in the on-join alerts: 'mask' for full hostmasks, or 'nick' for nicks"),

"colors.onjoin_alert.message": ("red", "The on-join clone alert's message colour. Formats are space separated."),

"colors.onjoin_alert.nick": ("bold red", "The on-join clone alert's nick colour. Formats are space separated. Note: if you have colorize_nicks, this option might not work as expected."),

"colors.onjoin_alert.channel": ("red", "The on-join clone alert's channel colour. Formats are space separated."),

"colors.onjoin_alert.matches": ("bold red", "The on-join clone alert's matches (masks or nicks) colour. Formats are space separated. Note: if you have colorize_nicks, this option might not work as expected."),

"colors.join_messages.message": ("chat", "The base colour for the join messages."),

"colors.join_messages.nick": ("bold", "The colour for the 'nick'-part of the join messages. Note: if you have colorize_nicks, this option might not always work as expected."),

"colors.join_messages.identhost": ("chat", "The colour for the 'ident@host'-part of the join messages."),

"colors.join_messages.channel": ("bold", "The colour for the 'channel'-part of the join messages."),

"colors.clone_report.header.message": ("chat", "The colour of the clone report header."),

"colors.clone_report.header.number_of_hosts": ("bold", "The colour of the number of hosts in the clone report header."),

"colors.clone_report.header.channel": ("bold", "The colour of the channel name in the clone report header."),

"colors.clone_report.subheader.message": ("chat", "The colour of the clone report subheader."),

"colors.clone_report.subheader.host": ("bold", "The colour of the host in the clone report subheader."),

"colors.clone_report.subheader.number_of_clones": ("bold", "The colour of the number of clones in the clone report subheader."),

"colors.clone_report.clone.message": ("chat", "The colour of the clone hit in the clone report message."),

"colors.clone_report.clone.match": ("chat", "The colour of the match details (masks or nicks) in the clone report."),

"colors.mask.nick": ("bold", "The formatting of the nick in the match mask."),

"colors.mask.identhost": ("", "The formatting of the identhost in the match mask."),

"hooks.explicit_servers": ("*", "Comma-separated, wildcard-supporting list of servers for which we should add hook to for monitoring clones. E.g. 'freenode,chat4all,esper*' or '*' (default)"),

"hooks.excluded_servers": ("bitlbee,twitchtv", "Which servers should the hook *not* be valid for? There's no support for wildcards unfortunately. E.g.: 'bitlbee,twitchtv' to exclude servers named bitlbee and twitchtv (default)."),

"lag_warning": ('on', 'Show temporary warning upon script load regarding the inefficiency of the script. Set to "off" to disable.')

key = OPTIONS[setting]

if key != 'mask' and key != 'nick':

weechat.prnt("", "Key %s not found. Valid settings are 'nick' and 'mask'. Reverted the setting to 'mask'" % key)

weechat.config_set_plugin("clone_report_key", "mask")

key = "mask"

if type(formats) == str:

formats = formats.split()

formatted_message = msg

needs_color_reset = False

for format in formats:

if format in ['bold', 'reverse', 'italic', 'underline']:

end_format = '-%s' % format

else:

needs_color_reset = True

end_format = ""

formatted_message = "%s%s%s" % (weechat.color(format), formatted_message, weechat.color(end_format))

if needs_color_reset:

formatted_message += weechat.color(reset_color)

network = signal.split(',')[0]

if network in OPTIONS['hooks.excluded_servers'].split(','):

return weechat.WEECHAT_RC_OK

joined_nick = weechat.info_get("irc_nick_from_host", signal_data)

join_match_data = re.match(r':[^!]+!([^@]+@(\S+)) JOIN :?([#&]\S*)', signal_data)

parsed_ident_host = join_match_data.group(1).lower()

parsed_host = join_match_data.group(2).lower()

if OPTIONS["compare_idents"] == "on":

hostkey = parsed_ident_host

else:

hostkey = parsed_host

chan_name = join_match_data.group(3)

network_chan_name = "%s.%s" % (network, chan_name)

chan_buffer = weechat.info_get("irc_buffer", "%s,%s" % (network, chan_name))

if not chan_buffer:

weechat.prnt("", "No IRC channel buffer found for %s" % network_chan_name)

return weechat.WEECHAT_RC_OK

if OPTIONS["display_join_messages"] == "on":

message = "%s%s%s%s%s" % (

format_from_config(joined_nick, "colors.join_messages.nick"),

format_from_config("!", "colors.join_messages.message"),

format_from_config(parsed_ident_host, "colors.join_messages.identhost"),

format_from_config(" JOINed ", "colors.join_messages.message"),

format_from_config(network_chan_name, "colors.join_messages.channel"),

)

#Make sure message format is also applied if no formatting is given for nick

message = format_from_config(message, "colors.join_messages.message")

weechat.prnt(cs_get_buffer(), message)

clones = get_clones_for_buffer("%s,%s" % (network, chan_name), hostkey)

if clones:

key = get_validated_key_from_config("clone_onjoin_alert_key")

filtered_clones = [clone for clone in clones[hostkey] if clone['nick'] != joined_nick]

match_strings = [format_from_config(m[key], "colors.onjoin_alert.matches") for m in filtered_clones]

join_string = format_from_config(' and ',"colors.onjoin_alert.message")

masks = join_string.join(match_strings)

message = "%s %s %s %s %s" % (

format_from_config(joined_nick, "colors.onjoin_alert.nick"),

format_from_config("is already on", "colors.onjoin_alert.message"),

format_from_config(network_chan_name, "colors.onjoin_alert.channel"),

format_from_config("as", "colors.onjoin_alert.message"),

masks

)

message = format_from_config(message, 'colors.onjoin_alert.message')

if OPTIONS["display_onjoin_alert_clone_buffer"] == "on":

weechat.prnt(cs_get_buffer(),message)

if OPTIONS["display_onjoin_alert_target_buffer"] == "on":

weechat.prnt(chan_buffer, message)

if OPTIONS["display_onjoin_alert_current_buffer"] == "on":

weechat.prnt(weechat.current_buffer(),message)

global cs_buffer

if not cs_buffer:

# Sets notify to 0 as this buffer does not need to be in hotlist.

cs_buffer = weechat.buffer_new("clone_scanner", "", \

"", SCRIPT_CLOSE_CB, "")

weechat.buffer_set(cs_buffer, "title", "Clone Scanner")

weechat.buffer_set(cs_buffer, "notify", "0")

weechat.buffer_set(cs_buffer, "nicklist", "0")

if OPTIONS["autofocus"] == "on":

if not weechat.window_search_with_buffer(cs_buffer):

weechat.command("", "/buffer " + weechat.buffer_get_string(cs_buffer,"name"))

""" A callback for buffer closing. """

global cs_buffer

#TODO: Ensure the clone_scanner buffer gets closed if its option is set and the script unloads

cs_buffer = None

server_name = weechat.buffer_get_string(buffer, "localvar_server")

channel_name = args

if not channel_name:

channel_name = weechat.buffer_get_string(buffer, "localvar_channel")

match_data = re.match(r'\A(irc.)?([^.]+)\.([#&]\S*)\Z', channel_name)

if match_data:

channel_name = match_data.group(3)

server_name = match_data.group(2)

matches = {}

infolist = weechat.infolist_get("irc_nick", "", infolist_buffer_name)

while(weechat.infolist_next(infolist)):

ident_hostname = weechat.infolist_string(infolist, "host")

host_matchdata = re.match(r'([^@]+)@(\S+)', ident_hostname)

if not host_matchdata:

continue

hostname = host_matchdata.group(2).lower()

ident = host_matchdata.group(1).lower()

if OPTIONS["compare_idents"] == "on":

hostkey = ident_hostname.lower()

else:

hostkey = hostname

if hostname_to_match and hostname_to_match.lower() != hostkey:

continue

nick = weechat.infolist_string(infolist, "name")

matches.setdefault(hostkey,[]).append({

'nick': nick,

'mask': "%s!%s" % (

format_from_config(nick, "colors.mask.nick"),

format_from_config(ident_hostname, "colors.mask.identhost")),

'ident': ident,

'ident_hostname': ident_hostname,

'hostname': hostname,

})

weechat.infolist_free(infolist)

#Select only the results that have more than 1 match for a host

# Default to clone_scanner buffer

if not target_buffer:

target_buffer = cs_get_buffer()

if clones:

clone_report_header = "%s %s %s%s" % (

format_from_config(len(clones), "colors.clone_report.header.number_of_hosts"),

format_from_config("hosts with clones were found on", "colors.clone_report.header.message"),

format_from_config(scanned_buffer_name, "colors.clone_report.header.channel"),

format_from_config(":", "colors.clone_report.header.message"),

)

clone_report_header = format_from_config(clone_report_header, "colors.clone_report.header.message")

weechat.prnt(target_buffer, clone_report_header)

for (host, clones) in clones.items():

host_message = "%s %s %s %s" % (

format_from_config(host, "colors.clone_report.subheader.host"),

format_from_config("is online from", "colors.clone_report.subheader.message"),

format_from_config(len(clones), "colors.clone_report.subheader.number_of_clones"),

format_from_config("nicks:", "colors.clone_report.subheader.message"),

)

host_message = format_from_config(host_message, "colors.clone_report.subheader.message")

weechat.prnt(target_buffer, host_message)

for user in clones:

key = get_validated_key_from_config("clone_report_key")

clone_message = "%s%s" % (" - ", format_from_config(user[key], "colors.clone_report.clone.match"))

clone_message = format_from_config(clone_message,"colors.clone_report.clone.message")

weechat.prnt(target_buffer, clone_message)

else:

if args[0:4] == 'scan':

server_name, channel_name = get_channel_from_buffer_args(buffer, args[5:])

clones = get_clones_for_buffer('%s,%s' % (server_name, channel_name))

if OPTIONS["display_scan_report_target_buffer"] == "on":

target_buffer = weechat.info_get("irc_buffer", "%s,%s" % (server_name, channel_name))

report_clones(clones, '%s.%s' % (server_name, channel_name), target_buffer)

if OPTIONS["display_scan_report_clone_buffer"] == "on":

report_clones(clones, '%s.%s' % (server_name, channel_name))

if OPTIONS["display_scan_report_current_buffer"] == "on":

report_clones(clones, '%s.%s' % (server_name, channel_name), weechat.current_buffer())

elif args[0:9] == 'advertise':

weechat.command("", "/input insert /me is using FiXato's CloneScanner v%s for WeeChat. Get the latest version from: https://github.com/FiXato/weechat_scripts/blob/master/clone_scanner.py or /script install clone_scanner.py" % SCRIPT_VERSION)

global OPTIONS

# Set default settings

for option,value in OPTIONS.items():

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)

global OPTIONS

config_option = name[len('plugins.var.python.' + SCRIPT_NAME + '.'):] # get optionname

OPTIONS[config_option] = value # save new value

if config_option in ('hooks.excluded_servers', 'hooks.explicit_servers'):

remove_hooks()

add_hooks()

weechat.config_set_plugin(config_option, value)

global hooks

hooked_servers = OPTIONS['hooks.explicit_servers'].split(',')

for server_name in hooked_servers:

signal = "%s,irc_in2_join" % server_name

# weechat.prnt('', "Adding hook on %s" % signal)

hook = weechat.hook_signal(signal, "on_join_scan_cb", "")

global hooks

for hook in hooks:

weechat.unhook(hook)