Makefile.PL

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