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