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