Home

Script: format_lines.pl

Format the output of each line. (for WeeChat ≥ 0.3.0, requires: Text::Format)
Author: R1cochet, version 1.5, GPL3 — added: 2013-01-17
  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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
# Copyright (c) 2013 by R1cochet DeltaXrho@gmail.com
# All rights reserved
#
# 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/>.
#
#

# Changelog:
# 2013-01-16, R1cochet
#     version 1.5: Fixed error where filtered lines would still show blank lines (found by Nei). Added option to hide prefix on formatted lines (suggested by Nei).
# 2013-01-15, R1cochet
#     version 1.4: Initial release


use strict;
use warnings;
use Text::Format;

my $VERSION = "1.5";
my $SCRIPT_DESC = "format the output of each line.";

weechat::register("format_lines", "R1cochet", $VERSION, "GPL3", $SCRIPT_DESC, "", "");

# initialize global variables
my $config_file;        # config pointer
my %config_section;     # config section pointer
my %config_options;     # init config options

sub init_config {
    $config_file = weechat::config_new("format_lines", "config_reload_cb", "");
    return if (!$config_file);

    $config_section{'lists'} = weechat::config_new_section($config_file, "lists", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'lists'}) {
        weechat::config_free($config_file);
        return;
    }
    $config_options{'blacklist_buffer'} = weechat::config_new_option($config_file, $config_section{'lists'}, "blacklist_buffer", "string",
                                                                       "Comma separated list of buffers to ignore.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'blacklist_nick'} = weechat::config_new_option($config_file, $config_section{'lists'}, "blacklist_nick", "string",
                                                                       "Comma separated list of nicks to ignore.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'blacklist_plugin'} = weechat::config_new_option($config_file, $config_section{'lists'}, "blacklist_plugin", "string",
                                                                       "Comma separated list of plugins to ignore.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'blacklist_server'} = weechat::config_new_option($config_file, $config_section{'lists'}, "blacklist_server", "string",
                                                                       "Comma separated list of servers to ignore.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'blacklist_tags'} = weechat::config_new_option($config_file, $config_section{'lists'}, "blacklist_tags", "string",
                                                                       "Comma separated list of tags to ignore.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'whitelist_buffer'} = weechat::config_new_option($config_file, $config_section{'lists'}, "whitelist_buffer", "string",
                                                                       "Comma separated list of buffers to always format.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'whitelist_nick'} = weechat::config_new_option($config_file, $config_section{'lists'}, "whitelist_nick", "string",
                                                                       "Comma separated list of nicks to always format.", "", 0, 0, "", "", 1, "", "", "", "", "", "",);

    $config_section{'look'} = weechat::config_new_section($config_file, "look", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'look'}) {
        weechat::config_free($config_file);
        return;
    }
    $config_options{'ignore_empty_lines'} = weechat::config_new_option($config_file, $config_section{'look'}, "ignore_empty_lines", "boolean",
                                                                       "Ignore lines with no text. (will not insert blank lines if there is no text)", "", 0, 0, "on", "on", 0, "", "", "", "", "", "",);
    $config_options{'print_blank_lines'} = weechat::config_new_option($config_file, $config_section{'look'}, "print_blank_lines", "boolean",
                                                                       "Print blank lines between each line of text.", "", 0, 0, "on", "on", 0, "", "", "", "", "", "",);
    $config_options{'number_of_lines'} = weechat::config_new_option($config_file, $config_section{'look'}, "number_of_lines", "integer",
                                                                       "Number of blank lines to print after each line of text.", "", 1, 4, "1", "1", 0, "", "", "", "", "", "",);
    $config_options{'hide_formatted_prefix'} = weechat::config_new_option($config_file, $config_section{'look'}, "hide_formatted_prefix", "boolean",
                                                                        "Prevent prefix from showing on formatted lines.", "", 0, 0, "off", "off", 0, "", "", "", "", "", "",);
    $config_options{'hide_timestamp'} = weechat::config_new_option($config_file, $config_section{'look'}, "hide_timestamp", "boolean",
                                                                       "Prevent timestamp from showing on inserted blank lines.", "", 0, 0, "on", "on", 0, "", "", "", "", "", "",);
    $config_options{'max_line_length'} = weechat::config_new_option($config_file, $config_section{'look'}, "max_line_length", "integer",
                                                                       "Maximum length of line before it is split. (Split occurs at max length or before)", "", 0, 256, "72", "72", 0, "", "", "", "", "", "",);
    $config_options{'indent_width'} = weechat::config_new_option($config_file, $config_section{'look'}, "indent_width", "integer",
                                                                       "Number of spaces to insert in front of first split line. (Paragraph style formatting)", "", 0, 16, "4", "4", 0, "", "", "", "", "", "",);
}

sub config_reload_cb {
    return weechat::config_reload($config_file);
}

sub config_read {
    return weechat::config_read($config_file);
}

sub config_write {
    return weechat::config_write($config_file);
}

### initialize config
init_config();
config_read();

my $text = Text::Format->new;
$text->columns(weechat::config_integer($config_options{'max_line_length'}));
$text->firstIndent(weechat::config_integer($config_options{'indent_width'}));

weechat::hook_config("format_lines.look.*", "config_cb", "");
sub config_cb {
    my ($data, $option, $value) = @_;
    return weechat::WEECHAT_RC_OK if ($option !~ /^format_lines\.look\./);
    if ($option =~ /^format_lines\.look\.max_line_length$/) {
        $text->columns($value);
    }
    if ($option =~ /^format_lines\.look\.indent_width$/) {
        $text->firstIndent($value);
    }
    return weechat::WEECHAT_RC_OK;
}


weechat::hook_modifier("weechat_print", "format_lines_cb", "");

