#! /opt/local/bin/perl
#
# Copyright (C) 2012-2022 Alexis Bienvenüe <paamc@passoire.fr>
#
# This file is part of Auto-Multiple-Choice
#
# Auto-Multiple-Choice is free software: you can redistribute it
# and/or modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation, either version 2 of
# the License, or (at your option) any later version.
#
# Auto-Multiple-Choice is distributed in the hope that it will be
# useful, but WITHOUT ANY WARRANTY; without even the implied warranty
# of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Auto-Multiple-Choice.  If not, see
# <http://www.gnu.org/licenses/>.

use warnings;
use 5.012;

use AMC::Basic;
use AMC::Gui::Avancement;

use File::Spec::Functions
  qw/splitpath catpath splitdir catdir catfile rel2abs tmpdir/;
use File::Temp qw/ tempdir /;
use File::Copy;

use Getopt::Long;

use_gettext;

my $list_file        = '';
my $progress_id      = '';
my $copy_to          = '';
my $debug            = '';
my $vector_density   = 300;
my $orientation      = "";
my $rotate_direction = "90";
my $force_convert    = 0;
my $password         = '';
my $pdfimages_opts   = '';
my %use = ( pdfimages => 1, pdftk => 1, qpdf => 1, gs => 1 );

GetProjectOptions(
    "list=s"                                => \$list_file,
    "progression-id=s"                      => \$progress_id,
    "copy-to=s"                             => \$copy_to,
    ":vector_scan_density|vector-density=s" => \$vector_density,
    ":pdfimages_opts|pdfimages-opts=s"      => \$pdfimages_opts,
    "orientation=s"                         => \$orientation,
    "rotate-direction=s"                    => \$rotate_direction,
    "use-pdfimages!"                        => \$use{pdfimages},
    "use-pdftk!"                            => \$use{pdftk},
    "use-qpdf!"                             => \$use{qpdf},
    "use-gs!"                               => \$use{gs},
    ":force_convert|force-convert!"         => \$force_convert,
    ":pdf_password|password=s"              => \$password,
);

debug("Copy to $copy_to") if ($copy_to);

$use{pdfimages} = 0 if ($force_convert);

# cancels use of pdfimages/pdftk if these commands are not available
# on the system

for my $cmd (qw/pdfimages pdftk qpdf/) {
    if ( $use{$cmd} && !commande_accessible($cmd) ) {
        debug "WARNING: command $cmd not found";
        $use{$cmd} = 0;
    }
}

# delete trailing / in the --copy-to directory option

$copy_to =~ s:(?<=.)/+$::;

# filenames of scan files are handled by a hashref that reminds if the
# file has already been processed: in this hash,
#
# * path is the whole path of the scan,
# * dir is the directory part of the path
# * file is the file part of the path
# * orig is 1 if the file is the original scan

# original_file builds a hashref for a original scan file (not yet
# processed or split or moved)

my $original_file_index = 1;

sub original_file {
    my ($file_path) = @_;
    return ( { path => $file_path,
               orig => 1,
               index => $original_file_index++ } );
}

# derivative_file builds a hashref for a file that has already been
# processed in some way by AMC-getimages

sub derivative_file {
    my ($origin, $file_path) = @_;
    return ( { path => $file_path, index => $origin->{index} } );
}

# check_split_path($f,$force) computes (if $force is set, or if not
# yet already done) the dir and file parts of the path

sub check_split_path {
    my ( $f, $force ) = @_;
    if ( $f->{path} && ( $force || !$f->{file} ) ) {
        my ( $fxa, $fxb, $file ) = splitpath( $f->{path} );
        $f->{file} = $file;
        $f->{dir}  = catpath( $fxa, $fxb, '' );
    }
}

# variables to show progress

my $dp;
my $p;
$p = AMC::Gui::Avancement::new( 1, id => $progress_id )
  if ($progress_id);

# image_size computes the image size (width,height) using 'identify'
# from ImageMagick/GraphicsMagick

