yaurls.pl 15.7 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
# Copyright (c) 2012 by R1cochet R1cochet@hushmail.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/>.
#
#
18
# yaURLs, version 1.9, for weechat version 0.3.7 or later
19 20
# will shorten URL's in channels
#
21 22
# Shorten URL's using any of the following services:
# durl.me, is.gd, ln-s.net, lytn.it, metamark.net, sapo.pt, safe.mn, tinyURL.com
23 24 25 26 27 28 29
#
# Default color theme in 256color terminal
# header: 46
# prefix/suffix: *200
# url: *190
# domain: 196
#
30 31
#
# Changelog:
32 33
# 2012-09-21, R1cochet
#     version 1.9: Added more shortening services
34 35
# 2012-03-09, Sebastien Helleu <flashcode@flashtux.org>
#     version 1.8: Fix reload of config file
36 37 38 39 40 41
# 2012-03-08, R1cochet
#     version 1.7: Removed need for Regexp::Common and URI::Escape modules. Cleaned up some code
# 2012-03-04, R1cochet
#     version 1.6: Fixed error with twitter links not being recognized. Added module URI::Escape to properly format URL's before shortening
# 2012-02-28, R1cochet
#     version 1.5: Initial release
42 43 44 45 46 47

use strict;
use warnings;

my $SCRIPT_NAME = "yaurls";
my $SCRIPT_AUTHOR = "R1cochet";
48
my $VERSION = "1.9";
49 50 51 52 53 54 55 56 57
my $SCRIPT_LICENSE = "GPL3";
my $SCRIPT_DESC = "yes, another URL shortener";

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

58 59 60 61 62 63
my %Unsafe = (RFC3986 => qr/[^A-Za-z0-9\-\._~]/,);
my %escapes;
for (0..255) {
    $escapes{chr($_)} = sprintf("%%%02X", $_);
}

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
weechat::register($SCRIPT_NAME, $SCRIPT_AUTHOR, $VERSION, $SCRIPT_LICENSE, $SCRIPT_DESC, "", "");

### initial config
sub init_config {
    $config_file = weechat::config_new("yaurls", "config_reload_cb", "");
    return if (!$config_file);

    # create new section in config file
    $config_section{'blacklists'} = weechat::config_new_section($config_file, "blacklists", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'blacklists'}) {
        weechat::config_free($config_file);
        return;
    }
    # add the options to the section
    $config_options{'channel_blacklist'} = weechat::config_new_option($config_file, $config_section{'blacklists'}, "channel_blacklist", "string",
                                                                       "Comma seperated list of Channels to ignore", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'nick_blacklist'} = weechat::config_new_option($config_file, $config_section{'blacklists'}, "nick_blacklist", "string",
                                                                       "Comma seperated list of Nicks to ignore", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'server_blacklist'} = weechat::config_new_option($config_file, $config_section{'blacklists'}, "server_blacklist", "string",
                                                                       "Comma seperated list of Servers to ignore", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'string_blacklist'} = weechat::config_new_option($config_file, $config_section{'blacklists'}, "string_blacklist", "string",
                                                                       "Comma seperated list of Strings to ignore", "", 0, 0, "", "", 1, "", "", "", "", "", "",);
    $config_options{'url_blacklist'} = weechat::config_new_option($config_file, $config_section{'blacklists'}, "url_blacklist", "string",
                                                                       "Comma seperated list of URL's to ignore", "", 0, 0, "youtube.com", "youtube.com", 1, "", "", "", "", "", "",);

    $config_section{'colors'} = weechat::config_new_section($config_file, "colors", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'colors'}) {
        weechat::config_free($config_file);
        return;
    }
    $config_options{'header_color'} = weechat::config_new_option($config_file, $config_section{'colors'}, "header_color", "color",
                                                                       "Set the color of the header", "", 0, 0, "green", "green", 0, "", "", "", "", "", "",);
    $config_options{'prefix_color'} = weechat::config_new_option($config_file, $config_section{'colors'}, "prefix_suffix_color", "color",
                                                                       "Set the color of the prefix and suffix", "", 0, 0, "magenta", "magenta", 0, "", "", "", "", "", "",);
    $config_options{'url_color'} = weechat::config_new_option($config_file, $config_section{'colors'}, "url_color", "color",
                                                                       "Set the color of the tinyURL link", "", 0, 0, "yellow", "yellow", 0, "", "", "", "", "", "",);
    $config_options{'domain_color'} = weechat::config_new_option($config_file, $config_section{'colors'}, "domain_color", "color",
                                                                       "Set the color of the domain name", "", 0, 0, "blue", "blue", 0, "", "", "", "", "", "",);

    $config_section{'engine'} = weechat::config_new_section($config_file, "engine", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'engine'}) {
        weechat::config_free($config_file);
        return;
    }
    $config_options{'service'} = weechat::config_new_option($config_file, $config_section{'engine'}, "service", "integer",
109 110 111
                                                                       "Set which shortener service to use (durl = durl.me, is.gd = is.gd, ln-s = ln-s.net, lytn = lytn.it, ".
                                                                       "metamark = metamark.net, punyURL = sapo.pt, safe = safe.mn, tinyURL = tinyURL.com)",
                                                                       "durl|is.gd|ln-s|lytn|metamark|punyURL|safe|tinyURL", 0, 0, "tinyURL", "tinyURL", 0, "", "", "", "", "", "");
