misc/Install.pm

   1 package Install; #assumes Install.pm
   2
   3
   4 # Copyright 2000-2002 Katipo Communications
   5 # Contains parts Copyright 2003 MJ Ray
   6 #
   7 # This file is part of Koha.
   8 #
   9 # Koha is free software; you can redistribute it and/or modify it under the
  10 # terms of the GNU General Public License as published by the Free Software
  11 # Foundation; either version 2 of the License, or (at your option) any later
  12 # version.
  13 #
  14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  16 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  17 #
  18 # You should have received a copy of the GNU General Public License along with
  19 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  20 # Suite 330, Boston, MA  02111-1307 USA
  21 #
  22 # Recent Authors
  23 # MJR: my.cnf, etcdir, prefix, new display, apache conf, copying fixups
  24
  25 use strict;
  26 use POSIX;
  27 #MJR: everyone will have these modules, right?
  28 # They look like part of perl core to me
  29 use Term::Cap;
  30 use Term::ANSIColor qw(:constants);
  31 use Text::Wrap;
  32 require Exporter;
  33
  34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  35
  36 =head1 NAME
  37
  38 Install.pm - Perl module containing the bulk of the installation logic
  39
  40 =head1 DESCRIPTION
  41
  42 The Install.pm module contains the bulk
  43 of the code to do installation;
  44 this code is used by installer.pl
  45 to perform an actual installation.
  46
  47 =head2 Internal functions (not meant to be used outside of Install.pm)
  48
  49 =over 4
  50
  51 =cut
  52
  53 # set the version for version checking
  54 $VERSION = 0.01;
  55
  56 @ISA = qw(Exporter);
  57 @EXPORT = qw(   &checkperlmodules
  58                 &checkabortedinstall
  59                 &getmessage
  60                 &showmessage
  61                 &releasecandidatewarning
  62                 &getinstallationdirectories
  63                 &getdatabaseinfo
  64                 &getapacheinfo
  65                 &getapachevhostinfo
  66                 &updateapacheconf
  67                 &basicauthentication
  68                 &installfiles
  69                 &databasesetup
  70                 &updatedatabase
  71                 &populatedatabase
  72                 &restartapache
  73                 &backupkoha
  74                 &finalizeconfigfile
  75                 &loadconfigfile
  76                 &backupmycnf
  77                 &restoremycnf
  78                 );
  79
  80 use vars qw( $kohaversion $newversion );                        # set in loadconfigfile and installer.pl
  81 use vars qw( $language );                       # set in installer.pl
  82 use vars qw( $domainname );                     # set in installer.pl
  83
  84 use vars qw( $etcdir );                         # set in installer.pl, usu. /etc
  85 use vars qw( $intranetdir $opacdir $kohalogdir );
  86 use vars qw( $realhttpdconf $httpduser );
  87 use vars qw( $servername $svr_admin $opacport $intranetport );
  88 use vars qw( $mysqldir );
  89 use vars qw( $database $mysqluser );
  90 use vars qw( $mysqlpass );                      # normally should not be used
  91 use vars qw( $dbname $hostname $user $pass );   # virtual hosting
  92
  93 =item heading
  94
  95     $messages->{'WelcomeToKohaInstaller'
  96         = heading('Welcome to the Koha Installer') . qq|...|;
  97
  98 The heading function takes one string, the text to be displayed as
  99 the heading, and returns a formatted heading (currently formatted
 100 with ANSI colours).
 101
 102 This reduces the likelihood of pod2man(1) etc. misinterpreting
 103 a line of equal signs as illegal POD directives.
 104
 105 =cut
 106
 107 my $termios = POSIX::Termios->new();
 108 $termios->getattr();
 109 my $terminal = Term::Cap->Tgetent({OSPEED=>$termios->getospeed()});
 110 my $clear_string = "\n\n"; #MJR: was $terminal->Tputs('cl');
 111
 112 sub heading ($) {
 113   my $title = shift;
 114   my $bal = 5;
 115   return($clear_string.ON_BLUE.WHITE.BOLD." "x$bal.uc($title)." "x$bal.RESET."\n\n");
 116 }
 117
 118 my $mycnf = $ENV{HOME}."/.my.cnf";
 119 my $mytmpcnf = `mktemp my.cnf.koha.XXXXXX`;
 120 chomp($mytmpcnf);
 121
 122 my $messages;
 123 $messages->{'continuing'}->{en}="Great!  Continuing...\n\n";
 124 $messages->{'WelcomeToKohaInstaller'}->{en} =
 125    heading('Welcome to the Koha Installer') . qq|
 126 This program will ask some questions and try to install koha for you.
 127 You need to know: where most koha files should be stored (you can set
 128 the prefix environment variable for this); the username and password of
 129 a mysql superuser; and details of your library setup.  You may also need
 130 to know details of your Apache setup.
 131
 132 If you want to install the Koha configuration files somewhere other than
 133 /etc (for multiple Koha versions on one system, for example), you should
 134 set the etcdir environment variable.  Please look at your manuals for
 135 details of how to set that.
 136
 137 Recommended answers are given in brackets after each question.  To accept
 138 the default value for any question (indicated by []), simply hit Enter
 139 at the prompt.
 140
 141 Are you ready to begin the installation? ([Y]/N): |;
 142
 143 $messages->{'WelcomeToUpgrader'}->{en} =
 144    heading('Welcome to the Koha Upgrader') . qq|
 145 You are attempting to upgrade from Koha %s to %s.
 146
 147 We recommend that you do a complete backup of all your files before upgrading.
 148 This upgrade script will make a backup copy of your files for you.
 149
 150 Would you like to proceed?  (Y/[N]):|;
 151
 152 $messages->{'AbortingInstall'}->{en} =
 153    heading('ABORTING') . qq|
 154 Aborting as requested.  Please rerun when you are ready.
 155 |;
 156
 157 $messages->{'ReleaseCandidateWarning'}->{en} =
 158    heading('RELEASE CANDIDATE') . qq|
 159 WARNING: You are about to install Koha version %s.  This is a
 160 release candidate, not intended for production systems.
 161 It is being released so that users can test it before we release a final
 162 version and report bugs to us.
 163
 164 Most people should answer Yes here.
 165
 166 Are you sure you want to install Koha %s? (Y/[N]): |;
 167 $messages->{'WatchForReleaseAnnouncements'}->{en}=qq|
 168
 169 Watch for announcements of Koha releases on the Koha mailing list or the Koha
 170 web site (http://www.koha.org/).
 171
 172 |;
 173
 174 $messages->{'NETZ3950Missing'}->{en}=qq|
 175
 176 The Net::Z3950 module is missing.  This module is necessary if you want to use
 177 Koha's Z39.50 client to download bibliographic records from other libraries.
 178
 179 To install this module, you will need the yaz client installed from
 180 http://www.indexdata.dk/yaz/ and then you can install the perl module with the
 181 command:
 182
 183 perl -MCPAN -e 'install Net::Z3950'
 184
 185 ...or by installing packages for your distribution, if available.
 186
 187 IMPORTANT NOTE : If you use Perl 5.8.0, you might need to
 188 edit NET::Z3950's Makefile.PL and yazwrap/Makefile.PL to include:
 189
 190     'DEFINE' => '-D_GNU_SOURCE',
 191
 192 Also note that some installations of Perl on Red Hat will generate a lot of
 193 "'my_perl' undeclared" errors when running make in Net-Z3950.  This is fixed by
 194 inserting in yazwrap/ywpriv.h a line saying #include "XSUB.h"
 195
 196 Press the <ENTER> key to continue: |;   #'
 197
 198 $messages->{'CheckingPerlModules'}->{en} = heading('PERL MODULES') . qq|
 199 Checking perl modules ...
 200 |;
 201
 202 $messages->{'PerlVersionFailure'}->{en}="Sorry, you need at least Perl %s\n";
 203
 204 $messages->{'MissingPerlModules'}->{en} = heading('MISSING PERL MODULES') . qq|
 205 You are missing some Perl modules which are required by Koha.
 206 Once these modules have been installed, rerun this installer.
 207 They may be installed by running (as root) the following:
 208
 209 %s
 210 |;
 211
 212 $messages->{'AllPerlModulesInstalled'}->{en} =
 213    heading('PERL MODULES AVAILABLE') . qq|
 214 All mandatory perl modules are installed.
 215
 216 Press <ENTER> to continue: |;
 217 $messages->{'KohaVersionInstalled'}->{en}="You currently have Koha %s on your system.";
 218 $messages->{'KohaUnknownVersionInstalled'}->{en}="I am not able to determine what version of Koha is installed now.";
 219 $messages->{'KohaAlreadyInstalled'}->{en} =
 220    heading('Koha already installed') . qq|
 221 It looks like Koha is already installed on your system (%s/koha.conf exists).
 222 If you would like to upgrade your system to %s, please use
 223 the koha.upgrade script in this directory.
 224
 225 %s
 226
 227 |;
 228 $messages->{'GetOpacDir'}->{en} = heading('OPAC DIRECTORY') . qq|
 229 Please supply the directory you want Koha to store its OPAC files in.  This
 230 directory will be auto-created for you if it doesn't exist.
 231
 232 OPAC Directory [%s]: |; #'
 233
 234 $messages->{'GetIntranetDir'}->{en} =
 235    heading('LIBRARIAN DIRECTORY') . qq|
 236 Please supply the directory you want Koha to store its Librarian interface
 237 files in.  This directory will be auto-created for you if it doesn't exist.
 238
 239 Intranet Directory [%s]: |;     #'
 240
 241 $messages->{'GetKohaLogDir'}->{en} = heading('LOG DIRECTORY') . qq|
 242 Specify a directory where log files will be written.
 243
 244 Koha Log Directory [%s]: |;
 245
 246 $messages->{'AuthenticationWarning'}->{en} = heading('Authentication') . qq|
 247 This release of Koha has a new authentication module.
 248 You will be required to log in to
 249 access some features.
 250
 251 IMPORTANT: You can log in using the userid and password from the %s/koha.conf configuration file at any time.
 252 Use the "Members" screen to add passwords for other accounts and set their flags.
 253
 254 Press the <ENTER> key to continue: |;
 255
 256 $messages->{'Completed'}->{en} = heading('INSTALLATION COMPLETE') . qq|
 257 Congratulations ... your Koha installation is complete!
 258
 259 You will be able to connect to your Librarian interface at:
 260
 261    http://%s\:%s/
 262
 263    use the koha admin mysql login and password to connect to this interface.
 264
 265 and the OPAC interface at:
 266
 267    http://%s\:%s/
 268
 269 Please read the Hints file and visit http://www.koha.org
 270
 271 Press <ENTER> to exit the installer: |;
 272
 273 $messages->{'UpgradeCompleted'}->{en} = heading('UPGRDE COMPLETE') . qq|
 274 Congratulations ... your Koha upgrade is finished!
 275
 276 If you are upgrading from a version of Koha
 277 prior to 1.2.1, it is likely that you will have to modify your Apache
 278 configuration to point it to the new files.
 279
 280 In your INTRANET VirtualHost section you should have:
 281   DocumentRoot $::intranetdir/htdocs
 282   ScriptAlias /cgi-bin/koha/ $::intranetdir/cgi-bin/
 283   SetEnv PERL5LIB $::intranetdir/modules
 284
 285 In the OPAC VirtualHost section you should have:
 286   DocumentRoot $::opacdir/htdocs
 287   ScriptAlias /cgi-bin/koha/ $::opacdir/cgi-bin/
 288   SetEnv PERL5LIB $::intranetdir/modules
 289
 290 You may also need to uncomment a "LoadModules env_module ... " line and restart
 291 Apache.
 292 If you're upgrading from 1.2.x version of Koha note that the MARC DB is NOT populated.
 293 To populate it :
 294 * launch Koha
 295 * Go to Parameters >> Marc structure option and Koha-MARC links option.
 296 * Modify default MARC structure to fit your needs.
 297 * open a console
 298 * type:
 299 cd /path/to/koha/misc
 300 export PERL5LIB=/path/to/koha
 301 ./koha2marc.pl
 302 the old DB is "copied" in the new MARC one.
 303 Koha 2.0.0 is ready :-)
 304
 305 Please report any problems you encounter through http://bugs.koha.org/
 306
 307 Press <ENTER> to exit the installer: |;
 308
 309 sub releasecandidatewarning {
 310     my $message=getmessage('ReleaseCandidateWarning', [$newversion, $newversion]);
 311     my $answer=showmessage($message, 'yn', 'n');
 312
 313     if ($answer =~ /y/i) {
 314         print getmessage('continuing');
 315     } else {
 316         my $message=getmessage('WatchForReleaseAnnouncements');
 317         print $message."\n";
 318         exit;
 319     };
 320 }
 321
 322
 323 =back
 324
 325 =head2 Accessor functions (for installer.pl)
 326
 327 =over 4
 328
 329 =cut
 330
 331 =item setlanguage
 332
 333     setlanguage('en');
 334
 335 Sets the installation language, normally "en" (English).
 336 In fact, only "en" is supported.
 337
 338 =cut
 339
 340 sub setlanguage ($) {
 341     ($language) = @_;
 342 }
 343
 344 =item setdomainname
 345
 346     setdomainname('example.org');
 347
 348 Sets the domain name of the host.
 349
 350 The domain name should not contain a leading dot;
 351 otherwise, the results are undefined.
 352
 353 =cut
 354
 355 sub setdomainname ($) {
 356     ($domainname) = @_;
 357 }
 358
 359 =item setetcdir
 360
 361     setetcdir('/etc');
 362
 363 Sets the sysconfdir, normally /etc.
 364 This should be an absolute path; a trailing / is not required.
 365
 366 =cut
 367
 368 sub setetcdir ($) {
 369     ($etcdir) = @_;
 370 }
 371
 372 =item setkohaversion
 373
 374     setkohaversion('1.3.3RC26');
 375
 376 Sets the Koha version as known by the installer.
 377
 378 =cut
 379
 380 sub setkohaversion ($) {
 381     ($newversion) = @_;
 382 }
 383
 384 =item getservername
 385
 386     my $servername = getservername;
 387
 388 Gets the name of the Koha virtual server as specified by the user.
 389
 390 =cut
 391
 392 sub getservername () {
 393     $servername;
 394 }
 395
 396 =item getopacport
 397
 398     $port = getopacport;
 399
 400 Gets the port that will run the Koha OPAC virtual server,
 401 as specified by the user.
 402
 403 =cut
 404
 405 sub getopacport () {
 406     $opacport;
 407 }
 408
 409 =item getintranetport
 410
 411     $port = getintranetport;
 412
 413 Gets the port that will run the Koha INTRANET virtual server,
 414 as specified by the user.
 415
 416 =cut
 417
 418 sub getintranetport () {
 419     $intranetport;
 420 }
 421
 422 =back
 423
 424 =head2 Miscellaneous utility functions
 425
 426 =over 4
 427
 428 =cut
 429
 430 =item dirname
 431
 432     dirname $path;
 433
 434 Does the equivalent of dirname(1). Given a path $path, return the
 435 parent directory of $path (best guess), except when $path seems to
 436 be the same as /, in which case $path itself is returned unchanged.
 437
 438 =cut
 439
 440 sub dirname ($;$) {
 441     my($path) = @_;
 442     if ($path =~ /[^\/]/s) {
 443         if ($path =~ /\//) {
 444             $path =~ s/\/+[^\/]+\/*$//s;
 445         } else {
 446             $path = '.';
 447         }
 448     }
 449     return $path;
 450 }
 451
 452 =item mkdir_parents
 453
 454     mkdir_parents $path;
 455     mkdir_parents $path, $mode;
 456
 457 Does the equivalent of mkdir -p, or mkdir --parents. Given a path $path,
 458 create the directory $path, recursively creating any intermediate
 459 directories. If $mode is given, the directory will be created with
 460 mode $mode.
 461
 462 WARNING: If $path already exists, mkdir_parents will just return
 463 successfully (just like mkdir -p), whether the mode of $path conforms
 464 to $mode or not. (This is the behaviour of the mkdir -p command.)
 465
 466 =cut
 467
 468 sub mkdir_parents {
 469     my($path, $mode) = @_;
 470     my $ok = -d($path)? 1: defined $mode? mkdir($path, $mode): mkdir($path);
 471
 472     if (!$ok && $! == ENOENT) {
 473         my $parent = dirname($path);
 474         $ok = mkdir_parents($parent, $mode);
 475
 476         # retry and at the same time make sure that $! is set correctly
 477         $ok = defined $mode? mkdir($path, $mode): mkdir($path);
 478     }
 479     return $ok;
 480 }
 481
 482
 483 =item getmessage
 484
 485     getmessage($msgid);
 486     getmessage($msgid, $variables);
 487
 488 Gets a localized message (format string) with message id $msgid,
 489 and, if an array reference of variables $variables is given,
 490 substitutes variables in the format string with @$variables.
 491 Returns the found message string, with variable substitutions
 492 if specified.
 493
 494 $msgid must be the message identifier corresponding to a defined
 495 message string (a valid key to the $messages hash in the Installer
 496 package). getmessage throws an exception if the message cannot be
 497 found.
 498
 499 =cut
 500
 501 sub getmessage {
 502     my $messagename=shift;
 503     my $variables=shift;
 504     my $message=$messages->{$messagename}->{$language} || $messages->{$messagename}->{en} || RED.BOLD."Error: No message named $messagename in Install.pm\n";
 505     if (defined($variables)) {
 506         $message=sprintf $message, @$variables;
 507     }
 508     return $message;
 509 }
 510
 511
 512 =item showmessage
 513
 514     showmessage($message, 'none');
 515     showmessage($message, 'none', undef, $noclear);
 516
 517     $result = showmessage($message, 'yn');
 518     $result = showmessage($message, 'yn', $defaultresponse);
 519     $result = showmessage($message, 'yn', $defaultresponse, $noclear);
 520
 521     $result = showmessage($message, 'restrictchar CHARS');
 522     $result = showmessage($message, 'free');
 523     $result = showmessage($message, 'silentfree');
 524     $result = showmessage($message, 'numerical');
 525     $result = showmessage($message, 'email');
 526     $result = showmessage($message, 'PressEnter');
 527
 528 Shows a message and optionally gets a response from the user.
 529
 530 The first two arguments, the message and the response type,
 531 are mandatory.  The message must be the actual string to
 532 display; the caller is responsible for calling getmessage if
 533 required.
 534
 535 The response type must be one of "none", "yn", "free", "silentfree"
 536 "numerical", "email", "PressEnter", or a string consisting
 537 of "restrictchar " followed by a list of allowed characters
 538 (space can be specified). (Case is not significant, but case is
 539 significant in the list of allowed characters.) If a response
 540 type other than the above-listed is specified, the result is
 541 undefined.
 542
 543 Note that the response type "yn" is equivalent to "restrictchar yn".
 544 Because "restrictchar" is case-sensitive, the user is expected
 545 to enter "y" or "n" in lowercase only.
 546
 547 Note that the response type of "email" does not actually
 548 guarantee that the returned value is a well-formed RFC-822
 549 email address, nor does it accept all well-formed RFC-822 email
 550 addresses. What it does is to restrict the returned value to a
 551 string that is looks reasonably likely to be an email address
 552 in the "real world", given the premise that the user is trying
 553 to enter a real email address.
 554
 555 If a response type other than "none" or "PressEnter" is
 556 specified, a third argument, specifying the default value, can
 557 be specified:  If this default response is not specified, the
 558 default response is the first allowed character if the response
 559 type is "restrictchar", otherwise the default response is the
 560 empty string. This default response is used when the user does
 561 not specify a value (i.e., presses Enter without typing in
 562 anything), showmessage will assume that the default response is
 563 the user's response.
 564
 565 Note that because the response type "yn" is equivalent to
 566 "restrictchar yn", the default value for response type "yn",
 567 if unspecified, is "y".
 568
 569 The screen is normally cleared before the message is displayed;
 570 if a fourth argument is specified and is nonzero, this
 571 screen-clearing is not done.
 572
 573 =cut
 574 #'
 575
 576 sub showmessage {
 577     #MJR: Maybe refactor to use anonymous functions that
 578     # check the responses instead of RnP branching.
 579     my $message=join('',fill('','',(shift)));
 580     my $responsetype=shift;
 581     my $defaultresponse=shift;
 582     my $noclear=shift;
 583     $noclear = 0 unless defined $noclear; # defaults to "clear"
 584     ($noclear) || (print $clear_string);
 585     if ($responsetype =~ /^yn$/) {
 586         $responsetype='restrictchar ynYN';
 587     }
 588     print RESET.$message;
 589     if ($responsetype =~/^restrictchar (.*)/i) {
 590         my $response='\0';
 591         my $options=$1;
 592         until ($options=~/$response/) {
 593             (defined($defaultresponse)) || ($defaultresponse=substr($options,0,1));
 594             $response=<STDIN>;
 595             chomp $response;
 596             (length($response)) || ($response=$defaultresponse);
 597             if ( $response=~/.*[\:\(\)\^\$\*\!\\].*/ ) {
 598                 ($noclear) || (print $clear_string);
 599                 print RED."Response contains invalid characters.  Choose from [$options].\n\n";
 600                 print RESET.$message;
 601                 $response='\0';
 602             } else {
 603                 unless ($options=~/$response/) {
 604                     ($noclear) || (print $clear_string);
 605                     print RED."Invalid Response.  Choose from [$options].\n\n";
 606                     print RESET.$message;
 607                 }
 608             }
 609         }
 610         return $response;
 611     } elsif ($responsetype =~/^(silent)?free$/i) {
 612         (defined($defaultresponse)) || ($defaultresponse='');
 613         if ($responsetype =~/^(silent)/i) { setecho(0) };
 614         my $response=<STDIN>;
 615         if ($responsetype =~/^(silent)/i) { setecho(1) };
 616         chomp $response;
 617         ($response) || ($response=$defaultresponse);
 618         return $response;
 619     } elsif ($responsetype =~/^numerical$/i) {
 620         (defined($defaultresponse)) || ($defaultresponse='');
 621         my $response='';
 622         until ($response=~/^\d+$/) {
 623             $response=<STDIN>;
 624             chomp $response;
 625             ($response) || ($response=$defaultresponse);
 626             unless ($response=~/^\d+$/) {
 627                 ($noclear) || (print $clear_string);
 628                 print RED."Invalid Response ($response).  Response must be a number.\n\n";
 629                 print RESET.$message;
 630             }
 631         }
 632         return $response;
 633     } elsif ($responsetype =~/^email$/i) {
 634         (defined($defaultresponse)) || ($defaultresponse='');
 635         my $response='';
 636         until ($response=~/.*\@.*\..*/) {
 637             $response=<STDIN>;
 638             chomp $response;
 639             ($response) || ($response=$defaultresponse);
 640             if ($response!~/.*\@.*\..*/) {
 641                         ($noclear) || (print $clear_string);
 642                         print RED."Invalid Response ($response).  Response must be a valid email address.\n\n";
 643                         print RESET.$message;
 644             }
 645         }
 646         return $response;
 647     } elsif ($responsetype =~/^PressEnter$/i) {
 648         <STDIN>;
 649         return;
 650     } elsif ($responsetype =~/^none$/i) {
 651         return;
 652     } else {
 653         # FIXME: There are a few places where we will get an undef as the
 654         # response type. Should we thrown an exception here, or should we
 655         # legitimize this usage and say "none" is the default if not specified?
 656         #die "Illegal response type \"$responsetype\"";
 657     }
 658 }
 659
 660
 661 =back
 662
 663 =item startsysout
 664
 665         startsysout;
 666
 667 Changes the display to show system output until the next showmessage call.
 668 At the time of writing, this means using red text.
 669
 670 =cut
 671
 672 sub startsysout {
 673         print RED."\n";
 674 }
 675
 676
 677 =back
 678
 679 =head2 Subtasks of doing an installation
 680
 681 =over 4
 682
 683 =cut
 684
 685 =item checkabortedinstall
 686
 687     checkabortedinstall;
 688
 689 Checks whether a previous installation process has been abnormally
 690 aborted, by checking whether $etcidr/koha.conf is a symlink matching
 691 a particular pattern.  If an aborted installation is detected, give
 692 the user a chance to abort, before trying to recover the aborted
 693 installation.
 694
 695 FIXME: The recovery is not complete; it only partially rolls back
 696 some changes.
 697
 698 =cut
 699
 700 sub checkabortedinstall () {
 701     if (-l("$etcdir/koha.conf")
 702         && readlink("$etcdir/koha.conf") =~ /\.tmp$/
 703     ) {
 704         print qq|
 705 I have detected that you tried to install Koha before, but the installation
 706 was aborted.  I will try to continue, but there might be problems if the
 707 database is already created.
 708
 709 |;
 710         print "Please press <ENTER> to continue: ";
 711         <STDIN>;
 712
 713         # Remove the symlink after the <STDIN>, so the user can back out
 714         unlink "$etcdir/koha.conf"
 715             || die "Failed to remove incomplete $etcdir/koha.conf: $!\n";
 716     }
 717 }
 718
 719 =item checkpaths
 720
 721         checkpaths;
 722
 723 Make sure that we loaded the right dirs from an old koha.conf
 724
 725 =cut
 726
 727 #FIXME: update to use Install.pm
 728 sub checkpaths {
 729 if ($opacdir && $intranetdir) {
 730     print qq|
 731
 732 I believe that your old files are located in:
 733
 734   OPAC:      $opacdir
 735   LIBRARIAN: $intranetdir
 736
 737
 738 Does this look right?  ([Y]/N):
 739 |;
 740     $answer = <STDIN>;
 741     chomp $answer;
 742
 743     if ($answer =~/n/i) {
 744         $intranetdir='';
 745         $opacdir='';
 746     } else {
 747         print "Great! continuing upgrade... \n";
 748     }
 749 }
 750
 751 if (!$opacdir || !$intranetdir) {
 752     $intranetdir='';
 753     $opacdir='';
 754     while (!$intranetdir) {
 755         print "Please specify the location of your LIBRARIAN files: ";
 756
 757         $answer = <STDIN>;
 758         chomp $answer;
 759
 760         if ($answer) {
 761             $intranetdir=$answer;
 762         }
 763         if (! -e "$intranetdir/htdocs") {
 764             print "\nCouldn't find the htdocs directory here.  That doesn't look right.\nPlease enter another location.\n\n";
 765             $intranetdir='';
 766         }
 767     }
 768     while (!$opacdir) {
 769         print "Please specify the location of your OPAC files: ";
 770
 771         $answer = <STDIN>;
 772         chomp $answer;
 773
 774         if ($answer) {
 775             $opacdir=$answer;
 776         }
 777         if (! -e "$opacdir/htdocs") {
 778             print "\nCouldn't find the htdocs directory here.  That doesn't look right.\nPlease enter another location.\n\n";
 779             $opacdir='';
 780         }
 781     }
 782 }
 783
 784 }
 785
 786 =item checkperlmodules
 787
 788     checkperlmodules;
 789
 790 Test whether the version of Perl is new enough, whether Perl is
 791 found at the expected location, and whether all required modules
 792 have been installed.
 793
 794 =cut
 795
 796 sub checkperlmodules {
 797 #
 798 # Test for Perl and Modules
 799 #
 800
 801     my $message = getmessage('CheckingPerlModules');
 802     showmessage($message, 'none');
 803
 804     unless ($] >= 5.006001) {                   # Bug 179
 805         die getmessage('PerlVersionFailure', ['5.6.1']);
 806     }
 807         startsysout();
 808
 809     my @missing = ();
 810     unless (eval {require DBI})              { push @missing,"DBI" };
 811     unless (eval {require Date::Manip})      { push @missing,"Date::Manip" };
 812     unless (eval {require DBD::mysql})       { push @missing,"DBD::mysql" };
 813     unless (eval {require HTML::Template})   { push @missing,"HTML::Template" };
 814 #    unless (eval {require Set::Scalar})      { push @missing,"Set::Scalar" };
 815     unless (eval {require Digest::MD5})      { push @missing,"Digest::MD5" };
 816     unless (eval {require MARC::Record})     { push @missing,"MARC::Record" };
 817     unless (eval {require Mail::Sendmail})   { push @missing,"Mail::Sendmail" };
 818     unless (eval {require Event})       {
 819                 if ($#missing>=0) { # only when $#missing >= 0 so this isn't fatal
 820                     push @missing, "Event";
 821                 }
 822     }
 823     unless (eval {require Net::Z3950})       {
 824         showmessage(getmessage('NETZ3950Missing'), 'PressEnter', '', 1);
 825                 if ($#missing>=0) { # see above note
 826                     push @missing, "Net::Z3950";
 827                 }
 828     }
 829
 830 #
 831 # Print out a list of any missing modules
 832 #
 833
 834     if (@missing > 0) {
 835         my $missing='';
 836         if (POSIX::setlocale(LC_ALL) != "C") {
 837                 $missing.="   export LC_ALL=C\n";
 838         }
 839         foreach my $module (@missing) {
 840             $missing.="   perl -MCPAN -e 'install \"$module\"'\n";
 841         }
 842         my $message=getmessage('MissingPerlModules', [$missing]);
 843         showmessage($message, 'none');
 844         print "\n";
 845         exit;
 846     } else {
 847         showmessage(getmessage('AllPerlModulesInstalled'), 'PressEnter', '', 1);
 848     }
 849
 850
 851         startsysout();
 852     unless (-x "/usr/bin/perl") {
 853         my $realperl=`which perl`;
 854         chomp $realperl;
 855         $realperl = showmessage(getmessage('NoUsrBinPerl'), 'none');
 856         until (-x $realperl) {
 857             $realperl=showmessage(getmessage('AskLocationOfPerlExecutable', $realperl), 'free', $realperl, 1);
 858         }
 859         my $response=showmessage(getmessage('ConfirmPerlExecutableSymlink', $realperl), 'yn', 'y', 1);
 860         unless ($response eq 'n') {
 861                 startsysout();
 862             system("ln -s $realperl /usr/bin/perl");
 863         }
 864     }
 865
 866
 867 }
 868
 869 $messages->{'NoUsrBinPerl'}->{en} =
 870    heading('No /usr/bin/perl') . qq|
 871 Koha expects to find the perl executable in the /usr/bin
 872 directory.  It is not there on your system.
 873
 874 |;
 875
 876 $messages->{'AskLocationOfPerlExecutable'}->{en}=qq|Location of Perl Executable [%s]: |;
 877 $messages->{'ConfirmPerlExecutableSymlink'}->{en}=qq|
 878 Some Koha scripts will _not_ work without a symlink from %s to /usr/bin/perl
 879
 880 Most users should answer Y here.
 881
 882 May I try to create this symlink? ([Y]/N):|;
 883
 884 $messages->{'DirFailed'}->{en} = RED.qq|
 885 We could not create %s, but continuing anyway...
 886
 887 |;
 888
 889
 890
 891 =item getinstallationdirectories
 892
 893     getinstallationdirectories;
 894
 895 Get the various installation directories from the user, and then
 896 create those directories (if they do not already exist).
 897
 898 These pieces of information are saved to global variables; the
 899 function does not return any values.
 900
 901 =cut
 902
 903 sub getinstallationdirectories {
 904         if (!$ENV{prefix}) { $ENV{prefix} = "/usr/local"; }
 905     $opacdir = $ENV{prefix}.'/koha/opac';
 906     $intranetdir = $ENV{prefix}.'/koha/intranet';
 907     my $getdirinfo=1;
 908     while ($getdirinfo) {
 909         # Loop until opac directory and koha directory are different
 910         my $message=getmessage('GetOpacDir', [$opacdir]);
 911         $opacdir=showmessage($message, 'free', $opacdir);
 912
 913         $message=getmessage('GetIntranetDir', [$intranetdir]);
 914         $intranetdir=showmessage($message, 'free', $intranetdir);
 915
 916         if ($intranetdir eq $opacdir) {
 917             print qq|
 918
 919 You must specify different directories for the OPAC and INTRANET files!
 920  :: $intranetdir :: $opacdir ::
 921 |;
 922 <STDIN>
 923         } else {
 924             $getdirinfo=0;
 925         }
 926     }
 927     $kohalogdir=$ENV{prefix}.'/koha/log';
 928     my $message=getmessage('GetKohaLogDir', [$kohalogdir]);
 929     $kohalogdir=showmessage($message, 'free', $kohalogdir);
 930
 931
 932     # FIXME: Need better error handling for all mkdir calls here
 933     unless ( -d $intranetdir ) {
 934        mkdir_parents (dirname($intranetdir), 0775) || print getmessage('DirFailed',['parents of '.$intranetdir]);
 935        mkdir ($intranetdir,                  0770) || print getmessage('DirFailed',[$intranetdir]);
 936        if ($>==0) { chown (oct(0), (getgrnam($httpduser))[2], "$intranetdir"); }
 937        chmod 0770, "$intranetdir";
 938     }
 939     mkdir_parents ("$intranetdir/htdocs",    0750);
 940     mkdir_parents ("$intranetdir/cgi-bin",   0750);
 941     mkdir_parents ("$intranetdir/modules",   0750);
 942     mkdir_parents ("$intranetdir/scripts",   0750);
 943     unless ( -d $opacdir ) {
 944        mkdir_parents (dirname($opacdir),     0775) || print getmessage('DirFailed',['parents of '.$opacdir]);
 945        mkdir ($opacdir,                      0770) || print getmessage('DirFailed',[$opacdir]);
 946        if ($>==0) { chown (oct(0), (getgrnam($httpduser))[2], "$opacdir"); }
 947        chmod (oct(770), "$opacdir");
 948     }
 949     mkdir_parents ("$opacdir/htdocs",        0750);
 950     mkdir_parents ("$opacdir/cgi-bin",       0750);
 951
 952
 953     unless ( -d $kohalogdir ) {
 954        mkdir_parents (dirname($kohalogdir),  0775) || print getmessage('DirFailed',['parents of '.$kohalogdir]);
 955        mkdir ($kohalogdir,                   0770) || print getmessage('DirFailed',[$kohalogdir]);
 956        if ($>==0) { chown (oct(0), (getgrnam($httpduser))[2,3], "$kohalogdir"); }
 957        chmod (oct(770), "$kohalogdir");
 958     }
 959 }
 960
 961 =item getmysqldir
 962
 963         getmysqldir;
 964
 965 Get the MySQL database server installation directory, automatically if possible.
 966
 967 =cut
 968
 969 $messages->{'WhereIsMySQL'}->{en} = heading('MYSQL LOCATION').qq|
 970 Koha can't find MySQL. If you compiled mysql yourself,
 971 please give the value of --prefix when you ran configure.
 972 The file mysqladmin should be in bin/mysqladmin under the directory that you give here.
 973
 974 MySQL installation directory: |;
 975
 976 sub getmysqldir {
 977     foreach my $mysql (qw(/usr/local/mysql
 978                           /opt/mysql
 979                           /usr
 980                           )) {
 981        if ( -d $mysql  && -f "$mysql/bin/mysqladmin") {
 982             $mysqldir=$mysql;
 983        }
 984     }
 985     if (!$mysqldir){
 986         for (;;) {
 987             $mysqldir = showmessage(getmessage('WhereisMySQL'),'free');
 988             last if -f "$mysqldir/bin/mysqladmin";
 989         }
 990     }
 991     return($mysqldir);
 992 }
 993
 994 =item getdatabaseinfo
 995
 996     getdatabaseinfo;
 997
 998 Get various pieces of information related to the Koha database:
 999 the name of the database, the host on which the SQL server is
