X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FKoha.pm;h=05e3074e72c8d608758a27ed623087db375a849e;hb=3c3dcf8fd9d440be560eb1b6025c0a129e7c5473;hp=0792a572de151e29724a6f90d1c9e976e288d337;hpb=6abda1a9184916868f51239f9164e57e321d78dd;p=koha.git diff --git a/C4/Koha.pm b/C4/Koha.pm index 0792a572de..05e3074e72 100644 --- a/C4/Koha.pm +++ b/C4/Koha.pm @@ -17,19 +17,58 @@ package C4::Koha; # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, # Suite 330, Boston, MA 02111-1307 USA -# $Id$ use strict; -require Exporter; use C4::Context; +use C4::Output; +use URI::Split qw(uri_split); +use Memoize; + +use vars qw($VERSION @ISA @EXPORT $DEBUG); + +BEGIN { + $VERSION = 3.01; + require Exporter; + @ISA = qw(Exporter); + @EXPORT = qw( + &slashifyDate + &DisplayISBN + &subfield_is_koha_internal_p + &GetPrinters &GetPrinter + &GetItemTypes &getitemtypeinfo + &GetCcodes + &get_itemtypeinfos_of + &getframeworks &getframeworkinfo + &getauthtypes &getauthtype + &getallthemes + &getFacets + &displayServers + &getnbpages + &get_infos_of + &get_notforloan_label_of + &getitemtypeimagedir + &getitemtypeimagesrc + &getitemtypeimagelocation + &GetAuthorisedValues + &GetAuthorisedValueCategories + &GetKohaAuthorisedValues + &GetAuthValCode + &GetNormalizedUPC + &GetNormalizedISBN + &GetNormalizedEAN + &GetNormalizedOCLCNumber + + $DEBUG + ); + $DEBUG = 0; +} -use vars qw($VERSION @ISA @EXPORT); - -$VERSION = do { my @v = '$Revision$' =~ /\d+/g; shift(@v) . "." . join("_", map {sprintf "%03d", $_ } @v); }; +# expensive functions +memoize('GetAuthorisedValues'); =head1 NAME -C4::Koha - Perl Module containing convenience functions for Koha scripts + C4::Koha - Perl Module containing convenience functions for Koha scripts =head1 SYNOPSIS @@ -38,251 +77,138 @@ C4::Koha - Perl Module containing convenience functions for Koha scripts =head1 DESCRIPTION -Koha.pm provides many functions for Koha scripts. + Koha.pm provides many functions for Koha scripts. =head1 FUNCTIONS -=over 2 - =cut -@ISA = qw(Exporter); -@EXPORT = qw( - &subfield_is_koha_internal_p - &GetBranches &getbranch &getbranchdetail - &getprinters &getprinter - &GetItemTypes &getitemtypeinfo - get_itemtypeinfos_of - &getframeworks &getframeworkinfo - &getauthtypes &getauthtype - &getallthemes &getalllanguages - &getallbranches &getletters - &getbranchname - getnbpages - getitemtypeimagedir - getitemtypeimagesrc - getitemtypeimagesrcfromurl - &getcities - &getroadtypes - get_branchinfos_of - get_notforloan_label_of - get_infos_of - $DEBUG); - -use vars qw(); - -my $DEBUG = 0; - -# FIXME.. this should be moved to a MARC-specific module -sub subfield_is_koha_internal_p ($) { - my($subfield) = @_; - - # We could match on 'lib' and 'tab' (and 'mandatory', & more to come!) - # But real MARC subfields are always single-character - # so it really is safer just to check the length +=head2 slashifyDate - return length $subfield != 1; -} + $slash_date = &slashifyDate($dash_date); -=head2 GetBranches - - $branches = &GetBranches(); - returns informations about branches. - Create a branch selector with the following code - Is branchIndependant sensitive - When IndependantBranches is set AND user is not superlibrarian, displays only user's branch - -=head3 in PERL SCRIPT - -my $branches = GetBranches; -my @branchloop; -foreach my $thisbranch (sort keys %$branches) { - my $selected = 1 if $thisbranch eq $branch; - my %row =(value => $thisbranch, - selected => $selected, - branchname => $branches->{$thisbranch}->{'branchname'}, - ); - push @branchloop, \%row; -} - - -=head3 in TEMPLATE - + 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 -sub GetBranches { -# returns a reference to a hash of references to branches... - my ($type) = @_; - my %branches; - my $branch; - my $dbh = C4::Context->dbh; - my $sth; - if (C4::Context->preference("IndependantBranches") && (C4::Context->userenv->{flags}!=1)){ - my $strsth ="Select * from branches "; - $strsth.= " WHERE branchcode = ".$dbh->quote(C4::Context->userenv->{branch}); - $strsth.= " order by branchname"; - $sth=$dbh->prepare($strsth); - } else { - $sth = $dbh->prepare("Select * from branches order by branchname"); - } - $sth->execute; - while ($branch=$sth->fetchrow_hashref) { - my $nsth = $dbh->prepare("select categorycode from branchrelations where branchcode = ?"); - if ($type){ - $nsth = $dbh->prepare("select categorycode from branchrelations where branchcode = ? and categorycode = ?"); - $nsth->execute($branch->{'branchcode'},$type); - } else { - $nsth->execute($branch->{'branchcode'}); - } - while (my ($cat) = $nsth->fetchrow_array) { - # FIXME - This seems wrong. It ought to be - # $branch->{categorycodes}{$cat} = 1; - # otherwise, there's a namespace collision if there's a - # category with the same name as a field in the 'branches' - # table (i.e., don't create a category called "issuing"). - # In addition, the current structure doesn't really allow - # you to list the categories that a branch belongs to: - # you'd have to list keys %$branch, and remove those keys - # that aren't fields in the "branches" table. - $branch->{$cat} = 1; - } - if ($type) { - $branches{$branch->{'branchcode'}}=$branch; - } - } - if (!$type){ - $branches{$branch->{'branchcode'}}=$branch; - } - - return (\%branches); -} +sub slashifyDate { -sub getbranchname { - my ($branchcode)=@_; - my $dbh = C4::Context->dbh; - my $sth; - $sth = $dbh->prepare("Select branchname from branches where branchcode=?"); - $sth->execute($branchcode); - my $branchname = $sth->fetchrow_array; - $sth->finish; - - return($branchname); + # accepts a date of the form xx-xx-xx[xx] and returns it in the + # form xx/xx/xx[xx] + my @dateOut = split( '-', shift ); + return ("$dateOut[2]/$dateOut[1]/$dateOut[0]"); } -=head2 getallbranches - $branches = &getallbranches(); - returns informations about ALL branches. - Create a branch selector with the following code - IndependantBranches Insensitive... - -=head3 in PERL SCRIPT - -my $branches = getallbranches; -my @branchloop; -foreach my $thisbranch (keys %$branches) { - my $selected = 1 if $thisbranch eq $branch; - my %row =(value => $thisbranch, - selected => $selected, - branchname => $branches->{$thisbranch}->{'branchname'}, - ); - push @branchloop, \%row; -} +=head2 DisplayISBN - -=head3 in TEMPLATE - + my $string = DisplayISBN( $isbn ); =cut - -sub getallbranches { -# returns a reference to a hash of references to ALL branches... - my %branches; - my $dbh = C4::Context->dbh; - my $sth; - $sth = $dbh->prepare("Select * from branches order by branchname"); - $sth->execute; - while (my $branch=$sth->fetchrow_hashref) { - my $nsth = $dbh->prepare("select categorycode from branchrelations where branchcode = ?"); - $nsth->execute($branch->{'branchcode'}); - while (my ($cat) = $nsth->fetchrow_array) { - # FIXME - This seems wrong. It ought to be - # $branch->{categorycodes}{$cat} = 1; - # otherwise, there's a namespace collision if there's a - # category with the same name as a field in the 'branches' - # table (i.e., don't create a category called "issuing"). - # In addition, the current structure doesn't really allow - # you to list the categories that a branch belongs to: - # you'd have to list keys %$branch, and remove those keys - # that aren't fields in the "branches" table. - $branch->{$cat} = 1; - } - $branches{$branch->{'branchcode'}}=$branch; +sub DisplayISBN { + my ($isbn) = @_; + if (length ($isbn)<13){ + my $seg1; + if ( substr( $isbn, 0, 1 ) <= 7 ) { + $seg1 = substr( $isbn, 0, 1 ); } - return (\%branches); -} - -=head2 getletters + 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 ) { - $letters = &getletters($category); - returns informations about letters. - if needed, $category filters for letters given category - Create a letter selector with the following code + # 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 ) { -=head3 in PERL SCRIPT - -my $letters = getletters($cat); -my @letterloop; -foreach my $thisletter (keys %$letters) { - my $selected = 1 if $thisletter eq $letter; - my %row =(value => $thisletter, - selected => $selected, - lettername => $letters->{$thisletter}, - ); - push @letterloop, \%row; + # 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) = @_; -=head3 in TEMPLATE - - -=cut + # We could match on 'lib' and 'tab' (and 'mandatory', & more to come!) + # But real MARC subfields are always single-character + # so it really is safer just to check the length -sub getletters { -# returns a reference to a hash of references to ALL letters... - my $cat =@_; - my %letters; - my $dbh = C4::Context->dbh; - my $sth; - if ($cat ne ""){ - $sth = $dbh->prepare("Select * from letter where module = \'".$cat."\' order by name"); - } else { - $sth = $dbh->prepare("Select * from letter order by name"); - } - $sth->execute; - my $count; - while (my $letter=$sth->fetchrow_hashref) { - $letters{$letter->{'code'}}=$letter->{'name'}; - $count++; - } - return ($count,\%letters); + return length $subfield != 1; } =head2 GetItemTypes @@ -295,63 +221,85 @@ build a HTML select with the following code : =head3 in PERL SCRIPT -my $itemtypes = GetItemTypes; -my @itemtypesloop; -foreach my $thisitemtype (sort keys %$itemtypes) { - my $selected = 1 if $thisitemtype eq $itemtype; - my %row =(value => $thisitemtype, - selected => $selected, - description => $itemtypes->{$thisitemtype}->{'description'}, - ); - push @itemtypesloop, \%row; -} -$template->param(itemtypeloop => \@itemtypesloop); + my $itemtypes = GetItemTypes; + my @itemtypesloop; + foreach my $thisitemtype (sort keys %$itemtypes) { + my $selected = 1 if $thisitemtype eq $itemtype; + my %row =(value => $thisitemtype, + selected => $selected, + description => $itemtypes->{$thisitemtype}->{'description'}, + ); + push @itemtypesloop, \%row; + } + $template->param(itemtypeloop => \@itemtypesloop); =head3 in TEMPLATE -
- - "> - -
- +
+ + "> + +
=cut sub GetItemTypes { -# returns a reference to a hash of references to branches... + + # returns a reference to a hash of references to itemtypes... my %itemtypes; - my $dbh = C4::Context->dbh; + my $dbh = C4::Context->dbh; my $query = qq| SELECT * FROM itemtypes |; - my $sth=$dbh->prepare($query); + my $sth = $dbh->prepare($query); $sth->execute; - while (my $IT=$sth->fetchrow_hashref) { - $itemtypes{$IT->{'itemtype'}}=$IT; + while ( my $IT = $sth->fetchrow_hashref ) { + $itemtypes{ $IT->{'itemtype'} } = $IT; } - return (\%itemtypes); + return ( \%itemtypes ); } -# FIXME this function is better and should replace GetItemTypes everywhere sub get_itemtypeinfos_of { my @itemtypes = @_; - my $query = ' + my $placeholders = join( ', ', map { '?' } @itemtypes ); + my $query = <<"END_SQL"; SELECT itemtype, description, + imageurl, notforloan FROM itemtypes - WHERE itemtype IN ('.join(',', map({"'".$_."'"} @itemtypes)).') -'; + WHERE itemtype IN ( $placeholders ) +END_SQL - return get_infos_of($query, 'itemtype'); + return get_infos_of( $query, 'itemtype', undef, \@itemtypes ); +} + +# this is temporary until we separate collection codes and item types +sub GetCcodes { + my $count = 0; + my @results; + my $dbh = C4::Context->dbh; + my $sth = + $dbh->prepare( + "SELECT * FROM authorised_values ORDER BY authorised_value"); + $sth->execute; + while ( my $data = $sth->fetchrow_hashref ) { + if ( $data->{category} eq "CCODE" ) { + $count++; + $results[$count] = $data; + + #warn "data: $data"; + } + } + $sth->finish; + return ( $count, @results ); } =head2 getauthtypes @@ -392,25 +340,27 @@ $template->param(itemtypeloop => \@itemtypesloop); =cut sub getauthtypes { -# returns a reference to a hash of references to authtypes... + + # returns a reference to a hash of references to authtypes... my %authtypes; my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from auth_types order by authtypetext"); + my $sth = $dbh->prepare("select * from auth_types order by authtypetext"); $sth->execute; - while (my $IT=$sth->fetchrow_hashref) { - $authtypes{$IT->{'authtypecode'}}=$IT; + while ( my $IT = $sth->fetchrow_hashref ) { + $authtypes{ $IT->{'authtypecode'} } = $IT; } - return (\%authtypes); + return ( \%authtypes ); } sub getauthtype { my ($authtypecode) = @_; -# returns a reference to a hash of references to authtypes... + + # returns a reference to a hash of references to authtypes... my %authtypes; my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from auth_types where authtypecode=?"); + my $sth = $dbh->prepare("select * from auth_types where authtypecode=?"); $sth->execute($authtypecode); - my $res=$sth->fetchrow_hashref; + my $res = $sth->fetchrow_hashref; return $res; } @@ -453,16 +403,18 @@ $template->param(frameworkloop => \@frameworksloop); =cut sub getframeworks { -# returns a reference to a hash of references to branches... + + # returns a reference to a hash of references to branches... my %itemtypes; my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from biblio_framework"); + my $sth = $dbh->prepare("select * from biblio_framework"); $sth->execute; - while (my $IT=$sth->fetchrow_hashref) { - $itemtypes{$IT->{'frameworkcode'}}=$IT; + while ( my $IT = $sth->fetchrow_hashref ) { + $itemtypes{ $IT->{'frameworkcode'} } = $IT; } - return (\%itemtypes); + return ( \%itemtypes ); } + =head2 getframeworkinfo $frameworkinfo = &getframeworkinfo($frameworkcode); @@ -473,14 +425,14 @@ Returns information about an frameworkcode. sub getframeworkinfo { my ($frameworkcode) = @_; - my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from biblio_framework where frameworkcode=?"); + my $dbh = C4::Context->dbh; + my $sth = + $dbh->prepare("select * from biblio_framework where frameworkcode=?"); $sth->execute($frameworkcode); my $res = $sth->fetchrow_hashref; return $res; } - =head2 getitemtypeinfo $itemtype = &getitemtype($itemtype); @@ -491,251 +443,215 @@ Returns information about an itemtype. sub getitemtypeinfo { my ($itemtype) = @_; - my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from itemtypes where itemtype=?"); + my $dbh = C4::Context->dbh; + my $sth = $dbh->prepare("select * from itemtypes where itemtype=?"); $sth->execute($itemtype); my $res = $sth->fetchrow_hashref; - $res->{imageurl} = getitemtypeimagesrcfromurl($res->{imageurl}); + $res->{imageurl} = getitemtypeimagelocation( 'intranet', $res->{imageurl} ); return $res; } -sub getitemtypeimagesrcfromurl { - my ($imageurl) = @_; +=head2 getitemtypeimagedir - if (defined $imageurl and $imageurl !~ m/^http/) { - $imageurl = - getitemtypeimagesrc() - .'/'.$imageurl - ; - } +=over - return $imageurl; -} +=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 { - return - C4::Context->intrahtdocs - .'/'.C4::Context->preference('template') - .'/itemtypeimg' - ; + my $src = shift || 'opac'; + if ($src eq 'intranet') { + return C4::Context->config('intrahtdocs') . '/' .C4::Context->preference('template') . '/img/itemtypeimg'; + } else { + return C4::Context->config('opachtdocs') . '/' . C4::Context->preference('template') . '/itemtypeimg'; + } } sub getitemtypeimagesrc { - return - '/intranet-tmpl' - .'/'.C4::Context->preference('template') - .'/itemtypeimg' - ; + my $src = shift || 'opac'; + if ($src eq 'intranet') { + return '/intranet-tmpl' . '/' . C4::Context->preference('template') . '/img/itemtypeimg'; + } else { + return '/opac-tmpl' . '/' . C4::Context->preference('template') . '/itemtypeimg'; + } } -=head2 getprinters +sub getitemtypeimagelocation($$) { + my ( $src, $image ) = @_; - $printers = &getprinters($env); - @queues = keys %$printers; + return '' if ( !$image ); -Returns information about existing printer queues. + my $scheme = ( uri_split( $image ) )[0]; -C<$env> is ignored. + return $image if ( $scheme ); -C<$printers> is a reference-to-hash whose keys are the print queues -defined in the printers table of the Koha database. The values are -references-to-hash, whose keys are the fields in the printers table. + return getitemtypeimagesrc( $src ) . '/' . $image; +} + +=head3 _getImagesFromDirectory + + Find all of the image files in a directory in the filesystem + + parameters: + a directory name + + 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. =cut -sub getprinters { - my ($env) = @_; - my %printers; - my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("select * from printers"); - $sth->execute; - while (my $printer=$sth->fetchrow_hashref) { - $printers{$printer->{'printqueue'}}=$printer; +sub _getImagesFromDirectory { + my $directoryname = shift; + return unless defined $directoryname; + return unless -d $directoryname; + + if ( opendir ( my $dh, $directoryname ) ) { + my @images = grep { /\.(gif|png)$/i } readdir( $dh ); + closedir $dh; + return @images; + } else { + warn "unable to opendir $directoryname: $!"; + return; } - return (\%printers); } -sub getbranch ($$) { - my($query, $branches) = @_; # get branch for this query from branches - my $branch = $query->param('branch'); - ($branch) || ($branch = $query->cookie('branch')); - ($branches->{$branch}) || ($branch=(keys %$branches)[0]); - return $branch; -} +=head3 _getSubdirectoryNames -=item getbranchdetail + Find all of the directories in a directory in the filesystem - $branchname = &getbranchdetail($branchcode); + parameters: + a directory name -Given the branch code, the function returns the corresponding -branch name for a comprehensive information display + returns: a list of subdirectories in that directory. -=cut + 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. -sub getbranchdetail -{ - my ($branchcode) = @_; - my $dbh = C4::Context->dbh; - my $sth = $dbh->prepare("SELECT * FROM branches WHERE branchcode = ?"); - $sth->execute($branchcode); - my $branchname = $sth->fetchrow_hashref(); - $sth->finish(); - return $branchname; -} # sub getbranchname +=cut +sub _getSubdirectoryNames { + my $directoryname = shift; + return unless defined $directoryname; + return unless -d $directoryname; -sub getprinter ($$) { - my($query, $printers) = @_; # get printer for this query from printers - my $printer = $query->param('printer'); - ($printer) || ($printer = $query->cookie('printer')) || ($printer=''); - ($printers->{$printer}) || ($printer = (keys %$printers)[0]); - return $printer; + if ( opendir ( my $dh, $directoryname ) ) { + my @directories = grep { -d File::Spec->catfile( $directoryname, $_ ) && ! ( /^\./ ) } readdir( $dh ); + closedir $dh; + return @directories; + } else { + warn "unable to opendir $directoryname: $!"; + return; + } } -=item getalllanguages +=head3 getImageSets - (@languages) = &getalllanguages($type); - (@languages) = &getalllanguages($type,$theme); + 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 an array of all available languages. + 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. + } =cut -sub getalllanguages { - my $type=shift; - my $theme=shift; - my $htdocs; - my @languages; - if ($type eq 'opac') { - $htdocs=C4::Context->config('opachtdocs'); - if ($theme and -d "$htdocs/$theme") { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - push @languages, $language; - } - return sort @languages; - } else { - my $lang; - foreach my $theme (getallthemes('opac')) { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - $lang->{$language}=1; - } - } - @languages=keys %$lang; - return sort @languages; - } - } elsif ($type eq 'intranet') { - $htdocs=C4::Context->config('intrahtdocs'); - if ($theme and -d "$htdocs/$theme") { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - push @languages, $language; - } - return sort @languages; - } else { - my $lang; - foreach my $theme (getallthemes('opac')) { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - $lang->{$language}=1; - } - } - @languages=keys %$lang; - return sort @languages; +sub getImageSets { + my %params = @_; + my $checked = $params{'checked'} || ''; + + my $paths = { staff => { filesystem => getitemtypeimagedir('intranet'), + url => getitemtypeimagesrc('intranet'), + }, + opac => { filesystem => getitemtypeimagedir('opac'), + url => getitemtypeimagesrc('opac'), + } + }; + + my @imagesets = (); # list of hasrefs of image set data to pass to template + my @subdirectories = _getSubdirectoryNames( $paths->{'staff'}{'filesystem'} ); + + foreach my $imagesubdir ( @subdirectories ) { + my @imagelist = (); # hashrefs of image info + my @imagenames = _getImagesFromDirectory( File::Spec->catfile( $paths->{'staff'}{'filesystem'}, $imagesubdir ) ); + foreach my $thisimage ( @imagenames ) { + push( @imagelist, + { KohaImage => "$imagesubdir/$thisimage", + StaffImageUrl => join( '/', $paths->{'staff'}{'url'}, $imagesubdir, $thisimage ), + OpacImageUrl => join( '/', $paths->{'opac'}{'url'}, $imagesubdir, $thisimage ), + checked => "$imagesubdir/$thisimage" eq $checked ? 1 : 0, + } + ); } - } else { - my $lang; - my $htdocs=C4::Context->config('intrahtdocs'); - foreach my $theme (getallthemes('intranet')) { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - $lang->{$language}=1; - } - } - $htdocs=C4::Context->config('opachtdocs'); - foreach my $theme (getallthemes('opac')) { - opendir D, "$htdocs/$theme"; - foreach my $language (readdir D) { - next if $language=~/^\./; - next if $language eq 'all'; - next if $language=~ /png$/; - next if $language=~ /css$/; - next if $language=~ /CVS$/; - next if $language=~ /itemtypeimg$/; - next if $language=~ /\.txt$/i; #Don't read the readme.txt ! - $lang->{$language}=1; - } - } - @languages=keys %$lang; - return sort @languages; + push @imagesets, { imagesetname => $imagesubdir, + images => \@imagelist }; + } + return \@imagesets; } -=item getallthemes +=head2 GetPrinters - (@themes) = &getallthemes('opac'); - (@themes) = &getallthemes('intranet'); + $printers = &GetPrinters(); + @queues = keys %$printers; -Returns an array of all available themes. +Returns information about existing printer queues. + +C<$printers> is a reference-to-hash whose keys are the print queues +defined in the printers table of the Koha database. The values are +references-to-hash, whose keys are the fields in the printers table. =cut -sub getallthemes { - my $type=shift; - my $htdocs; - my @themes; - if ($type eq 'intranet') { - $htdocs=C4::Context->config('intrahtdocs'); - } else { - $htdocs=C4::Context->config('opachtdocs'); - } - opendir D, "$htdocs"; - my @dirlist=readdir D; - foreach my $directory (@dirlist) { - -d "$htdocs/$directory/en" and push @themes, $directory; +sub GetPrinters { + my %printers; + my $dbh = C4::Context->dbh; + my $sth = $dbh->prepare("select * from printers"); + $sth->execute; + while ( my $printer = $sth->fetchrow_hashref ) { + $printers{ $printer->{'printqueue'} } = $printer; } - return @themes; + return ( \%printers ); +} + +=head2 GetPrinter + +$printer = GetPrinter( $query, $printers ); + +=cut + +sub GetPrinter ($$) { + my ( $query, $printers ) = @_; # get printer for this query from printers + my $printer = $query->param('printer'); + my %cookie = $query->cookie('userenv'); + ($printer) || ( $printer = $cookie{'printer'} ) || ( $printer = '' ); + ( $printers->{$printer} ) || ( $printer = ( keys %$printers )[0] ); + return $printer; } -=item getnbpages +=head2 getnbpages Returns the number of pages to display in a pagination bar, given the number of items and the number of items per page. @@ -743,109 +659,185 @@ of items and the number of items per page. =cut sub getnbpages { - my ($nb_items, $nb_items_per_page) = @_; + my ( $nb_items, $nb_items_per_page ) = @_; - return int(($nb_items - 1) / $nb_items_per_page) + 1; + return int( ( $nb_items - 1 ) / $nb_items_per_page ) + 1; } +=head2 getallthemes -=head2 getcities (OUEST-PROVENCE) - - ($id_cityarrayref, $city_hashref) = &getcities(); + (@themes) = &getallthemes('opac'); + (@themes) = &getallthemes('intranet'); -Looks up the different city and zip in the database. Returns two -elements: a reference-to-array, which lists the zip city -codes, and a reference-to-hash, which maps the name of the city. -WHERE =>OUEST PROVENCE OR EXTERIEUR +Returns an array of all available themes. =cut -sub getcities { - #my ($type_city) = @_; - my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("Select cityid,city_name from cities order by cityid "); - #$sth->execute($type_city); - $sth->execute(); - my %city; - my @id; -# insert empty value to create a empty choice in cgi popup - -while (my $data=$sth->fetchrow_hashref){ - - push @id,$data->{'cityid'}; - $city{$data->{'cityid'}}=$data->{'city_name'}; - } - - #test to know if the table contain some records if no the function return nothing - my $id=@id; - $sth->finish; - if ($id eq 0) - { - return(); + +sub getallthemes { + my $type = shift; + my $htdocs; + my @themes; + if ( $type eq 'intranet' ) { + $htdocs = C4::Context->config('intrahtdocs'); } - else{ - unshift (@id ,""); - return(\@id,\%city); + else { + $htdocs = C4::Context->config('opachtdocs'); } + opendir D, "$htdocs"; + my @dirlist = readdir D; + foreach my $directory (@dirlist) { + -d "$htdocs/$directory/en" and push @themes, $directory; + } + return @themes; } - -=head2 getroadtypes (OUEST-PROVENCE) - - ($idroadtypearrayref, $roadttype_hashref) = &getroadtypes(); - -Looks up the different road type . Returns two -elements: a reference-to-array, which lists the id_roadtype -codes, and a reference-to-hash, which maps the road type of the road . - - -=cut -sub getroadtypes { - my $dbh = C4::Context->dbh; - my $sth=$dbh->prepare("Select roadtypeid,road_type from roadtype order by road_type "); - $sth->execute(); - my %roadtype; - my @id; -# insert empty value to create a empty choice in cgi popup -while (my $data=$sth->fetchrow_hashref){ - push @id,$data->{'roadtypeid'}; - $roadtype{$data->{'roadtypeid'}}=$data->{'road_type'}; - } - #test to know if the table contain some records if no the function return nothing - my $id=@id; - $sth->finish; - if ($id eq 0) - { - return(); +sub getFacets { + my $facets; + if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) { + $facets = [ + { + link_value => 'su-to', + label_value => 'Topics', + tags => + [ '600', '601', '602', '603', '604', '605', '606', '610' ], + subfield => 'a', + }, + { + link_value => 'su-geo', + label_value => 'Places', + tags => ['651'], + subfield => 'a', + }, + { + link_value => 'su-ut', + label_value => 'Titles', + tags => [ '500', '501', '502', '503', '504', ], + subfield => 'a', + }, + { + link_value => 'au', + label_value => 'Authors', + tags => [ '700', '701', '702', ], + subfield => 'a', + }, + { + link_value => 'se', + label_value => 'Series', + tags => ['225'], + subfield => 'a', + }, + ]; + + my $library_facet; + + $library_facet = { + link_value => 'branch', + label_value => 'Libraries', + tags => [ '995', ], + subfield => 'b', + expanded => '1', + }; + push @$facets, $library_facet unless C4::Context->preference("singleBranchMode"); } - else{ - unshift (@id ,""); - return(\@id,\%roadtype); + else { + $facets = [ + { + link_value => 'su-to', + label_value => 'Topics', + tags => ['650'], + subfield => 'a', + }, + + # { + # link_value => 'su-na', + # label_value => 'People and Organizations', + # tags => ['600', '610', '611'], + # subfield => 'a', + # }, + { + link_value => 'su-geo', + label_value => 'Places', + tags => ['651'], + subfield => 'a', + }, + { + link_value => 'su-ut', + label_value => 'Titles', + tags => ['630'], + subfield => 'a', + }, + { + link_value => 'au', + label_value => 'Authors', + tags => [ '100', '110', '700', ], + subfield => 'a', + }, + { + link_value => 'se', + label_value => 'Series', + tags => [ '440', '490', ], + subfield => 'a', + }, + ]; + my $library_facet; + $library_facet = { + link_value => 'branch', + label_value => 'Libraries', + tags => [ '952', ], + subfield => 'b', + expanded => '1', + }; + push @$facets, $library_facet unless C4::Context->preference("singleBranchMode"); } + return $facets; } -=head2 get_branchinfos_of +=head2 get_infos_of - my $branchinfos_of = get_branchinfos_of(@branchcodes); +Return a href where a key is associated to a href. You give a query, +the name of the key among the fields returned by the query. If you +also give as third argument the name of the value, the function +returns a href of scalar. The optional 4th argument is an arrayref of +items passed to the C call. It is designed to bind +parameters to any placeholders in your SQL. -Associates a list of branchcodes to the information of the branch, taken in -branches table. + my $query = ' +SELECT itemnumber, + notforloan, + barcode + FROM items +'; -Returns a href where keys are branchcodes and values are href where keys are -branch information key. + # generic href of any information on the item, href of href. + my $iteminfos_of = get_infos_of($query, 'itemnumber'); + print $iteminfos_of->{$itemnumber}{barcode}; - print 'branchname is ', $branchinfos_of->{$code}->{branchname}; + # specific information, href of scalar + my $barcode_of_item = get_infos_of($query, 'itemnumber', 'barcode'); + print $barcode_of_item->{$itemnumber}; =cut -sub get_branchinfos_of { - my @branchcodes = @_; - my $query = ' -SELECT branchcode, - branchname - FROM branches - WHERE branchcode IN ('.join(',', map({"'".$_."'"} @branchcodes)).') -'; - return get_infos_of($query, 'branchcode'); +sub get_infos_of { + my ( $query, $key_name, $value_name, $bind_params ) = @_; + + my $dbh = C4::Context->dbh; + + my $sth = $dbh->prepare($query); + $sth->execute( @$bind_params ); + + my %infos_of; + while ( my $row = $sth->fetchrow_hashref ) { + if ( defined $value_name ) { + $infos_of{ $row->{$key_name} } = $row->{$value_name}; + } + else { + $infos_of{ $row->{$key_name} } = $row; + } + } + $sth->finish; + + return \%infos_of; } =head2 get_notforloan_label_of @@ -867,6 +859,9 @@ labels. } =cut + +# FIXME - why not use GetAuthorisedValues ?? +# sub get_notforloan_label_of { my $dbh = C4::Context->dbh; @@ -889,7 +884,7 @@ SELECT lib, $sth = $dbh->prepare($query); $sth->execute($statuscode); my %notforloan_label_of; - while (my $row = $sth->fetchrow_hashref) { + while ( my $row = $sth->fetchrow_hashref ) { $notforloan_label_of{ $row->{authorised_value} } = $row->{lib}; } $sth->finish; @@ -897,54 +892,340 @@ SELECT lib, return \%notforloan_label_of; } -=head2 get_infos_of +=head2 displayServers -Return a href where a key is associated to a href. You give a query, the -name of the key among the fields returned by the query. If you also give as -third argument the name of the value, the function returns a href of scalar. +=over 4 - my $query = ' -SELECT itemnumber, - notforloan, - barcode - FROM items -'; +my $servers = displayServers(); - # generic href of any information on the item, href of href. - my $iteminfos_of = get_infos_of($query, 'itemnumber'); - print $iteminfos_of->{$itemnumber}{barcode}; +my $servers = displayServers( $position ); + +my $servers = displayServers( $position, $type ); + +=back + +displayServers returns a listref of hashrefs, each containing +information about available z3950 servers. Each hashref has a format +like: + + { + 'checked' => 'checked', + 'encoding' => 'MARC-8' + 'icon' => undef, + 'id' => 'LIBRARY OF CONGRESS', + 'label' => '', + 'name' => 'server', + 'opensearch' => '', + 'value' => 'z3950.loc.gov:7090/', + 'zed' => 1, + }, - # specific information, href of scalar - my $barcode_of_item = get_infos_of($query, 'itemnumber', 'barcode'); - print $barcode_of_item->{$itemnumber}; =cut -sub get_infos_of { - my ($query, $key_name, $value_name) = @_; +sub displayServers { + my ( $position, $type ) = @_; my $dbh = C4::Context->dbh; + my $strsth = 'SELECT * FROM z3950servers'; + my @where_clauses; + my @bind_params; + + if ($position) { + push @bind_params, $position; + push @where_clauses, ' position = ? '; + } + + if ($type) { + push @bind_params, $type; + push @where_clauses, ' type = ? '; + } + + # reassemble where clause from where clause pieces + if (@where_clauses) { + $strsth .= ' WHERE ' . join( ' AND ', @where_clauses ); + } + + my $rq = $dbh->prepare($strsth); + $rq->execute(@bind_params); + my @primaryserverloop; + + while ( my $data = $rq->fetchrow_hashref ) { + push @primaryserverloop, + { label => $data->{description}, + id => $data->{name}, + name => "server", + value => $data->{host} . ":" . $data->{port} . "/" . $data->{database}, + encoding => ( $data->{encoding} ? $data->{encoding} : "iso-5426" ), + checked => "checked", + icon => $data->{icon}, + zed => $data->{type} eq 'zed', + opensearch => $data->{type} eq 'opensearch' + }; + } + return \@primaryserverloop; +} + +sub displaySecondaryServers { + +# my $secondary_servers_loop = [ +# { inner_sup_servers_loop => [ +# {label => "Google", id=>"GOOG", value=>"google",icon => "google.ico",opensearch => "1"}, +# {label => "Yahoo", id=>"YAH", value=>"yahoo", icon =>"yahoo.ico", zed => "1"}, +# {label => "Worldcat", id=>"WCT", value=>"worldcat", icon => "worldcat.gif", zed => "1"}, +# {label => "Library of Congress", id=>"LOC", name=> "server", value=>"z3950.loc.gov:7090/Voyager", icon =>"loc.ico", zed => "1"}, +# ], +# }, +# ]; + return; #$secondary_servers_loop; +} + +=head2 GetAuthValCode + +$authvalcode = GetAuthValCode($kohafield,$frameworkcode); + +=cut + +sub GetAuthValCode { + my ($kohafield,$fwcode) = @_; + my $dbh = C4::Context->dbh; + $fwcode='' unless $fwcode; + my $sth = $dbh->prepare('select authorised_value from marc_subfield_structure where kohafield=? and frameworkcode=?'); + $sth->execute($kohafield,$fwcode); + my ($authvalcode) = $sth->fetchrow_array; + return $authvalcode; +} + +=head2 GetAuthorisedValues + +$authvalues = GetAuthorisedValues([$category], [$selected]); + +This function returns all authorised values from the'authosied_value' table in a reference to array of hashrefs. + +C<$category> returns authorised values for just one category (optional). + +=cut + +sub GetAuthorisedValues { + my ($category,$selected) = @_; + my @results; + my $dbh = C4::Context->dbh; + my $query = "SELECT * FROM authorised_values"; + $query .= " WHERE category = '" . $category . "'" if $category; + my $sth = $dbh->prepare($query); - $sth->execute(); + $sth->execute; + while (my $data=$sth->fetchrow_hashref) { + if ($selected eq $data->{'authorised_value'} ) { + $data->{'selected'} = 1; + } + push @results, $data; + } + #my $data = $sth->fetchall_arrayref({}); + return \@results; #$data; +} - my %infos_of; - while (my $row = $sth->fetchrow_hashref) { - if (defined $value_name) { - $infos_of{ $row->{$key_name} } = $row->{$value_name}; +=head2 GetAuthorisedValueCategories + +$auth_categories = GetAuthorisedValueCategories(); + +Return an arrayref of all of the available authorised +value categories. + +=cut + +sub GetAuthorisedValueCategories { + my $dbh = C4::Context->dbh; + my $sth = $dbh->prepare("SELECT DISTINCT category FROM authorised_values ORDER BY category"); + $sth->execute; + my @results; + while (my $category = $sth->fetchrow_array) { + push @results, $category; + } + return \@results; +} + +=head2 GetKohaAuthorisedValues + + Takes $kohafield, $fwcode as parameters. + Returns hashref of Code => description + Returns undef + if no authorised value category is defined for the kohafield. + +=cut + +sub GetKohaAuthorisedValues { + my ($kohafield,$fwcode,$codedvalue) = @_; + $fwcode='' unless $fwcode; + my %values; + my $dbh = C4::Context->dbh; + my $avcode = GetAuthValCode($kohafield,$fwcode); + if ($avcode) { + my $sth = $dbh->prepare("select authorised_value, lib from authorised_values where category=? "); + $sth->execute($avcode); + while ( my ($val, $lib) = $sth->fetchrow_array ) { + $values{$val}= $lib; + } + return \%values; + } else { + return undef; + } +} + +=head2 display_marc_indicators + +=over 4 + +# field is a MARC::Field object +my $display_form = C4::Koha::display_marc_indicators($field); + +=back + +Generate a display form of the indicators of a variable +MARC field, replacing any blanks with '#'. + +=cut + +sub display_marc_indicators { + my $field = shift; + my $indicators = ''; + if ($field->tag() >= 10) { + $indicators = $field->indicator(1) . $field->indicator(2); + $indicators =~ s/ /#/g; + } + return $indicators; +} + +sub GetNormalizedUPC { + my ($record,$marcflavour) = @_; + my (@fields,$upc); + + if ($marcflavour eq 'MARC21') { + @fields = $record->field('024'); + foreach my $field (@fields) { + my $indicator = $field->indicator(1); + my $upc = _normalize_match_point($field->subfield('a')); + if ($indicator == 1 and $upc ne '') { + return $upc; + } } - else { - $infos_of{ $row->{$key_name} } = $row; + } + else { # assume unimarc if not marc21 + @fields = $record->field('072'); + foreach my $field (@fields) { + my $upc = _normalize_match_point($field->subfield('a')); + if ($upc ne '') { + return $upc; + } + } + } +} + +# Normalizes and returns the first valid ISBN found in the record +sub GetNormalizedISBN { + my ($isbn,$record,$marcflavour) = @_; + my @fields; + if ($isbn) { + return _isbn_cleanup($isbn); + } + return undef unless $record; + + if ($marcflavour eq 'MARC21') { + @fields = $record->field('020'); + foreach my $field (@fields) { + $isbn = $field->subfield('a'); + if ($isbn) { + return _isbn_cleanup($isbn); + } else { + return undef; + } + } + } + else { # assume unimarc if not marc21 + @fields = $record->field('010'); + foreach my $field (@fields) { + my $isbn = $field->subfield('a'); + if ($isbn) { + return _isbn_cleanup($isbn); + } else { + return undef; + } } } - $sth->finish; - return \%infos_of; +} + +sub GetNormalizedEAN { + my ($record,$marcflavour) = @_; + my (@fields,$ean); + + if ($marcflavour eq 'MARC21') { + @fields = $record->field('024'); + foreach my $field (@fields) { + my $indicator = $field->indicator(1); + $ean = _normalize_match_point($field->subfield('a')); + if ($indicator == 3 and $ean ne '') { + return $ean; + } + } + } + else { # assume unimarc if not marc21 + @fields = $record->field('073'); + foreach my $field (@fields) { + $ean = _normalize_match_point($field->subfield('a')); + if ($ean ne '') { + return $ean; + } + } + } +} +sub GetNormalizedOCLCNumber { + my ($record,$marcflavour) = @_; + my (@fields,$oclc); + + if ($marcflavour eq 'MARC21') { + @fields = $record->field('035'); + foreach my $field (@fields) { + $oclc = $field->subfield('a'); + if ($oclc =~ /OCoLC/) { + $oclc =~ s/\(OCoLC\)//; + return $oclc; + } else { + return undef; + } + } + } + else { # TODO: add UNIMARC fields + } +} + +sub _normalize_match_point { + my $match_point = shift; + (my $normalized_match_point) = $match_point =~ /([\d-]*[X]*)/; + $normalized_match_point =~ s/-//g; + + 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; + } + return undef; } 1; -__END__ -=back +__END__ =head1 AUTHOR