admin/branches.pl

   1 #!/usr/bin/perl
   2 # NOTE: Use standard 8-space tabs for this file (indents are 4 spaces)
   3
   4 #require '/u/acli/lib/cvs.pl';#DEBUG
   5 #open(DEBUG,'>/tmp/koha.debug');
   6
   7 # FIXME: individual fields in branch address need to be exported to templates,
   8 #        in order to fix bug 180; need to notify translators
   9 # FIXME: looped html (e.g., list of checkboxes) need to be properly
  10 #        TMPL_LOOP'ized; doing this properly will fix bug 130; need to
  11 #        notify translators
  12 # FIXME: need to implement the branch categories stuff
  13 # FIXME: heading() need to be moved to templates, need to notify translators
  14 # FIXME: there are too many TMPL_IF's; the proper way to do it is to have
  15 #        separate templates for each individual action; need to notify
  16 #        translators
  17 # FIXME: there are lots of error messages exported to the template; a lot
  18 #        of these should be converted into exported booleans / counters etc
  19 #        so that the error messages can be localized; need to notify translators
  20
  21 # Finlay working on this file from 26-03-2002
  22 # Reorganising this branches admin page.....
  23
  24
  25 # Copyright 2000-2002 Katipo Communications
  26 #
  27 # This file is part of Koha.
  28 #
  29 # Koha is free software; you can redistribute it and/or modify it under the
  30 # terms of the GNU General Public License as published by the Free Software
  31 # Foundation; either version 2 of the License, or (at your option) any later
  32 # version.
  33 #
  34 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  35 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  36 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  37 #
  38 # You should have received a copy of the GNU General Public License along with
  39 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  40 # Suite 330, Boston, MA  02111-1307 USA
  41
  42 use strict;
  43 use CGI;
  44 use C4::Auth;
  45 use C4::Context;
  46 use C4::Output;
  47 use C4::Interface::CGI::Output;
  48 use HTML::Template;
  49
  50 # Fixed variables
  51 my $linecolor1='#ffffcc';
  52 my $linecolor2='white';
  53 my $backgroundimage="/images/background-mem.gif";
  54 my $script_name="/cgi-bin/koha/admin/branches.pl";
  55 my $pagesize=20;
  56
  57
  58 #######################################################################################
  59 # Main loop....
  60
  61 my $input = new CGI;
  62 my $branchcode=$input->param('branchcode');
  63 my $op = $input->param('op');
  64
  65 my ($template, $borrowernumber, $cookie)
  66     = get_template_and_user({template_name => "parameters/branches.tmpl",
  67                              query => $input,
  68                              type => "intranet",
  69                              authnotrequired => 0,
  70                              flagsrequired => {parameters => 1},
  71                              debug => 1,
  72                              });
  73 if ($op) {
  74     $template->param(script_name => $script_name,
  75                      $op         => 1); # we show only the TMPL_VAR names $op
  76 } else {
  77     $template->param(script_name => $script_name,
  78                      else        => 1); # we show only the TMPL_VAR names $op
  79 }
  80 $template->param(action => $script_name);
  81
  82 if ($op eq 'add') {
  83 # If the user has pressed the "add new branch" button.
  84     heading("Branches: Add Branch");
  85     editbranchform();
  86
  87 } elsif ($op eq 'edit') {
  88 # if the user has pressed the "edit branch settings" button.
  89     heading("Branches: Edit Branch");
  90     $template->param(add => 1);
  91     editbranchform($branchcode);
  92
  93 } elsif ($op eq 'add_validate') {
  94 # confirm settings change...
  95     my $params = $input->Vars;
  96     unless ($params->{'branchcode'} && $params->{'branchname'}) {
  97         default ("Cannot change branch record: You must specify a Branchname and a Branchcode");
  98     } else {
  99         setbranchinfo($params);
 100         $template->param(else => 1);
 101         default ("Branch record changed for branch: $params->{'branchname'}");
 102     }
 103
 104 } elsif ($op eq 'delete') {
 105 # if the user has pressed the "delete branch" button.
 106     my $message = checkdatabasefor($branchcode);
 107     if ($message) {
 108         $template->param(else => 1);
 109         default($message);
 110     } else {
 111         deleteconfirm($branchcode);
 112         $template->param(delete_confirm => 1);
 113         $template->param(branchcode => $branchcode);
 114     }
 115
 116 } elsif ($op eq 'delete_confirmed') {
 117 # actually delete branch and return to the main screen....
 118     deletebranch($branchcode);
 119     $template->param(else => 1);
 120     default("The branch with code $branchcode has been deleted.");
 121
 122 } elsif ($op eq 'add_cat') {
 123 # If the user has pressed the "add new category" button.
 124     heading("Branches: Add Branch");
 125     editcatform();
 126
 127 } else {
 128 # if no operation has been set...
 129     default();
 130 }
 131
 132
 133
 134 ######################################################################################################
 135 #
 136 # html output functions....
 137
 138 sub default {
 139     my ($message) = @_;
 140     heading("Branches");
 141     $template->param(message => $message);
 142     $template->param(action => $script_name);
 143     branchinfotable();
 144
 145
 146 }
 147
 148 # FIXME: this function should not exist; otherwise headings are untranslatable
 149 sub heading {
 150     my ($head) = @_;
 151     $template->param(head => $head);
 152 }
 153
 154 sub editbranchform {
 155 # prepares the edit form...
 156     my ($branchcode) = @_;
 157     my $data;
 158     if ($branchcode) {
 159         $data = getbranchinfo($branchcode);
 160         $data = $data->[0];
 161         $template->param(branchcode => $data->{'branchcode'});
 162         $template->param(branchname => $data->{'branchname'});
 163         $template->param(branchaddress1 => $data->{'branchaddress1'});
 164         $template->param(branchaddress2 => $data->{'branchaddress2'});
 165         $template->param(branchaddress3 => $data->{'branchaddress3'});
 166         $template->param(branchphone => $data->{'branchphone'});
 167         $template->param(branchfax => $data->{'branchfax'});
 168         $template->param(branchemail => $data->{'branchemail'});
 169     }
 170
 171     # make the checkboxs.....
 172     #
 173     # We export a "categoryloop" array to the template, each element of which
 174     # contains separate 'categoryname', 'categorycode', 'codedescription', and
 175     # 'checked' fields. The $checked field is either '' or 'checked'
 176     # (see bug 130)
 177     #
 178     my $catinfo = getcategoryinfo();
 179     my $catcheckbox;
 180 #    print DEBUG "catinfo=".cvs($catinfo)."\n";
 181     my @categoryloop = ();
 182     foreach my $cat (@$catinfo) {
 183         my $checked = "";
 184         my $tmp = quotemeta($cat->{'categorycode'});
 185         if (grep {/^$tmp$/} @{$data->{'categories'}}) {
 186             $checked = "CHECKED";
 187         }
 188         push @categoryloop, {
 189                 categoryname    => $cat->{'categoryname'},
 190                 categorycode    => $cat->{'categorycode'},
 191                 codedescription => $cat->{'codedescription'},
 192                 checked         => $checked,
 193             };
 194     }
 195     $template->param(categoryloop => \@categoryloop);
 196
 197     # {{{ Leave this here until bug 130 is completely resolved in the templates
 198     for my $obsolete ('categoryname', 'categorycode', 'codedescription') {
 199         $template->param($obsolete => 'Your template is out of date (bug 130)');
 200     }
 201     # }}}
 202 }
 203
 204 sub deleteconfirm {
 205 # message to print if the
 206     my ($branchcode) = @_;
 207 }
 208
 209
 210 sub branchinfotable {
 211 # makes the html for a table of branch info from reference to an array of hashs.
 212
 213     my ($branchcode) = @_;
 214     my $branchinfo;
 215     if ($branchcode) {
 216         $branchinfo = getbranchinfo($branchcode);
 217     } else {
 218         $branchinfo = getbranchinfo();
 219     }
 220     my $color;
 221     my @loop_data =();
 222     foreach my $branch (@$branchinfo) {
 223         ($color eq $linecolor1) ? ($color=$linecolor2) : ($color=$linecolor1);
 224         #
 225         # We export the following fields to the template. These are not
 226         # pre-composed as a single "address" field because the template
 227         # might (and should) escape what is exported here. (See bug 180)
 228         #
 229         # - color
 230         # - branch_name     (Note: not "branchname")
 231         # - branch_code     (Note: not "branchcode")
 232         # - address         (containing a static error message)
 233         # - branchaddress1 \
 234         # - branchaddress2  |
 235         # - branchaddress3  | comprising the old "address" field
 236         # - branchphone     |
 237         # - branchfax       |
 238         # - branchemail    /
 239         # - address-empty-p (1 if no address information, 0 otherwise)
 240         # - categories (FIXME... need to convert this to a TMPL_LOOP too)
 241         # - value
 242         # - action
 243         #
 244         my %row = ();
 245
 246         # Handle address fields separately
 247         my $address_empty_p = 1;
 248         for my $field ('branchaddress1', 'branchaddress2', 'branchaddress3',
 249                 'branchphone', 'branchfax', 'branchemail') {
 250
 251             $row{$field} = $branch->{$field};
 252             $address_empty_p = 0;
 253         }
 254         $row{'address-empty-p'} = $address_empty_p;
 255         $row{'address'} = 'Your template is out of date (see bug 180)';
 256
 257         # Handle categories
 258         # FIXME. This should be another TMPL_LOOP
 259         my $categories = '';
 260         foreach my $cat (@{$branch->{'categories'}}) {
 261             my ($catinfo) = @{getcategoryinfo($cat)};
 262             $categories .= $catinfo->{'categoryname'}."<br>";
 263         }
 264         $categories = '(no categories set)' unless ($categories);
 265         $row{'categories'} = $categories; #FIXME
 266
 267         # Handle all other fields
 268         $row{'branch_name'} = $branch->{'branchname'};
 269         $row{'branch_code'} = $branch->{'branchcode'};
 270         $row{'color'} = $color;
 271         $row{'value'} = $branch->{'branchcode'};
 272         $row{'action'} = '/cgi-bin/koha/admin/branches.pl';
 273
 274         push @loop_data, { %row };
 275     }
 276     $template->param(branches => \@loop_data);
 277
 278 }
 279
 280 # FIXME logic seems wrong
 281 sub branchcategoriestable {
 282 #Needs to be implemented...
 283
 284     my $categoryinfo = getcategoryinfo();
 285     my $color;
 286     foreach my $cat (@$categoryinfo) {
 287         ($color eq $linecolor1) ? ($color=$linecolor2) : ($color=$linecolor1);
 288         $template->param(color => $color);
 289         $template->param(categoryname => $cat->{'categoryname'});
 290         $template->param(categorycode => $cat->{'categorycode'});
 291         $template->param(codedescription => $cat->{'codedescription'});
 292     }
 293 }
 294
 295 ######################################################################################################
 296 #
 297 # Database functions....
 298
 299 sub getbranchinfo {
 300 # returns a reference to an array of hashes containing branches,
 301
 302     my ($branchcode) = @_;
 303     my $dbh = C4::Context->dbh;
 304     my ($query, @query_args);
 305     if ($branchcode) {
 306         $query = "Select * from branches where branchcode = ?";
 307         @query_args = ($branchcode);
 308     } else {
 309         $query = "Select * from branches";
 310     }
 311     my $sth = $dbh->prepare($query);
 312     $sth->execute(@query_args);
 313     my @results;
 314     while (my $data = $sth->fetchrow_hashref) {
 315         $query = "select categorycode from branchrelations where branchcode = ?";
 316         my $nsth = $dbh->prepare($query);
 317         $nsth->execute($data->{'branchcode'});;
 318         my @cats = ();
 319         while (my ($cat) = $nsth->fetchrow_array) {
 320             push(@cats, $cat);
 321         }
 322         $nsth->finish;
 323         $data->{'categories'} = \@cats;
 324         push(@results, $data);
 325     }
 326     $sth->finish;
 327     return \@results;
 328 }
 329
 330 # FIXME This doesn't belong here; it should be moved into a module
 331 sub getcategoryinfo {
 332 # returns a reference to an array of hashes containing branches,
 333     my ($catcode) = @_;
 334     my $dbh = C4::Context->dbh;
 335     my ($query, @query_args);
 336 #    print DEBUG "getcategoryinfo: entry: catcode=".cvs($catcode)."\n";
 337     if ($catcode) {
 338         $query = "select * from branchcategories where categorycode = ?";
 339         @query_args = ($catcode);
 340     } else {
 341         $query = "Select * from branchcategories";
 342     }
 343 #    print DEBUG "getcategoryinfo: query=".cvs($query)."\n";
 344     my $sth = $dbh->prepare($query);
 345     $sth->execute(@query_args);
 346     my @results;
 347     while (my $data = $sth->fetchrow_hashref) {
 348         push(@results, $data);
 349     }
 350     $sth->finish;
 351 #    print DEBUG "getcategoryinfo: exit: returning ".cvs(\@results)."\n";
 352     return \@results;
 353 }
 354
 355 # FIXME This doesn't belong here; it should be moved into a module
 356 sub setbranchinfo {
 357 # sets the data from the editbranch form, and writes to the database...
 358     my ($data) = @_;
 359     my $dbh = C4::Context->dbh;
 360     my $query = "replace branches (branchcode,branchname,branchaddress1,branchaddress2,branchaddress3,branchphone,branchfax,branchemail) values (";
 361     my $tmp;
 362     $tmp = $data->{'branchcode'}; $query.= $dbh->quote($tmp).",";
 363     $tmp = $data->{'branchname'}; $query.= $dbh->quote($tmp).",";
 364     $tmp = $data->{'branchaddress1'}; $query.= $dbh->quote($tmp).",";
 365     $tmp = $data->{'branchaddress2'}; $query.= $dbh->quote($tmp).",";
 366     $tmp = $data->{'branchaddress3'}; $query.= $dbh->quote($tmp).",";
 367     $tmp = $data->{'branchphone'}; $query.= $dbh->quote($tmp).",";
 368     $tmp = $data->{'branchfax'}; $query.= $dbh->quote($tmp).",";
 369     $tmp = $data->{'branchemail'}; $query.= $dbh->quote($tmp).")";
 370     my $sth=$dbh->prepare($query);
 371     $sth->execute;
 372     $sth->finish;
 373 # sort out the categories....
 374     my @checkedcats;
 375     my $cats = getcategoryinfo();
 376     foreach my $cat (@$cats) {
 377         my $code = $cat->{'categorycode'};
 378         if ($data->{$code}) {
 379             push(@checkedcats, $code);
 380         }
 381     }
 382     my $branchcode = $data->{'branchcode'};
 383     my $branch = getbranchinfo($branchcode);
 384     $branch = $branch->[0];
 385     my $branchcats = $branch->{'categories'};
 386     my @addcats;
 387     my @removecats;
 388     foreach my $bcat (@$branchcats) {
 389         unless (grep {/^$bcat$/} @checkedcats) {
 390             push(@removecats, $bcat);
 391         }
 392     }
 393     foreach my $ccat (@checkedcats){
 394         unless (grep {/^$ccat$/} @$branchcats) {
 395             push(@addcats, $ccat);
 396         }
 397     }
 398     # FIXME - There's already a $dbh in this scope.
 399     my $dbh = C4::Context->dbh;
 400     foreach my $cat (@addcats) {
 401         my $query = "insert into branchrelations (branchcode, categorycode) values(?, ?)";
 402         my $sth = $dbh->prepare($query);
 403         $sth->execute($branchcode, $cat);
 404         $sth->finish;
 405     }
 406     foreach my $cat (@removecats) {
 407         my $query = "delete from branchrelations where branchcode=? and categorycode=?";
 408         my $sth = $dbh->prepare($query);
 409         $sth->execute($branchcode, $cat);
 410         $sth->finish;
 411     }
 412 }
 413
 414 sub deletebranch {
 415 # delete branch...
 416     my ($branchcode) = @_;
 417     my $query = "delete from branches where branchcode = ?";
 418     my $dbh = C4::Context->dbh;
 419     my $sth=$dbh->prepare($query);
 420     $sth->execute($branchcode);
 421     $sth->finish;
 422 }
 423
 424 sub checkdatabasefor {
 425 # check to see if the branchcode is being used in the database somewhere....
 426     my ($branchcode) = @_;
 427     my $dbh = C4::Context->dbh;
 428     my $sth=$dbh->prepare("select count(*) from items where holdingbranch=? or homebranch=?");
 429     $sth->execute($branchcode, $branchcode);
 430     my ($total) = $sth->fetchrow_array;
 431     $sth->finish;
 432     my $message;
 433     if ($total) {
 434         # FIXME: need to be replaced by an exported boolean parameter
 435         $message = "Branch cannot be deleted because there are $total items using that branch.";
 436     }
 437     return $message;
 438 }
 439
 440 output_html_with_http_headers $input, $cookie, $template->output;
 441
 442 # Local Variables:
 443 # tab-width: 8
 444 # End: