- $VERSION = 0.03;
- require Exporter;
- @ISA = qw(Exporter);
- @EXPORT = qw(
- &get_label_options &GetLabelItems
- &build_circ_barcode &draw_boundaries
- &drawbox &GetActiveLabelTemplate
- &GetAllLabelTemplates &DeleteTemplate
- &GetSingleLabelTemplate &SaveTemplate
- &CreateTemplate &SetActiveTemplate
- &SaveConf &DrawSpineText &GetTextWrapCols
- &GetUnitsValue &DrawBarcode &DrawPatronCardText
- &get_printingtypes &GetPatronCardItems
- &get_layouts
- &get_barcode_types
- &get_batches &delete_batch
- &add_batch &printText
- &GetItemFields
- &get_text_fields
- get_layout &save_layout &add_layout
- &set_active_layout &by_order
- &build_text_dropbox
- &delete_layout &get_active_layout
- &get_highest_batch
- &deduplicate_batch
- &GetAllPrinterProfiles &GetSinglePrinterProfile
- &SaveProfile &CreateProfile &DeleteProfile
- &GetAssociatedProfile &SetAssociatedProfile
- );
-}
-
-my $DEBUG = 0;
-
-=head1 NAME
-
-C4::Labels - Functions for printing spine labels and barcodes in Koha
-
-=head1 FUNCTIONS
-
-=over 2
-
-=item get_label_options;
-
- $options = get_label_options()
-
-Return a pointer on a hash list containing info from labels_conf table in Koha DB.
-
-=cut
-
-#'
-sub get_label_options {
- my $dbh = C4::Context->dbh;
- my $query2 = " SELECT * FROM labels_conf where active = 1";
- my $sth = $dbh->prepare($query2);
- $sth->execute();
- my $conf_data = $sth->fetchrow_hashref;
- $sth->finish;
- return $conf_data;
-}
-
-sub get_layouts {
-
-## FIXME: this if/else could be compacted...
- my $dbh = C4::Context->dbh;
- my @data;
- my $query = " Select * from labels_conf";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @resultsloop;
- while ( my $data = $sth->fetchrow_hashref ) {
-
- $data->{'fieldlist'} = get_text_fields( $data->{'id'} );
- push( @resultsloop, $data );
- }
- $sth->finish;
-
- # @resultsloop
-
- return @resultsloop;
-}
-
-sub get_layout {
- my ($layout_id) = @_;
- my $dbh = C4::Context->dbh;
-
- # get the actual items to be printed.
- my $query = " Select * from labels_conf where id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($layout_id);
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
- return $data;
-}
-
-sub get_active_layout {
- my ($layout_id) = @_;
- my $dbh = C4::Context->dbh;
-
- # get the actual items to be printed.
- my $query = " Select * from labels_conf where active = 1";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
- return $data;
-}
-
-sub delete_layout {
- my ($layout_id) = @_;
- my $dbh = C4::Context->dbh;
-
- # get the actual items to be printed.
- my $query = "delete from labels_conf where id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($layout_id);
- $sth->finish;
-}
-
-sub get_printingtypes {
- my ($layout_id) = @_;
- my @printtypes;
-
- push( @printtypes, { code => 'BAR', desc => "barcode" } );
- push( @printtypes, { code => 'BIB', desc => "biblio" } );
- push( @printtypes, { code => 'BARBIB', desc => "barcode / biblio" } );
- push( @printtypes, { code => 'BIBBAR', desc => "biblio / barcode" } );
- push( @printtypes, { code => 'ALT', desc => "alternating labels" } );
-
- my $conf = get_layout($layout_id);
- my $active_printtype = $conf->{'printingtype'};
-
- # lop thru layout, insert selected to hash
-
- foreach my $printtype (@printtypes) {
- if ( $printtype->{'code'} eq $active_printtype ) {
- $printtype->{'active'} = 'MOO';
- }
- }
- return @printtypes;
-}
-
-sub build_text_dropbox {
- my ($order) = @_;
-
- # my @fields = get_text_fields();
- # my $field_count = scalar @fields;
- my $field_count = 10; # <----------- FIXME hard coded
-
- my @lines;
- !$order
- ? push( @lines, { num => '', selected => '1' } )
- : push( @lines, { num => '' } );
- for ( my $i = 1 ; $i <= $field_count ; $i++ ) {
- my $line = { num => "$i" };
- $line->{'selected'} = 1 if $i eq $order;
- push( @lines, $line );
- }
-
- # add a blank row too
-
- return @lines;
-}
-
-sub get_text_fields {
- my ($layout_id, $sorttype) = @_;
-
- my ( $a, $b, $c, $d, $e, $f, $g, $h, $i ,$j, $k );
-
- my $sortorder = get_layout($layout_id);
-
- # $sortorder
-
- $a = {
- code => 'itemtype',
- desc => "Item Type",
- order => $sortorder->{'itemtype'}
- };
- $b = {
- code => 'dewey',
- desc => "Dewey",
- order => $sortorder->{'dewey'}
- };
- $c = { code => 'issn', desc => "ISSN",
- order => $sortorder->{'issn'} };
- $d = { code => 'isbn', desc => "ISBN",
- order => $sortorder->{'isbn'} };
- $e = {
- code => 'class',
- desc => "Classification",
- order => $sortorder->{'class'}
- };
- $f = {
- code => 'subclass',
- desc => "Sub-Class",
- order => $sortorder->{'subclass'}
- };
- $g = {
- code => 'barcode',
- desc => "Barcode",
- order => $sortorder->{'barcode'}
- };
- $h =
- { code => 'author', desc => "Author", order => $sortorder->{'author'} };
- $i = { code => 'title', desc => "Title", order => $sortorder->{'title'} };
- $j = { code => 'itemcallnumber', desc => "Call Number", order => $sortorder->{'itemcallnumber'} };
- $k = { code => 'subtitle', desc => "Subtitle", order => $sortorder->{'subtitle'} };
-
- my @text_fields = ( $a, $b, $c, $d, $e, $f, $g, $h, $i ,$j, $k );
-
- my @new_fields;
- foreach my $field (@text_fields) {
- push( @new_fields, $field ) if $field->{'order'} > 0;
- }
-
- my @sorted_fields = sort by_order @new_fields;
- my $active_fields;
- foreach my $field (@sorted_fields) {
- $sorttype eq 'codes' ? $active_fields .= "$field->{'code'} " :
- $active_fields .= "$field->{'desc'} ";
- }
- return $active_fields;
-
-}
-
-sub by_order {
- $$a{order} <=> $$b{order};
-}
-
-sub add_batch {
- my ( $batch_type ) = @_;
- my $new_batch;
- my $dbh = C4::Context->dbh;
- my $q =
- "SELECT DISTINCT batch_id FROM $batch_type ORDER BY batch_id desc LIMIT 1";
- my $sth = $dbh->prepare($q);
- $sth->execute();
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
-
- if ( !$data->{'batch_id'} ) {
- $new_batch = 1;
- }
- else {
- $new_batch = ( $data->{'batch_id'} + 1 );
- }
-
- return $new_batch;
-}
-
-#FIXME: Needs to be ported to receive $batch_type
-sub get_highest_batch {
- my $new_batch;
- my $dbh = C4::Context->dbh;
- my $q =
- "select distinct batch_id from labels order by batch_id desc limit 1";
- my $sth = $dbh->prepare($q);
- $sth->execute();
- my $data = $sth->fetchrow_hashref;
- $sth->finish;
-
- if ( !$data->{'batch_id'} ) {
- $new_batch = 1;
- }
- else {
- $new_batch = $data->{'batch_id'};
- }
-
- return $new_batch;
-}
-
-
-#FIXME: Needs to be ported to receive $batch_type
-sub get_batches {
- my ($batch_type) = @_;
- my $dbh = C4::Context->dbh;
- my $q = "select batch_id, count(*) as num from $batch_type group by batch_id";
- my $sth = $dbh->prepare($q);
- $sth->execute();
- my @resultsloop;
- while ( my $data = $sth->fetchrow_hashref ) {
- push( @resultsloop, $data );
- }
- $sth->finish;
-
-# Not sure why we are doing this rather than simply telling the user that no batches are currently defined.
-# So I'm commenting this out and modifying label-manager.tmpl to properly inform the user as stated. -fbcit
- # adding a dummy batch=1 value , if none exists in the db
-# if ( !scalar(@resultsloop) ) {
-# push( @resultsloop, { batch_id => '1' , num => '0' } );
-# }
- return @resultsloop;
-}
-
-sub delete_batch {
- my ($batch_id, $batch_type) = @_;
- warn "Deleteing batch of type $batch_type";
- my $dbh = C4::Context->dbh;
- my $q = "DELETE FROM $batch_type WHERE batch_id = ?";
- my $sth = $dbh->prepare($q);
- $sth->execute($batch_id);
- $sth->finish;
-}
-
-sub get_barcode_types {
- my ($layout_id) = @_;
- my $layout = get_layout($layout_id);
- my $barcode = $layout->{'barcodetype'};
- my @array;
-
- push( @array, { code => 'CODE39', desc => 'Code 39' } );
- push( @array, { code => 'CODE39MOD', desc => 'Code39 + Modulo43' } );
- push( @array, { code => 'CODE39MOD10', desc => 'Code39 + Modulo10' } );
- push( @array, { code => 'ITF', desc => 'Interleaved 2 of 5' } );
-
- foreach my $line (@array) {
- if ( $line->{'code'} eq $barcode ) {
- $line->{'active'} = 1;
- }
-
- }
- return @array;
-}
-
-sub GetUnitsValue {
- my ($units) = @_;
- my $unitvalue;
-
- $unitvalue = '1' if ( $units eq 'POINT' );
- $unitvalue = '2.83464567' if ( $units eq 'MM' );
- $unitvalue = '28.3464567' if ( $units eq 'CM' );
- $unitvalue = 72 if ( $units eq 'INCH' );
- return $unitvalue;
-}
-
-sub GetTextWrapCols {
- my ( $font, $fontsize, $label_width, $left_text_margin ) = @_;
- my $string = '0';
- my $strwidth;
- my $count = 0;
-# my $textlimit = $label_width - ($left_text_margin);
- my $textlimit = $label_width - ( 2* $left_text_margin);
-
- while ( $strwidth < $textlimit ) {
- $strwidth = prStrWidth( $string, $font, $fontsize );
- $string = $string . '0';
- #warn "strwidth:$strwidth, textlimit:$textlimit, count:$count string:$string";
- $count++;
- }
- return $count;
-}
-
-sub GetActiveLabelTemplate {
- my $dbh = C4::Context->dbh;
- my $query = " SELECT * FROM labels_templates where active = 1 limit 1";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my $active_tmpl = $sth->fetchrow_hashref;
- $sth->finish;
- return $active_tmpl;
-}
-
-sub GetSingleLabelTemplate {
- my ($tmpl_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = " SELECT * FROM labels_templates where tmpl_id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($tmpl_id);
- my $template = $sth->fetchrow_hashref;
- $sth->finish;
- return $template;
-}
-
-sub SetActiveTemplate {
-
- my ($tmpl_id) = @_;
-
- my $dbh = C4::Context->dbh;
- my $query = " UPDATE labels_templates SET active = NULL";
- my $sth = $dbh->prepare($query);
- $sth->execute();
-
- $query = "UPDATE labels_templates SET active = 1 WHERE tmpl_id = ?";
- $sth = $dbh->prepare($query);
- $sth->execute($tmpl_id);
- $sth->finish;
-}
-
-sub set_active_layout {
-
- my ($layout_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = " UPDATE labels_conf SET active = NULL";
- my $sth = $dbh->prepare($query);
- $sth->execute();
-
- $query = "UPDATE labels_conf SET active = 1 WHERE id = ?";
- $sth = $dbh->prepare($query);
- $sth->execute($layout_id);
- $sth->finish;
-}
-
-sub DeleteTemplate {
- my ($tmpl_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = " DELETE FROM labels_templates where tmpl_id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($tmpl_id);
- $sth->finish;
-}
-
-sub SaveTemplate {
- my (
- $tmpl_id, $tmpl_code, $tmpl_desc, $page_width,
- $page_height, $label_width, $label_height, $topmargin,
- $leftmargin, $cols, $rows, $colgap,
- $rowgap, $font, $fontsize, $units
- ) = @_;
- warn "Passed \$font:$font";
- my $dbh = C4::Context->dbh;
- my $query =
- " UPDATE labels_templates SET tmpl_code=?, tmpl_desc=?, page_width=?,
- page_height=?, label_width=?, label_height=?, topmargin=?,
- leftmargin=?, cols=?, rows=?, colgap=?, rowgap=?, font=?, fontsize=?,
- units=?
- WHERE tmpl_id = ?";
-
- my $sth = $dbh->prepare($query);
- $sth->execute(
- $tmpl_code, $tmpl_desc, $page_width, $page_height,
- $label_width, $label_height, $topmargin, $leftmargin,
- $cols, $rows, $colgap, $rowgap,
- $font, $fontsize, $units, $tmpl_id
- );
- my $dberror = $sth->errstr;
- $sth->finish;
- return $dberror;
-}
-
-sub CreateTemplate {
- my $tmpl_id;
- my (
- $tmpl_code, $tmpl_desc, $page_width, $page_height,
- $label_width, $label_height, $topmargin, $leftmargin,
- $cols, $rows, $colgap, $rowgap,
- $font, $fontsize, $units
- ) = @_;
-
- my $dbh = C4::Context->dbh;
-
- my $query = "INSERT INTO labels_templates (tmpl_code, tmpl_desc, page_width,
- page_height, label_width, label_height, topmargin,
- leftmargin, cols, rows, colgap, rowgap, font, fontsize, units)
- VALUES(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)";
-
- my $sth = $dbh->prepare($query);
- $sth->execute(
- $tmpl_code, $tmpl_desc, $page_width, $page_height,
- $label_width, $label_height, $topmargin, $leftmargin,
- $cols, $rows, $colgap, $rowgap,
- $font, $fontsize, $units
- );
- my $dberror = $sth->errstr;
- $sth->finish;
- return $dberror;
-}
-
-sub GetAllLabelTemplates {
- my $dbh = C4::Context->dbh;
-
- # get the actual items to be printed.
- my @data;
- my $query = " Select * from labels_templates ";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @resultsloop;
- while ( my $data = $sth->fetchrow_hashref ) {
- push( @resultsloop, $data );
- }
- $sth->finish;
-
- #warn Dumper @resultsloop;
- return @resultsloop;
-}
-
-#sub SaveConf {
-sub add_layout {
-
- my (
- $barcodetype, $title, $subtitle, $isbn, $issn,
- $itemtype, $bcn, $dcn, $classif,
- $subclass, $itemcallnumber, $author, $tmpl_id,
- $printingtype, $guidebox, $startlabel, $layoutname
- ) = @_;
-
- my $dbh = C4::Context->dbh;
- my $query2 = "update labels_conf set active = NULL";
- my $sth2 = $dbh->prepare($query2);
- $sth2->execute();
- $query2 = "INSERT INTO labels_conf
- ( barcodetype, title, subtitle, isbn,issn, itemtype, barcode,
- dewey, class, subclass, itemcallnumber, author, printingtype,
- guidebox, startlabel, layoutname, active )
- values ( ?, ?, ?, ?, ?, ?, ?, ?,?, ?, ?, ?, ?, ?,?,?, 1 )";
- $sth2 = $dbh->prepare($query2);
- $sth2->execute(
- $barcodetype, $title, $subtitle, $isbn, $issn,
-
- $itemtype, $bcn, $dcn, $classif,
- $subclass, $itemcallnumber, $author, $printingtype,
- $guidebox, $startlabel, $layoutname
- );
- $sth2->finish;
-
- SetActiveTemplate($tmpl_id);
- return;
-}
-
-sub save_layout {
-
- my (
- $barcodetype, $title, $subtitle, $isbn, $issn,
- $itemtype, $bcn, $dcn, $classif,
- $subclass, $itemcallnumber, $author, $tmpl_id,
- $printingtype, $guidebox, $startlabel, $layoutname,
- $layout_id
- ) = @_;
-### $layoutname
-### $layout_id
-
- my $dbh = C4::Context->dbh;
- my $query2 = "update labels_conf set
- barcodetype=?, title=?, subtitle=?, isbn=?,issn=?,
- itemtype=?, barcode=?, dewey=?, class=?,
- subclass=?, itemcallnumber=?, author=?, printingtype=?,
- guidebox=?, startlabel=?, layoutname=? where id = ?";
- my $sth2 = $dbh->prepare($query2);
- $sth2->execute(
- $barcodetype, $title, $subtitle, $isbn, $issn,
- $itemtype, $bcn, $dcn, $classif,
- $subclass, $itemcallnumber, $author, $printingtype,
- $guidebox, $startlabel, $layoutname, $layout_id
- );
- $sth2->finish;
-
- return;
-}
-
-=item GetAllPrinterProfiles;
-
- @profiles = GetAllPrinterProfiles()
-
-Returns an array of references-to-hash, whos keys are .....
-
-=cut
-
-sub GetAllPrinterProfiles {
-
- my $dbh = C4::Context->dbh;
- my @data;
- my $query = "SELECT * FROM printers_profile AS pp INNER JOIN labels_templates AS lt ON pp.tmpl_id = lt.tmpl_id; ";
- my $sth = $dbh->prepare($query);
- $sth->execute();
- my @resultsloop;
- while ( my $data = $sth->fetchrow_hashref ) {
- push( @resultsloop, $data );
- }
- $sth->finish;
-
- return @resultsloop;
-}
-
-=item GetSinglePrinterProfile;
-
- $profile = GetSinglePrinterProfile()
-
-Returns a hashref whos keys are...
-
-=cut
-
-sub GetSinglePrinterProfile {
- my ($prof_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = " SELECT * FROM printers_profile WHERE prof_id = ?; ";
- my $sth = $dbh->prepare($query);
- $sth->execute($prof_id);
- my $template = $sth->fetchrow_hashref;
- $sth->finish;
- return $template;
-}
-
-=item SaveProfile;
-
- SaveProfile('parameters')
-
-When passed a set of parameters, this function updates the given profile with the new parameters.
-
-=cut
-
-sub SaveProfile {
- my (
- $prof_id, $offset_horz, $offset_vert, $creep_horz, $creep_vert, $units
- ) = @_;
- my $dbh = C4::Context->dbh;
- my $query =
- " UPDATE printers_profile
- SET offset_horz=?, offset_vert=?, creep_horz=?, creep_vert=?, unit=?
- WHERE prof_id = ? ";
- my $sth = $dbh->prepare($query);
- $sth->execute(
- $offset_horz, $offset_vert, $creep_horz, $creep_vert, $units, $prof_id
- );
- $sth->finish;
-}
-
-=item CreateProfile;
-
- CreateProfile('parameters')
-
-When passed a set of parameters, this function creates a new profile containing those parameters
-and returns any errors.
-
-=cut
-
-sub CreateProfile {
- my (
- $prof_id, $printername, $paper_bin, $tmpl_id, $offset_horz,
- $offset_vert, $creep_horz, $creep_vert, $units
- ) = @_;
- my $dbh = C4::Context->dbh;
- my $query =
- " INSERT INTO printers_profile (prof_id, printername, paper_bin, tmpl_id,
- offset_horz, offset_vert, creep_horz, creep_vert, unit)
- VALUES(?,?,?,?,?,?,?,?,?) ";
- my $sth = $dbh->prepare($query);
- $sth->execute(
- $prof_id, $printername, $paper_bin, $tmpl_id, $offset_horz,
- $offset_vert, $creep_horz, $creep_vert, $units
- );
- my $error = $sth->errstr;
- $sth->finish;
- return $error;
-}
-
-=item DeleteProfile;
-
- DeleteProfile(prof_id)
-
-When passed a profile id, this function deletes that profile from the database and returns any errors.
-
-=cut
-
-sub DeleteProfile {
- my ($prof_id) = @_;
- my $dbh = C4::Context->dbh;
- my $query = " DELETE FROM printers_profile WHERE prof_id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($prof_id);
- my $error = $sth->errstr;
- $sth->finish;
- return $error;
-}
-
-=item GetAssociatedProfile;
-
- $assoc_prof = GetAssociatedProfile(tmpl_id)
-
-When passed a template id, this function returns the parameters from the currently associated printer profile
-in a hashref where key=fieldname and value=fieldvalue.
-
-=cut
-
-sub GetAssociatedProfile {
- my ($tmpl_id) = @_;
- my $dbh = C4::Context->dbh;
- # First we find out the prof_id for the associated profile...
- my $query = "SELECT * FROM labels_profile WHERE tmpl_id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($tmpl_id);
- my $assoc_prof = $sth->fetchrow_hashref;
- $sth->finish;
- # Then we retrieve that profile and return it to the caller...
- $assoc_prof = GetSinglePrinterProfile($assoc_prof->{'prof_id'});
- return $assoc_prof;
-}
-
-=item SetAssociatedProfile;
-
- SetAssociatedProfile($prof_id, $tmpl_id)
-
-When passed both a profile id and template id, this function establishes an association between the two. No more
-than one profile may be associated with any given template at the same time.
-
-=cut
-
-sub SetAssociatedProfile {
-
- my ($prof_id, $tmpl_id) = @_;
-
- my $dbh = C4::Context->dbh;
- my $query = "INSERT INTO labels_profile (prof_id, tmpl_id) VALUES (?,?) ON DUPLICATE KEY UPDATE prof_id = ?";
- my $sth = $dbh->prepare($query);
- $sth->execute($prof_id, $tmpl_id, $prof_id);
- $sth->finish;
-}
-
-=item GetLabelItems;
-
- $options = GetLabelItems()
-
-Returns an array of references-to-hash, whos keys are the field from the biblio, biblioitems, items and labels tables in the Koha database.
-
-=cut
-
-#'
-sub GetLabelItems {
- my ($batch_id) = @_;
- my $dbh = C4::Context->dbh;
-
- my @resultsloop = ();
- my $count;
- my @data;
- my $sth;
-
- if ($batch_id) {
- my $query3 = "Select * from labels where batch_id = ? order by labelid ";
- $sth = $dbh->prepare($query3);
- $sth->execute($batch_id);
-
- }
- else {
-
- my $query3 = "Select * from labels";
- $sth = $dbh->prepare($query3);
- $sth->execute();
- }
- my $cnt = $sth->rows;
- my $i1 = 1;
- while ( my $data = $sth->fetchrow_hashref ) {
-
- # lets get some summary info from each item
- my $query1 = "
- select i.*, bi.*, b.* from items i,biblioitems bi,biblio b
- where itemnumber=? and i.biblioitemnumber=bi.biblioitemnumber and
- bi.biblionumber=b.biblionumber";
-
- my $sth1 = $dbh->prepare($query1);
- $sth1->execute( $data->{'itemnumber'} );