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