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