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