Screen::debug(): encode arguments

[fcscs/fcscs.git] / bin / fcscs

diff --git a/bin/fcscs b/bin/fcscs
index f561af237ce9ec8dc77289268ed18288e0ae4e7c..230d4bc9440b1900f21ece73fd01330fb0d29c8d 100755 (executable)
--- a/bin/fcscs
+++ b/bin/fcscs
@@ -109,10 +109,9 @@ explained below. Per default URLs are selected, see options for a way to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to
 change this.
 
 I<NOTE>: When yanking (copying) a temporary file is used to pass the data to

-GNU screen/Tmux without exposing it to C<ps ux> or C<top>. However this may
+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
 leak data if those temporary files are written to disk. To prevent this change

-your C<$TMP> accordingly to point to a memory-only location or encrypted
-storage.
+your C<$TMP> to point to a memory-only location or encrypted storage.

 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:
 
 If no window appears, try running B<fcscs> manually to catch the error message
 and please report the bug:


@@ -342,6 +341,26 @@ package Screen {
         $self->deinit;
         exit 1;
     }
         $self->deinit;
         exit 1;
     }

+    sub debug {
+        my ($self, $module, @args) = @_;
+
+        return if not $self->{debug};
+
+        state $fh; # only open the file once per run
+        if (not defined $fh) {
+            # Ignore errors if the directory doesn't exist.
+            if (not open $fh, '>', "$ENV{HOME}/.config/fcscs/log") {
+                $fh = undef; # a failed open still writes a value to $fh
+                return;
+            }
+        }
+
+        foreach (@args) {
+            $_ = $self->encode($_);
+        }
+        say $fh "$module: @args";
+        return;
+    }

 
 
     sub prompt {
 
 
     sub prompt {


@@ -366,25 +385,6 @@ package Screen {
 
 # FUNCTIONS
 
 
 # FUNCTIONS
 

-sub debug {
-    my ($config, $module, @args) = @_;
-
-    return if not $config->{setting}{debug};
-
-    state $fh; # only open the file once per run
-    if (not defined $fh) {
-        # Ignore errors if the directory doesn't exist.
-        if (not open $fh, '>', "$ENV{HOME}/.config/fcscs/log") {
-            $fh = undef; # a failed open still writes a value to $fh
-            return;
-        }
-    }
-
-    say $fh "$module: @args";
-    return;
-}
-
-

 sub prepare_input {
     my ($screen, $input_ref) = @_;
 
 sub prepare_input {
     my ($screen, $input_ref) = @_;
 


@@ -433,9 +433,9 @@ sub get_regex_matches {
 
 
 sub run_command {
 
 
 sub run_command {

-    my ($config, $cmd) = @_;
+    my ($screen, $config, $cmd) = @_;

 
 

-    debug $config, 'run_command', "running @{$cmd}";
+    $screen->debug('run_command', "running @{$cmd}");

 
     my $exit = do {
         # Perl's system() combined with a $SIG{__WARN__} which die()s has
 
     my $exit = do {
         # Perl's system() combined with a $SIG{__WARN__} which die()s has


@@ -475,9 +475,9 @@ sub run_command {
     return;
 }
 sub run_in_background {
     return;
 }
 sub run_in_background {

-    my ($config, $sub) = @_;
+    my ($screen, $sub) = @_;

 
 

-    debug $config, 'run_in_background', "running $sub";
+    $screen->debug('run_in_background', "running $sub");

 
     my $pid = fork;
     defined $pid or die $!;
 
     my $pid = fork;
     defined $pid or die $!;


@@ -509,12 +509,12 @@ sub run_in_background {
 sub select_match {
     my ($name, $screen, $config, $input, $matches) = @_;
 
 sub select_match {
     my ($name, $screen, $config, $input, $matches) = @_;
 

-    debug $config, 'select_match', 'started';
+    $screen->debug('select_match', 'started');

 
     return if @{$matches} == 0;
     # Don't return on initial run to give the user a chance to select another
     # mode, e.g. to switch from URL selection to search selection.
 
     return if @{$matches} == 0;
     # Don't return on initial run to give the user a chance to select another
     # mode, e.g. to switch from URL selection to search selection.

-    if (@{$matches} == 1 and not $config->{state}->{initial}) {
+    if (@{$matches} == 1 and not $config->{state}{initial}) {

         return { match => $matches->[0] };
     }
     $config->{state}{initial} = 0;
         return { match => $matches->[0] };
     }
     $config->{state}{initial} = 0;


@@ -573,7 +573,7 @@ sub select_match {
     foreach (@{$matches}) {
         return { match => $_ } if $_->{id} == $number;
     }
     foreach (@{$matches}) {
         return { match => $_ } if $_->{id} == $number;
     }

-    debug $config, 'select_match', 'no match selected';
+    $screen->debug('select_match', 'no match selected');

     return { match => undef };
 }
 
     return { match => undef };
 }
 


@@ -600,7 +600,7 @@ sub extend_match_regex_right {
 sub extend_match {
     my ($screen, $config, $input, $match) = @_;
 
 sub extend_match {
     my ($screen, $config, $input, $match) = @_;
 

-    debug $config, 'extend_match', 'started';
+    $screen->debug('extend_match', 'started');

 
     $screen->prompt(name => 'extend', value => undef);
     $screen->draw_prompt($config);
 
     $screen->prompt(name => 'extend', value => undef);
     $screen->draw_prompt($config);


@@ -652,7 +652,7 @@ sub extend_match {
         $screen->refresh;
     }
 
         $screen->refresh;
     }
 

-    debug $config, 'extend_match', 'done';
+    $screen->debug('extend_match', 'done');

 
     return { match => $match };
 }
 
     return { match => $match };
 }


@@ -661,7 +661,7 @@ sub extend_match {
 sub mapping_paste {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_paste {
     my ($key, $screen, $config, $input) = @_;
 

-    debug $config, 'mapping_paste', 'started';
+    $screen->debug('mapping_paste', 'started');

 
     $config->{state}{handler} = $config->{handler}{paste};
 
 
     $config->{state}{handler} = $config->{handler}{paste};
 


@@ -674,7 +674,7 @@ sub mapping_paste {
 sub mapping_yank {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_yank {
     my ($key, $screen, $config, $input) = @_;
 

-    debug $config, 'mapping_yank', 'started';
+    $screen->debug('mapping_yank', 'started');

 
     $config->{state}{handler} = $config->{handler}{yank};
 
 
     $config->{state}{handler} = $config->{handler}{yank};
 


@@ -705,7 +705,7 @@ The following normal modes are available:
 sub mapping_mode_path {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_mode_path {
     my ($key, $screen, $config, $input) = @_;
 

-    debug $config, 'mapping_mode_path', 'started';
+    $screen->debug('mapping_mode_path', 'started');

 
     my @matches = get_regex_matches($input, $config->{regex}{path});
     return {
 
     my @matches = get_regex_matches($input, $config->{regex}{path});
     return {


@@ -717,7 +717,7 @@ sub mapping_mode_path {
 sub mapping_mode_url {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_mode_url {
     my ($key, $screen, $config, $input) = @_;
 

-    debug $config, 'mapping_mode_url', 'started';
+    $screen->debug('mapping_mode_url', 'started');

 
     my @matches = get_regex_matches($input, $config->{regex}{url});
     return {
 
     my @matches = get_regex_matches($input, $config->{regex}{url});
     return {


@@ -764,7 +764,7 @@ characters (C<\S+>), just like in Vim.
 sub mapping_mode_search {
     my ($key, $screen, $config, $input) = @_;
 
 sub mapping_mode_search {
     my ($key, $screen, $config, $input) = @_;
 

-    debug $config, 'mapping_mode_search', 'started';
+    $screen->debug('mapping_mode_search', 'started');

 
     $screen->cursor(1);
 
 
     $screen->cursor(1);
 


@@ -832,7 +832,7 @@ sub mapping_quit {
 sub handler_yank {
     my ($screen, $config, $match) = @_;
 
 sub handler_yank {
     my ($screen, $config, $match) = @_;
 

-    debug $config, 'handler_yank', 'started';
+    $screen->debug('handler_yank', 'started');

 
     require File::Temp;
 
 
     require File::Temp;
 


@@ -843,18 +843,18 @@ sub handler_yank {
     close $fh or die $!;
 
     if ($config->{setting}{multiplexer} eq 'screen') {
     close $fh or die $!;
 
     if ($config->{setting}{multiplexer} eq 'screen') {

-        debug $config, 'handler_yank', 'using screen';
+        $screen->debug('handler_yank', 'using screen');

 
         # 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};
 
         # 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($config, ['screen', '-X', 'msgwait', 0]);
-        run_command($config, ['screen', '-X', 'readbuf', $tmp]);
-        run_command($config, ['screen', '-X', 'msgwait', $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]);

     } elsif ($config->{setting}{multiplexer} eq 'tmux') {
     } elsif ($config->{setting}{multiplexer} eq 'tmux') {

-        debug $config, 'handler_yank', 'using tmux';
+        $screen->debug('handler_yank', 'using tmux');

 
 

-        run_command($config, ['tmux', 'load-buffer', $tmp]);
+        run_command($screen, $config, ['tmux', 'load-buffer', $tmp]);

     } else {
         die 'unsupported multiplexer';
     }
     } else {
         die 'unsupported multiplexer';
     }


@@ -865,22 +865,22 @@ sub handler_yank {
 sub handler_paste {
     my ($screen, $config, $match) = @_;
 
 sub handler_paste {
     my ($screen, $config, $match) = @_;
 

-    debug $config, 'handler_paste', 'started';
+    $screen->debug('handler_paste', 'started');

 
     require Time::HiRes;
 
     my @cmd;
     if ($config->{setting}{multiplexer} eq 'screen') {
 
     require Time::HiRes;
 
     my @cmd;
     if ($config->{setting}{multiplexer} eq 'screen') {

-        debug $config, 'handler_paste', 'using screen';
+        $screen->debug('handler_paste', 'using screen');

         @cmd = qw( screen -X paste . );
     } elsif ($config->{setting}{multiplexer} eq 'tmux') {
         @cmd = qw( screen -X paste . );
     } elsif ($config->{setting}{multiplexer} eq 'tmux') {

-        debug $config, 'handler_paste', 'using tmux';
+        $screen->debug('handler_paste', 'using tmux');

         @cmd = qw( tmux paste-buffer );
     } else {
         die 'unsupported multiplexer';
     }
 
         @cmd = qw( tmux paste-buffer );
     } else {
         die 'unsupported multiplexer';
     }
 

-    run_in_background($config, sub {
+    run_in_background($screen, sub {

         # We need to get the data in the paste buffer before we can paste
         # it.
         handler_yank($screen, $config, $match);
         # We need to get the data in the paste buffer before we can paste
         # it.
         handler_yank($screen, $config, $match);


@@ -888,21 +888,21 @@ sub handler_paste {
         # Sleep until we switch back to the current window.
         Time::HiRes::usleep($config->{setting}{paste_sleep});
 
         # Sleep until we switch back to the current window.
         Time::HiRes::usleep($config->{setting}{paste_sleep});
 

-        run_command($config, \@cmd);
+        run_command($screen, $config, \@cmd);

     });
     return;
 }
 sub handler_url {
     my ($screen, $config, $match) = @_;
 
     });
     return;
 }
 sub handler_url {
     my ($screen, $config, $match) = @_;
 

-    debug $config, 'handler_url', "opening $match->{value}";
+    $screen->debug('handler_url', "opening $match->{value}");

 
 

-    run_in_background($config, sub {
+    run_in_background($screen, sub {

         my @cmd = map { $screen->encode($_) } (
             @{$config->{setting}{browser}},
             $match->{value},
         );
         my @cmd = map { $screen->encode($_) } (
             @{$config->{setting}{browser}},
             $match->{value},
         );

-        run_command($config, \@cmd);
+        run_command($screen, $config, \@cmd);

     });
     return;
 }
     });
     return;
 }


@@ -1111,7 +1111,7 @@ my %setting = (
 
 =over
 
 
 =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()>
 


@@ -1153,8 +1153,9 @@ Example:
         my ($screen, $config, $match) = @_;
 
         if ($match->{value} =~ m{^https://www.youtube.com/}) {
         my ($screen, $config, $match) = @_;
 
         if ($match->{value} =~ m{^https://www.youtube.com/}) {

-            return run_in_background($config, sub {
-                run_command($config, ['youtube-dl-wrapper', $match->{value}]);
+            return run_in_background($screen, sub {
+                run_command($screen, $config,
+                            ['youtube-dl-wrapper', $match->{value}]);

             });
         }
         handler_url(@_);
             });
         }
         handler_url(@_);


@@ -1341,7 +1342,7 @@ eval {
     while (1) {
         if (not defined $mapping) {
             $key = $screen->getch unless defined $key;
     while (1) {
         if (not defined $mapping) {
             $key = $screen->getch unless defined $key;

-            debug \%config, 'input', "got key '$key'";
+            $screen->debug('input', "got key '$key'");

 
             $mapping = $config{mapping}{mode}{$key};
             $mapping = $config{mapping}{simple}{$key} unless defined $mapping;
 
             $mapping = $config{mapping}{mode}{$key};
             $mapping = $config{mapping}{simple}{$key} unless defined $mapping;


@@ -1351,22 +1352,22 @@ eval {
             }
         }
 
             }
         }
 

-        debug \%config, 'input', 'running mapping';
+        $screen->debug('input', 'running mapping');

         my $result = $mapping->($key, $screen, \%config, $input);
         $mapping = undef;
 
 RESULT:
         if (defined $result->{quit}) {
         my $result = $mapping->($key, $screen, \%config, $input);
         $mapping = undef;
 
 RESULT:
         if (defined $result->{quit}) {

-            debug \%config, 'input', 'quitting';
+            $screen->debug('input', 'quitting');

             last;
         }
         if (defined $result->{key}) {
             $key = $result->{key}; # lookup another mapping
             last;
         }
         if (defined $result->{key}) {
             $key = $result->{key}; # lookup another mapping

-            debug \%config, 'input', "processing new key: '$key'";
+            $screen->debug('input', "processing new key: '$key'");

             next;
         }
         if (defined $result->{select}) {
             next;
         }
         if (defined $result->{select}) {

-            debug \%config, 'input', 'selecting match';
+            $screen->debug('input', 'selecting match');

             my $tmp = $result;
             $result = select_match($result->{select},
                                 $screen, \%config, $input,
             my $tmp = $result;
             $result = select_match($result->{select},
                                 $screen, \%config, $input,


@@ -1376,22 +1377,22 @@ RESULT:
             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{extend}) {
             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{extend}) {

-            debug \%config, 'input', 'extending match';
+            $screen->debug('input', 'extending match');

             $result = extend_match($screen, \%config, $input,
                                    $result->{match});
             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{match}) {
             $result = extend_match($screen, \%config, $input,
                                    $result->{match});
             goto RESULT; # reprocess special entries in result
         }
         if (defined $result->{match}) {

-            if (not defined $result->{match}->{value}) {
-                $result->{match}->{value} = $result->{match}->{string};
+            if (not defined $result->{match}{value}) {
+                $result->{match}{value} = $result->{match}{string};

             }
 
             }
 

-            debug \%config, 'input', 'running handler';
+            $screen->debug('input', 'running handler');

 
             # Choose handler with falling priority.
             my @handlers = (
                 $config{state}{handler},     # set by user
 
             # Choose handler with falling priority.
             my @handlers = (
                 $config{state}{handler},     # set by user

-                $result->{match}->{handler}, # set by match
+                $result->{match}{handler},   # set by match

                 $result->{handler},          # set by mapping
                 $config{handler}{yank},      # fallback
             );
                 $result->{handler},          # set by mapping
                 $config{handler}{yank},      # fallback
             );