highmon.pl 36.1 KB
Newer Older
1
#
2
# highmon.pl - Highlight Monitoring for weechat 0.3.0
3
# Version 2.6
4
#
5 6 7
# Add 'Highlight Monitor' buffer/bar to log all highlights in one spot
#
# Usage:
8
# /highmon [help] | [monitor [channel [server]]] | [clean default|orphan|all] | clearbar
9 10 11 12 13
#  Command wrapper for highmon commands
#
# /highmon clean default|orphan|all will clean the config section of default 'on' entries,
#  channels you are no longer joined, or both
#
14 15
# /highmon clearbar will clear the contents of highmon's bar output
#
16 17
# /highmon monitor [channel] [server] is used to toggle a highlight monitoring on and off, this
#  can be used in the channel buffer for the channel you wish to toggle, or be given
18
#  with arguments e.g. /highmon monitor #weechat freenode
19
#
20
# /set plugins.var.perl.highmon.alignment
21
#  The config setting "alignment" can be changed to;
22
#  "channel", "schannel", "nchannel", "channel,nick", "schannel,nick", "nchannel,nick"
23
#  to change how the monitor appears
24 25 26
#  The 'channel'  value will show: "#weechat"
#  The 'schannel' value will show: "6"
#  The 'nchannel' value will show: "6:#weechat"
27 28
#
# /set plugins.var.perl.highmon.short_names
29
#  Setting this to 'on' will trim the network name from highmon, ala buffers.pl
30
#
31 32 33
# /set plugins.var.perl.highmon.merge_private
#  Setting this to 'on' will merge private messages to highmon's display
#
34
# /set plugins.var.perl.highmon.color_buf
35 36
#  This turns colored buffer names on or off, you can also set a single fixed color by using a weechat color name.
#  This *must* be a valid color name, or weechat will likely do unexpected things :)
37
#
38
# /set plugins.var.perl.highmon.hotlist_show
39 40
#  Setting this to 'on' will let the highmon buffer appear in hotlists
#  (status bar/buffer.pl)
41 42
#
# /set plugins.var.perl.highmon.away_only
43 44 45 46 47 48 49 50 51 52 53
#  Setting this to 'on' will only put messages in the highmon buffer when
#  you set your status to away
#
# /set plugins.var.perl.highmon.logging
#  Toggles logging status for highmon buffer (default: off)
#
# /set plugins.var.perl.highmon.output
#  Changes where output method of highmon; takes either "bar" or "buffer" (default; buffer)
# /set plugins.var.perl.highmon.bar_lines
#  Changes the amount of lines the output bar will hold.
#  (Only appears once output has been set to bar, defaults to 10)
54 55 56
# /set plugins.var.perl.highmon.bar_scrolldown
#  Toggles the bar scrolling at the bottom when new highlights are received
#  (Only appears once output has been set to bar, defaults to off)
57
#
58 59
# /set plugins.var.perl.highmon.nick_prefix
# /set plugins.var.perl.highmon.nick_suffix
60 61 62 63 64 65
#  Sets the prefix and suffix chars in the highmon buffer
#  (Defaults to <> if nothing set, and blank if there is)
#
# servername.#channel
#  servername is the internal name for the server (set when you use /server add)
#  #channel is the channel name, (where # is whatever channel type that channel happens to be)
66
#
67 68 69 70 71
# Optional, set up tweaks; Hide the status and input lines on highmon
#
# /set weechat.bar.status.conditions "${window.buffer.full_name} != perl.highmon"
# /set weechat.bar.input.conditions "${window.buffer.full_name} != perl.highmon"
#
72

73 74
# Bugs and feature requests at: https://github.com/KenjiE20/highmon

75
# History:
76 77
# 2019-05-13, HubbeKing <hubbe128@gmail.com>
#	v2.6:	-add: send "logger_backlog" signal on buffer open if logging is enabled
78 79 80 81 82
# 2014-08-16, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.5:	-add: clearbar command to clear bar output
#			-add: firstrun output prompt to check the help text for set up hints as they were being missed
#			and update hint for conditions to use eval
#			-change: Make all outputs use the date callback for more accurate timestamps (thanks Germainz)
83 84
# 2013-12-04, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.4:	-add: Support for eval style colour codes in time format used for bar output
85 86
# 2013-10-22, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3.3.2:	-fix: Typo in fix command
87 88 89 90
# 2013-10-10, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3.3.1:	-fix: Typo in closed buffer warning
# 2013-10-07, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3.3:	-add: Warning and fixer for accidental buffer closes
91 92 93
# 2013-01-15, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3.2:	-fix: Let bar output use the string set in weechat's config option
#			-add: github info
94 95
# 2012-04-15, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3.1:	-fix: Colour tags in bar timestamp string
96 97 98
# 2012-02-28, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.3:	-feature: Added merge_private option to display private messages (default: off)
#			-fix: Channel name colours now show correctly when set to on
99 100
# 2011-08-07, Sitaktif <romainchossart_at_gmail.com>:
#	v2.2.1:	-feature: Add "bar_scrolldown" option to have the bar display the latest hl at anytime
101
#			-fix: Set up bar-specific config at startup if 'output' is already configured as 'bar'
102 103
# 2010-12-22, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.2:	-change: Use API instead of config to find channel colours, ready for 0.3.4 and 256 colours
104 105 106
# 2010-12-13, idl0r & KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.1.3:	-fix: perl errors caused by bar line counter
#			-fix: Add command list to inbuilt help
107 108 109
# 2010-09-30, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.1.2:	-fix: logging config was not correctly toggling back on (thanks to sleo for noticing)
#			-version sync w/ chanmon
110 111
# 2010-08-27, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.1: -feature: Add 'nchannel' option to alignment to display buffer and name
112 113 114 115 116 117 118 119
# 2010-04-25, KenjiE20 <longbow@longbowslair.co.uk>:
#	v2.0:	Release as version 2.0
# 2010-04-24, KenjiE20 <longbow@longbowslair.co.uk>:
#	v1.9:	Rewrite for v2.0
#		Bring feature set in line with chanmon 2.0
#		-code change: Made more subs to shrink the code down in places
#		-fix: Stop highmon attempting to double load/hook
#		-fix: Add version dependant check for away status
120 121 122 123 124
# 2010-01-25, KenjiE20 <longbow@longbowslair.co.uk>:
#       v1.7:   -fixture: Let highmon be aware of nick_prefix/suffix
#                       and allow custom prefix/suffix for chanmon buffer
#                       (Defaults to <> if nothing set, and blank if there is)
#               (Thanks to m4v for these)
125 126 127
# 2009-09-07, KenjiE20 <longbow@longbowslair.co.uk>:
#	v1.6:	-feature: colored buffer names
#		-change: version sync with chanmon
128 129
# 2009-09-05, KenjiE20 <longbow@longbowslair.co.uk>:
#	v1.2:	-fix: disable buffer highlight
130 131
# 2009-09-02, KenjiE20 <longbow@longbowslair.co.uk>:
#	v.1.1.1	-change: Stop unsightly text block on '/help'
132 133
# 2009-08-10, KenjiE20 <longbow@longbowslair.co.uk>:
#	v1.1:	In-client help added
134 135
# 2009-08-02, KenjiE20 <longbow@longbowslair.co.uk>:
#	v1.0:	Initial Public Release
136

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
# Copyright (c) 2009 by KenjiE20 <longbow@longbowslair.co.uk>
#
# 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/>.
#

