Makefile.PL

   1 # Copyright 2007 MJ Ray
   2 #
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it under the
   6 # terms of the GNU General Public License as published by the Free Software
   7 # Foundation; either version 2 of the License, or (at your option) any later
   8 # version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
  11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
  12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
  13 #
  14 # You should have received a copy of the GNU General Public License along with
  15 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
  16 # Suite 330, Boston, MA  02111-1307 USA
  17 #
  18 # Current maintainer MJR http://mjr.towers.org.uk/
  19 # See http://www.koha.org/wiki/?page=KohaInstaller
  20 #
  21
  22 use strict;
  23 use warnings;
  24 use ExtUtils::MakeMaker;
  25 use POSIX;
  26 use File::Spec;
  27 use Getopt::Long;
  28
  29 my $DEBUG = 0;
  30 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
  31
  32 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
  33
  34 my $dirtree = hashdir('.');
  35 my %result = ();
  36
  37 =head1 NAME
  38
  39 Makefile.PL - Koha packager and installer
  40
  41 =head1 SYNOPSIS
  42
  43 =head2 BASIC INSTALLATION
  44
  45     perl Makefile.PL
  46     make
  47     make test
  48     sudo make install
  49
  50 =head2 UPGRADE INSTALLATION
  51
  52     NOTE: This option is only available if koha-install-log exists.
  53
  54     perl Makefile.PL --prev-install-log /path/to/koha-install-log
  55
  56     make
  57     make test
  58     sudo make upgrade
  59
  60 =head2 PACKAGING RELEASE TARBALLS
  61
  62     make manifest tardist
  63     make manifest zipdist
  64
  65 =head2 CLEANING UP
  66
  67         make clean
  68
  69 =head1 DESCRIPTION
  70
  71 This is a packager and installer that uses
  72 ExtUtils::MakeMaker, which is fairly common
  73 on perl systems.
  74 As well as building tar or zip files
  75 and installing with the above commands,
  76 it allows us to check pre-requisites
  77 and generate configuration files.
  78
  79 =head1 VARIABLES
  80
  81 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
  82
  83 Basic metadata about this software.
  84
  85 =head2 NO_META
  86
  87 Suppress generation of META.yml file.
  88
  89 =head2 PREREQ_PM
  90
  91 Hash of perl modules and versions required.
  92
  93 =head2 PM
  94
  95 Hash of file mappings
  96
  97 =head2 PL_FILES
  98
  99 This is a hash of PL scripts to run after installation and
 100 the files to ask them to generate.
 101 Maybe use the values from CONFIGURE
 102 to generate initial configuration files in future.
 103
 104 =cut
 105
 106 =head2 target_map
 107
 108 This is a hash mapping directories and files in the
 109 source tree to installation target directories.  The rules
 110 for this mapping are:
 111
 112 =over 4
 113
 114 =item If a directory or file is specified, it and its
 115 contents will be copied to the installation target directory.
 116
 117 =item If a subdirectory of a mapped directory is specified,
 118 its target overrides the parent's target for that subdirectory.
 119
 120 =item The value of each map entry may either be a scalar containing
 121 one target or a reference to a hash containing 'target' and 'trimdir'
 122 keys.
 123
 124 =item Any files at the top level of the source tree that are
 125 not included in the map will not be installed.
 126
 127 =item Any directories at the top level of the source tree
 128 that are not included in the map will be installed in
 129 INTRANET_CGI_DIR.  This is a sensible default given the
 130 current organization of the source tree, but (FIXME) it
 131 would be better to reorganize the source tree to better
 132 match the installation system, to allow adding new directories
 133 without having to adjust Makefile.PL each time.  The idea
 134 is to make the C<$target_map> hash as minimal as possible.
 135
 136 =back
 137
 138 The permitted installation targets are:
 139
 140 =over 4
 141
 142 =item INTRANET_CGI_DIR
 143
 144 CGI scripts for intranet (staff) interface.
 145
 146 =item INTRANET_TMPL_DIR
 147
 148 HTML templates for the intranet interface.
 149
 150 =item INTRANET_WWW_DIR
 151
 152 HTML files, images, etc. for DocumentRoot for the intranet interface.
 153
 154 =item OPAC_CGI_DIR
 155
 156 CGI scripts for OPAC (public) interface.
 157
 158 =item OPAC_TMPL_DIR
 159
 160 HTML templates for the OPAC interface.
 161
 162 =item OPAC_WWW_DIR
 163
 164 HTML files, images, etc. for DocumentRoot for the OPAC interface.
 165
 166 =item PERL_MODULE_DIR
 167
 168 Perl modules (at present just the C4 modules) that are intimately
 169 tied to Koha.  Depending on the installation options, these
 170 may or may not be installed one of the standard directories
 171 in Perl's default @LIB.
 172
 173 =item KOHA_CONF_DIR
 174
 175 Directory for Koha configuration files.
 176
 177 =item ZEBRA_CONF_DIR
 178
 179 Directory for Zebra configuration files.
 180
 181 =item ZEBRA_LOCK_DIR
 182
 183 Directory for Zebra's lock files.
 184
 185 =item ZEBRA_DATA_DIR
 186
 187 Directory for Zebra's data files.
 188
 189 =item ZEBRA_RUN_DIR
 190
 191 Directory for Zebra's UNIX-domain sockets.
 192
 193 =item MISC_DIR
 194
 195 Directory for for miscellaenous scripts, among other
 196 things the translation toolkit and RSS feed tools.
 197
 198 =item SCRIPT_DIR
 199
 200 Directory for command-line scripts and daemons to
 201 be set up all for installation modes.
 202
 203 =item SCRIPT_NONDEV_DIR
 204
 205 Directory for command-line scripts that should
 206 be installed in the same directory as the
 207 SCRIPT_DIR target except 'dev' installs.
 208
 209 =item MAN_DIR
 210
 211 Directory for man pages created from POD -- will mostly
 212 contain information of interest to Koha developers.
 213
 214 =item DOC_DIR
 215
 216 Directory for Koha documentation accessed from the
 217 command-line, e.g., READMEs.
 218
 219 =item LOG_DIR
 220
 221 Directory for Apache and Zebra logs produced by Koha.
 222
 223 =item PAZPAR2_CONF_DIR
 224
 225 Directory for PazPar2 configuration files.
 226
 227 =item NONE
 228
 229 This is a dummy target used to explicitly state
 230 that a given file or directory is not to be installed.
 231 This is used either for parts of the installer itself
 232 or for development tools that are not applicable to a
 233 production installation.
 234
 235 =back
 236
 237 =cut
 238
 239 my $target_map = {
 240   './about.pl'                  => 'INTRANET_CGI_DIR',
 241   './acqui'                     => 'INTRANET_CGI_DIR',
 242   './admin'                     => 'INTRANET_CGI_DIR',
 243   './authorities'               => 'INTRANET_CGI_DIR',
 244   './C4'                        => 'PERL_MODULE_DIR',
 245   './C4/SIP/t'                  => 'NONE',
 246   './C4/SIP/koha_test'          => 'NONE',
 247   './C4/tests'                  => 'NONE',
 248   './catalogue'                 => 'INTRANET_CGI_DIR',
 249   './cataloguing'               => 'INTRANET_CGI_DIR',
 250   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
 251   './check_sysprefs.pl'         => 'NONE',
 252   './circ'                      => 'INTRANET_CGI_DIR',
 253   './offline_circ'              => 'INTRANET_CGI_DIR',
 254   './edithelp.pl'               => 'INTRANET_CGI_DIR',
 255   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
 256   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
 257   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
 258   './help.pl'                   => 'INTRANET_CGI_DIR',
 259   './installer-CPAN.pl'         => 'NONE',
 260   './installer'                 => 'INTRANET_CGI_DIR',
 261   './errors'                    => {target => 'INTRANET_CGI_DIR'},
 262   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
 263   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
 264   './kohaversion.pl'            => 'INTRANET_CGI_DIR',
 265   './labels'                    => 'INTRANET_CGI_DIR',
 266   './mainpage.pl'               => 'INTRANET_CGI_DIR',
 267   './Makefile.PL'               => 'NONE',
 268   './MANIFEST.SKIP'             => 'NONE',
 269   './members'                   => 'INTRANET_CGI_DIR',
 270   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
 271   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
 272   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
 273   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
 274   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
 275   './misc/installer_devel_notes' => 'NONE',
 276   './opac'                      => 'OPAC_CGI_DIR',
 277   './README.txt'                => 'NONE',
 278   './reports'                   => 'INTRANET_CGI_DIR',
 279   './reserve'                   => 'INTRANET_CGI_DIR',
 280   './reviews'                   => 'INTRANET_CGI_DIR',
 281   './rewrite-config.PL'         => 'NONE',
 282   './reviews'                   => 'INTRANET_CGI_DIR',
 283   './serials'                   => 'INTRANET_CGI_DIR',
 284   './skel'                      => 'NONE',
 285   './skel/var/log/koha'         => { target => 'LOG_DIR', trimdir => -1 },
 286   './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
 287   './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
 288   './skel/var/lib/koha/zebradb/authorities/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 289   './skel/var/lib/koha/zebradb/authorities/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 290   './skel/var/lib/koha/zebradb/authorities/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 291   './skel/var/lib/koha/zebradb/authorities/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 292   './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
 293   './skel/var/lib/koha/zebradb/biblios/key'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 294   './skel/var/lib/koha/zebradb/biblios/register'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 295   './skel/var/lib/koha/zebradb/biblios/shadow'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 296   './skel/var/lib/koha/zebradb/biblios/tmp'  => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
 297   './sms'                       => 'INTRANET_CGI_DIR',
 298   './suggestion'                => 'INTRANET_CGI_DIR',
 299   './svc'                       => 'INTRANET_CGI_DIR',
 300   './t'                         => 'NONE',
 301   './tags'                      => 'INTRANET_CGI_DIR',
 302   './tmp'                       => 'NONE', # FIXME need to determine whether
 303                                            # Koha generates any persistent temp files
 304                                            # that should go in /var/tmp/koha
 305   './tools'                     => 'INTRANET_CGI_DIR',
 306   './virtualshelves'            => 'INTRANET_CGI_DIR',
 307   # ignore files and directories created by the install itself
 308   './pm_to_blib'                => 'NONE',
 309   './blib'                      => 'NONE',
 310 };
 311
 312 =head1 CONFIGURATION OPTIONS
 313
 314 The following configuration options are used by the installer.
 315
 316 =over 4
 317
 318 =item INSTALL_MODE
 319
 320 Specifies whether installation will be FHS-compliant (default,
 321 assumes user has root), put everything under
 322 a single directory (for users installing on a web host
 323 that allows CGI scripts and a MySQL database but not root
 324 access), or development (for a developer who wants to run
 325 Koha from a git clone with no fuss).
 326
 327 =item INSTALL_BASE
 328
 329 Directory under which most components will go.  Default
 330 value will vary depending on INSTALL_MODE.
 331
 332 =item DB_TYPE
 333
 334 Type of DBMS (e.g., mysql or Pg).
 335
 336 =item DB_HOST
 337
 338 Name of DBMS server.
 339
 340 =item DB_PORT
 341
 342 Port that DBMS server is listening on.
 343
 344 =item DB_NAME
 345
 346 Name of the DBMS database for Koha.
 347
 348 =item DB_USER
 349
 350 Name of DBMS user account for Koha's database.
 351
 352 =item DB_PASS
 353
 354 Pasword of DMBS user account for Koha's database.
 355
 356 =item INSTALL_ZEBRA
 357
 358 Whether to install Zebra configuration files and data
 359 directories.
 360
 361 =item ZEBRA_MARC_FORMAT
 362
 363 Specifies format of MARC records to be indexed by Zebra.
 364
 365 =item ZEBRA_LANGUAGE
 366
 367 Specifies primary language of records that will be
 368 indexed by Zebra.
 369
 370 =item ZEBRA_USER
 371
 372 Internal Zebra user account for the index.
 373
 374 =item ZEBRA_PASS
 375
 376 Internal Zebra user account's password.
 377
 378 =item KOHA_USER
 379
 380 System user account that will own Koha's files.
 381
 382 =item KOHA_GROUP
 383
 384 System group that will own Koha's files.
 385
 386 =back
 387
 388 =cut
 389
 390 # default configuration options
 391 my %config_defaults = (
 392   'DB_TYPE'           => 'mysql',
 393   'DB_HOST'           => 'localhost',
 394   'DB_NAME'           => 'koha',
 395   'DB_USER'           => 'kohaadmin',
 396   'DB_PASS'           => 'katikoan',
 397   'INSTALL_ZEBRA'     => 'yes',
 398   'INSTALL_SRU'       => 'yes',
 399   'INSTALL_PAZPAR2'   => 'no',
 400   'AUTH_INDEX_MODE'   => 'grs1',
 401   'ZEBRA_MARC_FORMAT' => 'marc21',
 402   'ZEBRA_LANGUAGE'    => 'en',
 403   'ZEBRA_USER'        => 'kohauser',
 404   'ZEBRA_PASS'        => 'zebrastripes',
 405   'ZEBRA_SRU_HOST'    => 'localhost',
 406   'ZEBRA_SRU_BIBLIOS_PORT'    => '9998',
 407   'ZEBRA_SRU_AUTHORITIES_PORT'    => '9999',
 408   'KOHA_USER'         => 'koha',
 409   'KOHA_GROUP'        => 'koha',
 410   'MERGE_SERVER_HOST' => 'localhost',
 411   'MERGE_SERVER_PORT' => '11001',
 412   'PAZPAR2_HOST' => 'localhost',
 413   'PAZPAR2_PORT' => '11002',
 414   'RUN_DATABASE_TESTS' => 'no',
 415   'PATH_TO_ZEBRA' => '',
 416 );
 417
 418 # set some default configuration options based on OS
 419 # more conditions need to be added for other OS's
 420 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
 421 # to allow for more granular decisions based on which Win32 platform
 422
 423 warn "Your platform appears to be $^O.\n" if $DEBUG;
 424
 425 if ( $^O eq 'MSWin32' ) {
 426         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
 427         # this could be changed to put some files (ie. libraries) into system32, etc.
 428         $config_defaults{'INSTALL_MODE'} = 'single';
 429         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
 430 }
 431 elsif ( $^O eq 'cygwin' ) {
 432         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
 433         # this could be changed to put some files (ie. libraries) into system32, etc.
 434         $config_defaults{'INSTALL_MODE'} = 'single';
 435         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
 436 }
 437 else {
 438         $config_defaults{'INSTALL_MODE'} = 'standard';
 439         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
 440 }
 441
 442 # valid values for certain configuration options
 443 my %valid_config_values = (
 444   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
 445   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
 446   'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
 447   'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
 448   'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
 449   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
 450   'ZEBRA_LANGUAGE'    => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
 451   'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
 452 );
 453
 454 # get settings from command-line
 455 my $koha_install_log = "";
 456 Getopt::Long::Configure('pass_through');
 457 my $results = GetOptions(
 458     "prev-install-log=s" => \$koha_install_log
 459 );
 460
 461 my %install_log_values = ();
 462 if ($koha_install_log ne "") {
 463     get_install_log_values($koha_install_log, \%install_log_values);
 464 }
 465
 466 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
 467 my ($target_directories, $skip_directories) = get_target_directories(\%config);
 468 display_configuration(\%config, $target_directories);
 469 my $file_map = {};
 470 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
 471
 472 my $pl_files = {
 473       'rewrite-config.PL' => [
 474          'blib/KOHA_CONF_DIR/koha-conf.xml',
 475          'blib/KOHA_CONF_DIR/koha-httpd.conf',
 476          'blib/MISC_DIR/koha-install-log'
 477          ],
 478           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
 479                  'blib'
 480                  ]
 481 };
 482
 483 if ($config{'INSTALL_ZEBRA'} eq "yes") {
 484     push @{ $pl_files->{'rewrite-config.PL'} }, (
 485         'blib/ZEBRA_CONF_DIR/etc/passwd',
 486         'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
 487         'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
 488         'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
 489         'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
 490         'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
 491         'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
 492         'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
 493     );
 494     push @{ $pl_files->{'rewrite-config.PL'} }, (
 495         'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
 496         'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
 497         'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
 498     );
 499     if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
 500         push @{ $pl_files->{'rewrite-config.PL'} }, (
 501             'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
 502             'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
 503         );
 504     }
 505     $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
 506     $config{'AUTH_RETRIEVAL_CFG'} =
 507         $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
 508 }
 509
 510 if ($config{'INSTALL_MODE'} ne "dev") {
 511     push @{ $pl_files->{'rewrite-config.PL'} }, (
 512         'blib/PERL_MODULE_DIR/C4/Context.pm',
 513         'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
 514     );
 515 }
 516
 517 my %test_suite_override_dirs = (
 518     KOHA_CONF_DIR  => ['etc'],
 519     ZEBRA_CONF_DIR => ['etc', 'zebradb'],
 520     LOG_DIR        => ['var', 'log'],
 521     SCRIPT_DIR     => ['bin'],
 522     ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
 523     ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
 524     ZEBRA_RUN_DIR  => ['var', 'run', 'zebradb'],
 525 );
 526
 527 WriteMakefile(
 528               NAME         => 'koha',
 529               VERSION     => '3.00.03',
 530               #VERSION_FROM => 'kohaversion.pl',
 531               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
 532               AUTHOR       => 'Koha Developers <koha-devel@lists.koha.org>',
 533               NO_META      => 1,
 534               PREREQ_PM => {
 535                             'Algorithm::CheckDigits'           => 0.50,
 536                             'Biblio::EndnoteStyle'             => 0.05,
 537                             'CGI'                              => 3.15,
 538                             'CGI::Carp'                        => 1.29,
 539                             'CGI::Session'                     => 4.20,
 540                             'CGI::Session::Serialize::yaml'    => 4.20,
 541                             'Class::Factory::Util'             => 1.6,
 542                             'Class::Accessor'                  => 0.30,
 543                             'DBD::mysql'                       => 4.004,
 544                             'DBI'                              => 1.53,
 545                             'Data::Dumper'                     => 2.121,
 546                             'Data::ICal'                       => 0.13,
 547                             'Date::Calc'                       => 5.4,
 548                             'Date::ICal'                       => 1.72,
 549                             'Date::Manip'                      => 5.44,
 550                             'Digest::MD5'                      => 2.36,
 551                             'Digest::SHA'                      => 5.43,
 552                             'Email::Date'                      => 1.103,
 553                             'File::Temp'                       => 0.16,
 554                             'GD'                               => 2.39,    #optional
 555                             'GD::Barcode::UPCE'                => 1.1,
 556                             'Getopt::Long'                     => 2.35,
 557                             'Getopt::Std'                      => 1.05,
 558                             'HTML::Template::Pro'              => 0.69,
 559                             'HTML::Scrubber'                   => 0.08,
 560                             'HTTP::Cookies'                    => 1.39,
 561                             'HTTP::OAI'                        => 3.20,
 562                             'HTTP::Request::Common'            => 1.26,
 563                             'IPC::Cmd'                         => 0.46,
 564                             'JSON'                             => 2.07, # Needed by admin/item_circulation_alerts.pl
 565                             'LWP::Simple'                      => 1.41,
 566                             'LWP::UserAgent'                   => 2.033,
 567                             'Lingua::Stem'                     => 0.82,
 568                             'List::Util'                       => 1.18,
 569                             'List::MoreUtils'                  => 0.21,
 570                             'Locale::Language'                 => 2.07,
 571                             'MARC::Charset'                    => 0.98,
 572                             'MARC::Crosswalk::DublinCore'      => 0.02,
 573                             'MARC::File::XML'                  => 0.88,
 574                             'MARC::Record'                     => 2.00,
 575                             'MIME::Base64'                     => 3.07,
 576                             'MIME::Lite'                       => 3.00,
 577                             'MIME::QuotedPrint'                => 3.07,
 578                             'Mail::Sendmail'                   => 0.79,
 579                             'Net::LDAP'                        => 0.33, # optional
 580                             'Net::LDAP::Filter'                => 0.14, # optional
 581                             'Net::Z3950::ZOOM'                 => 1.16,
 582                             'PDF::API2'                        => 2.000,
 583                             'PDF::API2::Page'                  => 2.000,
 584                             'PDF::API2::Util'                  => 2.000,
 585                             'PDF::Reuse'                       => 0.33,
 586                             'PDF::Reuse::Barcode'              => 0.05,
 587                             'POE'                              => 0.9999,
 588                             'POSIX'                            => 1.09,
 589                             'Schedule::At'                     => 1.06,
 590                             'SMS::Send'                        => 0.05, # optional
 591                             'Term::ANSIColor'                  => 1.10,
 592                             'Test'                             => 1.25,
 593                             'Test::Harness'                    => 2.56,
 594                             'Test::More'                       => 0.62,
 595                             'Text::CSV'                        => 0.01,
 596                             'Text::CSV_XS'                     => 0.32,
 597                             'Text::Iconv'                      => 1.7,
 598                             'Text::Wrap'                       => 2005.082401,
 599                             'Time::HiRes'                      => 1.86,
 600                             'Time::localtime'                  => 1.02,
 601                             'Unicode::Normalize'               => 0.32,
 602                             'URI::Escape'                      => 1.36,
 603                             'XML::Dumper'                      => 0.81,
 604                             'XML::LibXML'                      => 1.59,
 605                             'XML::LibXSLT'                     => 1.59,
 606                             'XML::SAX::ParserFactory'          => 1.01,
 607                             'XML::SAX::Writer'                 => 0.44,
 608                             'XML::Simple'                      => 2.14,
 609                             'XML::RSS'                         => 1.31,
 610                             'YAML::Syck'                       => 0.71,
 611                         },
 612
 613               # File tree mapping
 614               PM => $file_map,
 615
 616               # Man pages generated from POD
 617               # ExtUtils::MakeMaker already manage $(DESTDIR)
 618               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
 619               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
 620
 621               PL_FILES => $pl_files,
 622 );
 623
 624 =head1 FUNCTIONS
 625
 626 =head2 hashdir
 627
 628 This function recurses through the directory structure and builds
 629 a hash of hashes containing the structure with arrays holding filenames.
 630 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 631
 632 =cut
 633
 634 sub hashdir{
 635     my $dir = shift;
 636     opendir my $dh, $dir or die $!;
 637     my $tree = {}->{$dir} = {};
 638     while( my $file = readdir($dh) ) {
 639         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 640         my $path = $dir .'/' . $file;
 641         $tree->{$file} = hashdir($path), next if -d $path;
 642         push @{$tree->{'.'}}, $file;
 643     }
 644     return $tree;
 645 }
 646
 647 =head2 get_file_map
 648
 649 This function combines the target_map and file hash to
 650 map each source file to its destination relative to
 651 the set of installation targets.
 652
 653 Output will be a hash mapping from each source file
 654 to its destination value, like this:
 655
 656 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 657
 658 =cut
 659
 660 sub get_file_map {
 661     my $target_map = shift;
 662     my $dirtree = shift;
 663     my $file_map = shift;
 664     my $install_zebra = shift;
 665     my $curr_path = @_ ? shift : ['.'];
 666
 667     # Traverse the directory tree.
 668     # For each file or directory, identify the
 669     # most specific match in the target_map
 670     foreach my $dir (sort keys %{ $dirtree }) {
 671         if ($dir eq '.') {
 672             # deal with files in directory
 673             foreach my $file (sort @{ $dirtree->{$dir} }) {
 674                 my $targetdir = undef;
 675                 my $matchlevel = undef;
 676                 # first, see if there is a match on this specific
 677                 # file in the target map
 678                 my $filepath = join("/", @$curr_path, $file);
 679                 if (exists $target_map->{$filepath}) {
 680                     $targetdir = $target_map->{$filepath};
 681                     $matchlevel = scalar(@$curr_path) + 1;
 682                 } else {
 683                     # no match on the specific file; look for
 684                     # a directory match
 685                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 686                         my $dirpath = join("/", @$curr_path[0..$i]);
 687                         if (exists $target_map->{$dirpath}) {
 688                             $targetdir = $target_map->{$dirpath};
 689                             $matchlevel = $i + 1;
 690                             last;
 691                         }
 692                     }
 693                 }
 694                 if (defined $targetdir) {
 695                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
 696                 } else {
 697                     my $path = join("/", @$curr_path);
 698                     print "failed to map: $path/$file\n" if $DEBUG;
 699                 }
 700             }
 701         } else {
 702             # dealing with subdirectory
 703             push @$curr_path, $dir;
 704             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
 705             pop @$curr_path;
 706         }
 707     }
 708 }
 709
 710 sub _add_to_file_map {
 711     my $file_map = shift;
 712     my $targetdir = shift;
 713     my $curr_path = shift;
 714     my $file = shift;
 715     my $matchlevel = shift;
 716     my $install_zebra = shift;
 717     my $dest_path = @_ ? shift : $curr_path;
 718
 719     # The target can be one of the following:
 720     # 1. scalar representing target symbol
 721     # 2. hash ref containing target and trimdir keys
 722     #
 723     # Consequently, this routine traverses this structure,
 724     # calling itself recursively, until it deals with
 725     # all of the scalar target symbols.
 726     if (ref $targetdir eq 'HASH') {
 727         my $subtarget = $targetdir->{target};
 728         if (exists $targetdir->{trimdir}) {
 729             # if we get here, we've specified that
 730             # rather than installing the file to
 731             # $(TARGET)/matching/dirs/subdirs/file,
 732             # we want to install it to
 733             # $(TARGET)/subdirs/file
 734             #
 735             # Note that this the only place where
 736             # $matchlevel is used.
 737             my @new_dest_path = @$dest_path;
 738             if ($targetdir->{trimdir} == -1)  {
 739                 splice @new_dest_path, 0, $matchlevel;
 740             } else {
 741                 splice @new_dest_path, 0, $targetdir->{trimdir};
 742             }
 743             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
 744         } else {
 745             # actually getting here means that the
 746             # target was unnecessarily listed
 747             # as a hash, but we'll forgive that
 748             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
 749         }
 750     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 751         my $source = File::Spec->catfile(@$curr_path, $file);
 752         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 753         #print "$source => $destination\n"; # DEBUG
 754         # quote spaces in file names
 755         # FIXME: this is of questionable portability and
 756         # probably depends on user's make recognizing this
 757         # quoting syntax -- probably better to remove
 758         # spaces and shell metacharacters from all file names
 759         $source =~ s/ /\\ /g;
 760         $destination =~ s/ /\\ /g;
 761
 762         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
 763     }
 764 }
 765
 766 =head2 get_install_log_values
 767
 768 Reads value from the Koha install log specified by
 769 --prev-install-log
 770
 771 =cut
 772
 773 sub get_install_log_values {
 774     my $install_log = shift;
 775     my $values = shift;
 776
 777     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
 778     while (<LOG>) {
 779         chomp;
 780         next if /^#/ or /^\s*$/;
 781         next if /^=/;
 782         next unless m/=/;
 783         s/\s+$//g;
 784         my ($key, $value) = split /=/, $_, 2;
 785         $values->{$key} = $value;
 786     }
 787     close LOG;
 788
 789     print <<_EXPLAIN_INSTALL_LOG_;
 790 Reading values from install log $install_log.  You
 791 will be prompted only for settings that have been
 792 added since the last time you installed Koha.  To
 793 be prompted for all settings, run 'perl Makefile.PL'
 794 without the --prev-install-log option.
 795 _EXPLAIN_INSTALL_LOG_
 796 }
 797
 798 =head2 get_configuration
 799
 800 This prompts the user for various configuration options.
 801
 802 =cut
 803
 804 sub get_configuration {
 805   my $defaults = shift;
 806   my $valid_values = shift;
 807   my $install_log_values = shift;
 808   my %config = ();
 809
 810   my $msg = q(
 811 By default, Koha can be installed in one of three ways:
 812
 813 standard: Install files in conformance with the Filesystem
 814           Hierarchy Standard (FHS).  This is the default mode
 815           and should be used when installing a production
 816           Koha system.  On Unix systems, root access is
 817           needed to complete a standard installation.
 818
 819 single:   Install files under a single directory.  This option
 820           is useful for installing Koha without root access, e.g.,
 821           on a web host that allows CGI scripts and MySQL databases
 822           but requires the user to keep all files under the user's
 823           HOME directory.
 824
 825 dev:      Create a set of symbolic links and configuration files to
 826           allow Koha to run directly from the source distribution.
 827           This mode is useful for developers who want to run
 828           Koha from a git clone.
 829
 830 Installation mode);
 831     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 832     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
 833
 834     # set message and default value for INSTALL_BASE
 835     # depending on value of INSTALL_MODE
 836     my $install_base_default = $defaults->{'INSTALL_BASE'};
 837     if ($config{'INSTALL_MODE'} eq 'dev') {
 838         $msg = q(
 839 Please specify the directory in which to install Koha's
 840 active configuration files and (if applicable) the
 841 Zebra database.  Koha's CGI scripts and templates will
 842 be run from the current directory.
 843
 844 Configuration directory:);
 845         # FIXME - home directory portability consideration apply
 846         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
 847     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 848         $msg = "\nPlease specify the directory in which to install Koha";
 849         # FIXME -- we're assuming under a 'single' mode install
 850         # that user will likely want to install under the home
 851         # directory.  This is OK in and of itself, but we should
 852         # use File::HomeDir to locate the home directory portably.
 853         # This is deferred for now because File::HomeDir is not yet
 854         # core.
 855                 # --we must also keep this portable to the major OS's -fbcit
 856         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
 857     } else {
 858         # must be standard
 859         $msg = q(
 860 Please specify the directory under which most Koha files
 861 will be installed.
 862
 863 Note that if you are planning in installing more than
 864 one instance of Koha, you may want to modify the last
 865 component of the directory path, which will be used
 866 as the package name in the FHS layout.
 867
 868 Base installation directory);
 869     }
 870     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
 871
 872     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 873         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
 874     if ($config{'INSTALL_MODE'} eq "standard") {
 875         $msg = q(
 876 Since you are using the 'standard' install
 877 mode, you should run 'make install' as root.
 878 However, it is recommended that a non-root
 879 user (on Unix and Linux platforms) have
 880 ownership of Koha's files, including the
 881 Zebra indexes if applicable.
 882
 883 Please specify a user account.  This
 884 user account does not need to exist
 885 right now, but it needs to exist
 886 before you run 'make install'.  Please
 887 note that for security reasons, this
 888 user should not be the same as the user
 889 account Apache runs under.
 890
 891 User account);
 892         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
 893
 894         $msg = q(
 895 Please specify the group that should own
 896 Koha's files.  As above, this group need
 897 not exist right now, but should be created
 898 before you run 'make install'.
 899
 900 Group);
 901         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
 902     }
 903
 904     $msg = q(
 905 Please specify which database engine you will use
 906 to store data in Koha.  The choices are MySQL and
 907 PostgreSQL; please note that at the moment
 908 PostgreSQL support is highly experimental.
 909
 910 DBMS to use);
 911     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
 912     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
 913
 914     $msg = q(
 915 Please specify the name or address of your
 916 database server.  Note that the database
 917 does not have to exist at this point, it
 918 can be created after running 'make install'
 919 and before you try using Koha for the first time.
 920
 921 Database server);
 922     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
 923
 924     $msg = q(
 925 Please specify the port used to connect to the
 926 DMBS);
 927     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
 928     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
 929
 930     $msg = q(
 931 Please specify the name of the database to be
 932 used by Koha);
 933     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
 934
 935     $msg = q(
 936 Please specify the user that owns the database to be
 937 used by Koha);
 938     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
 939
 940     $msg = q(
 941 Please specify the password of the user that owns the
 942 database to be used by Koha);
 943     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
 944
 945     $msg = q(
 946 Koha can use the Zebra search engine for high-performance
 947 searching of bibliographic and authority records.  If you
 948 have installed the Zebra software and would like to use it,
 949 please answer 'yes' to the following question.  Otherwise,
 950 Koha will default to using its internal search engine.
 951
 952 Please note that if you choose *NOT* to install Zebra,
 953 koha-conf.xml will still contain some references to Zebra
 954 settings.  Those references will be ignored by Koha.
 955
 956 Install the Zebra configuration files?);
 957     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
 958     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
 959
 960     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
 961
 962         if (defined(my $zebra_path = find_zebra())) {
 963             $config{'PATH_TO_ZEBRA'} = $zebra_path;
 964             print qq(
 965 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
 966 );
 967         } else {
 968             print q(
 969 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
 970 in your PATH or in some of the usual places.  If you haven't
 971 installed Zebra yet, please do so and run Makefile.PL again.
 972
 973 );
 974         }
 975
 976         $msg = q(
 977 Since you've chosen to use Zebra with Koha,
 978 you must specify the primary MARC format of the
 979 records to be indexed by Zebra.
 980
 981 Koha provides Zebra configuration files for MARC 21
 982 and UNIMARC.
 983
 984 MARC format for Zebra indexing);
 985         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
 986         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
 987         $msg = q(
 988 Koha supplies Zebra configuration files tuned for
 989 searching either English (en) or French (fr) MARC
 990 records.
 991
 992 Primary language for Zebra indexing);
 993         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
 994         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
 995
 996         $msg = q(
 997 Koha can use one of  two different indexing modes
 998 for the MARC authorities records:
 999
1000 grs1 - uses the Zebra GRS-1 filter, available
1001        for legacy support
1002 dom  - uses the DOM XML filter; offers improved
1003        functionality.
1004
1005 Authorities indexing mode);
1006         $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1007         $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1008
1009         $msg = q(
1010 Please specify Zebra database user);
1011         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1012
1013         $msg = q(
1014 Please specify the Zebra database password);
1015         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1016
1017         $msg = q(
1018 Since you've chosen to use Zebra, you can enable the SRU/
1019 Z39.50 Server if you so choose, but you must specify a
1020 few configuration options for it.
1021
1022 Please note that if you choose *NOT* to configure SRU,
1023 koha-conf.xml will still contain some references to SRU
1024 settings.  Those references will be ignored by Koha.
1025
1026 Install the SRU configuration files?);
1027         $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1028         $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1029
1030         if ($config{'INSTALL_SRU'} eq 'yes') {
1031             $msg = q(
1032 Since you've chosen to configure SRU, you must
1033 specify the host and port(s) that the SRU
1034 Servers (bibliographic and authority) should run on.
1035 );
1036             $msg = q(
1037 SRU Database host?);
1038             $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1039
1040             $msg = q(
1041 SRU port for bibliographic data?);
1042             $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1043
1044             $msg = q(
1045 SRU port for authority data?);
1046             $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1047
1048         }
1049
1050         $msg = q(
1051 Since you've chosen to use Zebra, you can also choose to
1052 install PazPar2, which is a metasearch tool.  With PazPar2,
1053 Koha can perform on-the-fly merging of bibliographic
1054 records during searching, allowing for FRBRization of
1055 the results list.
1056
1057 Install the PazPar2 configuration files?);
1058         $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1059         $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1060
1061         if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1062             $msg = q(
1063 Since you've chosen to configure PazPar2, you must
1064 specify the host and port(s) that PazPar2
1065 uses:
1066 );
1067             $msg = q(
1068 Zebra bibliographic server host?);
1069             $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1070
1071             $msg = q(
1072 Zebra bibliographic port for PazPar2 to use?);
1073             $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1074
1075             $msg = q(
1076 PazPar2 host?);
1077             $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1078
1079             $msg = q(
1080 PazPar2 port?);
1081             $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1082
1083         }
1084     }
1085
1086   $msg = q(
1087 Would you like to run the database-dependent test suite?);
1088   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1089     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1090
1091   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1092       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1093       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1094       $msg = q(TEST DATABASE
1095
1096 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1097 testing. Please don't do this on your production database. It is not
1098 reversable.
1099
1100 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1101 database. You are better off not running this optional test suite than
1102 doing it in a database that you don't want to lose.
1103
1104 Please specify the name of the test database to be
1105 used by Koha);
1106
1107       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1108       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1109           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1110           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1111       }
1112
1113       $msg = q(
1114 Please specify the user that owns the database to be
1115 used by Koha);
1116     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1117
1118       $msg = q(
1119 Please specify the password of the user that owns the
1120 database to be used by Koha);
1121       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1122   }
1123
1124     print "\n\n";
1125
1126     # add version number
1127     my $version = "no_version_found";
1128     eval {
1129         require 'kohaversion.pl';
1130         $version = kohaversion();
1131     };
1132     $config{'KOHA_INSTALLED_VERSION'} = $version;
1133
1134     return %config;
1135 }
1136
1137 sub _add_valid_values_disp {
1138     my $key = shift;
1139     my $valid_values = shift;
1140
1141     my $disp = "";
1142     if (exists $valid_values->{$key}) {
1143         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1144     }
1145     return $disp;
1146 }
1147
1148 sub _get_value {
1149     my $key = shift;
1150     my $msg = shift;
1151     my $default = shift;
1152     my $valid_values = shift;
1153     my $install_log_values = shift;
1154
1155     # take value from install log if present
1156     if (exists $install_log_values{$key}) {
1157         return $install_log_values{$key};
1158     }
1159
1160     # override default value from environment
1161     if (exists $ENV{$key}) {
1162         $default = $ENV{$key};
1163         $msg .= " (default from environment)";
1164     }
1165
1166     my $val = prompt($msg, $default);
1167
1168     while (exists $valid_values->{$key} and
1169            $val ne $default and
1170            not exists $valid_values->{$key}->{$val}) {
1171         my $retry_msg = "Value '$val' is not a valid option.\n";
1172         $retry_msg .= "Please enter a value";
1173         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1174         $val = prompt($retry_msg, $default);
1175     }
1176     return $val;
1177 }
1178
1179 =head2 get_target_directories
1180
1181 Creates a hash mapping from symbols for installation target
1182 directories to actual directory paths.
1183
1184 Also returns a hash indicating targets for which
1185 files need not be copied -- this is used for the 'dev'
1186 mode installation, where some files are installed in place.
1187
1188 =cut
1189
1190 sub get_target_directories {
1191     my $config = shift;
1192
1193     my $base = $config->{'INSTALL_BASE'};
1194     my $mode = $config->{'INSTALL_MODE'};
1195
1196     # get last component of install base directory
1197     # to treat as package name
1198     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1199
1200     my @basedir = File::Spec->splitdir($directories);
1201
1202         # for Win32 we need to prepend the volume to the directory path
1203         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1204         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1205
1206     my $package = pop @basedir;
1207
1208
1209     my %dirmap = ();
1210     my %skipdirs = ();
1211     if ($mode eq 'single') {
1212         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1213         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1214         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1215         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1216         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1217         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1218         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1219         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1220         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1221         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1222         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1223         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1224         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1225         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1226         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1227         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1228         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1229         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1230         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1231     } elsif ($mode eq 'dev') {
1232         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1233         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1234         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1235         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1236         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1237         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1238         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1239         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1240         $skipdirs{'OPAC_CGI_DIR'} = 1;
1241         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1242         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1243         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1244         $skipdirs{'OPAC_WWW_DIR'} = 1;
1245         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1246         $skipdirs{'PERL_MODULE_DIR'} = 1;
1247         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1248         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1249         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1250         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1251         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1252         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1253         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1254         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1255         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1256         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1257         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1258         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1259         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1260     } else {
1261         # mode is standard, i.e., 'fhs'
1262         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1263         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1264         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1265         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1266         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1267         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1268         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1269         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1270         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1271         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1272         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1273         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1274         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1275         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1276         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1277         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1278         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1279         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1280         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1281     }
1282
1283     _get_env_overrides(\%dirmap);
1284     _get_argv_overrides(\%dirmap);
1285     _add_destdir(\%dirmap);
1286
1287     return \%dirmap, \%skipdirs;
1288 }
1289
1290 =head2 get_test_dir
1291
1292 Map a directory target to the corresponding path for
1293 the test suite.
1294
1295 =cut
1296
1297 sub get_test_dir {
1298     my ($dirname) = @_;
1299
1300     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1301     if (exists $test_suite_override_dirs{$dirname}) {
1302         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1303     } else {
1304         return;
1305     }
1306
1307 }
1308
1309 sub _get_env_overrides {
1310     my $dirmap = shift;
1311
1312     foreach my $key (keys %$dirmap) {
1313         if (exists $ENV{$key}) {
1314             $dirmap->{$key} = $ENV{$key};
1315             print "Setting $key from environment\n";
1316         }
1317     }
1318 }
1319
1320 sub _get_argv_overrides {
1321     my $dirmap = shift;
1322
1323     my @new_argv = ();
1324     for (my $i = 0; $i <= $#ARGV; $i++) {
1325         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1326             $dirmap->{$1} = $2;
1327         } else {
1328             push @new_argv, $ARGV[$i];
1329         }
1330     }
1331     @ARGV = @new_argv;
1332 }
1333
1334 sub _strip_destdir {
1335     my $dir = shift;
1336     $dir =~ s/^\$\(DESTDIR\)//;
1337     return $dir;
1338 }
1339
1340 sub _add_destdir {
1341     my $dirmap = shift;
1342
1343     foreach my $key (keys %$dirmap) {
1344         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1345     }
1346 }
1347
1348 sub display_configuration {
1349     my $config = shift;
1350     my $dirmap = shift;
1351     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1352     foreach my $key (sort keys %$config) {
1353         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1354     }
1355
1356     print "\nand in the following directories:\n\n";
1357     foreach my $key (sort keys %$dirmap) {
1358         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1359     }
1360     print "\n\nTo change any configuration setting, please run\n";
1361     print "perl Makefile.PL again.  To override one of the target\n";
1362     print "directories, you can do so on the command line like this:\n";
1363     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1364     print "You can also set different default values for parameters\n";
1365     print "or override directory locations by using environment variables.\n";
1366     print "\nFor example:\n\n";
1367     print "export DB_USER=my_koha\n";
1368     print "perl Makefile.PL\n";
1369     print "\nor\n\n";
1370     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1371     print "If installing on a Win32 platform, be sure to use:\n";
1372     print "'dmake -x MAXLINELENGTH=300000'\n\n";
1373 }
1374
1375 =head2 find_zebra
1376
1377 Attempt to find Zebra - check user's PATH and
1378 a few other directories for zebrasrv and zebraidx.
1379
1380 FIXME: doesn't handle Win32
1381
1382 =cut
1383
1384 sub find_zebra {
1385     my @search_dirs = map {
1386                             my $abs = File::Spec->rel2abs($_);
1387                             my ($toss, $directories);
1388                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1389                             $directories;
1390                         }  split /:/, $ENV{PATH};
1391     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1392     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1393     return unless @zebrasrv_dirs;
1394     # verify that directory that contains zebrasrv also contains zebraidx
1395     foreach my $dir (@zebrasrv_dirs) {
1396         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1397     }
1398     return;
1399 }
1400
1401 package MY;
1402
1403 # This will have to be reworked in order to accommodate Win32...
1404
1405 sub test {
1406     my $self = shift;
1407     my $test = $self->SUPER::test(@_);
1408     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1409
1410     # set KOHA_CONF
1411     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1412     return $test;
1413 }
1414
1415 sub install {
1416     my $self = shift;
1417     my $install = "";
1418     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1419     # This means that we're completely overriding EU::MM's default
1420     # installation and uninstallation targets.
1421
1422 # If installation is on Win32, we need to do permissions different from *nix
1423     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1424             foreach my $key (sort keys %$target_directories) {
1425                     $install .= qq(
1426 KOHA_INST_$key = blib/$key
1427 KOHA_DEST_$key = $target_directories->{$key}
1428 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1429                 }
1430                 $install .= qq(
1431 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1432 \t\$(NOECHO) \$(NOOP)
1433 );
1434                         $install .= "install_koha ::\n";
1435                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1436                         foreach my $key (sort keys %$target_directories) {
1437                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1438                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1439                         }
1440                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1441                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1442
1443                         $install .= "\n";
1444                         $install .= "set_koha_ownership ::\n";
1445 # Do not try to change ownership if DESTDIR is set
1446                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1447                                 foreach my $key (sort keys %$target_directories) {
1448                                         $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1449                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1450                                 }
1451                         } else {
1452                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1453                         }
1454
1455                         $install .= "\n";
1456                         $install .= "set_koha_permissions ::\n";
1457                         # This is necessary because EU::MM installs files
1458                         # as either 0444 or 0555, and we want the owner
1459                         # of Koha's files to have write permission by default.
1460                         foreach my $key (sort keys %$target_directories) {
1461                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1462                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1463                         }
1464         }
1465         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1466                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1467                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1468             foreach my $key (sort keys %$target_directories) {
1469                     $install .= qq(
1470 KOHA_INST_$key = blib/$key
1471 KOHA_DEST_$key = $target_directories->{$key}
1472 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1473                 }
1474                 $install .= qq(
1475 install :: all install_koha warn_koha_env_vars
1476 \t\$(NOECHO) \$(NOOP)
1477 );
1478                 $install .= "install_koha ::\n";
1479                 $install .= "\t\$(MOD_INSTALL) \\\n";
1480                 foreach my $key (sort keys %$target_directories) {
1481                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1482                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1483                 }
1484         }
1485         $install .= "\n";
1486
1487     $install .= "warn_koha_env_vars ::\n";
1488     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1489     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1490     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1491     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1492     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1493     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1494     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1495     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1496     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1497     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1498     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1499
1500     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1501         $install .= _update_zebra_conf_target();
1502     }
1503
1504     $install .= upgrade();
1505
1506     return $install;
1507 }
1508
1509 =head2 _update_zebra_conf_target
1510
1511 Add an installation target for updating
1512 Zebra's configuration files.
1513
1514 =cut
1515
1516 sub _update_zebra_conf_target {
1517
1518     my $target = "\nupdate_zebra_conf ::\n";
1519     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1520     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1521     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1522     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1523     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1524     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1525
1526     return $target;
1527 }
1528
1529 sub upgrade {
1530     my $upgrade = "";
1531
1532     my $backup_suffix;
1533     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1534         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1535         $version =~ s/\./_/g;
1536         $backup_suffix = "_koha_$version";
1537     } else {
1538         $backup_suffix = "_upgrade_backup";
1539     }
1540
1541     $upgrade .= qq/
1542 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1543
1544 upgrade :: make_upgrade_backup install
1545 \t\$(NOECHO) \$(NOOP)
1546 make_upgrade_backup ::
1547 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1548 /;
1549     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1550                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1551         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1552             unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1553                    exists $skip_directories->{$key} or
1554                    not exists $target_directories->{$key};
1555     }
1556     $upgrade =~ s/\\\n$/\n/;
1557
1558     return $upgrade;
1559 }
1560
1561 sub postamble {
1562     # put directory mappings into Makefile
1563     # so that Make will export as environment
1564     # variables -- this is for the use of
1565     # rewrite-confg.PL
1566
1567     # quote '$' in the two password parameters
1568     my %config = %config;
1569     $config{'DB_PASS'} =~ s/\$/\$\$/g;
1570     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1571         $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1572     }
1573
1574     my $env;
1575         # Hereagain, we must alter syntax per platform...
1576         if ( $^O eq 'MSWin32' ) {
1577                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1578                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1579                 $env .= "\n\n";
1580                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1581         }
1582     else {
1583                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1584                 $env .= "\n\n";
1585                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1586         }
1587
1588     if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1589         if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1590             print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1591             print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1592             print $confhandle "# It is separate from the standard koha-conf.xml so that you can edit this by hand and test with different configurations.\n";
1593
1594             # these directories will be relocated to the 't' directory
1595             foreach my $dirname ( keys %$target_directories ) {
1596                 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1597                 if ( exists $test_suite_override_dirs{$dirname} ) {
1598                     $dir = main::get_test_dir($dirname);
1599                 }
1600                 print $confhandle "$dirname = $dir\n"
1601             }
1602             print $confhandle "\n";
1603
1604             print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1605             close( $confhandle );
1606         } else {
1607             warn 'unable to open conf file for database dependent tests: $!';
1608         }
1609
1610     }
1611     return "$env\n";
1612 }
1613
1614
1615 __END__
1616
1617
1618 =head1 SEE ALSO
1619
1620 ExtUtils::MakeMaker(3)
1621
1622 =head1 AUTHORS
1623
1624 MJ Ray mjr at phonecoop.coop
1625 Galen Charlton galen.charlton at liblime.com
1626
1627 =cut
1628 FIXME: deal with .htaccess