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