Makefile.PL

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