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