bug 8215: (followup) make sure C4::CourseReserves doesn't export anything
[koha.git] / C4 / Branch.pm
1 package C4::Branch;
2
3 # This file is part of Koha.
4 #
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
8 # version.
9 #
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.
13 #
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
17
18
19 use strict;
20 #use warnings; FIXME - Bug 2505
21 require Exporter;
22 use C4::Context;
23
24 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
25
26 BEGIN {
27         # set the version for version checking
28     $VERSION = 3.07.00.049;
29         @ISA    = qw(Exporter);
30         @EXPORT = qw(
31                 &GetBranchCategory
32                 &GetBranchName
33                 &GetBranch
34                 &GetBranches
35                 &GetBranchesLoop
36                 &GetBranchDetail
37                 &get_branchinfos_of
38                 &ModBranch
39                 &CheckBranchCategorycode
40                 &GetBranchInfo
41                 &GetCategoryTypes
42                 &GetBranchCategories
43                 &GetBranchesInCategory
44                 &ModBranchCategoryInfo
45                 &DelBranch
46                 &DelBranchCategory
47                 &CheckCategoryUnique
48                 &mybranch
49                 &GetBranchesCount
50         );
51         @EXPORT_OK = qw( &onlymine &mybranch get_branch_code_from_name );
52 }
53
54 =head1 NAME
55
56 C4::Branch - Koha branch module
57
58 =head1 SYNOPSIS
59
60 use C4::Branch;
61
62 =head1 DESCRIPTION
63
64 The functions in this module deal with branches.
65
66 =head1 FUNCTIONS
67
68 =head2 GetBranches
69
70   $branches = &GetBranches();
71
72 Returns informations about ALL branches, IndependantBranches Insensitive.
73 GetBranchInfo() returns the same information without the problems of this function 
74 (namespace collision, mainly).
75
76 Create a branch selector with the following code.
77
78 =head3 in PERL SCRIPT
79
80     my $branches = GetBranches;
81     my @branchloop;
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},
87                 );
88         push @branchloop, \%row;
89     }
90
91 =head3 in TEMPLATE
92
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>
97         <!-- /TMPL_LOOP -->
98     </select>
99
100 =head4 Note that you often will want to just use GetBranchesLoop, for exactly the example above.
101
102 =cut
103
104 sub GetBranches {
105     my ($onlymine)=@_;
106     # returns a reference to a hash of references to ALL branches...
107     my %branches;
108     my $dbh = C4::Context->dbh;
109     my $sth;
110     my $query="SELECT * FROM branches";
111     my @bind_parameters;
112     if ($onlymine && C4::Context->userenv && C4::Context->userenv->{branch}){
113       $query .= ' WHERE branchcode = ? ';
114       push @bind_parameters, C4::Context->userenv->{branch};
115     }
116         $query.=" ORDER BY branchname";
117     $sth = $dbh->prepare($query);
118     $sth->execute( @bind_parameters );
119
120     my $nsth = $dbh->prepare(
121         "SELECT categorycode FROM branchrelations WHERE branchcode = ?"
122     );  # prepare once, outside while loop
123
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;
138         }
139         $branches{ $branch->{'branchcode'} } = $branch;
140     }
141     return ( \%branches );
142 }
143
144 sub onlymine {
145     return 
146     C4::Context->preference('IndependantBranches') &&
147     C4::Context->userenv                           &&
148     C4::Context->userenv->{flags} %2 != 1          &&
149     C4::Context->userenv->{branch}                 ;
150 }
151
152 # always returns a string for OK comparison via "eq" or "ne"
153 sub mybranch {
154     C4::Context->userenv           or return '';
155     return C4::Context->userenv->{branch} || '';
156 }
157
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);
162     my @loop;
163     foreach my $branchcode ( sort { uc($branches->{$a}->{branchname}) cmp uc($branches->{$b}->{branchname}) } keys %$branches ) {
164         push @loop, {
165             value      => $branchcode,
166             branchcode => $branchcode,
167             selected   => ($branchcode eq $branch) ? 1 : 0,
168             branchname => $branches->{$branchcode}->{branchname},
169         };
170     }
171     return \@loop;
172 }
173
174 =head2 GetBranchName
175
176 =cut
177
178 sub GetBranchName {
179     my ($branchcode) = @_;
180     my $dbh = C4::Context->dbh;
181     my $sth;
182     $sth = $dbh->prepare("Select branchname from branches where branchcode=?");
183     $sth->execute($branchcode);
184     my $branchname = $sth->fetchrow_array;
185     $sth->finish;
186     return ($branchname);
187 }
188
189 =head2 ModBranch
190
191 $error = &ModBranch($newvalue);
192
193 This function modify an existing branch
194
195 C<$newvalue> is a ref to an array wich is containt all the column from branches table.
196
197 =cut
198
199 sub ModBranch {
200     my ($data) = @_;
201     
202     my $dbh    = C4::Context->dbh;
203     if ($data->{add}) {
204         my $query  = "
205             INSERT INTO branches
206             (branchcode,branchname,branchaddress1,
207             branchaddress2,branchaddress3,branchzip,branchcity,branchstate,
208             branchcountry,branchphone,branchfax,branchemail,
209             branchurl,branchip,branchprinter,branchnotes,opac_info)
210             VALUES (?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)
211         ";
212         my $sth    = $dbh->prepare($query);
213         $sth->execute(
214             $data->{'branchcode'},       $data->{'branchname'},
215             $data->{'branchaddress1'},   $data->{'branchaddress2'},
216             $data->{'branchaddress3'},   $data->{'branchzip'},
217             $data->{'branchcity'},       $data->{'branchstate'},
218             $data->{'branchcountry'},
219             $data->{'branchphone'},      $data->{'branchfax'},
220             $data->{'branchemail'},      $data->{'branchurl'},
221             $data->{'branchip'},         $data->{'branchprinter'},
222             $data->{'branchnotes'},      $data->{opac_info},
223         );
224         return 1 if $dbh->err;
225     } else {
226         my $query  = "
227             UPDATE branches
228             SET branchname=?,branchaddress1=?,
229                 branchaddress2=?,branchaddress3=?,branchzip=?,
230                 branchcity=?,branchstate=?,branchcountry=?,branchphone=?,
231                 branchfax=?,branchemail=?,branchurl=?,branchip=?,
232                 branchprinter=?,branchnotes=?,opac_info=?
233             WHERE branchcode=?
234         ";
235         my $sth    = $dbh->prepare($query);
236         $sth->execute(
237             $data->{'branchname'},
238             $data->{'branchaddress1'},   $data->{'branchaddress2'},
239             $data->{'branchaddress3'},   $data->{'branchzip'},
240             $data->{'branchcity'},       $data->{'branchstate'},       
241             $data->{'branchcountry'},
242             $data->{'branchphone'},      $data->{'branchfax'},
243             $data->{'branchemail'},      $data->{'branchurl'},
244             $data->{'branchip'},         $data->{'branchprinter'},
245             $data->{'branchnotes'},      $data->{opac_info},
246             $data->{'branchcode'},
247         );
248     }
249     # sort out the categories....
250     my @checkedcats;
251     my $cats = GetBranchCategory();
252     foreach my $cat (@$cats) {
253         my $code = $cat->{'categorycode'};
254         if ( $data->{$code} ) {
255             push( @checkedcats, $code );
256         }
257     }
258     my $branchcode = uc( $data->{'branchcode'} );
259     my $branch     = GetBranchInfo($branchcode);
260     $branch = $branch->[0];
261     my $branchcats = $branch->{'categories'};
262     my @addcats;
263     my @removecats;
264     foreach my $bcat (@$branchcats) {
265
266         unless ( grep { /^$bcat$/ } @checkedcats ) {
267             push( @removecats, $bcat );
268         }
269     }
270     foreach my $ccat (@checkedcats) {
271         unless ( grep { /^$ccat$/ } @$branchcats ) {
272             push( @addcats, $ccat );
273         }
274     }
275     foreach my $cat (@addcats) {
276         my $sth =
277           $dbh->prepare(
278 "insert into branchrelations (branchcode, categorycode) values(?, ?)"
279           );
280         $sth->execute( $branchcode, $cat );
281         $sth->finish;
282     }
283     foreach my $cat (@removecats) {
284         my $sth =
285           $dbh->prepare(
286             "delete from branchrelations where branchcode=? and categorycode=?"
287           );
288         $sth->execute( $branchcode, $cat );
289         $sth->finish;
290     }
291 }
292
293 =head2 GetBranchCategory
294
295 $results = GetBranchCategory($categorycode);
296
297 C<$results> is an ref to an array.
298
299 =cut
300
301 sub GetBranchCategory {
302
303     # returns a reference to an array of hashes containing branches,
304     my ($catcode) = @_;
305     my $dbh = C4::Context->dbh;
306     my $sth;
307
308     #    print DEBUG "GetBranchCategory: entry: catcode=".cvs($catcode)."\n";
309     if ($catcode) {
310         $sth =
311           $dbh->prepare(
312             "select * from branchcategories where categorycode = ?");
313         $sth->execute($catcode);
314     }
315     else {
316         $sth = $dbh->prepare("Select * from branchcategories");
317         $sth->execute();
318     }
319     my @results;
320     while ( my $data = $sth->fetchrow_hashref ) {
321         push( @results, $data );
322     }
323     $sth->finish;
324
325     #    print DEBUG "GetBranchCategory: exit: returning ".cvs(\@results)."\n";
326     return \@results;
327 }
328
329 =head2 GetBranchCategories
330
331   my $categories = GetBranchCategories($branchcode,$categorytype,$show_in_pulldown,$selected_in_pulldown);
332
333 Returns a list ref of anon hashrefs with keys eq columns of branchcategories table,
334 i.e. categorycode, categorydescription, categorytype, categoryname.
335 if $branchcode and/or $categorytype are passed, limit set to categories that
336 $branchcode is a member of , and to $categorytype.
337
338 =cut
339
340 sub GetBranchCategories {
341     my ( $branchcode, $categorytype, $show_in_pulldown, $selected_in_pulldown ) = @_;
342     my $dbh = C4::Context->dbh();
343
344     my $query = "SELECT c.* FROM branchcategories c";
345     my ( @where, @bind );
346
347     if( $branchcode ) {
348         $query .= ",branchrelations r, branches b ";
349         push @where, "c.categorycode = r.categorycode AND r.branchcode = ? ";
350         push @bind , $branchcode;
351     }
352
353     if ( $categorytype ) {
354         push @where, " c.categorytype = ? ";
355         push @bind, $categorytype;
356     }
357
358     if ( defined( $show_in_pulldown ) ) {
359         push( @where, " c.show_in_pulldown = ? " );
360         push( @bind, $show_in_pulldown );
361     }
362
363     $query .= " WHERE " . join(" AND ", @where) if(@where);
364     $query .= " ORDER BY categorytype,c.categorycode";
365     my $sth=$dbh->prepare( $query);
366     $sth->execute(@bind);
367
368     my $branchcats = $sth->fetchall_arrayref({});
369     $sth->finish();
370
371     if ( $selected_in_pulldown ) {
372         foreach my $bc ( @$branchcats ) {
373             $bc->{'selected'} = 1 if ( $bc->{'categorycode'} eq $selected_in_pulldown );
374         }
375     }
376
377     return( $branchcats );
378 }
379
380 =head2 GetCategoryTypes
381
382 $categorytypes = GetCategoryTypes;
383 returns a list of category types.
384 Currently these types are HARDCODED.
385 type: 'searchdomain' defines a group of agencies that the calling library may search in.
386 Other usage of agency categories falls under type: 'properties'.
387         to allow for other uses of categories.
388 The searchdomain bit may be better implemented as a separate module, but
389 the categories were already here, and minimally used.
390 =cut
391
392         #TODO  manage category types.  rename possibly to 'agency domains' ? as borrowergroups are called categories.
393 sub GetCategoryTypes {
394         return ( 'searchdomain','properties');
395 }
396
397 =head2 GetBranch
398
399 $branch = GetBranch( $query, $branches );
400
401 =cut
402
403 sub GetBranch {
404     my ( $query, $branches ) = @_;    # get branch for this query from branches
405     my $branch = $query->param('branch');
406     my %cookie = $query->cookie('userenv');
407     ($branch)                || ($branch = $cookie{'branchname'});
408     ( $branches->{$branch} ) || ( $branch = ( keys %$branches )[0] );
409     return $branch;
410 }
411
412 =head2 GetBranchDetail
413
414     $branch = &GetBranchDetail($branchcode);
415
416 Given the branch code, the function returns a
417 hashref for the corresponding row in the branches table.
418
419 =cut
420
421 sub GetBranchDetail {
422     my ($branchcode) = shift or return;
423     my $sth = C4::Context->dbh->prepare("SELECT * FROM branches WHERE branchcode = ?");
424     $sth->execute($branchcode);
425     return $sth->fetchrow_hashref();
426 }
427
428 =head2 GetBranchesInCategory
429
430   my $branches = GetBranchesInCategory($categorycode);
431
432 Returns a href:  keys %$branches eq (branchcode,branchname) .
433
434 =cut
435
436 sub GetBranchesInCategory {
437     my ($categorycode) = @_;
438         my @branches;
439         my $dbh = C4::Context->dbh();
440         my $sth=$dbh->prepare( "SELECT b.branchcode FROM branchrelations r, branches b 
441                                                         where r.branchcode=b.branchcode and r.categorycode=?");
442     $sth->execute($categorycode);
443         while (my $branch = $sth->fetchrow) {
444                 push @branches, $branch;
445         }
446         $sth->finish();
447         return( \@branches );
448 }
449
450 =head2 GetBranchInfo
451
452 $results = GetBranchInfo($branchcode);
453
454 returns C<$results>, a reference to an array of hashes containing branches.
455 if $branchcode, just this branch, with associated categories.
456 if ! $branchcode && $categorytype, all branches in the category.
457 =cut
458
459 sub GetBranchInfo {
460     my ($branchcode,$categorytype) = @_;
461     my $dbh = C4::Context->dbh;
462     my $sth;
463
464
465         if ($branchcode) {
466         $sth =
467           $dbh->prepare(
468             "Select * from branches where branchcode = ? order by branchcode");
469         $sth->execute($branchcode);
470     }
471     else {
472         $sth = $dbh->prepare("Select * from branches order by branchcode");
473         $sth->execute();
474     }
475     my @results;
476     while ( my $data = $sth->fetchrow_hashref ) {
477                 my @bind = ($data->{'branchcode'});
478         my $query= "select r.categorycode from branchrelations r";
479                 $query .= ", branchcategories c " if($categorytype);
480                 $query .= " where  branchcode=? ";
481                 if($categorytype) { 
482                         $query .= " and c.categorytype=? and r.categorycode=c.categorycode";
483                         push @bind, $categorytype;
484                 }
485         my $nsth=$dbh->prepare($query);
486                 $nsth->execute( @bind );
487         my @cats = ();
488         while ( my ($cat) = $nsth->fetchrow_array ) {
489             push( @cats, $cat );
490         }
491         $nsth->finish;
492         $data->{'categories'} = \@cats;
493         push( @results, $data );
494     }
495     $sth->finish;
496     return \@results;
497 }
498
499 =head2 DelBranch
500
501 &DelBranch($branchcode);
502
503 =cut
504
505 sub DelBranch {
506     my ($branchcode) = @_;
507     my $dbh = C4::Context->dbh;
508     my $sth = $dbh->prepare("delete from branches where branchcode = ?");
509     $sth->execute($branchcode);
510     $sth->finish;
511 }
512
513 =head2 ModBranchCategoryInfo
514
515 &ModBranchCategoryInfo($data);
516 sets the data from the editbranch form, and writes to the database...
517
518 =cut
519
520 sub ModBranchCategoryInfo {
521     my ($data) = @_;
522     my $dbh    = C4::Context->dbh;
523     if ($data->{'add'}){
524         # we are doing an insert
525   my $sth   = $dbh->prepare("INSERT INTO branchcategories (categorycode,categoryname,codedescription,categorytype,show_in_pulldown) VALUES (?,?,?,?,?)");
526         $sth->execute(uc( $data->{'categorycode'} ),$data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'},$data->{'show_in_pulldown'} );
527         $sth->finish();         
528     }
529     else {
530         # modifying
531         my $sth = $dbh->prepare("UPDATE branchcategories SET categoryname=?,codedescription=?,categorytype=?,show_in_pulldown=? WHERE categorycode=?");
532         $sth->execute($data->{'categoryname'}, $data->{'codedescription'},$data->{'categorytype'},$data->{'show_in_pulldown'},uc( $data->{'categorycode'} ) );
533         $sth->finish();
534     }
535 }
536
537 =head2 CheckCategoryUnique
538
539 if (CheckCategoryUnique($categorycode)){
540   # do something
541 }
542
543 =cut
544
545 sub CheckCategoryUnique {
546     my $categorycode = shift;
547     my $dbh    = C4::Context->dbh;
548     my $sth = $dbh->prepare("SELECT categorycode FROM branchcategories WHERE categorycode = ?");
549     $sth->execute(uc( $categorycode) );
550     if (my $data = $sth->fetchrow_hashref){
551         return 0;
552     }
553     else {
554         return 1;
555     }
556 }
557
558     
559 =head2 DeleteBranchCategory
560
561 DeleteBranchCategory($categorycode);
562
563 =cut
564
565 sub DelBranchCategory {
566     my ($categorycode) = @_;
567     my $dbh = C4::Context->dbh;
568     my $sth = $dbh->prepare("delete from branchcategories where categorycode = ?");
569     $sth->execute($categorycode);
570     $sth->finish;
571 }
572
573 =head2 CheckBranchCategorycode
574
575 $number_rows_affected = CheckBranchCategorycode($categorycode);
576
577 =cut
578
579 sub CheckBranchCategorycode {
580
581     # check to see if the branchcode is being used in the database somewhere....
582     my ($categorycode) = @_;
583     my $dbh            = C4::Context->dbh;
584     my $sth            =
585       $dbh->prepare(
586         "select count(*) from branchrelations where categorycode=?");
587     $sth->execute($categorycode);
588     my ($total) = $sth->fetchrow_array;
589     return $total;
590 }
591
592 sub get_branch_code_from_name {
593    my @branch_name = @_;
594    my $query = "SELECT branchcode FROM branches WHERE branchname=?;";
595    my $dbh = C4::Context->dbh();
596    my $sth = $dbh->prepare($query);
597    $sth->execute(@branch_name);
598    return $sth->fetchrow_array;
599 }
600
601 sub GetBranchesCount {
602     my $dbh = C4::Context->dbh();
603     my $query = "SELECT COUNT(*) AS branches_count FROM branches";
604     my $sth = $dbh->prepare( $query );
605     $sth->execute();
606     my $row = $sth->fetchrow_hashref();
607     return $row->{'branches_count'};
608 }
609
610 1;
611 __END__
612
613 =head1 AUTHOR
614
615 Koha Development Team <http://koha-community.org/>
616
617 =cut