C4/Koha.pm

   1 package C4::Koha;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 # Parts Copyright 2010 Nelsonville Public Library
   5 # Parts copyright 2010 BibLibre
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along
  19 # with Koha; if not, write to the Free Software Foundation, Inc.,
  20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  21
  22
  23 use strict;
  24 #use warnings; FIXME - Bug 2505
  25
  26 use C4::Context;
  27
  28 use Memoize;
  29 use DateTime;
  30 use DateTime::Format::MySQL;
  31 use autouse 'Data::Dumper' => qw(Dumper);
  32
  33 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK $DEBUG);
  34
  35 BEGIN {
  36     $VERSION = 3.07.00.049;
  37         require Exporter;
  38         @ISA    = qw(Exporter);
  39         @EXPORT = qw(
  40                 &slashifyDate
  41                 &subfield_is_koha_internal_p
  42                 &GetPrinters &GetPrinter
  43                 &GetItemTypes &getitemtypeinfo
  44                 &GetCcodes
  45                 &GetSupportName &GetSupportList
  46                 &get_itemtypeinfos_of
  47                 &getframeworks &getframeworkinfo
  48                 &getauthtypes &getauthtype
  49                 &getallthemes
  50                 &getFacets
  51                 &displayServers
  52                 &getnbpages
  53                 &get_infos_of
  54                 &get_notforloan_label_of
  55                 &getitemtypeimagedir
  56                 &getitemtypeimagesrc
  57                 &getitemtypeimagelocation
  58                 &GetAuthorisedValues
  59                 &GetAuthorisedValueCategories
  60                 &GetKohaAuthorisedValues
  61                 &GetKohaAuthorisedValuesFromField
  62     &GetKohaAuthorisedValueLib
  63     &GetAuthorisedValueByCode
  64     &GetKohaImageurlFromAuthorisedValues
  65                 &GetAuthValCode
  66                 &GetNormalizedUPC
  67                 &GetNormalizedISBN
  68                 &GetNormalizedEAN
  69                 &GetNormalizedOCLCNumber
  70         &xml_escape
  71
  72                 $DEBUG
  73         );
  74         $DEBUG = 0;
  75 @EXPORT_OK = qw( GetDailyQuote );
  76 }
  77
  78 # expensive functions
  79 memoize('GetAuthorisedValues');
  80
  81 =head1 NAME
  82
  83 C4::Koha - Perl Module containing convenience functions for Koha scripts
  84
  85 =head1 SYNOPSIS
  86
  87 use C4::Koha;
  88
  89 =head1 DESCRIPTION
  90
  91 Koha.pm provides many functions for Koha scripts.
  92
  93 =head1 FUNCTIONS
  94
  95 =cut
  96
  97 =head2 slashifyDate
  98
  99   $slash_date = &slashifyDate($dash_date);
 100
 101 Takes a string of the form "DD-MM-YYYY" (or anything separated by
 102 dashes), converts it to the form "YYYY/MM/DD", and returns the result.
 103
 104 =cut
 105
 106 sub slashifyDate {
 107
 108     # accepts a date of the form xx-xx-xx[xx] and returns it in the
 109     # form xx/xx/xx[xx]
 110     my @dateOut = split( '-', shift );
 111     return ("$dateOut[2]/$dateOut[1]/$dateOut[0]");
 112 }
 113
 114 # FIXME.. this should be moved to a MARC-specific module
 115 sub subfield_is_koha_internal_p ($) {
 116     my ($subfield) = @_;
 117
 118     # We could match on 'lib' and 'tab' (and 'mandatory', & more to come!)
 119     # But real MARC subfields are always single-character
 120     # so it really is safer just to check the length
 121
 122     return length $subfield != 1;
 123 }
 124
 125 =head2 GetSupportName
 126
 127   $itemtypename = &GetSupportName($codestring);
 128
 129 Returns a string with the name of the itemtype.
 130
 131 =cut
 132
 133 sub GetSupportName{
 134         my ($codestring)=@_;
 135         return if (! $codestring);
 136         my $resultstring;
 137         my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 138         if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
 139                 my $query = qq|
 140                         SELECT description
 141                         FROM   itemtypes
 142                         WHERE itemtype=?
 143                         order by description
 144                 |;
 145                 my $sth = C4::Context->dbh->prepare($query);
 146                 $sth->execute($codestring);
 147                 ($resultstring)=$sth->fetchrow;
 148                 return $resultstring;
 149         } else {
 150         my $sth =
 151             C4::Context->dbh->prepare(
 152                     "SELECT lib FROM authorised_values WHERE category = ? AND authorised_value = ?"
 153                     );
 154         $sth->execute( $advanced_search_types, $codestring );
 155         my $data = $sth->fetchrow_hashref;
 156         return $$data{'lib'};
 157         }
 158
 159 }
 160 =head2 GetSupportList
 161
 162   $itemtypes = &GetSupportList();
 163
 164 Returns an array ref containing informations about Support (since itemtype is rather a circulation code when item-level-itypes is used).
 165
 166 build a HTML select with the following code :
 167
 168 =head3 in PERL SCRIPT
 169
 170     my $itemtypes = GetSupportList();
 171     $template->param(itemtypeloop => $itemtypes);
 172
 173 =head3 in TEMPLATE
 174
 175     <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
 176         <select name="itemtype">
 177             <option value="">Default</option>
 178         <!-- TMPL_LOOP name="itemtypeloop" -->
 179             <option value="<!-- TMPL_VAR name="itemtype" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->> <!--TMPL_IF Name="imageurl"--><img alt="<!-- TMPL_VAR name="description" -->" src="<!--TMPL_VAR Name="imageurl"-->><!--TMPL_ELSE-->"<!-- TMPL_VAR name="description" --><!--/TMPL_IF--></option>
 180         <!-- /TMPL_LOOP -->
 181         </select>
 182         <input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
 183         <input type="submit" value="OK" class="button">
 184     </form>
 185
 186 =cut
 187
 188 sub GetSupportList{
 189         my $advanced_search_types = C4::Context->preference("AdvancedSearchTypes");
 190         if (!$advanced_search_types or $advanced_search_types eq 'itemtypes') {
 191                 my $query = qq|
 192                         SELECT *
 193                         FROM   itemtypes
 194                         order by description
 195                 |;
 196                 my $sth = C4::Context->dbh->prepare($query);
 197                 $sth->execute;
 198                 return $sth->fetchall_arrayref({});
 199         } else {
 200                 my $advsearchtypes = GetAuthorisedValues($advanced_search_types);
 201                 my @results= map {{itemtype=>$$_{authorised_value},description=>$$_{lib},imageurl=>$$_{imageurl}}} @$advsearchtypes;
 202                 return \@results;
 203         }
 204 }
 205 =head2 GetItemTypes
 206
 207   $itemtypes = &GetItemTypes();
 208
 209 Returns information about existing itemtypes.
 210
 211 build a HTML select with the following code :
 212
 213 =head3 in PERL SCRIPT
 214
 215     my $itemtypes = GetItemTypes;
 216     my @itemtypesloop;
 217     foreach my $thisitemtype (sort keys %$itemtypes) {
 218         my $selected = 1 if $thisitemtype eq $itemtype;
 219         my %row =(value => $thisitemtype,
 220                     selected => $selected,
 221                     description => $itemtypes->{$thisitemtype}->{'description'},
 222                 );
 223         push @itemtypesloop, \%row;
 224     }
 225     $template->param(itemtypeloop => \@itemtypesloop);
 226
 227 =head3 in TEMPLATE
 228
 229     <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
 230         <select name="itemtype">
 231             <option value="">Default</option>
 232         <!-- TMPL_LOOP name="itemtypeloop" -->
 233             <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="description" --></option>
 234         <!-- /TMPL_LOOP -->
 235         </select>
 236         <input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
 237         <input type="submit" value="OK" class="button">
 238     </form>
 239
 240 =cut
 241
 242 sub GetItemTypes {
 243
 244     # returns a reference to a hash of references to itemtypes...
 245     my %itemtypes;
 246     my $dbh   = C4::Context->dbh;
 247     my $query = qq|
 248         SELECT *
 249         FROM   itemtypes
 250     |;
 251     my $sth = $dbh->prepare($query);
 252     $sth->execute;
 253     while ( my $IT = $sth->fetchrow_hashref ) {
 254         $itemtypes{ $IT->{'itemtype'} } = $IT;
 255     }
 256     return ( \%itemtypes );
 257 }
 258
 259 sub get_itemtypeinfos_of {
 260     my @itemtypes = @_;
 261
 262     my $placeholders = join( ', ', map { '?' } @itemtypes );
 263     my $query = <<"END_SQL";
 264 SELECT itemtype,
 265        description,
 266        imageurl,
 267        notforloan
 268   FROM itemtypes
 269   WHERE itemtype IN ( $placeholders )
 270 END_SQL
 271
 272     return get_infos_of( $query, 'itemtype', undef, \@itemtypes );
 273 }
 274
 275 # this is temporary until we separate collection codes and item types
 276 sub GetCcodes {
 277     my $count = 0;
 278     my @results;
 279     my $dbh = C4::Context->dbh;
 280     my $sth =
 281       $dbh->prepare(
 282         "SELECT * FROM authorised_values ORDER BY authorised_value");
 283     $sth->execute;
 284     while ( my $data = $sth->fetchrow_hashref ) {
 285         if ( $data->{category} eq "CCODE" ) {
 286             $count++;
 287             $results[$count] = $data;
 288
 289             #warn "data: $data";
 290         }
 291     }
 292     $sth->finish;
 293     return ( $count, @results );
 294 }
 295
 296 =head2 getauthtypes
 297
 298   $authtypes = &getauthtypes();
 299
 300 Returns information about existing authtypes.
 301
 302 build a HTML select with the following code :
 303
 304 =head3 in PERL SCRIPT
 305
 306    my $authtypes = getauthtypes;
 307    my @authtypesloop;
 308    foreach my $thisauthtype (keys %$authtypes) {
 309        my $selected = 1 if $thisauthtype eq $authtype;
 310        my %row =(value => $thisauthtype,
 311                 selected => $selected,
 312                 authtypetext => $authtypes->{$thisauthtype}->{'authtypetext'},
 313             );
 314         push @authtypesloop, \%row;
 315     }
 316     $template->param(itemtypeloop => \@itemtypesloop);
 317
 318 =head3 in TEMPLATE
 319
 320   <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
 321     <select name="authtype">
 322     <!-- TMPL_LOOP name="authtypeloop" -->
 323         <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="authtypetext" --></option>
 324     <!-- /TMPL_LOOP -->
 325     </select>
 326     <input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
 327     <input type="submit" value="OK" class="button">
 328   </form>
 329
 330
 331 =cut
 332
 333 sub getauthtypes {
 334
 335     # returns a reference to a hash of references to authtypes...
 336     my %authtypes;
 337     my $dbh = C4::Context->dbh;
 338     my $sth = $dbh->prepare("select * from auth_types order by authtypetext");
 339     $sth->execute;
 340     while ( my $IT = $sth->fetchrow_hashref ) {
 341         $authtypes{ $IT->{'authtypecode'} } = $IT;
 342     }
 343     return ( \%authtypes );
 344 }
 345
 346 sub getauthtype {
 347     my ($authtypecode) = @_;
 348
 349     # returns a reference to a hash of references to authtypes...
 350     my %authtypes;
 351     my $dbh = C4::Context->dbh;
 352     my $sth = $dbh->prepare("select * from auth_types where authtypecode=?");
 353     $sth->execute($authtypecode);
 354     my $res = $sth->fetchrow_hashref;
 355     return $res;
 356 }
 357
 358 =head2 getframework
 359
 360   $frameworks = &getframework();
 361
 362 Returns information about existing frameworks
 363
 364 build a HTML select with the following code :
 365
 366 =head3 in PERL SCRIPT
 367
 368   my $frameworks = frameworks();
 369   my @frameworkloop;
 370   foreach my $thisframework (keys %$frameworks) {
 371     my $selected = 1 if $thisframework eq $frameworkcode;
 372     my %row =(value => $thisframework,
 373                 selected => $selected,
 374                 description => $frameworks->{$thisframework}->{'frameworktext'},
 375             );
 376     push @frameworksloop, \%row;
 377   }
 378   $template->param(frameworkloop => \@frameworksloop);
 379
 380 =head3 in TEMPLATE
 381
 382   <form action='<!-- TMPL_VAR name="script_name" -->' method=post>
 383     <select name="frameworkcode">
 384         <option value="">Default</option>
 385     <!-- TMPL_LOOP name="frameworkloop" -->
 386         <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="frameworktext" --></option>
 387     <!-- /TMPL_LOOP -->
 388     </select>
 389     <input type=text name=searchfield value="<!-- TMPL_VAR name="searchfield" -->">
 390     <input type="submit" value="OK" class="button">
 391   </form>
 392
 393 =cut
 394
 395 sub getframeworks {
 396
 397     # returns a reference to a hash of references to branches...
 398     my %itemtypes;
 399     my $dbh = C4::Context->dbh;
 400     my $sth = $dbh->prepare("select * from biblio_framework");
 401     $sth->execute;
 402     while ( my $IT = $sth->fetchrow_hashref ) {
 403         $itemtypes{ $IT->{'frameworkcode'} } = $IT;
 404     }
 405     return ( \%itemtypes );
 406 }
 407
 408 =head2 getframeworkinfo
 409
 410   $frameworkinfo = &getframeworkinfo($frameworkcode);
 411
 412 Returns information about an frameworkcode.
 413
 414 =cut
 415
 416 sub getframeworkinfo {
 417     my ($frameworkcode) = @_;
 418     my $dbh             = C4::Context->dbh;
 419     my $sth             =
 420       $dbh->prepare("select * from biblio_framework where frameworkcode=?");
 421     $sth->execute($frameworkcode);
 422     my $res = $sth->fetchrow_hashref;
 423     return $res;
 424 }
 425
 426 =head2 getitemtypeinfo
 427
 428   $itemtype = &getitemtype($itemtype);
 429
 430 Returns information about an itemtype.
 431
 432 =cut
 433
 434 sub getitemtypeinfo {
 435     my ($itemtype) = @_;
 436     my $dbh        = C4::Context->dbh;
 437     my $sth        = $dbh->prepare("select * from itemtypes where itemtype=?");
 438     $sth->execute($itemtype);
 439     my $res = $sth->fetchrow_hashref;
 440
 441     $res->{imageurl} = getitemtypeimagelocation( 'intranet', $res->{imageurl} );
 442
 443     return $res;
 444 }
 445
 446 =head2 getitemtypeimagedir
 447
 448   my $directory = getitemtypeimagedir( 'opac' );
 449
 450 pass in 'opac' or 'intranet'. Defaults to 'opac'.
 451
 452 returns the full path to the appropriate directory containing images.
 453
 454 =cut
 455
 456 sub getitemtypeimagedir {
 457         my $src = shift || 'opac';
 458         if ($src eq 'intranet') {
 459                 return C4::Context->config('intrahtdocs') . '/' .C4::Context->preference('template') . '/img/itemtypeimg';
 460         } else {
 461                 return C4::Context->config('opachtdocs') . '/' . C4::Context->preference('opacthemes') . '/itemtypeimg';
 462         }
 463 }
 464
 465 sub getitemtypeimagesrc {
 466         my $src = shift || 'opac';
 467         if ($src eq 'intranet') {
 468                 return '/intranet-tmpl' . '/' . C4::Context->preference('template') . '/img/itemtypeimg';
 469         } else {
 470                 return '/opac-tmpl' . '/' . C4::Context->preference('opacthemes') . '/itemtypeimg';
 471         }
 472 }
 473
 474 sub getitemtypeimagelocation($$) {
 475         my ( $src, $image ) = @_;
 476
 477         return '' if ( !$image );
 478     require URI::Split;
 479
 480         my $scheme = ( URI::Split::uri_split( $image ) )[0];
 481
 482         return $image if ( $scheme );
 483
 484         return getitemtypeimagesrc( $src ) . '/' . $image;
 485 }
 486
 487 =head3 _getImagesFromDirectory
 488
 489 Find all of the image files in a directory in the filesystem
 490
 491 parameters: a directory name
 492
 493 returns: a list of images in that directory.
 494
 495 Notes: this does not traverse into subdirectories. See
 496 _getSubdirectoryNames for help with that.
 497 Images are assumed to be files with .gif or .png file extensions.
 498 The image names returned do not have the directory name on them.
 499
 500 =cut
 501
 502 sub _getImagesFromDirectory {
 503     my $directoryname = shift;
 504     return unless defined $directoryname;
 505     return unless -d $directoryname;
 506
 507     if ( opendir ( my $dh, $directoryname ) ) {
 508         my @images = grep { /\.(gif|png)$/i } readdir( $dh );
 509         closedir $dh;
 510         @images = sort(@images);
 511         return @images;
 512     } else {
 513         warn "unable to opendir $directoryname: $!";
 514         return;
 515     }
 516 }
 517
 518 =head3 _getSubdirectoryNames
 519
 520 Find all of the directories in a directory in the filesystem
 521
 522 parameters: a directory name
 523
 524 returns: a list of subdirectories in that directory.
 525
 526 Notes: this does not traverse into subdirectories. Only the first
 527 level of subdirectories are returned.
 528 The directory names returned don't have the parent directory name on them.
 529
 530 =cut
 531
 532 sub _getSubdirectoryNames {
 533     my $directoryname = shift;
 534     return unless defined $directoryname;
 535     return unless -d $directoryname;
 536
 537     if ( opendir ( my $dh, $directoryname ) ) {
 538         my @directories = grep { -d File::Spec->catfile( $directoryname, $_ ) && ! ( /^\./ ) } readdir( $dh );
 539         closedir $dh;
 540         return @directories;
 541     } else {
 542         warn "unable to opendir $directoryname: $!";
 543         return;
 544     }
 545 }
 546
 547 =head3 getImageSets
 548
 549 returns: a listref of hashrefs. Each hash represents another collection of images.
 550
 551  { imagesetname => 'npl', # the name of the image set (npl is the original one)
 552          images => listref of image hashrefs
 553  }
 554
 555 each image is represented by a hashref like this:
 556
 557  { KohaImage     => 'npl/image.gif',
 558    StaffImageUrl => '/intranet-tmpl/prog/img/itemtypeimg/npl/image.gif',
 559    OpacImageURL  => '/opac-tmpl/prog/itemtypeimg/npl/image.gif'
 560    checked       => 0 or 1: was this the image passed to this method?
 561                     Note: I'd like to remove this somehow.
 562  }
 563
 564 =cut
 565
 566 sub getImageSets {
 567     my %params = @_;
 568     my $checked = $params{'checked'} || '';
 569
 570     my $paths = { staff => { filesystem => getitemtypeimagedir('intranet'),
 571                              url        => getitemtypeimagesrc('intranet'),
 572                         },
 573                   opac => { filesystem => getitemtypeimagedir('opac'),
 574                              url       => getitemtypeimagesrc('opac'),
 575                         }
 576                   };
 577
 578     my @imagesets = (); # list of hasrefs of image set data to pass to template
 579     my @subdirectories = _getSubdirectoryNames( $paths->{'staff'}{'filesystem'} );
 580     foreach my $imagesubdir ( @subdirectories ) {
 581     warn $imagesubdir if $DEBUG;
 582         my @imagelist     = (); # hashrefs of image info
 583         my @imagenames = _getImagesFromDirectory( File::Spec->catfile( $paths->{'staff'}{'filesystem'}, $imagesubdir ) );
 584         my $imagesetactive = 0;
 585         foreach my $thisimage ( @imagenames ) {
 586             push( @imagelist,
 587                   { KohaImage     => "$imagesubdir/$thisimage",
 588                     StaffImageUrl => join( '/', $paths->{'staff'}{'url'}, $imagesubdir, $thisimage ),
 589                     OpacImageUrl  => join( '/', $paths->{'opac'}{'url'}, $imagesubdir, $thisimage ),
 590                     checked       => "$imagesubdir/$thisimage" eq $checked ? 1 : 0,
 591                }
 592              );
 593              $imagesetactive = 1 if "$imagesubdir/$thisimage" eq $checked;
 594         }
 595         push @imagesets, { imagesetname => $imagesubdir,
 596                            imagesetactive => $imagesetactive,
 597                            images       => \@imagelist };
 598
 599     }
 600     return \@imagesets;
 601 }
 602
 603 =head2 GetPrinters
 604
 605   $printers = &GetPrinters();
 606   @queues = keys %$printers;
 607
 608 Returns information about existing printer queues.
 609
 610 C<$printers> is a reference-to-hash whose keys are the print queues
 611 defined in the printers table of the Koha database. The values are
 612 references-to-hash, whose keys are the fields in the printers table.
 613
 614 =cut
 615
 616 sub GetPrinters {
 617     my %printers;
 618     my $dbh = C4::Context->dbh;
 619     my $sth = $dbh->prepare("select * from printers");
 620     $sth->execute;
 621     while ( my $printer = $sth->fetchrow_hashref ) {
 622         $printers{ $printer->{'printqueue'} } = $printer;
 623     }
 624     return ( \%printers );
 625 }
 626
 627 =head2 GetPrinter
 628
 629   $printer = GetPrinter( $query, $printers );
 630
 631 =cut
 632
 633 sub GetPrinter ($$) {
 634     my ( $query, $printers ) = @_;    # get printer for this query from printers
 635     my $printer = $query->param('printer');
 636     my %cookie = $query->cookie('userenv');
 637     ($printer) || ( $printer = $cookie{'printer'} ) || ( $printer = '' );
 638     ( $printers->{$printer} ) || ( $printer = ( keys %$printers )[0] );
 639     return $printer;
 640 }
 641
 642 =head2 getnbpages
 643
 644 Returns the number of pages to display in a pagination bar, given the number
 645 of items and the number of items per page.
 646
 647 =cut
 648
 649 sub getnbpages {
 650     my ( $nb_items, $nb_items_per_page ) = @_;
 651
 652     return int( ( $nb_items - 1 ) / $nb_items_per_page ) + 1;
 653 }
 654
 655 =head2 getallthemes
 656
 657   (@themes) = &getallthemes('opac');
 658   (@themes) = &getallthemes('intranet');
 659
 660 Returns an array of all available themes.
 661
 662 =cut
 663
 664 sub getallthemes {
 665     my $type = shift;
 666     my $htdocs;
 667     my @themes;
 668     if ( $type eq 'intranet' ) {
 669         $htdocs = C4::Context->config('intrahtdocs');
 670     }
 671     else {
 672         $htdocs = C4::Context->config('opachtdocs');
 673     }
 674     opendir D, "$htdocs";
 675     my @dirlist = readdir D;
 676     foreach my $directory (@dirlist) {
 677         -d "$htdocs/$directory/en" and push @themes, $directory;
 678     }
 679     return @themes;
 680 }
 681
 682 sub getFacets {
 683     my $facets;
 684     if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 685         $facets = [
 686             {
 687                 idx   => 'su-to',
 688                 label => 'Topics',
 689                 tags  => [ qw/ 600a 601a 602a 603a 604a 605a 606ax 610a/ ],
 690                 sep   => ' - ',
 691             },
 692             {
 693                 idx   => 'su-geo',
 694                 label => 'Places',
 695                 tags  => [ qw/ 651a / ],
 696                 sep   => ' - ',
 697             },
 698             {
 699                 idx   => 'su-ut',
 700                 label => 'Titles',
 701                 tags  => [ qw/ 500a 501a 502a 503a 504a / ],
 702                 sep   => ', ',
 703             },
 704             {
 705                 idx   => 'au',
 706                 label => 'Authors',
 707                 tags  => [ qw/ 700ab 701ab 702ab / ],
 708                 sep   => ', ',
 709             },
 710             {
 711                 idx   => 'se',
 712                 label => 'Series',
 713                 tags  => [ qw/ 225a / ],
 714                 sep   => ', ',
 715             },
 716         ];
 717         my $library_facet = {
 718             idx   => 'branch',
 719             label => 'Libraries',
 720             tags  => [ qw/ 995b / ],
 721             expanded => '1',
 722         };
 723         push @$facets, $library_facet unless C4::Context->preference("singleBranchMode");
 724     }
 725     else {
 726         $facets = [
 727             {
 728                 idx   => 'su-to',
 729                 label => 'Topics',
 730                 tags  => [ qw/ 650a / ],
 731                 sep   => '--',
 732             },
 733             #        {
 734             #        idx   => 'su-na',
 735             #        label => 'People and Organizations',
 736             #        tags  => [ qw/ 600a 610a 611a / ],
 737             #        sep   => 'a',
 738             #        },
 739             {
 740                 idx   => 'su-geo',
 741                 label => 'Places',
 742                 tags  => [ qw/ 651a / ],
 743                 sep   => '--',
 744             },
 745             {
 746                 idx   => 'su-ut',
 747                 label => 'Titles',
 748                 tags  => [ qw/ 630a / ],
 749                 sep   => '--',
 750             },
 751             {
 752                 idx   => 'au',
 753                 label => 'Authors',
 754                 tags  => [ qw/ 100a 110a 700a / ],
 755                 sep   => ', ',
 756             },
 757             {
 758                 idx   => 'se',
 759                 label => 'Series',
 760                 tags  => [ qw/ 440a 490a / ],
 761                 sep   => ', ',
 762             },
 763             {
 764                 idx   => 'itype',
 765                 label => 'ItemTypes',
 766                 tags  => [ qw/ 952y 942c / ],
 767                 sep   => ', ',
 768             },
 769             ];
 770             my $library_facet;
 771             $library_facet = {
 772                 idx   => 'branch',
 773                 label => 'Libraries',
 774                 tags  => [ qw/ 952b / ],
 775                 sep   => ', ',
 776                 expanded    => '1',
 777             };
 778             push @$facets, $library_facet unless C4::Context->preference("singleBranchMode");
 779     }
 780     return $facets;
 781 }
 782
 783 =head2 get_infos_of
 784
 785 Return a href where a key is associated to a href. You give a query,
 786 the name of the key among the fields returned by the query. If you
 787 also give as third argument the name of the value, the function
 788 returns a href of scalar. The optional 4th argument is an arrayref of
 789 items passed to the C<execute()> call. It is designed to bind
 790 parameters to any placeholders in your SQL.
 791
 792   my $query = '
 793 SELECT itemnumber,
 794        notforloan,
 795        barcode
 796   FROM items
 797 ';
 798
 799   # generic href of any information on the item, href of href.
 800   my $iteminfos_of = get_infos_of($query, 'itemnumber');
 801   print $iteminfos_of->{$itemnumber}{barcode};
 802
 803   # specific information, href of scalar
 804   my $barcode_of_item = get_infos_of($query, 'itemnumber', 'barcode');
 805   print $barcode_of_item->{$itemnumber};
 806
 807 =cut
 808
 809 sub get_infos_of {
 810     my ( $query, $key_name, $value_name, $bind_params ) = @_;
 811
 812     my $dbh = C4::Context->dbh;
 813
 814     my $sth = $dbh->prepare($query);
 815     $sth->execute( @$bind_params );
 816
 817     my %infos_of;
 818     while ( my $row = $sth->fetchrow_hashref ) {
 819         if ( defined $value_name ) {
 820             $infos_of{ $row->{$key_name} } = $row->{$value_name};
 821         }
 822         else {
 823             $infos_of{ $row->{$key_name} } = $row;
 824         }
 825     }
 826     $sth->finish;
 827
 828     return \%infos_of;
 829 }
 830
 831 =head2 get_notforloan_label_of
 832
 833   my $notforloan_label_of = get_notforloan_label_of();
 834
 835 Each authorised value of notforloan (information available in items and
 836 itemtypes) is link to a single label.
 837
 838 Returns a href where keys are authorised values and values are corresponding
 839 labels.
 840
 841   foreach my $authorised_value (keys %{$notforloan_label_of}) {
 842     printf(
 843         "authorised_value: %s => %s\n",
 844         $authorised_value,
 845         $notforloan_label_of->{$authorised_value}
 846     );
 847   }
 848
 849 =cut
 850
 851 # FIXME - why not use GetAuthorisedValues ??
 852 #
 853 sub get_notforloan_label_of {
 854     my $dbh = C4::Context->dbh;
 855
 856     my $query = '
 857 SELECT authorised_value
 858   FROM marc_subfield_structure
 859   WHERE kohafield = \'items.notforloan\'
 860   LIMIT 0, 1
 861 ';
 862     my $sth = $dbh->prepare($query);
 863     $sth->execute();
 864     my ($statuscode) = $sth->fetchrow_array();
 865
 866     $query = '
 867 SELECT lib,
 868        authorised_value
 869   FROM authorised_values
 870   WHERE category = ?
 871 ';
 872     $sth = $dbh->prepare($query);
 873     $sth->execute($statuscode);
 874     my %notforloan_label_of;
 875     while ( my $row = $sth->fetchrow_hashref ) {
 876         $notforloan_label_of{ $row->{authorised_value} } = $row->{lib};
 877     }
 878     $sth->finish;
 879
 880     return \%notforloan_label_of;
 881 }
 882
 883 =head2 displayServers
 884
 885    my $servers = displayServers();
 886    my $servers = displayServers( $position );
 887    my $servers = displayServers( $position, $type );
 888
 889 displayServers returns a listref of hashrefs, each containing
 890 information about available z3950 servers. Each hashref has a format
 891 like:
 892
 893     {
 894       'checked'    => 'checked',
 895       'encoding'   => 'MARC-8'
 896       'icon'       => undef,
 897       'id'         => 'LIBRARY OF CONGRESS',
 898       'label'      => '',
 899       'name'       => 'server',
 900       'opensearch' => '',
 901       'value'      => 'z3950.loc.gov:7090/',
 902       'zed'        => 1,
 903     },
 904
 905 =cut
 906
 907 sub displayServers {
 908     my ( $position, $type ) = @_;
 909     my $dbh = C4::Context->dbh;
 910
 911     my $strsth = 'SELECT * FROM z3950servers';
 912     my @where_clauses;
 913     my @bind_params;
 914
 915     if ($position) {
 916         push @bind_params,   $position;
 917         push @where_clauses, ' position = ? ';
 918     }
 919
 920     if ($type) {
 921         push @bind_params,   $type;
 922         push @where_clauses, ' type = ? ';
 923     }
 924
 925     # reassemble where clause from where clause pieces
 926     if (@where_clauses) {
 927         $strsth .= ' WHERE ' . join( ' AND ', @where_clauses );
 928     }
 929
 930     my $rq = $dbh->prepare($strsth);
 931     $rq->execute(@bind_params);
 932     my @primaryserverloop;
 933
 934     while ( my $data = $rq->fetchrow_hashref ) {
 935         push @primaryserverloop,
 936           { label    => $data->{description},
 937             id       => $data->{name},
 938             name     => "server",
 939             value    => $data->{host} . ":" . $data->{port} . "/" . $data->{database},
 940             encoding => ( $data->{encoding} ? $data->{encoding} : "iso-5426" ),
 941             checked  => "checked",
 942             icon     => $data->{icon},
 943             zed        => $data->{type} eq 'zed',
 944             opensearch => $data->{type} eq 'opensearch'
 945           };
 946     }
 947     return \@primaryserverloop;
 948 }
 949
 950
 951 =head2 GetKohaImageurlFromAuthorisedValues
 952
 953 $authhorised_value = GetKohaImageurlFromAuthorisedValues( $category, $authvalcode );
 954
 955 Return the first url of the authorised value image represented by $lib.
 956
 957 =cut
 958
 959 sub GetKohaImageurlFromAuthorisedValues {
 960     my ( $category, $lib ) = @_;
 961     my $dbh = C4::Context->dbh;
 962     my $sth = $dbh->prepare("SELECT imageurl FROM authorised_values WHERE category=? AND lib =?");
 963     $sth->execute( $category, $lib );
 964     while ( my $data = $sth->fetchrow_hashref ) {
 965         return $data->{'imageurl'};
 966     }
 967 }
 968
 969 =head2 GetAuthValCode
 970
 971   $authvalcode = GetAuthValCode($kohafield,$frameworkcode);
 972
 973 =cut
 974
 975 sub GetAuthValCode {
 976         my ($kohafield,$fwcode) = @_;
 977         my $dbh = C4::Context->dbh;
 978         $fwcode='' unless $fwcode;
 979         my $sth = $dbh->prepare('select authorised_value from marc_subfield_structure where kohafield=? and frameworkcode=?');
 980         $sth->execute($kohafield,$fwcode);
 981         my ($authvalcode) = $sth->fetchrow_array;
 982         return $authvalcode;
 983 }
 984
 985 =head2 GetAuthValCodeFromField
 986
 987   $authvalcode = GetAuthValCodeFromField($field,$subfield,$frameworkcode);
 988
 989 C<$subfield> can be undefined
 990
 991 =cut
 992
 993 sub GetAuthValCodeFromField {
 994         my ($field,$subfield,$fwcode) = @_;
 995         my $dbh = C4::Context->dbh;
 996         $fwcode='' unless $fwcode;
 997         my $sth;
 998         if (defined $subfield) {
 999             $sth = $dbh->prepare('select authorised_value from marc_subfield_structure where tagfield=? and tagsubfield=? and frameworkcode=?');
1000             $sth->execute($field,$subfield,$fwcode);
1001         } else {
1002             $sth = $dbh->prepare('select authorised_value from marc_tag_structure where tagfield=? and frameworkcode=?');
1003             $sth->execute($field,$fwcode);
1004         }
1005         my ($authvalcode) = $sth->fetchrow_array;
1006         return $authvalcode;
1007 }
1008
1009 =head2 GetAuthorisedValues
1010
1011   $authvalues = GetAuthorisedValues([$category], [$selected]);
1012
1013 This function returns all authorised values from the'authorised_value' table in a reference to array of hashrefs.
1014
1015 C<$category> returns authorised values for just one category (optional).
1016
1017 C<$opac> If set to a true value, displays OPAC descriptions rather than normal ones when they exist.
1018
1019 =cut
1020
1021 sub GetAuthorisedValues {
1022     my ($category,$selected,$opac) = @_;
1023     my @results;
1024     my $dbh      = C4::Context->dbh;
1025     my $query    = "SELECT * FROM authorised_values";
1026     $query .= " WHERE category = '" . $category . "'" if $category;
1027     $query .= " ORDER BY category, lib, lib_opac";
1028     my $sth = $dbh->prepare($query);
1029     $sth->execute;
1030     while (my $data=$sth->fetchrow_hashref) {
1031         if ( (defined($selected)) && ($selected eq $data->{'authorised_value'}) ) {
1032             $data->{'selected'} = 1;
1033         }
1034         else {
1035             $data->{'selected'} = 0;
1036         }
1037         if ($opac && $data->{'lib_opac'}) {
1038             $data->{'lib'} = $data->{'lib_opac'};
1039         }
1040         push @results, $data;
1041     }
1042     #my $data = $sth->fetchall_arrayref({});
1043     return \@results; #$data;
1044 }
1045
1046 =head2 GetAuthorisedValueCategories
1047
1048   $auth_categories = GetAuthorisedValueCategories();
1049
1050 Return an arrayref of all of the available authorised
1051 value categories.
1052
1053 =cut
1054
1055 sub GetAuthorisedValueCategories {
1056     my $dbh = C4::Context->dbh;
1057     my $sth = $dbh->prepare("SELECT DISTINCT category FROM authorised_values ORDER BY category");
1058     $sth->execute;
1059     my @results;
1060     while (defined (my $category  = $sth->fetchrow_array) ) {
1061         push @results, $category;
1062     }
1063     return \@results;
1064 }
1065
1066 =head2 GetAuthorisedValueByCode
1067
1068 $authhorised_value = GetAuthorisedValueByCode( $category, $authvalcode );
1069
1070 Return the lib attribute from authorised_values from the row identified
1071 by the passed category and code
1072
1073 =cut
1074
1075 sub GetAuthorisedValueByCode {
1076     my ( $category, $authvalcode ) = @_;
1077
1078     my $dbh = C4::Context->dbh;
1079     my $sth = $dbh->prepare("SELECT lib FROM authorised_values WHERE category=? AND authorised_value =?");
1080     $sth->execute( $category, $authvalcode );
1081     while ( my $data = $sth->fetchrow_hashref ) {
1082         return $data->{'lib'};
1083     }
1084 }
1085
1086 =head2 GetKohaAuthorisedValues
1087
1088 Takes $kohafield, $fwcode as parameters.
1089
1090 If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
1091
1092 Returns hashref of Code => description
1093
1094 Returns undef if no authorised value category is defined for the kohafield.
1095
1096 =cut
1097
1098 sub GetKohaAuthorisedValues {
1099   my ($kohafield,$fwcode,$opac) = @_;
1100   $fwcode='' unless $fwcode;
1101   my %values;
1102   my $dbh = C4::Context->dbh;
1103   my $avcode = GetAuthValCode($kohafield,$fwcode);
1104   if ($avcode) {
1105         my $sth = $dbh->prepare("select authorised_value, lib, lib_opac from authorised_values where category=? ");
1106         $sth->execute($avcode);
1107         while ( my ($val, $lib, $lib_opac) = $sth->fetchrow_array ) {
1108                 $values{$val} = ($opac && $lib_opac) ? $lib_opac : $lib;
1109         }
1110         return \%values;
1111   } else {
1112         return undef;
1113   }
1114 }
1115
1116 =head2 GetKohaAuthorisedValuesFromField
1117
1118 Takes $field, $subfield, $fwcode as parameters.
1119
1120 If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
1121 $subfield can be undefined
1122
1123 Returns hashref of Code => description
1124
1125 Returns undef if no authorised value category is defined for the given field and subfield
1126
1127 =cut
1128
1129 sub GetKohaAuthorisedValuesFromField {
1130   my ($field, $subfield, $fwcode,$opac) = @_;
1131   $fwcode='' unless $fwcode;
1132   my %values;
1133   my $dbh = C4::Context->dbh;
1134   my $avcode = GetAuthValCodeFromField($field, $subfield, $fwcode);
1135   if ($avcode) {
1136         my $sth = $dbh->prepare("select authorised_value, lib, lib_opac from authorised_values where category=? ");
1137         $sth->execute($avcode);
1138         while ( my ($val, $lib, $lib_opac) = $sth->fetchrow_array ) {
1139                 $values{$val} = ($opac && $lib_opac) ? $lib_opac : $lib;
1140         }
1141         return \%values;
1142   } else {
1143         return undef;
1144   }
1145 }
1146
1147 =head2 xml_escape
1148
1149   my $escaped_string = C4::Koha::xml_escape($string);
1150
1151 Convert &, <, >, ', and " in a string to XML entities
1152
1153 =cut
1154
1155 sub xml_escape {
1156     my $str = shift;
1157     return '' unless defined $str;
1158     $str =~ s/&/&amp;/g;
1159     $str =~ s/</&lt;/g;
1160     $str =~ s/>/&gt;/g;
1161     $str =~ s/'/&apos;/g;
1162     $str =~ s/"/&quot;/g;
1163     return $str;
1164 }
1165
1166 =head2 GetKohaAuthorisedValueLib
1167
1168 Takes $category, $authorised_value as parameters.
1169
1170 If $opac parameter is set to a true value, displays OPAC descriptions rather than normal ones when they exist.
1171
1172 Returns authorised value description
1173
1174 =cut
1175
1176 sub GetKohaAuthorisedValueLib {
1177   my ($category,$authorised_value,$opac) = @_;
1178   my $value;
1179   my $dbh = C4::Context->dbh;
1180   my $sth = $dbh->prepare("select lib, lib_opac from authorised_values where category=? and authorised_value=?");
1181   $sth->execute($category,$authorised_value);
1182   my $data = $sth->fetchrow_hashref;
1183   $value = ($opac && $$data{'lib_opac'}) ? $$data{'lib_opac'} : $$data{'lib'};
1184   return $value;
1185 }
1186
1187 =head2 display_marc_indicators
1188
1189   my $display_form = C4::Koha::display_marc_indicators($field);
1190
1191 C<$field> is a MARC::Field object
1192
1193 Generate a display form of the indicators of a variable
1194 MARC field, replacing any blanks with '#'.
1195
1196 =cut
1197
1198 sub display_marc_indicators {
1199     my $field = shift;
1200     my $indicators = '';
1201     if ($field->tag() >= 10) {
1202         $indicators = $field->indicator(1) . $field->indicator(2);
1203         $indicators =~ s/ /#/g;
1204     }
1205     return $indicators;
1206 }
1207
1208 sub GetNormalizedUPC {
1209  my ($record,$marcflavour) = @_;
1210     my (@fields,$upc);
1211
1212     if ($marcflavour eq 'UNIMARC') {
1213         @fields = $record->field('072');
1214         foreach my $field (@fields) {
1215             my $upc = _normalize_match_point($field->subfield('a'));
1216             if ($upc ne '') {
1217                 return $upc;
1218             }
1219         }
1220
1221     }
1222     else { # assume marc21 if not unimarc
1223         @fields = $record->field('024');
1224         foreach my $field (@fields) {
1225             my $indicator = $field->indicator(1);
1226             my $upc = _normalize_match_point($field->subfield('a'));
1227             if ($indicator == 1 and $upc ne '') {
1228                 return $upc;
1229             }
1230         }
1231     }
1232 }
1233
1234 # Normalizes and returns the first valid ISBN found in the record
1235 # ISBN13 are converted into ISBN10. This is required to get Amazon cover book.
1236 sub GetNormalizedISBN {
1237     my ($isbn,$record,$marcflavour) = @_;
1238     my @fields;
1239     if ($isbn) {
1240         # Koha attempts to store multiple ISBNs in biblioitems.isbn, separated by " | "
1241         # anything after " | " should be removed, along with the delimiter
1242         $isbn =~ s/(.*)( \| )(.*)/$1/;
1243         return _isbn_cleanup($isbn);
1244     }
1245     return undef unless $record;
1246
1247     if ($marcflavour eq 'UNIMARC') {
1248         @fields = $record->field('010');
1249         foreach my $field (@fields) {
1250             my $isbn = $field->subfield('a');
1251             if ($isbn) {
1252                 return _isbn_cleanup($isbn);
1253             } else {
1254                 return undef;
1255             }
1256         }
1257     }
1258     else { # assume marc21 if not unimarc
1259         @fields = $record->field('020');
1260         foreach my $field (@fields) {
1261             $isbn = $field->subfield('a');
1262             if ($isbn) {
1263                 return _isbn_cleanup($isbn);
1264             } else {
1265                 return undef;
1266             }
1267         }
1268     }
1269 }
1270
1271 sub GetNormalizedEAN {
1272     my ($record,$marcflavour) = @_;
1273     my (@fields,$ean);
1274
1275     if ($marcflavour eq 'UNIMARC') {
1276         @fields = $record->field('073');
1277         foreach my $field (@fields) {
1278             $ean = _normalize_match_point($field->subfield('a'));
1279             if ($ean ne '') {
1280                 return $ean;
1281             }
1282         }
1283     }
1284     else { # assume marc21 if not unimarc
1285         @fields = $record->field('024');
1286         foreach my $field (@fields) {
1287             my $indicator = $field->indicator(1);
1288             $ean = _normalize_match_point($field->subfield('a'));
1289             if ($indicator == 3 and $ean ne '') {
1290                 return $ean;
1291             }
1292         }
1293     }
1294 }
1295 sub GetNormalizedOCLCNumber {
1296     my ($record,$marcflavour) = @_;
1297     my (@fields,$oclc);
1298
1299     if ($marcflavour eq 'UNIMARC') {
1300         # TODO: add UNIMARC fields
1301     }
1302     else { # assume marc21 if not unimarc
1303         @fields = $record->field('035');
1304         foreach my $field (@fields) {
1305             $oclc = $field->subfield('a');
1306             if ($oclc =~ /OCoLC/) {
1307                 $oclc =~ s/\(OCoLC\)//;
1308                 return $oclc;
1309             } else {
1310                 return undef;
1311             }
1312         }
1313     }
1314 }
1315
1316 =head2 GetDailyQuote($opts)
1317
1318 Takes a hashref of options
1319
1320 Currently supported options are:
1321
1322 'id'        An exact quote id
1323 'random'    Select a random quote
1324 noop        When no option is passed in, this sub will return the quote timestamped for the current day
1325
1326 The function returns an anonymous hash following this format:
1327
1328         {
1329           'source' => 'source-of-quote',
1330           'timestamp' => 'timestamp-value',
1331           'text' => 'text-of-quote',
1332           'id' => 'quote-id'
1333         };
1334
1335 =cut
1336
1337 # This is definitely a candidate for some sort of caching once we finally settle caching/persistence issues...
1338 # at least for default option
1339
1340 sub GetDailyQuote {
1341     my %opts = @_;
1342     my $dbh = C4::Context->dbh;
1343     my $query = '';
1344     my $sth = undef;
1345     my $quote = undef;
1346     if ($opts{'id'}) {
1347         $query = 'SELECT * FROM quotes WHERE id = ?';
1348         $sth = $dbh->prepare($query);
1349         $sth->execute($opts{'id'});
1350         $quote = $sth->fetchrow_hashref();
1351     }
1352     elsif ($opts{'random'}) {
1353         # Fall through... we also return a random quote as a catch-all if all else fails
1354     }
1355     else {
1356         $query = 'SELECT * FROM quotes WHERE timestamp LIKE CONCAT(CURRENT_DATE,\'%\') ORDER BY timestamp DESC LIMIT 0,1';
1357         $sth = $dbh->prepare($query);
1358         $sth->execute();
1359         $quote = $sth->fetchrow_hashref();
1360     }
1361     unless ($quote) {        # if there are not matches, choose a random quote
1362         # get a list of all available quote ids
1363         $sth = C4::Context->dbh->prepare('SELECT count(*) FROM quotes;');
1364         $sth->execute;
1365         my $range = ($sth->fetchrow_array)[0];
1366         if ($range > 1) {
1367             # chose a random id within that range if there is more than one quote
1368             my $id = int(rand($range));
1369             # grab it
1370             $query = 'SELECT * FROM quotes WHERE id = ?;';
1371             $sth = C4::Context->dbh->prepare($query);
1372             $sth->execute($id);
1373         }
1374         else {
1375             $query = 'SELECT * FROM quotes;';
1376             $sth = C4::Context->dbh->prepare($query);
1377             $sth->execute();
1378         }
1379         $quote = $sth->fetchrow_hashref();
1380         # update the timestamp for that quote
1381         $query = 'UPDATE quotes SET timestamp = ? WHERE id = ?';
1382         $sth = C4::Context->dbh->prepare($query);
1383         $sth->execute(DateTime::Format::MySQL->format_datetime(DateTime->now), $quote->{'id'});
1384     }
1385     return $quote;
1386 }
1387
1388 sub _normalize_match_point {
1389     my $match_point = shift;
1390     (my $normalized_match_point) = $match_point =~ /([\d-]*[X]*)/;
1391     $normalized_match_point =~ s/-//g;
1392
1393     return $normalized_match_point;
1394 }
1395
1396 sub _isbn_cleanup {
1397     require Business::ISBN;
1398     my $isbn = Business::ISBN->new( $_[0] );
1399     if ( $isbn ) {
1400         $isbn = $isbn->as_isbn10 if $isbn->type eq 'ISBN13';
1401         if (defined $isbn) {
1402             return $isbn->as_string([]);
1403         }
1404     }
1405     return;
1406 }
1407
1408 1;
1409
1410 __END__
1411
1412 =head1 AUTHOR
1413
1414 Koha Team
1415
1416 =cut