3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
14 # You should have received a copy of the GNU General Public License along with
15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
16 # Suite 330, Boston, MA 02111-1307 USA
20 #use warnings; FIXME - Bug 2505
24 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
27 # set the version for version checking
28 $VERSION = 3.07.00.049;
39 &CheckBranchCategorycode
43 &GetBranchesInCategory
44 &ModBranchCategoryInfo
51 @EXPORT_OK = qw( &onlymine &mybranch get_branch_code_from_name );
56 C4::Branch - Koha branch module
64 The functions in this module deal with branches.
70 $branches = &GetBranches();
72 Returns informations about ALL branches, IndependantBranches Insensitive.
73 GetBranchInfo() returns the same information without the problems of this function
74 (namespace collision, mainly).
76 Create a branch selector with the following code.
80 my $branches = GetBranches;
82 foreach my $thisbranch (sort keys %$branches) {
83 my $selected = 1 if $thisbranch eq $branch;
84 my %row =(value => $thisbranch,
85 selected => $selected,
86 branchname => $branches->{$thisbranch}->{branchname},
88 push @branchloop, \%row;
93 <select name="branch">
94 <option value="">Default</option>
95 <!-- TMPL_LOOP name="branchloop" -->
96 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="branchname" --></option>
100 =head4 Note that you often will want to just use GetBranchesLoop, for exactly the example above.
106 # returns a reference to a hash of references to ALL branches...
108 my $dbh = C4::Context->dbh;
110 my $query="SELECT * FROM branches";
112 if ($onlymine && C4::Context->userenv && C4::Context->userenv->{branch}){
113 $query .= ' WHERE branchcode = ? ';
114 push @bind_parameters, C4::Context->userenv->{branch};
116 $query.=" ORDER BY branchname";
117 $sth = $dbh->prepare($query);
118 $sth->execute( @bind_parameters );
120 my $nsth = $dbh->prepare(
121 "SELECT categorycode FROM branchrelations WHERE branchcode = ?"
122 ); # prepare once, outside while loop
124 while ( my $branch = $sth->fetchrow_hashref ) {
125 $nsth->execute( $branch->{'branchcode'} );
126 while ( my ($cat) = $nsth->fetchrow_array ) {
127 # FIXME - This seems wrong. It ought to be
128 # $branch->{categorycodes}{$cat} = 1;
129 # otherwise, there's a namespace collision if there's a
130 # category with the same name as a field in the 'branches'
131 # table (i.e., don't create a category called "issuing").
132 # In addition, the current structure doesn't really allow
133 # you to list the categories that a branch belongs to:
134 # you'd have to list keys %$branch, and remove those keys
135 # that aren't fields in the "branches" table.
136 # $branch->{$cat} = 1;
137 $branch->{category}{$cat} = 1;
139 $branches{ $branch->{'branchcode'} } = $branch;
141 return ( \%branches );
146 C4::Context->preference('IndependantBranches') &&
147 C4::Context->userenv &&
148 C4::Context->userenv->{flags} %2 != 1 &&
149 C4::Context->userenv->{branch} ;
152 # always returns a string for OK comparison via "eq" or "ne"
154 C4::Context->userenv or return '';
155 return C4::Context->userenv->{branch} || '';
158 sub GetBranchesLoop { # since this is what most pages want anyway
159 my $branch = @_ ? shift : mybranch(); # optional first argument is branchcode of "my branch", if preselection is wanted.
160 my $onlymine = @_ ? shift : onlymine();
161 my $branches = GetBranches($onlymine);
163 foreach ( sort { uc($branches->{$a}->{branchname}) cmp uc($branches->{$b}->{branchname}) } keys %$branches ) {
166 selected => ($_ eq $branch) ? 1 : 0,
167 branchname => $branches->{$_}->{branchname},
178 my ($branchcode) = @_;
179 my $dbh = C4::Context->dbh;
181 $sth = $dbh->prepare("Select branchname from branches where branchcode=?");
182 $sth->execute($branchcode);
183 my $branchname = $sth->fetchrow_array;
185 return ($branchname);
190 $error = &ModBranch($newvalue);
192 This function modify an existing branch
194 C<$newvalue> is a ref to an array wich is containt all the column from branches table.
201 my $dbh = C4::Context->dbh;
205 (branchcode,branchname,branchaddress1,
206 branchaddress2,branchaddress3,branchzip,branchcity,branchstate,
207 branchcountry,branchphone,branchfax,branchemail,
208 branchurl,branchip,branchprinter,branchnotes,opac_info)
209 VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
211 my $sth = $dbh->prepare($query);
213 $data->{'branchcode'}, $data->{'branchname'},
214 $data->{'branchaddress1'}, $data->{'branchaddress2'},
215 $data->{'branchaddress3'}, $data->{'branchzip'},
216 $data->{'branchcity'}, $data->{'branchstate'},
217 $data->{'branchcountry'},
218 $data->{'branchphone'}, $data->{'branchfax'},
219 $data->{'branchemail'}, $data->{'branchurl'},
220 $data->{'branchip'}, $data->{'branchprinter'},
221 $data->{'branchnotes'}, $data->{opac_info},
223 return 1 if $dbh->err;
227 SET branchname=?,branchaddress1=?,
228 branchaddress2=?,branchaddress3=?,branchzip=?,
229 branchcity=?,branchstate=?,branchcountry=?,branchphone=?,
230 branchfax=?,branchemail=?,branchurl=?,branchip=?,
231 branchprinter=?,branchnotes=?,opac_info=?
234 my $sth = $dbh->prepare($query);
236 $data->{'branchname'},
237 $data->{'branchaddress1'}, $data->{'branchaddress2'},
238 $data->{'branchaddress3'}, $data->{'branchzip'},
239 $data->{'branchcity'}, $data->{'branchstate'},
240 $data->{'branchcountry'},
241 $data->{'branchphone'}, $data->{'branchfax'},
242 $data->{'branchemail'}, $data->{'branchurl'},
243 $data->{'branchip'}, $data->{'branchprinter'},
244 $data->{'branchnotes'}, $data->{opac_info},
245 $data->{'branchcode'},
248 # sort out the categories....
250 my $cats = GetBranchCategory();
251 foreach my $cat (@$cats) {
252 my $code = $cat->{'categorycode'};
253 if ( $data->{$code} ) {
254 push( @checkedcats, $code );
257 my $branchcode = uc( $data->{'branchcode'} );
258 my $branch = GetBranchInfo($branchcode);
259 $branch = $branch->[0];
260 my $branchcats = $branch->{'categories'};
263 foreach my $bcat (@$branchcats) {
265 unless ( grep { /^$bcat$/ } @checkedcats ) {
266 push( @removecats, $bcat );
269 foreach my $ccat (@checkedcats) {
270 unless ( grep { /^$ccat$/ } @$branchcats ) {
271 push( @addcats, $ccat );
274 foreach my $cat (@addcats) {
277 "insert into branchrelations (branchcode, categorycode) values(?, ?)"
279 $sth->execute( $branchcode, $cat );
282 foreach my $cat (@removecats) {
285 "delete from branchrelations where branchcode=? and categorycode=?"
287 $sth->execute( $branchcode, $cat );
292 =head2 GetBranchCategory
294 $results = GetBranchCategory($categorycode);
296 C<$results> is an ref to an array.
300 sub GetBranchCategory {
302 # returns a reference to an array of hashes containing branches,
304 my $dbh = C4::Context->dbh;
307 # print DEBUG "GetBranchCategory: entry: catcode=".cvs($catcode)."\n";
311 "select * from branchcategories where categorycode = ?");
312 $sth->execute($catcode);
315 $sth = $dbh->prepare("Select * from branchcategories");
319 while ( my $data = $sth->fetchrow_hashref ) {
320 push( @results, $data );
324 # print DEBUG "GetBranchCategory: exit: returning ".cvs(\@results)."\n";
328 =head2 GetBranchCategories
330 my $categories = GetBranchCategories($branchcode,$categorytype);
332 Returns a list ref of anon hashrefs with keys eq columns of branchcategories table,
333 i.e. categorycode, categorydescription, categorytype, categoryname.
334 if $branchcode and/or $categorytype are passed, limit set to categories that
335 $branchcode is a member of , and to $categorytype.
339 sub GetBranchCategories {
340 my ($branchcode,$categorytype) = @_;
341 my $dbh = C4::Context->dbh();
342 my $query = "SELECT c.* FROM branchcategories c";
345 $query .= ",branchrelations r, branches b ";
346 push @where, "c.categorycode=r.categorycode and r.branchcode=? ";
347 push @bind , $branchcode;
350 push @where, " c.categorytype=? ";
351 push @bind, $categorytype;
353 $query .= " where " . join(" and ", @where) if(@where);
354 $query .= " order by categorytype,c.categorycode";
355 my $sth=$dbh->prepare( $query);
356 $sth->execute(@bind);
358 my $branchcats = $sth->fetchall_arrayref({});
360 return( $branchcats );
363 =head2 GetCategoryTypes
365 $categorytypes = GetCategoryTypes;
366 returns a list of category types.
367 Currently these types are HARDCODED.
368 type: 'searchdomain' defines a group of agencies that the calling library may search in.
369 Other usage of agency categories falls under type: 'properties'.
370 to allow for other uses of categories.
371 The searchdomain bit may be better implemented as a separate module, but
372 the categories were already here, and minimally used.
375 #TODO manage category types. rename possibly to 'agency domains' ? as borrowergroups are called categories.
376 sub GetCategoryTypes {
377 return ( 'searchdomain','properties');
382 $branch = GetBranch( $query, $branches );
387 my ( $query, $branches ) = @_; # get branch for this query from branches
388 my $branch = $query->param('branch');
389 my %cookie = $query->cookie('userenv');
390 ($branch) || ($branch = $cookie{'branchname'});
391 ( $branches->{$branch} ) || ( $branch = ( keys %$branches )[0] );
395 =head2 GetBranchDetail
397 $branch = &GetBranchDetail($branchcode);
399 Given the branch code, the function returns a
400 hashref for the corresponding row in the branches table.
404 sub GetBranchDetail {
405 my ($branchcode) = shift or return;
406 my $sth = C4::Context->dbh->prepare("SELECT * FROM branches WHERE branchcode = ?");
407 $sth->execute($branchcode);
408 return $sth->fetchrow_hashref();
411 =head2 GetBranchesInCategory
413 my $branches = GetBranchesInCategory($categorycode);
415 Returns a href: keys %$branches eq (branchcode,branchname) .
419 sub GetBranchesInCategory {
420 my ($categorycode) = @_;
422 my $dbh = C4::Context->dbh();
423 my $sth=$dbh->prepare( "SELECT b.branchcode FROM branchrelations r, branches b
424 where r.branchcode=b.branchcode and r.categorycode=?");
425 $sth->execute($categorycode);
426 while (my $branch = $sth->fetchrow) {
427 push @branches, $branch;
430 return( \@branches );
435 $results = GetBranchInfo($branchcode);
437 returns C<$results>, a reference to an array of hashes containing branches.
438 if $branchcode, just this branch, with associated categories.
439 if ! $branchcode && $categorytype, all branches in the category.
443 my ($branchcode,$categorytype) = @_;
444 my $dbh = C4::Context->dbh;
451 "Select * from branches where branchcode = ? order by branchcode");
452 $sth->execute($branchcode);
455 $sth = $dbh->prepare("Select * from branches order by branchcode");
459 while ( my $data = $sth->fetchrow_hashref ) {
460 my @bind = ($data->{'branchcode'});
461 my $query= "select r.categorycode from branchrelations r";
462 $query .= ", branchcategories c " if($categorytype);
463 $query .= " where branchcode=? ";
465 $query .= " and c.categorytype=? and r.categorycode=c.categorycode";
466 push @bind, $categorytype;
468 my $nsth=$dbh->prepare($query);
469 $nsth->execute( @bind );
471 while ( my ($cat) = $nsth->fetchrow_array ) {
475 $data->{'categories'} = \@cats;
476 push( @results, $data );
484 &DelBranch($branchcode);
489 my ($branchcode) = @_;
490 my $dbh = C4::Context->dbh;
491 my $sth = $dbh->prepare("delete from branches where branchcode = ?");
492 $sth->execute($branchcode);
496 =head2 ModBranchCategoryInfo
498 &ModBranchCategoryInfo($data);
499 sets the data from the editbranch form, and writes to the database...
503 sub ModBranchCategoryInfo {
505 my $dbh = C4::Context->dbh;
507 # we are doing an insert
508 my $sth = $dbh->prepare("INSERT INTO branchcategories (categorycode,categoryname,codedescription,categorytype) VALUES (?,?,?,?)");
509 $sth->execute(uc( $data->{'categorycode'} ),$data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'} );
514 my $sth = $dbh->prepare("UPDATE branchcategories SET categoryname=?,codedescription=?,categorytype=? WHERE categorycode=?");
515 $sth->execute($data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'},uc( $data->{'categorycode'} ) );
520 =head2 CheckCategoryUnique
522 if (CheckCategoryUnique($categorycode)){
528 sub CheckCategoryUnique {
529 my $categorycode = shift;
530 my $dbh = C4::Context->dbh;
531 my $sth = $dbh->prepare("SELECT categorycode FROM branchcategories WHERE categorycode = ?");
532 $sth->execute(uc( $categorycode) );
533 if (my $data = $sth->fetchrow_hashref){
542 =head2 DeleteBranchCategory
544 DeleteBranchCategory($categorycode);
548 sub DelBranchCategory {
549 my ($categorycode) = @_;
550 my $dbh = C4::Context->dbh;
551 my $sth = $dbh->prepare("delete from branchcategories where categorycode = ?");
552 $sth->execute($categorycode);
556 =head2 CheckBranchCategorycode
558 $number_rows_affected = CheckBranchCategorycode($categorycode);
562 sub CheckBranchCategorycode {
564 # check to see if the branchcode is being used in the database somewhere....
565 my ($categorycode) = @_;
566 my $dbh = C4::Context->dbh;
569 "select count(*) from branchrelations where categorycode=?");
570 $sth->execute($categorycode);
571 my ($total) = $sth->fetchrow_array;
575 sub get_branch_code_from_name {
576 my @branch_name = @_;
577 my $query = "SELECT branchcode FROM branches WHERE branchname=?;";
578 my $dbh = C4::Context->dbh();
579 my $sth = $dbh->prepare($query);
580 $sth->execute(@branch_name);
581 return $sth->fetchrow_array;
584 sub GetBranchesCount {
585 my $dbh = C4::Context->dbh();
586 my $query = "SELECT COUNT(*) AS branches_count FROM branches";
587 my $sth = $dbh->prepare( $query );
589 my $row = $sth->fetchrow_hashref();
590 return $row->{'branches_count'};
598 Koha Development Team <http://koha-community.org/>