C4/Input.pm

   1 package C4::Input; #assumes C4/Input
   2
   3
   4 # Copyright 2000-2002 Katipo Communications
   5 #
   6 # This file is part of Koha.
   7 #
   8 # Koha is free software; you can redistribute it and/or modify it under the
   9 # terms of the GNU General Public License as published by the Free Software
  10 # Foundation; either version 2 of the License, or (at your option) any later
  11 # version.
  12 #
  13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  15 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License along with
  18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  19 # Suite 330, Boston, MA  02111-1307 USA
  20
  21 use strict;
  22 require Exporter;
  23
  24 use vars qw($VERSION @ISA @EXPORT);
  25
  26 # set the version for version checking
  27 $VERSION = 0.01;
  28
  29 =head1 NAME
  30
  31 C4::Input - Miscellaneous sanity checks
  32
  33 =head1 SYNOPSIS
  34
  35   use C4::Input;
  36
  37 =head1 DESCRIPTION
  38
  39 This module provides functions to see whether a given library card
  40 number or ISBN is valid.
  41
  42 =head1 FUNCTIONS
  43
  44 =over 2
  45
  46 =cut
  47
  48 @ISA = qw(Exporter);
  49 @EXPORT = qw(
  50         &checkflds &checkdigit &checkvalidisbn
  51 );
  52
  53 # FIXME - This is never used.
  54 sub checkflds {
  55   my ($env,$reqflds,$data) = @_;
  56   my $numrflds = @$reqflds;
  57   my @probarr;
  58   my $i = 0;
  59   while ($i < $numrflds) {
  60     if ($data->{@$reqflds[$i]} eq "") {
  61       push(@probarr, @$reqflds[$i]);
  62     }
  63     $i++
  64   }
  65   return (\@probarr);
  66 }
  67
  68 =item checkdigit
  69
  70   $valid = &checkdigit($env, $cardnumber);
  71
  72 Takes a card number, computes its check digit, and compares it to the
  73 checkdigit at the end of C<$cardnumber>. Returns a true value iff
  74 C<$cardnumber> has a valid check digit.
  75
  76 C<$env> is ignored.
  77
  78 =cut
  79 #'
  80 sub checkdigit {
  81   my ($env,$infl) =  @_;
  82   $infl = uc $infl;
  83   my @weightings = (8,4,6,3,5,2,1);
  84   my $sum;
  85   my $i = 1;
  86   my $valid = 0;
  87   #  print $infl."<br>";
  88   # FIXME - for ($i = 1; $i < 8; $i++)
  89   # or      foreach $i (1..7)
  90   while ($i <8) {
  91     my $temp1 = $weightings[$i-1];
  92     my $temp2 = substr($infl,$i,1);
  93     $sum += $temp1 * $temp2;
  94 #    print "$sum $temp1 $temp2<br>";
  95     $i++;
  96   }
  97   my $rem = ($sum%11);
  98   if ($rem == 10) {
  99     $rem = "X";
 100   }
 101   #print $rem."<br>";
 102   if ($rem eq substr($infl,8,1)) {
 103     $valid = 1;
 104   }
 105   return $valid;
 106 } # sub checkdigit
 107
 108 =item checkvalidisbn
 109
 110   $valid = &checkvalidisbn($isbn);
 111
 112 Returns a true value iff C<$isbn> is a valid ISBN: it must be ten
 113 digits long (counting "X" as a digit), and must have a valid check
 114 digit at the end.
 115
 116 =cut
 117 #'
 118 #--------------------------------------
 119 # Determine if a number is a valid ISBN number, according to length
 120 #   of 10 digits and valid checksum
 121 sub checkvalidisbn {
 122         use strict;
 123         my ($q)=@_ ;    # Input: ISBN number
 124
 125         my $isbngood = 0; # Return: true or false
 126
 127         $q=~s/x$/X/g;           # upshift lower case X
 128         $q=~s/[^X\d]//g;
 129         $q=~s/X.//g;
 130         if (length($q)==10) {
 131             my $checksum=substr($q,9,1);
 132             my $isbn=substr($q,0,9);
 133             my $i;
 134             my $c=0;
 135             for ($i=0; $i<9; $i++) {
 136                 my $digit=substr($q,$i,1);
 137                 $c+=$digit*(10-$i);
 138             }
 139             $c=$c%11;  # % is the modulus function
 140             ($c==10) && ($c='X');
 141             # FIXME - $isbngood = $c eq $checksum;
 142             if ($c eq $checksum) {
 143                 $isbngood=1;
 144             } else {
 145                 $isbngood=0;
 146             }
 147         } else {
 148             # FIXME - Put "return 0 if $length($q) != 10" near the
 149             # top, so we don't have to indent the rest of the function
 150             # as much.
 151             $isbngood=0;
 152         } # if length good
 153
 154         return $isbngood;
 155
 156 } # sub checkvalidisbn
 157
 158 END { }       # module clean-up code here (global destructor)
 159
 160 1;
 161 __END__
 162
 163 =back
 164
 165 =head1 AUTHOR
 166
 167 Koha Developement team <info@koha.org>
 168
 169 =cut