koha-dev.rot13.org Git - koha_fer/blob - misc/Install.pm

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