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   './edithelp.pl'               => 'INTRANET_CGI_DIR',
 254   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
 255   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
 256   './etc/pazpar2'               => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
 257   './help.pl'                   => 'INTRANET_CGI_DIR',
 258   './installer-CPAN.pl'         => 'NONE',
 259   './installer'                 => 'INTRANET_CGI_DIR',
 260   './errors'                    => {target => 'INTRANET_CGI_DIR'},
 261   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
 262   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
 263   './kohaversion.pl'            => 'INTRANET_CGI_DIR',
 264   './labels'                    => 'INTRANET_CGI_DIR',
 265   './mainpage.pl'               => 'INTRANET_CGI_DIR',
 266   './Makefile.PL'               => 'NONE',
 267   './MANIFEST.SKIP'             => 'NONE',
 268   './members'                   => 'INTRANET_CGI_DIR',
 269   './misc'                      => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
 270   './misc/bin'                  => { target => 'SCRIPT_DIR', trimdir => -1 },
 271   './misc/release_notes'        => { target => 'DOC_DIR', trimdir => 2 },
 272   './misc/translator'           => { target => 'MISC_DIR', trimdir => 2 },
 273   './misc/koha-install-log'     => { target => 'MISC_DIR', trimdir => -1 },
 274   './misc/installer_devel_notes' => 'NONE',
 275   './opac'                      => 'OPAC_CGI_DIR',
 276   './README.txt'                => 'NONE',
 277   './reports'                   => 'INTRANET_CGI_DIR',
 278   './reserve'                   => 'INTRANET_CGI_DIR',
 279   './reviews'                   => 'INTRANET_CGI_DIR',
 280   './rewrite-config.PL'         => 'NONE',
 281   './reviews'                   => 'INTRANET_CGI_DIR',
 282   './rss'                       => 'MISC_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 configuratio 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     => strftime('2.9.%Y%m%d%H',gmtime),
 530               VERSION_FROM => 'kohaversion.pl',
 531               ABSTRACT     => 'Award-winning integrated library system (ILS) and Web OPAC',
 532               AUTHOR       => 'Koha Developers <koha-devel@nongnu.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.10',
 540                             'Class::Factory::Util'             => 1.6,
 541                             'Class::Accessor'                  => 0.30,
 542                             'DBD::mysql'                       => 4.004,
 543                             'DBD::SQLite'                      => 1.13, # optional, used for offline circulation
 544                             'DBI'                              => 1.53,
 545                             'Data::ICal'                       => 0.13,
 546                             'Data::Dumper'                     => 2.121,
 547                             'Date::Calc'                       => 5.4,
 548                             'Date::ICal'                       => 1.72,
 549                             'Date::Manip'                      => 5.44,
 550                             'Digest::MD5'                      => 2.36,
 551                             'Email::Date'                      => 1.103,
 552                             'File::Temp'                       => 0.16,
 553                             'GD'                               => 2.39,    #optional
 554                             'GD::Barcode::UPCE'                => 1.1,
 555                             'Getopt::Long'                     => 2.35,
 556                             'Getopt::Std'                      => 1.05,
 557                             'HTML::Template::Pro'              => 0.69,
 558                             'HTML::Scrubber'                   => 0.08,
 559                             'HTTP::Cookies'                    => 1.39,
 560                             'HTTP::Request::Common'            => 1.26,
 561                             'LWP::Simple'                      => 1.41,
 562                             'LWP::UserAgent'                   => 2.033,
 563                             'Lingua::Stem'                     => 0.82,
 564                             'List::Util'                       => 1.18,
 565                             'List::MoreUtils'                  => 0.21,
 566                             'Locale::Language'                 => 2.07,
 567                             'MARC::Charset'                    => 0.98,
 568                             'MARC::Crosswalk::DublinCore'      => 0.02,
 569                             'MARC::File::XML'                  => 0.88,
 570                             'MARC::Record'                     => 2.00,
 571                             'MIME::Base64'                     => 3.07,
 572                             'MIME::Lite'                       => 3.00,
 573                             'MIME::QuotedPrint'                => 3.07,
 574                             'Mail::Sendmail'                   => 0.79,
 575                             'Net::LDAP'                        => 0.33, # optional
 576                             'Net::LDAP::Filter'                => 0.14, # optional
 577                             'Net::Z3950::ZOOM'                 => 1.16,
 578                             'PDF::API2'                        => 2.000,
 579                             'PDF::API2::Page'                  => 2.000,
 580                             'PDF::API2::Util'                  => 2.000,
 581                             'PDF::Reuse'                       => 0.33,
 582                             'PDF::Reuse::Barcode'              => 0.05,
 583                             'POE'                              => 0.9999,
 584                             'POSIX'                            => 1.09,
 585                             'Schedule::At'                     => 1.06,
 586                             'SMS::Send'                        => 0.05, # optional
 587                             'Term::ANSIColor'                  => 1.10,
 588                             'Test'                             => 1.25,
 589                             'Test::Harness'                    => 2.56,
 590                             'Test::More'                       => 0.62,
 591                             'Text::CSV'                        => 0.01,
 592                             'Text::CSV_XS'                     => 0.32,
 593                             'Text::Iconv'                      => 1.7,
 594                             'Text::Wrap'                       => 2005.082401,
 595                             'Time::HiRes'                      => 1.86,
 596                             'Time::localtime'                  => 1.02,
 597                             'Unicode::Normalize'               => 0.32,
 598                             'XML::Dumper'                      => 0.81,
 599                             'XML::LibXML'                      => 1.59,
 600                             'XML::LibXSLT'                     => 1.59,
 601                             'XML::SAX::ParserFactory'          => 1.01,
 602                             'XML::Simple'                      => 2.14,
 603                             'XML::RSS'                         => 1.31,
 604                             'YAML::Syck'                       => 0.71,
 605                         },
 606
 607               # File tree mapping
 608               PM => $file_map,
 609
 610               # Man pages generated from POD
 611               INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
 612               INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
 613
 614               PL_FILES => $pl_files,
 615 );
 616
 617 =head1 FUNCTIONS
 618
 619 =head2 hashdir
 620
 621 This function recurses through the directory structure and builds
 622 a hash of hashes containing the structure with arrays holding filenames.
 623 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 624
 625 =cut
 626
 627 sub hashdir{
 628     my $dir = shift;
 629     opendir my $dh, $dir or die $!;
 630     my $tree = {}->{$dir} = {};
 631     while( my $file = readdir($dh) ) {
 632         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 633         my $path = $dir .'/' . $file;
 634         $tree->{$file} = hashdir($path), next if -d $path;
 635         push @{$tree->{'.'}}, $file;
 636     }
 637     return $tree;
 638 }
 639
 640 =head2 get_file_map
 641
 642 This function combines the target_map and file hash to
 643 map each source file to its destination relative to
 644 the set of installation targets.
 645
 646 Output will be a hash mapping from each source file
 647 to its destination value, like this:
 648
 649 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 650
 651 =cut
 652
 653 sub get_file_map {
 654     my $target_map = shift;
 655     my $dirtree = shift;
 656     my $file_map = shift;
 657     my $install_zebra = shift;
 658     my $curr_path = @_ ? shift : ['.'];
 659
 660     # Traverse the directory tree.
 661     # For each file or directory, identify the
 662     # most specific match in the target_map
 663     foreach my $dir (sort keys %{ $dirtree }) {
 664         if ($dir eq '.') {
 665             # deal with files in directory
 666             foreach my $file (sort @{ $dirtree->{$dir} }) {
 667                 my $targetdir = undef;
 668                 my $matchlevel = undef;
 669                 # first, see if there is a match on this specific
 670                 # file in the target map
 671                 my $filepath = join("/", @$curr_path, $file);
 672                 if (exists $target_map->{$filepath}) {
 673                     $targetdir = $target_map->{$filepath};
 674                     $matchlevel = scalar(@$curr_path) + 1;
 675                 } else {
 676                     # no match on the specific file; look for
 677                     # a directory match
 678                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 679                         my $dirpath = join("/", @$curr_path[0..$i]);
 680                         if (exists $target_map->{$dirpath}) {
 681                             $targetdir = $target_map->{$dirpath};
 682                             $matchlevel = $i + 1;
 683                             last;
 684                         }
 685                     }
 686                 }
 687                 if (defined $targetdir) {
 688                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
 689                 } else {
 690                     my $path = join("/", @$curr_path);
 691                     print "failed to map: $path/$file\n" if $DEBUG;
 692                 }
 693             }
 694         } else {
 695             # dealing with subdirectory
 696             push @$curr_path, $dir;
 697             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
 698             pop @$curr_path;
 699         }
 700     }
 701 }
 702
 703 sub _add_to_file_map {
 704     my $file_map = shift;
 705     my $targetdir = shift;
 706     my $curr_path = shift;
 707     my $file = shift;
 708     my $matchlevel = shift;
 709     my $install_zebra = shift;
 710     my $dest_path = @_ ? shift : $curr_path;
 711
 712     # The target can be one of the following:
 713     # 1. scalar representing target symbol
 714     # 2. hash ref containing target and trimdir keys
 715     #
 716     # Consequently, this routine traverses this structure,
 717     # calling itself recursively, until it deals with
 718     # all of the scalar target symbols.
 719     if (ref $targetdir eq 'HASH') {
 720         my $subtarget = $targetdir->{target};
 721         if (exists $targetdir->{trimdir}) {
 722             # if we get here, we've specified that
 723             # rather than installing the file to
 724             # $(TARGET)/matching/dirs/subdirs/file,
 725             # we want to install it to
 726             # $(TARGET)/subdirs/file
 727             #
 728             # Note that this the only place where
 729             # $matchlevel is used.
 730             my @new_dest_path = @$dest_path;
 731             if ($targetdir->{trimdir} == -1)  {
 732                 splice @new_dest_path, 0, $matchlevel;
 733             } else {
 734                 splice @new_dest_path, 0, $targetdir->{trimdir};
 735             }
 736             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
 737         } else {
 738             # actually getting here means that the
 739             # target was unnecessarily listed
 740             # as a hash, but we'll forgive that
 741             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
 742         }
 743     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 744         my $source = File::Spec->catfile(@$curr_path, $file);
 745         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 746         #print "$source => $destination\n"; # DEBUG
 747         # quote spaces in file names
 748         # FIXME: this is of questionable portability and
 749         # probably depends on user's make recognizing this
 750         # quoting syntax -- probably better to remove
 751         # spaces and shell metacharacters from all file names
 752         $source =~ s/ /\\ /g;
 753         $destination =~ s/ /\\ /g;
 754
 755         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
 756     }
 757 }
 758
 759 =head2 get_install_log_values
 760
 761 Reads value from the Koha install log specified by
 762 --prev-install-log
 763
 764 =cut
 765
 766 sub get_install_log_values {
 767     my $install_log = shift;
 768     my $values = shift;
 769
 770     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
 771     while (<LOG>) {
 772         chomp;
 773         next if /^#/ or /^\s*$/;
 774         next if /^=/;
 775         next unless m/=/;
 776         s/\s+$//g;
 777         my ($key, $value) = split /=/, $_, 2;
 778         $values->{$key} = $value;
 779     }
 780     close LOG;
 781
 782     print <<_EXPLAIN_INSTALL_LOG_;
 783 Reading values from install log $install_log.  You
 784 will be prompted only for settings that have been
 785 added since the last time you installed Koha.  To
 786 be prompted for all settings, run 'perl Makefile.PL'
 787 without the --prev-install-log option.
 788 _EXPLAIN_INSTALL_LOG_
 789 }
 790
 791 =head2 get_configuration
 792
 793 This prompts the user for various configuration options.
 794
 795 =cut
 796
 797 sub get_configuration {
 798   my $defaults = shift;
 799   my $valid_values = shift;
 800   my $install_log_values = shift;
 801   my %config = ();
 802
 803   my $msg = q(
 804 By default, Koha can be installed in one of three ways:
 805
 806 standard: Install files in conformance with the Filesystem
 807           Hierarchy Standard (FHS).  This is the default mode
 808           and should be used when installing a production
 809           Koha system.  On Unix systems, root access is
 810           needed to complete a standard installation.
 811
 812 single:   Install files under a single directory.  This option
 813           is useful for installing Koha without root access, e.g.,
 814           on a web host that allows CGI scripts and MySQL databases
 815           but requires the user to keep all files under the user's
 816           HOME directory.
 817
 818 dev:      Create a set of symbolic links and configuration files to
 819           allow Koha to run directly from the source distribution.
 820           This mode is useful for developers who want to run
 821           Koha from a git clone.
 822
 823 Installation mode);
 824     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 825     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
 826
 827     # set message and default value for INSTALL_BASE
 828     # depending on value of INSTALL_MODE
 829     my $install_base_default = $defaults->{'INSTALL_BASE'};
 830     if ($config{'INSTALL_MODE'} eq 'dev') {
 831         $msg = q(
 832 Please specify the directory in which to install Koha's
 833 active configuration files and (if applicable) the
 834 Zebra database.  Koha's CGI scripts and templates will
 835 be run from the current directory.
 836
 837 Configuration directory:);
 838         # FIXME - home directory portability consideration apply
 839         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
 840     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 841         $msg = "\nPlease specify the directory in which to install Koha";
 842         # FIXME -- we're assuming under a 'single' mode install
 843         # that user will likely want to install under the home
 844         # directory.  This is OK in and of itself, but we should
 845         # use File::HomeDir to locate the home directory portably.
 846         # This is deferred for now because File::HomeDir is not yet
 847         # core.
 848                 # --we must also keep this portable to the major OS's -fbcit
 849         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
 850     } else {
 851         # must be standard
 852         $msg = q(
 853 Please specify the directory under which most Koha files
 854 will be installed.
 855
 856 Note that if you are planning in installing more than
 857 one instance of Koha, you may want to modify the last
 858 component of the directory path, which will be used
 859 as the package name in the FHS layout.
 860
 861 Base installation directory);
 862     }
 863     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
 864
 865     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 866         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
 867     if ($config{'INSTALL_MODE'} eq "standard") {
 868         $msg = q(
 869 Since you are using the 'standard' install
 870 mode, you should run 'make install' as root.
 871 However, it is recommended that a non-root
 872 user (on Unix and Linux platforms) have
 873 ownership of Koha's files, including the
 874 Zebra indexes if applicable.
 875
 876 Please specify a user account.  This
 877 user account does not need to exist
 878 right now, but it needs to exist
 879 before you run 'make install'.  Please
 880 note that for security reasons, this
 881 user should not be the same as the user
 882 account Apache runs under.
 883
 884 User account);
 885         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
 886
 887         $msg = q(
 888 Please specify the group that should own
 889 Koha's files.  As above, this group need
 890 not exist right now, but should be created
 891 before you run 'make install'.
 892
 893 Group);
 894         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
 895     }
 896
 897     $msg = q(
 898 Please specify which database engine you will use
 899 to store data in Koha.  The choices are MySQL and
 900 PostgreSQL; please note that at the moment
 901 PostgreSQL support is highly experimental.
 902
 903 DBMS to use);
 904     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
 905     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
 906
 907     $msg = q(
 908 Please specify the name or address of your
 909 database server.  Note that the database
 910 does not have to exist at this point, it
 911 can be created after running 'make install'
 912 and before you try using Koha for the first time.
 913
 914 Database server);
 915     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
 916
 917     $msg = q(
 918 Please specify the port used to connect to the
 919 DMBS);
 920     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
 921     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
 922
 923     $msg = q(
 924 Please specify the name of the database to be
 925 used by Koha);
 926     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
 927
 928     $msg = q(
 929 Please specify the user that owns the database to be
 930 used by Koha);
 931     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
 932
 933     $msg = q(
 934 Please specify the password of the user that owns the
 935 database to be used by Koha);
 936     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
 937
 938     $msg = q(
 939 Koha can use the Zebra search engine for high-performance
 940 searching of bibliographic and authority records.  If you
 941 have installed the Zebra software and would like to use it,
 942 please answer 'yes' to the following question.  Otherwise,
 943 Koha will default to using its internal search engine.
 944
 945 Please note that if you choose *NOT* to install Zebra,
 946 koha-conf.xml will still contain some references to Zebra
 947 settings.  Those references will be ignored by Koha.
 948
 949 Install the Zebra configuration files?);
 950     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
 951     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
 952
 953     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
 954
 955         if (defined(my $zebra_path = find_zebra())) {
 956             $config{'PATH_TO_ZEBRA'} = $zebra_path;
 957             print qq(
 958 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
 959 );
 960         } else {
 961             print q(
 962 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
 963 in your PATH or in some of the usual places.  If you haven't
 964 installed Zebra yet, please do so and run Makefile.PL again.
 965
 966 );
 967         }
 968
 969         $msg = q(
 970 Since you've chosen to use Zebra with Koha,
 971 you must specify the primary MARC format of the
 972 records to be indexed by Zebra.
 973
 974 Koha provides Zebra configuration files for MARC 21
 975 and UNIMARC.
 976
 977 MARC format for Zebra indexing);
 978         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
 979         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
 980         $msg = q(
 981 Koha supplies Zebra configuration files tuned for
 982 searching either English (en) or French (fr) MARC
 983 records.
 984
 985 Primary language for Zebra indexing);
 986         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
 987         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
 988
 989         $msg = q(
 990 Koha can use one of  two different indexing modes
 991 for the MARC authorities records:
 992
 993 grs1 - uses the Zebra GRS-1 filter, available
 994        for legacy support
 995 dom  - uses the DOM XML filter; offers improved
 996        functionality.
 997
 998 Authorities indexing mode);
 999         $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1000         $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1001
1002         $msg = q(
1003 Please specify Zebra database user);
1004         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1005
1006         $msg = q(
1007 Please specify the Zebra database password);
1008         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1009
1010         $msg = q(
1011 Since you've chosen to use Zebra, you can enable the SRU/
1012 Z39.50 Server if you so choose, but you must specify a
1013 few configuration options for it.
1014
1015 Please note that if you choose *NOT* to configure SRU,
1016 koha-conf.xml will still contain some references to SRU
1017 settings.  Those references will be ignored by Koha.
1018
1019 Install the SRU configuration files?);
1020         $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1021         $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1022
1023         if ($config{'INSTALL_SRU'} eq 'yes') {
1024             $msg = q(
1025 Since you've chosen to configure SRU, you must
1026 specify the host and port(s) that the SRU
1027 Servers (bibliographic and authority) should run on.
1028 );
1029             $msg = q(
1030 SRU Database host?);
1031             $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1032
1033             $msg = q(
1034 SRU port for bibliographic data?);
1035             $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1036
1037             $msg = q(
1038 SRU port for authority data?);
1039             $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1040
1041         }
1042
1043         $msg = q(
1044 Since you've chosen to use Zebra, you can also choose to
1045 install PazPar2, which is a metasearch tool.  With PazPar2,
1046 Koha can perform on-the-fly merging of bibliographic
1047 records during searching, allowing for FRBRization of
1048 the results list.
1049
1050 Install the PazPar2 configuration files?);
1051         $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1052         $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1053
1054         if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1055             $msg = q(
1056 Since you've chosen to configure PazPar2, you must
1057 specify the host and port(s) that PazPar2
1058 uses:
1059 );
1060             $msg = q(
1061 Zebra bibliographic server host?);
1062             $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1063
1064             $msg = q(
1065 Zebra bibliographic port for PazPar2 to use?);
1066             $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1067
1068             $msg = q(
1069 PazPar2 host?);
1070             $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1071
1072             $msg = q(
1073 PazPar2 port?);
1074             $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1075
1076         }
1077     }
1078
1079   $msg = q(
1080 Would you like to run the database-dependent test suite?);
1081   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1082     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1083
1084   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1085       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1086       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1087       $msg = q(TEST DATABASE
1088
1089 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1090 testing. Please don't do this on your production database. It is not
1091 reversable.
1092
1093 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1094 database. You are better off not running this optional test suite than
1095 doing it in a database that you don't want to lose.
1096
1097 Please specify the name of the test database to be
1098 used by Koha);
1099
1100       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1101       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1102           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1103           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1104       }
1105
1106       $msg = q(
1107 Please specify the user that owns the database to be
1108 used by Koha);
1109     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1110
1111       $msg = q(
1112 Please specify the password of the user that owns the
1113 database to be used by Koha);
1114       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1115   }
1116
1117     print "\n\n";
1118
1119     # add version number
1120     my $version = "no_version_found";
1121     eval {
1122         require 'kohaversion.pl';
1123         $version = kohaversion();
1124     };
1125     $config{'KOHA_INSTALLED_VERSION'} = $version;
1126
1127     return %config;
1128 }
1129
1130 sub _add_valid_values_disp {
1131     my $key = shift;
1132     my $valid_values = shift;
1133
1134     my $disp = "";
1135     if (exists $valid_values->{$key}) {
1136         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1137     }
1138     return $disp;
1139 }
1140
1141 sub _get_value {
1142     my $key = shift;
1143     my $msg = shift;
1144     my $default = shift;
1145     my $valid_values = shift;
1146     my $install_log_values = shift;
1147
1148     # take value from install log if present
1149     if (exists $install_log_values{$key}) {
1150         return $install_log_values{$key};
1151     }
1152
1153     # override default value from environment
1154     if (exists $ENV{$key}) {
1155         $default = $ENV{$key};
1156         $msg .= " (default from environment)";
1157     }
1158
1159     my $val = prompt($msg, $default);
1160
1161     while (exists $valid_values->{$key} and
1162            $val ne $default and
1163            not exists $valid_values->{$key}->{$val}) {
1164         my $retry_msg = "Value '$val' is not a valid option.\n";
1165         $retry_msg .= "Please enter a value";
1166         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1167         $val = prompt($retry_msg, $default);
1168     }
1169     return $val;
1170 }
1171
1172 =head2 get_target_directories
1173
1174 Creates a hash mapping from symbols for installation target
1175 directories to actual directory paths.
1176
1177 Also returns a hash indicating targets for which
1178 files need not be copied -- this is used for the 'dev'
1179 mode installation, where some files are installed in place.
1180
1181 =cut
1182
1183 sub get_target_directories {
1184     my $config = shift;
1185
1186     my $base = $config->{'INSTALL_BASE'};
1187     my $mode = $config->{'INSTALL_MODE'};
1188
1189     # get last component of install base directory
1190     # to treat as package name
1191     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1192
1193     my @basedir = File::Spec->splitdir($directories);
1194
1195         # for Win32 we need to prepend the volume to the directory path
1196         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1197         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1198
1199     my $package = pop @basedir;
1200
1201
1202     my %dirmap = ();
1203     my %skipdirs = ();
1204     if ($mode eq 'single') {
1205         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1206         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1207         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1208         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1209         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1210         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1211         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1212         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1213         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1214         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1215         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1216         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1217         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1218         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1219         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1220         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1221         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1222         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1223         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1224     } elsif ($mode eq 'dev') {
1225         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1226         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1227         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1228         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1229         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1230         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1231         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1232         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1233         $skipdirs{'OPAC_CGI_DIR'} = 1;
1234         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1235         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1236         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1237         $skipdirs{'OPAC_WWW_DIR'} = 1;
1238         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1239         $skipdirs{'PERL_MODULE_DIR'} = 1;
1240         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1241         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1242         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1243         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1244         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1245         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1246         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1247         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1248         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1249         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1250         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1251         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1252         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1253     } else {
1254         # mode is standard, i.e., 'fhs'
1255         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1256         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1257         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1258         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1259         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1260         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1261         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1262         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1263         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1264         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1265         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1266         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1267         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1268         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1269         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1270         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1271         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1272         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1273         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1274     }
1275
1276     _get_env_overrides(\%dirmap);
1277     _get_argv_overrides(\%dirmap);
1278
1279     return \%dirmap, \%skipdirs;
1280 }
1281
1282 =head2 get_test_dir
1283
1284 Map a directory target to the corresponding path for
1285 the test suite.
1286
1287 =cut
1288
1289 sub get_test_dir {
1290     my ($dirname) = @_;
1291
1292     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1293     if (exists $test_suite_override_dirs{$dirname}) {
1294         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1295     } else {
1296         return;
1297     }
1298
1299 }
1300
1301 sub _get_env_overrides {
1302     my $dirmap = shift;
1303
1304     foreach my $key (keys %$dirmap) {
1305         if (exists $ENV{$key}) {
1306             $dirmap->{$key} = $ENV{$key};
1307             print "Setting $key from environment\n";
1308         }
1309     }
1310 }
1311
1312 sub _get_argv_overrides {
1313     my $dirmap = shift;
1314
1315     my @new_argv = ();
1316     for (my $i = 0; $i <= $#ARGV; $i++) {
1317         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1318             $dirmap->{$1} = $2;
1319         } else {
1320             push @new_argv, $ARGV[$i];
1321         }
1322     }
1323     @ARGV = @new_argv;
1324 }
1325
1326 sub display_configuration {
1327     my $config = shift;
1328     my $dirmap = shift;
1329     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1330     foreach my $key (sort keys %$config) {
1331         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1332     }
1333
1334     print "\nand in the following directories:\n\n";
1335     foreach my $key (sort keys %$dirmap) {
1336         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1337     }
1338     print "\n\nTo change any configuration setting, please run\n";
1339     print "perl Makefile.PL again.  To override one of the target\n";
1340     print "directories, you can do so on the command line like this:\n";
1341     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1342     print "You can also set different default values for parameters\n";
1343     print "or override directory locations by using environment variables.\n";
1344     print "\nFor example:\n\n";
1345     print "export DB_USER=my_koha\n";
1346     print "perl Makefile.PL\n";
1347     print "\nor\n\n";
1348     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1349     print "If installing on a Win32 platform, be sure to use:\n";
1350     print "'dmake -x MAXLINELENGTH=300000'\n\n";
1351 }
1352
1353 =head2 find_zebra
1354
1355 Attempt to find Zebra - check user's PATH and
1356 a few other directories for zebrasrv and zebraidx.
1357
1358 FIXME: doesn't handle Win32
1359
1360 =cut
1361
1362 sub find_zebra {
1363     my @search_dirs = map {
1364                             my $abs = File::Spec->rel2abs($_);
1365                             my ($toss, $directories);
1366                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1367                             $directories;
1368                         }  split /:/, $ENV{PATH};
1369     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1370     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1371     return unless @zebrasrv_dirs;
1372     # verify that directory that contains zebrasrv also contains zebraidx
1373     foreach my $dir (@zebrasrv_dirs) {
1374         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1375     }
1376     return;
1377 }
1378
1379 package MY;
1380
1381 # This will have to be reworked in order to accommodate Win32...
1382
1383 sub test {
1384     my $self = shift;
1385     my $test = $self->SUPER::test(@_);
1386     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1387
1388     # set KOHA_CONF
1389     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1390     return $test;
1391 }
1392
1393 sub install {
1394     my $self = shift;
1395     my $install = "";
1396     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1397     # This means that we're completely overriding EU::MM's default
1398     # installation and uninstallation targets.
1399
1400 # If installation is on Win32, we need to do permissions different from *nix
1401     if ( $^O =~ /darwin|linux|cygwin|freebsd/ ) { # this value needs to be verified for each platform and modified accordingly
1402             foreach my $key (sort keys %$target_directories) {
1403                     $install .= qq(
1404 KOHA_INST_$key = blib/$key
1405 KOHA_DEST_$key = $target_directories->{$key}
1406 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1407                 }
1408                 $install .= qq(
1409 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1410 \t\$(NOECHO) \$(NOOP)
1411 );
1412                         $install .= "install_koha ::\n";
1413                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1414                         foreach my $key (sort keys %$target_directories) {
1415                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1416                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1417                         }
1418                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1419                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1420
1421                         $install .= "\n";
1422                         $install .= "set_koha_ownership ::\n";
1423                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1424                                 foreach my $key (sort keys %$target_directories) {
1425                                         $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1426                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1427                                 }
1428                         } else {
1429                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1430                         }
1431
1432                         $install .= "\n";
1433                         $install .= "set_koha_permissions ::\n";
1434                         # This is necessary because EU::MM installs files
1435                         # as either 0444 or 0555, and we want the owner
1436                         # of Koha's files to have write permission by default.
1437                         foreach my $key (sort keys %$target_directories) {
1438                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1439                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1440                         }
1441         }
1442         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1443                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1444                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1445             foreach my $key (sort keys %$target_directories) {
1446                     $install .= qq(
1447 KOHA_INST_$key = blib/$key
1448 KOHA_DEST_$key = $target_directories->{$key}
1449 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1450                 }
1451                 $install .= qq(
1452 install :: all install_koha warn_koha_env_vars
1453 \t\$(NOECHO) \$(NOOP)
1454 );
1455                 $install .= "install_koha ::\n";
1456                 $install .= "\t\$(MOD_INSTALL) \\\n";
1457                 foreach my $key (sort keys %$target_directories) {
1458                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1459                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1460                 }
1461         }
1462         $install .= "\n";
1463
1464     $install .= "warn_koha_env_vars ::\n";
1465     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1466     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1467     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1468     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1469     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1470     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1471     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1472     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1473     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1474     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1475     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1476
1477     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1478         $install .= _update_zebra_conf_target();
1479     }
1480
1481     $install .= upgrade();
1482
1483     return $install;
1484 }
1485
1486 =head2 _update_zebra_conf_target
1487
1488 Add an installation target for updating
1489 Zebra's configuration files.
1490
1491 =cut
1492
1493 sub _update_zebra_conf_target {
1494
1495     my $target = "\nupdate_zebra_conf ::\n";
1496     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1497     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1498     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1499     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1500     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1501     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1502
1503     return $target;
1504 }
1505
1506 sub upgrade {
1507     my $upgrade = "";
1508
1509     my $backup_suffix;
1510     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1511         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1512         $version =~ s/\./_/g;
1513         $backup_suffix = "_koha_$version";
1514     } else {
1515         $backup_suffix = "_upgrade_backup";
1516     }
1517
1518     $upgrade .= qq/
1519 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1520
1521 upgrade :: make_upgrade_backup install
1522 \t\$(NOECHO) \$(NOOP)
1523 make_upgrade_backup ::
1524 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1525 /;
1526     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1527                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1528         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1529             unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1530                    exists $skip_directories->{$key} or
1531                    not exists $target_directories->{$key};
1532     }
1533     $upgrade =~ s/\\\n$/\n/;
1534
1535     return $upgrade;
1536 }
1537
1538 sub postamble {
1539     # put directory mappings into Makefile
1540     # so that Make will export as environment
1541     # variables -- this is for the use of
1542     # rewrite-confg.PL
1543
1544     # quote '$' in the two password parameters
1545     my %config = %config;
1546     $config{'DB_PASS'} =~ s/\$/\$\$/g;
1547     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1548         $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1549     }
1550
1551     my $env;
1552         # Hereagain, we must alter syntax per platform...
1553         if ( $^O eq 'MSWin32' ) {
1554                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1555                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1556                 $env .= "\n\n";
1557                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1558         }
1559     else {
1560                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1561                 $env .= "\n\n";
1562                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1563         }
1564
1565     if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1566         if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1567             print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1568             print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1569             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";
1570
1571             # these directories will be relocated to the 't' directory
1572             foreach my $dirname ( keys %$target_directories ) {
1573                 my $dir = $target_directories->{$dirname};
1574                 if ( exists $test_suite_override_dirs{$dirname} ) {
1575                     $dir = main::get_test_dir($dirname);
1576                 }
1577                 print $confhandle "$dirname = $dir\n"
1578             }
1579             print $confhandle "\n";
1580
1581             print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1582             close( $confhandle );
1583         } else {
1584             warn 'unable to open conf file for database dependent tests: $!';
1585         }
1586
1587     }
1588     return "$env\n";
1589 }
1590
1591
1592 __END__
1593
1594
1595 =head1 SEE ALSO
1596
1597 ExtUtils::MakeMaker(3)
1598
1599 =head1 AUTHORS
1600
1601 MJ Ray mjr at phonecoop.coop
1602 Galen Charlton galen.charlton at liblime.com
1603
1604 =cut
1605 FIXME: deal with .htaccess