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