Makefile.PL

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