Makefile.PL

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