112 113 114
    $config_options{'convert_own'} = weechat::config_new_option($config_file, $config_section{'engine'}, "convert_own", "boolean",
                                                                       "Convert own links sent to buffer", "", 0, 0, "off", "off", 0, "", "", "", "", "", "",);
    $config_options{'maximum_length'} = weechat::config_new_option($config_file, $config_section{'engine'}, "maximum_length", "integer",
115 116 117
                                                                       "Set the maximum length of URL's to be converted (anything equal to or larger will be converted)", "", 20, 500, "35", "35", 0, "", "", "", "", "", "");
    $config_options{'timeout'} = weechat::config_new_option($config_file, $config_section{'engine'}, "timeout", "integer",
                                                                       "Set the maximum time limit for fetching the short URL (time in seconds)", "", 10, 120, "20", "20", 0, "", "", "", "", "", "");
118 119 120 121 122 123 124

    $config_section{'look'} = weechat::config_new_section($config_file, "look", 0, 0, "", "", "", "", "", "", "", "", "", "");
    if (!$config_section{'look'}) {
        weechat::config_free($config_file);
        return;
    }
    $config_options{'header'} = weechat::config_new_option($config_file, $config_section{'look'}, "header", "string",
125
                                                                       "Set the header string", "", 0, 0, "yaURLs", "yaURLs", 1, "", "", "", "", "", "",);
126 127 128 129 130 131 132 133 134
    $config_options{'header_prefix'} = weechat::config_new_option($config_file, $config_section{'look'}, "header_prefix", "string",
                                                                       "Set the header prefix", "", 0, 0, "{", "{", 1, "", "", "", "", "", "",);
    $config_options{'header_suffix'} = weechat::config_new_option($config_file, $config_section{'look'}, "header_suffix", "string",
                                                                       "Set the header suffix", "", 0, 0, "}~>", "}~>", 1, "", "", "", "", "", "",);
    $config_options{'format'} = weechat::config_new_option($config_file, $config_section{'look'}, "format", "string",
                                                                       "Set the print format (%H = Header, %U = tinyURL, %D = Domain)", "", 0, 0, "%H %U %D", "%H %U %D", 0, "", "", "", "", "", "",);
}
# intit callbacks
sub config_reload_cb {      # reload config file
135
    return weechat::config_reload($config_file);
136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157
}

sub config_read {           # read my config file
    return weechat::config_read($config_file);
}

