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