]> ruderich.org/simon Gitweb - fcscs/fcscs.git/blobdiff - bin/fcscs
allow yanking to X11 selection with new yank_x11 option
[fcscs/fcscs.git] / bin / fcscs
index 5b68c2b022a76f445db3f9c652a7f65e343d9bbb..da614bc396b3af1d6214d42aec7f425fc9fe118f 100755 (executable)
--- a/bin/fcscs
+++ b/bin/fcscs
@@ -102,12 +102,15 @@ or another number to select the longer match. Use backspace to remove the last
 entered number.
 
 Press return before entering a number to select the last (lowest numbered)
-match. To abort without selecting any match either use "q".
+match (underlined by default). To abort without selecting any match use "q".
 
 To change the selection mode (e.g. paths, files, etc.) use one of the mappings
 explained below. Per default URLs are selected, see options for a way to
 change this.
 
+I<NOTE>: Opening URLs in the browser passes the URL via the command line which
+leaks URLs to other users on the current system via C<ps aux> or C<top>.
+
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
 GNU screen/Tmux without exposing it to C<ps aux> or C<top>. However this may
 leak data if those temporary files are written to disk. To prevent this change
@@ -264,6 +267,8 @@ package Screen {
     sub draw_prompt {
         my ($self, $config) = @_;
 
+        $self->debug('draw_prompt', 'started');
+
         my $x = 0;
         my $y = $self->height - 1;
 
@@ -273,17 +278,20 @@ package Screen {
         # Draw prompt flags.
         if (defined (my $s = $self->{prompt}{flags})) {
             $s = "[$s]";
+            $self->debug('draw_prompt', $s);
             $self->draw_clipped($y, $x, $config->{attribute}{prompt_flags}, $s);
             $x += length($s) + 1; # space between next element
         }
         # Draw prompt name.
         if (defined (my $s = $self->{prompt}{name})) {
             $s = "[$s]";
+            $self->debug('draw_prompt', $s);
             $self->draw_clipped($y, $x, $config->{attribute}{prompt_name}, $s);
             $x += length($s) + 1;
         }
         # Draw prompt value, e.g. a search field.
         if (defined (my $s = $self->{prompt}{value})) {
+            $self->debug('draw_prompt', $s);
             $self->draw_clipped($y, $x, undef, $s);
             $x += length($s) + 1;
         }
@@ -299,9 +307,13 @@ package Screen {
 
         my $attr_id     = $config->{attribute}{match_id};
         my $attr_string = $config->{attribute}{match_string};
+        my $attr_last   = $config->{attribute}{match_last};
 
         foreach (@{$matches_add}) {
-            $self->draw($_->{y}, $_->{x}, $attr_string, $_->{string});
+            my $attr = (defined $_->{id} and $_->{id} == 1)
+                     ? $attr_last
+                     : $attr_string;
+            $self->draw($_->{y}, $_->{x}, $attr, $_->{string});
             if (defined $_->{id}) {
                 $self->draw($_->{y}, $_->{x}, $attr_id, $_->{id});
             }
@@ -355,6 +367,9 @@ package Screen {
             }
         }
 
+        foreach (@args) {
+            $_ = $self->encode($_);
+        }
         say $fh "$module: @args";
         return;
     }
@@ -430,7 +445,7 @@ sub get_regex_matches {
 
 
 sub run_command {
-    my ($screen, $config, $cmd) = @_;
+    my ($screen, $cmd) = @_;
 
     $screen->debug('run_command', "running @{$cmd}");
 
@@ -456,7 +471,8 @@ sub run_command {
         # a working $$.
         no warnings;
 
-        system { $cmd->[0] } @{$cmd};
+        my @cmd = map { $screen->encode($_) } @{$cmd};
+        system { $cmd[0] } @cmd;
     };
     if ($exit != 0) {
         my $msg;
@@ -484,11 +500,13 @@ sub run_in_background {
         # closes the window (because the parent process has exited).
         local $SIG{HUP} = 'IGNORE';
 
-        # Necessary for GNU screen or it'll keep the window open until the
-        # paste command has run.
-        close STDIN  or die $!;
-        close STDOUT or die $!;
-        close STDERR or die $!;
+        # Necessary for GNU screen or it'll keep the window open until an
+        # external command has run.
+        require File::Spec;
+        my $devnull = File::Spec->devnull();
+        open STDIN,  '<', $devnull or die $!;
+        open STDOUT, '>', $devnull or die $!;
+        open STDERR, '>', $devnull or die $!;
 
         # Double-fork to prevent zombies.
         my $pid = fork;
@@ -536,7 +554,8 @@ sub select_match {
             $number = $number * 10 + $char;
         } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
             $number = int($number / 10);
-        } elsif ($char eq "\n") {
+        } elsif ($char eq "\n"
+                or $char eq $config->{setting}{alternative_return}) {
             if ($number == 0) { # number without selection matches last entry
                 $number = 1;
             }
@@ -599,6 +618,8 @@ sub extend_match {
 
     $screen->debug('extend_match', 'started');
 
+    return if not defined $match;
+
     $screen->prompt(name => 'extend', value => undef);
     $screen->draw_prompt($config);
 
@@ -612,8 +633,9 @@ sub extend_match {
         my $match_old = \%{$match};
 
         my $char = $screen->getch;
-        if ($char eq "\n") { # accept match
-            last;
+        if ($char eq "\n"
+                or $char eq $config->{setting}{alternative_return}) {
+            last; # accept match
 
         } elsif ($char eq 'w') { # select current word (both directions)
             extend_match_regex_left($line,  $match, qr/\w+/);
@@ -631,7 +653,7 @@ sub extend_match {
         } elsif ($char eq 'E') { # select current WORD (only right)
             extend_match_regex_right($line, $match, qr/\S+/);
 
-        } elsif ($char eq '^') { # select to beginning of line
+        } elsif ($char eq '0') { # select to beginning of line
             extend_match_regex_left($line, $match, qr/.+/);
         } elsif ($char eq '$') { # select to end of line
             extend_match_regex_right($line, $match, qr/.+/);
@@ -696,6 +718,8 @@ The following normal modes are available:
 
 =item B<url mode>  select URLs
 
+=item B<ip mode>   select IPv4 and IPv6 addresses
+
 =back
 
 =cut
@@ -723,6 +747,19 @@ sub mapping_mode_url {
         handler => $config->{handler}{url},
     };
 }
+sub mapping_mode_ip {
+    my ($key, $screen, $config, $input) = @_;
+
+    $screen->debug('mapping_mode_ip', 'started');
+
+    my @ipv4 = get_regex_matches($input, $config->{regex}{ipv4});
+    my @ipv6 = get_regex_matches($input, $config->{regex}{ipv6});
+    return {
+        select  => 'ip select',
+        matches => [@ipv4, @ipv6],
+        handler => $config->{handler}{ip},
+    };
+}
 
 =head2 SEARCH MODE (AND EXTEND MODE)
 
@@ -748,7 +785,7 @@ configurable at the moment):
 
 =item B<E> extend WORD to the right
 
-=item B<^> extend to beginning of line
+=item B<0> extend to beginning of line
 
 =item B<$> extend to end of line
 
@@ -810,6 +847,11 @@ sub mapping_mode_search {
 
     $screen->cursor(0);
 
+    $screen->prompt(name => undef, value => undef); # clear prompt
+    $screen->draw_prompt($config);
+
+    $screen->debug('mapping_mode_search', 'done');
+
     return {
         select  => 'search',
         matches => \@last_matches,
@@ -845,18 +887,40 @@ sub handler_yank {
         # GNU screen displays an annoying "Slurping X characters into buffer".
         # Use 'msgwait 0' as a hack to disable it.
         my $msgwait = $config->{setting}{screen_msgwait};
-        run_command($screen, $config, ['screen', '-X', 'msgwait', 0]);
-        run_command($screen, $config, ['screen', '-X', 'readbuf', $tmp]);
-        run_command($screen, $config, ['screen', '-X', 'msgwait', $msgwait]);
+        run_command($screen, ['screen', '-X', 'msgwait', 0]);
+        run_command($screen, ['screen', '-X', 'readbuf', $tmp]);
+        run_command($screen, ['screen', '-X', 'msgwait', $msgwait]);
     } elsif ($config->{setting}{multiplexer} eq 'tmux') {
         $screen->debug('handler_yank', 'using tmux');
 
-        run_command($screen, $config, ['tmux', 'load-buffer', $tmp]);
+        run_command($screen, ['tmux', 'load-buffer', $tmp]);
     } else {
         die 'unsupported multiplexer';
     }
 
     unlink $tmp or die $!;
+
+    if ($config->{setting}{yank_x11}) {
+        $screen->debug('handler_yank', 'setting X11 selection');
+
+        my @xsel_cmd  = qw( xsel --input --primary );
+        my @xclip_cmd = qw( xclip -in -selection primary );
+
+        my $fh;
+        {
+            # We don't care if a program doesn't exist.
+            no warnings;
+
+            if (not open $fh, '|-', @xsel_cmd) {
+                if (not open $fh, '|-', @xclip_cmd) {
+                    die "install xsel or xlip to yank to X11 selection\n";
+                }
+            }
+        }
+        print $fh $match->{value} or die $!;
+        close $fh or die $!;
+    }
+
     return;
 }
 sub handler_paste {
@@ -885,7 +949,7 @@ sub handler_paste {
         # Sleep until we switch back to the current window.
         Time::HiRes::usleep($config->{setting}{paste_sleep});
 
-        run_command($screen, $config, \@cmd);
+        run_command($screen, \@cmd);
     });
     return;
 }
@@ -895,11 +959,8 @@ sub handler_url {
     $screen->debug('handler_url', "opening $match->{value}");
 
     run_in_background($screen, sub {
-        my @cmd = map { $screen->encode($_) } (
-            @{$config->{setting}{browser}},
-            $match->{value},
-        );
-        run_command($screen, $config, \@cmd);
+        my @cmd = ( @{$config->{setting}{browser}}, $match->{value} );
+        run_command($screen, \@cmd);
     });
     return;
 }
@@ -985,6 +1046,8 @@ them in parentheses):
 
 =item B<u> select URLs (C<\&mapping_mode_url>)
 
+=item B<i> select IPv4 and IPv6 addresses (C<\&mapping_mode_ip>)
+
 =item B</> search for regex to get selection (C<\&mapping_mode_search>)
 
 =item B<q> quit fcscs (C<\&mapping_quit>)
@@ -1001,6 +1064,19 @@ The following simple mappings are available by default:
 
 =back
 
+Note that yanking only uses the GNU screen or Tmux paste buffer by default. To
+also copy to X11 selection, enable the B<yank_x11> option.
+
+The following additional mappings are available by default:
+
+=over
+
+=item B<\n> accept current selection (not customizable)
+
+=item B<s>  additional key to accept selection (B<alternative_return> option)
+
+=back
+
 All (single-byte) keys except numbers, backspace and return can be mapped.
 
 Unknown mappings are ignored when pressing keys.
@@ -1020,6 +1096,7 @@ Example:
 my %mapping_mode = (
     f   => \&mapping_mode_path,
     u   => \&mapping_mode_url,
+    i   => \&mapping_mode_ip,
     '/' => \&mapping_mode_search,
     q   => \&mapping_quit,
 );
@@ -1039,6 +1116,8 @@ Defaults in parentheses (foreground, background, attribute).
 
 =item B<match_string>  attribute for matches (yellow, default, normal)
 
+=item B<match_last>    attribute for the match selected by return (yellow, default, underline)
+
 =item B<prompt_name>   attribute for prompt name (standout)
 
 =item B<prompt_flags>  attribute for prompt flags (standout)
@@ -1057,6 +1136,8 @@ my %attribute = (
     match_id     => $screen->color_pair(Curses::COLOR_RED, -1)
                     | Curses::A_BOLD,
     match_string => $screen->color_pair(Curses::COLOR_YELLOW, -1),
+    match_last   => $screen->color_pair(Curses::COLOR_YELLOW, -1)
+                    | Curses::A_UNDERLINE,
     prompt_name  => Curses::A_STANDOUT,
     prompt_flags => Curses::A_STANDOUT,
 );
@@ -1067,21 +1148,25 @@ Defaults in parentheses.
 
 =over
 
-=item B<debug>          enable debug mode, writes to I<~/.config/fcscs/log> (C<0>)
+=item B<debug>              enable debug mode, writes to I<~/.config/fcscs/log> (C<0>)
+
+=item B<initial_mode>       start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
 
-=item B<initial_mode>   start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
+=item B<multiplexer>        set multiplexer ("screen" or "tmux") if not autodetected (C<undef>)
 
-=item B<multiplexer>    set multiplexer ("screen" or "tmux") if not autodetected (C<undef>)
+=item B<ignorecase>         ignore case when searching (C<0>)
 
-=item B<ignorecase>     ignore case when searching (C<0>)
+=item B<smartcase>          ignore case unless one uppercase character is searched (C<1>)
 
-=item B<smartcase>      ignore case unless one uppercase character is searched (C<1>)
+=item B<yank_x11>           copy selection also to X11 primary selection when yanking (C<0>)
 
-=item B<paste_sleep>    sleep x us before running paste command (C<100_000>)
+=item B<paste_sleep>        sleep x us before running paste command (C<100_000>)
 
-=item B<screen_msgwait> GNU Screen's msgwait variable, used when yanking (C<5>)
+=item B<screen_msgwait>     GNU Screen's msgwait variable, used when yanking (C<5>)
 
-=item B<browser>        browser command as array reference (C<['x-www-browser']>)
+=item B<alternative_return> additional accept key like return, set to C<\n> to disable (C<s>)
+
+=item B<browser>            browser command as array reference (C<['x-www-browser']>)
 
 =back
 
@@ -1093,24 +1178,31 @@ Example:
 =cut
 my %setting = (
     # options
-    debug          => 0,
-    initial_mode   => \&mapping_mode_url,
-    multiplexer    => undef,
-    ignorecase     => 0,
-    smartcase      => 1,
-    paste_sleep    => 100_000,
-    screen_msgwait => 5,
+    debug              => 0,
+    initial_mode       => \&mapping_mode_url,
+    multiplexer        => undef,
+    ignorecase         => 0,
+    smartcase          => 1,
+    yank_x11           => 0,
+    paste_sleep        => 100_000,
+    screen_msgwait     => 5,
+    # global mappings
+    alternative_return => 's',
     # commands
-    browser        => ['x-www-browser'],
+    browser            => ['x-www-browser'],
 );
 
 =head2 REGEXPS
 
 =over
 
-=item B<url>  used by C<\&mapping_mode_url()>
+=item B<url>  used by C<\&mapping_mode_url>
+
+=item B<path> used by C<\&mapping_mode_path>
 
-=item B<path> used by C<\&mapping_mode_path()>
+=item B<ipv4> used by C<\&mapping_mode_ip>
+
+=item B<ipv6> used by C<\&mapping_mode_ip>
 
 =back
 
@@ -1124,6 +1216,10 @@ my %regex = (
     # Taken from urlview's default configuration file, thanks.
     url  => qr{((?:(?:(?:http|https|ftp|gopher)|mailto):(?://)?[^ <>"\t]*|(?:www|ftp)[0-9]?\.[-a-z0-9.]+)[^ .,;\t\n\r<">\):]?[^, <>"\t]*[^ .,;\t\n\r<">\):])},
     path => qr{(~?[a-zA-Z0-9_./-]*/[a-zA-Z0-9_./-]+)},
+    # IP addresses with optional prefix. Not perfectly accurate but good
+    # enough.
+    ipv4 => qr!\b(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(?:/\d{1,2})?)\b!,
+    ipv6 => qr!\b((?:[0-9a-fA-F]{1,4})?(?::+[0-9a-fA-F]{1,4})+(?:/\d{1,3})?)\b!,
 );
 
 =head2 HANDLERS
@@ -1140,6 +1236,8 @@ The following handlers are available, defaults in parentheses.
 
 =item B<url>   used to open URLs (e.g. in a browser) (C<\&handler_url>)
 
+=item B<ip>    used to handle IPs (C<\&handler_yank>)
+
 =back
 
 Example:
@@ -1151,8 +1249,7 @@ Example:
 
         if ($match->{value} =~ m{^https://www.youtube.com/}) {
             return run_in_background($screen, sub {
-                run_command($screen, $config,
-                            ['youtube-dl-wrapper', $match->{value}]);
+                run_command($screen, ['youtube-dl-wrapper', $match->{value}]);
             });
         }
         handler_url(@_);
@@ -1163,6 +1260,7 @@ my %handler = (
     yank  => \&handler_yank,
     paste => \&handler_paste,
     url   => \&handler_url,
+    ip    => \&handler_yank,
 );
 
 my %state = (
@@ -1184,6 +1282,7 @@ Create a new Curses attribute with the given fore- and background color.
 
     mapping_mode_path()
     mapping_mode_url()
+    mapping_mode_ip()
     mapping_mode_search()
 
     mapping_paste()
@@ -1221,6 +1320,7 @@ package Fcscs {
 
     sub mapping_mode_path { return main::mapping_mode_path(@_); }
     sub mapping_mode_url { return main::mapping_mode_url(@_); }
+    sub mapping_mode_ip { return main::mapping_mode_ip(@_); }
     sub mapping_mode_search { return main::mapping_mode_search(@_); }
 
     sub mapping_paste { return main::mapping_paste(@_); }
@@ -1367,8 +1467,8 @@ RESULT:
             $screen->debug('input', 'selecting match');
             my $tmp = $result;
             $result = select_match($result->{select},
-                                $screen, \%config, $input,
-                                $result->{matches});
+                                   $screen, \%config, $input,
+                                   $result->{matches});
             $result->{handler} = $tmp->{handler};
             $result->{extend}  = $tmp->{extend};
             goto RESULT; # reprocess special entries in result