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