153 154
@bar_lines = ();
@bar_lines_time = ();
155
# Replicate info earlier for in-client help
156

157
$highmonhelp = weechat::color("bold")."/highmon [help] | [monitor [channel [server]]] | [clean default|orphan|all] | clearbar".weechat::color("-bold")."
158 159 160 161
 Command wrapper for highmon commands

".weechat::color("bold")."/highmon clean default|orphan|all".weechat::color("-bold")." will clean the config section of default 'on' entries, channels you are no longer joined, or both

162 163
".weechat::color("bold")."/highmon clearbar".weechat::color("-bold")." will clear the contents of highmon's bar output

164 165 166
".weechat::color("bold")."/highmon monitor [channel] [server]".weechat::color("-bold")." is used to toggle a highlight monitoring on and off, this can be used in the channel buffer for the channel you wish to toggle, or be given with arguments e.g. /highmon monitor #weechat freenode

".weechat::color("bold")."/set plugins.var.perl.highmon.alignment".weechat::color("-bold")."
167
 The config setting \"alignment\" can be changed to;
168
 \"channel\", \"schannel\", \"nchannel\", \"channel,nick\", \"schannel,nick\", \"nchannel,nick\"
169
 to change how the monitor appears
170 171 172
 The 'channel'  value will show: \"#weechat\"
 The 'schannel' value will show: \"6\"
 The 'nchannel' value will show: \"6:#weechat\"
173 174

".weechat::color("bold")."/set plugins.var.perl.highmon.short_names".weechat::color("-bold")."
175
 Setting this to 'on' will trim the network name from highmon, ala buffers.pl
176

177 178 179
".weechat::color("bold")."/set plugins.var.perl.highmon.merge_private".weechat::color("-bold")."
 Setting this to 'on' will merge private messages to highmon's display

180
".weechat::color("bold")."/set plugins.var.perl.highmon.color_buf".weechat::color("-bold")."
181 182
 This turns colored buffer names on or off, you can also set a single fixed color by using a weechat color name.
 This ".weechat::color("bold")."must".weechat::color("-bold")." be a valid color name, or weechat will likely do unexpected things :)
183

184 185 186 187
".weechat::color("bold")."/set plugins.var.perl.highmon.hotlist_show".weechat::color("-bold")."
Setting this to 'on' will let the highmon buffer appear in hotlists (status bar/buffer.pl)

".weechat::color("bold")."/set plugins.var.perl.highmon.away_only".weechat::color("-bold")."
188 189
Setting this to 'on' will only put messages in the highmon buffer when you set your status to away

190 191 192 193 194 195 196 197
".weechat::color("bold")."/set plugins.var.perl.highmon.logging".weechat::color("-bold")."
 Toggles logging status for highmon buffer (default: off)

".weechat::color("bold")."/set plugins.var.perl.highmon.output".weechat::color("-bold")."
 Changes where output method of highmon; takes either \"bar\" or \"buffer\" (default; buffer)
".weechat::color("bold")."/set plugins.var.perl.highmon.bar_lines".weechat::color("-bold")."
 Changes the amount of lines the output bar will hold.
 (Only appears once output has been set to bar, defaults to 10)
198 199 200
".weechat::color("bold")."/set plugins.var.perl.highmon.bar_scrolldown".weechat::color("-bold")."
 Toggles the bar scrolling at the bottom when new highlights are received
 (Only appears once output has been set to bar, defaults to off)
201

202 203
".weechat::color("bold")."/set plugins.var.perl.highmon.nick_prefix".weechat::color("-bold")."
".weechat::color("bold")."/set plugins.var.perl.highmon.nick_suffix".weechat::color("-bold")."
204 205
 Sets the prefix and suffix chars in the highmon buffer
 (Defaults to <> if nothing set, and blank if there is)
206

