admin/branches.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it under the
   8 # terms of the GNU General Public License as published by the Free Software
   9 # Foundation; either version 2 of the License, or (at your option) any later
  10 # version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  14 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  15 #
  16 # You should have received a copy of the GNU General Public License along with
  17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  18 # Suite 330, Boston, MA  02111-1307 USA
  19
  20 =head1 branches.pl
  21
  22  FIXME: individual fields in branch address need to be exported to templates,
  23         in order to fix bug 180; need to notify translators
  24 FIXME: looped html (e.g., list of checkboxes) need to be properly
  25         TMPL_LOOP'ized; doing this properly will fix bug 130; need to
  26         notify translators
  27  FIXME: need to implement the branch categories stuff
  28  FIXME: there are too many TMPL_IF's; the proper way to do it is to have
  29         separate templates for each individual action; need to notify
  30         translators
  31  FIXME: there are lots of error messages exported to the template; a lot
  32         of these should be converted into exported booleans / counters etc
  33         so that the error messages can be localized; need to notify translators
  34
  35  Finlay working on this file from 26-03-2002
  36  Reorganising this branches admin page.....
  37
  38 =cut
  39
  40 use strict;
  41 use warnings;
  42 use CGI;
  43 use C4::Auth;
  44 use C4::Context;
  45 use C4::Output;
  46 use C4::Koha;
  47 use C4::Branch;
  48
  49 # Fixed variables
  50 my $script_name = "/cgi-bin/koha/admin/branches.pl";
  51
  52 ################################################################################
  53 # Main loop....
  54 my $input        = new CGI;
  55 my $branchcode   = $input->param('branchcode');
  56 my $branchname   = $input->param('branchname');
  57 my $categorycode = $input->param('categorycode');
  58 my $op           = $input->param('op') || '';
  59
  60 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  61     {
  62         template_name   => "admin/branches.tmpl",
  63         query           => $input,
  64         type            => "intranet",
  65         authnotrequired => 0,
  66         flagsrequired   => { parameters => 1},
  67         debug           => 1,
  68     }
  69 );
  70 $template->param(
  71      script_name => $script_name,
  72      action      => $script_name,
  73 );
  74 $template->param( ($op || 'else') => 1 );
  75
  76 if ( $op eq 'add' ) {
  77
  78     # If the user has pressed the "add new branch" button.
  79     $template->param( 'heading-branches-add-branch-p' => 1 );
  80     editbranchform($branchcode,$template);
  81
  82 }
  83 elsif ( $op eq 'edit' ) {
  84
  85     # if the user has pressed the "edit branch settings" button.
  86     $template->param( 'heading-branches-add-branch-p' => 0,
  87                         'add' => 1, );
  88     editbranchform($branchcode,$template);
  89 }
  90 elsif ( $op eq 'add_validate' ) {
  91
  92     # confirm settings change...
  93     my $params = $input->Vars;
  94     unless ( $params->{'branchcode'} && $params->{'branchname'} ) {
  95         $template->param( else => 1 );
  96         default("MESSAGE1",$template);
  97     }
  98     else {
  99         my $error = ModBranch($params); # FIXME: causes warnings to log on duplicate branchcode
 100         # if error saving, stay on edit and rise error
 101         if ($error) {
 102             # copy input parameters back to form
 103             # FIXME - doing this doesn't preserve any branch group selections, but good enough for now
 104             editbranchform($branchcode,$template);
 105             $template->param( 'heading-branches-add-branch-p' => 1, 'add' => 1, "ERROR$error" => 1 );
 106         } else {
 107             $template->param( else => 1);
 108             default("MESSAGE2",$template);
 109         }
 110     }
 111 }
 112 elsif ( $op eq 'delete' ) {
 113     # if the user has pressed the "delete branch" button.
 114
 115     # check to see if the branchcode is being used in the database somewhere....
 116     my $dbh = C4::Context->dbh;
 117     my $sthitems     = $dbh->prepare("select count(*) from items where holdingbranch=? or homebranch=?");
 118     my $sthborrowers = $dbh->prepare("select count(*) from borrowers where branchcode=?");
 119     $sthitems->execute( $branchcode, $branchcode );
 120     $sthborrowers->execute( $branchcode );
 121     my ($totalitems)     = $sthitems->fetchrow_array;
 122     my ($totalborrowers) = $sthitems->fetchrow_array;
 123     if ($totalitems or $totalborrowers) {
 124         $template->param( else => 1 );
 125         default("MESSAGE7", $template);
 126     }
 127     else {
 128         $template->param( delete_confirm => 1 );
 129         $template->param( branchname     => $branchname );
 130         $template->param( branchcode     => $branchcode );
 131     }
 132 }
 133 elsif ( $op eq 'delete_confirmed' ) {
 134
 135     # actually delete branch and return to the main screen....
 136     DelBranch($branchcode);
 137     $template->param( else => 1 );
 138     default("MESSAGE3",$template);
 139 }
 140 elsif ( $op eq 'editcategory' ) {
 141
 142     # If the user has pressed the "add new category" or "modify" buttons.
 143     $template->param( 'heading-branches-edit-category-p' => 1 );
 144     editcatform($categorycode,$template);
 145 }
 146 elsif ( $op eq 'addcategory_validate' ) {
 147
 148     $template->param( else => 1 );
 149     # confirm settings change...
 150     my $params = $input->Vars;
 151     unless ( $params->{'categorycode'} && $params->{'categoryname'} ) {
 152         default("MESSAGE4",$template);
 153     }
 154     else {
 155         ModBranchCategoryInfo($params);
 156         default("MESSAGE5",$template);
 157     }
 158 }
 159 elsif ( $op eq 'delete_category' ) {
 160
 161     # if the user has pressed the "delete branch" button.
 162     my $message = "MESSAGE8" if CheckBranchCategorycode($categorycode);
 163     if ($message) {
 164         $template->param( else => 1 );
 165         default($message,$template);
 166     }
 167     else {
 168         $template->param( delete_category => 1 );
 169         $template->param( categorycode    => $categorycode );
 170     }
 171 }
 172 elsif ( $op eq 'categorydelete_confirmed' ) {
 173
 174     # actually delete branch and return to the main screen....
 175     DelBranchCategory($categorycode);
 176     $template->param( else => 1 );
 177     default("MESSAGE6",$template);
 178
 179 }
 180 else {
 181     # if no operation has been set...
 182     default("",$template);
 183 }
 184
 185 ################################################################################
 186 #
 187 # html output functions....
 188
 189 sub default {
 190     my $message       = shift || '';
 191     my $innertemplate = shift or return;
 192     $innertemplate->param($message => 1) if $message;
 193     $innertemplate->param(
 194         'heading-branches-p' => 1,
 195     );
 196     branchinfotable("",$innertemplate);
 197 }
 198
 199 sub editbranchform {
 200     my ($branchcode,$innertemplate) = @_;
 201     # initiate the scrolling-list to select the printers
 202     my $printers = GetPrinters();
 203     my @printerloop;
 204     my $data;
 205     my $oldprinter = "";
 206
 207     if ($branchcode) {
 208         $data = GetBranchInfo($branchcode);
 209         $data = $data->[0];
 210
 211         # get the old printer of the branch
 212         $oldprinter = $data->{'branchprinter'} || '';
 213         $innertemplate->param(
 214              branchcode     => $data->{'branchcode'},
 215              branch_name    => $data->{'branchname'},
 216              branchaddress1 => $data->{'branchaddress1'},
 217              branchaddress2 => $data->{'branchaddress2'},
 218              branchaddress3 => $data->{'branchaddress3'},
 219              branchzip      => $data->{'branchzip'},
 220              branchcity     => $data->{'branchcity'},
 221              branchcountry  => $data->{'branchcountry'},
 222              branchphone    => $data->{'branchphone'},
 223              branchfax      => $data->{'branchfax'},
 224              branchemail    => $data->{'branchemail'},
 225              branchurl      => $data->{'branchurl'},
 226              branchip       => $data->{'branchip'},
 227              branchnotes    => $data->{'branchnotes'},
 228         );
 229     }
 230
 231     foreach my $thisprinter ( keys %$printers ) {
 232         push @printerloop, {
 233             value         => $thisprinter,
 234             selected      => ( $oldprinter eq $printers->{$thisprinter} ),
 235             branchprinter => $printers->{$thisprinter}->{'printqueue'},
 236         };
 237     }
 238
 239     $innertemplate->param( printerloop => \@printerloop );
 240     # make the checkboxes.....
 241     #
 242     # We export a "categoryloop" array to the template, each element of which
 243     # contains separate 'categoryname', 'categorycode', 'codedescription', and
 244     # 'checked' fields. The $checked field is either '' or 'checked="checked"'
 245
 246     my $catinfo = GetBranchCategory();
 247     my @categoryloop = ();
 248     foreach my $cat (@$catinfo) {
 249         my $checked = "";
 250         my $tmp     = quotemeta( $cat->{'categorycode'} );
 251         if ( grep { /^$tmp$/ } @{ $data->{'categories'} } ) {
 252             $checked = "checked=\"checked\"";
 253         }
 254         push @categoryloop, {
 255             categoryname    => $cat->{'categoryname'},
 256             categorycode    => $cat->{'categorycode'},
 257             categorytype    => $cat->{'categorytype'},
 258             codedescription => $cat->{'codedescription'},
 259             checked         => $checked,
 260         };
 261     }
 262     $innertemplate->param( categoryloop => \@categoryloop );
 263
 264     for my $obsolete ( 'categoryname', 'categorycode', 'codedescription' ) {
 265         $innertemplate->param(
 266             $obsolete => 'Your template is out of date (bug 130)' );
 267     }
 268 }
 269
 270 sub editcatform {
 271
 272     # prepares the edit form...
 273     my ($categorycode,$innertemplate) = @_;
 274     # warn "cat : $categorycode";
 275         my @cats;
 276     my $data;
 277         if ($categorycode) {
 278         my $data = GetBranchCategory($categorycode);
 279         $data = $data->[0];
 280         $innertemplate->param(
 281             categorycode    => $data->{'categorycode'},
 282             categoryname    => $data->{'categoryname'},
 283             codedescription => $data->{'codedescription'},
 284                 );
 285     }
 286         for my $ctype (GetCategoryTypes()) {
 287                 push @cats , { type => $ctype , selected => ($data->{'categorytype'} and $data->{'categorytype'} eq $ctype) };
 288         }
 289     $innertemplate->param(categorytype => \@cats);
 290 }
 291
 292 sub branchinfotable {
 293
 294 # makes the html for a table of branch info from reference to an array of hashs.
 295
 296     my ($branchcode,$innertemplate) = @_;
 297     my $branchinfo = $branchcode ? GetBranchInfo($branchcode) : GetBranchInfo();
 298     my @loop_data = ();
 299     foreach my $branch (@$branchinfo) {
 300         #
 301         # We export the following fields to the template. These are not
 302         # pre-composed as a single "address" field because the template
 303         # might (and should) escape what is exported here. (See bug 180)
 304         #
 305         # - branch_name     (Note: not "branchname")
 306         # - branch_code     (Note: not "branchcode")
 307         # - address         (containing a static error message)
 308         # - branchaddress1 \
 309         # - branchaddress2  |
 310         # - branchaddress3  | comprising the old "address" field
 311         # - branchzip       |
 312         # - branchcity      |
 313         # - branchcountry   |
 314         # - branchphone     |
 315         # - branchfax       |
 316         # - branchemail    /
 317         # - branchurl      /
 318         # - address-empty-p (1 if no address information, 0 otherwise)
 319         # - categories      (containing a static error message)
 320         # - category_list   (loop containing "categoryname")
 321         # - no-categories-p (1 if no categories set, 0 otherwise)
 322         # - value
 323         #
 324         my %row = ();
 325
 326         # Handle address fields separately
 327         my $address_empty_p = 1;
 328         for my $field (
 329             'branchaddress1', 'branchaddress2',
 330             'branchaddress3', 'branchzip',
 331             'branchcity', 'branchcountry',
 332             'branchphone', 'branchfax',
 333             'branchemail', 'branchurl',
 334             'branchip',       'branchprinter', 'branchnotes'
 335           )
 336         {
 337             $row{$field} = $branch->{$field};
 338             $address_empty_p = 0 if ( $branch->{$field} );
 339         }
 340         $row{'address-empty-p'} = $address_empty_p;
 341
 342         # Handle categories
 343         my $no_categories_p = 1;
 344         my @categories;
 345         foreach my $cat ( @{ $branch->{'categories'} } ) {
 346             my ($catinfo) = @{ GetBranchCategory($cat) };
 347             push @categories, { 'categoryname' => $catinfo->{'categoryname'} };
 348             $no_categories_p = 0;
 349         }
 350
 351         $row{'category_list'}   = \@categories;
 352         $row{'no-categories-p'} = $no_categories_p;
 353         $row{'branch_name'} = $branch->{'branchname'};
 354         $row{'branch_code'} = $branch->{'branchcode'};
 355         $row{'value'}       = $branch->{'branchcode'};
 356
 357         push @loop_data, \%row;
 358     }
 359     my @branchcategories = ();
 360         for my $ctype ( GetCategoryTypes() ) {
 361         my $catinfo = GetBranchCategories(undef,$ctype);
 362         my @categories;
 363                 foreach my $cat (@$catinfo) {
 364             push @categories, {
 365                 categoryname    => $cat->{'categoryname'},
 366                 categorycode    => $cat->{'categorycode'},
 367                 codedescription => $cat->{'codedescription'},
 368                 categorytype    => $cat->{'categorytype'},
 369             };
 370         }
 371         push @branchcategories, { categorytype => $ctype , $ctype => 1 , catloop => \@categories};
 372         }
 373     $innertemplate->param(
 374         branches         => \@loop_data,
 375         branchcategories => \@branchcategories
 376     );
 377
 378 }
 379
 380 output_html_with_http_headers $input, $cookie, $template->output;
 381
 382 # Local Variables:
 383 # tab-width: 8
 384 # End: