3 # fcscs - fast curses screen content select
5 # Copyright (C) 2013-2017 Simon Ruderich
7 # This program is free software: you can redistribute it and/or modify
8 # it under the terms of the GNU General Public License as published by
9 # the Free Software Foundation, either version 3 of the License, or
10 # (at your option) any later version.
12 # This program is distributed in the hope that it will be useful,
13 # but WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with this program. If not, see <http://www.gnu.org/licenses/>.
24 use v5.10; # say, state
28 use I18N::Langinfo ();
32 our $VERSION = '0.01';
37 fcscs - fast curses screen content select
41 B<fcscs> [I<options>] I<path/to/screen/capture/file>
45 B<fcscs> is a small tool which allows quick selection of terminal screen
46 contents (like URLs, paths, regex matches, etc.) and passes the selection to
47 GNU Screen's or Tmux's paste buffer or any other program. The selection can
48 then quickly be pasted, e.g. in the shell. Requires GNU Screen or Tmux to
49 capture the terminal content. It's licensed under the GPL 3 or later.
57 Short overview of the general usage, details below:
60 - configure actions (optional)
63 - select mode (optional, URL mode is used on startup):
67 - c: checksums (e.g. MD5, SHA1, ..)
71 - select match by displayed number or <return> for lowest numbered
73 - configured action is run, e.g. URL is opened with browser
75 - perform incremental search
76 - on <return> go to `normal' mode to select a match
77 - after the match is selected wait for confirmation or extension
78 - confirmation: <return> run previously selected action
79 - extension: change match, e.g. select complete word or line
81 GNU Screen setup (add to F<~/.screenrc>):
83 bind ^B eval "hardcopy $HOME/.tmp/screen-fcscs" "screen fcscs $HOME/.tmp/screen-fcscs"
85 Tmux setup (add to F<~/.tmux.conf>):
87 bind-key C-b capture-pane \; save-buffer ~/.tmp/tmux-fcscs \; delete-buffer \; new-window "fcscs ~/.tmp/tmux-fcscs"
89 This requires a writable ~/.tmp directory. Adapt the mapping according to your
90 preferences. Ensure these files are not readable by others as they can contain
91 private data (umask or protected directory). B<fcscs> must be in your C<$PATH>
92 for the above mappings to work.
94 Pressing the configured mapping (Prefix Ctrl-B in this example) opens B<fcscs>
95 in a new GNU screen/Tmux window. After selection, the content is either passed
96 to external programs (e.g. for URLs) or copied to the paste buffer or directly
97 pasted in your previous window and the new window is closed.
99 To select a match just type its number. If the match is unique, the entry is
100 automatically selected (e.g. you press 2 and there are only 19 matches). If
101 there are multiple matches left (e.g. you press 1 and there are more than ten
102 matches available), press return to select the current match (1 in this case)
103 or another number to select the longer match. Use backspace to remove the last
106 Press return before entering a number to select the last (lowest numbered)
107 match (underlined by default). To abort without selecting any match use "q".
109 To change the selection mode (e.g. paths, files, etc.) use one of the mappings
110 explained below. Per default URLs are selected, see options for a way to
113 I<NOTE>: Opening URLs in the browser passes the URL via the command line which
114 might leak URLs to other users on the current system via C<ps aux> or C<top>
115 (mount C</proc> with C<hidepid=2> on Linux to prevent this information
118 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
119 GNU screen/Tmux without exposing it to C<ps aux> or C<top>. However this may
120 leak data if those temporary files are written to disk. To prevent this change
121 your C<$TMP> to point to a memory-only location or encrypted storage.
123 If no window appears, try running B<fcscs> manually to catch the error message
124 and please report the bug:
126 fcscs /path/to/screen-or-tmux-fcscs-file
136 # Helper class for drawing on the screen using Curses.
139 my ($class, $encoding) = @_;
141 # Prefer strict UTF-8 handling (see perldoc Encode); just in case.
142 if (lc $encoding eq 'utf8') {
145 # Get Encode object to speed up decode()/encode().
146 my $encoding_object = Encode::find_encoding($encoding);
147 die "unsupported encoding '$encoding'" unless ref $encoding_object;
149 my $curses = Curses->new or die $!;
152 encoding => $encoding,
153 encoding_object => $encoding_object,
165 # Allow default colors by passing -1 to init_pair. A default color is
166 # not drawn on screen thus allowing terminals with pseudo-transparency
167 # to use the transparent background in place of the default color.
168 Curses::use_default_colors;
187 # Convert between Perl's internal encoding and the terminal's encoding.
189 my ($self, $string) = @_;
190 return $self->{encoding_object}->encode($string);
193 my ($self, $string) = @_;
194 return eval { # returns undef on decode failure
195 $self->{encoding_object}->decode($string, Encode::FB_CROAK);
199 # Create attribute for the given fore-/background colors.
201 my ($self, $fg, $bg) = @_;
203 state $next_color_pair = 1; # must start at 1 for init_pair()
205 Curses::init_pair($next_color_pair, $fg, $bg);
206 return Curses::COLOR_PAIR($next_color_pair++);
209 # Draw a string which must fit in the current line. Wrapping/clipping is
210 # not supported and must be handled by the caller.
212 my ($self, $y, $x, $attributes, $string) = @_;
214 die if $string =~ /\n/;
215 # FIXME: wide characters
216 die if $x + length $string > $self->width;
218 $self->{curses}->attron($attributes) if defined $attributes;
219 $self->{curses}->addstr($y, $x, $self->encode($string));
220 $self->{curses}->attroff($attributes) if defined $attributes;
223 # Like draw_simple(), but the string is automatically clipped.
225 my ($self, $y, $x, $attributes, $string) = @_;
227 # FIXME: wide characters
228 $string = substr $string, 0, $self->width - $x;
229 $self->draw_simple($y, $x, $attributes, $string);
233 my ($self, $y, $x, $attributes, $string) = @_;
235 die unless defined $string;
239 # We must print each line separately. Search for next newline or
240 # line end, whichever is closer.
241 if ($string =~ /\n/) {
244 # FIXME: wide characters
245 if ($x + length $string > $self->width) {
246 my $new_offset = $self->width - $x;
247 if (not defined $offset or $offset > $new_offset) {
248 $offset = $new_offset;
251 last unless defined $offset;
253 # FIXME: wide characters
254 $self->draw_simple($y, $x, $attributes, substr $string, 0, $offset);
256 # Don't draw "\n" itself.
257 if ("\n" eq substr $string, $offset, 1) {
261 $string = substr $string, $offset;
267 $self->draw_simple($y, $x, $attributes, $string);
272 my ($self, $config) = @_;
274 $self->debug('draw_prompt', 'started');
277 my $y = $self->height - 1;
279 # Clear line for better visibility.
280 $self->draw_simple($y, $x, undef, ' ' x $self->width);
283 if (defined (my $s = $self->{prompt}{flags})) {
285 $self->debug('draw_prompt', $s);
286 $self->draw_clipped($y, $x, $config->{attribute}{prompt_flags}, $s);
287 $x += length($s) + 1; # space between next element
290 if (defined (my $s = $self->{prompt}{name})) {
292 $self->debug('draw_prompt', $s);
293 $self->draw_clipped($y, $x, $config->{attribute}{prompt_name}, $s);
294 $x += length($s) + 1;
296 # Draw prompt value, e.g. a search field.
297 if (defined (my $s = $self->{prompt}{value})) {
298 $self->debug('draw_prompt', $s);
299 $self->draw_clipped($y, $x, undef, $s);
300 $x += length($s) + 1;
306 my ($self, $config, $matches_remove, $matches_add) = @_;
308 foreach (@{$matches_remove}) {
309 $self->draw($_->{y}, $_->{x}, Curses::A_NORMAL, $_->{string});
312 my $attr_id = $config->{attribute}{match_id};
313 my $attr_string = $config->{attribute}{match_string};
314 my $attr_last = $config->{attribute}{match_last};
316 foreach (@{$matches_add}) {
317 my $attr = (defined $_->{id} and $_->{id} == 1)
320 $self->draw($_->{y}, $_->{x}, $attr, $_->{string});
321 if (defined $_->{id}) {
322 $self->draw($_->{y}, $_->{x}, $attr_id, $_->{id});
330 my ($self, %settings) = @_;
332 foreach (keys %settings) {
333 die if not exists $self->{prompt}{$_};
334 $self->{prompt}{$_} = $settings{$_};
341 my ($self, $module, @args) = @_;
343 return if not $self->{debug};
345 state $fh; # only open the file once per run
346 if (not defined $fh) {
347 # Ignore errors if the directory doesn't exist.
348 if (not open $fh, '>', "$ENV{HOME}/.config/fcscs/log") {
349 $fh = undef; # a failed open still writes a value to $fh
356 $_ = $self->encode($_);
358 say $fh "$module: @args" or die $!;
362 my ($self, @args) = @_;
364 my $attr = $self->color_pair(Curses::COLOR_RED, -1) | Curses::A_BOLD;
366 # Clear the screen to improve visibility of the error message.
367 $self->{curses}->clear;
369 my $y = $self->draw(0, 0, $attr, "@args");
371 if ($self->{debug}) {
374 require Devel::StackTrace;
377 $msg = "Devel::StackTrace missing, no stack trace.\n";
379 my $trace = Devel::StackTrace->new;
380 $msg = "Stack trace:\n" . $trace->as_string;
382 $y = $self->draw($y + 1, 0, Curses::A_NORMAL, $msg);
385 $self->draw($y + 1, 0, Curses::A_NORMAL,
386 'Press any key to terminate fcscs.');
394 # Wrapper for Curses.
395 sub width { return $Curses::COLS; }
396 sub height { return $Curses::LINES; }
397 sub refresh { return $_[0]->{curses}->refresh; }
398 sub getch { return $_[0]->{curses}->getch; }
399 sub cursor { Curses::curs_set($_[1]); return; }
407 my ($screen, $input_ref) = @_;
409 # Make sure the input fits on the screen by removing the top lines if
411 splice @{$input_ref}, 0, -$screen->height;
413 # Pad each line with spaces to the screen width to correctly handle
414 # multi-line regexes.
415 # FIXME: wide characters
416 my @padded = map { sprintf '%-*s', $screen->width, $_ } @{$input_ref};
418 my $string = join "\n", @padded;
422 width => $screen->width + 1,
423 # + 1 = "\n", used in input_match_offset_to_coordinates
427 sub input_match_offset_to_coordinates {
428 my ($width, $offset) = @_;
430 die unless defined $offset;
432 my $y = int($offset / $width);
433 my $x = $offset - $y * $width;
437 sub get_regex_matches {
438 my ($input, $regex) = @_;
441 while ($input->{string} =~ /$regex/g) {
443 die "Match group required in regex '$regex'" if not defined $offset;
445 my ($x, $y) = input_match_offset_to_coordinates($input->{width},
447 push @matches, { x => $x, y => $y, offset => $offset, string => $1 };
454 my ($screen, $cmd) = @_;
456 $screen->debug('run_command', "running @{$cmd}");
459 # Perl's system() combined with a $SIG{__WARN__} which die()s has
460 # issues due to the fork. The die() in the __WARN__ handler doesn't
461 # die but the program continues after the system().
463 # If the forked process fails to exec (e.g. program not found) then
464 # the __WARN__ handler is called (because a warning is about to be
465 # displayed) and the die() should display a message and terminate the
466 # process. But due to the fork it doesn't terminate the parent process
467 # and instead changes the return value of system(); it's no longer -1
468 # which makes it impossible to detect that case.
470 # Perl < 5.18 (found in 5.14) doesn't setup $$ during system() which
471 # makes it impossible to detect if the handler was called from inside
474 # Instead, just ignore any warnings during the system(). Thanks to
475 # mauke in #perl on Freenode (2013-10-29 23:30 CET) for the idea to
476 # use no warnings and anno for testing a more recent Perl version with
480 my @cmd = map { $screen->encode($_) } @{$cmd};
481 system { $cmd[0] } @cmd;
486 $msg = 'failed to execute: ' . $!;
488 $msg = 'killed by signal ' . ($? & 127);
490 $msg = 'exited with code ' . ($? >> 8);
492 die "system(@{$cmd}) $msg.";
496 sub run_in_background {
497 my ($screen, $sub) = @_;
499 $screen->debug('run_in_background', "running $sub");
502 defined $pid or die $!;
505 # The terminal multiplexer sends a SIGHUP to the process when it
506 # closes the window (because the parent process has exited).
507 local $SIG{HUP} = 'IGNORE';
509 # Necessary for GNU screen or it'll keep the window open until an
510 # external command has run.
511 require File::Spec; # load here to speedup startup
512 my $devnull = File::Spec->devnull();
513 open STDIN, '<', $devnull or die $!;
514 open STDOUT, '>', $devnull or die $!;
515 open STDERR, '>', $devnull or die $!;
517 # Double-fork to prevent zombies.
519 defined $pid or die $!;
520 if ($pid == 0) { # child
525 waitpid $pid, 0 or die $!;
531 my ($name, $screen, $config, $input, $matches) = @_;
533 $screen->debug('select_match', 'started');
535 return if @{$matches} == 0;
536 # Don't return on initial run to give the user a chance to select another
537 # mode, e.g. to switch from URL selection to search selection.
538 if (@{$matches} == 1 and not $config->{state}{initial}) {
539 return { match => $matches->[0] };
541 $config->{state}{initial} = 0;
543 my @sorted = sort { $b->{y} <=> $a->{y} or $b->{x} <=> $a->{x} } @{$matches};
550 $screen->prompt(name => $name, value => undef);
551 $screen->draw_prompt($config);
553 $screen->draw_matches($config, [], $matches);
558 my $char = $screen->getch;
559 if ($char =~ /^\d$/) {
560 $number = $number * 10 + $char;
561 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
562 $number = int($number / 10);
563 } elsif ($char eq "\n"
564 or $char eq $config->{setting}{alternative_return}) {
567 # Selecting a new mode requires falling through into the main input
568 # loop and then starting the new mode.
569 } elsif (defined $config->{mapping}{mode}{$char}) {
570 $screen->draw_matches($config, $matches, []); # clear matches
571 return { key => $char };
572 # All other mappings stay in the current mode.
573 } elsif (defined (my $m = $config->{mapping}{simple}{$char})) {
574 my $result = $m->($char, $screen, $config, $input);
575 last if defined $result->{select_match};
579 next; # ignore unknown mappings
582 last if $number > 0 and $number * 10 > @{$matches}; # unique match
584 my @remaining = $number == 0
586 : grep { $_->{id} =~ /^$number/ } @{$matches};
587 $screen->draw_matches($config, $matches, \@remaining);
590 # Number without selection matches last entry.
595 $screen->draw_matches($config, $matches, []); # clear matches
597 foreach (@{$matches}) {
598 return { match => $_ } if $_->{id} == $number;
600 $screen->debug('select_match', 'no match selected');
601 return { match => undef };
604 sub extend_match_regex_left {
605 my ($line, $match, $regex) = @_;
607 my $s = reverse substr $line, 0, $match->{x};
608 if ($s =~ /^($regex)/) {
609 $match->{string} = reverse($1) . $match->{string};
610 $match->{x} -= length $1;
611 $match->{offset} -= length $1;
615 sub extend_match_regex_right {
616 my ($line, $match, $regex) = @_;
618 my $s = substr $line, $match->{x} + length $match->{string};
619 if ($s =~ /^($regex)/) {
620 $match->{string} .= $1;
625 my ($screen, $config, $input, $match) = @_;
627 $screen->debug('extend_match', 'started');
629 return if not defined $match;
631 $screen->prompt(name => 'extend', value => undef);
632 $screen->draw_prompt($config);
634 delete $match->{id}; # don't draw any match ids
635 $screen->draw_matches($config, [], [$match]);
638 my $line = $input->{lines}[$match->{y}];
641 my $match_old = \%{$match};
643 my $char = $screen->getch;
645 or $char eq $config->{setting}{alternative_return}) {
648 } elsif ($char eq 'w') { # select current word (both directions)
649 extend_match_regex_left($line, $match, qr/\w+/);
650 extend_match_regex_right($line, $match, qr/\w+/);
651 } elsif ($char eq 'b') { # select current word (only left)
652 extend_match_regex_left($line, $match, qr/\w+/);
653 } elsif ($char eq 'e') { # select current word (only right)
654 extend_match_regex_right($line, $match, qr/\w+/);
656 } elsif ($char eq 'W') { # select current WORD (both directions)
657 extend_match_regex_left($line, $match, qr/\S+/);
658 extend_match_regex_right($line, $match, qr/\S+/);
659 } elsif ($char eq 'B') { # select current WORD (only left)
660 extend_match_regex_left($line, $match, qr/\S+/);
661 } elsif ($char eq 'E') { # select current WORD (only right)
662 extend_match_regex_right($line, $match, qr/\S+/);
664 } elsif ($char eq '0') { # select to beginning of line
665 extend_match_regex_left($line, $match, qr/.+/);
666 } elsif ($char eq '$') { # select to end of line
667 extend_match_regex_right($line, $match, qr/.+/);
669 # Allow mode changes if not overwritten by above mappings.
670 } elsif (defined $config->{mapping}{mode}{$char}) {
671 $screen->draw_matches($config, [$match_old], []); # clear match
672 return { key => $char };
675 next; # ignore unknown mappings
678 $screen->draw_matches($config, [$match_old], [$match]);
682 $screen->debug('extend_match', 'done');
684 return { match => $match };
688 sub mapping_state_helper {
689 my ($name, $flags, $key, $screen, $config, $input) = @_;
691 $screen->debug("mapping_$name", 'started');
693 $config->{state}{handler} = $config->{handler}{$name};
695 $screen->prompt(flags => $flags);
696 $screen->draw_prompt($config);
701 sub mapping_state_now_helper {
702 my ($name, $key, $screen, $config, $input) = @_;
704 $screen->debug("mapping_${name}_now", 'started');
706 $config->{state}{handler} = $config->{handler}{$name};
714 return mapping_state_helper('paste', 'P', @_);
716 sub mapping_paste_now {
717 return mapping_state_now_helper('paste', @_);
721 return mapping_state_helper('yank', 'Y', @_);
723 sub mapping_yank_now {
724 return mapping_state_now_helper('yank', @_);
730 Normal modes select matches by calling a function which returns them, e.g. by
733 The following normal modes are available:
737 =item B<path mode> select relative/absolute paths
739 =item B<url mode> select URLs
741 =item B<ip mode> select IPv4 and IPv6 addresses
743 =item B<checksum mode> select checksums (MD5, SHA1, SHA256, SHA512)
748 sub mapping_mode_helper {
749 my ($name, $select, $key, $screen, $config, $input) = @_;
751 $screen->debug("mapping_mode_$name", 'started');
753 my @matches = get_regex_matches($input, $config->{regex}{$name});
756 matches => \@matches,
757 handler => $config->{handler}{$name},
760 sub mapping_mode_path {
761 return mapping_mode_helper('path', 'path select', @_);
763 sub mapping_mode_url {
764 return mapping_mode_helper('url', 'url select', @_);
766 sub mapping_mode_ip {
767 my ($key, $screen, $config, $input) = @_;
769 $screen->debug('mapping_mode_ip', 'started');
771 my @ipv4 = get_regex_matches($input, $config->{regex}{ipv4});
772 my @ipv6 = get_regex_matches($input, $config->{regex}{ipv6});
774 select => 'ip select',
775 matches => [@ipv4, @ipv6],
776 handler => $config->{handler}{ip},
779 sub mapping_mode_checksum {
780 return mapping_mode_helper('checksum', 'checksum select', @_);
783 =head2 SEARCH MODE (AND EXTEND MODE)
785 Search mode is a special mode which lets you type a search string (a Perl
786 regex) and then select one of the matches. Afterwards you can extend the
787 match. For example select the complete word or to the end of the line. This
788 allows quick selection of arbitrary text.
790 The following mappings are available during the extension mode (not
791 configurable at the moment):
795 =item B<w> select current word
797 =item B<b> extend word to the left
799 =item B<e> extend word to the right
801 =item B<W> select current WORD
803 =item B<B> extend WORD to the left
805 =item B<E> extend WORD to the right
807 =item B<0> extend to beginning of line
809 =item B<$> extend to end of line
813 C<word> includes any characters matching C<\w+>, C<WORD> any non-whitespace
814 characters (C<\S+>), just like in Vim.
817 sub mapping_mode_search {
818 my ($key, $screen, $config, $input) = @_;
820 $screen->debug('mapping_mode_search', 'started');
824 my $search = ''; # encoded
827 # getch doesn't return decoded characters but raw input bytes. Wait
828 # until the input character is complete.
829 my $value = $screen->decode($search);
830 $value = '' unless defined $value; # undef on decode failure
832 $screen->prompt(name => 'search', value => $value);
833 $screen->draw_prompt($config);
836 my $char = $screen->getch;
837 # TODO: readline editing support
840 } elsif ($char eq "\b" or $char eq "\x7f") { # backspace
841 # Remove a character, not a byte.
842 $search = $screen->decode($search);
844 $search = $screen->encode($search);
847 next unless defined $screen->decode($search);
853 if (($config->{setting}{smartcase} and $search eq lc $search)
854 or $config->{setting}{ignorecase}) {
857 # Ignore invalid regexps.
858 # TODO: display warning on error?
860 @matches = get_regex_matches($input, qr/($case$search)/);
863 $screen->draw_matches($config, \@last_matches, \@matches);
864 @last_matches = @matches;
869 $screen->prompt(name => undef, value => undef); # clear prompt
870 $screen->draw_prompt($config);
872 $screen->debug('mapping_mode_search', 'done');
876 matches => \@last_matches,
878 handler => $config->{handler}{yank},
883 my ($key, $screen, $config, $input) = @_;
885 # Key is necessary to fall through to main event loop which then quits.
886 return { key => $key, quit => 1 };
891 my ($screen, $config, $match) = @_;
893 $screen->debug('handler_yank', 'started');
895 require File::Temp; # load here to speedup startup
897 # Use a temporary file to prevent leaking the yanked data to other users
898 # with the command line, e.g. ps aux or top.
899 my ($fh, $tmp) = File::Temp::tempfile(); # dies on its own
900 print $fh $screen->encode($match->{value}) or die $!;
903 if ($config->{setting}{multiplexer} eq 'screen') {
904 $screen->debug('handler_yank', 'using screen');
906 # GNU screen displays an annoying "Slurping X characters into buffer".
907 # Use 'msgwait 0' as a hack to disable it.
908 my $msgwait = $config->{setting}{screen_msgwait};
909 run_command($screen, ['screen', '-X', 'msgwait', 0]);
910 run_command($screen, ['screen', '-X', 'readbuf', $tmp]);
911 run_command($screen, ['screen', '-X', 'msgwait', $msgwait]);
912 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
913 $screen->debug('handler_yank', 'using tmux');
915 run_command($screen, ['tmux', 'load-buffer', $tmp]);
917 die 'unsupported multiplexer';
920 unlink $tmp or die $!;
922 if ($config->{setting}{yank_x11}) {
923 $screen->debug('handler_yank', 'setting X11 selection');
925 my @xsel_cmd = qw( xsel --input --primary );
926 my @xclip_cmd = qw( xclip -in -selection primary );
930 # We don't care if a program doesn't exist.
933 if (not open $fh, '|-', @xsel_cmd) {
934 if (not open $fh, '|-', @xclip_cmd) {
935 die "install xsel or xlip to yank to X11 selection\n";
939 print $fh $match->{value} or die $!;
946 my ($screen, $config, $match) = @_;
948 $screen->debug('handler_paste', 'started');
950 require Time::HiRes; # load here to speedup startup
953 if ($config->{setting}{multiplexer} eq 'screen') {
954 $screen->debug('handler_paste', 'using screen');
955 @cmd = qw( screen -X paste . );
956 } elsif ($config->{setting}{multiplexer} eq 'tmux') {
957 $screen->debug('handler_paste', 'using tmux');
958 @cmd = qw( tmux paste-buffer );
960 die 'unsupported multiplexer';
963 run_in_background($screen, sub {
964 # We need to get the data in the paste buffer before we can paste
966 handler_yank($screen, $config, $match);
968 # Sleep until we switch back to the current window.
969 Time::HiRes::usleep($config->{setting}{paste_sleep});
971 run_command($screen, \@cmd);
976 my ($screen, $config, $match) = @_;
978 $screen->debug('handler_url', "opening $match->{value}");
980 run_in_background($screen, sub {
981 my @cmd = ( @{$config->{setting}{browser}}, $match->{value} );
982 run_command($screen, \@cmd);
989 # CONFIGURATION DEFAULTS
993 fcscs is configured through F<~/.fcscsrc> (preferred) or
994 F<~/.config/fcscs/fcscsrc> which is a normal Perl script with all of Perl's
995 usual features (only loaded if not writable by others).
997 All configuration values are stored in the hash C<%config>. All manually
998 defined keys overwrite the default settings.
1000 A simple F<~/.fcscsrc> could look like this (for details about the used
1001 settings see below):
1006 use Curses; # for COLOR_* and A_* constants
1010 # Draw matches in blue.
1011 $config{attribute}{match_string} = color_pair(COLOR_BLUE, -1);
1012 # Draw numbers in bold yellow.
1013 $config{attribute}{match_id} = color_pair(COLOR_YELLOW, -1)
1015 # Disable Vim-like 'smartcase' (ignore case until an upper character is
1016 # searched) which is enabled by default.
1017 $config{setting}{smartcase} = 0;
1019 # Use chromium to open URLs if running under X, elinks otherwise.
1020 if (defined $ENV{DISPLAY}) {
1021 $config{setting}{browser} = ['chromium'];
1023 $config{setting}{browser} = ['elinks', '-remote'];
1026 # Let fcscs know the file was loaded successfully.
1034 Pod::Usage::pod2usage(2);
1038 # Determine terminal encoding from the environment ($ENV{LANG} or similar).
1039 my $encoding = I18N::Langinfo::langinfo(I18N::Langinfo::CODESET);
1041 my $screen = Screen->init($encoding);
1043 # We must restore the screen before exiting.
1044 local $SIG{INT} = sub {
1048 # Make all warnings fatal to make sure they don't get lost (stderr is normally
1050 local $SIG{__WARN__} = sub {
1051 $screen->die('warning', @_);
1058 I<NOTE>: Mappings are split in two categories: Mode mappings which change the
1059 selection and may receive additional input (e.g. a search string) and simple
1060 mappings which only change some config value. Mode mappings are configured via
1061 C<$config{mapping}{mode}>, simple mappings via C<$config{mapping}{simple}>.
1063 The following mode mappings are available by default (the function to remap
1064 them in parentheses):
1068 =item B<f> select absolute/relative paths (C<\&mapping_mode_path>)
1070 =item B<u> select URLs (C<\&mapping_mode_url>)
1072 =item B<i> select IPv4 and IPv6 addresses (C<\&mapping_mode_ip>)
1074 =item B<c> select checksums (e.g. MD5, SHA) (C<\&mapping_mode_checksum>)
1076 =item B</> search for regex to get selection (C<\&mapping_mode_search>)
1078 =item B<q> quit fcscs (C<\&mapping_quit>)
1082 The following simple mappings are available by default:
1086 =item B<p> enable pasting (C<\&mapping_paste>)
1088 =item B<P> paste current selection (like C<\n> but paste) (C<\&mapping_paste_now>)
1090 =item B<y> enable yanking (copying) (C<\&mapping_yank>)
1092 =item B<Y> yank current selection (like C<\n> but yank) (C<\&mapping_yank_now>)
1096 Note that yanking only uses the GNU screen or Tmux paste buffer by default. To
1097 also copy to X11 selection, enable the B<yank_x11> option.
1099 The following additional mappings are available by default:
1103 =item B<\n> accept current selection (not customizable)
1105 =item B<s> additional key to accept selection (B<alternative_return> option)
1109 All (single-byte) keys except numbers, backspace and return can be mapped.
1111 Unknown mappings are ignored when pressing keys.
1113 To remove a default mapping, delete it from the mapping hash.
1117 # Map 'p' to select paths, 'P' to enable pasting.
1118 $config{mapping}{mode}{p} = \&mapping_mode_path;
1119 $config{mapping}{simple}{P} = \&mapping_paste;
1121 # Disable 'f' mapping.
1122 delete $config{mapping}{mode}{f};
1125 my %mapping_mode = (
1126 f => \&mapping_mode_path,
1127 u => \&mapping_mode_url,
1128 i => \&mapping_mode_ip,
1129 c => \&mapping_mode_checksum,
1130 '/' => \&mapping_mode_search,
1131 q => \&mapping_quit,
1133 my %mapping_simple = (
1134 p => \&mapping_paste,
1135 P => \&mapping_paste_now,
1136 y => \&mapping_yank,
1137 Y => \&mapping_yank_now,
1142 Attributes are used to style the output. They must be Curses attributes.
1143 Defaults in parentheses (foreground, background, attribute).
1147 =item B<match_id> attribute for match numbers (red, default, bold)
1149 =item B<match_string> attribute for matches (yellow, default, normal)
1151 =item B<match_last> attribute for the match selected by return (yellow, default, underline)
1153 =item B<prompt_name> attribute for prompt name (standout)
1155 =item B<prompt_flags> attribute for prompt flags (standout)
1161 # Draw prompt flags in bold red with default background color.
1162 $config{attribute}{prompt_flags}
1164 | color_pair(Curses::COLOR_RED, -1);
1168 match_id => $screen->color_pair(Curses::COLOR_RED, -1)
1170 match_string => $screen->color_pair(Curses::COLOR_YELLOW, -1),
1171 match_last => $screen->color_pair(Curses::COLOR_YELLOW, -1)
1172 | Curses::A_UNDERLINE,
1173 prompt_name => Curses::A_STANDOUT,
1174 prompt_flags => Curses::A_STANDOUT,
1179 Defaults in parentheses.
1183 =item B<debug> enable debug mode, writes to I<~/.config/fcscs/log> (C<0>)
1185 =item B<initial_mode> start in this mode, must be a valid mode mapping (C<\&mapping_mode_url>)
1187 =item B<multiplexer> set multiplexer ("screen" or "tmux"), defaults to autodetection (C<undef>)
1189 =item B<ignorecase> ignore case when searching (C<0>)
1191 =item B<smartcase> ignore case unless one uppercase character is searched (C<1>)
1193 =item B<yank_x11> copy selection also to X11 primary selection when yanking (C<0>)
1195 =item B<paste_sleep> sleep x us before running paste command (C<100_000>)
1197 =item B<screen_msgwait> GNU Screen's msgwait variable, overwritten with this value when yanking (C<5>)
1199 =item B<alternative_return> additional accept key like return, set to C<\n> to disable (C<s>)
1201 =item B<browser> browser command as array reference (C<['x-www-browser']>)
1207 # Select paths on startup instead of URLs.
1208 $config{setting}{initial_mode} = \&mapping_mode_path;
1214 initial_mode => \&mapping_mode_url,
1215 multiplexer => undef,
1219 paste_sleep => 100_000,
1220 screen_msgwait => 5,
1222 alternative_return => 's',
1224 browser => ['x-www-browser'],
1231 =item B<url> used by C<\&mapping_mode_url>
1233 =item B<path> used by C<\&mapping_mode_path>
1235 =item B<ipv4> used by C<\&mapping_mode_ip>
1237 =item B<ipv6> used by C<\&mapping_mode_ip>
1243 # Select all non-whitespace characters when searching for paths.
1244 $config{regex}{path} = qr{(\S+)};
1248 # Taken from urlview's default configuration file, thanks.
1249 url => qr{((?:(?:(?:http|https|ftp|gopher)|mailto):(?://)?[^ <>"\t]*|(?:www|ftp)[0-9]?\.[-a-z0-9.]+)[^ .,;\t\n\r<">\):]?[^, <>"\t]*[^ .,;\t\n\r<">\):])},
1250 path => qr{(~?[a-zA-Z0-9_./-]*/[a-zA-Z0-9_./-]+)},
1251 # IP addresses with optional prefix. Not perfectly accurate but good
1253 ipv4 => qr!\b(\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}(?:/\d{1,2})?)\b!,
1254 ipv6 => qr!\b((?:[0-9a-fA-F]{1,4})?(?::+[0-9a-fA-F]{1,4})+(?:/\d{1,3})?)\b!,
1255 # MD5, SHA1, SHA256, SHA512
1256 checksum => qr!\b([0-9a-fA-F]{32}|[0-9a-fA-F]{40}|[0-9a-fA-F]{64}|[0-9a-fA-F]{128})\b!,
1261 Handlers are used to perform actions on the selected string.
1263 The following handlers are available, defaults in parentheses.
1267 =item B<yank> used to yank (copy) selection to paste buffer (C<\&handler_yank>)
1269 =item B<paste> used to paste selection into window (C<\&handler_paste>)
1271 =item B<path> used to handle paths (C<\&handler_yank>)
1273 =item B<url> used to open URLs (e.g. in a browser) (C<\&handler_url>)
1275 =item B<ip> used to handle IPs (C<\&handler_yank>)
1277 =item B<checksum> used to handle checksums (C<\&handler_yank>)
1283 # Download YouTube videos with a custom wrapper, handle all other URLs
1284 # with the default URL handler.
1285 $config{handler}{url} = sub {
1286 my ($screen, $config, $match) = @_;
1288 if ($match->{value} =~ m{^https://www.youtube.com/}) {
1289 return run_in_background($screen, sub {
1290 run_command($screen, ['youtube-dl-wrapper', $match->{value}]);
1298 yank => \&handler_yank,
1299 paste => \&handler_paste,
1300 path => \&handler_yank,
1301 url => \&handler_url,
1302 ip => \&handler_yank,
1303 checksum => \&handler_yank,
1307 initial => 1, # used by select_match() for 'initial_mode'
1313 # CONFIGURATION "API"
1317 The following functions are available:
1319 color_pair($fg, $bg)
1321 Create a new Curses attribute with the given fore- and background color.
1326 mapping_mode_checksum()
1327 mapping_mode_search()
1335 Used as mappings, see L</MAPPINGS> above.
1341 Used as handler to yank, paste selection or open URL in browser.
1348 Helper functions when writing custom mappings, see the source and example for
1353 # Enhance URL mode by updating the mapping.
1354 $config{mapping}{mode}{u} = sub {
1355 my ($key, $screen, $config, $input) = @_;
1357 # First get matches of normal URL mode.
1358 my $result = mapping_mode_url(@_);
1360 # Add all strings matching "CVE-1234-1234" with URLs pointing to the
1361 # Debian security tracker. "->{value}" is the string which is used as
1362 # result of the match (e.g. the URL in this case).
1363 my @matches = get_regex_matches($input, qr/\b(CVE-\d+-\d+)\b/);
1364 foreach (@matches) {
1365 $_->{value} = "https://security-tracker.debian.org/$_->{string}";
1367 push @{$result->{matches}}, @matches;
1369 # Change all YouTube links to use the custom "youtube" handler (see
1370 # below). This will allow us to automatically open YouTube URLs with a
1371 # custom program, like `youtube-dl` or `mpv`.
1372 foreach (@{$result->{matches}}) {
1373 if ($_->{string} =~ m{^https://www.youtube.com/}) {
1374 $_->{handler} = $config{handler}{youtube};
1380 # Also update initial mode to use our new "URL mode".
1381 $config{setting}{initial_mode} = $config{mapping}{mode}{u};
1383 # Special handler to download YouTube URLs with `youtube-dl`. You could
1384 # also use `mpv` here to immediately play them.
1385 $config{handler}{youtube} = sub {
1386 my ($screen, $config, $match) = @_;
1388 return run_in_background($screen, sub {
1389 run_command($screen, ['youtube-dl', $match->{value}]);
1395 # All variables and functions which are usable by ~/.fcscsrc.
1397 our $screen; # "private"
1400 sub color_pair { return $screen->color_pair(@_); }
1402 sub mapping_mode_path { return main::mapping_mode_path(@_); }
1403 sub mapping_mode_url { return main::mapping_mode_url(@_); }
1404 sub mapping_mode_ip { return main::mapping_mode_ip(@_); }
1405 sub mapping_mode_checksum { return main::mapping_mode_checksum(@_); }
1406 sub mapping_mode_search { return main::mapping_mode_search(@_); }
1408 sub mapping_paste { return main::mapping_paste(@_); }
1409 sub mapping_paste_now { return main::mapping_paste_now(@_); }
1410 sub mapping_yank { return main::mapping_yank(@_); }
1411 sub mapping_yank_now { return main::mapping_yank_now(@_); }
1412 sub mapping_quit { return main::mapping_quit(@_); }
1414 sub handler_yank { return main::handler_yank(@_); }
1415 sub handler_paste { return main::handler_paste(@_); }
1416 sub handler_url { return main::handler_url(@_); }
1418 sub get_regex_matches { return main::get_regex_matches(@_); }
1419 sub select_match { return main::select_match(@_); }
1421 sub run_command { return main::run_command(@_); }
1422 sub run_in_background { return main::run_in_background(@_); }
1424 $Fcscs::screen = $screen;
1430 # Alias %config and %Fcscs::config. %config is less to type.
1432 local *config = \%Fcscs::config;
1434 $config{mapping}{mode} = \%mapping_mode;
1435 $config{mapping}{simple} = \%mapping_simple;
1436 $config{attribute} = \%attribute;
1437 $config{setting} = \%setting;
1438 $config{regex} = \%regex;
1439 $config{handler} = \%handler;
1440 $config{state} = \%state;
1443 my @configs = ("$ENV{HOME}/.fcscsrc",
1444 "$ENV{HOME}/.config/fcscs/fcscsrc");
1445 foreach my $path (@configs) {
1446 my $decoded = $screen->decode($path);
1448 # Load configuration file. Checks have a race condition if the home
1449 # directory is writable by an attacker (but then the user is screwed
1451 next unless -e $path;
1453 $screen->die("Config '$decoded' not owned by current user!");
1455 # Make sure the file is not writable by other users. Doesn't handle
1456 # ACLs and see comment above about race conditions.
1457 my @stat = stat $path or $screen->die("Config '$decoded': $!");
1458 my $mode = $stat[2];
1459 if (($mode & Fcntl::S_IWGRP) or ($mode & Fcntl::S_IWOTH)) {
1460 $screen->die("Config '$decoded' must not be writable by other users.");
1463 my $result = do $path;
1465 $screen->die("Failed to parse '$decoded': $@") if $@;
1466 $screen->die("Failed to do '$decoded': $!") unless defined $result;
1467 $screen->die("Failed to run '$decoded'.");
1470 last; # success, don't load more files
1473 $screen->{debug} = $config{setting}{debug};
1479 # Auto-detect current multiplexer.
1480 if (not defined $config{setting}{multiplexer}) {
1481 if (defined $ENV{STY} and defined $ENV{TMUX}) {
1482 die 'Found both $STY and $TMUX, set $config{setting}{multiplexer}.';
1483 } elsif (defined $ENV{STY}) {
1484 $config{setting}{multiplexer} = 'screen';
1485 } elsif (defined $ENV{TMUX}) {
1486 $config{setting}{multiplexer} = 'tmux';
1488 die 'No multiplexer found.';
1492 my $binmode = $encoding;
1493 # GNU screen stores the screen dump for unknown reasons as ISO-8859-1
1494 # instead of the currently active encoding.
1495 if ($config{setting}{multiplexer} eq 'screen') {
1496 $binmode = 'ISO-8859-1';
1500 open my $fh, '<', $ARGV[0] or die $!;
1501 binmode $fh, ":encoding($binmode)" or die $!;
1504 push @input_lines, $_;
1506 close $fh or die $!;
1508 my $input = prepare_input($screen, \@input_lines);
1510 # Display original screen content.
1512 foreach (@{$input->{lines}}) {
1513 $screen->draw_simple($y++, 0, undef, $_);
1518 my $mapping = $config{setting}{initial_mode};
1522 if (not defined $mapping) {
1523 $key = $screen->getch unless defined $key;
1524 $screen->debug('input', "got key '$key'");
1526 $mapping = $config{mapping}{mode}{$key};
1527 $mapping = $config{mapping}{simple}{$key} unless defined $mapping;
1528 if (not defined $mapping) { # ignore unknown mappings
1534 $screen->debug('input', 'running mapping');
1535 my $result = $mapping->($key, $screen, \%config, $input);
1539 if (defined $result->{quit}) {
1540 $screen->debug('input', 'quitting');
1543 if (defined $result->{key}) {
1544 $key = $result->{key}; # lookup another mapping
1545 $screen->debug('input', "processing new key: '$key'");
1548 if (defined $result->{select}) {
1549 $screen->debug('input', 'selecting match');
1551 $result = select_match($result->{select},
1552 $screen, \%config, $input,
1553 $result->{matches});
1554 $result->{handler} = $tmp->{handler};
1555 $result->{extend} = $tmp->{extend};
1556 goto RESULT; # reprocess special entries in result
1558 if (defined $result->{extend}) {
1559 $screen->debug('input', 'extending match');
1560 $result = extend_match($screen, \%config, $input,
1562 goto RESULT; # reprocess special entries in result
1564 if (defined $result->{match}) {
1565 if (not defined $result->{match}{value}) {
1566 $result->{match}{value} = $result->{match}{string};
1569 $screen->debug('input', 'running handler');
1571 # Choose handler with falling priority.
1573 $config{state}{handler}, # set by user
1574 $result->{match}{handler}, # set by match
1575 $result->{handler}, # set by mapping
1576 $config{handler}{yank}, # fallback
1578 foreach my $handler (@handlers) {
1579 next unless defined $handler;
1581 $handler->($screen, \%config, $result->{match});
1587 $key = undef; # get next key from user
1612 Invalid arguments/options.
1618 Simon Ruderich E<lt>simon@ruderich.orgE<gt>
1620 =head1 LICENSE AND COPYRIGHT
1622 Copyright (C) 2013-2017 by Simon Ruderich
1624 This program is free software: you can redistribute it and/or modify
1625 it under the terms of the GNU General Public License as published by
1626 the Free Software Foundation, either version 3 of the License, or
1627 (at your option) any later version.
1629 This program is distributed in the hope that it will be useful,
1630 but WITHOUT ANY WARRANTY; without even the implied warranty of
1631 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
1632 GNU General Public License for more details.
1634 You should have received a copy of the GNU General Public License
1635 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
1639 L<screen(1)>, L<tmux(1)>, L<urlview(1)>