# erkSearch - IRC network finder for irssi # ---------------------------------------- # Searches the erkstats public API for IRC networks and lets you connect. No API # key needed - the API is public. Results print to the window you searched from, # numbered, and you connect by number. Lookups run in the background, so irssi # never freezes while one is on its way. # # Install: save this file to ~/.irssi/scripts/ and run: /script load erksearch # (to load it on every start, link it into ~/.irssi/scripts/autorun/) # Needs: irssi 0.8.15 or newer. Uses Perl's built-in HTTP::Tiny when # IO::Socket::SSL is installed, and falls back to curl otherwise. # # Commands: # /erksearch [sort=..] [lang=..] [show=N] search by keyword: names, descriptions, # tags and languages, best match first # /erksearch tag= [terms] [..] networks with that tag # /erksearch [sort=..] [lang=..] [show=N] (no terms) browse the top networks # /erkinfo full details for result n # /erkconnect connect to result n # /erk show help # # sort = best (default for a search) | users (default for browsing) | 30d | channels # | servers | name | newest | oldest # e.g. /erksearch linux /erksearch tag=gaming /erksearch sort=newest lang=german show=25 use strict; use warnings; use Irssi; use POSIX (); use JSON::PP (); our $VERSION = '1.1'; our %IRSSI = ( authors => 'erkstats', contact => 'https://erkstats.info/contact', name => 'erksearch', description => 'Find IRC networks via the erkstats public API', url => 'https://erkstats.info/api#scripts', ); my $API = 'https://erkstats.info/api/v1/public'; my $AGENT = "erksearch-irssi/$VERSION"; my @last; # last result list (array of network hashes) my $busy = 0; # a lookup is on its way # friendly sort name -> [api sort, dir] my %SORTS = ( best => ['relevance', 'desc'], users => ['users', 'desc'], '30d' => ['users_30d', 'desc'], avg => ['users_30d', 'desc'], channels => ['channels', 'desc'], servers => ['servers', 'desc'], name => ['name', 'asc'], newest => ['founded', 'desc'], oldest => ['founded', 'asc'], age => ['founded', 'asc'], ); # ---- helpers ----------------------------------------------------------------- # irssi reads % as a format code: double it in anything that came from outside sub esc { my $s = shift // ''; $s =~ s/%/%%/g; return $s } sub out { my ($win, $text) = @_; $win = Irssi::active_win() unless $win && Irssi::window_find_refnum($win->{refnum}); $win->print($text, MSGLEVEL_CLIENTCRAP); } sub say { my ($win, $msg) = @_; out($win, "%_erkSearch%_ $msg") } sub comma { my $n = shift; return '?' unless defined $n; 1 while $n =~ s/^(\d+)(\d{3})/$1,$2/; return $n; } sub trunc { my ($s, $n) = @_; $s //= ''; return length($s) <= $n ? $s : substr($s, 0, $n - 1) . '~'; } sub urlencode { my $s = shift; utf8::encode($s) if utf8::is_utf8($s); $s =~ s/([^A-Za-z0-9._~-])/sprintf('%%%02X', ord $1)/ge; return $s; } # ---- fetching (in a child process, so irssi keeps running) -------------------- # runs in the child: returns the response body, or dies with a reason sub http_get { my $url = shift; require HTTP::Tiny; if (HTTP::Tiny->can_ssl) { my $res = HTTP::Tiny->new(agent => $AGENT, timeout => 15)->get($url); # a 4xx from the API still carries a JSON {"error": ...} worth showing return $res->{content} if $res->{status} != 599 && ($res->{content} // '') =~ /^\s*\{/; die $res->{status} == 599 ? "$res->{content}\n" : "HTTP $res->{status} $res->{reason}\n"; } open(my $fh, '-|', 'curl', '-sS', '--max-time', '15', '-A', $AGENT, $url) or die "no HTTPS support: install IO::Socket::SSL or curl\n"; local $/; my $body = <$fh>; close $fh; die "no response (network error, or curl missing)\n" unless defined $body && length $body; return $body; } # fetch $url in the background, then call $done->($data) or $done->(undef, $error) sub fetch { my ($url, $done) = @_; pipe(my $rd, my $wr) or return $done->(undef, "could not start a lookup: $!"); my $pid = fork(); if (!defined $pid) { close $rd; close $wr; return $done->(undef, "could not start a lookup: $!"); } if ($pid == 0) { close $rd; my $body = eval { http_get($url) }; print $wr defined $body ? "OK\n$body" : "ERR\n" . ($@ || 'unknown error'); close $wr; POSIX::_exit(0); } close $wr; Irssi::pidwait_add($pid); my ($buf, $tag) = (''); $tag = Irssi::input_add(fileno($rd), INPUT_READ, sub { my $n = sysread($rd, my $chunk, 65536); if ($n) { $buf .= $chunk; return } Irssi::input_remove($tag); close $rd; my ($status, $body) = split /\n/, $buf, 2; $body //= ''; if (!defined $status || $status ne 'OK') { $body =~ s/\s+$//; return $done->(undef, $body || 'the lookup stopped unexpectedly'); } # bytes in, bytes out: names print as the UTF-8 they arrived in my $data = eval { JSON::PP->new->decode($body) }; return $done->(undef, 'unexpected response from server') unless ref $data eq 'HASH'; return $done->(undef, $data->{error}) if defined $data->{error}; $done->($data); }, ''); } # ---- commands ---------------------------------------------------------------- # pull "sort=.. lang=.. show=.." out of the args; the rest is the query sub parse_args { my %o = (dir => 'desc', show => 10); my @terms; for my $tok (split ' ', shift // '') { if ($tok =~ /^sort=(.+)$/i) { my $s = $SORTS{lc $1} or return (undef, "Unknown sort \"$1\". Use best, users, 30d, channels, servers, name, newest or oldest."); @o{qw(sort dir)} = @$s; } elsif ($tok =~ /^lang=(.+)$/i) { $o{lang} = $1; } elsif ($tok =~ /^tag=#?(.+)$/i) { $o{tag} = $1; } elsif ($tok =~ /^show=(.*)$/i) { my $v = $1; my $n = $v =~ /^\d+$/ ? $v : 10; $o{show} = $n < 1 ? 1 : $n > 100 ? 100 : $n; } else { push @terms, $tok; } } return (join(' ', @terms), \%o); } sub cmd_search { my ($args, $server, $witem) = @_; my $win = $witem ? $witem->window : Irssi::active_win(); my ($query, $o) = parse_args($args); return say($win, esc($o)) unless defined $query; my $tag = $o->{tag}; if ($query ne '' && length($query) < 2 && !defined $tag) { return say($win, 'Enter at least 2 characters to search, or nothing to browse the top networks.'); } return say($win, 'Still waiting for the last search - give it a moment.') if $busy; # a search ranks best match first unless a sort is asked for; browsing has no # "best", so it lists the biggest first my $searching = $query ne '' || defined $tag; my $sort = $o->{sort} // ($searching ? 'relevance' : 'users'); $sort = 'users' if $sort eq 'relevance' && !$searching; my @p = ("sort=$sort", "dir=$o->{dir}", "limit=$o->{show}"); unshift @p, 'q=' . urlencode($query) if $query ne ''; push @p, 'tag=' . urlencode($tag) if defined $tag; push @p, 'lang=' . urlencode($o->{lang}) if defined $o->{lang}; my $url = $API . ($searching ? '/search/network' : '/networks') . '?' . join('&', @p); my $what = join ' ', ($query ne '' ? '"' . esc($query) . '"' : ()), (defined $tag ? 'tag ' . esc($tag) : ()); say($win, $searching ? "Searching for $what ..." : 'Loading top networks ...'); $busy = 1; fetch($url, sub { my ($data, $err) = @_; $busy = 0; return say($win, 'Error: ' . esc($err)) unless $data; @last = @{ $data->{results} || [] }; if (!@last) { return say($win, 'No networks found' . ($searching ? " for $what" : '') . '.'); } say($win, sprintf('%d match(es) for %s - showing %d. /erkconnect N to join, /erkinfo N for details.', $data->{count} // scalar(@last), $searching ? $what : 'top networks', scalar @last)); # the words the search widened to (word forms, related words) my $also = ref $data->{also_matching} eq 'ARRAY' ? $data->{also_matching} : []; say($win, 'Also matching: ' . esc(join ', ', @$also)) if @$also; my $i = 0; for my $nw (@last) { out($win, esc(sprintf('%2d. ', ++$i)) . '%_' . esc(sprintf('%-20s', trunc($nw->{name}, 20))) . '%_ ' . esc(sprintf('%9s users %-10s %-5s %s:%s%s%s', comma($nw->{users}), $nw->{language} // '-', $nw->{founded} // '-', $nw->{server} // '?', $nw->{port} // '?', $nw->{tls} ? ' (TLS)' : '', $nw->{verified} ? ' [verified]' : ''))); } }); } sub pick { my ($n, $win) = @_; my $nw = defined $n && $n =~ /^\s*(\d+)\s*$/ && $1 >= 1 ? $last[$1 - 1] : undef; say($win, 'No result #' . esc($n // '') . '. Run a search first.') unless $nw; return $nw; } sub cmd_info { my ($args, $server, $witem) = @_; my $win = $witem ? $witem->window : Irssi::active_win(); my $nw = pick($args, $win) or return; say($win, '%_' . esc($nw->{name}) . '%_' . ($nw->{verified} ? ' [verified]' : '')); out($win, ' Server: ' . esc("$nw->{server}:$nw->{port}") . ($nw->{tls} ? ' (TLS)' : ' (plain)')); out($win, ' Users: ' . comma($nw->{users}) . ' online, ' . comma($nw->{users_30d_avg}) . ' avg (30d)'); out($win, ' Language: ' . esc($nw->{language})) if defined $nw->{language}; out($win, ' Founded: ' . esc($nw->{founded})) if defined $nw->{founded}; out($win, ' Website: ' . esc($nw->{website})) if defined $nw->{website}; out($win, ' Webchat: ' . esc($nw->{webchat})) if defined $nw->{webchat}; out($win, ' Connect: ' . esc($nw->{connect_uri} // '')); out($win, ' ' . esc($nw->{blurb})) if defined $nw->{blurb}; } sub cmd_connect { my ($args, $server, $witem) = @_; my $win = $witem ? $witem->window : Irssi::active_win(); my $nw = pick($args, $win) or return; # irssi 1.2 renamed -ssl to -tls my $tls = !$nw->{tls} ? '' : Irssi::version() >= 20190211 ? '-tls ' : '-ssl '; say($win, 'Connecting to ' . esc("$nw->{name} ($nw->{server}:$nw->{port})") . ' ...'); Irssi::command("connect $tls$nw->{server} $nw->{port}"); } sub cmd_help { my ($args, $server, $witem) = @_; my $win = $witem ? $witem->window : Irssi::active_win(); say($win, 'commands:'); out($win, ' /erksearch [sort=..] [lang=..] [show=N] - search networks'); out($win, ' /erksearch tag= [terms] - networks with a tag'); out($win, ' /erksearch [sort=..] [lang=..] [show=N] - browse the top networks'); out($win, ' /erkinfo - full details for result n'); out($win, ' /erkconnect - connect to result n'); out($win, ' sort = best | users | 30d | channels | servers | name | newest | oldest'); } Irssi::command_bind('erksearch', \&cmd_search); Irssi::command_bind('erkinfo', \&cmd_info); Irssi::command_bind('erkconnect', \&cmd_connect); Irssi::command_bind('erk', \&cmd_help); say(undef, 'loaded. Type /erk for help, /erksearch to search.');