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'   => 'dom',
 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                                                         'Authen::CAS::Client'              => 0.05,
 543                             'Biblio::EndnoteStyle'             => 0.05,
 544                             'CGI'                              => 3.15,
 545                             'CGI::Carp'                        => 1.29,
 546                             'CGI::Session'                     => 4.20,
 547                             'CGI::Session::Serialize::yaml'    => 4.20,
 548                             'Class::Factory::Util'             => 1.6,
 549                             'Class::Accessor'                  => 0.30,
 550                             'DBD::mysql'                       => 4.004,
 551                             'DBD::SQLite2'                     => 0.33, # optional, used for offline circulation
 552                             'DBI'                              => 1.53,
 553                             'Data::Dumper'                     => 2.121,
 554                             'Data::ICal'                       => 0.13,
 555                             'Date::Calc'                       => 5.4,
 556                             'Date::ICal'                       => 1.72,
 557                             'Date::Manip'                      => 5.44,
 558                             'Digest::MD5'                      => 2.36,
 559                             'Digest::SHA'                      => 5.43,
 560                             'Email::Date'                      => 1.103,
 561                             'File::Temp'                       => 0.16,
 562                             'GD'                               => 2.39,    #optional, used for patron image feature
 563                             'GD::Barcode::UPCE'                => 1.1,
 564                             'Graphics::Magick'                 => 1.3.7,   #optional, used for patron cards creator
 565                             'Getopt::Long'                     => 2.35,
 566                             'Getopt::Std'                      => 1.05,
 567                             'HTML::Template::Pro'              => 0.69,
 568                             'HTML::Scrubber'                   => 0.08,
 569                             'HTTP::Cookies'                    => 1.39,
 570                             'HTTP::OAI'                        => 3.20,
 571                             'HTTP::Request::Common'            => 1.26,
 572                             'IPC::Cmd'                         => 0.46,
 573                             'JSON'                             => 2.07, # Needed by admin/item_circulation_alerts.pl
 574                             'LWP::Simple'                      => 1.41,
 575                             'LWP::UserAgent'                   => 2.033,
 576                             'Lingua::Stem'                     => 0.82,
 577                             'Lingua::Stem::Snowball'           => 0.952,
 578                             'List::Util'                       => 1.18,
 579                             'List::MoreUtils'                  => 0.21,
 580                             'Locale::Language'                 => 2.07,
 581                             'MARC::Charset'                    => 0.98,
 582                             'MARC::Crosswalk::DublinCore'      => 0.02,
 583                             'MARC::File::XML'                  => 0.88,
 584                             'MARC::Record'                     => 2.00,
 585                             'MIME::Base64'                     => 3.07,
 586                             'MIME::Lite'                       => 3.00,
 587                             'MIME::QuotedPrint'                => 3.07,
 588                             'Mail::Sendmail'                   => 0.79,
 589                             'Memoize::Memcached'               => 0.03, # optional
 590                             'Net::LDAP'                        => 0.33, # optional
 591                             'Net::LDAP::Filter'                => 0.14, # optional
 592                             'Net::Z3950::ZOOM'                 => 1.16,
 593                             'Number::Format'                   => 1.52,
 594                             'PDF::API2'                        => 2.000,
 595                             'PDF::API2::Page'                  => 2.000,
 596                             'PDF::API2::Util'                  => 2.000,
 597                             'PDF::API2::Simple'                => 1.000,
 598                             'PDF::Table'                       => 0.9.3,
 599                             'PDF::Reuse'                       => 0.33,
 600                             'PDF::Reuse::Barcode'              => 0.05,
 601                             'POE'                              => 0.9999,
 602                             'POSIX'                            => 1.09,
 603                             'Schedule::At'                     => 1.06,
 604                             'Storable'                         => 2.21,
 605                             'SMS::Send'                        => 0.05, # optional
 606                             'Term::ANSIColor'                  => 1.10,
 607                             'Test'                             => 1.25,
 608                             'Test::Harness'                    => 2.56,
 609                             'Test::More'                       => 0.80,
 610                             'Text::CSV'                        => 0.01,
 611                             'Text::CSV_XS'                     => 0.32,
 612                             'Text::CSV::Encoded'               => 0.09,
 613                             'Text::Iconv'                      => 1.7,
 614                             'Text::Wrap'                       => 2005.082401,
 615                             'Time::HiRes'                      => 1.86,
 616                             'Time::localtime'                  => 1.02,
 617                             'Unicode::Normalize'               => 0.32,
 618                             'URI::Escape'                      => 1.36,
 619                             'XML::Dumper'                      => 0.81,
 620                             'XML::LibXML'                      => 1.59,
 621                             'XML::LibXSLT'                     => 1.59,
 622                             'XML::SAX::ParserFactory'          => 1.01,
 623                             'XML::SAX::Writer'                 => 0.44,
 624                             'XML::Simple'                      => 2.14,
 625                             'XML::RSS'                         => 1.31,
 626                             'YAML::Syck'                       => 0.71,
 627                         },
 628
 629               # File tree mapping
 630               PM => $file_map,
 631
 632               # Man pages generated from POD
 633               # ExtUtils::MakeMaker already manage $(DESTDIR)
 634               INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
 635               INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
 636
 637               PL_FILES => $pl_files,
 638 );
 639
 640 =head1 FUNCTIONS
 641
 642 =head2 hashdir
 643
 644 This function recurses through the directory structure and builds
 645 a hash of hashes containing the structure with arrays holding filenames.
 646 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 647
 648 =cut
 649
 650 sub hashdir{
 651     my $dir = shift;
 652     opendir my $dh, $dir or die $!;
 653     my $tree = {}->{$dir} = {};
 654     while( my $file = readdir($dh) ) {
 655         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 656         my $path = $dir .'/' . $file;
 657         $tree->{$file} = hashdir($path), next if -d $path;
 658         push @{$tree->{'.'}}, $file;
 659     }
 660     return $tree;
 661 }
 662
 663 =head2 get_file_map
 664
 665 This function combines the target_map and file hash to
 666 map each source file to its destination relative to
 667 the set of installation targets.
 668
 669 Output will be a hash mapping from each source file
 670 to its destination value, like this:
 671
 672 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 673
 674 =cut
 675
 676 sub get_file_map {
 677     my $target_map = shift;
 678     my $dirtree = shift;
 679     my $file_map = shift;
 680     my $install_zebra = shift;
 681     my $curr_path = @_ ? shift : ['.'];
 682
 683     # Traverse the directory tree.
 684     # For each file or directory, identify the
 685     # most specific match in the target_map
 686     foreach my $dir (sort keys %{ $dirtree }) {
 687         if ($dir eq '.') {
 688             # deal with files in directory
 689             foreach my $file (sort @{ $dirtree->{$dir} }) {
 690                 my $targetdir = undef;
 691                 my $matchlevel = undef;
 692                 # first, see if there is a match on this specific
 693                 # file in the target map
 694                 my $filepath = join("/", @$curr_path, $file);
 695                 if (exists $target_map->{$filepath}) {
 696                     $targetdir = $target_map->{$filepath};
 697                     $matchlevel = scalar(@$curr_path) + 1;
 698                 } else {
 699                     # no match on the specific file; look for
 700                     # a directory match
 701                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 702                         my $dirpath = join("/", @$curr_path[0..$i]);
 703                         if (exists $target_map->{$dirpath}) {
 704                             $targetdir = $target_map->{$dirpath};
 705                             $matchlevel = $i + 1;
 706                             last;
 707                         }
 708                     }
 709                 }
 710                 if (defined $targetdir) {
 711                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
 712                 } else {
 713                     my $path = join("/", @$curr_path);
 714                     print "failed to map: $path/$file\n" if $DEBUG;
 715                 }
 716             }
 717         } else {
 718             # dealing with subdirectory
 719             push @$curr_path, $dir;
 720             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
 721             pop @$curr_path;
 722         }
 723     }
 724 }
 725
 726 sub _add_to_file_map {
 727     my $file_map = shift;
 728     my $targetdir = shift;
 729     my $curr_path = shift;
 730     my $file = shift;
 731     my $matchlevel = shift;
 732     my $install_zebra = shift;
 733     my $dest_path = @_ ? shift : $curr_path;
 734
 735     # The target can be one of the following:
 736     # 1. scalar representing target symbol
 737     # 2. hash ref containing target and trimdir keys
 738     #
 739     # Consequently, this routine traverses this structure,
 740     # calling itself recursively, until it deals with
 741     # all of the scalar target symbols.
 742     if (ref $targetdir eq 'HASH') {
 743         my $subtarget = $targetdir->{target};
 744         if (exists $targetdir->{trimdir}) {
 745             # if we get here, we've specified that
 746             # rather than installing the file to
 747             # $(TARGET)/matching/dirs/subdirs/file,
 748             # we want to install it to
 749             # $(TARGET)/subdirs/file
 750             #
 751             # Note that this the only place where
 752             # $matchlevel is used.
 753             my @new_dest_path = @$dest_path;
 754             if ($targetdir->{trimdir} == -1)  {
 755                 splice @new_dest_path, 0, $matchlevel;
 756             } else {
 757                 splice @new_dest_path, 0, $targetdir->{trimdir};
 758             }
 759             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
 760         } else {
 761             # actually getting here means that the
 762             # target was unnecessarily listed
 763             # as a hash, but we'll forgive that
 764             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
 765         }
 766     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 767         my $source = File::Spec->catfile(@$curr_path, $file);
 768         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 769         #print "$source => $destination\n"; # DEBUG
 770         # quote spaces in file names
 771         # FIXME: this is of questionable portability and
 772         # probably depends on user's make recognizing this
 773         # quoting syntax -- probably better to remove
 774         # spaces and shell metacharacters from all file names
 775         $source =~ s/ /\\ /g;
 776         $destination =~ s/ /\\ /g;
 777
 778         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
 779     }
 780 }
 781
 782 =head2 get_install_log_values
 783
 784 Reads value from the Koha install log specified by
 785 --prev-install-log
 786
 787 =cut
 788
 789 sub get_install_log_values {
 790     my $install_log = shift;
 791     my $values = shift;
 792
 793     open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
 794     while (<LOG>) {
 795         chomp;
 796         next if /^#/ or /^\s*$/;
 797         next if /^=/;
 798         next unless m/=/;
 799         s/\s+$//g;
 800         my ($key, $value) = split /=/, $_, 2;
 801         $values->{$key} = $value;
 802     }
 803     close LOG;
 804
 805     print <<_EXPLAIN_INSTALL_LOG_;
 806 Reading values from install log $install_log.  You
 807 will be prompted only for settings that have been
 808 added since the last time you installed Koha.  To
 809 be prompted for all settings, run 'perl Makefile.PL'
 810 without the --prev-install-log option.
 811 _EXPLAIN_INSTALL_LOG_
 812 }
 813
 814 =head2 get_configuration
 815
 816 This prompts the user for various configuration options.
 817
 818 =cut
 819
 820 sub get_configuration {
 821   my $defaults = shift;
 822   my $valid_values = shift;
 823   my $install_log_values = shift;
 824   my %config = ();
 825
 826   my $msg = q(
 827 By default, Koha can be installed in one of three ways:
 828
 829 standard: Install files in conformance with the Filesystem
 830           Hierarchy Standard (FHS).  This is the default mode
 831           and should be used when installing a production
 832           Koha system.  On Unix systems, root access is
 833           needed to complete a standard installation.
 834
 835 single:   Install files under a single directory.  This option
 836           is useful for installing Koha without root access, e.g.,
 837           on a web host that allows CGI scripts and MySQL databases
 838           but requires the user to keep all files under the user's
 839           HOME directory.
 840
 841 dev:      Create a set of symbolic links and configuration files to
 842           allow Koha to run directly from the source distribution.
 843           This mode is useful for developers who want to run
 844           Koha from a git clone.
 845
 846 Installation mode);
 847     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 848     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
 849
 850     # set message and default value for INSTALL_BASE
 851     # depending on value of INSTALL_MODE
 852     my $install_base_default = $defaults->{'INSTALL_BASE'};
 853     if ($config{'INSTALL_MODE'} eq 'dev') {
 854         $msg = q(
 855 Please specify the directory in which to install Koha's
 856 active configuration files and (if applicable) the
 857 Zebra database.  Koha's CGI scripts and templates will
 858 be run from the current directory.
 859
 860 Configuration directory:);
 861         # FIXME - home directory portability consideration apply
 862         $install_base_default =
 863             $ENV{DESTDIR}
 864             || ( exists $ENV{HOME} ? "$ENV{HOME}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev" )
 865         ;
 866     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 867         $msg = "\nPlease specify the directory in which to install Koha";
 868         # FIXME -- we're assuming under a 'single' mode install
 869         # that user will likely want to install under the home
 870         # directory.  This is OK in and of itself, but we should
 871         # use File::HomeDir to locate the home directory portably.
 872         # This is deferred for now because File::HomeDir is not yet
 873         # core.
 874                 # --we must also keep this portable to the major OS's -fbcit
 875         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
 876     } else {
 877         # must be standard
 878         $msg = q(
 879 Please specify the directory under which most Koha files
 880 will be installed.
 881
 882 Note that if you are planning in installing more than
 883 one instance of Koha, you may want to modify the last
 884 component of the directory path, which will be used
 885 as the package name in the FHS layout.
 886
 887 Base installation directory);
 888     }
 889     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
 890
 891     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 892         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
 893     if ($config{'INSTALL_MODE'} eq "standard") {
 894         $msg = q(
 895 Since you are using the 'standard' install
 896 mode, you should run 'make install' as root.
 897 However, it is recommended that a non-root
 898 user (on Unix and Linux platforms) have
 899 ownership of Koha's files, including the
 900 Zebra indexes if applicable.
 901
 902 Please specify a user account.  This
 903 user account does not need to exist
 904 right now, but it needs to exist
 905 before you run 'make install'.  Please
 906 note that for security reasons, this
 907 user should not be the same as the user
 908 account Apache runs under.
 909
 910 User account);
 911         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
 912
 913         $msg = q(
 914 Please specify the group that should own
 915 Koha's files.  As above, this group need
 916 not exist right now, but should be created
 917 before you run 'make install'.
 918
 919 Group);
 920         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
 921     }
 922
 923     $msg = q(
 924 Please specify which database engine you will use
 925 to store data in Koha.  The choices are MySQL and
 926 PostgreSQL; please note that at the moment
 927 PostgreSQL support is highly experimental.
 928
 929 DBMS to use);
 930     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
 931     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
 932
 933     $msg = q(
 934 Please specify the name or address of your
 935 database server.  Note that the database
 936 does not have to exist at this point, it
 937 can be created after running 'make install'
 938 and before you try using Koha for the first time.
 939
 940 Database server);
 941     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
 942
 943     $msg = q(
 944 Please specify the port used to connect to the
 945 DMBS);
 946     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
 947     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
 948
 949     $msg = q(
 950 Please specify the name of the database to be
 951 used by Koha);
 952     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
 953
 954     $msg = q(
 955 Please specify the user that owns the database to be
 956 used by Koha);
 957     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
 958
 959     $msg = q(
 960 Please specify the password of the user that owns the
 961 database to be used by Koha);
 962     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
 963
 964     $msg = q(
 965 Koha can use the Zebra search engine for high-performance
 966 searching of bibliographic and authority records.  If you
 967 have installed the Zebra software and would like to use it,
 968 please answer 'yes' to the following question.  Otherwise,
 969 Koha will default to using its internal search engine.
 970
 971 Please note that if you choose *NOT* to install Zebra,
 972 koha-conf.xml will still contain some references to Zebra
 973 settings.  Those references will be ignored by Koha.
 974
 975 Install the Zebra configuration files?);
 976     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
 977     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
 978
 979     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
 980
 981         if (defined(my $zebra_path = find_zebra())) {
 982             $config{'PATH_TO_ZEBRA'} = $zebra_path;
 983             print qq(
 984 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
 985 );
 986         } else {
 987             print q(
 988 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
 989 in your PATH or in some of the usual places.  If you haven't
 990 installed Zebra yet, please do so and run Makefile.PL again.
 991
 992 );
 993         }
 994
 995         $msg = q(
 996 Since you've chosen to use Zebra with Koha,
 997 you must specify the primary MARC format of the
 998 records to be indexed by Zebra.
 999
1000 Koha provides Zebra configuration files for MARC 21
1001 and UNIMARC.
1002
1003 MARC format for Zebra indexing);
1004         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
1005         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
1006         $msg = q(
1007 Koha supplies Zebra configuration files tuned for
1008 searching either English (en) or French (fr) MARC
1009 records.
1010
1011 Primary language for Zebra indexing);
1012         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
1013         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1014
1015         $msg = q(
1016 Koha can use one of  two different indexing modes
1017 for the MARC authorities records:
1018
1019 grs1 - uses the Zebra GRS-1 filter, available
1020        for legacy support
1021 dom  - uses the DOM XML filter; offers improved
1022        functionality.
1023
1024 Authorities indexing mode);
1025         $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
1026         $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1027
1028         $msg = q(
1029 Please specify Zebra database user);
1030         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
1031
1032         $msg = q(
1033 Please specify the Zebra database password);
1034         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
1035
1036         $msg = q(
1037 Since you've chosen to use Zebra, you can enable the SRU/
1038 Z39.50 Server if you so choose, but you must specify a
1039 few configuration options for it.
1040
1041 Please note that if you choose *NOT* to configure SRU,
1042 koha-conf.xml will still contain some references to SRU
1043 settings.  Those references will be ignored by Koha.
1044
1045 Install the SRU configuration files?);
1046         $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
1047         $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
1048
1049         if ($config{'INSTALL_SRU'} eq 'yes') {
1050             $msg = q(
1051 Since you've chosen to configure SRU, you must
1052 specify the host and port(s) that the SRU
1053 Servers (bibliographic and authority) should run on.
1054 );
1055             $msg = q(
1056 SRU Database host?);
1057             $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
1058
1059             $msg = q(
1060 SRU port for bibliographic data?);
1061             $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
1062
1063             $msg = q(
1064 SRU port for authority data?);
1065             $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
1066
1067         }
1068
1069         $msg = q(
1070 Since you've chosen to use Zebra, you can also choose to
1071 install PazPar2, which is a metasearch tool.  With PazPar2,
1072 Koha can perform on-the-fly merging of bibliographic
1073 records during searching, allowing for FRBRization of
1074 the results list.
1075
1076 Install the PazPar2 configuration files?);
1077         $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
1078         $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
1079
1080         if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1081             $msg = q(
1082 Since you've chosen to configure PazPar2, you must
1083 specify the host and port(s) that PazPar2
1084 uses:
1085 );
1086             $msg = q(
1087 Zebra bibliographic server host?);
1088             $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
1089
1090             $msg = q(
1091 Zebra bibliographic port for PazPar2 to use?);
1092             $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
1093
1094             $msg = q(
1095 PazPar2 host?);
1096             $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
1097
1098             $msg = q(
1099 PazPar2 port?);
1100             $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
1101
1102         }
1103     }
1104   $msg = q(
1105 Use memcached and memoize to cache the results of some function calls?
1106 This provides a signficant performance improvement.
1107 You will need a Memcached server running.);
1108   $msg .= _add_valid_values_disp('USE_MEMCACHED', $valid_values);
1109   $config{'USE_MEMCACHED'} = _get_value('USE_MEMCACHED', $msg, $defaults->{'USE_MEMCACHED'}, $valid_values, $install_log_values);
1110   if ($config{'USE_MEMCACHED'} eq 'yes'){
1111       $msg = q(
1112 Since you've chosen to use caching, you must specify the memcached servers and the namespace to use:
1113 );
1114       $msg = q(
1115 Memcached server address?);
1116       $config{'MEMCACHED_SERVERS'} = _get_value('MEMCACHED_SERVERS', $msg, $defaults->{'MEMCACHED_SERVERS'}, $valid_values, $install_log_values);
1117
1118       $msg = q(
1119 Memcached namespace?);
1120       $config{'MEMCACHED_NAMESPACE'} = _get_value('MEMCACHED_NAMESPACE', $msg, $defaults->{'MEMCACHED_NAMESPACE'}, $valid_values, $install_log_values);
1121   }
1122
1123
1124
1125   $msg = q(
1126 Would you like to run the database-dependent test suite?);
1127   $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1128     $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1129
1130   if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1131       $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1132       $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1133       $msg = q(TEST DATABASE
1134
1135 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1136 testing. Please don't do this on your production database. It is not
1137 reversable.
1138
1139 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1140 database. You are better off not running this optional test suite than
1141 doing it in a database that you don't want to lose.
1142
1143 Please specify the name of the test database to be
1144 used by Koha);
1145
1146       $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1147       while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1148           $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1149           $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1150       }
1151
1152       $msg = q(
1153 Please specify the user that owns the database to be
1154 used by Koha);
1155     $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1156
1157       $msg = q(
1158 Please specify the password of the user that owns the
1159 database to be used by Koha);
1160       $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1161   }
1162
1163     print "\n\n";
1164
1165     # add version number
1166     my $version = "no_version_found";
1167     eval {
1168         require 'kohaversion.pl';
1169         $version = kohaversion();
1170     };
1171     $config{'KOHA_INSTALLED_VERSION'} = $version;
1172
1173     return %config;
1174 }
1175
1176 sub _add_valid_values_disp {
1177     my $key = shift;
1178     my $valid_values = shift;
1179
1180     my $disp = "";
1181     if (exists $valid_values->{$key}) {
1182         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1183     }
1184     return $disp;
1185 }
1186
1187 sub _get_value {
1188     my $key = shift;
1189     my $msg = shift;
1190     my $default = shift;
1191     my $valid_values = shift;
1192     my $install_log_values = shift;
1193
1194     # take value from install log if present
1195     if (exists $install_log_values{$key}) {
1196         return $install_log_values{$key};
1197     }
1198
1199     # override default value from environment
1200     if (exists $ENV{$key}) {
1201         $default = $ENV{$key};
1202         $msg .= " (default from environment)";
1203     }
1204
1205     my $val = prompt($msg, $default);
1206
1207     while (exists $valid_values->{$key} and
1208            $val ne $default and
1209            not exists $valid_values->{$key}->{$val}) {
1210         my $retry_msg = "Value '$val' is not a valid option.\n";
1211         $retry_msg .= "Please enter a value";
1212         $retry_msg .= _add_valid_values_disp($key, $valid_values);
1213         $val = prompt($retry_msg, $default);
1214     }
1215     return $val;
1216 }
1217
1218 =head2 get_target_directories
1219
1220 Creates a hash mapping from symbols for installation target
1221 directories to actual directory paths.
1222
1223 Also returns a hash indicating targets for which
1224 files need not be copied -- this is used for the 'dev'
1225 mode installation, where some files are installed in place.
1226
1227 =cut
1228
1229 sub get_target_directories {
1230     my $config = shift;
1231
1232     my $base = $config->{'INSTALL_BASE'};
1233     my $mode = $config->{'INSTALL_MODE'};
1234
1235     # get last component of install base directory
1236     # to treat as package name
1237     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
1238
1239     my @basedir = File::Spec->splitdir($directories);
1240
1241         # for Win32 we need to prepend the volume to the directory path
1242         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1243         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
1244
1245     my $package = pop @basedir;
1246
1247
1248     my %dirmap = ();
1249     my %skipdirs = ();
1250     if ($mode eq 'single') {
1251         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1252         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1253         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1254         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1255         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1256         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1257         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1258         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1259         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1260         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1261         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1262         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1263         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1264         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1265         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1266         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1267         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1268         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1269         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1270     } elsif ($mode eq 'dev') {
1271         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1272         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1273         $skipdirs{'INTRANET_CGI_DIR'} = 1;
1274         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1275         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
1276         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1277         $skipdirs{'INTRANET_WWW_DIR'} = 1;
1278         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1279         $skipdirs{'OPAC_CGI_DIR'} = 1;
1280         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1281         $skipdirs{'OPAC_TMPL_DIR'} = 1;
1282         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1283         $skipdirs{'OPAC_WWW_DIR'} = 1;
1284         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1285         $skipdirs{'PERL_MODULE_DIR'} = 1;
1286         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1287         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
1288         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1289         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1290         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1291         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1292         $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
1293         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1294         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1295         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1296         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
1297         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
1298         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
1299     } else {
1300         # mode is standard, i.e., 'fhs'
1301         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
1302         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
1303         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
1304         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
1305         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
1306         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
1307         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1308         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1309         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
1310         $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1311         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
1312         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
1313         $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1314         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1315         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1316         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1317         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1318         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
1319         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
1320     }
1321
1322     _get_env_overrides(\%dirmap);
1323     _get_argv_overrides(\%dirmap);
1324     _add_destdir(\%dirmap) unless ($^O eq 'MSWin32');
1325
1326     return \%dirmap, \%skipdirs;
1327 }
1328
1329 =head2 get_test_dir
1330
1331 Map a directory target to the corresponding path for
1332 the test suite.
1333
1334 =cut
1335
1336 sub get_test_dir {
1337     my ($dirname) = @_;
1338
1339     my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1340     if (exists $test_suite_override_dirs{$dirname}) {
1341         return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1342     } else {
1343         return;
1344     }
1345
1346 }
1347
1348 sub _get_env_overrides {
1349     my $dirmap = shift;
1350
1351     foreach my $key (keys %$dirmap) {
1352         if (exists $ENV{$key}) {
1353             $dirmap->{$key} = $ENV{$key};
1354             print "Setting $key from environment\n";
1355         }
1356     }
1357 }
1358
1359 sub _get_argv_overrides {
1360     my $dirmap = shift;
1361
1362     my @new_argv = ();
1363     for (my $i = 0; $i <= $#ARGV; $i++) {
1364         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1365             $dirmap->{$1} = $2;
1366         } else {
1367             push @new_argv, $ARGV[$i];
1368         }
1369     }
1370     @ARGV = @new_argv;
1371 }
1372
1373 sub _strip_destdir {
1374     my $dir = shift;
1375     $dir =~ s/^\$\(DESTDIR\)//;
1376     return $dir;
1377 }
1378
1379 sub _add_destdir {
1380     my $dirmap = shift;
1381
1382     foreach my $key (keys %$dirmap) {
1383         $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1384     }
1385 }
1386
1387 sub display_configuration {
1388     my $config = shift;
1389     my $dirmap = shift;
1390     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1391     foreach my $key (sort keys %$config) {
1392         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1393     }
1394
1395     print "\nand in the following directories:\n\n";
1396     foreach my $key (sort keys %$dirmap) {
1397         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1398     }
1399     print "\n\nTo change any configuration setting, please run\n";
1400     print "perl Makefile.PL again.  To override one of the target\n";
1401     print "directories, you can do so on the command line like this:\n";
1402     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1403     print "You can also set different default values for parameters\n";
1404     print "or override directory locations by using environment variables.\n";
1405     print "\nFor example:\n\n";
1406     print "export DB_USER=my_koha\n";
1407     print "perl Makefile.PL\n";
1408     print "\nor\n\n";
1409     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1410     print "If installing on a Win32 platform, be sure to use:\n";
1411     print "'dmake -x MAXLINELENGTH=300000'\n\n";
1412 }
1413
1414 =head2 find_zebra
1415
1416 Attempt to find Zebra - check user's PATH and
1417 a few other directories for zebrasrv and zebraidx.
1418
1419 FIXME: doesn't handle Win32
1420
1421 =cut
1422
1423 sub find_zebra {
1424     my @search_dirs = map {
1425                             my $abs = File::Spec->rel2abs($_);
1426                             my ($toss, $directories);
1427                             ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1428                             $directories;
1429                         }  split /:/, $ENV{PATH};
1430     push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1431     my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1432     return unless @zebrasrv_dirs;
1433     # verify that directory that contains zebrasrv also contains zebraidx
1434     foreach my $dir (@zebrasrv_dirs) {
1435         return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1436     }
1437     return;
1438 }
1439
1440 package MY;
1441
1442 # This will have to be reworked in order to accommodate Win32...
1443
1444 sub test {
1445     my $self = shift;
1446     my $test = $self->SUPER::test(@_);
1447     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1448
1449     # set KOHA_CONF
1450     $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
1451     return $test;
1452 }
1453
1454 sub install {
1455     my $self = shift;
1456     my $install = "";
1457     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1458     # This means that we're completely overriding EU::MM's default
1459     # installation and uninstallation targets.
1460
1461 # If installation is on Win32, we need to do permissions different from *nix
1462     if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
1463             foreach my $key (sort keys %$target_directories) {
1464                     $install .= qq(
1465 KOHA_INST_$key = blib/$key
1466 KOHA_DEST_$key = $target_directories->{$key}
1467 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1468                 }
1469                 $install .= qq(
1470 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1471 \t\$(NOECHO) \$(NOOP)
1472 );
1473                         $install .= "install_koha ::\n";
1474                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1475                         foreach my $key (sort keys %$target_directories) {
1476                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1477                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1478                         }
1479                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1480                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1481
1482                         $install .= "\n";
1483                         $install .= "set_koha_ownership ::\n";
1484 # Do not try to change ownership if DESTDIR is set
1485                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1486                                 foreach my $key (sort keys %$target_directories) {
1487                                         $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
1488                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1489                                 }
1490                         } else {
1491                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1492                         }
1493
1494                         $install .= "\n";
1495                         $install .= "set_koha_permissions ::\n";
1496                         # This is necessary because EU::MM installs files
1497                         # as either 0444 or 0555, and we want the owner
1498                         # of Koha's files to have write permission by default.
1499                         foreach my $key (sort keys %$target_directories) {
1500                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1501                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1502                         }
1503         }
1504         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1505                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1506                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1507             foreach my $key (sort keys %$target_directories) {
1508                     $install .= qq(
1509 KOHA_INST_$key = blib/$key
1510 KOHA_DEST_$key = $target_directories->{$key}
1511 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1512                 }
1513                 $install .= qq(
1514 install :: all install_koha warn_koha_env_vars
1515 \t\$(NOECHO) \$(NOOP)
1516 );
1517                 $install .= "install_koha ::\n";
1518                 $install .= "\t\$(MOD_INSTALL) \\\n";
1519                 foreach my $key (sort keys %$target_directories) {
1520                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1521                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1522                 }
1523         }
1524         $install .= "\n";
1525
1526     $install .= "warn_koha_env_vars ::\n";
1527     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1528     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1529     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1530     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1531     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1532     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1533     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1534     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1535     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1536     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1537     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1538
1539     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1540         $install .= _update_zebra_conf_target();
1541     }
1542
1543     $install .= upgrade();
1544
1545     return $install;
1546 }
1547
1548 =head2 _update_zebra_conf_target
1549
1550 Add an installation target for updating
1551 Zebra's configuration files.
1552
1553 =cut
1554
1555 sub _update_zebra_conf_target {
1556
1557     my $target = "\nupdate_zebra_conf ::\n";
1558     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1559     $target .= "\t\t\$(KOHA_INST_ZEBRA_CONF_DIR) \$(KOHA_DEST_ZEBRA_CONF_DIR) \n";
1560     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_ZEBRA_CONF_DIR)\n" unless $^O eq "MSWin32";
1561     $target .= "\tumask 022; \$(MOD_INSTALL) \\\n";
1562     $target .= "\t\t\$(KOHA_INST_PAZPAR2_CONF_DIR) \$(KOHA_DEST_PAZPAR2_CONF_DIR) \n";
1563     $target .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_PAZPAR2_CONF_DIR)\n" unless $^O eq "MSWin32";
1564
1565     return $target;
1566 }
1567
1568 sub upgrade {
1569     my $upgrade = "";
1570
1571     my $backup_suffix;
1572     if (exists $install_log_values{'KOHA_INSTALLED_VERSION'}) {
1573         my $version = $install_log_values{'KOHA_INSTALLED_VERSION'};
1574         $version =~ s/\./_/g;
1575         $backup_suffix = "_koha_$version";
1576     } else {
1577         $backup_suffix = "_upgrade_backup";
1578     }
1579
1580     $upgrade .= qq/
1581 MOD_BACKUP = \$(ABSPERLRUN) -Minstall_misc::UpgradeBackup -e 'backup_changed_files({\@ARGV}, '$backup_suffix', '\''\$(VERBINST)'\'', '\''\$(UNINST)'\'');' --
1582
1583 upgrade :: make_upgrade_backup install
1584 \t\$(NOECHO) \$(NOOP)
1585 make_upgrade_backup ::
1586 \t\$(NOECHO) umask 022; \$(MOD_BACKUP) \\
1587 /;
1588     foreach my $key (qw/KOHA_CONF_DIR INTRANET_TMPL_DIR INTRANET_WWW_DIR OPAC_TMPL_DIR OPAC_WWW_DIR
1589                      PAZPAR2_CONF_DIR ZEBRA_CONF_DIR/) {
1590         $upgrade .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1591             unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or
1592                    exists $skip_directories->{$key} or
1593                    not exists $target_directories->{$key};
1594     }
1595     $upgrade =~ s/\\\n$/\n/;
1596
1597     return $upgrade;
1598 }
1599
1600 sub postamble {
1601     # put directory mappings into Makefile
1602     # so that Make will export as environment
1603     # variables -- this is for the use of
1604     # rewrite-confg.PL
1605
1606     # quote '$' in the two password parameters
1607     my %config = %config;
1608     $config{'DB_PASS'} =~ s/\$/\$\$/g;
1609     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1610         $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1611     }
1612
1613     my $env;
1614         # Hereagain, we must alter syntax per platform...
1615         if ( $^O eq 'MSWin32' ) {
1616                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1617                 $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1618                 $env .= "\n\n";
1619                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1620         }
1621     else {
1622                 $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1623                 $env .= "\n\n";
1624                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1625         }
1626
1627     if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1628         if ( open( my $confhandle, '>', 't/test-config.txt' ) ) {
1629             print $confhandle "# This configuration file lets the t/Makefile prepare a test koha-conf.xml file.\n";
1630             print $confhandle "# It is generated by the top-level Makefile.PL.\n";
1631             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";
1632
1633             # these directories will be relocated to the 't' directory
1634             foreach my $dirname ( keys %$target_directories ) {
1635                 my $dir = main::_strip_destdir( $target_directories->{$dirname} );
1636                 if ( exists $test_suite_override_dirs{$dirname} ) {
1637                     $dir = main::get_test_dir($dirname);
1638                 }
1639                 print $confhandle "$dirname = $dir\n"
1640             }
1641             print $confhandle "\n";
1642
1643             print $confhandle join( "\n", map { "$_ = $config{$_}" } keys( %config ) ), "\n";
1644             close( $confhandle );
1645         } else {
1646             warn 'unable to open conf file for database dependent tests: $!';
1647         }
1648
1649     }
1650     return "$env\n";
1651 }
1652
1653
1654 __END__
1655
1656
1657 =head1 SEE ALSO
1658
1659 ExtUtils::MakeMaker(3)
1660
1661 =head1 AUTHORS
1662
1663 MJ Ray mjr at phonecoop.coop
1664 Galen Charlton galen.charlton at liblime.com
1665
1666 =cut
1667 FIXME: deal with .htaccess