removing useless package
[koha.git] / C4 / Input.pm
index 330fc54..528f680 100644 (file)
-package C4::Input; #asummes C4/Input
-
-#package to deal with marking up output
+package C4::Input; #assumes C4/Input
+
+
+# Copyright 2000-2002 Katipo Communications
+#
+# 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;
 require Exporter;
+use C4::Context;
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
+use vars qw($VERSION @ISA @EXPORT);
 
 # set the version for version checking
 $VERSION = 0.01;
 
-@ISA = qw(Exporter);
-@EXPORT = qw(&checkflds &checkdigit);
-%EXPORT_TAGS = ( );     # eg: TAG => [ qw!name1 name2! ],
-
-# your exported package globals go here,
-# as well as any optionally exported functions
+=head1 NAME
 
-@EXPORT_OK   = qw($Var1 %Hashit);
+C4::Input - Miscellaneous sanity checks
 
+=head1 SYNOPSIS
 
-# non-exported package globals go here
-use vars qw(@more $stuff);
+  use C4::Input;
 
-# initalize package globals, first exported ones
+=head1 DESCRIPTION
 
-my $Var1   = '';
-my %Hashit = ();
+This module provides functions to see whether a given library card
+number or ISBN is valid.
 
+=head1 FUNCTIONS
 
-# then the others (which are still accessible as $Some::Module::stuff)
-my $stuff  = '';
-my @more   = ();
+=over 2
 
-# all file-scoped lexicals must be created before
-# the functions below that use them.
+=cut
 
-# file-private lexicals go here
-my $priv_var    = '';
-my %secret_hash = ();
+@ISA = qw(Exporter);
+@EXPORT = qw(
+       &checkdigit &checkvalidisbn
+);
+
+# FIXME - This is never used.
+#sub checkflds {
+#  my ($env,$reqflds,$data) = @_;
+#  my $numrflds = @$reqflds;
+#  my @probarr;
+#  my $i = 0;
+#  while ($i < $numrflds) {
+#    if ($data->{@$reqflds[$i]} eq "") {
+#      push(@probarr, @$reqflds[$i]);
+#    }
+#    $i++
+#  }
+#  return (\@probarr);
+#}
+
+=item checkdigit
+
+  $valid = &checkdigit($env, $cardnumber $nounique);
+
+Takes a card number, computes its check digit, and compares it to the
+checkdigit at the end of C<$cardnumber>. Returns a true value iff
+C<$cardnumber> has a valid check digit.
+
+C<$env> is ignored.
+
+=cut
+#'
+sub checkdigit {
 
-# here's a file-private function as a closure,
-# callable as &$priv_func;  it cannot be prototyped.
-my $priv_func = sub {
-# stuff goes here.
-  };
-   
-# make all your functions, whether exported or not;
-sub checkflds {
-  my ($env,$reqflds,$data) = @_;
-  my $numrflds = @$reqflds;
-  my @probarr;
-  my $i = 0;
-  while ($i < $numrflds) {
-    if ($data->{@$reqflds[$i]} eq "") {
-      push(@probarr, @$reqflds[$i]);
-    }  
-    $i++
-  }
-  return (\@probarr);
-}
+       my ($env,$infl, $nounique) =  @_;
+       $infl = uc $infl;
+
+
+       #Check to make sure the cardnumber is unique
+
+       #FIXME: We should make the error for a nonunique cardnumber
+       #different from the one where the checkdigit on the number is
+       #not correct
+
+       unless ( $nounique )
+       {
+               my $dbh=C4::Context->dbh;
+               my $query=qq{SELECT * FROM borrowers WHERE cardnumber=?};
+               my $sth=$dbh->prepare($query);
+               $sth->execute($infl);
+               my %results = $sth->fetchrow_hashref();
+               if ( $sth->rows != 0 )
+               {
+                       return 0;
+               }
+       }
+       if (C4::Context->preference("checkdigit") eq "none") {
+               return 1;
+       }
+
+       my @weightings = (8,4,6,3,5,2,1);
+       my $sum;
+       my $i = 1;
+       my $valid = 0;
+
+       foreach $i (1..7) {
+               my $temp1 = $weightings[$i-1];
+               my $temp2 = substr($infl,$i,1);
+               $sum += $temp1 * $temp2;
+       }
+       my $rem = ($sum%11);
+       if ($rem == 10) {
+       $rem = "X";
+       }
+       if ($rem eq substr($infl,8,1)) {
+               $valid = 1;
+       }
+       return $valid;
+} # sub checkdigit
+
+=item checkvalidisbn
+
+  $valid = &checkvalidisbn($isbn);
+
+Returns a true value iff C<$isbn> is a valid ISBN: it must be ten
+digits long (counting "X" as a digit), and must have a valid check
+digit at the end.
+
+=cut
+#'
+#--------------------------------------
+# Determine if a number is a valid ISBN number, according to length
+#   of 10 digits and valid checksum
+sub checkvalidisbn {
+        use strict;
+        my ($q)=@_ ;   # Input: ISBN number
+
+        my $isbngood = 0; # Return: true or false
+
+        $q=~s/x$/X/g;           # upshift lower case X
+        $q=~s/[^X\d]//g;
+        $q=~s/X.//g;
+        
+       #return 0 if $q is not ten digits long
+       if (length($q)!=10) {
+               return 0;
+       }
+       
+       #If we get to here, length($q) must be 10
+        my $checksum=substr($q,9,1);
+        my $isbn=substr($q,0,9);
+        my $i;
+        my $c=0;
+        for ($i=0; $i<9; $i++) {
+            my $digit=substr($q,$i,1);
+            $c+=$digit*(10-$i);
+        }
+       $c %= 11;
+        ($c==10) && ($c='X');
+        $isbngood = $c eq $checksum;
+
+        return $isbngood;
+
+} # sub checkvalidisbn
 
-sub checkdigit {
-  my ($env,$infl) =  @_;
-  $infl = uc $infl;
-  my @weightings = (8,4,6,3,5,2,1);
-  my $sum;
-  my $i = 1;
-  my $valid = 0;
-  #  print $infl."<br>";
-  while ($i <8) {
-    my $temp1 = $weightings[$i-1];
-    my $temp2 = substr($infl,$i,1);
-    $sum = $sum + ($temp1*$temp2);
-#    print "$sum $temp1 $temp2<br>";
-    $i++;
-  }
-  my $rem = ($sum%11);
-  if ($rem == 10) {
-    $rem = "X";
-  }  
-  #print $rem."<br>";
-  if ($rem eq substr($infl,8,1)) {
-    $valid = 1;
-  }
-  return $valid;
-}
 END { }       # module clean-up code here (global destructor)
-    
+
+1;
+__END__
+
+=back
+
+=head1 AUTHOR
+
+Koha Developement team <info@koha.org>
+
+=cut