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