Makefile.PL

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