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