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