summaryrefslogtreecommitdiffstats
path: root/pdftool.pl
blob: 97c8d6194960c97f8403c473ee4c99b73ebc5cad (plain)
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
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
#! /usr/bin/perl -w

# This program is free software. It comes without any warranty, to the
# extent permitted by applicable law. You can redistribute it and/or
# modify it under the terms of the Do What The Fuck You Want To Public
# License, Version 2, as published by Sam Hocevar.
# See http://sam.zoy.org/wtfpl/COPYING for more details.


$VERSION = "0.5.2, 21 January 2012";

use Getopt::Long qw /:config posix_default no_ignore_case gnu_compat
                             bundling auto_version auto_help/;
use Pod::Usage;
use IPC::Open3;
use File::Spec::Functions qw /tmpdir catfile/;
use POSIX qw /floor/;
use Error qw /:try/;
use strict;


=head1 NAME

pdftool.pl - a swiss army knife for PDF documents

=head1 SYNOPSIS

B<pdftool.pl> [B<-w> I<width> ] [B<-h> I<height>] [B<-p> I<paper>]
[B<-W> I<width>] [B<-H> I<height>] [B<-P> I<paper>] [B<-s> I<pages>]
[B<-m> I<margin>] [B<-b> I<border>] [B<-c>] [B<--book>] [B<--column>]
[B<-n> I<num>] [B<--auto-rotate>] [B<--ps>] [B<-q>] [I<infile> [I<outfile>]]

B<pdftool.pl> [I<OPTIONS>] I<infile1> ... [I<OPTIONS>] I<infilen> [I<OPTIONS>] I<outfile>

=head1 DESCRIPTION

B<PDFTool> combines the tools in the PSUtils bundle in a nice way. The
inputs should be either Portable Document Format (PDF) files, or
PostScript files.

If no input file is given, or if a single hyphen-minus (I<->) is given as
file name, B<PDFTool> reads the PDF or PostScript data from the standard
input. If a PDF is sent to the standard input, an auxiliary file is
created (because reading a PDF requires random access to the data), and removed
afterwards. Also, if the input size is not specified (options B<-W> and B<-H>,
or B<-P>) for a non seekable input file, an auxiliary file is created,
and removed afterwards.

The input page size is by default guessed from the input document. However,
the options B<-P>, B<-W> and B<-H> let you choose a specific input page
size, while B<-c> makes B<PDFTool> ignore the input page size and
calculate the minimal bouding box instead. The default output page size
is I<a4>.

If no output file is given, or if a single hyphen-minus (I<->) is given as
file name, B<PDFTool> sends the data to the standard output. By
default, B<PDFTool> outputs a PDF document; Use B<--ps> to
get a PostScript instead.

If n>2 files are passed to B<PDFTool>, the n-1 first will be
processed (using the set of options given immediately before each
argument) and then merged. A global set of options can be passed after the
last input file: they will be applied to all the inputs (the local
taking precedence, in case of clashes).
NOTE: The options B<-p>, B<-w>, B<-h>, B<--auto-rotate>, B<--ps> and
B<-q> refer to the output file only, hence should be set only once.


B<PDFTool> does the following passes on the input documents:

=over 4

=item *

Convert from PDF to PostScript if necessary (if possible,
that is if all page numbers are relative to the begining of the
document, convert only the smallest interval that contains all the selected
pages),

=item *

Select the page range if necessary (option B<-s>),

=item *

Calculate the minimal bounding box (option B<-c>),

=item *

Rearrange pages for printing books or booklets if necessary
(option B<--book>),

=item *

Put multiple pages per sheets (option B<-n>), and

=item *

"Flatten" the output, and convert it to PDF (if the flag B<--ps> is not set).

=back

=head1 OPTIONS

=over 8

=item B<-s> I<pages>, B<--select=>I<pages>

Specify the pages which are to be selected.
I<Pages> is a comma separated list of page ranges, each of which
may be a page number, or a page range of the form
I<first>-I<last>. If I<first> is omitted, the first page is assumed,
and if I<last> is omitted, the last page is assumed.

