#
# Copyright (c) 2010-2011 by Nils Görs <weechatter@arcor.de>
#
# colors the channel text with nick color and also highlight the whole line
# colorize_nicks.py script will be supported
#
# 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/>.
#
# settings see help page
#
# history:
# 0.7: fixed: bug when irc.look.nick_suffix was set (reported and beta-testing by: hw2) (>= weechat 0.3.4)
# blacklist_channels option supports servername
# clean up code
# 0.6: code optimazations.
# rename of script (rainbow_text.pl -> colorize_lines.pl) (suggested by xt and flashcode)
# 0.5: support of hotlist_max_level_nicks_add and weechat.color.chat_nick_colors (>= weechat 0.3.4)
# 0.4: support of weechat.look.highlight_regex option (>= weechat 0.3.4)
# : support of weechat.look.highlight option
# : highlighted line did not work with "." inside servername
# ; internal "autoset" function fixed
# 0.3: support of colorize_nicks.py implemented.
# : /me text displayed wrong nick colour (colour from suffix was used)
# : highlight messages will be checked case insensitiv
# 0.2: supports highlight_words_add from buffer_autoset.py script (suggested: Emralegna)
# : correct look_nickmode colour will be used (bug reported by: Emralegna)
# : /me text will be coloured, too
# 0.1: initial release
#
# requirements: sunglasses ;-)
use strict;
my $prgname = "colorize_lines";
my $version = "0.7";
my $description = "colors text in chat area with according nick color. Highlight messages will be fully highlighted in chat area";
# default values
my %default_options = ( "var_highlight" => "on",
"var_chat" => "on",
"var_shuffle" => "off",
"var_buffer_autoset" => "off",
"var_look_highlight" => "off",
"var_look_highlight_regex" => "off",
"var_hotlist_max_level_nicks_add" => "off",
"zahl" => 0,
"default_version" => 0,
"prefix_action" => "",
"var_blacklist_channels" => "",
);
my @var_blacklist_channels = "";
my $nick_mode = "";
# standard colours.
my %colours = (0 => "darkgray", 1 => "red", 2 => "lightred", 3 => "green",
4 => "lightgreen", 5 => "brown", 6 => "yellow", 7 => "blue",
8 => "lightblue", 9 => "magenta", 10 => "lightmagenta", 11 => "cyan",
12 => "lightcyan", 13 => "white");
# program starts here
sub colorize_cb {
my ( $data, $modifier, $modifier_data, $string ) = @_;
if (index($modifier_data,"irc_privmsg") == -1){ # its neither a channel nor a query buffer
return $string;
}
if ($default_options{var_highlight} eq "off" and $default_options{var_chat} eq "off"){ # all options OFF
return $string;
}
$modifier_data =~ (m/irc;(.+?)\.(.+?)\;/); # irc;servername.channelname;
my ($t0, $t1 , $t2) = split(/;/,$modifier_data);
#$t1 =~ m/^(.+)\.(.+)$/;
my $servername = $1;
my $channel_name = $2;
if ( grep /^$servername.$channel_name$/, @var_blacklist_channels ) { # check for blacklist_channels
return $string;
}
my $my_nick = weechat::info_get( 'irc_nick', $servername ); # get nick with servername (;freenode.)
$string =~ m/^(.*)\t(.*)/; # get the nick name: nick[tab]string
my $nick = $1; # nick with nick_mode and color codes
my $line = $2; # get written text
$line = weechat::string_remove_color($line,""); # remove color-codes from line, first
$modifier_data =~ m/nick_(.*),/; # get the nick name from modifier_data (without nick_mode and color codes!)
$nick = $1;
# recreate irc.look.nick_suffix and irc.color.nick_suffix
my $nick_suffix_with_color = "";
my $nick_suffix = weechat::config_string( weechat::config_get("irc.look.nick_suffix"));
if ( $nick_suffix ne "" ){
my $nick_suffix_color = weechat::color( weechat::config_color( weechat::config_get( "irc.color.nick_suffix" )));
$nick_suffix_with_color = $nick_suffix_color . $nick_suffix;
}
# check for action (/me)
my $prefix_action_with_color = "";
if (index($modifier_data,"irc_action") >= 0){
my $prefix_action_color = weechat::color( weechat::config_color( weechat::config_get( "weechat.color.chat_prefix_action" )));
my $prefix_action = weechat::config_string( weechat::config_get("weechat.look.prefix_action"));
$prefix_action_with_color = $prefix_action_color . $prefix_action;
}
# check if look.nickmode is ON and no prefix and no query buffer
$nick_mode = "";
if ( weechat::config_boolean(weechat::config_get("weechat.look.nickmode")) == 1 and ($nick ne $default_options{prefix_action}) and (index($modifier_data,"notify_private")) == -1){
# if ($nick =~ m/^\@|^\%|^\+|^\~|^\*|^\&|^\!|^\-/) { # check for nick modes (@%+~*&!-) without colour
my $buf_pointer = weechat::buffer_search("irc",$servername . "." . $channel_name);
my $nick_pointer = weechat::nicklist_search_nick($buf_pointer,"",$nick);
$nick_mode = weechat::nicklist_nick_get_string($buf_pointer,$nick_pointer,"prefix");
my $color_mode = weechat::color( weechat::config_string( weechat::config_get( weechat::nicklist_nick_get_string($buf_pointer,$nick_pointer,"prefix_color") ) ) );
if ( $nick_mode eq " " or $color_mode eq ""){ # no nick_mode!
$nick_mode = "";
}else{ # nick_mode exists
$nick_mode = $color_mode . $nick_mode;
}
}
# i wrote the message
if ($nick eq $my_nick ){ # i wrote the message
if ($default_options{var_chat} eq "on"){
my $nick_color = weechat::config_color(weechat::config_get("weechat.color.chat_nick_self")); # get my nick color
$nick_color = weechat::color($nick_color);
$line = colorize_nicks($nick_color,$modifier_data,$line);
if (index($modifier_data,"irc_action") >= 0){
$nick = $prefix_action_with_color;
}else{
$nick = $nick . $nick_suffix_with_color;
}
$line = $nick_mode . $nick_color . $nick . "\t" . $nick_color . $line . weechat::color('reset');
return $line;
}else{
return $string;
}
}
# get nick color
$nick = weechat::string_remove_color($nick,""); # remove colour-codes from nick
my $nick_color = weechat::info_get('irc_nick_color', $nick); # get nick-colour
my $var_hl_max_level_nicks_add = 0;
# highlight message received?
if ($default_options{var_highlight} eq "on"){ # highlight_mode on?
if ( $default_options{var_buffer_autoset} eq "on" || $default_options{var_look_highlight} eq "on" ){# buffer_autoset or look_highlight "on"?
my $highlight_words = "";
# get strings from buffer_autoset and/or weechat.look.highlight and weechat.look.highlight_regex
if ($default_options{var_buffer_autoset} eq "on"){
my $highlight_words_add = weechat::config_string(weechat::config_get("buffer_autoset.buffer.irc.".$servername.".".$channel_name.".highlight_words_add"));
$highlight_words .= $highlight_words_add . ",";
}
if ($default_options{var_look_highlight} eq "on"){
my $look_highlight = weechat::config_string( weechat::config_get("weechat.look.highlight") );
$highlight_words .= $look_highlight;
}
if ( $default_options{var_hotlist_max_level_nicks_add} eq "on" and weechat::config_string(weechat::config_get("buffer_autoset.buffer.irc.".$servername.".".$channel_name.".hotlist_max_level_nicks_add")) =~ /$nick\:[0-2]/ ){
$var_hl_max_level_nicks_add = 1;
}
# kill "," at end of string
$/ = ",";
chomp($highlight_words);
foreach ( split( /,+/, $highlight_words ) ) { # check for highlight_words
if ($_ eq ""){next;} # ignore empty string
my $search_string = shell2regex($_);
if ($string =~ m/\b$search_string\b/gi){ # i (ignorecase)
my $color_highlight = weechat::config_color(weechat::config_get("weechat.color.chat_highlight"));
my $color_highlight_bg = weechat::config_color(weechat::config_get("weechat.color.chat_highlight_bg"));
my $high_color = weechat::color("$color_highlight,$color_highlight_bg");
if (index($modifier_data,"irc_action") >= 0){
$line = colorize_nicks($high_color,$modifier_data,$line);
$nick = $prefix_action_with_color;
$line = $high_color . $nick . "\t" . $high_color . $line . weechat::color('reset');
return $line;
}
$line = colorize_nicks($high_color,$modifier_data,$line);
$line = $nick_mode . $high_color . $nick . $nick_suffix_with_color . "\t" . $high_color . $line . weechat::color('reset');
return $line;
}
}
}
# buffer_autoset is off.
# TODO: Fix "all:" and "all," highlighting
if (lc($string) =~ m/(\w.*$my_nick.*)/){ # my name called in string (case insensitiv)?
my $color_highlight = weechat::config_color(weechat::config_get("weechat.color.chat_highlight"));
my $color_highlight_bg = weechat::config_color(weechat::config_get("weechat.color.chat_highlight_bg"));
my $high_color = weechat::color("$color_highlight,$color_highlight_bg");
if (index($modifier_data,"irc_action") >= 0){ # action used (/me)
$line = colorize_nicks($high_color,$modifier_data,$line);
$nick = $prefix_action_with_color;
$line = $high_color . $nick . "\t" . $high_color . $line . weechat::color('reset');
return $line;
}
# highlight whole line
if ( $var_hl_max_level_nicks_add eq 0 ){
$line = colorize_nicks($high_color,$modifier_data,$line);
$line = $nick_mode . $high_color . $nick . $nick_suffix_with_color . "\t" . $high_color . $line . weechat::color('reset');
return $line;
}
}
} # highlight area finished
# simple channel message
if ($default_options{var_chat} eq "on"){ # chat_mode on?
if ($default_options{var_shuffle} eq "on"){ # color_shuffle on?
my $zahl2 = 0;
my $my_color = weechat::config_color(weechat::config_get("weechat.color.chat_nick_self")); # get my own nick colour
for (1){ # get a random colour but don't use
redo if ( $default_options{zahl} == ($zahl2 = int(rand(14))) or ($colours{$zahl2} eq $my_color) ); # latest color nor own nick color
$default_options{zahl} = $zahl2;
}
$nick_color = weechat::color($colours{$default_options{zahl}}); # get new random color
}
# check for weechat version and use weechat.look.highlight_regex option
if ( $default_options{default_version} eq 1 ){ # weechat is >= 0.3.4?
if ( $default_options{var_look_highlight_regex} eq "on" ){
if ( weechat::string_has_highlight_regex($line,weechat::config_string(weechat::config_get("weechat.look.highlight_regex"))) eq 1 ){
my $color_highlight = weechat::config_color(weechat::config_get("weechat.color.chat_highlight"));
my $color_highlight_bg = weechat::config_color(weechat::config_get("weechat.color.chat_highlight_bg"));
my $high_color = weechat::color("$color_highlight,$color_highlight_bg");
$line = colorize_nicks($high_color,$modifier_data,$line);
$line = $nick_mode . $high_color . $nick . $nick_suffix_with_color . "\t" . $high_color . $line . weechat::color('reset');
return $line;
}
}
}
if (index($modifier_data,"irc_action") >= 0){
# if ($default_options{prefix_action} eq $nick){
my $nick_color = weechat::info_get('irc_nick_color', $nick); # get nick-color
$line = colorize_nicks($nick_color,$modifier_data,$line);
$nick = $prefix_action_with_color;
$line = $nick . "\t" . $nick_color . $line . weechat::color('reset');
return $line;
}
$line = colorize_nicks($nick_color,$modifier_data,$line);
$line = $nick_mode . $nick_color . $nick . $nick_suffix_with_color . "\t" . $nick_color . $line . weechat::color('reset'); # create new line nick_color+nick+separator+text
return $line;
}else{
return $string; # return original string
}
} # end of sub colorize_cb{}
# converts shell wildcard characters to regex
sub shell2regex {
my $globstr = shift;
my %patmap = (
'*' => '.*',
'?' => '.',
'[' => '[',
']' => ']',
);
$globstr =~ s{(.)} { $patmap{$1} || "\Q$1" }ge;
return $globstr;
}
# check for colorize_nicks script an set colour before and after nick name
sub colorize_nicks{
my ( $nick_color, $mf_data, $line ) = @_;
my $pyth_ptn = weechat::infolist_get("python_script","","colorize_nicks");
weechat::infolist_next($pyth_ptn);
if ( "colorize_nicks" eq weechat::infolist_string($pyth_ptn,"name") ){ # does colorize_nicks is installed?
$line = weechat::hook_modifier_exec( "colorize_nicks",$mf_data,$line); # call colorize_nicks function and color the nick(s)
my @array = "";
my $color_code_reset = weechat::color('reset');
@array=split(/$color_code_reset/,$line);
my $new_line = "";
foreach (@array){
$new_line .= $nick_color . $_ . weechat::color('reset');
}
$new_line =~ s/\s+$//g; # remove space at end
$line = $new_line;
}
weechat::infolist_free($pyth_ptn);
return $line;
}
# changes in settings hooked by hook_config()?
sub toggle_config_by_set{
my ( $pointer, $name, $value ) = @_;
$name = substr($name,length("plugins.var.perl.$prgname."),length($name));
$default_options{"var_" . $name} = $value;
if ( $name eq "blacklist_channels" ){
@var_blacklist_channels = "";
@var_blacklist_channels = split( /,/, $default_options{"var_" . $name} );
}
return weechat::WEECHAT_RC_OK ;
}
# toggle functions on/off manually
sub change_settings{
my $getarg = lc($_[2]); # switch to lower-case
if ($getarg eq "highlight"){
if ($default_options{var_highlight} eq "on"){
weechat::config_set_plugin("highlight", "off");
} else{
weechat::config_set_plugin("highlight", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "autoset"){
if ($default_options{var_buffer_autoset} eq "on"){
weechat::config_set_plugin("buffer_autoset", "off");
} else{
weechat::config_set_plugin("buffer_autoset", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "lookhighlight"){
if ($default_options{var_look_highlight} eq "on"){
weechat::config_set_plugin("look_highlight", "off");
} else{
weechat::config_set_plugin("look_highlight", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "lookhighlight_regex"){
if ($default_options{var_look_highlight_regex} eq "on"){
weechat::config_set_plugin("look_highlight_regex", "off");
} else{
weechat::config_set_plugin("look_highlight_regex", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "hotlist"){
if ($default_options{var_hotlist_max_level_nicks_add} eq "on"){
weechat::config_set_plugin("hotlist_max_level_nicks_add", "off");
} else{
weechat::config_set_plugin("hotlist_max_level_nicks_add", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "chat"){
if ($default_options{var_chat} eq "on"){
weechat::config_set_plugin("chat", "off");
} else{
weechat::config_set_plugin("chat", "on");
}
return weechat::WEECHAT_RC_OK;
}
if ($getarg eq "shuffle"){
if ($default_options{var_shuffle} eq "on"){
weechat::config_set_plugin("shuffle", "off");
} else{
weechat::config_set_plugin("shuffle", "on");
}
return weechat::WEECHAT_RC_OK;
}
weechat::command("", "/help $prgname"); # no arguments given. Print help
return weechat::WEECHAT_RC_OK;
}
# main routine
# first function called by a WeeChat-script.
weechat::register($prgname, "Nils Görs <weechatter\@arcor.de>", $version,
"GPL3", $description, "", "");
if (!weechat::config_is_set_plugin("highlight")){
weechat::config_set_plugin("highlight", $default_options{var_highlight});
}else{
$default_options{var_highlight} = weechat::config_get_plugin("highlight");
}
if (!weechat::config_is_set_plugin("buffer_autoset")){
weechat::config_set_plugin("buffer_autoset", $default_options{var_buffer_autoset});
}else{
$default_options{var_buffer_autoset} = weechat::config_get_plugin("buffer_autoset");
}
if (!weechat::config_is_set_plugin("hotlist_max_level_nicks_add")){
weechat::config_set_plugin("hotlist_max_level_nicks_add", $default_options{var_hotlist_max_level_nicks_add});
}else{
$default_options{var_hotlist_max_level_nicks_add} = weechat::config_get_plugin("hotlist_max_level_nicks_add");
}
if (!weechat::config_is_set_plugin("look_highlight")){
weechat::config_set_plugin("look_highlight", $default_options{var_look_highlight});
}else{
$default_options{var_look_highlight} = weechat::config_get_plugin("look_highlight");
}
if (!weechat::config_is_set_plugin("look_highlight_regex")){
weechat::config_set_plugin("look_highlight_regex", $default_options{var_look_highlight_regex});
}else{
$default_options{var_look_highlight_regex} = weechat::config_get_plugin("look_highlight_regex");
}
if (!weechat::config_is_set_plugin("chat")){
weechat::config_set_plugin("chat", $default_options{var_chat});
}else{
$default_options{var_chat} = weechat::config_get_plugin("chat");
}
if (!weechat::config_is_set_plugin("shuffle")){
weechat::config_set_plugin("shuffle", $default_options{var_shuffle});
}else{
$default_options{var_shuffle} = weechat::config_get_plugin("shuffle");
}
if (!weechat::config_is_set_plugin("blacklist_channels")){
weechat::config_set_plugin("blacklist_channels", $default_options{var_blacklist_channels});
}else{
$default_options{var_blacklist_channels} = weechat::config_get_plugin("blacklist_channels");
}
# read nick colours if exists (>= weechat 0.3.4) in %colours
my $colours_buf = weechat::config_string(weechat::config_get("weechat.color.chat_nick_colors"));
if ( $colours_buf ne "" ) {
my @array = split(/,/,$colours_buf);
my $i = 0;
foreach (@array){
$colours{$i++} = $_;
}
undef $colours_buf;
undef @array;
}
$default_options{prefix_action} = weechat::config_string(weechat::config_get("weechat.look.prefix_action"));
weechat::hook_modifier("weechat_print","colorize_cb", "");
#weechat::hook_modifier("colorize_text","colorize_cb", "");
# check weechat version
$default_options{default_version} = weechat::info_get("version_number", "");
if (( $default_options{default_version} ne "" ) && ( $default_options{default_version} >= 0x00030400 )){ # v0.3.4?
$default_options{default_version} = 1; # yes!
}
weechat::hook_command($prgname, $description,
"<highlight> <chat> <shuffle> <autoset> <lookhighlight> <hotlist>",
"<highlight> toggle highlight color in chat area (on/off)\n".
"<chat> colors the text in chat area with according nick color (on/off)\n".
"<shuffle> toggle shuffle color mode on/off\n".
"<autoset> toggle highlight color mode for buffer_autoset on/off\n".
"<lookhighlight> toggle highlight color mode for weechat.look.highlight on/off\n".
"<lookhighlight_regex> toggle highlight color in chat area for option weechat.look.highlight_regex on/off\n".
"<hotlist> toggle hotlist_max_level_nicks_add on/off\n\n".
"Options (script):\n".
" 'plugins.var.perl.$prgname.highlight' : toggle highlight color in chat area on/off.\n".
" 'plugins.var.perl.$prgname.hotlist_max_level_nicks_add' : toggle highlight for hotlist on/off\n".
" 'plugins.var.perl.$prgname.buffer_autoset' : toggle highlight color in chat area for buffer_autoset on/off\n".
" 'plugins.var.perl.$prgname.look_highlight' : toggle highlight color in chat area for option weechat.look.highlight on/off\n".
" 'plugins.var.perl.$prgname.look_highlight_regex' : toggle highlight color in chat area for option weechat.look.highlight_regex on/off\n".
" 'plugins.var.perl.$prgname.chat' : toggle colored text for chats on/off\n".
" 'plugins.var.perl.$prgname.shuffle' : toggle shuffle color mode for chats area on/off\n".
" 'plugins.var.perl.$prgname.blacklist_channels' : comma separated list with channelname (e.g.: freenode.#weechat,freenode.#weechat-fr)\n\n".
"Options (global):\n".
" 'weechat.color.chat_highlight' : highlight color\n".
" 'weechat.color.chat_highlight_bg' : highlight background color\n".
" 'weechat.color.chat_nick*' : colors for nicks\n\n".
"To use the buffer_autoset and/or hotlist_max_level_nicks_install buffer_autoset script from: http://www.weechat.org/scripts/\n",
"highlight|chat|shuffle|autoset|lookhighlight|lookhighlight_regex|hotlist", "change_settings", "");
weechat::hook_config( "plugins.var.perl.$prgname.*", "toggle_config_by_set", "" );