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