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