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