/usr/share/weechat/perl/beep.pl is in weechat-scripts 20140928-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 | #
# 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]."\")");
}
}
}
|