Script: notifym.pl

Highly configurable send-notify script for user, channel and server messages.
Author: dmitescu — Version: 1.2 — License: GPL3
For WeeChat ≥ 0.3.4.
Added: 2017-05-08 — Updated: 2019-04-13
Download

  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
#
# Copyright (c) 2016-2019 Mitescu George Dan <mitescugd@gmail.com>
# Copyright (c) 2019 Silvan Mosberger <infinisil@icloud.com>
# Copyright (c) 2016 Berechet Mihai <mihaibereket9954@gmail.com>
#
# 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/>.
#

my $SCRIPT_NAME = "notifym";
my $VERSION = "1.2";

# use Data::Dumper;

weechat::register($SCRIPT_NAME, "dmitescu", $VERSION, "GPL3", 
		  "Script which uses libnotify to alert the user about certain events.",
		  "", "");

my %options_def = ( 'notify_pv'         => ['on',
					    'Notify on private message.'],
		    'notify_mentions'    => ['on',
					    'Notify on mention in all channel.'],
		    'notify_channels'   => ['off',
					    'Notify all messages from whitelisted channels.'],
		    'notify_servers'    => ['off',
					    'Notify all messages from whitelisted servers.'],
		    'channel_whitelist' => ['.*',
					    'Channel white-list. (perl regex required)'],
		    'server_whitelist'  => ['.*',
					    'Server white-list. (perl regex required)']
    );

my %options = ();

# Initiates options if non-existent and loads them
sub init {
    foreach my $opt (keys %options_def) {
	if (!weechat::config_is_set_plugin($opt)) {
	    weechat::config_set_plugin($opt, $options_def{$opt}[0]);
	}
	$options{$opt} = weechat::config_get_plugin($opt);
	weechat::config_set_desc_plugin($opt, $options_def{$opt}[1]
					. " (default: \"" . $options_def{$opt}[0]
					. "\")");
    }
}

# On update option, load it into the hash
sub update_config_handler {
    my ($data, $option, $value) = @_;
    $name = substr($option, 
		   length("plugins.var.perl.".$SCRIPT_NAME."."), 
		   length($option));
    $options{$name} = $value;
    # weechat::print("", $name . " is now " . $value . "!");
    return weechat::WEECHAT_RC_OK;
}

# Function to send notification
sub send_notification {
    my ($urgency, $summary, $body) = @_;
    my $retval = system("notify-send", "-u", $urgency, $summary, $body);
}

# Verify matching options
sub opt_match {
	my ($str, $option) = @_;
	return $str =~ /$options{$option}/;
}

# Handlers for signals :
# Private message

sub message_handler {
    my ($data, $signal, $signal_data) = @_;
    # my @pta = split(":", $signal_data);
    # weechat::print("", Dumper(\%options));
    my ($server, $command) = $signal =~ /(.*),irc_in_(.*)/;
    if ($command eq 'PRIVMSG') {
	my $hash_in = {"message" => $signal_data};
	my $hash_data = weechat::info_get_hashtable("irc_message_parse", $hash_in);

	my $nick = $hash_data->{"nick"};
	my $text = $hash_data->{"text"};
	my $chan = $hash_data->{"channel"};
	
	if (($options{'notify_servers'} eq 'on') && 
	    opt_match($server, 'server_whitelist')) {
	    # Server match
	    send_notification("normal", "$nick:", "$text");
	} elsif (($options{'notify_channels'} eq 'on') &&
		 opt_match($chan, 'channel_whitelist')){
	    # Channel match
	    send_notification("normal", "$nick:", "$text");
	} elsif ($options{'notify_pv'} eq 'on') {
	    # Private message match
	    my $mynick = weechat::info_get("irc_nick", $server);
	    if ($chan eq $mynick) {
		send_notification("critical", "$nick says:", "$text");
	    }
	} else {
	}
	
	# Mention match
	my $mynick = weechat::info_get("irc_nick", $server);
	if (index($text, $mynick) != -1) {
	    send_notification("critical", "$nick mentioned you!", "");
	}	
	# weechat::print("", Dumper($hash_data));
    }
    return weechat::WEECHAT_RC_OK;
}

# Main execution point

init();
send_notification("critical",
		  "Starting NotifyM plugin, version " . $VERSION . "!",
		  "");
weechat::hook_config("plugins.var.perl." . $SCRIPT_NAME . ".*",
		     "update_config_handler", "");
weechat::hook_signal("*,irc_in_*", "message_handler", "");