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