sub config_write {          # write to my config file
    return weechat::config_write($config_file);
}

init_config();              # load config
config_read();              # get options if already in config file

weechat::hook_print( "", "irc_privmsg", "://", 1, "print_hook_cb", "");         # Hook into print

sub build_header {
    my $header = weechat::color(weechat::config_color($config_options{'header_color'})) . weechat::config_string($config_options{'header'}) . weechat::color("reset");
    $header = weechat::color(weechat::config_color($config_options{'prefix_color'})) . weechat::config_string($config_options{'header_prefix'}) . weechat::color("reset") . $header;
    $header = $header . weechat::color(weechat::config_color($config_options{'prefix_color'})) . weechat::config_string($config_options{'header_suffix'}) . weechat::color("reset");
    return $header;
}

158
sub black_list1 {       # match url, string
159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175
    my ($string, $black_list) = @_;
    my @black_list = split ",", $black_list;
    foreach(@black_list) {
        return 1 if $string =~ /\Q$_\E/i;
    }
    return 0;
}

sub black_list2 {       # match nick, server, channel; front to end
    my ($string, $black_list) = @_;
    my @black_list = split ",", $black_list;
    foreach(@black_list) {
        return 1 if $string =~ /^\Q$_\E\z/;
    }
    return 0;
}

176 177 178 179 180 181 182
sub uri_escape {
    my $url = shift;
    utf8::encode($url);
    $url =~ s/($Unsafe{RFC3986})/$escapes{$1}/ge;
    return $url;
}

183 184
sub service_url {
    my $url = shift;
185
    $url = uri_escape($url);
186

187 188 189 190
    if (weechat::config_string($config_options{'service'}) eq "durl") {
        $url = "http://durl.me/api/Create.do?longurl=$url";
    }
    elsif (weechat::config_string($config_options{'service'}) eq "is.gd") {
191 192 193 194 195
        $url = "http://is.gd/create.php?format=simple&url=$url";
    }
    elsif (weechat::config_string($config_options{'service'}) eq "ln-s") {
        $url = "http://ln-s.net/home/api.jsp?url=$url";
    }
196 197 198 199 200 201 202 203 204 205 206 207
    elsif (weechat::config_string($config_options{'service'}) eq "lytn") {
        $url = "http://lytn.it/api.php?rel=2&link=$url";
    }
    elsif (weechat::config_string($config_options{'service'}) eq "metamark") {
        $url = "http://metamark.net/api/rest/simple?long_url=$url";
    }
    elsif (weechat::config_string($config_options{'service'}) eq "punyURL") {
        $url = "http://services.sapo.pt/PunyURL/GetCompressedURLByURL?url=$url";
    }
    elsif (weechat::config_string($config_options{'service'}) eq "safe") {
        $url = "http://safe.mn/api/?format=text&url=$url";
    }
208 209 210 211 212 213 214 215 216 217
    else {
        $url = "http://tinyurl.com/api-create.php?url=$url";
    }

    return $url;
}

sub process_cb {
    my ($buffer_domain, $command, $return_code, $out, $err) = @_;

218
    if ($return_code != 0) { # weechat::WEECHAT_HOOK_PROCESS_ERROR
219
        weechat::print("", "Error with command: $command");
220 221
        weechat::print("", "An error occured: $err") if ($err ne "");
        weechat::print("", "ret code: $return_code");
222
    }
223
    elsif ($out) {
224 225 226 227
        my ($buffer, $domain) = split "_:_", $buffer_domain, 2;
        my $header = build_header();
        $domain = weechat::color(weechat::config_color($config_options{'domain_color'})) . "($domain)" . weechat::color("reset");

228 229 230 231
        if (weechat::config_string($config_options{'service'}) eq "durl") {
            ($out) = $out =~ m/(http:\/\/durl\.me\/\w+)/;
        }
        elsif (weechat::config_string($config_options{'service'}) eq "ln-s") {
232 233
            $out =~ s/^(\d{3}\s)|\n*$//g;
        }
234 235 236 237 238 239 240 241
        elsif (weechat::config_string($config_options{'service'}) eq "punyURL") {
            weechat::print("", "punyURL called");
            ($out) = $out =~ m/.+\<ascii\>(.+)\<\/ascii\>/;
        }
        elsif (weechat::config_string($config_options{'service'}) eq "safe") {
            $out =~ s/\n*//g;
        }

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 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
        my $short_url = weechat::color(weechat::config_color($config_options{'url_color'})) . $out . weechat::color("reset");
        my $tiny_url = weechat::config_string($config_options{'format'});

        $tiny_url =~ s/%H/$header/;
        $tiny_url =~ s/%U/$short_url/;
        $tiny_url =~ s/%D/$domain/;
        weechat::print($buffer, "$tiny_url");
    }
    return weechat::WEECHAT_RC_OK;
}