207 208
".weechat::color("bold")."servername.#channel".weechat::color("-bold")."
 servername is the internal name for the server (set when you use /server add)
209 210 211 212 213 214
 #channel is the channel name, (where # is whatever channel type that channel happens to be)

".weechat::color("bold")."Optional, set up tweaks;".weechat::color("-bold")." Hide the status and input lines on highmon

".weechat::color("bold")."/set weechat.bar.status.conditions \"\${window.buffer.full_name} != perl.highmon\"".weechat::color("-bold")."
".weechat::color("bold")."/set weechat.bar.input.conditions \"\${window.buffer.full_name} != perl.highmon\"".weechat::color("-bold");
215 216
# Print verbose help
sub print_help
217
{
218 219
	weechat::print("", "\t".weechat::color("bold")."Highmon Help".weechat::color("-bold")."\n\n");
	weechat::print("", "\t".$highmonhelp);
220 221 222
	return weechat::WEECHAT_RC_OK;
}

223 224
# Bar item build
sub highmon_bar_build
225
{
226 227
	# Get max lines
	$max_lines = weechat::config_get_plugin("bar_lines");
228
	$max_lines = $max_lines ? $max_lines : 10;
229 230 231 232
	$str = '';
	$align_num = 0;
	$count = 0;
	# Keep lines within max
233
	while ($#bar_lines > $max_lines)
234
	{
235 236
		shift(@bar_lines);
		shift(@bar_lines_time);
237
	}
238 239
	# So long as we have some lines, build a string
	if (@bar_lines)
240
	{
241
		# Build loop
242
		$sep = " ".weechat::config_string(weechat::config_get("weechat.look.prefix_suffix"))." ";
243
		foreach(@bar_lines)
244
		{
245
			# Find max align needed
246
			$prefix_num = (index(weechat::string_remove_color($_, ""), $sep));
247
			$align_num = $prefix_num if ($prefix_num > $align_num);
248
		}
249 250 251
		foreach(@bar_lines)
		{
			# Get align for this line
252 253
			$prefix_num = (index(weechat::string_remove_color($_, ""), $sep));

254 255 256 257
			# Make string
			$str = $str.$bar_lines_time[$count]." ".(" " x ($align_num - $prefix_num)).$_."\n";
			# Increment count for sync with time list
			$count++;
258 259
		}
	}
260
	return $str;
261 262
}

263 264
# Make a new bar
sub highmon_bar_open
265
{
266 267
	# Make the bar item
	weechat::bar_item_new("highmon", "highmon_bar_build", "");
268

269 270
	$highmon_bar = weechat::bar_new ("highmon", "off", 100, "root", "", "bottom", "vertical", "vertical", 0, 0, "default", "cyan", "default", "on", "highmon");

271 272
	return weechat::WEECHAT_RC_OK;
}
273 274
# Close bar
sub highmon_bar_close
275
{
276 277 278 279 280 281 282
	# Find if bar exists
	$highmon_bar = weechat::bar_search("highmon");
	# If is does, close it
	if ($highmon_bar ne "")
	{
		weechat::bar_remove($highmon_bar);
	}
283

284 285 286 287 288 289 290
	# Find if bar item exists
	$highmon_bar_item = weechat::bar_item_search("highmon_bar");
	# If is does, close it
	if ($highmon_bar_item ne "")
	{
		weechat::bar_remove($highmon_bar_item);
	}
291

292
	@bar_lines = ();
293 294 295
	return weechat::WEECHAT_RC_OK;
}

296
# Make a new buffer
297 298
sub highmon_buffer_open
{
299
	# Search for pre-existing buffer
300 301
	$highmon_buffer = weechat::buffer_search("perl", "highmon");

302
	# Make a new buffer
303 304
	if ($highmon_buffer eq "")
	{
305
		$highmon_buffer = weechat::buffer_new("highmon", "highmon_buffer_input", "", "highmon_buffer_close", "");
306 307
	}

308
	# Turn off notify, highlights
309 310
	if ($highmon_buffer ne "")
	{
311
		if (weechat::config_get_plugin("hotlist_show") eq "off")
312 313 314
		{
			weechat::buffer_set($highmon_buffer, "notify", "0");
		}
315
		weechat::buffer_set($highmon_buffer, "highlight_words", "-");
316
		weechat::buffer_set($highmon_buffer, "title", "Highlight Monitor");
317 318 319 320 321
		# Set no_log
		if (weechat::config_get_plugin("logging") eq "off")
		{
			weechat::buffer_set($highmon_buffer, "localvar_set_no_log", "1");
		}
322 323 324 325 326
		# send "logger_backlog" signal if logging is enabled to display backlog
		if (weechat::config_get_plugin("logging") eq "on")
		{
			weechat::hook_signal_send("logger_backlog", weechat::WEECHAT_HOOK_SIGNAL_POINTER, $highmon_buffer)
		}
327 328 329
	}
	return weechat::WEECHAT_RC_OK;
}
330
# Buffer input has no action
331 332 333 334
sub highmon_buffer_input
{
	return weechat::WEECHAT_RC_OK;
}
335 336
# Close up
sub highmon_buffer_close
337
{
338
	$highmon_buffer = "";
339 340 341 342 343
	# If user hasn't changed output style warn user
	if (weechat::config_get_plugin("output") eq "buffer")
	{
		weechat::print("", "\tHighmon buffer has been closed but output is still set to buffer, unusual results may occur. To recreate the buffer use ".weechat::color("bold")."/highmon fix".weechat::color("-bold"));
	}
344 345 346
	return weechat::WEECHAT_RC_OK;
}

347 348
# Highmon command wrapper
sub highmon_command_cb
349
{
350 351 352 353 354
	$data = $_[0];
	$buffer = $_[1];
	$args = $_[2];
	my $cmd = '';
	my $arg = '';
355

356 357 358 359 360 361 362 363 364 365 366 367
	if ($args ne "")
	{
		# Split argument up
		@arg_array = split(/ /,$args);
		# Take first as command
		$cmd = shift(@arg_array);
		# Rebuild string to pass to subs
		if (@arg_array)
		{
			$arg = join(" ", @arg_array);
		}
	}
368

369 370 371 372 373 374
	# Help command
	if ($cmd eq "" || $cmd eq "help")
	{
		print_help();
	}
	# /monitor command
375
	elsif ($cmd eq "monitor")
376 377 378 379 380 381 382 383
	{
		highmon_toggle($data, $buffer, $arg);
	}
	# /highclean command
	elsif ($cmd eq "clean")
	{
		highmon_config_clean($data, $buffer, $arg);
	}
384 385 386 387 388 389 390 391 392
	# clearbar command
	elsif ($cmd eq "clearbar")
	{
		if (weechat::config_get_plugin("output") eq "bar")
		{
			@bar_lines = ();
			weechat::bar_item_update("highmon");
		}
	}
393 394 395 396 397
	# Fix closed buffer
	elsif ($cmd eq "fix")
	{
		if (weechat::config_get_plugin("output") eq "buffer" && $highmon_buffer eq "")
		{
398
			highmon_buffer_open();
399 400
		}
	}
401
	return weechat::WEECHAT_RC_OK;
402
}
403 404 405

# Clean up config entries
sub highmon_config_clean
406
{
407 408 409
	$data = $_[0];
	$buffer = $_[1];
	$args = $_[2];
410

411 412 413 414 415 416
	# Don't do anything if bad option given
	if ($args ne "default" && $args ne "orphan"  && $args ne "all")
	{
		weechat::print("", "\thighmon.pl: Unknown option");
		return weechat::WEECHAT_RC_OK;
	}
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
	@chans = ();
	# Load an infolist of highmon options
	$infolist = weechat::infolist_get("option", "", "*highmon*");
	while (weechat::infolist_next($infolist))
	{
		$name = weechat::infolist_string($infolist, "option_name");
		$name =~ s/perl\.highmon\.(\w*)\.([#&\+!])(.*)/$1.$2$3/;
		if ($name =~ /^(.*)\.([#&\+!])(.*)$/)
		{
			$action = 0;
			# Clean up all 'on's
			if ($args eq "default" || $args eq "all")
			{
				# If value in config is "on"
				if (weechat::config_get_plugin($name) eq "on")
				{
					# Unset and if successful flag as changed
					$rc = weechat::config_unset_plugin($name);
					if ($rc eq weechat::WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED)
					{
						$action = 1;
					}
				}
			}
			# Clean non joined
			if ($args eq "orphan" || $args eq "all")
			{
				# If we can't find the buffer for this entry
				if (weechat::buffer_search("irc", $name) eq "")
				{
					# Unset and if successful flag as changed
					$rc = weechat::config_unset_plugin($name);
					if ($rc eq weechat::WEECHAT_CONFIG_OPTION_UNSET_OK_REMOVED)
					{
						$action = 1;
					}
				}
			}
			# Add changed entry names to list
			push (@chans, $name) if ($action);
		}
	}
	weechat::infolist_free($infolist);
	# If channels were cleaned from config
	if (@chans)
	{
		# If only one entry
		if (@chans == 1)
		{
			$str = "\thighmon.pl: Cleaned ".@chans." entry from the config:";
		}
		else
		{
			$str = "\thighmon.pl: Cleaned ".@chans." entries from the config:";
		}
		# Build a list of channels
		foreach(@chans)
		{
			$str = $str." ".$_;
		}
		# Print what happened
		weechat::print("",$str);
	}
	# Config seemed to be clean
	else
	{
		weechat::print("", "\thighmon.pl: No entries removed");
	}
	return weechat::WEECHAT_RC_OK;
487
}
488 489 490

# Check config elements
sub highmon_config_init
491
{
492 493 494 495 496 497 498 499 500
	# First run default
	if (!(weechat::config_is_set_plugin ("first_run")))
	{
		if (weechat::config_get_plugin("first_run") ne "true")
		{
			weechat::print("", "\tThis appears to be the first time highmon has been run. For help and common set up hints see /highmon help");
			weechat::config_set_plugin("first_run", "true");
		}
	}
501 502 503 504 505 506 507 508 509
	# Alignment default
	if (!(weechat::config_is_set_plugin ("alignment")))
	{
		weechat::config_set_plugin("alignment", "channel");
	}
	if (weechat::config_get_plugin("alignment") eq "")
	{
		weechat::config_set_plugin("alignment", "none");
	}
510

511 512 513 514 515
	# Short name default
	if (!(weechat::config_is_set_plugin ("short_names")))
	{
		weechat::config_set_plugin("short_names", "off");
	}
516

517 518 519 520 521
	# Coloured names default
	if (!(weechat::config_is_set_plugin ("color_buf")))
	{
		weechat::config_set_plugin("color_buf", "on");
	}
522

523 524 525 526 527
	# Hotlist show default
	if (!(weechat::config_is_set_plugin ("hotlist_show")))
	{
		weechat::config_set_plugin("hotlist_show", "off");
	}
528

529 530 531 532 533 534 535 536 537 538 539
	# Away only default
	if (!(weechat::config_is_set_plugin ("away_only")))
	{
		weechat::config_set_plugin("away_only", "off");
	}

	# highmon log default
	if (!(weechat::config_is_set_plugin ("logging")))
	{
		weechat::config_set_plugin("logging", "off");
	}
540

541 542 543 544 545
	# Output default
	if (!(weechat::config_is_set_plugin ("output")))
	{
		weechat::config_set_plugin("output", "buffer");
	}
546

547 548 549 550 551
	# Private message merging
	if (!(weechat::config_is_set_plugin ("merge_private")))
	{
		weechat::config_set_plugin("merge_private", "off");
	}
552

553 554 555 556 557 558 559 560 561 562 563 564 565 566
	# Set bar config in case output was set to "bar" before even changing the setting
	if (weechat::config_get_plugin("output") eq "bar")
	{
		# Output bar lines default
		if (!(weechat::config_is_set_plugin ("bar_lines")))
		{
			weechat::config_set_plugin("bar_lines", "10");
		}
		if (!(weechat::config_is_set_plugin ("bar_scrolldown")))
		{
			weechat::config_set_plugin("bar_scrolldown", "off");
		}
	}

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
	# Check for exisiting prefix/suffix chars, and setup accordingly
	$prefix = weechat::config_get("irc.look.nick_prefix");
	$prefix = weechat::config_string($prefix);
	$suffix = weechat::config_get("irc.look.nick_suffix");
	$suffix = weechat::config_string($suffix);

	if (!(weechat::config_is_set_plugin("nick_prefix")))
	{
		if ($prefix eq "" && $suffix eq "")
		{
			weechat::config_set_plugin("nick_prefix", "<");
		}
		else
		{
			weechat::config_set_plugin("nick_prefix", "");
		}
	}

	if (!(weechat::config_is_set_plugin("nick_suffix")))
	{
		if ($prefix eq "" && $suffix eq "")
		{
			weechat::config_set_plugin("nick_suffix", ">");
		}
		else
		{
			weechat::config_set_plugin("nick_suffix", "");
		}
	}
596
}
597 598 599

# Get config updates
sub highmon_config_cb
600
{
601 602 603
	$point = $_[0];
	$name = $_[1];
	$value = $_[2];
604

605
	$name =~ s/^plugins\.var\.perl\.highmon\.//;
606

607 608 609 610 611 612 613 614 615 616 617
	# Set logging on buffer
	if ($name eq "logging")
	{
		# Search for pre-existing buffer
		$highmon_buffer = weechat::buffer_search("perl", "highmon");
		if ($value eq "off")
		{
			weechat::buffer_set($highmon_buffer, "localvar_set_no_log", "1");
		}
		else
		{
618
			weechat::buffer_set($highmon_buffer, "localvar_del_no_log", "");
619 620 621 622 623 624 625 626 627 628 629 630 631 632
		}
	}
	# Output changer
	elsif ($name eq "output")
	{
		if ($value eq "bar")
		{
			# Search for pre-existing buffer
			$highmon_buffer = weechat::buffer_search("perl", "highmon");
			# Close if it exists
			if ($highmon_buffer ne "")
			{
				weechat::buffer_close($highmon_buffer)
			}
633

634 635 636 637 638
			# Output bar lines default
			if (!(weechat::config_is_set_plugin ("bar_lines")))
			{
				weechat::config_set_plugin("bar_lines", "10");
			}
639 640 641 642
			if (!(weechat::config_is_set_plugin ("bar_scrolldown")))
			{
				weechat::config_set_plugin("bar_scrolldown", "off");
			}
643 644 645 646 647 648 649 650 651 652
			# Make a bar if doesn't exist
			highmon_bar_open();
		}
		elsif ($value eq "buffer")
		{
			# If a bar exists, close it
			highmon_bar_close();
			# Open buffer
			highmon_buffer_open();
		}
653

654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
	}
	# Change if hotlist config changes
	elsif ($name eq "hotlist_show")
	{
		# Search for pre-existing buffer
		$highmon_buffer = weechat::buffer_search("perl", "highmon");
		if ($value eq "off" && $highmon_buffer)
		{
			weechat::buffer_set($highmon_buffer, "notify", "0");
		}
		elsif ($value ne "off" && $highmon_buffer)
		{
			weechat::buffer_set($highmon_buffer, "notify", "3");
		}
	}
669 670 671 672 673 674 675 676 677
	elsif ($name eq "weechat.look.prefix_suffix")
	{
		if (weechat::config_get_plugin("output") eq "bar")
		{
			@bar_lines = ();
			weechat::print("", "\thighmon: weechat.look.prefix_suffix changed, clearing highmon bar");
			weechat::bar_item_update("highmon");
		}
	}
678
	return weechat::WEECHAT_RC_OK;
679
}
680 681 682

# Set up weechat hooks / commands
sub highmon_hook
683
{
684 685
	weechat::hook_print("", "", "", 0, "highmon_new_message", "");
	weechat::hook_command("highclean", "Highmon config clean up", "default|orphan|all", " default: Cleans all config entries with the default \"on\" value\n  orphan: Cleans all config entries for channels you aren't currently joined\n     all: Does both defaults and orphan", "default|orphan|all", "highmon_config_clean", "");
686

687
	weechat::hook_command("highmon", "Highmon help", "[help] | [monitor [channel [server]]] | [clean default|orphan|all] | clearbar", "    help: Print help on config options for highmon\n monitor: Toggles monitoring for a channel\n   clean: Highmon config clean up (/highclean)\nclearbar: Clear Highmon bar", "help || monitor %(irc_channels) %(irc_servers) || clean default|orphan|all || clearbar", "highmon_command_cb", "");
688

689
	weechat::hook_config("plugins.var.perl.highmon.*", "highmon_config_cb", "");
690
	weechat::hook_config("weechat.look.prefix_suffix", "highmon_config_cb", "");
691
}
692 693 694

# Main body, Callback for hook_print
sub highmon_new_message
695
{
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
	my $net = "";
	my $chan = "";
	my $nick = "";
	my $outstr = "";
	my $window_displayed = "";
	my $dyncheck = "0";

#	DEBUG point
#	$string = "\t"."0: ".$_[0]." 1: ".$_[1]." 2: ".$_[2]." 3: ".$_[3]." 4: ".$_[4]." 5: ".$_[5]." 6: ".$_[6]." 7: ".$_[7];
#	weechat::print("", "\t".$string);

	$cb_datap = $_[0];
	$cb_bufferp = $_[1];
	$cb_date = $_[2];
	$cb_tags = $_[3];
	$cb_disp = $_[4];
	$cb_high = $_[5];
	$cb_prefix = $_[6];
	$cb_msg = $_[7];

716 717
	# Only work on highlighted messages or private message when enabled
	if ($cb_high == "1" || (weechat::config_get_plugin("merge_private") eq "on" && $cb_tags =~ /notify_private/))
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766
	{
		# Pre bug #29618 (0.3.3) away detect
		if (weechat::info_get("version_number", "") <= 197120)
		{
			$away = '';
			# Get infolist for this server
			$infolist = weechat::infolist_get("irc_server", "", weechat::buffer_get_string($cb_bufferp, "localvar_server"));
			while (weechat::infolist_next($infolist))
			{
				# Get away message is is_away is on
				$away = weechat::infolist_string($infolist, "away_message") if (weechat::infolist_integer($infolist, "is_away"));
			}
			weechat::infolist_free($infolist);
		}
		# Post bug #29618 fix
		else
		{
			$away = weechat::buffer_get_string($cb_bufferp, "localvar_away");
		}
		if (weechat::config_get_plugin("away_only") ne "on" || ($away ne ""))
		{
			# Check buffer name is an IRC channel
			$bufname = weechat::buffer_get_string($cb_bufferp, 'name');
			if ($bufname =~ /(.*)\.([#&\+!])(.*)/)
			{
				# Are we running on this channel
				if (weechat::config_get_plugin($bufname) ne "off" && $cb_disp eq "1")
				{
					# Format nick
					# Line isn't action or topic notify
					if (!($cb_tags =~ /irc_action/) && !($cb_tags =~ /irc_topic/))
					{
						# Strip nick colour
						$uncolnick = weechat::string_remove_color($cb_prefix, "");
						# Format nick
						$nick = " ".weechat::config_get_plugin("nick_prefix").weechat::color("chat_highlight").$uncolnick.weechat::color("reset").weechat::config_get_plugin("nick_suffix");
					}
					# Topic line
					elsif ($cb_tags =~ /irc_topic/)
					{
						$nick = " ".$cb_prefix.weechat::color("reset");
					}
					# Action line
					else
					{
						$uncolnick = weechat::string_remove_color($cb_prefix, "");
						$nick = weechat::color("chat_highlight").$uncolnick.weechat::color("reset");
					}
					# Send to output
767
					highmon_print ($cb_msg, $cb_bufferp, $nick, $cb_date, $cb_tags);
768 769
				}
			}
770 771 772 773 774 775 776 777
			# Or is private message
			elsif (weechat::config_get_plugin("merge_private") eq "on" && $cb_tags =~ /notify_private/)
			{
				# Strip nick colour
				$uncolnick = weechat::buffer_get_string($cb_bufferp, 'short_name');
				# Format nick
				$nick = " ".weechat::config_get_plugin("nick_prefix").weechat::color("chat_highlight").$uncolnick.weechat::color("reset").weechat::config_get_plugin("nick_suffix");
				#Send to output
778
				highmon_print ($cb_msg, $cb_bufferp, $nick, $cb_date, $cb_tags);
779
			}
780 781 782
		}
	}
	return weechat::WEECHAT_RC_OK;
783 784
}

785 786 787 788 789 790
# Output formatter and printer takes (msg bufpointer nick)
sub highmon_print
{
	$cb_msg = $_[0];
	my $cb_bufferp = $_[1] if ($_[1]);
	my $nick = $_[2] if ($_[2]);
791 792
	my $cb_date = $_[3] if ($_[3]);
	my $cb_tags = $_[4] if ($_[4]);
793

794 795 796 797
	#Normal channel message
	if ($cb_bufferp && $nick)
	{
		# Format buffer name
798 799
		$bufname = format_buffer_name($cb_bufferp);

800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
		# If alignment is #channel | nick msg
		if (weechat::config_get_plugin("alignment") eq "channel")
		{
			$nick =~ s/\s(.*)/$1/;
			# Build string
			$outstr = $bufname."\t".$nick." ".$cb_msg;
		}
		# or if it is channel number | nick msg
		elsif (weechat::config_get_plugin("alignment") eq "schannel")
		{
			$nick =~ s/\s(.*)/$1/;
			# Use channel number instead
			$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').weechat::color("reset");
			# Build string
			$outstr = $bufname."\t".$nick." ".$cb_msg;
		}
816 817 818 819 820 821 822 823 824
		# or if it is number:#channel | nick msg
		elsif (weechat::config_get_plugin("alignment") eq "nchannel")
		{
			$nick =~ s/\s(.*)/$1/;
			# Place channel number in front of formatted name
			$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').":".weechat::color("reset").$bufname;
			# Build string
			$outstr = $bufname."\t".$nick." ".$cb_msg;
		}
825 826 827 828 829 830 831 832 833 834 835 836 837 838
		# or if it is #channel nick | msg
		elsif (weechat::config_get_plugin("alignment") eq "channel,nick")
		{
			# Build string
			$outstr = $bufname.":".$nick."\t".$cb_msg;
		}
		# or if it is channel number nick | msg
		elsif (weechat::config_get_plugin("alignment") eq "schannel,nick")
		{
			# Use channel number instead
			$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').weechat::color("reset");
			# Build string
			$outstr = $bufname.":".$nick."\t".$cb_msg;
		}
839 840 841 842 843 844 845 846
		# or if it is number:#channel nick | msg
		elsif (weechat::config_get_plugin("alignment") eq "nchannel,nick")
		{
			# Place channel number in front of formatted name
			$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').":".weechat::color("reset").$bufname;
			# Build string
			$outstr = $bufname.":".$nick."\t".$cb_msg;
		}
847 848 849 850 851 852 853 854 855 856 857
		# or finally | #channel nick msg
		else
		{
			# Build string
			$outstr = "\t".$bufname.":".$nick." ".$cb_msg;
		}
	}
	# highmon channel toggle message
	elsif ($cb_bufferp && !$nick)
	{
		# Format buffer name
858 859
		$bufname = format_buffer_name($cb_bufferp);

860 861 862 863 864 865 866 867 868
		# If alignment is #channel * | *
		if (weechat::config_get_plugin("alignment") =~ /channel/)
		{
			# If it's actually channel number * | *
			if (weechat::config_get_plugin("alignment") =~ /schannel/)
			{
				# Use channel number instead
				$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').weechat::color("reset");
			}
869 870 871 872 873 874
			# Or if it's actually number:#channel * | *
			if (weechat::config_get_plugin("alignment") =~ /nchannel/)
			{
				# Place channel number in front of formatted name
			$bufname = weechat::color("chat_prefix_buffer").weechat::buffer_get_integer($cb_bufferp, 'number').":".weechat::color("reset").$bufname;
			}
875 876 877 878 879 880 881 882 883 884 885 886 887
			$outstr = $bufname."\t".$cb_msg;
		}
		# or if alignment is | *
		else
		{
			$outstr = $bufname.": ".$cb_msg;
		}
	}
	# highmon dynmon
	elsif (!$cb_bufferp && !$nick)
	{
		$outstr = "\t".$cb_msg;
	}
888

889 890 891 892 893 894
	# Send string to buffer
	if (weechat::config_get_plugin("output") eq "buffer")
	{
		# Search for and confirm buffer
		$highmon_buffer = weechat::buffer_search("perl", "highmon");
		# Print
895 896 897 898 899 900 901 902
		if ($cb_date)
		{
			weechat::print_date_tags($highmon_buffer, $cb_date, $cb_tags, $outstr);
		}
		else
		{
			weechat::print($highmon_buffer, $outstr);
		}
903 904 905 906 907
	}
	elsif (weechat::config_get_plugin("output") eq "bar")
	{
		# Add time string
		use POSIX qw(strftime);
908 909 910 911 912 913 914 915
		if ($cb_date)
		{
			$time = strftime(weechat::config_string(weechat::config_get("weechat.look.buffer_time_format")), localtime($cb_date));
		}
		else
		{
			$time = strftime(weechat::config_string(weechat::config_get("weechat.look.buffer_time_format")), localtime);
		}
916
		# Colourise
917
		if ($time =~ /\$\{(?:color:)?[\w,]+\}/) # Coloured string
918
		{
919
			while ($time =~ /\$\{(?:color:)?([\w,]+)\}/)
920 921
			{
				$color = weechat::color($1);
922
				$time =~ s/\$\{(?:color:)?[\w,]+\}/$color/;
923
			}
924
			$time .= weechat::color("reset");
925 926 927 928 929 930 931
		}
		else # Default string
		{
			$colour = weechat::color(weechat::config_string(weechat::config_get("weechat.color.chat_time_delimiters")));
			$reset = weechat::color("reset");
			$time =~ s/(\d*)(.)(\d*)/$1$colour$2$reset$3/g;
		}
932 933
		# Push updates to bar lists
		push (@bar_lines_time, $time);
934

935
		# Change tab char
936
		$delim = " ".weechat::color(weechat::config_string(weechat::config_get("weechat.color.chat_delimiters"))).weechat::config_string(weechat::config_get("weechat.look.prefix_suffix")).weechat::color("reset")." ";
937
		$outstr =~ s/\t/$delim/;
938

939 940 941
		push (@bar_lines, $outstr);
		# Trigger update
		weechat::bar_item_update("highmon");
942 943 944 945 946

		if (weechat::config_get_plugin("bar_scrolldown") eq "on")
		{
			weechat::command("", "/bar scroll highmon * ye")
		}
947 948
	}
}
949

950 951 952 953 954 955 956 957 958 959 960 961
# Start the output display
sub highmon_start
{
	if (weechat::config_get_plugin("output") eq "buffer")
	{
		highmon_buffer_open();
	}
	elsif (weechat::config_get_plugin("output") eq "bar")
	{
		highmon_bar_open();
	}
}
962

963 964
# Takes two optional args (channel server), toggles monitoring on/off
sub highmon_toggle
965
{
966 967 968
	$data = $_[0];
	$buffer = $_[1];
	$args = $_[2];
969

970 971
	# Check if we've been told what channel to act on
	if ($args ne "")
972
	{
973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013
		# Split argument up
		@arg_array = split(/ /,$args);
		# Check if a server was given
		if ($arg_array[1])
		{
			# Find matching
			$bufp = weechat::buffer_search("irc", $arg_array[1].".".$arg_array[0]);
		}
		else
		{
			$found_chans = 0;
			# Loop through defined servers
			$infolist = weechat::infolist_get("buffer", "", "");
			while (weechat::infolist_next($infolist))
			{
				# Only interesting in IRC buffers
				if (weechat::infolist_string($infolist, "plugin_name") eq "irc")
				{
					# Find buffers that maych
					$sname = weechat::infolist_string($infolist, "short_name");
					if ($sname eq $arg_array[0])
					{
						$found_chans++;
						$bufp = weechat::infolist_pointer($infolist, "pointer");
					}
				}
			}
			weechat::infolist_free($infolist);
			# If the infolist found more than one channel, halt as we need to know which one
			if ($found_chans > 1)
			{
				weechat::print("", "Channel name is not unique, please define server");
				return weechat::WEECHAT_RC_OK;
			}
		}
		# Something didn't return right
		if ($bufp eq "")
		{
			weechat::print("", "Could not find buffer");
			return weechat::WEECHAT_RC_OK;
		}
1014 1015 1016
	}
	else
	{
1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037
		# Get pointer from where we are
		$bufp = weechat::current_buffer();
	}
	# Get buffer name
	$bufname = weechat::buffer_get_string($bufp, 'name');
	# Test if buffer is an IRC channel
	if ($bufname =~ /(.*)\.([#&\+!])(.*)/)
	{
		if (weechat::config_get_plugin($bufname) eq "off")
		{
			# If currently off, set on
			weechat::config_set_plugin($bufname, "on");

			# Send to output formatter
			highmon_print("Highlight Monitoring Enabled", $bufp);
			return weechat::WEECHAT_RC_OK;
		}
		elsif (weechat::config_get_plugin($bufname) eq "on" || weechat::config_get_plugin($bufname) eq "")
		{
			# If currently on, set off
			weechat::config_set_plugin($bufname, "off");
1038

1039 1040 1041 1042
			# Send to output formatter
			highmon_print("Highlight Monitoring Disabled", $bufp);
			return weechat::WEECHAT_RC_OK;
		}
1043 1044 1045
	}
}

1046 1047
# Takes a buffer pointer and returns a formatted name
sub format_buffer_name
1048
{
1049 1050
	$cb_bufferp = $_[0];
	$bufname = weechat::buffer_get_string($cb_bufferp, 'name');
1051

1052 1053
	# Set colour from buffer name
	if (weechat::config_get_plugin("color_buf") eq "on")
1054
	{
1055
		# Determine what colour to use
1056 1057
		$color = weechat::info_get("irc_nick_color", $bufname);
		if (!$color)
1058
		{
1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
			$color = 0;
			@char_array = split(//,$bufname);
			foreach $char (@char_array)
			{
				$color += ord($char);
			}
			$color %= 10;
			$color = sprintf "weechat.color.chat_nick_color%02d", $color+1;
			$color = weechat::config_get($color);
			$color = weechat::config_string($color);
			$color = weechat::color($color);
1070
		}
1071

1072 1073 1074 1075 1076
		# Private message just show network
		if (weechat::config_get_plugin("merge_private") eq "on" && weechat::buffer_get_string($cb_bufferp, "localvar_type") eq "private")
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, "localvar_server");
		}
1077
		# Format name to short or 'nicename'
1078
		elsif (weechat::config_get_plugin("short_names") eq "on")
1079 1080 1081 1082 1083 1084 1085
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, 'short_name');
		}
		else
		{
			$bufname =~ s/(.*)\.([#&\+!])(.*)/$1$2$3/;
		}
1086

1087
		# Build a coloured string
1088
		$bufname = $color.$bufname.weechat::color("reset");
1089 1090 1091 1092
	}
	# User set colour name
	elsif (weechat::config_get_plugin("color_buf") ne "off")
	{
1093 1094 1095 1096 1097
		# Private message just show network
		if (weechat::config_get_plugin("merge_private") eq "on" && weechat::buffer_get_string($cb_bufferp, "localvar_type") eq "private")
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, "localvar_server");
		}
1098
		# Format name to short or 'nicename'
1099
		elsif (weechat::config_get_plugin("short_names") eq "on")
1100 1101 1102 1103 1104 1105 1106
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, 'short_name');
		}
		else
		{
			$bufname =~ s/(.*)\.([#&\+!])(.*)/$1$2$3/;
		}
1107

1108 1109
		$color = weechat::config_get_plugin("color_buf");
		$bufname = weechat::color($color).$bufname.weechat::color("reset");
1110
	}
1111
	# Stick with default colour
1112 1113
	else
	{
1114 1115 1116 1117 1118
		# Private message just show network
		if (weechat::config_get_plugin("merge_private") eq "on" && weechat::buffer_get_string($cb_bufferp, "localvar_type") eq "private")
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, "localvar_server");
		}
1119
		# Format name to short or 'nicename'
1120
		elsif (weechat::config_get_plugin("short_names") eq "on")
1121 1122 1123 1124 1125 1126 1127
		{
			$bufname = weechat::buffer_get_string($cb_bufferp, 'short_name');
		}
		else
		{
			$bufname =~ s/(.*)\.([#&\+!])(.*)/$1$2$3/;
		}
1128
	}
1129

1130
	return $bufname;
1131 1132
}

1133
# Check result of register, and attempt to behave in a sane manner
1134
if (!weechat::register("highmon", "KenjiE20", "2.6", "GPL3", "Highlight Monitor", "", ""))
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
{
	# Double load
	weechat::print ("", "\tHighmon is already loaded");
	return weechat::WEECHAT_RC_OK;
}
else
{
	# Start everything
	highmon_hook();
	highmon_config_init();
	highmon_start();
1146
}