Makefile.PL

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