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
24 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
27 # set the version for version checking
39 &CheckBranchCategorycode
43 &GetBranchesInCategory
44 &ModBranchCategoryInfo
48 @EXPORT_OK = qw( &onlymine );
53 C4::Branch - Koha branch module
61 The functions in this module deal with branches.
67 $branches = &GetBranches();
69 Returns informations about ALL branches, IndependantBranches Insensitive.
70 GetBranchInfo() returns the same information without the problems of this function
71 (namespace collision, mainly).
72 Create a branch selector with the following code.
76 my $branches = GetBranches;
78 foreach my $thisbranch (sort keys %$branches) {
79 my $selected = 1 if $thisbranch eq $branch;
80 my %row =(value => $thisbranch,
81 selected => $selected,
82 branchname => $branches->{$thisbranch}->{branchname},
84 push @branchloop, \%row;
89 <select name="branch">
90 <option value="">Default</option>
91 <!-- TMPL_LOOP name="branchloop" -->
92 <option value="<!-- TMPL_VAR name="value" -->" <!-- TMPL_IF name="selected" -->selected<!-- /TMPL_IF -->><!-- TMPL_VAR name="branchname" --></option>
96 =head4 Note that you often will want to just use GetBranchesLoop, for exactly the example above.
102 # returns a reference to a hash of references to ALL branches...
104 my $dbh = C4::Context->dbh;
106 my $query="SELECT * FROM branches";
108 if ($onlymine && C4::Context->userenv && C4::Context->userenv->{branch}){
109 $query .= ' WHERE branchcode = ? ';
110 push @bind_parameters, C4::Context->userenv->{branch};
112 $query.=" ORDER BY branchname";
113 $sth = $dbh->prepare($query);
114 $sth->execute( @bind_parameters );
116 my $nsth = $dbh->prepare(
117 "SELECT categorycode FROM branchrelations WHERE branchcode = ?"
118 ); # prepare once, outside while loop
120 while ( my $branch = $sth->fetchrow_hashref ) {
121 $nsth->execute( $branch->{'branchcode'} );
122 while ( my ($cat) = $nsth->fetchrow_array ) {
123 # FIXME - This seems wrong. It ought to be
124 # $branch->{categorycodes}{$cat} = 1;
125 # otherwise, there's a namespace collision if there's a
126 # category with the same name as a field in the 'branches'
127 # table (i.e., don't create a category called "issuing").
128 # In addition, the current structure doesn't really allow
129 # you to list the categories that a branch belongs to:
130 # you'd have to list keys %$branch, and remove those keys
131 # that aren't fields in the "branches" table.
132 # $branch->{$cat} = 1;
133 $branch->{category}{$cat} = 1;
135 $branches{ $branch->{'branchcode'} } = $branch;
137 return ( \%branches );
142 C4::Context->preference('IndependantBranches') &&
143 C4::Context->userenv &&
144 C4::Context->userenv->{flags}!=1 &&
145 C4::Context->userenv->{branch} ;
148 sub GetBranchesLoop (;$$) { # since this is what most pages want anyway
149 my $branch = @_ ? shift : ''; # optional first argument is branchcode of "my branch", if preselection is wanted.
150 my $onlymine = @_ ? shift : onlymine();
151 my $branches = GetBranches($onlymine);
153 foreach (sort { $branches->{$a}->{branchname} cmp $branches->{$b}->{branchname} } keys %$branches) {
156 selected => ($_ eq $branch) ? 1 : 0,
157 branchname => $branches->{$_}->{branchname},
168 my ($branchcode) = @_;
169 my $dbh = C4::Context->dbh;
171 $sth = $dbh->prepare("Select branchname from branches where branchcode=?");
172 $sth->execute($branchcode);
173 my $branchname = $sth->fetchrow_array;
175 return ($branchname);
180 $error = &ModBranch($newvalue);
182 This function modify an existing branch
184 C<$newvalue> is a ref to an array wich is containt all the column from branches table.
191 my $dbh = C4::Context->dbh;
195 (branchcode,branchname,branchaddress1,
196 branchaddress2,branchaddress3,branchphone,
197 branchfax,branchemail,branchip,branchprinter)
198 VALUES (?,?,?,?,?,?,?,?,?,?)
200 my $sth = $dbh->prepare($query);
202 $data->{'branchcode'}, $data->{'branchname'},
203 $data->{'branchaddress1'}, $data->{'branchaddress2'},
204 $data->{'branchaddress3'}, $data->{'branchphone'},
205 $data->{'branchfax'}, $data->{'branchemail'},
206 $data->{'branchip'}, $data->{'branchprinter'},
208 return 1 if $dbh->err;
212 SET branchname=?,branchaddress1=?,
213 branchaddress2=?,branchaddress3=?,branchphone=?,
214 branchfax=?,branchemail=?,branchip=?,branchprinter=?
217 my $sth = $dbh->prepare($query);
219 $data->{'branchname'},
220 $data->{'branchaddress1'}, $data->{'branchaddress2'},
221 $data->{'branchaddress3'}, $data->{'branchphone'},
222 $data->{'branchfax'}, $data->{'branchemail'},
223 $data->{'branchip'}, $data->{'branchprinter'},
224 $data->{'branchcode'},
227 # sort out the categories....
229 my $cats = GetBranchCategory();
230 foreach my $cat (@$cats) {
231 my $code = $cat->{'categorycode'};
232 if ( $data->{$code} ) {
233 push( @checkedcats, $code );
236 my $branchcode = uc( $data->{'branchcode'} );
237 my $branch = GetBranchInfo($branchcode);
238 $branch = $branch->[0];
239 my $branchcats = $branch->{'categories'};
242 foreach my $bcat (@$branchcats) {
244 unless ( grep { /^$bcat$/ } @checkedcats ) {
245 push( @removecats, $bcat );
248 foreach my $ccat (@checkedcats) {
249 unless ( grep { /^$ccat$/ } @$branchcats ) {
250 push( @addcats, $ccat );
253 foreach my $cat (@addcats) {
256 "insert into branchrelations (branchcode, categorycode) values(?, ?)"
258 $sth->execute( $branchcode, $cat );
261 foreach my $cat (@removecats) {
264 "delete from branchrelations where branchcode=? and categorycode=?"
266 $sth->execute( $branchcode, $cat );
271 =head2 GetBranchCategory
273 $results = GetBranchCategory($categorycode);
275 C<$results> is an ref to an array.
279 sub GetBranchCategory {
281 # returns a reference to an array of hashes containing branches,
283 my $dbh = C4::Context->dbh;
286 # print DEBUG "GetBranchCategory: entry: catcode=".cvs($catcode)."\n";
290 "select * from branchcategories where categorycode = ?");
291 $sth->execute($catcode);
294 $sth = $dbh->prepare("Select * from branchcategories");
298 while ( my $data = $sth->fetchrow_hashref ) {
299 push( @results, $data );
303 # print DEBUG "GetBranchCategory: exit: returning ".cvs(\@results)."\n";
307 =head2 GetBranchCategories
309 my $categories = GetBranchCategories($branchcode,$categorytype);
311 Returns a list ref of anon hashrefs with keys eq columns of branchcategories table,
312 i.e. categorycode, categorydescription, categorytype, categoryname.
313 if $branchcode and/or $categorytype are passed, limit set to categories that
314 $branchcode is a member of , and to $categorytype.
318 sub GetBranchCategories {
319 my ($branchcode,$categorytype) = @_;
320 my $dbh = C4::Context->dbh();
321 my $query = "SELECT c.* FROM branchcategories c";
324 $query .= ",branchrelations r, branches b ";
325 push @where, "c.categorycode=r.categorycode and r.branchcode=? ";
326 push @bind , $branchcode;
329 push @where, " c.categorytype=? ";
330 push @bind, $categorytype;
332 $query .= " where " . join(" and ", @where) if(@where);
333 $query .= " order by categorytype,c.categorycode";
334 my $sth=$dbh->prepare( $query);
335 $sth->execute(@bind);
337 my $branchcats = $sth->fetchall_arrayref({});
339 return( $branchcats );
342 =head2 GetCategoryTypes
344 $categorytypes = GetCategoryTypes;
345 returns a list of category types.
346 Currently these types are HARDCODED.
347 type: 'searchdomain' defines a group of agencies that the calling library may search in.
348 Other usage of agency categories falls under type: 'properties'.
349 to allow for other uses of categories.
350 The searchdomain bit may be better implemented as a separate module, but
351 the categories were already here, and minimally used.
354 #TODO manage category types. rename possibly to 'agency domains' ? as borrowergroups are called categories.
355 sub GetCategoryTypes() {
356 return ( 'searchdomain','properties');
361 $branch = GetBranch( $query, $branches );
366 my ( $query, $branches ) = @_; # get branch for this query from branches
367 my $branch = $query->param('branch');
368 my %cookie = $query->cookie('userenv');
369 ($branch) || ($branch = $cookie{'branchname'});
370 ( $branches->{$branch} ) || ( $branch = ( keys %$branches )[0] );
374 =head2 GetBranchDetail
376 $branchname = &GetBranchDetail($branchcode);
378 Given the branch code, the function returns the corresponding
379 branch name for a comprehensive information display
383 sub GetBranchDetail {
384 my ($branchcode) = @_;
385 my $dbh = C4::Context->dbh;
386 my $sth = $dbh->prepare("SELECT * FROM branches WHERE branchcode = ?");
387 $sth->execute($branchcode);
388 my $branchname = $sth->fetchrow_hashref();
393 =head2 get_branchinfos_of
395 my $branchinfos_of = get_branchinfos_of(@branchcodes);
397 Associates a list of branchcodes to the information of the branch, taken in
400 Returns a href where keys are branchcodes and values are href where keys are
401 branch information key.
403 print 'branchname is ', $branchinfos_of->{$code}->{branchname};
407 sub get_branchinfos_of {
408 my @branchcodes = @_;
414 WHERE branchcode IN ('
415 . join( ',', map( { "'" . $_ . "'" } @branchcodes ) ) . ')
417 return C4::Koha::get_infos_of( $query, 'branchcode' );
421 =head2 GetBranchesInCategory
423 my $branches = GetBranchesInCategory($categorycode);
425 Returns a href: keys %$branches eq (branchcode,branchname) .
429 sub GetBranchesInCategory($) {
430 my ($categorycode) = @_;
432 my $dbh = C4::Context->dbh();
433 my $sth=$dbh->prepare( "SELECT b.branchcode FROM branchrelations r, branches b
434 where r.branchcode=b.branchcode and r.categorycode=?");
435 $sth->execute($categorycode);
436 while (my $branch = $sth->fetchrow) {
437 push @branches, $branch;
440 return( \@branches );
445 $results = GetBranchInfo($branchcode);
447 returns C<$results>, a reference to an array of hashes containing branches.
448 if $branchcode, just this branch, with associated categories.
449 if ! $branchcode && $categorytype, all branches in the category.
453 my ($branchcode,$categorytype) = @_;
454 my $dbh = C4::Context->dbh;
461 "Select * from branches where branchcode = ? order by branchcode");
462 $sth->execute($branchcode);
465 $sth = $dbh->prepare("Select * from branches order by branchcode");
469 while ( my $data = $sth->fetchrow_hashref ) {
470 my @bind = ($data->{'branchcode'});
471 my $query= "select r.categorycode from branchrelations r";
472 $query .= ", branchcategories c " if($categorytype);
473 $query .= " where branchcode=? ";
475 $query .= " and c.categorytype=? and r.categorycode=c.categorycode";
476 push @bind, $categorytype;
478 my $nsth=$dbh->prepare($query);
479 $nsth->execute( @bind );
481 while ( my ($cat) = $nsth->fetchrow_array ) {
485 $data->{'categories'} = \@cats;
486 push( @results, $data );
494 &DelBranch($branchcode);
499 my ($branchcode) = @_;
500 my $dbh = C4::Context->dbh;
501 my $sth = $dbh->prepare("delete from branches where branchcode = ?");
502 $sth->execute($branchcode);
506 =head2 ModBranchCategoryInfo
508 &ModBranchCategoryInfo($data);
509 sets the data from the editbranch form, and writes to the database...
513 sub ModBranchCategoryInfo {
515 my $dbh = C4::Context->dbh;
517 # we are doing an insert
518 my $sth = $dbh->prepare("INSERT INTO branchcategories (categorycode,categoryname,codedescription,categorytype) VALUES (?,?,?,?)");
519 $sth->execute(uc( $data->{'categorycode'} ),$data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'} );
524 my $sth = $dbh->prepare("UPDATE branchcategories SET categoryname=?,codedescription=?,categorytype=? WHERE categorycode=?");
525 $sth->execute($data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'},uc( $data->{'categorycode'} ) );
530 =head2 DeleteBranchCategory
532 DeleteBranchCategory($categorycode);
536 sub DelBranchCategory {
537 my ($categorycode) = @_;
538 my $dbh = C4::Context->dbh;
539 my $sth = $dbh->prepare("delete from branchcategories where categorycode = ?");
540 $sth->execute($categorycode);
544 =head2 CheckBranchCategorycode
546 $number_rows_affected = CheckBranchCategorycode($categorycode);
550 sub CheckBranchCategorycode {
552 # check to see if the branchcode is being used in the database somewhere....
553 my ($categorycode) = @_;
554 my $dbh = C4::Context->dbh;
557 "select count(*) from branchrelations where categorycode=?");
558 $sth->execute($categorycode);
559 my ($total) = $sth->fetchrow_array;
568 Koha Developement team <info@koha.org>