sub nick_wl {
    my ($tags, $nick_list) = (shift, weechat::config_string($config_options{'whitelist_nick'}));
    my @nick_list = split ",", $nick_list;
    foreach(@nick_list) {
        return 1 if $tags =~ /.*,nick_\Q$_\E,/i;
    }
    return 0;
}
sub buffer_wl {
    my ($buffer_name, $buffer_list) = (shift, weechat::config_string($config_options{'whitelist_buffer'}));
    my @buffer_list = split ",", $buffer_list;
    foreach(@buffer_list) {
        return 1 if $buffer_name =~ /^\Q$_\E\z/i;
    }
    return 0;
}

sub buffer_bl {
    my ($buffer, $buffer_list) = (shift, weechat::config_string($config_options{'blacklist_buffer'}));
    my @buffer_list = split ",", $buffer_list;
    foreach(@buffer_list) {
        return 1 if $buffer =~ /^\Q$_\E\z/i;
    }
    return 0;
}
sub nick_bl {
    my ($tags, $nick_list) = (shift, weechat::config_string($config_options{'blacklist_nick'}));
    my @nick_list = split ",", $nick_list;
    foreach(@nick_list) {
        return 1 if $tags =~ /.*,nick_\Q$_\E,/i;
    }
    return 0;
}
sub plugin_bl {
    my ($plugin, $plugin_list) = (shift, weechat::config_string($config_options{'blacklist_plugin'}));
    my @plugin_list = split ",", $plugin_list;
    foreach(@plugin_list) {
        return 1 if $plugin =~ /^\Q$_\E\z/;
    }
    return 0;
}
sub server_bl {
    my ($server, $server_list) = (shift, weechat::config_string($config_options{'blacklist_server'}));
    my @server_list = split ",", $server_list;
    foreach(@server_list) {
        return 1 if $server =~ /^\Q$_\E\z/;
    }
    return 0;
}
sub tags_bl {
    my ($tags, $tags_list) = (shift, weechat::config_string($config_options{'blacklist_tags'}));
    my @tags_list = split ",", $tags_list;
    foreach(@tags_list) {
        return 1 if $tags =~ /\Q$_\E/i;
    }
    return 0;
}

sub print_blank_lines {
    my ($tag, $buffer, $tab) = (shift, shift, "\t\t");
    $tag =~ s/(^|,)nick_.*?(,|$)// if $tag =~ /irc_privmsg/;
    $tab = "\t" unless (weechat::config_boolean($config_options{'hide_timestamp'}));
    my $blank_lines = weechat::config_integer($config_options{'number_of_lines'});
    for (1..$blank_lines) {
        weechat::print_date_tags($buffer, 0, $tag, $tab);
    }
}

sub print_formatted {
    my ($buffer, $tags, $string) = @_;
    my ($prefix, $msg) = split /\t/, $string;

    if ($msg && length(weechat::string_remove_color($msg, "")) > weechat::config_integer($config_options{'max_line_length'}) ) {
        my @formatted_lines = split /\n/, $text->format($msg);
        for (my $i = 0; $i <= $#formatted_lines; $i++) {
            if ($i > 0 && weechat::config_boolean($config_options{'hide_formatted_prefix'})) {
                weechat::print_date_tags($buffer, 0, $tags, "\t$formatted_lines[$i]");
                print_blank_lines($tags, $buffer) if (weechat::config_boolean($config_options{'print_blank_lines'}));
            }
            else {
                weechat::print_date_tags($buffer, 0, $tags, "$prefix\t$formatted_lines[$i]");
                print_blank_lines($tags, $buffer) if (weechat::config_boolean($config_options{'print_blank_lines'}));
            }
        }
    }
    else {
        weechat::print_date_tags($buffer, 0, $tags, $string);
        print_blank_lines($tags, $buffer) if (weechat::config_boolean($config_options{'print_blank_lines'}));
    }
}

sub format_lines_cb {
    my ($data, $modifier, $modifier_data, $string) = @_;

    if (weechat::config_boolean($config_options{'ignore_empty_lines'})) {
        return $string if ($string eq "");
    }

    my ($plugin, $buffer_name, $tags) = split ";", $modifier_data;
    my $buffer = weechat::buffer_search($plugin, $buffer_name);
    my ($server, $channel) = split /\./, $buffer_name, 2;
    my ($prefix, $msg) = split /\t/, $string;

    # whitelists
    if ($channel) {
        if (weechat::config_string($config_options{'whitelist_buffer'}) ne "") {
            if (buffer_wl($channel)) {
                print_formatted($buffer, $tags, $string);
                return "";
            }
        }
    }
    if ($tags =~ /nick_/) {
        if (weechat::config_string($config_options{'whitelist_nick'}) ne "") {
            if (nick_wl($tags)) {
                print_formatted($buffer, $tags, $string);
                return "";
            }
        }
    }
    # blacklists
    if (weechat::config_string($config_options{'blacklist_plugin'}) ne "") {
        if (plugin_bl($plugin)) {
            return $string;
        }
    }
    if (weechat::config_string($config_options{'blacklist_server'}) ne "") {
        if (server_bl($server)) {
            return $string;
        }
    }
    if ($channel) {
        if (weechat::config_string($config_options{'blacklist_buffer'}) ne "") {
            if (buffer_bl($channel)) {
                return $string;
            }
        }
    }
    if (weechat::config_string($config_options{'blacklist_tags'}) ne "") {
        if (tags_bl($tags)) {
            return $string;
        }
    }
    if (weechat::config_string($config_options{'blacklist_nick'}) ne "") {
        if (nick_bl($tags)) {
            return $string;
        }
    }

    print_formatted($buffer, $tags, $string);
    return "";
}