sub image_size {
    my ($file) = @_;
    my @r = ();
    my @cmd = ( magick_module("identify"), "-format", "%w,%h\n", $file );
    if ( open( IDF, "-|", @cmd ) ) {
        while (<IDF>) {
            chomp();
            @r = ( $1, $2 ) if (/([^,]+),(.*)/);
        }
        close(IDF);
    } else {
        debug( "CMD: " . join( ' ', @cmd ) );
        debug("ERROR: $!");
    }
    return (@r);
}

# image_orientation returns "portrait", "landscape" or "" (in
# indetermined cases) depending on the image orientation.

sub image_orientation {
    my ($file) = @_;
    my ( $w, $h ) = image_size($file);
    if ( defined($h) && defined($w) ) {
        return (
            $h > 1.1 * $w ? "portrait" : $w > 1.1 * $h ? "landscape" : "" );
    } else {
        debug "WARNING: undefined image orientation for $file";
        return (undef);
    }
}

# move_derivative($origin,$derivative) moves the file descried by
# $derivative to the same directory as $origin (changing its name if a
# file with this name already exists), and then updates $derivative to
# point to the new location, and returns it.

sub move_derivative {
    my ( $origin, $derivative ) = @_;
    if ( !$copy_to ) {
        check_split_path($origin);
        check_split_path($derivative);
        my $dest = new_filename( $origin->{dir} . "/" . $derivative->{file} );
        debug "Moving $derivative->{path} to $dest";
        if ( !move( $derivative->{path}, $dest ) ) {
            debug_and_stderr "File move failed: $dest";
        }
        $derivative->{path} = $dest;
        check_split_path( $derivative, 1 );
    }
    return ($derivative);
}

# replace_by($origin,@derivative_paths) is called after a scan file
# described by $origin has been split in several files. It moves the
# derivative files to the same directory has the origin, deletes the
# $origin file if it is not an original scan file (has already been
# processed in some way), and returns the derivatives files
# descriptions array.

sub replace_by {
    my ( $origin, @derivative_paths ) = @_;
    my @fd =
      map { move_derivative( $origin, derivative_file($origin, $_) ) } @derivative_paths;
    unlink $origin->{path}
      if ( !$origin->{orig} );
    return (@fd);
}

###################################################################
# STEP 0: collects all original scan provided as arguments of the
# command, or in a file

my @f = map { original_file($_) } (@ARGV);
my @fs;

if ( -f $list_file ) {
    open( LIST, "<:utf8", $list_file );
    while (<LIST>) {
        chomp;
        push @f, original_file($_);
    }
    close(LIST);
}

###################################################################
# STEP 1: split multi-page PDF with pdfimages, pdftk or qpdf, which use
# less memory than ImageMagick