1000 running, and the database user name.
1001
1002 These pieces of information are saved to global variables; the
1003 function does not return any values.
1004
1005 =cut
1006
1007 $messages->{'DatabaseName'}->{en} = heading('Database Name') . qq|
1008 Please provide the name that you wish to give your koha database.
1009 It must not exist already on the database server.
1010
1011 Most users give a short single-word name for their library here.
1012
1013 Database name [%s]: |;
1014
1015 $messages->{'DatabaseHost'}->{en} = heading('Database Host') . qq|
1016 Please provide the mysql server name.  Unless the database is stored on
1017 another machine, this should be "localhost".
1018
1019 Database host [%s]: |;
1020
1021 $messages->{'DatabaseUser'}->{en} = heading('Database User') . qq|
1022 We are going to create a new mysql user for Koha. This user will have full administrative rights
1023 to the database called %s when they connect from %s.
1024 This is also the name of the Koha librarian superuser.
1025
1026 Most users give a single-word name here.
1027
1028 Database user [%s]: |;
1029
1030 $messages->{'DatabasePassword'}->{en} = heading('Database Password') . qq|
1031 Please provide a good password for the user %s.
1032
1033 IMPORTANT: You can log in using this user and password at any time.
1034
1035 Password for database user %s: |;
1036
1037 $messages->{'BlankPassword'}->{en} = heading('BLANK PASSWORD') . qq|
1038 You must not use a blank password for your MySQL user.
1039
1040 Press <ENTER> to try again:
1041 |;
1042
1043 sub getdatabaseinfo {
1044
1045     $dbname = 'Koha';
1046     $hostname = 'localhost';
1047     $user = 'kohaadmin';
1048     $pass = '';
1049
1050 #Get the database name
1051
1052     my $message=getmessage('DatabaseName', [$dbname]);
1053     $dbname=showmessage($message, 'free', $dbname);
1054
1055 #Get the hostname for the database
1056
1057     $message=getmessage('DatabaseHost', [$hostname]);
1058     $hostname=showmessage($message, 'free', $hostname);
1059
1060 #Get the username for the database
1061
1062     $message=getmessage('DatabaseUser', [$dbname, $hostname, $user]);
1063     $user=showmessage($message, 'free', $user);
1064
1065 #Get the password for the database user
1066
1067     while ($pass eq '') {
1068         my $message=getmessage('DatabasePassword', [$user, $user]);
1069         $pass=showmessage($message, 'free', $pass);
1070         if ($pass eq '') {
1071             my $message=getmessage('BlankPassword');
1072             showmessage($message,'PressEnter');
1073         }
1074     }
1075 }
1076
1077
1078
1079 =item getapacheinfo
1080
1081     getapacheinfo;
1082
1083 Get various pieces of information related to the Apache server:
1084 the location of the configuration file and, if needed, the Unix
1085 user that the Koha CGI will be run under.
1086
1087 These pieces of information are saved to global variables; the
1088 function does not return any values.
1089
1090 =cut
1091
1092 $messages->{'FoundMultipleApacheConfFiles'}->{en} =
1093    heading('MULTIPLE APACHE CONFIG FILES FOUND') . qq|
1094 I found more than one possible Apache configuration file:
1095
1096 %s
1097
1098 Enter number of the file to read [1]: |;
1099
1100 $messages->{'NoApacheConfFiles'}->{en} =
1101    heading('NO APACHE CONFIG FILE FOUND') . qq|
1102 I was not able to find your Apache configuration file.
1103
1104 The file is usually called httpd.conf, apache.conf or similar.
1105
1106 Please enter the full name, starting with /: |;
1107
1108 $messages->{'NotAFile'}->{en} = heading('FILE DOES NOT EXIST') . qq|
1109 The file %s does not exist.
1110
1111 Please press <ENTER> to continue: |;
1112
1113 $messages->{'EnterApacheUser'}->{en} = heading('NEED APACHE USER') . qq\
1114 The installer could not find the User setting in the Apache configuration file.
1115 This is used to set up access permissions for
1116 %s/koha.conf.  This user should be set in one of the Apache configuration.
1117 Please try to find it and enter the user name below.  You might find
1118 that "ps u|grep apache" will tell you.  It probably is NOT "root".
1119
1120 Enter the Apache userid: \;
1121
1122 $messages->{'InvalidUserid'}->{en} = heading('INVALID USER') . qq|
1123 The userid %s is not a valid userid on this system.
1124
1125 Press <ENTER> to continue: |;
1126
1127 sub getapacheinfo {
1128     my @confpossibilities;
1129
1130     foreach my $httpdconf (qw(/usr/local/apache/conf/httpd.conf
1131                           /usr/local/etc/apache/httpd.conf
1132                           /usr/local/etc/apache/apache.conf
1133                           /var/www/conf/httpd.conf
1134                           /etc/apache2/httpd.conf
1135                           /etc/apache2/apache2.conf
1136                           /etc/apache/conf/httpd.conf
1137                           /etc/apache/conf/apache.conf
1138                           /etc/apache-ssl/conf/apache.conf
1139                           /etc/apache-ssl/httpd.conf
1140                           /etc/httpd/conf/httpd.conf
1141                           /etc/httpd/httpd.conf
1142                           /etc/httpd/2.0/conf/httpd2.conf
1143                           )) {
1144         if ( -f $httpdconf ) {
1145             push @confpossibilities, $httpdconf;
1146         }
1147     }
1148
1149     if ($#confpossibilities==-1) {
1150         my $message=getmessage('NoApacheConfFiles');
1151         my $choice='';
1152         $realhttpdconf='';
1153         until (-f $realhttpdconf) {
1154             $choice=showmessage($message, "free", 1);
1155             if (-f $choice) {
1156                 $realhttpdconf=$choice;
1157             } else {
1158                 showmessage(getmessage('NotAFile', [$choice]),'PressEnter', '', 1);
1159             }
1160         }
1161     } elsif ($#confpossibilities>0) {
1162         my $conffiles='';
1163         my $counter=1;
1164         my $options='';
1165         foreach (@confpossibilities) {
1166             $conffiles.="   $counter: $_\n";
1167             $options.="$counter";
1168             $counter++;
1169         }
1170         my $message=getmessage('FoundMultipleApacheConfFiles', [$conffiles]);
1171         my $choice=showmessage($message, "restrictchar $options", 1);
1172         $realhttpdconf=$confpossibilities[$choice-1];
1173     } else {
1174         $realhttpdconf=$confpossibilities[0];
1175     }
1176     unless (open (HTTPDCONF, "<$realhttpdconf")) {
1177         warn RED."Insufficient privileges to open $realhttpdconf for reading.\n";
1178         sleep 4;
1179     }
1180
1181     while (<HTTPDCONF>) {
1182         if (/^\s*User\s+"?([-\w]+)"?\s*$/) {
1183             $httpduser = $1;
1184         }
1185     }
1186     close(HTTPDCONF);
1187
1188     unless (defined($httpduser)) {
1189         my $message=getmessage('EnterApacheUser', [$etcdir]);
1190         until (defined($httpduser) && length($httpduser) && getpwnam($httpduser)) {
1191             $httpduser=showmessage($message, "free", '');
1192             if (length($httpduser)>0) {
1193                 unless (getpwnam($httpduser)) {
1194                     my $message=getmessage('InvalidUserid', [$httpduser]);
1195                     showmessage($message,'PressEnter');
1196                 }
1197             } else {
1198             }
1199         }
1200     }
1201 }
1202
1203
1204 =item getapachevhostinfo
1205
1206     getapachevhostinfo;
1207
1208 Gets various pieces of information related to virtual hosting:
1209 the webmaster email address, virtual hostname, and the ports
1210 that the OPAC and INTRANET modules run on.
1211
1212 These pieces of information are saved to global variables; the
1213 function does not return any values.
1214
1215 =cut
1216
1217 $messages->{'ApacheConfigIntroduction'}->{en} =
1218    heading('APACHE CONFIGURATION') . qq|
1219 Koha needs to write an Apache configuration file for the
1220 OPAC and Librarian sites.  By default this installer
1221 will do this by using one name and two different ports
1222 for the virtual hosts.  There are other ways to set this up,
1223 and the installer will leave comments in
1224 %s/koha-httpd.conf about them.
1225
1226 NOTE: You will need to add lines to your main httpd.conf to
1227 include %s/koha-httpd.conf
1228 and to make sure it is listening on the right ports
1229 (using the Listen directive).
1230
1231 Press <ENTER> to continue: |;
1232
1233 $messages->{'GetVirtualHostEmail'}->{en} =
1234    heading('WEB E-MAIL CONTACT') . qq|
1235 Enter the e-mail address to be used as a contact for Koha.  This
1236 address is displayed if fatal errors are encountered.
1237
1238 E-mail contact [%s]: |;
1239
1240 $messages->{'GetServerName'}->{en} =
1241    heading('WEB HOST NAME OR IP ADDRESS') . qq|
1242 Please enter the host name or IP address that you wish to use for koha.
1243 Normally, this should be a name or IP that belongs to this machine.
1244
1245 Host name or IP Address [%s]: |;
1246
1247 $messages->{'GetOpacPort'}->{en} = heading('OPAC PORT') . qq|
1248 Please enter the port for your OPAC interface.  This defaults to port 80, but
1249 if you are already serving web content with this hostname, you should change it
1250 to a different port (8000 might be a good choice, but check any firewalls).
1251
1252 Enter the OPAC Port [%s]: |;
1253
1254 $messages->{'GetIntranetPort'}->{en} =
1255    heading('LIBRARIAN PORT') . qq|
1256 Please enter the port for your Librarian interface.  This must be different from
1257 the OPAC port (%s).
1258
1259 Enter the Intranet Port [%s]: |;
1260
1261
1262 sub getapachevhostinfo {
1263
1264     $svr_admin = "webmaster\@$domainname";
1265     $servername=`hostname`;
1266     chomp $servername;
1267     $opacport=80;
1268     $intranetport=8080;
1269
1270     showmessage(getmessage('ApacheConfigIntroduction',[$etcdir,$etcdir]), 'PressEnter');
1271
1272     $svr_admin=showmessage(getmessage('GetVirtualHostEmail', [$svr_admin]), 'email', $svr_admin);
1273     $servername=showmessage(getmessage('GetServerName', [$servername]), 'free', $servername);
1274
1275
1276     $opacport=showmessage(getmessage('GetOpacPort', [$opacport]), 'numerical', $opacport);
1277     $intranetport=showmessage(getmessage('GetIntranetPort', [$opacport, $intranetport]), 'numerical', $intranetport);
1278
1279 }
1280
1281
1282 =item updateapacheconf
1283
1284     updateapacheconf;
1285
1286 Updates the Apache config file according to parameters previously
1287 specified by the user.
1288
1289 It will append fully-commented directives at the end of the original
1290 Apache config file.  The old config file is renamed with an extension
1291 of .prekoha.
1292
1293 If you need to uninstall Koha for any reason, the lines between
1294
1295     # Ports to listen to for Koha
1296
1297 and the block of comments beginning with
1298
1299     # If you want to use name based Virtual Hosting:
1300
1301 must be removed.
1302
1303 =cut
1304
1305 $messages->{'StartUpdateApache'}->{en} =
1306    heading('UPDATING APACHE CONFIGURATION') . qq|
1307 Checking for modules that need to be loaded...
1308 |;
1309
1310 $messages->{'ApacheConfigMissingModules'}->{en} =
1311    heading('APACHE CONFIGURATION NEEDS UPDATE') . qq|
1312 Koha uses the mod_env and mod_include apache features, but the
1313 installer did not find them in your config.  Please
1314 make sure that they are enabled for your Koha site.
1315
1316 Press <ENTER> to continue: |;
1317
1318
1319 $messages->{'ApacheAlreadyConfigured'}->{en} =
1320    heading('APACHE ALREADY CONFIGURED') . qq|
1321 %s appears to already have an entry for Koha.  You may need to edit %s
1322 if anything has changed since it was last set up.  This
1323 script will not attempt to modify an existing Koha apache
1324 configuration.
1325
1326 Press <ENTER> to continue: |;
1327
1328 sub updateapacheconf {
1329     my $logfiledir=$kohalogdir;
1330     my $httpdconf = $etcdir."/koha-httpd.conf";
1331
1332     showmessage(getmessage('StartUpdateApache'), 'none');
1333         # to be polite about it: I don't think this should touch the main httpd.conf
1334
1335         # QUESTION: Should we warn for includes_module too?
1336     my $envmodule=0;
1337     my $includesmodule=0;
1338     open HC, "<$realhttpdconf";
1339     while (<HC>) {
1340         if (/^\s*#\s*LoadModule env_module /) {
1341             showmessage(getmessage('ApacheConfigMissingModules'));
1342             $envmodule=1;
1343         }
1344         if (/\s*LoadModule includes_module / ) {
1345             $includesmodule=1;
1346         }
1347     }
1348
1349         startsysout;
1350     if (`grep -q 'VirtualHost $servername' "$httpdconf" 2>/dev/null`) {
1351         showmessage(getmessage('ApacheAlreadyConfigured', [$httpdconf, $httpdconf]), 'PressEnter');
1352         return;
1353     } else {
1354         my $includesdirectives='';
1355         if ($includesmodule) {
1356             $includesdirectives.="Options +Includes\n";
1357             $includesdirectives.="   AddHandler server-parsed .html\n";
1358         }
1359         open(SITE,">$httpdconf") or warn "Insufficient priveleges to open $httpdconf for writing.\n";
1360         my $opaclisten = '';
1361         if ($opacport != 80) {
1362             $opaclisten="Listen $opacport";
1363         }
1364         my $intranetlisten = '';
1365         if ($intranetport != 80) {
1366             $intranetlisten="Listen $intranetport";
1367         }
1368         print SITE <<EOP
1369
1370 # Ports to listen to for Koha
1371 # uncomment these if they aren't already in main httpd.conf
1372 #$opaclisten
1373 #$intranetlisten
1374
1375 # NameVirtualHost is used by one of the optional configurations detailed below
1376
1377 #NameVirtualHost 11.22.33.44
1378
1379 # KOHA's OPAC Configuration
1380 <VirtualHost $servername\:$opacport>
1381    ServerAdmin $svr_admin
1382    DocumentRoot $opacdir/htdocs
1383    ServerName $servername
1384    ScriptAlias /cgi-bin/koha/ $opacdir/cgi-bin/
1385    ErrorLog $logfiledir/opac-error_log
1386    TransferLog $logfiledir/opac-access_log
1387    SetEnv PERL5LIB "$intranetdir/modules"
1388    SetEnv KOHA_CONF "$etcdir/koha.conf"
1389    $includesdirectives
1390 </VirtualHost>
1391
1392 # KOHA's INTRANET Configuration
1393 <VirtualHost $servername\:$intranetport>
1394    ServerAdmin $svr_admin
1395    DocumentRoot $intranetdir/htdocs
1396    ServerName $servername
1397    ScriptAlias /cgi-bin/koha/ "$intranetdir/cgi-bin/"
1398    ErrorLog $logfiledir/koha-error_log
1399    TransferLog $logfiledir/koha-access_log
1400    SetEnv PERL5LIB "$intranetdir/modules"
1401    SetEnv KOHA_CONF "$etcdir/koha.conf"
1402    $includesdirectives
1403 </VirtualHost>
1404
1405 # If you want to use name based Virtual Hosting:
1406 #   1. remove the two Listen lines
1407 #   2. replace $servername\:$opacport wih your.opac.domain.name
1408 #   3. replace ServerName $servername wih ServerName your.opac.domain.name
1409 #   4. replace $servername\:$intranetport wih your intranet domain name
1410 #   5. replace ServerName $servername wih ServerName your.intranet.domain.name
1411 #
1412 # If you want to use NameVirtualHost'ing (using two names on one ip address):
1413 #   1.  Follow steps 1-5 above
1414 #   2.  Uncomment the NameVirtualHost line and set the correct ip address
1415
1416 EOP
1417
1418
1419     }
1420 }
1421
1422
1423 =item basicauthentication
1424
1425     basicauthentication;
1426
1427 Asks the user whether HTTP basic authentication is wanted, and,
1428 if so, the user name and password for the basic authentication.
1429
1430 These pieces of information are saved to global variables; the
1431 function does not return any values.
1432
1433 =cut
1434
1435 $messages->{'IntranetAuthenticationQuestion'}->{en} =
1436    heading('LIBRARIAN AUTHENTICATION') . qq|
1437 The Librarian site can be password protected using
1438 Apache's Basic Authorization instead of Koha user details.
1439
1440 This method going to be phased out very soon.  Most users should answer N here.
1441
1442 Would you like to do this (Y/[N]): |;   #'
1443
1444 $messages->{'BasicAuthUsername'}->{en}="Please enter a username for librarian access [%s]: ";
1445 $messages->{'BasicAuthPassword'}->{en}="Please enter a password for %s: ";
1446 $messages->{'BasicAuthPasswordWasBlank'}->{en}="\nYou cannot use a blank password!\n\n";
1447
1448 sub basicauthentication {
1449     my $message=getmessage('IntranetAuthenticationQuestion');
1450     my $answer=showmessage($message, 'yn', 'n');
1451     my $httpdconf = $etcdir."/koha-httpd.conf";
1452
1453     my $apacheauthusername='librarian';
1454     my $apacheauthpassword='';
1455     if ($answer=~/^y/i) {
1456         ($apacheauthusername) = showmessage(getmessage('BasicAuthUsername', [ $apacheauthusername]), 'free', $apacheauthusername, 1);
1457         $apacheauthusername=~s/[^a-zA-Z0-9]//g;
1458         while (! $apacheauthpassword) {
1459             ($apacheauthpassword) = showmessage(getmessage('BasicAuthPassword', [ $apacheauthusername]), 'free', 1);
1460             if (!$apacheauthpassword) {
1461                 ($apacheauthpassword) = showmessage(getmessage('BasicAuthPasswordWasBlank'), 'none', '', 1);
1462             }
1463         }
1464         open AUTH, ">$etcdir/kohaintranet.pass";
1465         my $chars='ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
1466         my $salt=substr($chars, int(rand(length($chars))),1);
1467         $salt.=substr($chars, int(rand(length($chars))),1);
1468         print AUTH $apacheauthusername.":".crypt($apacheauthpassword, $salt)."\n";
1469         close AUTH;
1470         open(SITE,">>$httpdconf") or warn "Insufficient priveleges to open $realhttpdconf for writing.\n";
1471         print SITE <<EOP
1472
1473 <Directory $intranetdir>
1474     AuthUserFile $etcdir/kohaintranet.pass
1475     AuthType Basic
1476     AuthName "Koha Intranet (for librarians only)"
1477     Require  valid-user
1478 </Directory>
1479 EOP
1480     }
1481     close(SITE);
1482 }
1483
1484
1485 =item installfiles
1486
1487     installfiles
1488
1489 Install the Koha files to the specified OPAC and INTRANET
1490 directories (usually in /usr/local/koha).
1491
1492 The koha.conf file is created, but as koha.conf.tmp. The
1493 caller is responsible for calling finalizeconfigfile when
1494 installation is completed, to rename it back to koha.conf.
1495
1496 =cut
1497
1498 $messages->{'InstallFiles'}->{en} = heading('INSTALLING FILES') . qq|
1499 Copying files to installation directories:
1500
1501 |;
1502
1503 $messages->{'OldFiles'}->{en} = heading('OLD FILES') . qq|
1504 Any files from the previous edition of Koha have been
1505 copied to a dated backup directory alongside the new
1506 installation. You should move any custom files that you
1507 want to keep (such as your site templates) into the new
1508 directories and then move the backup off of the live
1509 server.
1510
1511 Press ENTER to continue:|;
1512
1513
1514 $messages->{'CopyingFiles'}->{en}="Copying %s to %s.\n";
1515
1516
1517
1518 sub installfiles {
1519
1520         #MJR: preserve old files, just in case
1521         sub neatcopy {
1522                 my $desc = shift;
1523                 my $src = shift;
1524                 my $tgt = shift;
1525
1526                 if (-e $tgt) {
1527                 print getmessage('CopyingFiles', ["old ".$desc,$tgt.strftime("%Y%m%d%H%M",localtime())]);
1528                         startsysout();
1529                         system("mv ".$tgt." ".$tgt.".old");
1530                 }
1531
1532         print getmessage('CopyingFiles', [$desc,$tgt]);
1533         startsysout;
1534             system("cp -R ".$src." ".$tgt);
1535         }
1536
1537     showmessage(getmessage('InstallFiles'),'none');
1538
1539     neatcopy("admin templates", 'intranet-html', "$intranetdir/htdocs");
1540     neatcopy("admin interface", 'intranet-cgi', "$intranetdir/cgi-bin");
1541     neatcopy("main scripts", 'scripts', "$intranetdir/scripts");
1542     neatcopy("perl modules", 'modules', "$intranetdir/modules");
1543     neatcopy("OPAC templates", 'opac-html', "$opacdir/htdocs");
1544     neatcopy("OPAC interface", 'opac-cgi', "$opacdir/cgi-bin");
1545         startsysout();
1546     system("touch $opacdir/cgi-bin/opac");
1547
1548         #MJR: is this necessary?
1549         if ($> == 0) {
1550             system("chown -R $httpduser:$httpduser $opacdir $intranetdir");
1551     }
1552         system("chmod -R a+rx $opacdir $intranetdir");
1553
1554     # Create /etc/koha.conf
1555
1556     my $old_umask = umask(027); # make sure koha.conf is never world-readable
1557     open(SITES,">$etcdir/koha.conf.tmp") or warn "Couldn't create file at $etcdir. Must have write capability.\n";
1558     print SITES qq|
1559 database=$dbname
1560 hostname=$hostname
1561 user=$user
1562 pass=$pass
1563 includes=$opacdir/htdocs/includes
1564 intranetdir=$intranetdir
1565 opacdir=$opacdir
1566 kohalogdir=$kohalogdir
1567 kohaversion=$newversion
1568 httpduser=$httpduser
1569 intrahtdocs=$intranetdir/htdocs/intranet-tmpl
1570 opachtdocs=$opacdir/htdocs/opac-tmpl
1571 |;
1572     close(SITES);
1573     umask($old_umask);
1574
1575         startsysout();
1576         #MJR: can't help but this be broken, can we?
1577     chmod 0440, "$etcdir/koha.conf.tmp";
1578
1579         #MJR: does this contain any passwords?
1580     chmod 0755, "$intranetdir/scripts/z3950daemon/z3950-daemon-launch.sh", "$intranetdir/scripts/z3950daemon/z3950-daemon-shell.sh", "$intranetdir/scripts/z3950daemon/processz3950queue";
1581
1582         #MJR: generate our own settings, to remove the /home/paul hardwired links
1583     open(FILE,">$intranetdir/scripts/z3950daemon/z3950-daemon-options");
1584     print FILE "RunAsUser=apache\nKohaZ3950Dir=$intranetdir/scripts/z3950daemon\nKohaModuleDir=$intranetdir/modules\nLogDir=$kohalogdir\nKohaConf=$etcdir/koha.conf";
1585     close(FILE);
1586
1587         if ($> == 0) {
1588             chown((getpwnam($httpduser)) [2,3], "$etcdir/koha.conf.tmp") or warn "can't chown koha.conf: $!";
1589         chown(0, (getpwnam($httpduser)) [3], "$intranetdir/scripts/z3950daemon/z3950-daemon-shell.sh") or warn "can't chown $intranetdir/scripts/z3950daemon/z3950-daemon-shell.sh: $!";
1590         chown(0, (getpwnam($httpduser)) [3], "$intranetdir/scripts/z3950daemon/processz3950queue") or warn "can't chown $intranetdir/scripts/z3950daemon/processz3950queue: $!";
1591         } #MJR: FIXME: Should report that we haven't chown()d.
1592
1593     showmessage(getmessage('OldFiles'),'PressEnter');
1594 }
1595
1596
1597 =item databasesetup
1598
1599     databasesetup;
1600
1601 Finds out where the MySQL utitlities are located in the system,
1602 then create the Koha database structure and MySQL permissions.
1603
1604 =cut
1605
1606 $messages->{'MysqlRootPassword'}->{en} =
1607    heading('MYSQL ROOT USER PASSWORD') . qq|
1608 To create the koha database, please enter your
1609 mysql server's root user password:
1610
1611 Password: |;    #'
1612
1613 $messages->{'CreatingDatabase'}->{en} = heading('CREATING DATABASE') . qq|
1614 Creating the MySQL database for Koha...
1615
1616 |;
1617
1618 $messages->{'CreatingDatabaseError'}->{en} =
1619    heading('ERROR CREATING DATABASE') . qq|
1620 Couldn't connect to the MySQL server for the reason given above.
1621 This is a serious problem, the database will not get installed.
1622
1623 Press <ENTER> to continue: |;   #'
1624
1625 $messages->{'SampleData'}->{en} = heading('SAMPLE DATA') . qq|
1626 If you are installing Koha for evaluation purposes,
1627 you can install some sample data now.
1628
1629 If you are installing Koha to use your own
1630 data, you probably don't want this sample data installed.
1631
1632 Would you like to install the sample data? Y/[N]: |;    #'
1633
1634 $messages->{'SampleDataInstalled'}->{en} =
1635    heading('SAMPLE DATA INSTALLED') . qq|
1636 Sample data has been installed.  For some suggestions on testing Koha, please
1637 read the file doc/HOWTO-Testing.  If you find any bugs, please submit them at
1638 http://bugs.koha.org/.  If you need help with testing Koha, you can post a
1639 question through the koha-devel mailing list, or you can check for a developer
1640 online at irc.katipo.co.nz:6667 channel #koha.
1641
1642 You can find instructions for subscribing to the Koha mailing lists at:
1643
1644     http://www.koha.org
1645
1646
1647 Press <ENTER> to continue: |;
1648
1649 $messages->{'AddBranchPrinter'}->{en} = heading('Add Branch and Printer') . qq|
1650 Would you like to describe an initial branch and printer? [Y]/N: |;
1651
1652 $messages->{'BranchName'}->{en}="Branch Name [%s]: ";
1653 $messages->{'BranchCode'}->{en}="Branch Code (4 letters or numbers) [%s]: ";
1654 $messages->{'PrinterQueue'}->{en}="Printer Queue [%s]: ";
1655 $messages->{'PrinterName'}->{en}="Printer Name [%s]: ";
1656
1657 sub databasesetup {
1658     $mysqluser = 'root';
1659     $mysqlpass = '';
1660         my $mysqldir = getmysqldir();
1661
1662     # we must not put the mysql root password on the command line
1663         $mysqlpass=     showmessage(getmessage('MysqlRootPassword'),'silentfree');
1664
1665         showmessage(getmessage('CreatingDatabase'),'none');
1666         # set the login up
1667         setmysqlclipass($mysqlpass);
1668         # Set up permissions
1669         startsysout();
1670         print system("$mysqldir/bin/mysql -u$mysqluser mysql -e \"insert into user (Host,User,Password) values ('$hostname','$user',password('$pass'))\"\;");
1671         system("$mysqldir/bin/mysql -u$mysqluser mysql -e \"insert into db (Host,Db,User,Select_priv,Insert_priv,Update_priv,Delete_priv,Create_priv,Drop_priv, index_priv, alter_priv) values ('%','$dbname','$user','Y','Y','Y','Y','Y','Y','Y','Y')\"");
1672         system("$mysqldir/bin/mysqladmin -u$mysqluser reload");
1673         # Change to admin user login
1674         setmysqlclipass($pass);
1675         my $result=system("$mysqldir/bin/mysqladmin", "-u$user", "create", "$dbname");
1676         if ($result) {
1677                 showmessage(getmessage('CreatingDatabaseError'),'PressEnter', '', 1);
1678         } else {
1679                 # Create the database structure
1680                 startsysout();
1681                 system("$mysqldir/bin/mysql -u$user $dbname < koha.mysql");
1682         }
1683
1684 }
1685
1686
1687 =item updatedatabase
1688
1689     updatedatabase;
1690
1691 Updates the Koha database structure, including the addition of
1692 MARC tables.
1693
1694 The MARC tables are also populated in addition to being created.
1695
1696 Because updatedatabase calls scripts/updater/updatedatabase to
1697 do the actual update, and that script uses C4::Context,
1698 $etcdir/koha.conf must exist at this point. We use the KOHA_CONF
1699 environment variable to do this.
1700
1701 FIXME: (See checkabortedinstall as it depends on old symlink way.)
1702
1703 =cut
1704
1705 $messages->{'UpdateMarcTables'}->{en} =
1706    heading('MARC FIELD DEFINITIONS') . qq|
1707 You can import MARC settings for:
1708
1709   1 MARC21
1710   2 UNIMARC
1711   N none
1712
1713 NOTE: If you choose N,
1714 nothing will be added, and you must create them all yourself.
1715 Only choose N if you want to use a MARC format not listed here,
1716 such as DANMARC.  We would like to hear from you if you do.
1717
1718 Choose MARC definition [1]: |;
1719
1720 $messages->{'Language'}->{en} = heading('CHOOSE LANGUAGE') . qq|
1721 This version of koha supports a few languages.
1722
1723   en : default language, all pages available
1724   fr : complete translation (except pictures)
1725   es : partial librarian site translation (including pictures)
1726   pl : complete OPAC and partial librarian translation
1727   zh_TW : partial translation
1728
1729 en is used when a screen is not available in your language
1730
1731 If you specify a language here, you can still
1732 change it from the system preferences screen in the librarian sit.
1733
1734 Which language do you choose? |;
1735
1736 sub updatedatabase {
1737     # At this point, $etcdir/koha.conf must exist, for C4::Context
1738     $ENV{"KOHA_CONF"}=$etcdir.'/koha.conf.tmp';
1739         startsysout();
1740         my $result=system ("perl -I $intranetdir/modules scripts/updater/updatedatabase");
1741         if ($result) {
1742                 restoremycnf();
1743                 print "Problem updating database...\n";
1744                 exit;
1745         }
1746
1747         if ($kohaversion =~ /^1\.[012]\./) {
1748                 my $response=showmessage(getmessage('UpdateMarcTables'), 'restrictchar 12N', '1');
1749
1750                 startsysout();
1751                 if ($response eq '1') {
1752                         system("cat scripts/misc/marc_datas/marc21_en/structure_def.sql | $mysqldir/bin/mysql -u$user $dbname");
1753                 }
1754                 if ($response eq '2') {
1755                         system("cat scripts/misc/marc_datas/unimarc_fr/structure_def.sql | $mysqldir/bin/mysql -u$user $dbname");
1756                         system("cat scripts/misc/lang-datas/fr/stopwords.sql | $mysqldir/bin/mysql -u$user $dbname");
1757                 }
1758                 delete($ENV{"KOHA_CONF"});
1759         }
1760
1761         print RESET."\n\nFinished updating of database. Press <ENTER> to continue...";
1762         <STDIN>;
1763 }
1764
1765
1766 =item populatedatabase
1767
1768     populatedatabase;
1769
1770 Populate the non-MARC tables. If the user wants to install the
1771 sample data, install them.
1772
1773 =cut
1774
1775 sub populatedatabase {
1776 #       my $response=showmessage(getmessage('SampleData'), 'yn', 'n');
1777 #       if ($response =~/^y/i) {
1778 #
1779 # FIXME: These calls are now unsafe and should either be removed
1780 # or updated to use -u$user and no mysqlpass_quoted
1781 #
1782 #               system("gunzip -d < sampledata-1.2.gz | $mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname");
1783 #               system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname -e \"insert into branches (branchcode,branchname,issuing) values ('MAIN', 'Main Library', 1)\"");
1784 #               system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname -e \"insert into branchrelations (branchcode,categorycode) values ('MAIN', 'IS')\"");
1785 #               system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname -e \"insert into branchrelations (branchcode,categorycode) values ('MAIN', 'CU')\"");
1786 #               system("$mysqldir/bin/mysql -u$mysqluser $mysqlpass_quoted $dbname -e \"insert into printers (printername,printqueue,printtype) values ('Circulation Desk Printer', 'lp', 'hp')\"");
1787 #               showmessage(getmessage('SampleDataInstalled'), 'PressEnter','',1);
1788 #       } else {
1789                 my $input;
1790                 my $response=showmessage(getmessage('AddBranchPrinter'), 'yn', 'y');
1791
1792                 unless ($response =~/^n/i) {
1793                 my $branch='Main Library';
1794                 $branch=showmessage(getmessage('BranchName', [$branch]), 'free', $branch, 1);
1795                 $branch=~s/[^A-Za-z0-9\s]//g;
1796
1797                 my $branchcode=$branch;
1798                 $branchcode=~s/[^A-Za-z0-9]//g;
1799                 $branchcode=uc($branchcode);
1800                 $branchcode=substr($branchcode,0,4);
1801                 $branchcode=showmessage(getmessage('BranchCode', [$branchcode]), 'free', $branchcode, 1);
1802                 $branchcode=~s/[^A-Za-z0-9]//g;
1803                 $branchcode=uc($branchcode);
1804                 $branchcode=substr($branchcode,0,4);
1805                 $branchcode or $branchcode='DEF';
1806
1807                 startsysout();
1808                 system("$mysqldir/bin/mysql -u$user $dbname -e \"insert into branches (branchcode,branchname,issuing) values ('$branchcode', '$branch', 1)\"");
1809                 system("$mysqldir/bin/mysql -u$user $dbname -e \"insert into branchrelations (branchcode,categorycode) values ('MAIN', 'IS')\"");
1810                 system("$mysqldir/bin/mysql -u$user $dbname -e \"insert into branchrelations (branchcode,categorycode) values ('MAIN', 'CU')\"");
1811
1812                 my $printername='Library Printer';
1813                 $printername=showmessage(getmessage('PrinterName', [$printername]), 'free', $printername, 1);
1814                 $printername=~s/[^A-Za-z0-9\s]//g;
1815
1816                 my $printerqueue='lp';
1817                 $printerqueue=showmessage(getmessage('PrinterQueue', [$printerqueue]), 'free', $printerqueue, 1);
1818                 $printerqueue=~s/[^A-Za-z0-9]//g;
1819                 startsysout();
1820                 system("$mysqldir/bin/mysql -u$user $dbname -e \"insert into printers (printername,printqueue,printtype) values ('$printername', '$printerqueue', '')\"");
1821 #               }
1822         my $language=showmessage(getmessage('Language'), 'free', 'en');
1823         startsysout();
1824         system("$mysqldir/bin/mysql -u$user $dbname -e \"update systempreferences set value='$language' where variable='opaclanguages'\"");
1825         }
1826 }
1827
1828
1829 =item restartapache
1830
1831     restartapache;
1832
1833 Asks the user whether to restart Apache, and restart it if the user
1834 wants so.
1835
1836 =cut
1837
1838 $messages->{'RestartApache'}->{en} = heading('RESTART APACHE') . qq|
1839 The web server daemon needs to be restarted to load the new configuration for Koha.
1840 The installer can do this if you are using Apache and give the root password.
1841
1842 Would you like to try to restart Apache now?  [Y]/N: |;
1843
1844 sub restartapache {
1845
1846     my $response=showmessage(getmessage('RestartApache'), 'yn', 'y');
1847
1848     unless ($response=~/^n/i) {
1849         startsysout();
1850         # Need to support other init structures here?
1851         if (-e "/etc/rc.d/init.d/httpd") {
1852             system('su root -c /etc/rc.d/init.d/httpd restart');
1853         } elsif (-e "/etc/init.d/apache") {
1854             system('su root -c /etc/init.d/apache restart');
1855         } elsif (-e "/etc/init.d/apache-ssl") {
1856             system('su root -c /etc/init.d/apache-ssl restart');
1857         }
1858     }
1859
1860 }
1861
1862 =item backupkoha
1863
1864    backupkoha;
1865
1866 This function attempts to back up all koha's details.
1867
1868 =cut
1869
1870 $messages->{'BackupDir'}->{en} = heading('BACKUP STORAGE').qq|
1871 The upgrader will now try to backup your old files.
1872
1873 Please specify a directory to store the backup in [%s]: |;
1874
1875 $messages->{'BackupSummary'}->{en} = heading('BACKUP SUMMARY').qq|
1876 Backed up:
1877
1878 %6d biblio entries
1879 %6d biblioitems entries
1880 %6d items entries
1881 %6d borrowers
1882
1883 File Listing
1884 ---------------------------------------------------------------------
1885 %s
1886 ---------------------------------------------------------------------
1887
1888 Does this look right? ([Y]/N): |;
1889
1890 #FIXME: rewrite to use Install.pm
1891 sub backupkoha {
1892 my $backupdir=$ENV{'prefix'}.'/backups';
1893
1894 $answer = showmessage(getmessage('BackupDir',[$backupdir]),'free',$backupdir);
1895
1896 if (! -e $backupdir) {
1897         my $result=mkdir ($backupdir, oct(770));
1898         if ($result==0) {
1899                 my @dirs = split(m#/#, $backupdir);
1900                 my $checkdir='';
1901                 foreach (@dirs) {
1902                         $checkdir.="$_/";
1903                         unless (-e "$checkdir") {
1904                                 mkdir($checkdir, 0775);
1905                         }
1906                 }
1907         }
1908 }
1909
1910 chmod 0770, $backupdir;
1911
1912 # Backup MySql database
1913 #
1914 #
1915 my $mysqldir = getmysqldir();
1916
1917 my ($sec, $min, $hr, $day, $month, $year) = (localtime(time))[0,1,2,3,4,5];
1918 $month++;
1919 $year+=1900;
1920 my $date= sprintf "%4d-%02d-%02d_%02d:%02d:%02d", $year, $month, $day,$hr,$min,$sec;
1921
1922 open (MD, "$mysqldir/bin/mysqldump --user=$user --password=$pass --host=$hostname $database|");
1923
1924 (open BF, ">$backupdir/Koha.backup_$date") || (die "Error opening up backup file $backupdir/Koha.backup_$date: $!\n");
1925
1926 my $itemcounter=0;
1927 my $bibliocounter=0;
1928 my $biblioitemcounter=0;
1929 my $membercounter=0;
1930
1931 while (<MD>) {
1932         (/insert into items /i) && ($itemcounter++);
1933         (/insert into biblioitems /i) && ($biblioitemcounter++);
1934         (/insert into biblio /i) && ($bibliocounter++);
1935         (/insert into borrowers /i) && ($membercounter++);
1936         print BF $_;
1937 }
1938
1939 close BF;
1940 close MD;
1941
1942 my $filels=`ls -hl $backupdir/Koha.backup_$date`;
1943 chomp $filels;
1944 $answer = showmessage(getmessage('BackupSummary',[$bibliocounter, $biblioitemcounter, $itemcounter, $membercounter, $filels]),'yn');
1945
1946 if ($answer=~/^n/i) {
1947     print qq|
1948
1949 Aborting.  The database dump is located in:
1950
1951         $backupdir/Koha.backup_$date
1952
1953 |;
1954     exit;
1955 } else {
1956         print "Great! continuing upgrade... \n";
1957 };
1958
1959
1960
1961 }
1962
1963 =item finalizeconfigfile
1964
1965    finalizeconfigfile;
1966
1967 This function must be called when the installation is complete,
1968 to rename the koha.conf.tmp file to koha.conf.
1969
1970 Currently, failure to rename the file results only in a warning.
1971
1972 =cut
1973
1974 sub finalizeconfigfile {
1975         restoremycnf();
1976    rename "$etcdir/koha.conf.tmp", "$etcdir/koha.conf"
1977       || showmessage(<<EOF, 'PressEnter', undef, 1);
1978 An unexpected error, $!, occurred
1979 while the Koha config file is being saved to its final location,
1980 $etcdir/koha.conf.
1981
1982 Couldn't rename file at $etcdir. Must have write capability.
1983
1984 Press Enter to continue.
1985 EOF
1986 #'
1987 }
1988
1989
1990 =item loadconfigfile
1991
1992    loadconfigfile
1993
1994 Open the existing koha.conf file and get its values,
1995 saving the values to some global variables.
1996
1997 If the existing koha.conf file cannot be opened for any reason,
1998 the file is silently ignored.
1999
2000 =cut
2001
2002 sub loadconfigfile {
2003     my %configfile;
2004
2005         #MJR: reverted to r1.53.  Please call setetcdir().  Do NOT hardcode this.
2006         #FIXME: make a dated backup
2007     open (KC, "<$etcdir/koha.conf");
2008     while (<KC>) {
2009      chomp;
2010      (next) if (/^\s*#/);
2011      if (/(.*)\s*=\s*(.*)/) {
2012        my $variable=$1;
2013        my $value=$2;
2014        # Clean up white space at beginning and end
2015        $variable=~s/^\s*//g;
2016        $variable=~s/\s*$//g;
2017        $value=~s/^\s*//g;
2018        $value=~s/\s*$//g;
2019        $configfile{$variable}=$value;
2020      }
2021     }
2022
2023         #MJR: Reverted this too. You do not mess with my privates. Please ask for new functions if required.
2024     $intranetdir=$configfile{'intranetdir'};
2025     $opacdir=$configfile{'opacdir'};
2026     $kohaversion=$configfile{'kohaversion'};
2027     $kohalogdir=$configfile{'kohalogdir'};
2028     $database=$configfile{'database'};
2029     $hostname=$configfile{'hostname'};
2030     $user=$configfile{'user'};
2031     $pass=$configfile{'pass'};
2032 }
2033
2034 END { }       # module clean-up code here (global destructor)
2035
2036 ### These things may move
2037
2038 sub setecho {
2039 my $state=shift;
2040 my $t = POSIX::Termios->new;
2041
2042 $t->getattr();
2043 if ($state) {
2044   $t->setlflag(($t->getlflag) | &POSIX::ECHO);
2045   }
2046 else {
2047   $t->setlflag(($t->getlflag) & !(&POSIX::ECHO));
2048   }
2049 $t->setattr();
2050 }
2051
2052 sub setmysqlclipass {
2053         my $pass = shift;
2054         open(MYCNF,">$mycnf");
2055         chmod(0600,$mycnf);
2056         print MYCNF "[client]\npassword=$pass\n";
2057         close(MYCNF);
2058 }
2059
2060 sub backupmycnf {
2061         if (-e $mycnf) {
2062                 rename $mycnf,$mytmpcnf;
2063         }
2064 }
2065
2066 sub restoremycnf {
2067         if (-e $mycnf) {
2068                 unlink($mycnf);
2069         }
2070         if (-e $mytmpcnf) {
2071                 rename $mytmpcnf,$mycnf;
2072         }
2073 }
2074
2075 =back
2076
2077 =head1 SEE ALSO
2078
2079 buildrelease.pl
2080 installer.pl
2081 koha.upgrade
2082
2083 =cut
2084
2085 1;