From 3d65f09faa078f67d19c159de09be2239f8af3f3 Mon Sep 17 00:00:00 2001 From: Dobrica Pavlinusic Date: Wed, 28 Mar 2012 14:43:35 +0200 Subject: [PATCH] Bug 6448 [2/3] Barcodes::EAN13 autoBarcode Implement auto-incrementing EAN-13 barcodes To make this work, C4::Barcodes::next was modified to call process_tail with new incremented value so that process_tail can generate correct checksum. Since process_tail is currenlty not used by any barcodes, this change is safe. C4::Barcodes is used by addbiblio.pl when adding multiple records, while value_builder is used in all other cases. Test scenario: 1. prove t/Barcodes_EAN13.t 2. KOHA_CONF=/etc/koha/sites/fer/koha-conf.xml prove t/db_dependent/Barcodes.t this will check C4::Barcode implementataion 3. in systempreference change autoBarcode to incremental EAN-13 barcode 4. edit two items of any biblio assigning barcodes and verify that numbers are increasing. Have in mind that last digit is check digit, and it doesn't increment, but is calculated from barcode itself. Example with checksum in brackets: 000000086275[2], 000000086276[9], 000000086277[6] 5. Add Item and verify that it gets assigned next barcode 6. Add & Duplicate item and verify barcode increase 7. Add Multiple Copies and verify that barcode increase for each copy Signed-off-by: Chris Cormack --- C4/Barcodes.pm | 4 +- C4/Barcodes/EAN13.pm | 57 ++++++++++++++++++++ cataloguing/value_builder/barcode.pl | 23 ++++++++ installer/data/mysql/sysprefs.sql | 2 +- installer/data/mysql/updatedatabase.pl | 4 ++ .../en/modules/admin/preferences/cataloguing.pref | 1 + t/Barcodes_EAN13.t | 13 +++++ t/db_dependent/Barcodes.t | 3 +- 8 files changed, 104 insertions(+), 3 deletions(-) create mode 100644 C4/Barcodes/EAN13.pm create mode 100755 t/Barcodes_EAN13.t diff --git a/C4/Barcodes.pm b/C4/Barcodes.pm index 4a5fa19..9261ae2 100644 --- a/C4/Barcodes.pm +++ b/C4/Barcodes.pm @@ -28,6 +28,7 @@ use C4::Dates; use C4::Barcodes::hbyymmincr; use C4::Barcodes::annual; use C4::Barcodes::incremental; +use C4::Barcodes::EAN13; use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS); use vars qw($debug $cgi_debug); # from C4::Debug, of course @@ -138,7 +139,7 @@ sub next_value { $debug and warn "$incr"; $head = $self->process_head($head,$max,$specific); - $tail = $self->process_tail($tail,$max,$specific); + $tail = $self->process_tail($tail,$incr,$specific); # XXX use $incr and not $max! my $next_value = $head . $incr . $tail; $debug and print STDERR "( next ) max barcode found: $next_value\n"; return $next_value; @@ -177,6 +178,7 @@ our $types = { incremental => sub {C4::Barcodes::incremental->new_object(@_);}, hbyymmincr => sub {C4::Barcodes::hbyymmincr->new_object(@_); }, OFF => sub {C4::Barcodes::OFF->new_object(@_); }, + EAN13 => sub {C4::Barcodes::EAN13->new_object(@_); }, }; sub new { diff --git a/C4/Barcodes/EAN13.pm b/C4/Barcodes/EAN13.pm new file mode 100644 index 0000000..4878e89 --- /dev/null +++ b/C4/Barcodes/EAN13.pm @@ -0,0 +1,57 @@ +package C4::Barcodes::EAN13; + +# Copyright 2012 Koha Development team +# +# 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., +# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +use strict; +use warnings; + +use C4::Context; +use C4::Debug; + +use Algorithm::CheckDigits; + +use vars qw($VERSION @ISA); +use vars qw($debug $cgi_debug); # from C4::Debug, of course + +BEGIN { + $VERSION = 0.01; + @ISA = qw(C4::Barcodes); +} + +sub parse { + my $self = shift; + my $barcode = (@_) ? shift : $self->value; + my $ean = CheckDigits('ean'); + if ( $ean->is_valid($barcode) ) { + return ( '', $ean->basenumber($barcode), $ean->checkdigit($barcode) ); + } else { + die "$barcode not valid EAN-13 barcode"; + } +} + +sub process_tail { + my ( $self,$tail,$whole,$specific ) = @_; + my $ean = CheckDigits('ean'); + my $full = $ean->complete($whole); + my $chk = $ean->checkdigit($full); + $debug && warn "# process_tail $tail -> $chk [$whole -> $full] $specific"; + return $chk; +} + +1; +__END__ diff --git a/cataloguing/value_builder/barcode.pl b/cataloguing/value_builder/barcode.pl index c5e1fd3..709e726 100755 --- a/cataloguing/value_builder/barcode.pl +++ b/cataloguing/value_builder/barcode.pl @@ -24,6 +24,8 @@ no warnings 'redefine'; # otherwise loading up multiple plugins fills the log wi use C4::Context; require C4::Dates; +use Algorithm::CheckDigits; + my $DEBUG = 0; =head1 @@ -123,6 +125,27 @@ sub plugin_javascript { } "; } + elsif ($autoBarcodeType eq 'EAN13') { + # not the best, two catalogers could add the same barcode easily this way :/ + $query = "select max(abs(barcode)) from items"; + my $sth = $dbh->prepare($query); + $sth->execute(); + while (my ($last)= $sth->fetchrow_array) { + $nextnum = $last; + } + my $ean = CheckDigits('ean'); + if ( $ean->is_valid($nextnum) ) { + my $next = $ean->basenumber( $nextnum ) + 1; + $nextnum = $ean->complete( $next ); + $nextnum = '0' x ( 13 - length($nextnum) ) . $nextnum; # pad zeros + } else { + warn "ERROR: invalid EAN-13 $nextnum, using increment"; + $nextnum++; + } + } + else { + warn "ERROR: unknown autoBarcode: $autoBarcodeType"; + } # default js body (if not filled by hbyymmincr) $scr or $scr = <preference("Version") < TransformToNum($DBversion) ) { $dbh->do("UPDATE systempreferences SET options=concat(options,'|EAN13') WHERE variable='itemBarcodeInputFilter' AND options NOT LIKE '%EAN13%'"); print "Upgrade to $DBversion done (Add itemBarcodeInputFilter choice EAN13)\n"; + + $dbh->do("UPDATE systempreferences SET options = concat(options,'|EAN13'), explanation = concat(explanation,'; EAN13 - incremental') WHERE variable = 'autoBarcode' AND options NOT LIKE '%EAN13%'"); + print "Upgrade to $DBversion done ( Added EAN13 barcode autogeneration sequence )\n"; + SetVersion($DBversion); } diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref index fe5fd05..c683da7 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/cataloguing.pref @@ -93,6 +93,7 @@ Cataloging: incremental: generated in the form 1, 2, 3. annual: generated in the form <year>-0001, <year>-0002. hbyymmincr: generated in the form <branchcode>yymm0001. + EAN13: incremental EAN-13 barcodes "OFF": not generated automatically. Display: - diff --git a/t/Barcodes_EAN13.t b/t/Barcodes_EAN13.t new file mode 100755 index 0000000..c75936d --- /dev/null +++ b/t/Barcodes_EAN13.t @@ -0,0 +1,13 @@ +#!/usr/bin/perl +# +# implementation tests are in t/db_dependent/Barcodes.t + +use strict; +use warnings; + +use Test::More tests => 1; + +BEGIN { + use_ok('C4::Barcodes::EAN13'); +} + diff --git a/t/db_dependent/Barcodes.t b/t/db_dependent/Barcodes.t index cd50178..3a78452 100755 --- a/t/db_dependent/Barcodes.t +++ b/t/db_dependent/Barcodes.t @@ -3,7 +3,7 @@ use strict; use warnings; -use Test::More tests => 49; +use Test::More tests => 66; BEGIN { use FindBin; use lib $FindBin::Bin; @@ -14,6 +14,7 @@ my %thash = ( incremental => [], annual => [], hbyymmincr => ['MAIN'], + EAN13 => ['0000000695152','892685001928'], ); print "\n"; -- 1.7.2.5