labels/label-create-pdf.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright Chris Nighswonger 2009
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20
  21 use strict;
  22 use warnings;
  23
  24 use CGI qw ( -utf8 );
  25 use C4::Auth;
  26 use C4::Debug;
  27 use C4::Creators;
  28 use C4::Labels;
  29
  30 my $cgi = new CGI;
  31
  32 my ( undef, $loggedinuser, $cookie ) = get_template_and_user({
  33                                                                      template_name   => "labels/label-home.tt",
  34                                                                      query           => $cgi,
  35                                                                      type            => "intranet",
  36                                                                      authnotrequired => 0,
  37                                                                      flagsrequired   => { tools => 'label_creator' },
  38                                                                      debug           => 1,
  39                                                                      });
  40
  41 my $batch_id;
  42 my @label_ids;
  43 my @item_numbers;
  44 $batch_id    = $cgi->param('batch_id') if $cgi->param('batch_id');
  45 my $template_id = $cgi->param('template_id') || undef;
  46 my $layout_id   = $cgi->param('layout_id') || undef;
  47 my $start_label = $cgi->param('start_label') || 1;
  48 @label_ids   = $cgi->param('label_id') if $cgi->param('label_id');
  49 @item_numbers  = $cgi->param('item_number') if $cgi->param('item_number');
  50
  51 my $items = undef;
  52
  53
  54
  55 my $pdf_file = (@label_ids || @item_numbers ? "label_single_" . scalar(@label_ids || @item_numbers) : "label_batch_$batch_id");
  56 print $cgi->header( -type       => 'application/pdf',
  57                     -encoding   => 'utf-8',
  58                     -attachment => "$pdf_file.pdf",
  59                   );
  60
  61 our $pdf = C4::Creators::PDF->new(InitVars => 0);
  62 my $batch = C4::Labels::Batch->retrieve(batch_id => $batch_id);
  63 our $template = C4::Labels::Template->retrieve(template_id => $template_id, profile_id => 1);
  64 my $layout = C4::Labels::Layout->retrieve(layout_id => $layout_id);
  65
  66 sub _calc_next_label_pos {
  67     my ($row_count, $col_count, $llx, $lly) = @_;
  68     if ($col_count < $template->get_attr('cols')) {
  69         $llx = ($llx + $template->get_attr('label_width') + $template->get_attr('col_gap'));
  70         $col_count++;
  71     }
  72     else {
  73         $llx = $template->get_attr('left_margin');
  74         if ($row_count == $template->get_attr('rows')) {
  75             $pdf->Page();
  76             $lly = ($template->get_attr('page_height') - $template->get_attr('top_margin') - $template->get_attr('label_height'));
  77             $row_count = 1;
  78         }
  79         else {
  80             $lly = ($lly - $template->get_attr('row_gap') - $template->get_attr('label_height'));
  81             $row_count++;
  82         }
  83         $col_count = 1;
  84     }
  85     return ($row_count, $col_count, $llx, $lly);
  86 }
  87
  88 sub _print_text {
  89     my $label_text = shift;
  90     foreach my $text_line (@$label_text) {
  91         $pdf->Font($text_line->{'font'});
  92         $pdf->FontSize( $text_line->{'font_size'} );
  93         $pdf->Text( $text_line->{'text_llx'}, $text_line->{'text_lly'}, $text_line->{'line'} );
  94     }
  95 }
  96
  97 $| = 1;
  98
  99 # set the paper size
 100 my $lowerLeftX  = 0;
 101 my $lowerLeftY  = 0;
 102 my $upperRightX = $template->get_attr('page_width');
 103 my $upperRightY = $template->get_attr('page_height');
 104
 105 $pdf->Compress(1);
 106 $pdf->Mbox($lowerLeftX, $lowerLeftY, $upperRightX, $upperRightY);
 107
 108 my ($row_count, $col_count, $llx, $lly) = $template->get_label_position($start_label);
 109
 110 if (@label_ids) {
 111     my $batch_items = $batch->get_attr('items');
 112     grep {
 113         my $label_id = $_;
 114         push(@{$items}, grep{$_->{'label_id'} == $label_id;} @{$batch_items});
 115     } @label_ids;
 116 }
 117 elsif (@item_numbers) {
 118     grep {
 119         push(@{$items}, {item_number => $_});
 120     } @item_numbers;
 121 }
 122 else {
 123     $items = $batch->get_attr('items');
 124 }
 125
 126 LABEL_ITEMS:
 127 foreach my $item (@{$items}) {
 128     my ($barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor) = 0,0,0,0;
 129     if ($layout->get_attr('printing_type') eq 'ALT') {  # we process the ALT style printing type here because it is not an atomic printing type
 130         my $label_a = C4::Labels::Label->new(
 131                                         batch_id            => $batch_id,
 132                                         item_number         => $item->{'item_number'},
 133                                         llx                 => $llx,
 134                                         lly                 => $lly,
 135                                         width               => $template->get_attr('label_width'),
 136                                         height              => $template->get_attr('label_height'),
 137                                         top_text_margin     => $template->get_attr('top_text_margin'),
 138                                         left_text_margin    => $template->get_attr('left_text_margin'),
 139                                         barcode_type        => $layout->get_attr('barcode_type'),
 140                                         printing_type       => 'BIB',
 141                                         guidebox            => $layout->get_attr('guidebox'),
 142                                         font                => $layout->get_attr('font'),
 143                                         font_size           => $layout->get_attr('font_size'),
 144                                         callnum_split       => $layout->get_attr('callnum_split'),
 145                                         justify             => $layout->get_attr('text_justify'),
 146                                         format_string       => $layout->get_attr('format_string'),
 147                                         text_wrap_cols      => $layout->get_text_wrap_cols(label_width => $template->get_attr('label_width'), left_text_margin => $template->get_attr('left_text_margin')),
 148                                           );
 149         $pdf->Add($label_a->draw_guide_box) if $layout->get_attr('guidebox');
 150         my $label_a_text = $label_a->create_label();
 151         _print_text($label_a_text);
 152         ($row_count, $col_count, $llx, $lly) = _calc_next_label_pos($row_count, $col_count, $llx, $lly);
 153         my $label_b = C4::Labels::Label->new(
 154                                         batch_id            => $batch_id,
 155                                         item_number         => $item->{'item_number'},
 156                                         llx                 => $llx,
 157                                         lly                 => $lly,
 158                                         width               => $template->get_attr('label_width'),
 159                                         height              => $template->get_attr('label_height'),
 160                                         top_text_margin     => $template->get_attr('top_text_margin'),
 161                                         left_text_margin    => $template->get_attr('left_text_margin'),
 162                                         barcode_type        => $layout->get_attr('barcode_type'),
 163                                         printing_type       => 'BAR',
 164                                         guidebox            => $layout->get_attr('guidebox'),
 165                                         font                => $layout->get_attr('font'),
 166                                         font_size           => $layout->get_attr('font_size'),
 167                                         callnum_split       => $layout->get_attr('callnum_split'),
 168                                         justify             => $layout->get_attr('text_justify'),
 169                                         format_string       => $layout->get_attr('format_string'),
 170                                         text_wrap_cols      => $layout->get_text_wrap_cols(label_width => $template->get_attr('label_width'), left_text_margin => $template->get_attr('left_text_margin')),
 171                                           );
 172         $pdf->Add($label_b->draw_guide_box) if $layout->get_attr('guidebox');
 173         my $label_b_text = $label_b->create_label();
 174         ($row_count, $col_count, $llx, $lly) = _calc_next_label_pos($row_count, $col_count, $llx, $lly);
 175         next LABEL_ITEMS;
 176     }
 177     else {
 178     }
 179         my $label = C4::Labels::Label->new(
 180                                         batch_id            => $batch_id,
 181                                         item_number         => $item->{'item_number'},
 182                                         llx                 => $llx,
 183                                         lly                 => $lly,
 184                                         width               => $template->get_attr('label_width'),
 185                                         height              => $template->get_attr('label_height'),
 186                                         top_text_margin     => $template->get_attr('top_text_margin'),
 187                                         left_text_margin    => $template->get_attr('left_text_margin'),
 188                                         barcode_type        => $layout->get_attr('barcode_type'),
 189                                         printing_type       => $layout->get_attr('printing_type'),
 190                                         guidebox            => $layout->get_attr('guidebox'),
 191                                         font                => $layout->get_attr('font'),
 192                                         font_size           => $layout->get_attr('font_size'),
 193                                         callnum_split       => $layout->get_attr('callnum_split'),
 194                                         justify             => $layout->get_attr('text_justify'),
 195                                         format_string       => $layout->get_attr('format_string'),
 196                                         text_wrap_cols      => $layout->get_text_wrap_cols(label_width => $template->get_attr('label_width'), left_text_margin => $template->get_attr('left_text_margin')),
 197                                           );
 198         $pdf->Add($label->draw_guide_box) if $layout->get_attr('guidebox');
 199         my $label_text = $label->create_label();
 200         _print_text($label_text) if $label_text;
 201         ($row_count, $col_count, $llx, $lly) = _calc_next_label_pos($row_count, $col_count, $llx, $lly);
 202         next LABEL_ITEMS;
 203 }
 204
 205 $pdf->End();
 206
 207 __END__
 208
 209 =head1 NAME
 210
 211 labels/label-create-pdf.pl - A script for creating a pdf export of labels and label batches in Koha
 212
 213 =head1 ABSTRACT
 214
 215 This script provides the means of producing a pdf of labels for items either individually, in groups, or in batches from within Koha.
 216
 217 =head1 USAGE
 218
 219 This script is intended to be called as a cgi script although it could be easily modified to accept command line parameters. The script accepts four single
 220 parameters and two "multiple" parameters as follows:
 221
 222     C<batch_id>         A single valid batch id to export.
 223     C<template_id>      A single valid template id to be applied to the current export. This parameter is manditory.
 224     C<layout_id>        A single valid layout id to be applied to the current export. This parameter is manditory.
 225     C<start_label>      The number of the label on which to begin the export. This parameter is optional.
 226     C<lable_ids>        A single valid label id to export. Multiple label ids may be submitted to export multiple labels.
 227     C<item_numbers>     A single valid item number to export. Multiple item numbers may be submitted to export multiple items.
 228
 229 B<NOTE:> One of the C<batch_id>, C<label_ids>, or C<item_number> parameters is manditory. However, do not pass a combination of them or bad things might result.
 230
 231     example:
 232         http://staff-client.kohadev.org/cgi-bin/koha/labels/label-create-pdf.pl?batch_id=1&template_id=1&layout_id=5&start_label=1
 233
 234 =head1 AUTHOR
 235
 236 Chris Nighswonger <cnighswonger AT foundations DOT edu>
 237
 238 =head1 COPYRIGHT
 239
 240 Copyright 2009 Foundations Bible College.
 241
 242 =head1 LICENSE
 243
 244 This file is part of Koha.
 245
 246 Koha 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
 247 Foundation; either version 2 of the License, or (at your option) any later version.
 248
 249 You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 51 Franklin Street,
 250 Fifth Floor, Boston, MA 02110-1301 USA.
 251
 252 =head1 DISCLAIMER OF WARRANTY
 253
 254 Koha is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
 255 A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 256
 257 =cut