Adds helpful note to Home Phone and Home Email fields to remind staff which fields...
[koha.git] / labels / label-print-pdf.pl
1 #!/usr/bin/perl
2
3 use strict;
4 use warnings;
5
6 use CGI;
7 use C4::Labels;     # GetActiveLabelTemplate get_label_options GetAssociatedProfile 
8 # GetPatronCardItems GetLabelItems GetUnitsValue...
9 use C4::Auth;
10 use C4::Output;
11 use C4::Context;
12 use C4::Members;
13 use C4::Branch;
14 use HTML::Template::Pro;
15 use PDF::Reuse;
16 use PDF::Reuse::Barcode;
17 use POSIX;  # ceil
18 use Data::Dumper;
19
20 my $DEBUG = 0;
21 my $DEBUG_LPT = 0;
22
23 my $cgi         = new CGI;
24
25 #### Tons of Initialization ####
26 # get the printing settings
27 my $template    = GetActiveLabelTemplate();
28 my $conf_data   = get_label_options() or die "get_label_options failed";
29 my $profile     = GetAssociatedProfile($template->{'tmpl_id'});
30
31 my $batch_id =   $cgi->param('batch_id');
32 my @resultsloop;
33
34 my $batch_type   = $conf_data->{'type'};
35 my $barcodetype  = $conf_data->{'barcodetype'};
36 my $printingtype = $conf_data->{'printingtype'} or die "No printingtype in conf_data";
37 my $guidebox     = $conf_data->{'guidebox'};
38 my $start_label  = $conf_data->{'startlabel'};
39 if ($cgi->param('startlabel')) {
40     $start_label = $cgi->param('startlabel');       # A bit of a hack to allow setting the starting label from the address bar... -fbcit
41 }
42 warn "Starting on label #$start_label" if $DEBUG;
43 my $units        = $template->{'units'};
44
45 if ($printingtype eq 'PATCRD') {
46     @resultsloop = GetPatronCardItems($batch_id);
47 } else {
48     @resultsloop = GetLabelItems($batch_id);
49 }
50
51 #warn "UNITS $units";
52 #warn "fontsize = $fontsize";
53 #warn Dumper $template;
54
55 my $unitvalue      = GetUnitsValue($units);
56 my $prof_unitvalue = GetUnitsValue($profile->{'unit'});
57
58 warn "Template units: $units which converts to $unitvalue PostScript Points" if $DEBUG;
59 warn "Profile units: $profile->{'unit'} which converts to $prof_unitvalue PostScript Points" if $DEBUG;
60
61 my $tmpl_code = $template->{'tmpl_code'};
62 my $tmpl_desc = $template->{'tmpl_desc'};
63
64 my $page_height  = ( $template->{'page_height'}  * $unitvalue );
65 my $page_width   = ( $template->{'page_width'}   * $unitvalue );
66 my $label_height = ( $template->{'label_height'} * $unitvalue );
67 my $label_width  = ( $template->{'label_width'}  * $unitvalue );
68 my $spine_width  = ( $template->{'label_width'}  * $unitvalue );
69 my $circ_width   = ( $template->{'label_width'}  * $unitvalue );
70 my $top_margin   = ( $template->{'topmargin'}    * $unitvalue );
71 my $left_margin  = ( $template->{'leftmargin'}   * $unitvalue );
72 my $colspace     = ( $template->{'colgap'}       * $unitvalue );
73 my $rowspace     = ( $template->{'rowgap'}       * $unitvalue );
74
75 warn "Converted dimensions are:" if $DEBUG;
76 warn "pghth=$page_height, pgwth=$page_width, lblhth=$label_height, lblwth=$label_width, spinwth=$spine_width, circwth=$circ_width, tpmar=$top_margin, lmar=$left_margin, colsp=$colspace, rowsp=$rowspace" if $DEBUG;
77
78 my $label_cols = $template->{'cols'};
79 my $label_rows = $template->{'rows'};
80
81 my $margin           = $top_margin;
82 my $left_text_margin = 3;       # FIXME: This value should not be hardcoded
83 my $str;
84
85 # Some peritent notes from PDF::Reuse regarding prFont()...
86 # If a font wasn't found, Helvetica will be set.
87 # These names are always recognized: Times-Roman, Times-Bold, Times-Italic, Times-BoldItalic, Courier, Courier-Bold,
88 #   Courier-Oblique, Courier-BoldOblique, Helvetica, Helvetica-Bold, Helvetica-Oblique, Helvetica-BoldOblique
89 # They can be abbreviated: TR, TB, TI, TBI, C, CB, CO, CBO, H, HB, HO, HBO
90
91 my $fontsize    = $template->{'fontsize'};
92 my $fontname    = $template->{'font'};
93
94 my $text_wrap_cols = GetTextWrapCols( $fontname, $fontsize, $label_width, $left_text_margin );
95
96 #warn $label_cols, $label_rows;
97
98 # set the paper size
99 my $lowerLeftX  = 0;
100 my $lowerLeftY  = 0;
101 my $upperRightX = $page_width;
102 my $upperRightY = $page_height;
103 my $codetype; # = 'Code39';
104
105 warn "Active profile: " . ($profile->{prof_id} || "None") if $DEBUG;
106
107 #### PRINT PRELIMINARY DATA ####
108 print $cgi->header( -type => 'application/pdf', -attachment => 'barcode.pdf' ); 
109     # Don't print header until very last possible moment
110     # That way if error or die occurs, fatals_to_browser will still work.
111     # After we print this header, there is no way back to HTML.  All we can do is deliver PDF.
112 prInitVars();
113 $| = 1;
114 prFile();   # No args means to STDOUT
115 prCompress(1);  # turn on zip compression which dramatically reduces file size
116 prMbox( $lowerLeftX, $lowerLeftY, $upperRightX, $upperRightY );
117
118 # drawbox( $lowerLeftX, $lowerLeftY, $upperRightX, $upperRightY );  #do page border
119 # draw margin box for alignment page
120 drawbox($left_margin, $top_margin, $page_width-(2*$left_margin), $page_height-(2*$top_margin)) if $DEBUG_LPT;
121
122
123 #### TWEAKS and DEBUGGING ###
124 # Adjustments for image position and creep -fbcit
125 # NOTE: *All* of these factor in to image position and creep. Keep this in mind when makeing adjustments.
126 # Suggested proceedure: Adjust margins until both top and left margins are correct. Then adjust the label
127 # height and width to correct label creep across and down page. Units are PostScript Points (72 per inch).
128
129 sub debug_drop {
130     my $title = @_ || "";
131     warn "-------------------------$title-----------------------------\n"
132      . "  top margin = $top_margin points\n" 
133      . " left margin = $left_margin points\n"
134      . "label height = $label_height points\n"
135      . "label width  = $label_width points\n";
136 }
137
138 debug_drop('INITIAL VALUES') if ($DEBUG);
139
140 if ( $profile->{'prof_id'} ) {
141     $top_margin   += ($profile->{'offset_vert'} * $prof_unitvalue);    # controls vertical offset
142     $label_height += ($profile->{'creep_vert'}  * $prof_unitvalue);    # controls vertical creep
143     $left_margin  += ($profile->{'offset_horz'} * $prof_unitvalue);    # controls horizontal offset
144     $label_width  += ($profile->{'creep_horz'}  * $prof_unitvalue);    # controls horizontal creep
145 }
146
147 if ($DEBUG) {
148     if ($profile->{'prof_id'}) {
149         debug_drop('ADJUSTED VALUES');
150     } else {
151         warn "No profile associated so no adjustment applied.";
152     }
153 }
154
155 #warn " $lowerLeftX, $lowerLeftY, $upperRightX, $upperRightY";
156 #warn "$label_rows, $label_cols\n";
157 #warn "$label_height, $label_width\n";
158 #warn "$page_height, $page_width\n";
159
160 my ($rowcount, $colcount, $x_pos, $y_pos, $rowtemp, $coltemp);
161
162 if ( $start_label and $start_label == 1 ) {
163     $rowcount = 1;
164     $colcount = 1;
165     $x_pos    = $left_margin;
166     $y_pos    = ( $page_height - $top_margin - $label_height );
167 } else {
168     $rowcount = ceil( $start_label / $label_cols );
169     $colcount = ( $start_label - ( ( $rowcount - 1 ) * $label_cols ) );
170     $x_pos = $left_margin + ( $label_width * ( $colcount - 1 ) ) +
171       ( $colspace * ( $colcount - 1 ) );
172     $y_pos = $page_height - $top_margin - ( $label_height * $rowcount ) -
173       ( $rowspace * ( $rowcount - 1 ) );
174     $DEBUG and warn "Start label: $start_label. Beginning in row $rowcount, column $colcount\n"
175         . "(X,Y) positions = ($x_pos,$y_pos)\n"
176         . "Rowspace = $rowspace, Label height = $label_height";
177 }
178
179 #
180 #### main foreach loop #### 
181 #
182
183 foreach my $item (@resultsloop) {
184     warn "Label parameters: xpos=$x_pos, ypos=$y_pos, lblwid=$label_width, lblhig=$label_height" if $DEBUG;
185
186     drawbox($x_pos, $y_pos, $label_width, $label_height) if $guidebox;  # regardless of printingtype
187
188     if ( $printingtype eq 'BAR' ) {
189         DrawBarcode( $x_pos, $y_pos, $label_height, $label_width, $item->{'barcode'}, $barcodetype );
190     }
191     elsif ( $printingtype eq 'BARBIB' ) {
192         # reposoitioning barcode up the top of label
193         my $barcode_height = ($label_height / 1.5 );    ## scaling voodoo
194         my $text_height    = $label_height / 2;
195         my $barcode_y      = $y_pos + ( $label_height / 2.5  );   ## scaling voodoo
196
197         DrawBarcode( $x_pos, $barcode_y, $barcode_height, $label_width, $item->{'barcode'}, $barcodetype );
198         DrawSpineText( $x_pos, $y_pos, $label_height, $label_width, $fontname, $fontsize,
199             $left_text_margin, $text_wrap_cols, \$item, \$conf_data, $printingtype );
200     }    # correct
201     elsif ( $printingtype eq 'BIBBAR' ) {
202         my $barcode_height = $label_height / 2;
203         DrawBarcode( $x_pos, $y_pos, $barcode_height, $label_width, $item->{'barcode'}, $barcodetype );
204         DrawSpineText( $x_pos, $y_pos, $label_height, $label_width, $fontname, $fontsize,
205             $left_text_margin, $text_wrap_cols, \$item, \$conf_data, $printingtype );
206     }
207     elsif ( $printingtype eq 'ALT' ) {
208         DrawBarcode( $x_pos, $y_pos, $label_height, $label_width, $item->{'barcode'}, $barcodetype );
209         CalcNextLabelPos();
210         drawbox( $x_pos, $y_pos, $label_width, $label_height ) if $guidebox;
211         DrawSpineText( $x_pos, $y_pos, $label_height, $label_width, $fontname, $fontsize,
212             $left_text_margin, $text_wrap_cols, \$item, \$conf_data, $printingtype );
213     }
214     elsif ( $printingtype eq 'BIB' ) {
215         DrawSpineText( $x_pos, $y_pos, $label_height, $label_width, $fontname, $fontsize,
216             $left_text_margin, $text_wrap_cols, \$item, \$conf_data, $printingtype );
217     }
218     elsif ( $printingtype eq 'PATCRD' ) {
219         my $patron_data = $item;
220         #FIXME: This needs to be paramatized and passed in from the user...
221         #Each element of this hash is a separate line on the patron card. Keys are the text to print and the associated data is the point size.
222         my $text = {        
223             $patron_data->{'description'}  => $fontsize,
224             $patron_data->{'branchname'}   => ($fontsize + 3),
225         };
226         $DEBUG and warn "Generating patron card for cardnumber $patron_data->{'cardnumber'}";
227         my $barcode_height = $label_height / 2.75; #FIXME: Scaling barcode height; this needs to be a user parameter.
228         DrawBarcode( $x_pos, $y_pos, $barcode_height, $label_width, $patron_data->{'cardnumber'}, $barcodetype );
229         DrawPatronCardText( $x_pos, $y_pos, $label_height, $label_width, $fontname, $fontsize,
230             $left_text_margin, $text_wrap_cols, $text, $printingtype );
231     }
232     else {
233         die "CANNOT PRINT: Unknown printingtype '$printingtype'";
234     }
235
236     CalcNextLabelPos();     # regardless of printingtype
237 }    # end for item loop
238 prEnd();
239
240 sub CalcNextLabelPos {
241     if ($colcount < $label_cols) {
242         # warn "new col";
243         $x_pos = ( $x_pos + $label_width + $colspace );
244         $colcount++;
245     } else {
246         $x_pos = $left_margin;
247         if ($rowcount == $label_rows) {
248             # warn "new page";
249             prPage();
250             $y_pos    = ( $page_height - $top_margin - $label_height );
251             $rowcount = 1;
252         } else {
253             # warn "new row";
254             $y_pos = ( $y_pos - $rowspace - $label_height );
255             $rowcount++;
256         }
257         $colcount = 1;
258     }
259 }
260