summaryrefslogtreecommitdiffstats
path: root/scripts/active_notice.pl
blob: 7a851a6436347f64dd4b855d63b43e058c65a435 (plain)
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
#!/usr/bin/perl -w

## Bugreports and Licence disclaimer.
#
# For bugreports and other improvements contact Geert Hauwaerts <geert@hauwaerts.be>
#
#   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 2 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 script; if not, write to the Free Software Foundation, Inc., 59 Temple
#   Place, Suite 330, Boston, MA  02111-1307  USA.
##


## Documentation.
#
# Versioning:
#
#   This script uses the YEAR.FEATURE.REVISION versioning scheme and must abide
#   by the follwing rules:
#   
#       1) when adding a new feature, you must increase the FEATURE
#          numeric by one;
#       
#       2) when fixing a bug, you must increase the REVISION numeric
#          by one; and
#       
#       3) the first feature or bug change in any given year must set the YEAR
#          numeric to the two digit representation of the current year, and
#          reset the FEATURE and REVISION numerics to 01.
#
# Settings:
#
#   active_notice_show_in_status_window
#   
#       When enabled, notices will also be sent to the status window.
##


##
# Load the required libraries.
##

use strict;
use Irssi;
use vars qw($VERSION %IRSSI);


##
# Declare the administrative information.
##

$VERSION = '18.01.01';

%IRSSI = (
    authors     => 'Geert Hauwaerts',
    contact     => 'geert@hauwaerts.be',
    name        => 'active_notice.pl',
    description => 'This script shows incoming notices into the active channel.',
    license     => 'GNU General Public License',
    url         => 'https://github.com/GeertHauwaerts/irssi-scripts/blob/master/src/active_notice.pl',
    changed     => '2018-07-27',
);


##
# Register the custom theme formats.
##

Irssi::theme_register([
    'active_notice_loaded', '%R>>%n %_Scriptinfo:%_ Loaded $0 version $1 by $2.'
]);


## Function.
#
# Irssi::active_notice::notice_move() function.
#
#   Function:       notice_move()
#   Arguments:      The destination.
#                   The text.
#                   The stripped text.
#   
#   Description:    Print received notices into the active window.
##

sub notice_move {
    
    
    ##
    # Parse the parameters.
    ##
    
    my ($dest, $text, $stripped) = @_;
    my $server                   = $dest->{'server'};
    
    
    ##
    # Check whether the message is irrelevant.
    ##
    
    if (!$server || !($dest->{level} & MSGLEVEL_NOTICES) || $server->ischannel($dest->{'target'})) {
        return;
    }
    
    
    ##
    # Fetch the source, destination and status windows.
    ##
    
    my $witem  = $server->window_item_find($dest->{'target'});
    my $status = Irssi::window_find_name("(status)");
    my $awin   = Irssi::active_win();
    
    
    ##
    # Check whether we have a window for the source of the notice.
    ##
    
    if (!$witem) {
        
        
        ##
        # Check whether the notice originated from the status window.
        ##
        
        if ($awin->{'name'} eq "(status)") {
            return;
        }
        
        ##
        # replace a single % with %%. (by  Dwarf <dwarf@rizon.net>) 
        ##
        
		$text =~ s/%/%%/g;

        ##
        # Print the notice in the active window.
        ###
        
        $awin->print($text, MSGLEVEL_NOTICES);
        
        
        ##
        # Check whether the notice needs to be printed in the status window.
        ##
        
        if (!Irssi::settings_get_bool('active_notice_show_in_status_window')) {
            Irssi::signal_stop();
        }
    } else {
        
        
        ##
        # Check whether we need to print the notice in the status window.
        ##
        
        if (($awin->{'name'} ne "(status)") && (Irssi::settings_get_bool('active_notice_show_in_status_window'))) {
            $status->print($text, MSGLEVEL_NOTICES);
        }
        
        
        ##
        # Check whether the notice originated from the active window.
        ##
        
        if ($witem->{'_irssi'} == $awin->{'active'}->{'_irssi'}) {
            return;
        }
        
        
        ##
        # Print the notice in the active window.
        ##
        
        $awin->print($text, MSGLEVEL_NOTICES);
    }
}


##
# Register the signals to hook on.
##

Irssi::signal_add('print text', 'notice_move');


##
# Register the custom settings.
##

Irssi::settings_add_bool('active_notice', 'active_notice_show_in_status_window', 1);


##
# Display the script banner.
##

Irssi::printformat(MSGLEVEL_CLIENTCRAP, 'active_notice_loaded', $IRSSI{name}, $VERSION, $IRSSI{authors});