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