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