The prefix character `_' indicates that the page number is relative
to the end of the document, counting backwards. If just this
character with no page number is used, a blank page will be inserted.

=item B<-w> I<length>, B<--width=>I<length>

Specify the width of the output file. If the height is not specified as
well, it will be ignored. The known units are I<pt>, I<in>, I<cm> and
I<mm>. The default unit is I<pt>.

=item B<-h> I<length>, B<--height=>I<length>

Specify the height of the output file. If the width is not specified as
well, it will be ignored. The known units are I<pt>, I<in>, I<cm> and
I<mm>. The default unit is I<pt>.

=item B<-p> I<paper>, B<--paper=>I<paper>

Specify the paper size of the output file, as an alternative to B<-w>
and B<-h>. Can be set to I<a0>, I<a1>, I<a2>, I<a3>, I<a4>, I<a5>, I<b5>,
I<letter>, I<legal>, I<ledger>, I<tabloid>, I<statement>, I<executive>,
I<folio>, I<quarto>, or I<10x14>. The default output paper size is I<a4>.

=item B<-W> I<length>, B<--Width=>I<length>

Same as the option B<-w>, but for the input file. This option is ignored if
the option B<-c> (cropping) is set.

=item B<-H> I<length>, B<--Height=>I<length>

Same as the option B<-h>, but for the input file. This option is ignored if
the option B<-c> (cropping) is set.

=item B<-P> I<paper>, B<--Paper=>I<paper>

Same as the option B<-p>, but for the input file. By default,
B<PDFTool> will try to guess this value from the header of the file,
and will fail if the information is missing. This option is ignored if the
option B<-c> (cropping) is set.

=item B<-b> I<length>, B<--border=>I<length>

Add a margin around each logical page on a sheet. Possible units are I<pt>,
I<in>, I<cm> and I<mm>. The default unit is I<pt>. The default border is
I<1cm> if the option B<-c> (cropping) is set, and I<0> otherwise.

=item B<-m> I<length>, B<--margin=>I<length>

Add a margin around the whole page. Possible units are I<pt>, I<in>, I<cm>
and I<mm>. The default unit is I<pt>. The default margin is I<0>.

=item B<-c>, B<--crop>

If this option is set, the PostScript code will interpreted to calculate the
maximal effective bounding box. This operation may take time and be quite
demanding for the CPU. See the note for the option B<-b> above.

=item B<--book>

Rearrange pages for printing books or booklets.

=item B<-n> I<num>, B<--nup=>I<num>

Put multiple logical pages onto each physical sheet of paper.
If I<num> is less than 10, the option B<->I<num> may be used as an
alternative.

=item B<--auto-rotate>

Auto-rotate the pages in order to ensure that your document will be
printable using your favorite duplex mode for portrait documents (e.g.,
C<Tumble> if you prefer to turn the pages like those of a book -
"vertical folding"; regardless of the orientation of the document).
It has no effect if the input is a portrait document.
This flag might not be suitable if you plan to read the output document
on your screen.
NOTE: Using this flag with multiple input files might lead to weird
outputs!

=item B<--ps>

By default, B<PDFTool> outputs a PDF 1.4 document; use this flag if
you want a PostScript (language level 2) instead.

=item B<--column>

Change the order to "column-major", where successive pages are placed in
columns down the paper.

=item B<-q>, B<--quiet>

B<PDFTool> normally prints the page numbers of the pages output; this
option suppresses this.

=item B<--help>

Display a brief help.

=item B<--version>

Display the version number of the B<PDFTool> program.

=item B<--man>

Display the manual page.

=back

=head1 EXAMPLES

The following comand can be used to remotely crop a PDF file, convert it
to A4 paper, and rearrange the pages to locally print a (PostScript)
booklet with custom margins:

C<< ssh remote pdftool.pl -cpA4 --book -2 -b2cm -m-1cm --auto-rotate < in.pdf | 
    lpr -o Duplex=DumplexTumble >>

=head1 REQUIREMENTS

=over 4

=item *

Requires C<pdftops> available via the command line (only if the input is
a PDF).

=item *

Requires L<PSUtils|http://www.tardis.ed.ac.uk/~ajcd/psutils/> installed
and available via the command line.

=item *

Requires L<GhostScript|http://ghostscript.com/> installed and available
via the command C<gs>.

=back

=head1 AUTHOR

Copyright 2010-2012 Guilhem Moulin. See the source for copying
conditions.

=cut



#
# Options & arguments
#

my @inputs;
my %out;    # Global option, for the output file

my $index = 1;
while (@ARGV) {
    my %config;
    GetOptions( "select|s=s" => sub { $config{select} = $_[1] },
                "w|width=s"  => sub { $out{width} = $_[1] },
                "h|height=s" => sub { $out{height} = $_[1] },
                "p|paper=s"  => sub { my ($w,$h) = &papersize ($_[1]);
                                      $out{width} = $w;
                                      $out{height} = $h; },
                "W|Width=s"  => sub { $config{inwidth} = $_[1] },
                "H|Height=s" => sub { $config{inheight} = $_[1] },
                "P|Paper=s"  => sub { my ($w,$h) = &papersize ($_[1]);
                                      $config{inwidth} = $w;
                                      $config{inheight} = $h; },
                "margin|m=s" => sub { $config{margin} = $_[1] },
                "border|b=s" => sub { $config{border} = $_[1] },
                "crop|c"     => sub { $config{crop} = 1 },
                "book"       => sub { $config{book} = 1 },
                "ps"         => sub { $out{ps} = 1 },
                "nup|n=i"    => sub { $config{nup} = $_[1] },
                "auto-rotate"=> sub { $out{autorotate} = 1 },
                "1"          => sub { $config{nup} = 1 },
                "2"          => sub { $config{nup} = 2 },
                "3"          => sub { $config{nup} = 3 },
                "4"          => sub { $config{nup} = 4 },
                "5"          => sub { $config{nup} = 5 },
                "6"          => sub { $config{nup} = 6 },
                "7"          => sub { $config{nup} = 7 },
                "8"          => sub { $config{nup} = 8 },
                "9"          => sub { $config{nup} = 9 },
                "column"     => sub { $config{column} = 1 },
                "q|quiet"    => sub { $out{quiet} = 1},
                "man"        => sub { pod2usage(-exitstatus => 0,
                                                -verbose => 2) }
    ) or pod2usage(2);
    if (@ARGV) {
        $config{infile} = $ARGV[0];
        $config{index} = $index;
        $index++;
        shift;
    }
    push @inputs, \%config;
}


*LOG = *STDERR;
my @gs = ('gs', '-P-', '-dSAFER');

# Global variables
my @auxfiles;   # Auxiliary files, to remove
my @fds;        # File handles, to close
my @pids;       # Pids, to waid for
my $return = 0; # Return value


my $FOUT;
if ($#inputs > 0) {
    # The last file with the expected result, and the last set of
    # options was the global one
    my $global = pop @inputs;

    pod2usage(2) unless defined $global->{infile};
    if ($global->{infile} ne "-") {
        open $FOUT, '>', $global->{infile}
            or die "Error: Cannot create `" .$global->{infile}. "': $!\n";
        push @fds, $FOUT;
        delete $global->{infile};
    }

    foreach my $config (@inputs) {
        foreach (keys %$global) {
            $config->{$_} = $global->{$_} unless exists $config->{$_};
        }
    }
}
elsif ($#inputs < 0) {
    @inputs = ({ infile => '-' });
}
$FOUT = *STDOUT  unless  defined $FOUT;


