package C4::Labels::Label;
-# Copyright 2006 Katipo Communications.
-# Some parts Copyright 2009 Foundations Bible College.
-#
-# This file is part of Koha.
-#
-# 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
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
-#
-# 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
-# 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
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
-
use strict;
use warnings;
use C4::Context;
use C4::Debug;
use C4::Biblio;
-use Data::Dumper;
BEGIN {
use version; our $VERSION = qv('1.0.0_1');
}
+my $possible_decimal = qr/\d{3,}(?:\.\d+)?/; # at least three digits for a DDCN
+
+sub _check_params {
+ my $given_params = {};
+ my $exit_code = 0;
+ my @valid_label_params = (
+ 'batch_id',
+ 'item_number',
+ 'llx',
+ 'lly',
+ 'height',
+ 'width',
+ 'top_text_margin',
+ 'left_text_margin',
+ 'barcode_type',
+ 'printing_type',
+ 'guidebox',
+ 'font',
+ 'font_size',
+ 'callnum_split',
+ 'justify',
+ 'format_string',
+ 'text_wrap_cols',
+ 'barcode',
+ );
+ if (scalar(@_) >1) {
+ $given_params = {@_};
+ foreach my $key (keys %{$given_params}) {
+ if (!(grep m/$key/, @valid_label_params)) {
+ syslog("LOG_ERR", "C4::Labels::Label : Unrecognized parameter type of \"%s\".", $key);
+ $exit_code = 1;
+ }
+ }
+ }
+ else {
+ if (!(grep m/$_/, @valid_label_params)) {
+ syslog("LOG_ERR", "C4::Labels::Label : Unrecognized parameter type of \"%s\".", $_);
+ $exit_code = 1;
+ }
+ }
+ return $exit_code;
+}
+
sub _guide_box {
my ( $llx, $lly, $width, $height ) = @_;
my $obj_stream = "q\n"; # save the graphic state
my $item_number = shift;
my $barcode_only = shift || 0;
my $dbh = C4::Context->dbh;
- my $query =
# FIXME This makes for a very bulky data structure; data from tables w/duplicate col names also gets overwritten.
# Something like this, perhaps, but this also causes problems because we need more fields sometimes.
# SELECT i.barcode, i.itemcallnumber, i.itype, bi.isbn, bi.issn, b.title, b.author
- "SELECT bi.*, i.*, b.*
- FROM items AS i, biblioitems AS bi ,biblio AS b
- WHERE itemnumber=? AND i.biblioitemnumber=bi.biblioitemnumber AND bi.biblionumber=b.biblionumber";
- my $sth = $dbh->prepare($query);
+ my $sth = $dbh->prepare("SELECT bi.*, i.*, b.* FROM items AS i, biblioitems AS bi ,biblio AS b WHERE itemnumber=? AND i.biblioitemnumber=bi.biblioitemnumber AND bi.biblionumber=b.biblionumber;");
$sth->execute($item_number);
if ($sth->err) {
syslog("LOG_ERR", "C4::Labels::Label::_get_label_item : Database returned the following error: %s", $sth->errstr);
return \@sorted_fields;
}
+
sub _split_lccn {
my ($lccn) = @_;
- my ($ll, $wnl, $dec, $cutter, $pubdate) = (0, 0, 0, 0, 0);
$_ = $lccn;
- # lccn example 'HE8700.7 .P6T44 1983';
- my @splits = m/
- (^[a-zA-Z]+) # HE
- ([0-9]+\.*[0-9]*) # 8700.7
+ # lccn examples: 'HE8700.7 .P6T44 1983', 'BS2545.E8 H39 1996';
+ my (@parts) = m/
+ ^([a-zA-Z]+) # HE # BS
+ (\d+(?:\.\d)*) # 8700.7 # 2545
\s*
- (\.*[a-zA-Z0-9]*) # P6T44
+ (\.*\D+\d*) # .P6 # .E8
\s*
- ([0-9]*) # 1983
- /x;
-
- # strip something occuring spaces too
- $splits[0] =~ s/\s+$//;
- $splits[1] =~ s/\s+$//;
- $splits[2] =~ s/\s+$//;
-
- return @splits;
+ (.*) # T44 1983 # H39 1996 # everything else (except any bracketing spaces)
+ \s*
+ /x;
+ unless (scalar @parts) {
+ syslog("LOG_ERR", "C4::Labels::Label::_split_lccn : regexp failed to match string: %s", $_);
+ push @parts, $_; # if no match, just push the whole string.
+ }
+ push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
+ $debug and print STDERR "split_lccn array: ", join(" | ", @parts), "\n";
+ return @parts;
}
sub _split_ddcn {
my ($ddcn) = @_;
- $ddcn =~ s/\///g; # in theory we should be able to simply remove all segmentation markers and arrive at the correct call number...
$_ = $ddcn;
- # ddcn example R220.3 H2793Z H32 c.2
- my @splits = m/^([A-Z]{0,3}) # R (OS, REF, etc. up do three letters)
- ([0-9]+\.[0-9]*) # 220.3
- \s? # space (not requiring anything beyond the call number)
- ([a-zA-Z0-9]*\.?[a-zA-Z0-9])# cutter number... maybe, but if so it is in this position (Z indicates literary criticism)
- \s? # space if it exists
- ([a-zA-Z]*\.?[0-9]*) # other indicators such as cutter for author of literary criticism in this example if it exists
- \s? # space if ie exists
- ([a-zA-Z]*\.?[0-9]*) # other indicators such as volume number, copy number, edition date, etc. if it exists
- /x;
- return @splits;
+ s/\///g; # in theory we should be able to simply remove all segmentation markers and arrive at the correct call number...
+ my (@parts) = m/
+ ^([a-zA-Z-]+(?:$possible_decimal)?) # R220.3 # BIO # first example will require extra splitting
+ \s+
+ (.+) # H2793Z H32 c.2 # R5c.1 # everything else (except bracketing spaces)
+ \s*
+ /x;
+ unless (scalar @parts) {
+ syslog("LOG_ERR", "C4::Labels::Label::_split_ddcn : regexp failed to match string: %s", $_);
+ push @parts, $_; # if no match, just push the whole string.
+ }
+
+ if ($parts[ 0] =~ /^([a-zA-Z]+)($possible_decimal)$/) {
+ shift @parts; # pull off the mathching first element, like example 1
+ unshift @parts, $1, $2; # replace it with the two pieces
+ }
+
+ push @parts, split /\s+/, pop @parts; # split the last piece into an arbitrary number of pieces at spaces
+
+ if ($parts[-1] !~ /^.*\d-\d.*$/ && $parts[-1] =~ /^(.*\d+)(\D.*)$/) {
+ pop @parts; # pull off the mathching last element, like example 2
+ push @parts, $1, $2; # replace it with the two pieces
+ }
+
+ $debug and print STDERR "split_ddcn array: ", join(" | ", @parts), "\n";
+ return @parts;
}
sub _split_fcn {
last SPLIT_FCN; # No match, break out of the loop
}
}
+ unless (scalar @fcn_split) {
+ syslog("LOG_ERR", "C4::Labels::Label::_split_fcn : regexp failed to match string: %s", $_);
+ push (@fcn_split, $_);
+ }
return @fcn_split;
}
return $kohatables;
}
+### This series of functions calculates the position of text and barcode on individual labels
+### Please *do not* add printing types which are non-atomic. Instead, build code which calls the necessary atomic printing types to form the non-atomic types. See the ALT type
+### in labels/label-create-pdf.pl as an example.
+### NOTE: Each function must be passed seven parameters and return seven even if some are 0 or undef
+
+sub _BIB {
+ my $self = shift;
+ my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
+ my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
+ return $self->{'llx'}, $text_lly, $line_spacer, 0, 0, 0, 0;
+}
+
+sub _BAR {
+ my $self = shift;
+ my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the the left edge of the label ($llx)
+ my $barcode_lly = $self->{'lly'} + $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance above the bottom of the label ($lly)
+ my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
+ my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
+ return 0, 0, 0, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
+}
+
+sub _BIBBAR {
+ my $self = shift;
+ my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the the left edge of the label ($self->{'llx'})
+ my $barcode_lly = $self->{'lly'} + $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance above the bottom of the label ($lly)
+ my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
+ my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
+ my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
+ my $text_lly = ($self->{'lly'} + ($self->{'height'} - $self->{'top_text_margin'}));
+ return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
+}
+
+sub _BARBIB {
+ my $self = shift;
+ my $barcode_llx = $self->{'llx'} + $self->{'left_text_margin'}; # this places the bottom left of the barcode the left text margin distance to right of the the left edge of the label ($self->{'llx'})
+ my $barcode_lly = ($self->{'lly'} + $self->{'height'}) - $self->{'top_text_margin'}; # this places the bottom left of the barcode the top text margin distance below the top of the label ($self->{'lly'})
+ my $barcode_width = 0.8 * $self->{'width'}; # this scales the barcode width to 80% of the label width
+ my $barcode_y_scale_factor = 0.01 * $self->{'height'}; # this scales the barcode height to 10% of the label height
+ my $line_spacer = ($self->{'font_size'} * 1); # number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size.).
+ my $text_lly = (($self->{'lly'} + $self->{'height'}) - $self->{'top_text_margin'} - (($self->{'lly'} + $self->{'height'}) - $barcode_lly));
+ return $self->{'llx'}, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor;
+}
+
sub new {
my ($invocant, %params) = @_;
my $type = ref($invocant) || $invocant;
my $self = {
batch_id => $params{'batch_id'},
item_number => $params{'item_number'},
+ llx => $params{'llx'},
+ lly => $params{'lly'},
height => $params{'height'},
width => $params{'width'},
top_text_margin => $params{'top_text_margin'},
return $self->{'printing_type'};
}
-=head2 $label->get_attr("attr")
-
- Invoking the I<get_attr> method will return the value of the requested attribute or 1 on errors.
-
- example:
- my $value = $label->get_attr("attr");
-
-=cut
-
sub get_attr {
my $self = shift;
-# if (_check_params(@_) eq 1) {
-# return -1;
-# }
+ if (_check_params(@_) eq 1) {
+ return -1;
+ }
my ($attr) = @_;
if (exists($self->{$attr})) {
return $self->{$attr};
return;
}
-=head2 $label->draw_label_text()
-
- Invoking the I<draw_label_text> method generates the label text for the label object.
- example:
- $label->draw_label_text(
- llx => $text_llx,
- lly => $text_lly,
- top_text_margin => $label_top_text_margin,
- line_spacer => $text_leading,
- font => $text_font,
- font_size => $text_font_size,
- justify => $text_justification,
+sub create_label {
+ my $self = shift;
+ my $label_text = '';
+ my ($text_llx, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor);
+ {
+ no strict 'refs';
+ ($text_llx, $text_lly, $line_spacer, $barcode_llx, $barcode_lly, $barcode_width, $barcode_y_scale_factor) = &{"_$self->{'printing_type'}"}($self); # an obfuscated call to the correct printing type sub
+ }
+ if ($self->{'printing_type'} =~ /BIB/) {
+ $label_text = draw_label_text( $self,
+ llx => $text_llx,
+ lly => $text_lly,
+ line_spacer => $line_spacer,
+ );
+ }
+ if ($self->{'printing_type'} =~ /BAR/) {
+ barcode( $self,
+ llx => $barcode_llx,
+ lly => $barcode_lly,
+ width => $barcode_width,
+ y_scale_factor => $barcode_y_scale_factor,
);
-=cut
+ }
+ return $label_text if $label_text;
+ return;
+}
sub draw_label_text {
my ($self, %params) = @_;
return \@label_text;
}
-=head2 $label->barcode()
-
- Invoking the I<barcode> method generates a barcode for the label object and inserts it into the current pdf stream. C<barcode_data> is optional
- and omitting it will cause the barcode from the current item to be used. C<barcode_type> is also optional. Omission results in the barcode
- type of the current template being used.
-
- example:
- $label->barcode(
- llx => $barcode_llx,
- lly => $barcode_lly,
- width => $barcode_width,
- y_scale_factor => $barcode_y_scale_factor,
- barcode_data => $barcode,
- barcode_type => $barcodetype,
- );
-=cut
-
sub barcode {
my $self = shift;
my %params = @_;
- $params{'barcode'} = _get_label_item($self->{'item_number'}, 1) if !$params{'barcode'};
+ $params{'barcode_data'} = _get_label_item($self->{'item_number'}, 1) if !$params{'barcode_data'};
$params{'barcode_type'} = $self->{'barcode_type'} if !$params{'barcode_type'};
my $x_scale_factor = 1;
- my $num_of_bars = length($params{'barcode'});
+ my $num_of_bars = length($params{'barcode_data'});
my $tot_bar_length = 0;
my $bar_length = 0;
my $guard_length = 10;
$x_scale_factor = ($params{'width'} / $tot_bar_length);
if ($params{'barcode_type'} eq 'CODE39MOD') {
my $c39 = CheckDigits('visa'); # get modulo43 checksum
- $params{'barcode'} = $c39->complete($params{'barcode'});
+ $params{'barcode_data'} = $c39->complete($params{'barcode_data'});
}
elsif ($params{'barcode_type'} eq 'CODE39MOD10') {
my $c39_10 = CheckDigits('visa'); # get modulo43 checksum
- $params{'barcode'} = $c39_10->complete($params{'barcode'});
+ $params{'barcode_data'} = $c39_10->complete($params{'barcode_data'});
$hide_text = '';
}
eval {
PDF::Reuse::Barcode::Code39(
x => $params{'llx'},
y => $params{'lly'},
- value => "*$params{barcode}*",
+ value => "*$params{barcode_data}*",
xSize => $x_scale_factor,
ySize => $params{'y_scale_factor'},
hide_asterisk => 1,
PDF::Reuse::Barcode::COOP2of5(
x => $params{'llx'},
y => $params{'lly'},
- value => "*$params{barcode}*",
+ value => "*$params{barcode_data}*",
xSize => $x_scale_factor,
ySize => $params{'y_scale_factor'},
mode => 'graphic',
PDF::Reuse::Barcode::Industrial2of5(
x => $params{'llx'},
y => $params{'lly'},
- value => "*$params{barcode}*",
+ value => "*$params{barcode_data}*",
xSize => $x_scale_factor,
ySize => $params{'y_scale_factor'},
mode => 'graphic',
1;
__END__
+=head1 NAME
+
+C4::Labels::Label - A class for creating and manipulating label objects in Koha
+
+=head1 ABSTRACT
+
+This module provides methods for creating, and otherwise manipulating single label objects used by Koha to create and export labels.
+
+=head1 METHODS
+
+=head2 new()
+
+ Invoking the I<new> method constructs a new label object containing the supplied values. Depending on the final output format of the label data
+ the minimal required parameters change. (See the implimentation of this object type in labels/label-create-pdf.pl and labels/label-create-csv.pl
+ and labels/label-create-xml.pl for examples.) The following parameters are optionally accepted as key => value pairs:
+
+ C<batch_id> Batch id with which this label is associated
+ C<item_number> Item number of item to be the data source for this label
+ C<height> Height of this label (All measures passed to this method B<must> be supplied in postscript points)
+ C<width> Width of this label
+ C<top_text_margin> Top margin of this label
+ C<left_text_margin> Left margin of this label
+ C<barcode_type> Defines the barcode type to be used on labels. NOTE: At present only the following barcode types are supported in the label creator code:
+
+=over 9
+
+=item .
+ CODE39 = Code 3 of 9
+
+=item .
+ CODE39MOD = Code 3 of 9 with modulo 43 checksum
+
+=item .
+ CODE39MOD10 = Code 3 of 9 with modulo 10 checksum
+
+=item .
+ COOP2OF5 = A varient of 2 of 5 barcode based on NEC's "Process 8000" code
+
+=item .
+ INDUSTRIAL2OF5 = The standard 2 of 5 barcode (a binary level bar code developed by Identicon Corp. and Computer Identics Corp. in 1970)
+
+=back
+
+ C<printing_type> Defines the general layout to be used on labels. NOTE: At present there are only five printing types supported in the label creator code:
+
+=over 9
+
+=item .
+BIB = Only the bibliographic data is printed
+
+=item .
+BARBIB = Barcode proceeds bibliographic data
+
+=item .
+BIBBAR = Bibliographic data proceeds barcode
+
+=item .
+ALT = Barcode and bibliographic data are printed on alternating labels
+
+=item .
+BAR = Only the barcode is printed
+
+=back
+
+ C<guidebox> Setting this to '1' will result in a guide box being drawn around the labels marking the edge of each label
+ C<font> Defines the type of font to be used on labels. NOTE: The following fonts are available by default on most systems:
+
+=over 9
+
+=item .
+TR = Times-Roman
+
+=item .
+TB = Times Bold
+
+=item .
+TI = Times Italic
+
+=item .
+TBI = Times Bold Italic
+
+=item .
+C = Courier
+
+=item .
+CB = Courier Bold
+
+=item .
+CO = Courier Oblique (Italic)
+
+=item .
+CBO = Courier Bold Oblique
+
+=item .
+H = Helvetica
+
+=item .
+HB = Helvetica Bold
+
+=item .
+HBO = Helvetical Bold Oblique
+
+=back
+
+ C<font_size> Defines the size of the font in postscript points to be used on labels
+ C<callnum_split> Setting this to '1' will enable call number splitting on labels
+ C<text_justify> Defines the text justification to be used on labels. NOTE: The following justification styles are currently supported by label creator code:
+
+=over 9
+
+=item .
+L = Left
+
+=item .
+C = Center
+
+=item .
+R = Right
+
+=back
+
+ C<format_string> Defines what fields will be printed and in what order they will be printed on labels. These include any of the data fields that may be mapped
+ to your MARC frameworks. Specify MARC subfields as a 4-character tag-subfield string: ie. 254a Enclose a whitespace-separated list of fields
+ to concatenate on one line in double quotes. ie. "099a 099b" or "itemcallnumber barcode" Static text strings may be entered in single-quotes:
+ ie. 'Some static text here.'
+ C<text_wrap_cols> Defines the column after which the text will wrap to the next line.
+
+=head2 get_label_type()
+
+ Invoking the I<get_label_type> method will return the printing type of the label object.
+
+ example:
+ C<my $label_type = $label->get_label_type();>
+
+=head2 get_attr($attribute)
+
+ Invoking the I<get_attr> method will return the value of the requested attribute or -1 on errors.
+
+ example:
+ C<my $value = $label->get_attr($attribute);>
+
+=head2 create_label()
+
+ Invoking the I<create_label> method generates the text for that label and returns it as an arrayref of an array contianing the formatted text as well as creating the barcode
+ and writing it directly to the pdf stream. The handling of the barcode is not quite good OO form due to the linear format of PDF::Reuse::Barcode. Be aware that the instantiating
+ code is responsible to properly format the text for insertion into the pdf stream as well as the actual insertion.
+
+ example:
+ my $label_text = $label->create_label();
+
+=head2 draw_label_text()
+
+ Invoking the I<draw_label_text> method generates the label text for the label object and returns it as an arrayref of an array containing the formatted text. The same caveats
+ apply to this method as to C<create_label()>. This method accepts the following parameters as key => value pairs: (NOTE: The unit is the postscript point - 72 per inch)
+
+ C<llx> The lower-left x coordinate for the text block (The point of origin for all PDF's is the lower left of the page per ISO 32000-1)
+ C<lly> The lower-left y coordinate for the text block
+ C<top_text_margin> The top margin for the text block.
+ C<line_spacer> The number of pixels between text rows (This is actually leading: baseline to baseline minus font size. Recommended starting point is 20% of font size)
+ C<font> The font to use for this label. See documentation on the new() method for supported fonts.
+ C<font_size> The font size in points to use for this label.
+ C<justify> The style of justification to use for this label. See documentation on the new() method for supported justification styles.
+
+ example:
+ C<my $label_text = $label->draw_label_text(
+ llx => $text_llx,
+ lly => $text_lly,
+ top_text_margin => $label_top_text_margin,
+ line_spacer => $text_leading,
+ font => $text_font,
+ font_size => $text_font_size,
+ justify => $text_justification,
+ );>
+
+=head2 barcode()
+
+ Invoking the I<barcode> method generates a barcode for the label object and inserts it into the current pdf stream. This method accepts the following parameters as key => value
+ pairs (C<barcode_data> is optional and omitting it will cause the barcode from the current item to be used. C<barcode_type> is also optional. Omission results in the barcode
+ type of the current template being used.):
+
+ C<llx> The lower-left x coordinate for the barcode block (The point of origin for all PDF's is the lower left of the page per ISO 32000-1)
+ C<lly> The lower-left y coordinate for the barcode block
+ C<width> The width of the barcode block
+ C<y_scale_factor> The scale factor to be applied to the y axis of the barcode block
+ C<barcode_data> The data to be encoded in the barcode
+ C<barcode_type> The barcode type (See the C<new()> method for supported barcode types)
+
+ example:
+ C<$label->barcode(
+ llx => $barcode_llx,
+ lly => $barcode_lly,
+ width => $barcode_width,
+ y_scale_factor => $barcode_y_scale_factor,
+ barcode_data => $barcode,
+ barcode_type => $barcodetype,
+ );>
+
+=head2 csv_data()
+
+ Invoking the I<csv_data> method returns an arrayref of an array containing the label data suitable for passing to Text::CSV_XS->combine() to produce csv output.
+
+ example:
+ C<my $csv_data = $label->csv_data();>
+
=head1 AUTHOR
Mason James <mason@katipo.co.nz>
+
Chris Nighswonger <cnighswonger AT foundations DOT edu>
-=cut
+=head1 COPYRIGHT
+
+Copyright 2006 Katipo Communications.
+
+Copyright 2009 Foundations Bible College.
+
+=head1 LICENSE
+
+This file is part of Koha.
+
+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
+Foundation; either version 2 of the License, or (at your option) any later version.
+You should have received a copy of the GNU General Public License along with Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
+Suite 330, Boston, MA 02111-1307 USA
+
+=head1 DISCLAIMER OF WARRANTY
+
+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
+A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+=cut
projects / koha_ffzg / blobdiff