if ( $use{pdfimages} || $use{pdftk} || $use{qpdf} ) {

    # @pdfs is the list of PDF files

    my @pdfs = grep { $_->{path} =~ /\.pdf$/i } @f;

    # starts PDFs processing...

    if (@pdfs) {

        # @fs will collect all split pages from PDF files.

        @fs = ();

        $dp = 1 / ( 1 + $#pdfs );
        $p->text( __("Splitting multi-page PDF files...") ) if ($p);

      PDF: for my $file (@f) {
            if ( $file->{path} !~ /\.pdf$/i ) {
                push @fs, $file;
            } else {

                $p->progres($dp) if ($p);

                # makes a temporary directory to extract images from the PDF

                my $temp_loc = tmpdir();
                my $temp_dir;

                check_split_path($file);

                # First, try pdfimages, which is much more judicious

                if ( $use{pdfimages} ) {
                    $temp_dir = tempdir(
                        DIR     => $temp_loc,
                        CLEANUP => ( !get_debug() )
                    );
                    debug "PDF split tmp dir / pdfimages: $temp_dir";

                    my @pdfimages_command = ("pdfimages");
                    push @pdfimages_command, "-upw", $password
                        if ( $password ne '' );
                    push @pdfimages_command,
                      grep { $_ ne '' } split( /\s+/, $pdfimages_opts )
                      if ($pdfimages_opts);

                    if (
                        system_debug(
                            cmd => [
                                @pdfimages_command, "-p", $file->{path},
                                $temp_dir . '/' . $file->{file} . '-page'
                            ]
                        ) == 0
                      )
                    {

                        opendir( my $dh, $temp_dir )
                          || debug "can't opendir $temp_dir: $!";
                        my @images = map { "$temp_dir/$_" }
                          sort { $a cmp $b } grep { /-page-/ } readdir($dh);
                        closedir $dh;

                        if (@images) {

                            # pdfimages produced some files. Check that the page
                            # numbers follow each other starting from 1

                            my $ok = 1;
                          PDFIM: for my $i ( 0 .. $#images ) {
                                if ( $images[$i] =~ /-page-([0-9]+)/ ) {
                                    my $pp = $1;
                                    if ( $pp != $i + 1 ) {
                                        debug "INFO: missing page "
                                          . ( $i + 1 )
                                          . " from pdfimages";
                                        $ok = 0;
                                        last PDFIM;
                                    }
                                }
                            }
                            if ($ok) {
                                debug "pdfimages ok for $file->{file}";
                                push @fs, replace_by( $file, @images );
                                next PDF;
                            }
                        } else {
                            debug "INFO: pdfimages produced no file";
                        }

                    } else {
                        debug "ERROR while trying pdfimages...";
                    }
                }

                # Second, try qpdf
                if ( $use{qpdf} ) {
                    $temp_dir = tempdir(
                        DIR     => $temp_loc,
                        CLEANUP => ( !get_debug() )
                    );
                    debug "PDF split tmp dir / qpdf: $temp_dir";

                    my @qpdf_command = ("qpdf");
                    push @qpdf_command, "--password=$password"
                      if ( $password ne '' );

                    if (
                        system_debug(
                            cmd => [
                                @qpdf_command,
                                $file->{path},
                                "--split-pages",
                                $temp_dir . '/'
                                  . $file->{file}
                                  . '-page-%d.pdf'
                            ]
                        ) == 0
                      )
                    {

                        opendir( my $dh, $temp_dir )
                          || debug "can't opendir $temp_dir: $!";
                        my @images = map { "$temp_dir/$_" }
                          sort { $a cmp $b } grep { /-page-/ } readdir($dh);
                        closedir $dh;

                        if (@images) {

                            debug "qpdf ok for $file->{file}";
                            push @fs, replace_by( $file, @images );
                            next PDF;

                        } else {
                            debug "INFO: qpdf produced no file";
                        }

                    } else {
                        debug "ERROR while trying qpdf...";
                    }
                }

                # If not successful with pdfimages and qpdf, use pdftk

                if ( $use{pdftk} ) {
                    $temp_dir = tempdir(
                        DIR     => $temp_loc,
                        CLEANUP => ( !get_debug() )
                    );
                    debug "PDF split tmp dir / pdftk: $temp_dir";

                    my @pdftk_command = ( "pdftk", $file->{path} );
                    push @pdftk_command, "input_pw", $password
                      if ( $password ne '' );

                    if (
                        system(
                            cmd => [
                                @pdftk_command,
                                "burst",
                                "output",
                                $temp_dir . '/'
                                  . $file->{file}
                                  . '-page-%04d.pdf'
                            ]
                        ) == 0
                      )
                    {

                        opendir( my $dh, $temp_dir )
                          || debug "can't opendir $temp_dir: $!";
                        my @burst = replace_by( $file,
                            map  { "$temp_dir/$_" }
                            sort { $a cmp $b }
                            grep { /-page-/ } readdir($dh) );
                        closedir $dh;

                        if (@burst) {
                            push @fs, @burst;
                            next PDF;
                        } else {
                            debug "WARNING: pdftk produced no file";
                        }

                    } else {
                        debug "ERROR while trying pdftk burst...";
                    }
                }

                # no success... keep the PDF to be processed by magick

                push @fs, $file;
            }
        }

        $p->text('') if ($p);

        # To end, replaces the file list

        @f = @fs;
    }

}

###################################################################
# STEP 2: split other multi-page images (such as TIFF) with
# ImageMagick, and convert vector to bitmap

@fs = ();
for my $fich (@f) {
    check_split_path($fich);

    if ( $fich->{file} =~ /\.(pdf|eps|ps)$/i
        && commande_accessible('gs') && $use{gs} )
    {
        # ghostscript is preferred for PDF, EPS and PS files.

        my $temp_loc = tmpdir();
        my $temp_dir = tempdir(
            DIR     => $temp_loc,
            CLEANUP => ( !get_debug() )
        );

        debug "GS split tmp dir: $temp_dir";
        my $fb = $fich->{file};
        if ( !( $fb =~ s/\.([^.]+)$/_%04d.$1/ ) ) {
            $fb .= '_%04d';
        }
        $fb .= ".png";

        my @cmd = (
            "gs",                         "-sDEVICE=png16m",
            "-sOutputFile=$temp_dir/$fb", "-r$vector_density",
            "-dNOPAUSE",                  "-dSAFER",
            "-dBATCH"
                  );
        push @cmd, "-sPDFPassword=$password" if($password ne '');
        push @cmd, "-dQUIET" if ( !get_debug() );
        system_debug( cmd => [ @cmd, $fich->{path} ], die_on_error => 1 );

        opendir( my $dh, $temp_dir ) || debug "can't opendir $temp_dir: $!";
        push @fs,
          replace_by( $fich,
            grep { -f "$_" } map { "$temp_dir/$_" }
            sort { $a cmp $b } readdir($dh) );
        closedir $dh;

    } else {

        # Image files, that maybe need some processing...

        my $suffix_change = '';
        my @pre_options   = ();

        push @pre_options, "-authenticate", $password if ($password ne '');

        # number of pages :
        my $np = 0;

        my $scene = 0;

        # Is this a vector format file? If so, we have to convert it
        # to bitmap
        my $vector = '';
        if ( $fich->{file} =~ /\.(pdf|eps|ps)$/i ) {
            $vector        = 1;
            $suffix_change = '.png';
            push @pre_options, '-density', $vector_density
              if ($vector_density);

            debug "> Scan $fich->{path}: Vector";
        } else {

            # any scene with number > 0 ? This may cause problems with OpenCV
            if (
                open( NP, "-|", magick_module("identify"),
                    "-format", "%s\n", $fich->{path}
                )
              )
            {
                while (<NP>) {
                    chomp();
                    if (/[^\s]/) {
                        $np++;
                        $scene = 1 if ( $_ > 0 );
                    }
                }
                close(NP);
            }

            debug "> Scan $fich->{path}: $np page(s)"
              . ( $scene ? " [has scene>0]" : "" );
        }

        # With ImageMagic, remove alpha channel to get white background
        if ( !use_gm_command() ) {
            push @pre_options, "-alpha", "remove";
        }

        if ( $np > 1 || $scene || $vector || $force_convert ) {

            # split multipage image into 1-page images, and/or convert
            # to bitmap format

            if ($p) {
                if ($vector) {

                    $p->text(
                        sprintf(
# TRANSLATORS: Here, %s will be replaced with the path of a file that will be converted.
                            __("Converting %s to bitmap..."),
                            $fich->{file}
                        )
                    );
                } elsif ( $np > 1 ) {

                    $p->text(
                        sprintf(
# TRANSLATORS: Here, %s will be replaced with the path of a file that will be splitted to several images (one per page).
                            __("Splitting multi-page image %s..."),
                            $fich->{file}
                        )
                    );
                } elsif ( $scene || $force_convert ) {

                    $p->text(
# TRANSLATORS: Here, %s will be replaced with the path of a file that will be splitted to several images (one per page).
                        sprintf( __("Processing image %s..."), $fich->{file} )
                    );
                }
            }

            my $temp_loc = tmpdir();
            my $temp_dir = tempdir(
                DIR     => $temp_loc,
                CLEANUP => ( !get_debug() )
            );

            debug "Image split tmp dir: $temp_dir";

            my $fb = $fich->{file};
            if ( !( $fb =~ s/\.([^.]+)$/_%04d.$1/ ) ) {
                $fb .= '_%04d';
            }
            $fb .= $suffix_change;

            system_debug(
                cmd => [
                    magick_module("convert"), @pre_options,
                    $fich->{path},            "+adjoin",
                    "$temp_dir/$fb"
                ],
                die_on_error => 1
            );
            opendir( my $dh, $temp_dir ) || debug "can't opendir $temp_dir: $!";
            push @fs,
              replace_by( $fich,
                grep { -f "$_" } map { "$temp_dir/$_" }
                sort { $a cmp $b } readdir($dh) );
            closedir $dh;

            $p->text('') if ($p);
        } else {

            # no coversion needed...
            push @fs, $fich;
        }
    }
}

@f = @fs;

###################################################################
# STEP 3: check files orientation (if requested) and rotate them 90°
# if needed.

if ($orientation) {

    $p->text(__"Checking pages orientation...") if($p);
    $dp = 1 / @f if(@f);

    my $temp_dir = tempdir(
        DIR     => tmpdir(),
        CLEANUP => ( !get_debug() )
    );

    @fs = ();
    for my $fich (@f) {
        my $o = image_orientation( $fich->{path} );
        if ( $o && $o ne $orientation ) {
            check_split_path($fich);

            debug "Rotate scan file $fich->{path} to orientation $orientation";
            my $dest = new_filename( $temp_dir . '/rotated-' . $fich->{file} );
            my @cmd  = (
                magick_module("convert"),
                $fich->{path}, "-rotate", $rotate_direction, $dest
            );
            debug "CMD: " . join( ' ', @cmd );

            if ( system_debug( cmd => [@cmd] ) == 0 ) {
                push @fs, replace_by( $fich, $dest );
            } else {
                debug "Error while rotating $fich->{path}...";
                push @fs, $fich;
            }
        } else {
            push @fs, $fich;
        }

        $p->progres($dp) if($p);
    }
    @f = @fs;

    $p->text('') if($p);

}

###################################################################
# STEP 4: if requested, copy files to project directory

if ( $copy_to && @f ) {
    $p->text( __ "Copying scans to project directory..." ) if ($p);

    $dp = 1 / ( 1 + $#f );

    my @fl = ();
    my $c  = 0;
    for my $fich (@f) {
        check_split_path($fich);

        # no accentuated or special characters in filename, please!
        # this could break the process somewere...
        my $fb = string_to_filename( $fich->{file}, 'scan' );

        my $dest = $copy_to . "/" . $fich->{index} . '_' . $fb;

        my $deplace = 0;

        if ( $fich->{path} ne $dest ) {
            if ( -e $dest ) {

                # dest file already exists: change name
                debug "File $dest already exists";
                $dest = new_filename($dest);
                debug "--> $dest";
            }
            debug "$fich->{path} --> $dest";
            if ( copy( $fich->{path}, $dest ) ) {
                push @fl, derivative_file($fich, $dest);
                $deplace = 1;
            } else {
                debug "COPY ERROR: $!";
            }
        }
        $c += $deplace;
        push @fl, derivative_file( $fich, $fich->{path} )
          if ( !$deplace );

        $p->progres($dp) if ($p);
    }
    debug "Copied scan files: " . $c . "/" . ( 1 + $#f );
    @f = @fl;

    $p->text('') if ($p);
}

###################################################################
# STEP 5: updates the files list with processed files names

if ($list_file) {
    open( NEWLIST, ">:utf8", $list_file );
    for (@f) {
        print NEWLIST $_->{path} . "\n";
    }
    close(NEWLIST);
} else {
    debug "WARNING: no output list file requested";
}