try {
    my @ins;
    my ($landscape, $rotate);
    foreach my $config (@inputs) {
        #
        # Default values
        #
        
        $config->{nup} = 1 unless exists $config->{nup};
        
        # Default margin & border
        $config->{margin} = 0 unless exists $config->{margin};
        unless (exists $config->{border}) {
            if (exists $config->{crop}) {
                $config->{border} = '1cm';
            } else {
                $config->{border} = 0;
            }
        }
        
        # Default output papersize
        unless  (exists $out{width} and exists $out{height}) {
            my ($w,$h) = &papersize ("a4");
            $out{width} = $w;
            $out{height} = $h;
        }
        
        # Default unit: PostScript point
        map { $config->{$_} = &topoints($config->{$_}) if exists $config->{$_} }
            qw /inwidth inheight margin border/;
        map { $out{$_} = &topoints($out{$_}) if exists $out{$_} }
            qw /width height/;
        die "Error: Margins are too big.\n"
            if $out{width} <= 2*$config->{margin}
                or $out{height} <= $config->{margin};
        
        
        
        #
        # Check options
        #
        die "Error: Bad page range: `" .$config->{select}. "'.\n" if
            defined $config->{select} &&
            not $config->{select} =~ /^(_?\d*-?_?\d*,)*_?\d*-?_?\d*$/;
        
        die "Error: Bad nup: `" .$config->{nup}. "'.\n" if
            defined $config->{nup} &&
            not ($config->{nup} =~ /^\d+$/ && $config->{nup} > 0);
        
        #
        # Open input file
        #
        my $FIN;
        if (defined $config->{infile} && $config->{infile} ne "-") {
            open $FIN, '<', $config->{infile}
                or die "Error: Cannot read `" .$config->{infile}. "': $!\n";
            push @fds, $FIN;
        } else {
            $FIN = *STDIN;
        }
    

        #
        # Process the file
        #
        my $FD = &pdftops($FIN, $config);
    
        $FD = &psselect($FD, $config) if exists $config->{select};
    
        my ($FD2, $bbox) = &psbbox($FD