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