package C4::Koha; # Copyright 2000-2002 Katipo Communications # # This file is part of Koha. # # Koha is free software; you can redistribute it and/or modify it under the # terms of the GNU General Public License as published by the Free Software # Foundation; either version 2 of the License, or (at your option) any later # version. # # Koha is distributed in the hope that it will be useful, but WITHOUT ANY # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR # A PARTICULAR PURPOSE. See the GNU General Public License for more details. # # You should have received a copy of the GNU General Public License along with # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place, # Suite 330, Boston, MA 02111-1307 USA use strict; require Exporter; use C4::Context; use vars qw($VERSION @ISA @EXPORT); $VERSION = 0.01; =head1 NAME C4::Koha - Perl Module containing convenience functions for Koha scripts =head1 SYNOPSIS use C4::Koha; $date = slashifyDate("01-01-2002") $ethnicity = fixEthnicity('asian'); ($categories, $labels) = borrowercategories(); ($categories, $labels) = ethnicitycategories(); =head1 DESCRIPTION Koha.pm provides many functions for Koha scripts. =head1 FUNCTIONS =over 2 =cut @ISA = qw(Exporter); @EXPORT = qw( &fixEthnicity &borrowercategories &getborrowercategory ðnicitycategories &subfield_is_koha_internal_p &getbranches &getbranch &getbranchdetail &getprinters &getprinter &getitemtypes &getitemtypeinfo &getframeworks &getframeworkinfo &getauthtypes &getauthtype &getallthemes &getalllanguages &getallbranches $DEBUG); use vars qw(); my $DEBUG = 0; # removed slashifyDate => useless =head2 fixEthnicity $ethn_name = &fixEthnicity($ethn_code); Takes an ethnicity code (e.g., "european" or "pi") and returns the corresponding descriptive name from the C table in the Koha database ("European" or "Pacific Islander"). =cut #' sub fixEthnicity($) { my $ethnicity = shift; my $dbh = C4::Context->dbh; my $sth=$dbh->prepare("Select name from ethnicity where code = ?"); $sth->execute($ethnicity); my $data=$sth->fetchrow_hashref; $sth->finish; return $data->{'name'}; } =head2 borrowercategories ($codes_arrayref, $labels_hashref) = &borrowercategories(); Looks up the different types of borrowers in the database. Returns two elements: a reference-to-array, which lists the borrower category codes, and a reference-to-hash, which maps the borrower category codes to category descriptions. =cut #' sub borrowercategories { my $dbh = C4::Context->dbh; my $sth=$dbh->prepare("Select categorycode,description from categories order by description"); $sth->execute; my %labels; my @codes; while (my $data=$sth->fetchrow_hashref){ push @codes,$data->{'categorycode'}; $labels{$data->{'categorycode'}}=$data->{'description'}; } $sth->finish; return(\@codes,\%labels); } =item getborrowercategory $description = &getborrowercategory($categorycode); Given the borrower's category code, the function returns the corresponding description for a comprehensive information display. =cut sub getborrowercategory { my ($catcode) = @_; my $dbh = C4::Context->dbh; my $sth = $dbh->prepare("SELECT description FROM categories WHERE categorycode = ?"); $sth->execute($catcode); my $description = $sth->fetchrow(); $sth->finish(); return $description; } # sub getborrowercategory =head2 ethnicitycategories ($codes_arrayref, $labels_hashref) = ðnicitycategories(); Looks up the different ethnic types in the database. Returns two elements: a reference-to-array, which lists the ethnicity codes, and a reference-to-hash, which maps the ethnicity codes to ethnicity descriptions. =cut #' sub ethnicitycategories { my $dbh = C4::Context->dbh; my $sth=$dbh->prepare("Select code,name from ethnicity order by name"); $sth->execute; my %labels; my @codes; while (my $data=$sth->fetchrow_hashref){ push @codes,$data->{'code'}; $labels{$data->{'code'}}=$data->{'name'}; } $sth->finish; return(\@codes,\%labels); } # 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 return length $subfield != 1; } =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 =cut sub getbranches { # returns a reference to a hash of references to branches... my %branches; 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 (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; } return (\%branches); } =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; } =head3 in TEMPLATE =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; } return (\%branches); } =head2 getitemtypes $itemtypes = &getitemtypes(); Returns information about existing itemtypes. 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); =head3 in TEMPLATE
">
=cut sub getitemtypes { # returns a reference to a hash of references to branches... my %itemtypes; my $dbh = C4::Context->dbh; my $sth=$dbh->prepare("select * from itemtypes"); $sth->execute; while (my $IT=$sth->fetchrow_hashref) { $itemtypes{$IT->{'itemtype'}}=$IT; } return (\%itemtypes); } =head2 getauthtypes $authtypes = &getauthtypes(); Returns information about existing authtypes. build a HTML select with the following code : =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, selected => $selected, authtypetext => $authtypes->{$thisauthtype}->{'authtypetext'}, ); push @authtypesloop, \%row; } $template->param(itemtypeloop => \@itemtypesloop); =head3 in TEMPLATE
">
=cut sub getauthtypes { # 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"); $sth->execute; while (my $IT=$sth->fetchrow_hashref) { $authtypes{$IT->{'authtypecode'}}=$IT; } return (\%authtypes); } sub getauthtype { my ($authtypecode) = @_; # 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=?"); $sth->execute($authtypecode); my $res=$sth->fetchrow_hashref; return $res; } =head2 getframework $frameworks = &getframework(); Returns information about existing frameworks build a HTML select with the following code : =head3 in PERL SCRIPT 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); =head3 in TEMPLATE
">
=cut sub getframeworks { # 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"); $sth->execute; while (my $IT=$sth->fetchrow_hashref) { $itemtypes{$IT->{'frameworkcode'}}=$IT; } return (\%itemtypes); } =head2 getframeworkinfo $frameworkinfo = &getframeworkinfo($frameworkcode); Returns information about an frameworkcode. =cut sub getframeworkinfo { my ($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); Returns information about an itemtype. =cut sub getitemtypeinfo { my ($itemtype) = @_; my $dbh = C4::Context->dbh; my $sth=$dbh->prepare("select * from itemtypes where itemtype=?"); $sth->execute($itemtype); my $res = $sth->fetchrow_hashref; return $res; } =head2 getprinters $printers = &getprinters($env); @queues = keys %$printers; Returns information about existing printer queues. C<$env> is ignored. 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 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; } 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; } =item getbranchdetail $branchname = &getbranchdetail($branchcode); Given the branch code, the function returns the corresponding branch name for a comprehensive information display =cut 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 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; } =item getalllanguages (@languages) = &getalllanguages($type); (@languages) = &getalllanguages($type,$theme); Returns an array of all available languages. =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$/; 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$/; $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$/; 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$/; $lang->{$language}=1; } } @languages=keys %$lang; return sort @languages; } } 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$/; $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$/; $lang->{$language}=1; } } @languages=keys %$lang; return sort @languages; } } =item getallthemes (@themes) = &getallthemes('opac'); (@themes) = &getallthemes('intranet'); Returns an array of all available themes. =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; } return @themes; } 1; __END__ =back =head1 AUTHOR Koha Team =cut