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