Bug 17600: Standardize our EXPORT_OK
[srvgit] / cataloguing / value_builder / barcode.pl
index c5e1fd3..da1ec86 100755 (executable)
 #!/usr/bin/perl
+
+# Converted to new plugin style (Bug 13437)
+
 # Copyright 2000-2002 Katipo Communications
 # Parts copyright 2008-2010 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 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 3 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.
+# 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.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
-use strict;
-use warnings;
-no warnings 'redefine'; # otherwise loading up multiple plugins fills the log with subroutine redefine warnings
+use Modern::Perl;
 
 use C4::Context;
-require C4::Dates;
-
-my $DEBUG = 0;
-
-=head1
-
-plugin_parameters : other parameters added when the plugin is called by the dopop function
-
-=cut
+use C4::Barcodes::ValueBuilder;
+use C4::Biblio qw( GetMarcFromKohaField );
+use Koha::DateUtils qw( dt_from_string output_pref );
 
-sub plugin_parameters {
-#   my ($dbh,$record,$tagslib,$i,$tabloop) = @_;
-    return "";
-}
-
-=head1
-
-plugin_javascript : the javascript function called when the user enters the subfield.
-contain 3 javascript functions :
-* one called when the field is entered (OnFocus). Named FocusXXX
-* one called when the field is leaved (onBlur). Named BlurXXX
-* one called when the ... link is clicked (<a href="javascript:function">) named ClicXXX
+use Algorithm::CheckDigits qw( CheckDigits );
 
-returns :
-* XXX
-* a variable containing the 3 scripts.
-the 3 scripts are inserted after the <input> in the html code
-
-=cut
-
-sub plugin_javascript {
-       my ($dbh,$record,$tagslib,$field_number,$tabloop) = @_;
-       my $function_name= "barcode".(int(rand(100000))+1);
+my $builder = sub {
+    my ( $params ) = @_;
+    my $function_name = $params->{id};
+    my %args;
 
        # find today's date
-       my ($year, $mon, $day) = split('-', C4::Dates->today('iso'));
-       my ($tag,$subfield)       =  GetMarcFromKohaField("items.barcode", '');
-       my ($loctag,$locsubfield) =  GetMarcFromKohaField("items.homebranch", '');
+    ($args{year}, $args{mon}, $args{day}) = split('-', output_pref({ dt => dt_from_string, dateformat => 'iso', dateonly => 1 }));
+    ($args{tag},$args{subfield})       =  GetMarcFromKohaField( "items.barcode" );
+    ($args{loctag},$args{locsubfield}) =  GetMarcFromKohaField( "items.homebranch" );
 
        my $nextnum;
-       my $query;
     my $scr;
        my $autoBarcodeType = C4::Context->preference("autoBarcode");
-    warn "Barcode type = $autoBarcodeType" if $DEBUG;
        if ((not $autoBarcodeType) or $autoBarcodeType eq 'OFF') {
         # don't return a value unless we have the appropriate syspref set
-               return ($function_name, 
-        "<script type=\"text/javascript\">
-        // autoBarcodeType OFF (or not defined)
-        function Focus$function_name() { return 0;}
-        function  Clic$function_name() { return 0;}
-        function  Blur$function_name() { return 0;}
-        </script>");
+        return q|<script></script>|;
     }
        if ($autoBarcodeType eq 'annual') {
-               $query = "select max(cast( substring_index(barcode, '-',-1) as signed)) from items where barcode like ?";
-               my $sth=$dbh->prepare($query);
-               $sth->execute("$year%");
-               while (my ($count)= $sth->fetchrow_array) {
-            warn "Examining Record: $count" if $DEBUG;
-               $nextnum = $count if $count;
-               }
-               $nextnum++;
-               $nextnum = sprintf("%0*d", "4",$nextnum);
-               $nextnum = "$year-$nextnum";
+        ($nextnum, $scr) = C4::Barcodes::ValueBuilder::annual::get_barcode(\%args);
        }
        elsif ($autoBarcodeType eq 'incremental') {
-               # 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 ($count)= $sth->fetchrow_array) {
-                       $nextnum = $count;
-               }
-               $nextnum++;
+        ($nextnum, $scr) = C4::Barcodes::ValueBuilder::incremental::get_barcode(\%args);
     }
     elsif ($autoBarcodeType eq 'hbyymmincr') {      # Generates a barcode where hb = home branch Code, yymm = year/month catalogued, incr = incremental number, reset yearly -fbcit
-        $year = substr($year, -2);
-        $query = "SELECT MAX(CAST(SUBSTRING(barcode,-4) AS signed)) AS number FROM items WHERE barcode REGEXP ?";
+        ($nextnum, $scr) = C4::Barcodes::ValueBuilder::hbyymmincr::get_barcode(\%args);
+    }
+    elsif ($autoBarcodeType eq 'EAN13') {
+        # not the best, two catalogers could add the same barcode easily this way :/
+        my $query = "select max(abs(barcode)) from items";
+    my $dbh = $params->{dbh};
         my $sth = $dbh->prepare($query);
-        $sth->execute("^[-a-zA-Z]{1,}$year");
-        while (my ($count)= $sth->fetchrow_array) {
-            $nextnum = $count if $count;
-            $nextnum = 0 if $nextnum == 9999; # this sequence only allows for cataloging 10000 books per month
-            warn "Existing incremental number = $nextnum" if $DEBUG;
-        }
-        $nextnum++;
-        $nextnum = sprintf("%0*d", "4",$nextnum);
-        $nextnum = $year . $mon . $nextnum;
-        warn "New hbyymmincr Barcode = $nextnum" if $DEBUG;
-        $scr = " 
-        for (i=0 ; i<document.f.field_value.length ; i++) {
-            if (document.f.tag[i].value == '$loctag' && document.f.subfield[i].value == '$locsubfield') {
-                fnum = i;
-            }
+        $sth->execute();
+        while (my ($last)= $sth->fetchrow_array) {
+            $nextnum = $last;
         }
-        if (\$('#' + id).val() == '' || force) {
-            \$('#' + id).val(document.f.field_value[fnum].value + '$nextnum');
+        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 = <<END_OF_JS;
 if (\$('#' + id).val() == '' || force) {
     \$('#' + id).val('$nextnum');
-}
+};
 END_OF_JS
 
     my $js  = <<END_OF_JS;
-<script type="text/javascript">
-//<![CDATA[
-
-function Blur$function_name(index) {
-    //barcode validation might go here
-}
+<script>
 
-function Focus$function_name(subfield_managed, id, force) {
+function Focus$function_name(id, force) {
 $scr
-    return 0;
 }
 
-function Clic$function_name(id) {
-    return Focus$function_name('not_relavent', id, 1);
+function Click$function_name(id) {
+    Focus$function_name(id, 1);
+    return false;
 }
-//]]>
 </script>
 END_OF_JS
-    return ($function_name, $js);
-}
-
-=head1
-
-plugin: useless here
-
-=cut
-
-sub plugin {
-    # my ($input) = @_;
-    return "";
-}
+    return $js;
+};
 
-1;
+return { builder => $builder };