Created
May 13, 2013 14:38
-
-
Save anonymous/5568765 to your computer and use it in GitHub Desktop.
Update Weechat's beep.pl to support command expansion for the actual message and Weechat's home
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # | |
| # Copyright (C) 2006-2012 Sebastien Helleu <flashcode@flashtux.org> | |
| # Copyright (C) 2011 Nils Görs <weechatter@arcor.de> | |
| # Copyright (C) 2011 ArZa <arza@arza.us> | |
| # | |
| # 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/>. | |
| # | |
| # | |
| # Beep (terminal bell) and/or run command on highlight/private message or new DCC. | |
| # | |
| # History: | |
| # 2012-06-05, ldvx<ldvx@freenode>: | |
| # version 1.1: Added wildcard support for whitelist_nicks. | |
| # 2012-05-09, ldvx <ldvx@freenode>: | |
| # version 1.0: Added beep_pv_blacklist, beep_highlight_blacklist, blacklist_nicks, | |
| # and wildcard support for blacklist_nicks. | |
| # 2012-05-02, ldvx <ldvx@freenode>: | |
| # version 0.9: fix regex for nick in tags, add options "whitelist_channels" | |
| # and "bell_always" | |
| # 2012-04-19, ldvx <ldvx@freenode>: | |
| # version 0.8: add whitelist, trigger, use hook_process for commands, | |
| # rename option "beep_command" to "beep_command_pv", add help for options | |
| # 2011-04-16, ArZa <arza@arza.us>: | |
| # version 0.7: fix default beep command | |
| # 2011-03-11, nils_2 <weechatter@arcor.de>: | |
| # version 0.6: add additional command options for dcc and highlight | |
| # 2011-03-09, nils_2 <weechatter@arcor.de>: | |
| # version 0.5: add option for beep command and dcc | |
| # 2009-05-02, Sebastien Helleu <flashcode@flashtux.org>: | |
| # version 0.4: sync with last API changes | |
| # 2008-11-05, Sebastien Helleu <flashcode@flashtux.org>: | |
| # version 0.3: conversion to WeeChat 0.3.0+ | |
| # 2007-08-10, Sebastien Helleu <flashcode@flashtux.org>: | |
| # version 0.2: upgraded licence to GPL 3 | |
| # 2006-09-02, Sebastien Helleu <flashcode@flashtux.org>: | |
| # version 0.1: initial release | |
| use strict; | |
| my $SCRIPT_NAME = "beep"; | |
| my $VERSION = "1.1"; | |
| # default values in setup file (~/.weechat/plugins.conf) | |
| my %options_default = ('beep_pv' => ['on', 'beep on private message'], | |
| 'beep_pv_whitelist' => ['off', 'turn whitelist for private messages on or off'], | |
| 'beep_pv_blacklist' => ['off', 'turn blacklist for private messages on or off'], | |
| 'beep_highlight' => ['on', 'beep on highlight'], | |
| 'beep_highlight_whitelist' => ['off', 'turn whitelist for highlights on or off'], | |
| 'beep_highlight_blacklist' => ['off', 'turn blacklist for highlights on or off'], | |
| 'beep_dcc' => ['on', 'beep on dcc'], | |
| 'beep_trigger_pv' => ['', 'word that will trigger execution of beep_command_pv (it empty, anything will trigger)'], | |
| 'beep_trigger_highlight' => ['', 'word that will trigger execution of beep_command_highlight (if empty, anything will trigger)'], | |
| 'beep_command_pv' => ['$bell', 'command for beep on private message, special value "$bell" is allowed, as well as "$bell;command"'], | |
| 'beep_command_highlight' => ['$bell', 'command for beep on highlight, special value "$bell" is allowed, as well as "$bell;command"'], | |
| 'beep_command_dcc' => ['$bell', 'command for beep on dcc, special value "$bell" is allowed, as well as "$bell;command"'], | |
| 'beep_command_timeout' => ['30000', 'timeout for command run (in milliseconds, 0 = never kill (not recommended))'], | |
| 'whitelist_nicks' => ['', 'comma-separated list of "server.nick": if not empty, only these nicks will trigger execution of commands (example: "freenode.nick1,freenode.nick2")'], | |
| 'blacklist_nicks' => ['', 'comma-separated list of "server.nick": if not empty, these nicks will not be able to trigger execution of commands. Cannot be used in conjuction with whitelist (example: "freenode.nick1,freenode.nick2")'], | |
| 'whitelist_channels' => ['', 'comma-separated list of "server.#channel": if not empty, only these channels will trigger execution of commands (example: "freenode.#weechat,freenode.#channel2")'], | |
| 'bell_always' => ['', 'use $bell on private messages and/or highlights regardless of trigger and whitelist settings (example: "pv,highlight")'], | |
| ); | |
| my %options = (); | |
| weechat::register($SCRIPT_NAME, "FlashCode <flashcode\@flashtux.org>", $VERSION, | |
| "GPL3", "Beep (terminal bell) and/or run command on highlight/private message or new DCC", "", ""); | |
| init_config(); | |
| weechat::hook_config("plugins.var.perl.$SCRIPT_NAME.*", "toggle_config_by_set", ""); | |
| weechat::hook_print("", "", "", 1, "pv_and_highlight", ""); | |
| weechat::hook_signal("irc_dcc", "dcc", ""); | |
| sub pv_and_highlight | |
| { | |
| my ($data, $buffer, $date, $tags, $displayed, $highlight, $prefix, $message) = @_; | |
| # return if message is filtered | |
| return weechat::WEECHAT_RC_OK if ($displayed != 1); | |
| # return if nick in message is own nick | |
| my $nick = ""; | |
| $nick = $2 if ($tags =~ m/(^|,)nick_([^,]*)(,|$)/); | |
| return weechat::WEECHAT_RC_OK if (weechat::buffer_get_string($buffer, "localvar_nick") eq $nick); | |
| # highlight | |
| if ($highlight) | |
| { | |
| # Always print visual bel, regardless of whitelist and trigger settings | |
| # beep_command_highlight does not need to contain $bell | |
| if ($options{bell_always} =~ m/(^|,)highlight(,|$)/) | |
| { | |
| print STDERR "\a"; | |
| } | |
| # Channels whitelist for highlights | |
| if ($options{beep_highlight} eq "on") | |
| { | |
| if ($options{whitelist_channels} ne "") | |
| { | |
| my $serverandchannel = weechat::buffer_get_string($buffer, "localvar_server"). "." . | |
| weechat::buffer_get_string($buffer, "localvar_channel"); | |
| if ($options{beep_trigger_highlight} eq "" or $message =~ m/\b$options{beep_trigger_highlight}\b/) | |
| { | |
| if ($options{whitelist_channels} =~ /(^|,)$serverandchannel(,|$)/) | |
| { | |
| beep_exec_command($options{beep_command_highlight}); | |
| } | |
| # What if we are highlighted and we're in a PM? For now, do nothing. | |
| } | |
| } | |
| else | |
| { | |
| # Execute $bell and/or command with trigger and whitelist/blacklist settings | |
| beep_trigger_whitelist_blacklist($buffer, $message, $nick, $options{beep_trigger_highlight}, | |
| $options{beep_highlight_whitelist}, $options{beep_highlight_blacklist}, | |
| $options{beep_command_highlight}); | |
| } | |
| } | |
| } | |
| # private message | |
| elsif (weechat::buffer_get_string($buffer, "localvar_type") eq "private" and $tags =~ m/(^|,)notify_private(,|$)/) | |
| { | |
| # Always print visual bel, regardless of whitelist and trigger settings | |
| # beep_command_pv does not need to contain $bell | |
| if ($options{bell_always} =~ m/(^|,)pv(,|$)/) | |
| { | |
| print STDERR "\a"; | |
| } | |
| # Execute $bell and/or command with trigger and whitelist/blacklist settings | |
| if ($options{beep_pv} eq "on") | |
| { | |
| beep_trigger_whitelist_blacklist($buffer, $message, $nick, $options{beep_trigger_pv}, | |
| $options{beep_pv_whitelist}, $options{beep_pv_blacklist}, | |
| $options{beep_command_pv}); | |
| } | |
| } | |
| return weechat::WEECHAT_RC_OK; | |
| } | |
| sub dcc | |
| { | |
| beep_exec_command($options{beep_command_dcc}) if ($options{beep_dcc} eq "on"); | |
| return weechat::WEECHAT_RC_OK; | |
| } | |
| sub beep_trigger_whitelist_blacklist | |
| { | |
| my ($buffer, $message, $nick, $trigger, $whitelist, $blacklist, $command) = @_; | |
| if ($trigger eq "" or $message =~ m/\b$trigger\b/) | |
| { | |
| my $serverandnick = weechat::buffer_get_string($buffer, "localvar_server").".".$nick; | |
| if ($whitelist eq "on" and $options{whitelist_nicks} ne "") | |
| { | |
| # What to do if there's a wildcard in the whitelit | |
| if ($options{whitelist_nicks} =~ m/\*/ and | |
| match_in_wild_card($serverandnick, $options{whitelist_nicks})) | |
| { | |
| beep_exec_command($command); | |
| } | |
| # What to do if there's no wildcard in the whitelist | |
| elsif ($options{whitelist_nicks} =~ /(^|,)$serverandnick(,|$)/) | |
| { | |
| beep_exec_command($command); | |
| } | |
| } | |
| elsif ($blacklist eq "on" and $options{blacklist_nicks} ne "") | |
| { | |
| # What to do if there's a wildcard in the blacklist | |
| if ($options{blacklist_nicks} =~ m/\*/ and | |
| !match_in_wild_card($serverandnick, $options{blacklist_nicks})) | |
| { | |
| beep_exec_command($command); | |
| } | |
| # What to do if there's no wildcard in the blacklist | |
| elsif ($options{blacklist_nicks} !~ /(^|,)$serverandnick(,|$)/) | |
| { | |
| beep_exec_command($command); | |
| } | |
| } | |
| # What to do if we are not using whitelist of blacklist feature | |
| elsif ($whitelist eq "off" and $blacklist eq "off") | |
| { | |
| beep_exec_command($command); | |
| } | |
| } | |
| } | |
| sub beep_exec_command | |
| { | |
| my $command = $_[0]; | |
| if ($command =~ /^\$bell/) | |
| { | |
| print STDERR "\a"; | |
| ($command) = $command =~ /^\$bell;(.+)$/; | |
| } | |
| weechat::hook_process($command, $options{beep_command_timeout}, "my_process", "") if ($command); | |
| } | |
| sub match_in_wild_card | |
| { | |
| my ($serverandnick, $white_or_black) = @_; | |
| my $nick_iter; | |
| my @array_of_nicks = split(",", $white_or_black); | |
| foreach $nick_iter (@array_of_nicks) | |
| { | |
| $nick_iter =~ s/\*/[^,]*/g; | |
| if ($serverandnick =~ /$nick_iter/) | |
| { | |
| return 1; | |
| } | |
| } | |
| return 0; | |
| } | |
| sub my_process | |
| { | |
| return weechat::WEECHAT_RC_OK; | |
| } | |
| sub toggle_config_by_set | |
| { | |
| my ($pointer, $name, $value) = @_; | |
| $name = substr($name, length("plugins.var.perl.".$SCRIPT_NAME."."), length($name)); | |
| $options{$name} = $value; | |
| return weechat::WEECHAT_RC_OK; | |
| } | |
| sub init_config | |
| { | |
| my $version = weechat::info_get("version_number", "") || 0; | |
| foreach my $option (keys %options_default) | |
| { | |
| if (!weechat::config_is_set_plugin($option)) | |
| { | |
| weechat::config_set_plugin($option, $options_default{$option}[0]); | |
| $options{$option} = $options_default{$option}[0]; | |
| } | |
| else | |
| { | |
| $options{$option} = weechat::config_get_plugin($option); | |
| } | |
| if ($version >= 0x00030500) | |
| { | |
| weechat::config_set_desc_plugin($option, $options_default{$option}[1]." (default: \"".$options_default{$option}[0]."\")"); | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment