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