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