package C4::Koha;
# Copyright 2000-2002 Katipo Communications
+# Parts Copyright 2010 Nelsonville Public Library
+# Parts copyright 2010 BibLibre
#
# This file is part of Koha.
#
# 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
+# 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; FIXME - Bug 2505
use C4::Context;
use C4::Output;
use URI::Split qw(uri_split);
use Memoize;
+use Business::ISBN;
use vars qw($VERSION @ISA @EXPORT $DEBUG);
@ISA = qw(Exporter);
@EXPORT = qw(
&slashifyDate
- &DisplayISBN
&subfield_is_koha_internal_p
&GetPrinters &GetPrinter
&GetItemTypes &getitemtypeinfo
&GetAuthorisedValueCategories
&GetKohaAuthorisedValues
&GetKohaAuthorisedValuesFromField
+ &GetKohaAuthorisedValueLib
+ &GetAuthorisedValueByCode
+ &GetKohaImageurlFromAuthorisedValues
&GetAuthValCode
&GetNormalizedUPC
&GetNormalizedISBN
&GetNormalizedEAN
&GetNormalizedOCLCNumber
+ &xml_escape
$DEBUG
);
=head1 NAME
- C4::Koha - Perl Module containing convenience functions for Koha scripts
+C4::Koha - Perl Module containing convenience functions for Koha scripts
=head1 SYNOPSIS
- use C4::Koha;
-
+use C4::Koha;
=head1 DESCRIPTION
- Koha.pm provides many functions for Koha scripts.
+Koha.pm provides many functions for Koha scripts.
=head1 FUNCTIONS
$slash_date = &slashifyDate($dash_date);
- Takes a string of the form "DD-MM-YYYY" (or anything separated by
- dashes), converts it to the form "YYYY/MM/DD", and returns the result.
+Takes a string of the form "DD-MM-YYYY" (or anything separated by
+dashes), converts it to the form "YYYY/MM/DD", and returns the result.
=cut
return ("$dateOut[2]/$dateOut[1]/$dateOut[0]");
}
-
-=head2 DisplayISBN
-
- my $string = DisplayISBN( $isbn );
-
-=cut
-
-sub DisplayISBN {
- my ($isbn) = @_;
- if (length ($isbn)<13){
- my $seg1;
- if ( substr( $isbn, 0, 1 ) <= 7 ) {
- $seg1 = substr( $isbn, 0, 1 );
- }
- elsif ( substr( $isbn, 0, 2 ) <= 94 ) {
- $seg1 = substr( $isbn, 0, 2 );
- }
- elsif ( substr( $isbn, 0, 3 ) <= 995 ) {
- $seg1 = substr( $isbn, 0, 3 );
- }
- elsif ( substr( $isbn, 0, 4 ) <= 9989 ) {
- $seg1 = substr( $isbn, 0, 4 );
- }
- else {
- $seg1 = substr( $isbn, 0, 5 );
- }
- my $x = substr( $isbn, length($seg1) );
- my $seg2;
- if ( substr( $x, 0, 2 ) <= 19 ) {
-
- # if(sTmp2 < 10) sTmp2 = "0" sTmp2;
- $seg2 = substr( $x, 0, 2 );
- }
- elsif ( substr( $x, 0, 3 ) <= 699 ) {
- $seg2 = substr( $x, 0, 3 );
- }
- elsif ( substr( $x, 0, 4 ) <= 8399 ) {
- $seg2 = substr( $x, 0, 4 );
- }
- elsif ( substr( $x, 0, 5 ) <= 89999 ) {
- $seg2 = substr( $x, 0, 5 );
- }
- elsif ( substr( $x, 0, 6 ) <= 9499999 ) {
- $seg2 = substr( $x, 0, 6 );
- }
- else {
- $seg2 = substr( $x, 0, 7 );
- }
- my $seg3 = substr( $x, length($seg2) );
- $seg3 = substr( $seg3, 0, length($seg3) - 1 );
- my $seg4 = substr( $x, -1, 1 );
- return "$seg1-$seg2-$seg3-$seg4";
- } else {
- my $seg1;
- $seg1 = substr( $isbn, 0, 3 );
- my $seg2;
- if ( substr( $isbn, 3, 1 ) <= 7 ) {
- $seg2 = substr( $isbn, 3, 1 );
- }
- elsif ( substr( $isbn, 3, 2 ) <= 94 ) {
- $seg2 = substr( $isbn, 3, 2 );
- }
- elsif ( substr( $isbn, 3, 3 ) <= 995 ) {
- $seg2 = substr( $isbn, 3, 3 );
- }
- elsif ( substr( $isbn, 3, 4 ) <= 9989 ) {
- $seg2 = substr( $isbn, 3, 4 );
- }
- else {
- $seg2 = substr( $isbn, 3, 5 );
- }
- my $x = substr( $isbn, length($seg2) +3);
- my $seg3;
- if ( substr( $x, 0, 2 ) <= 19 ) {
-
- # if(sTmp2 < 10) sTmp2 = "0" sTmp2;
- $seg3 = substr( $x, 0, 2 );
- }
- elsif ( substr( $x, 0, 3 ) <= 699 ) {
- $seg3 = substr( $x, 0, 3 );
- }
- elsif ( substr( $x, 0, 4 ) <= 8399 ) {
- $seg3 = substr( $x, 0, 4 );
- }
- elsif ( substr( $x, 0, 5 ) <= 89999 ) {
- $seg3 = substr( $x, 0, 5 );
- }
- elsif ( substr( $x, 0, 6 ) <= 9499999 ) {
- $seg3 = substr( $x, 0, 6 );
- }
- else {
- $seg3 = substr( $x, 0, 7 );
- }
- my $seg4 = substr( $x, length($seg3) );
- $seg4 = substr( $seg4, 0, length($seg4) - 1 );
- my $seg5 = substr( $x, -1, 1 );
- return "$seg1-$seg2-$seg3-$seg4-$seg5";
- }
-}
-
# FIXME.. this should be moved to a MARC-specific module
sub subfield_is_koha_internal_p ($) {
my ($subfield) = @_;
Returns a string with the name of the itemtype.
-
=cut
sub GetSupportName{
=head3 in PERL SCRIPT
-my $authtypes = getauthtypes;
-my @authtypesloop;
-foreach my $thisauthtype (keys %$authtypes) {
- my $selected = 1 if $thisauthtype eq $authtype;
- my %row =(value => $thisauthtype,
+ my $authtypes = getauthtypes;
+ my @authtypesloop;
+ foreach my $thisauthtype (keys %$authtypes) {
+ my $selected = 1 if $thisauthtype eq $authtype;
+ my %row =(value => $thisauthtype,
selected => $selected,
authtypetext => $authtypes->{$thisauthtype}->{'authtypetext'},
);
- push @authtypesloop, \%row;
-}
-$template->param(itemtypeloop => \@itemtypesloop);
+ push @authtypesloop, \%row;
+ }
+ $template->param(itemtypeloop => \@itemtypesloop);
=head3 in TEMPLATE
-<form action='<!-- TMPL_VAR name="script_name" -->' method=post>
+ <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
<select name="authtype">
<!-- TMPL_LOOP name="authtypeloop" -->
<option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="authtypetext" --></option>
</select>
<input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
<input type="submit" value="OK" class="button">
-</form>
+ </form>
=cut
=head3 in PERL SCRIPT
-my $frameworks = frameworks();
-my @frameworkloop;
-foreach my $thisframework (keys %$frameworks) {
+ my $frameworks = frameworks();
+ my @frameworkloop;
+ foreach my $thisframework (keys %$frameworks) {
my $selected = 1 if $thisframework eq $frameworkcode;
my %row =(value => $thisframework,
selected => $selected,
description => $frameworks->{$thisframework}->{'frameworktext'},
);
push @frameworksloop, \%row;
-}
-$template->param(frameworkloop => \@frameworksloop);
+ }
+ $template->param(frameworkloop => \@frameworksloop);
=head3 in TEMPLATE
-<form action='<!-- TMPL_VAR name="script_name" -->' method=post>
+ <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
<select name="frameworkcode">
<option value="">Default</option>
<!-- TMPL_LOOP name="frameworkloop" -->
</select>
<input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
<input type="submit" value="OK" class="button">
-</form>
-
+ </form>
=cut
=head2 getitemtypeimagedir
-=over
-
-=item 4
-
my $directory = getitemtypeimagedir( 'opac' );
pass in 'opac' or 'intranet'. Defaults to 'opac'.
returns the full path to the appropriate directory containing images.
-=back
-
=cut
sub getitemtypeimagedir {
=head3 _getImagesFromDirectory
- Find all of the image files in a directory in the filesystem
+Find all of the image files in a directory in the filesystem
- parameters:
- a directory name
+parameters: a directory name
- returns: a list of images in that directory.
+returns: a list of images in that directory.
- Notes: this does not traverse into subdirectories. See
- _getSubdirectoryNames for help with that.
- Images are assumed to be files with .gif or .png file extensions.
- The image names returned do not have the directory name on them.
+Notes: this does not traverse into subdirectories. See
+_getSubdirectoryNames for help with that.
+Images are assumed to be files with .gif or .png file extensions.
+The image names returned do not have the directory name on them.
=cut
if ( opendir ( my $dh, $directoryname ) ) {
my @images = grep { /\.(gif|png)$/i } readdir( $dh );
closedir $dh;
+ @images = sort(@images);
return @images;
} else {
warn "unable to opendir $directoryname: $!";
=head3 _getSubdirectoryNames
- Find all of the directories in a directory in the filesystem
+Find all of the directories in a directory in the filesystem
- parameters:
- a directory name
+parameters: a directory name
- returns: a list of subdirectories in that directory.
+returns: a list of subdirectories in that directory.
- Notes: this does not traverse into subdirectories. Only the first
- level of subdirectories are returned.
- The directory names returned don't have the parent directory name
- on them.
+Notes: this does not traverse into subdirectories. Only the first
+level of subdirectories are returned.
+The directory names returned don't have the parent directory name on them.
=cut
=head3 getImageSets
- returns: a listref of hashrefs. Each hash represents another collection of images.
- { imagesetname => 'npl', # the name of the image set (npl is the original one)
- images => listref of image hashrefs
- }
+returns: a listref of hashrefs. Each hash represents another collection of images.
+
+ { imagesetname => 'npl', # the name of the image set (npl is the original one)
+ images => listref of image hashrefs
+ }
+
+each image is represented by a hashref like this:
- each image is represented by a hashref like this:
- { KohaImage => 'npl/image.gif',
- StaffImageUrl => '/intranet-tmpl/prog/img/itemtypeimg/npl/image.gif',
- OpacImageURL => '/opac-tmpl/prog/itemtypeimg/npl/image.gif'
- checked => 0 or 1: was this the image passed to this method?
- Note: I'd like to remove this somehow.
- }
+ { KohaImage => 'npl/image.gif',
+ StaffImageUrl => '/intranet-tmpl/prog/img/itemtypeimg/npl/image.gif',
+ OpacImageURL => '/opac-tmpl/prog/itemtypeimg/npl/image.gif'
+ checked => 0 or 1: was this the image passed to this method?
+ Note: I'd like to remove this somehow.
+ }
=cut
my @imagesets = (); # list of hasrefs of image set data to pass to template
my @subdirectories = _getSubdirectoryNames( $paths->{'staff'}{'filesystem'} );
-
+warn $paths->{'staff'}{'filesystem'};
foreach my $imagesubdir ( @subdirectories ) {
+ warn $imagesubdir;
my @imagelist = (); # hashrefs of image info
my @imagenames = _getImagesFromDirectory( File::Spec->catfile( $paths->{'staff'}{'filesystem'}, $imagesubdir ) );
+ my $imagesetactive = 0;
foreach my $thisimage ( @imagenames ) {
push( @imagelist,
{ KohaImage => "$imagesubdir/$thisimage",
checked => "$imagesubdir/$thisimage" eq $checked ? 1 : 0,
}
);
+ $imagesetactive = 1 if "$imagesubdir/$thisimage" eq $checked;
}
push @imagesets, { imagesetname => $imagesubdir,
+ imagesetactive => $imagesetactive,
images => \@imagelist };
}
=head2 GetPrinter
-$printer = GetPrinter( $query, $printers );
+ $printer = GetPrinter( $query, $printers );
=cut
=head2 displayServers
-=over 4
-
-my $servers = displayServers();
-
-my $servers = displayServers( $position );
-
-my $servers = displayServers( $position, $type );
-
-=back
+ my $servers = displayServers();
+ my $servers = displayServers( $position );
+ my $servers = displayServers( $position, $type );
displayServers returns a listref of hashrefs, each containing
information about available z3950 servers. Each hashref has a format
'zed' => 1,
},
-
=cut
sub displayServers {
return \@primaryserverloop;
}
+
+=head2 GetKohaImageurlFromAuthorisedValues
+
+$authhorised_value = GetKohaImageurlFromAuthorisedValues( $category, $authvalcode );
+
+Return the first url of the authorised value image represented by $lib.
+
+=cut
+
+sub GetKohaImageurlFromAuthorisedValues {
+ my ( $category, $lib ) = @_;
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("SELECT imageurl FROM authorised_values WHERE category=? AND lib =?");
+ $sth->execute( $category, $lib );
+ while ( my $data = $sth->fetchrow_hashref ) {
+ return $data->{'imageurl'};
+ }
+}
+
=head2 GetAuthValCode
-$authvalcode = GetAuthValCode($kohafield,$frameworkcode);
+ $authvalcode = GetAuthValCode($kohafield,$frameworkcode);
=cut
=head2 GetAuthValCodeFromField
-$authvalcode = GetAuthValCodeFromField($field,$subfield,$frameworkcode);
+ $authvalcode = GetAuthValCodeFromField($field,$subfield,$frameworkcode);
C<$subfield> can be undefined
=head2 GetAuthorisedValues
-$authvalues = GetAuthorisedValues([$category], [$selected]);
+ $authvalues = GetAuthorisedValues([$category], [$selected]);
This function returns all authorised values from the'authorised_value' table in a reference to array of hashrefs.
my $sth = $dbh->prepare($query);
$sth->execute;
while (my $data=$sth->fetchrow_hashref) {
- if ($selected eq $data->{'authorised_value'} ) {
+ if ($selected && $selected eq $data->{'authorised_value'} ) {
$data->{'selected'} = 1;
}
if ($opac && $data->{'lib_opac'}) {
=head2 GetAuthorisedValueCategories
-$auth_categories = GetAuthorisedValueCategories();
+ $auth_categories = GetAuthorisedValueCategories();
Return an arrayref of all of the available authorised
value categories.
my $sth = $dbh->prepare("SELECT DISTINCT category FROM authorised_values ORDER BY category");
$sth->execute;
my @results;
- while (my $category = $sth->fetchrow_array) {
+ while (defined (my $category = $sth->fetchrow_array) ) {
push @results, $category;
}
return \@results;
}
+=head2 GetAuthorisedValueByCode
+
+$authhorised_value = GetAuthorisedValueByCode( $category, $authvalcode );
+
+Return the lib attribute from authorised_values from the row identified
+by the passed category and code
+
+=cut
+
+sub GetAuthorisedValueByCode {
+ my ( $category, $authvalcode ) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("SELECT lib FROM authorised_values WHERE category=? AND authorised_value =?");
+ $sth->execute( $category, $authvalcode );
+ while ( my $data = $sth->fetchrow_hashref ) {
+ return $data->{'lib'};
+ }
+}
+
=head2 GetKohaAuthorisedValues
-
- Takes $kohafield, $fwcode as parameters.
- If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
- Returns hashref of Code => description
- Returns undef
- if no authorised value category is defined for the kohafield.
+
+Takes $kohafield, $fwcode as parameters.
+
+If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
+
+Returns hashref of Code => description
+
+Returns undef if no authorised value category is defined for the kohafield.
=cut
}
=head2 GetKohaAuthorisedValuesFromField
-
- Takes $field, $subfield $fwcode as parameters.
- If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
- $subfield can be undefined
- Returns hashref of Code => description
- Returns undef
- if no authorised value category is defined for the given field and subfield
+
+Takes $field, $subfield, $fwcode as parameters.
+
+If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
+$subfield can be undefined
+
+Returns hashref of Code => description
+
+Returns undef if no authorised value category is defined for the given field and subfield
=cut
}
}
-=head2 display_marc_indicators
+=head2 xml_escape
+
+ my $escaped_string = C4::Koha::xml_escape($string);
+
+Convert &, <, >, ', and " in a string to XML entities
+
+=cut
-=over 4
+sub xml_escape {
+ my $str = shift;
+ return '' unless defined $str;
+ $str =~ s/&/&/g;
+ $str =~ s/</</g;
+ $str =~ s/>/>/g;
+ $str =~ s/'/'/g;
+ $str =~ s/"/"/g;
+ return $str;
+}
+
+=head2 GetKohaAuthorisedValueLib
+
+Takes $category, $authorised_value as parameters.
+
+If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
-# field is a MARC::Field object
-my $display_form = C4::Koha::display_marc_indicators($field);
+Returns authorised value description
-=back
+=cut
+
+sub GetKohaAuthorisedValueLib {
+ my ($category,$authorised_value,$opac) = @_;
+ my $value;
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("select lib, lib_opac from authorised_values where category=? and authorised_value=?");
+ $sth->execute($category,$authorised_value);
+ my $data = $sth->fetchrow_hashref;
+ $value = ($opac && $$data{'lib_opac'}) ? $$data{'lib_opac'} : $$data{'lib'};
+ return $value;
+}
+
+=head2 display_marc_indicators
+
+ my $display_form = C4::Koha::display_marc_indicators($field);
+
+C<$field> is a MARC::Field object
Generate a display form of the indicators of a variable
MARC field, replacing any blanks with '#'.
my ($record,$marcflavour) = @_;
my (@fields,$upc);
- if ($marcflavour eq 'MARC21') {
- @fields = $record->field('024');
+ if ($marcflavour eq 'UNIMARC') {
+ @fields = $record->field('072');
foreach my $field (@fields) {
- my $indicator = $field->indicator(1);
my $upc = _normalize_match_point($field->subfield('a'));
- if ($indicator == 1 and $upc ne '') {
+ if ($upc ne '') {
return $upc;
}
}
+
}
- else { # assume unimarc if not marc21
- @fields = $record->field('072');
+ else { # assume marc21 if not unimarc
+ @fields = $record->field('024');
foreach my $field (@fields) {
+ my $indicator = $field->indicator(1);
my $upc = _normalize_match_point($field->subfield('a'));
- if ($upc ne '') {
+ if ($indicator == 1 and $upc ne '') {
return $upc;
}
}
}
# Normalizes and returns the first valid ISBN found in the record
+# ISBN13 are converted into ISBN10. This is required to get Amazon cover book.
sub GetNormalizedISBN {
my ($isbn,$record,$marcflavour) = @_;
my @fields;
if ($isbn) {
+ # Koha attempts to store multiple ISBNs in biblioitems.isbn, separated by " | "
+ # anything after " | " should be removed, along with the delimiter
+ $isbn =~ s/(.*)( \| )(.*)/$1/;
return _isbn_cleanup($isbn);
}
return undef unless $record;
- if ($marcflavour eq 'MARC21') {
- @fields = $record->field('020');
+ if ($marcflavour eq 'UNIMARC') {
+ @fields = $record->field('010');
foreach my $field (@fields) {
- $isbn = $field->subfield('a');
+ my $isbn = $field->subfield('a');
if ($isbn) {
return _isbn_cleanup($isbn);
} else {
}
}
}
- else { # assume unimarc if not marc21
- @fields = $record->field('010');
+ else { # assume marc21 if not unimarc
+ @fields = $record->field('020');
foreach my $field (@fields) {
- my $isbn = $field->subfield('a');
+ $isbn = $field->subfield('a');
if ($isbn) {
return _isbn_cleanup($isbn);
} else {
}
}
}
-
}
sub GetNormalizedEAN {
my ($record,$marcflavour) = @_;
my (@fields,$ean);
- if ($marcflavour eq 'MARC21') {
- @fields = $record->field('024');
+ if ($marcflavour eq 'UNIMARC') {
+ @fields = $record->field('073');
foreach my $field (@fields) {
- my $indicator = $field->indicator(1);
$ean = _normalize_match_point($field->subfield('a'));
- if ($indicator == 3 and $ean ne '') {
+ if ($ean ne '') {
return $ean;
}
}
}
- else { # assume unimarc if not marc21
- @fields = $record->field('073');
+ else { # assume marc21 if not unimarc
+ @fields = $record->field('024');
foreach my $field (@fields) {
+ my $indicator = $field->indicator(1);
$ean = _normalize_match_point($field->subfield('a'));
- if ($ean ne '') {
+ if ($indicator == 3 and $ean ne '') {
return $ean;
}
}
my ($record,$marcflavour) = @_;
my (@fields,$oclc);
- if ($marcflavour eq 'MARC21') {
+ if ($marcflavour eq 'UNIMARC') {
+ # TODO: add UNIMARC fields
+ }
+ else { # assume marc21 if not unimarc
@fields = $record->field('035');
foreach my $field (@fields) {
$oclc = $field->subfield('a');
}
}
}
- else { # TODO: add UNIMARC fields
- }
}
sub _normalize_match_point {
return $normalized_match_point;
}
-sub _isbn_cleanup ($) {
- my $normalized_isbn = shift;
- $normalized_isbn =~ s/-//g;
- $normalized_isbn =~/([0-9x]{1,})/i;
- $normalized_isbn = $1;
- if (
- $normalized_isbn =~ /\b(\d{13})\b/ or
- $normalized_isbn =~ /\b(\d{12})\b/i or
- $normalized_isbn =~ /\b(\d{10})\b/ or
- $normalized_isbn =~ /\b(\d{9}X)\b/i
- ) {
- return $1;
+sub _isbn_cleanup {
+ my $isbn = Business::ISBN->new( $_[0] );
+ if ( $isbn ) {
+ $isbn = $isbn->as_isbn10 if $isbn->type eq 'ISBN13';
+ if (defined $isbn) {
+ return $isbn->as_string([]);
+ }
}
- return undef;
+ return;
}
1;
projects / koha.git / blobdiff