sub print_hook_cb {
    my ($data, $buffer, $date, $tags, $displayed, $highlight, $prefix, $msg) = @_;
    return weechat::WEECHAT_RC_OK if ($displayed != 1);     # return if initial message wont be shown

    if ((weechat::config_string($config_options{'string_blacklist'})) ne "") {      # check message against "string blacklist"
        return weechat::WEECHAT_RC_OK if (black_list1($msg, weechat::config_string($config_options{'string_blacklist'})));       # return if string is blacklisted
    }

    my $hdata = weechat::hdata_get("buffer");
    my $buffer_name = weechat::hdata_string($hdata, $buffer, "name");
    my ($server, $channel) = split /\./, $buffer_name;  # can be done with a match
    $channel =~ s/#//;

    if ((weechat::config_string($config_options{'server_blacklist'})) ne "") {      # check message against "server blacklist"
        return weechat::WEECHAT_RC_OK if (black_list2($server, weechat::config_string($config_options{'server_blacklist'})));    # return if server is blacklisted
    }

    if ((weechat::config_string($config_options{'channel_blacklist'})) ne "") {     # check message against "channel blacklist"
        return weechat::WEECHAT_RC_OK if (black_list2($channel, weechat::config_string($config_options{'channel_blacklist'})));  # return if nick is blacklisted
    }

    ($incoming_nick = $tags) =~ s/.*nick_//i;
    $incoming_nick =~ s/,.*//i;
    my $own_nick = weechat::info_get("irc_nick", $server);

    if (!weechat::config_boolean($config_options{'convert_own'})) {                 # check if converting own
        return weechat::WEECHAT_RC_OK if $incoming_nick =~ /^\Q$own_nick\E\z/;
    }

    if ((weechat::config_string($config_options{'nick_blacklist'})) ne "") {        # check message against "nick blacklist"
        return weechat::WEECHAT_RC_OK if (black_list2($incoming_nick, weechat::config_string($config_options{'nick_blacklist'})));        # return if nick is blacklisted
    }

    my @msg = split " ", $msg;
    foreach(@msg) {
288
        if ($_ =~ /^(ht|f)tp/ && $_ =~ m|(?:([^:/?#]+):)?(?://([^/?#]*))?([^?#]*)(?:\?([^#]*))?(?:#(.*))?|) {
289 290 291
            next if (length($_) <= weechat::config_integer($config_options{'maximum_length'}));        # skip if url shorter than max

            if (weechat::config_string($config_options{'url_blacklist'}) ne "") {
292
                next if (black_list1($_, weechat::config_string($config_options{'url_blacklist'})));     # skip if url is blacklisted
293
            }
294 295
            my $buffer_domain = $buffer."_:_$2";
            my $url = service_url($_);
296

297
            weechat::hook_process("url:$url", weechat::config_integer($config_options{'timeout'}) * 1000, "process_cb", $buffer_domain);
298 299 300 301
        }
    }
    return weechat::WEECHAT_RC_OK;
}