/usr/share/perl5/Gscan2pdf/Frontend/CLI.pm is in gscan2pdf 2.1.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 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 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 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 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 | package Gscan2pdf::Frontend::CLI;
use strict;
use warnings;
use feature 'switch';
no if $] >= 5.018, warnings => 'experimental::smartmatch';
use Locale::gettext 1.05; # For translations
use Carp;
use Text::ParseWords;
use Glib qw(TRUE FALSE);
use POSIX qw(locale_h :signal_h :errno_h :sys_wait_h);
use Proc::Killfam;
use IPC::Open3;
use IO::Handle;
use Gscan2pdf::NetPBM;
use Gscan2pdf::Scanner::Options;
use Gscan2pdf::Dialog::Scan;
use Gscan2pdf::Translation '__'; # easier to extract strings with xgettext
use Image::Sane ':all'; # To get SANE_NAME_PAGE_WIDTH & SANE_NAME_PAGE_HEIGHT
use Cwd;
use File::Spec;
use Readonly;
Readonly my $_POLL_INTERVAL => 100; # ms
Readonly my $_100 => 100;
Readonly my $_1KB => 1024;
Readonly my $ALL_PENDING_ZOMBIE_PROCESSES => -1;
Readonly my $INFINITE_DOCUMENTS => -1;
our $VERSION = '2.1.0';
my $EMPTY = q{};
my $COMMA = q{,};
my ( $_self, $logger );
my $mess_warmingup1 =
qr/Scanner[ ]warming[ ]up[ ]-[ ]waiting[ ]\d*[ ]seconds/xsm;
my $mess_warmingup2 = qr/wait[ ]for[ ]lamp[ ]warm-up/xsm;
my $mess_warmingup = qr/$mess_warmingup1|$mess_warmingup2/xsm;
my $page_no = qr/page[ ](\d*)/xsm;
sub setup {
( my $class, $logger ) = @_;
$_self = {};
return;
}
sub get_devices {
my ( $class, %options ) = @_;
_watch_cmd(
cmd =>
"$options{prefix} scanimage --formatted-device-list=\"'%i','%d','%v','%m','%t'%n\"",
started_callback => $options{started_callback},
running_callback => $options{running_callback},
finished_callback => sub {
my ( $output, $error ) = @_;
if ( defined $options{finished_callback} ) {
$options{finished_callback}
->( Gscan2pdf::Frontend::CLI->parse_device_list($output) );
}
}
);
return;
}
sub parse_device_list {
my ( $class, $output ) = @_;
my (@device_list);
if ( not defined $output ) { return [] }
$logger->info($output);
# parse out the device and model names
my @words =
parse_line( $COMMA, 0, substr $output, 0, index( $output, "'\n" ) + 1 );
while (@words) {
$output = substr $output, index( $output, "'\n" ) + 2, length $output;
shift @words;
push @device_list,
{
name => shift @words,
vendor => shift @words,
model => shift @words,
type => shift @words
};
@words = parse_line( $COMMA, 0, substr $output,
0, index( $output, "'\n" ) + 1 );
}
return \@device_list;
}
sub find_scan_options {
my ( $class, %options ) = @_;
if ( not defined $options{prefix} ) { $options{prefix} = $EMPTY }
if ( not defined $options{frontend} or $options{frontend} eq $EMPTY ) {
$options{frontend} = 'scanimage';
}
# Get output from scanimage or scanadf.
my $cmd = _create_scanimage_cmd( \%options );
_watch_cmd(
cmd => $cmd,
started_callback => $options{started_callback},
running_callback => $options{running_callback},
finished_callback => sub {
my ( $output, $error ) = @_;
if ( defined $error and defined $options{error_callback} ) {
while ( $error =~ /([\r\n])/xsm ) {
my $le = $1;
my $line = substr $error, 0, index $error, $le;
$error = substr $error, index( $error, $le ) + 1,
length $error;
if ( $line =~ /^$options{frontend}:[ ](.*)/xsm ) {
my $msg = $1;
if ( $msg !~ /rounded/xsm ) {
$options{error_callback}->($msg);
}
}
}
}
my $options = Gscan2pdf::Scanner::Options->new_from_data($output);
$_self->{device_name} = Gscan2pdf::Scanner::Options->device;
if ( defined $options{finished_callback} ) {
$options{finished_callback}->($options);
}
}
);
return;
}
# Select wrapper method for _scanadf() and _scanimage()
sub scan_pages {
my ( $class, %options ) = @_;
if ( not defined $options{prefix} ) { $options{prefix} = $EMPTY }
if (
defined $options{frontend}
and ( $options{frontend} eq 'scanadf'
or $options{frontend} eq 'scanadf-perl' )
)
{
_scanadf(%options);
}
else {
_scanimage(%options);
}
return;
}
sub parse_scanimage_output {
my ( $line, $options ) = @_;
given ($line) {
# scanimage seems to produce negative progress percentages
# in some circumstances
when (/^Progress:[ ](-?\d*[.]\d*)%/xsm) {
if ( defined $options->{running_callback} ) {
$options->{running_callback}->( $1 / $_100 );
}
}
when (/^Scanning[ ](-?\d*|infinity)[ ]pages?/xsm) {
my $num = $1 eq 'infinity' ? $INFINITE_DOCUMENTS : $1;
if ( defined $options->{running_callback} ) {
$options->{running_callback}
->( 0, sprintf __('Scanning %i pages...'), $num );
}
}
when (/^Scanning[ ]$page_no/xsm) {
if ( defined $options->{running_callback} ) {
$options->{running_callback}
->( 0, sprintf __('Scanning page %i...'), $1 );
}
}
when (/^Scanned[ ]$page_no [.][ ][(]scanner[ ]status[ ]=[ ](\d)[)]/xsm)
{
my ( $id, $return ) = ( $1, $2 );
if ( $return == SANE_STATUS_EOF ) {
my $timer = Glib::Timeout->add(
$_POLL_INTERVAL,
sub {
my $path =
defined( $options->{dir} )
? File::Spec->catfile( $options->{dir}, "out$id.pnm" )
: "out$id.pnm";
if ( not -e $path ) {
return Glib::SOURCE_CONTINUE;
}
if ( defined $options->{new_page_callback} ) {
$options->{new_page_callback}->( $path, $id );
}
$options->{num_scans}++;
return Glib::SOURCE_REMOVE;
}
);
}
}
when ($mess_warmingup) {
if ( defined $options->{running_callback} ) {
$options->{running_callback}->( 0, __('Scanner warming up') );
}
}
when (
/^$options->{frontend}:[ ]sane_start:[ ]Document[ ]feeder[ ]out[ ]of[ ]documents/xsm ## no critic (ProhibitComplexRegexes)
)
{
if ( defined $options->{error_callback}
and $options->{num_scans} == 0 )
{
$options->{error_callback}
->( __('Document feeder out of documents') );
}
}
when (
$_self->{abort_scan} == TRUE
and ( $line =~
qr{^$options->{frontend}:[ ]sane_start:[ ]Error[ ]during[ ]device[ ]I/O}xsm
or $line =~ /^$options->{frontend}:[ ]received[ ]signal/xsm
or $line =~ /^$options->{frontend}:[ ]aborting/xsm
or $line =~
/^$options->{frontend}:[ ]trying[ ]to[ ]stop[ ]scanner/xsm )
)
{
;
}
when (/^$options->{frontend}:[ ]rounded/xsm) {
$logger->info( substr $line, 0, index( $line, "\n" ) + 1 );
}
when (/^Batch[ ]terminated,[ ]\d+[ ]pages?[ ]scanned/xsm) {
$logger->info( substr $line, 0, index( $line, "\n" ) + 1 );
}
when (
/^$options->{frontend}:[ ]sane_(?:start|read):[ ]Device[ ]busy/xsm)
{
if ( defined $options->{error_callback} ) {
$options->{error_callback}->( __('Device busy') );
}
}
when (
/^$options->{frontend}:[ ]sane_(?:start|read):[ ]Operation[ ]was[ ]cancelled/xsm
)
{
if ( defined $options->{error_callback} ) {
$options->{error_callback}->( __('Operation cancelled') );
}
}
default {
if ( defined $options->{error_callback} ) {
$options->{error_callback}->(
__('Unknown message: ') . substr $line,
0, index $line, "\n"
);
}
}
}
return;
}
# Carry out the scan with scanimage and the options passed.
sub _scanimage {
my (%options) = @_;
if ( not defined $options{frontend} or $options{frontend} eq $EMPTY ) {
$options{frontend} = 'scanimage';
}
my $cmd = _create_scanimage_cmd( \%options, TRUE );
# flag to ignore error messages after cancelling scan
$_self->{abort_scan} = FALSE;
# flag to ignore out of documents message
# if successfully scanned at least one page
$options{num_scans} = 0;
_watch_cmd(
cmd => $cmd,
dir => $options{dir},
started_callback => $options{started_callback},
err_callback => sub {
my ($line) = @_;
parse_scanimage_output( $line, \%options );
},
finished_callback => $options{finished_callback}
);
return;
}
# Helper sub to create the scanimage command
sub _create_scanimage_cmd {
my ( $options, $scan ) = @_;
my %options = %{$options};
if ( not defined $options{frontend} ) {
$options{frontend} = 'scanimage';
}
my $help = $scan ? $EMPTY : '--help';
# inverted commas needed for strange characters in device name
my $device = "--device-name='$options{device}'";
my @options;
if ( defined $options{options} ) {
my $iter = $options{options}->each_backend_option;
while ( my $i = $iter->() ) {
my ( $key, $val ) =
$options{options}->get_backend_option_by_index($i);
if ( $key =~ /^[xytl]$/xsm ) {
push @options, "-$key $val";
}
elsif ( defined $val ) {
push @options, "--$key='$val'";
}
else {
push @options, "--$key";
}
}
}
if ( not $help ) {
push @options, '--batch';
push @options, '--progress';
if ( defined $options{start} and $options{start} != 0 ) {
push @options, "--batch-start=$options{start}";
}
if ( defined $options{npages} and $options{npages} != 0 ) {
push @options, "--batch-count=$options{npages}";
}
if ( defined $options{step} and $options{step} != 1 ) {
push @options, "--batch-increment=$options{step}";
}
}
# Create command
return "$options{prefix} $options{frontend} $help $device @options";
}
# Carry out the scan with scanadf and the options passed.
sub _scanadf {
my (%options) = @_;
if ( not defined $options{frontend} ) { $options{frontend} = 'scanadf' }
# inverted commas needed for strange characters in device name
my $device = "--device-name='$options{device}'";
# Add basic options
my @options;
if ( defined $options{options} ) { @options = @{ $options{options} } }
push @options, '--start-count=1';
if ( $options{npages} != 0 ) {
push @options, "--end-count=$options{npages}";
}
push @options, '-o out%d.pnm';
# Create command
my $cmd = "$options{prefix} $options{frontend} $device @options";
# scanadf doesn't have a progress option, so create a timeout to check
# the size of the image being currently scanned.
my $size;
my $id = 1;
my $running = TRUE;
if ( defined $options{running_callback} ) {
my $timer = Glib::Timeout->add(
$_POLL_INTERVAL,
sub {
if ($running) {
if ( defined $size ) {
if ($size) {
$options{running_callback}
->( ( -s "out$id.pnm" ) / $size );
}
else {
# Pulse
$options{running_callback}->();
}
}
# 50 is enough of the file for the header to be complete
elsif ( -e "out$id.pnm"
and ( -s "out$id.pnm" ) >
50 ) ## no critic (ProhibitMagicNumbers)
{
$size = Gscan2pdf::NetPBM::file_size_from_header(
"out$id.pnm");
}
else {
# Pulse
$options{running_callback}->();
}
return Glib::SOURCE_CONTINUE;
}
return Glib::SOURCE_REMOVE;
}
);
}
_watch_cmd(
cmd => $cmd,
dir => $options{dir},
started_callback => $options{started_callback},
err_callback => sub {
my ($line) = @_;
given ($line) {
when ($mess_warmingup) {
if ( defined $options{running_callback} ) {
$options{running_callback}
->( 0, __('Scanner warming up') );
}
}
when (/^Scanned[ ]document[ ]out(\d*)[.]pnm/xsm) {
$id = $1;
# Timer will run until callback returns false
my $timer = Glib::Timeout->add(
$_POLL_INTERVAL,
sub {
my $path =
defined( $options{dir} )
? File::Spec->catfile( $options{dir},
"out$id.pnm" )
: "out$id.pnm";
if ( not -e $path ) {
return Glib::SOURCE_CONTINUE;
}
if ( defined $options{new_page_callback} ) {
$options{new_page_callback}->( $path, $id );
}
return Glib::SOURCE_REMOVE;
}
);
# Prevent the Glib::Timeout from checking the size of the file when it is
# about to be renamed
undef $size;
}
when (/^Scanned[ ]\d*[ ]pages/xsm) {
;
}
when (/^$options{frontend}:[ ]rounded/xsm) {
$logger->info( substr $line, 0, index( $line, "\n" ) + 1 );
}
when (/^$options{frontend}:[ ]sane_start:[ ]Device[ ]busy/xsm) {
if ( defined $options{error_callback} ) {
$options{error_callback}->( __('Device busy') );
}
$running = FALSE;
}
when (
/^$options{frontend}:[ ]sane_read:[ ]Operation[ ]was[ ]cancelled/xsm
)
{
if ( defined $options{error_callback} ) {
$options{error_callback}->( __('Operation cancelled') );
}
$running = FALSE;
}
default {
if ( defined $options{error_callback} ) {
$options{error_callback}->(
__('Unknown message: ') . substr $line,
0, index $line, "\n"
);
}
}
}
},
finished_callback => sub {
if ( defined $options{finished_callback} ) {
$options{finished_callback}->();
}
$running = FALSE;
}
);
return;
}
# Flag the scan routine to abort
sub cancel_scan {
$_self->{abort_scan} = TRUE;
return;
}
# Only needed by unit tests to reset $_self->{abort_scan}
sub uncancel_scan {
$_self->{abort_scan} = FALSE;
return;
}
sub device {
return $_self->{device_name};
}
sub _watch_cmd {
my (%options) = @_;
my $out_finished = FALSE;
my $err_finished = FALSE;
my $error_flag = FALSE;
$logger->info( $options{cmd} );
if ( defined $options{running_callback} ) {
my $timer = Glib::Timeout->add(
$_POLL_INTERVAL,
sub {
$options{running_callback}->();
return Glib::SOURCE_REMOVE
if ( $out_finished or $err_finished );
return Glib::SOURCE_CONTINUE;
}
);
}
# Make sure we are in temp directory
my $cwd = getcwd;
if ( defined $options{dir} ) { chdir $options{dir} }
# Interface to scanimage
my ( $write, $read );
my $error = IO::Handle->new; # this needed because of a bug in open3.
my $pid = IPC::Open3::open3( $write, $read, $error, $options{cmd} );
$logger->info("Forked PID $pid");
# change back to original directory
chdir $cwd;
if ( defined $options{started_callback} ) { $options{started_callback}->() }
if ( $_self->{abort_scan} ) {
local $SIG{INT} = 'IGNORE';
$logger->info("Sending INT signal to PID $pid and its children");
killfam 'INT', ($pid);
}
my ( $stdout, $stderr, $error_message );
_add_watch(
$read,
sub {
my ($line) = @_;
$stdout .= $line;
if ( defined $options{out_callback} ) {
$options{out_callback}->($line);
}
},
sub {
# Don't flag this until after the callback to avoid the race condition
# where stdout is truncated by stderr prematurely reaping the process
$out_finished = TRUE;
},
sub {
($error_message) = @_;
$error_flag = TRUE;
}
);
_add_watch(
$error,
sub {
my ($line) = @_;
$stderr .= $line;
if ( defined $options{err_callback} ) {
$options{err_callback}->($line);
}
},
sub {
# Don't flag this until after the callback to avoid the race condition
# where stderr is truncated by stdout prematurely reaping the process
$err_finished = TRUE;
},
sub {
($error_message) = @_;
$error_flag = TRUE;
}
);
# Watch for the process to hang up before running the finished callback
Glib::Child->watch_add(
$pid,
sub {
# Although the process has hung up, we may still have output to read,
# so wait until the _watch_add flags that the process has ended first.
my $timer = Glib::Timeout->add(
$_POLL_INTERVAL,
sub {
if ($error_flag) {
if ( defined $options{error_callback} ) {
$options{error_callback}->($error_message);
}
return Glib::SOURCE_REMOVE;
}
elsif ( $out_finished and $err_finished ) {
if ( defined $options{finished_callback} ) {
$options{finished_callback}->( $stdout, $stderr );
}
$logger->info('Waiting to reap process');
$logger->info( 'Reaped PID ',
waitpid $ALL_PENDING_ZOMBIE_PROCESSES, WNOHANG );
return Glib::SOURCE_REMOVE;
}
return Glib::SOURCE_CONTINUE;
}
);
}
);
return;
}
sub _add_watch {
my ( $fh, $line_callback, $finished_callback, $error_callback ) = @_;
my $line;
Glib::IO->add_watch(
fileno($fh),
[ 'in', 'hup' ],
sub {
my ( $fileno, $condition ) = @_;
my $buffer;
if ( $condition & 'in' ) { # bit field operation. >= would also work
# Only reading one buffer, rather than until sysread gives EOF
# because things seem to be strange for stderr
sysread $fh, $buffer, $_1KB;
if ($buffer) { $line .= $buffer }
while ( $line =~ /([\r\n])/xsm ) {
my $le = $1;
if ( defined $line_callback ) {
$line_callback->(
substr $line, 0, index( $line, $le ) + 1
);
}
$line = substr $line, index( $line, $le ) + 1, length $line;
}
}
# Only allow the hup if sure an empty buffer has been read.
if (
( $condition & 'hup' ) # bit field operation. >= would also work
and ( not defined $buffer or $buffer eq $EMPTY )
)
{
if ( close $fh ) {
$finished_callback->();
}
elsif ( defined $error_callback ) {
$error_callback->('Error closing filehandle');
}
return Glib::SOURCE_REMOVE;
}
return Glib::SOURCE_CONTINUE;
}
);
return;
}
1;
__END__
|