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/info'                 => { target => 'DOC_DIR', trimdir => 2 },
 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   'ZEBRA_MARC_FORMAT' => 'marc21',
 373   'ZEBRA_LANGUAGE'    => 'en',
 374   'ZEBRA_USER'        => 'kohauser',
 375   'ZEBRA_PASS'        => 'zebrastripes',
 376   'KOHA_USER'         => 'koha',
 377   'KOHA_GROUP'        => 'koha',
 378 );
 379
 380 # set some default configuratio options based on OS
 381 # more conditions need to be added for other OS's
 382 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
 383 # to allow for more granular decisions based on which Win32 platform
 384
 385 warn "Your platform appears to be $^O.\n" if $DEBUG;
 386
 387 if ( $^O eq 'MSWin32' ) {
 388         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
 389         # this could be changed to put some files (ie. libraries) into system32, etc.
 390         $config_defaults{'INSTALL_MODE'} = 'single';
 391         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
 392 }
 393 elsif ( $^O eq 'cygwin' ) {
 394         # Most Unix2Win32 ports seem to poke everything into the Program Files directory
 395         # this could be changed to put some files (ie. libraries) into system32, etc.
 396         $config_defaults{'INSTALL_MODE'} = 'single';
 397         $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
 398 }
 399 else {
 400         $config_defaults{'INSTALL_MODE'} = 'standard';
 401         $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
 402 }
 403
 404 # valid values for certain configuration options
 405 my %valid_config_values = (
 406   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
 407   'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
 408   'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
 409   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
 410   'ZEBRA_LANGUAGE'    => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
 411 );
 412
 413 my %config = get_configuration(\%config_defaults, \%valid_config_values);
 414 my ($target_directories, $skip_directories) = get_target_directories(\%config);
 415 display_configuration(\%config, $target_directories);
 416 my $file_map = {};
 417 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
 418
 419 my $pl_files = {
 420       'rewrite-config.PL' => [
 421          'blib/KOHA_CONF_DIR/koha-conf.xml',
 422          'blib/KOHA_CONF_DIR/koha-httpd.conf'
 423          ],
 424           'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
 425                  'blib'
 426                  ]
 427 };
 428
 429 if ($config{'INSTALL_ZEBRA'} eq "yes") {
 430     push @{ $pl_files->{'rewrite-config.PL'} }, (
 431         'blib/ZEBRA_CONF_DIR/etc/passwd',
 432         'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
 433         'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg'
 434     );
 435 }
 436
 437 if ($config{'INSTALL_MODE'} ne "dev") {
 438     push @{ $pl_files->{'rewrite-config.PL'} }, (
 439         'blib/PERL_MODULE_DIR/C4/Context.pm',
 440         'blib/SCRIPT_DIR/kohalib.pl'
 441     );
 442 }
 443
 444 WriteMakefile(
 445     NAME => 'koha',
 446     #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
 447     VERSION_FROM => 'kohaversion.pl',
 448     ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
 449     AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
 450     NO_META => 1,
 451     PREREQ_PM => {
 452 # awaiting package maintainer's use of $VERSION
 453 #'Algorithm::CheckDigits' => 0.48,
 454 #'Algorithm::CheckDigits::M43_001' => 0.48,
 455 'Biblio::EndnoteStyle' => 0.05,
 456 'CGI' => 3.15,
 457 'CGI::Carp' => 1.29,
 458 'CGI::Session' => '4.10',
 459 'Class::Factory::Util' => 1.6,
 460 'Class::Accessor' => 0.30,
 461 'DBD::mysql' => 3.0008,
 462 'DBI' => 1.53,
 463 'Data::ICal' => 0.13,
 464 'Data::Dumper' => 2.121_08,
 465 'Date::Calc' => 5.4,
 466 'Date::ICal' => 1.72,
 467 'Date::Manip' => 5.44,
 468 'Digest::MD5' => 2.36,
 469 'File::Temp' => 0.16,
 470 'GD::Barcode::UPCE' => 1.1,
 471 'Getopt::Long' => 2.35,
 472 'Getopt::Std' => 1.05,
 473 'HTML::Template::Pro' => 0.65,
 474 'HTTP::Cookies' => 1.39,
 475 'HTTP::Request::Common' => 1.26,
 476 'LWP::Simple' => 1.41,
 477 'LWP::UserAgent' => 2.033,
 478 'Lingua::Stem' => 0.82,
 479 'List::Util' => 1.18,
 480 'List::MoreUtils' => 0.21,
 481 'Locale::Language' => 2.07,
 482 'MARC::Charset' => 0.98,
 483 'MARC::Crosswalk::DublinCore' => 0.02,
 484 'MARC::File::XML' => 0.88,
 485 'MARC::Record' => 2.00,
 486 'MIME::Base64' => 3.07,
 487 'MIME::QuotedPrint' => 3.07,
 488 'Mail::Sendmail' => 0.79,
 489 'Net::LDAP' => 0.34,
 490 'Net::LDAP::Filter' => 0.15,
 491 'Net::Z3950::ZOOM' => 1.16,
 492 'PDF::API2' => 2.000,
 493 'PDF::API2::Page' => 2.000,
 494 'PDF::API2::Util' => 2.000,
 495 'PDF::Reuse' => 0.33,
 496 'PDF::Reuse::Barcode' => 0.05,
 497 'POE' => 0.9999,
 498 'POSIX' => 1.09,
 499 'Schedule::At' => 1.06,
 500 'Term::ANSIColor' => 1.10,
 501 'Test' => 1.25,
 502 'Test::Harness' => 2.56,
 503 'Test::More' => 0.62,
 504 'Text::CSV' => 0.01,
 505 'Text::CSV_XS' => 0.32,
 506 'Text::Wrap' => 2005.082401,
 507 'Time::HiRes' => 1.86,
 508 'Time::localtime' => 1.02,
 509 'Unicode::Normalize' => 0.32,
 510 'XML::Dumper' => 0.81,
 511 'XML::LibXML' => 1.59,
 512 'XML::LibXSLT' => 1.59,
 513 'XML::SAX::ParserFactory' => 1.01,
 514 'XML::Simple' => 2.14,
 515 'XML::RSS' => 1.31,
 516         },
 517
 518         # File tree mapping
 519         PM => $file_map,
 520
 521     # Man pages generated from POD
 522     INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
 523     INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
 524
 525     PL_FILES => $pl_files,
 526
 527 );
 528
 529 =head1 FUNCTIONS
 530
 531 =head2 hashdir
 532
 533 This function recurses through the directory structure and builds
 534 a hash of hashes containing the structure with arrays holding filenames.
 535 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 536
 537 =cut
 538
 539 sub hashdir{
 540     my $dir = shift;
 541     opendir my $dh, $dir or die $!;
 542     my $tree = {}->{$dir} = {};
 543     while( my $file = readdir($dh) ) {
 544         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 545         my $path = $dir .'/' . $file;
 546         $tree->{$file} = hashdir($path), next if -d $path;
 547         push @{$tree->{'.'}}, $file;
 548     }
 549     return $tree;
 550 }
 551
 552 =head2 get_file_map
 553
 554 This function combines the target_map and file hash to
 555 map each source file to its destination relative to
 556 the set of installation targets.
 557
 558 Output will be a hash mapping from each source file
 559 to its destination value, like this:
 560
 561 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 562
 563 =cut
 564
 565 sub get_file_map {
 566     my $target_map = shift;
 567     my $dirtree = shift;
 568     my $file_map = shift;
 569     my $install_zebra = shift;
 570     my $curr_path = @_ ? shift : ['.'];
 571
 572     # Traverse the directory tree.
 573     # For each file or directory, identify the
 574     # most specific match in the target_map
 575     foreach my $dir (sort keys %{ $dirtree }) {
 576         if ($dir eq '.') {
 577             # deal with files in directory
 578             foreach my $file (sort @{ $dirtree->{$dir} }) {
 579                 my $targetdir = undef;
 580                 my $matchlevel = undef;
 581                 # first, see if there is a match on this specific
 582                 # file in the target map
 583                 my $filepath = join("/", @$curr_path, $file);
 584                 if (exists $target_map->{$filepath}) {
 585                     $targetdir = $target_map->{$filepath};
 586                     $matchlevel = scalar(@$curr_path) + 1;
 587                 } else {
 588                     # no match on the specific file; look for
 589                     # a directory match
 590                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 591                         my $dirpath = join("/", @$curr_path[0..$i]);
 592                         if (exists $target_map->{$dirpath}) {
 593                             $targetdir = $target_map->{$dirpath};
 594                             $matchlevel = $i + 1;
 595                             last;
 596                         }
 597                     }
 598                 }
 599                 if (defined $targetdir) {
 600                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
 601                 } else {
 602                     my $path = join("/", @$curr_path);
 603                     print "failed to map: $path/$file\n" if $DEBUG;
 604                 }
 605             }
 606         } else {
 607             # dealing with subdirectory
 608             push @$curr_path, $dir;
 609             get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
 610             pop @$curr_path;
 611         }
 612     }
 613 }
 614
 615 sub _add_to_file_map {
 616     my $file_map = shift;
 617     my $targetdir = shift;
 618     my $curr_path = shift;
 619     my $file = shift;
 620     my $matchlevel = shift;
 621     my $install_zebra = shift;
 622     my $dest_path = @_ ? shift : $curr_path;
 623
 624     # The target can be one of the following:
 625     # 1. scalar representing target symbol
 626     # 2. hash ref containing target and trimdir keys
 627     #
 628     # Consequently, this routine traverses this structure,
 629     # calling itself recursively, until it deals with
 630     # all of the scalar target symbols.
 631     if (ref $targetdir eq 'HASH') {
 632         my $subtarget = $targetdir->{target};
 633         if (exists $targetdir->{trimdir}) {
 634             # if we get here, we've specified that
 635             # rather than installing the file to
 636             # $(TARGET)/matching/dirs/subdirs/file,
 637             # we want to install it to
 638             # $(TARGET)/subdirs/file
 639             #
 640             # Note that this the only place where
 641             # $matchlevel is used.
 642             my @new_dest_path = @$dest_path;
 643             if ($targetdir->{trimdir} == -1)  {
 644                 splice @new_dest_path, 0, $matchlevel;
 645             } else {
 646                 splice @new_dest_path, 0, $targetdir->{trimdir};
 647             }
 648             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
 649         } else {
 650             # actually getting here means that the
 651             # target was unnecessarily listed
 652             # as a hash, but we'll forgive that
 653             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
 654         }
 655     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 656         my $source = File::Spec->catfile(@$curr_path, $file);
 657         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 658         #print "$source => $destination\n"; # DEBUG
 659         # quote spaces in file names
 660         # FIXME: this is of questionable portability and
 661         # probably depends on user's make recognizing this
 662         # quoting syntax -- probably better to remove
 663         # spaces and shell metacharacters from all file names
 664         $source =~ s/ /\\ /g;
 665         $destination =~ s/ /\\ /g;
 666
 667         $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
 668     }
 669 }
 670
 671 =head2 get_configuration_options
 672
 673 This prompts the user for various configuration options.
 674
 675 =cut
 676
 677 sub get_configuration {
 678   my $defaults = shift;
 679   my $valid_values = shift;
 680   my %config = ();
 681
 682   my $msg = q(
 683 By default, Koha can be installed in one of three ways:
 684
 685 standard: Install files in conformance with the Filesystem
 686           Hierarchy Standard (FHS).  This is the default mode
 687           and should be used when installing a production
 688           Koha system.  On Unix systems, root access is
 689           needed to complete a standard installation.
 690
 691 single:   Install files under a single directory.  This option
 692           is useful for installing Koha without root access, e.g.,
 693           on a web host that allows CGI scripts and MySQL databases
 694           but requires the user to keep all files under the user's
 695           HOME directory.
 696
 697 dev:      Create a set of symbolic links and configuration files to
 698           allow Koha to run directly from the source distribution.
 699           This mode is useful for developers who want to run
 700           Koha from a git clone.
 701
 702 Installation mode);
 703     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 704     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values);
 705
 706     # set message and default value for INSTALL_BASE
 707     # depending on value of INSTALL_MODE
 708     my $install_base_default = $defaults->{'INSTALL_BASE'};
 709     if ($config{'INSTALL_MODE'} eq 'dev') {
 710         $msg = q(
 711 Please specify the directory in which to install Koha's
 712 active configuration files and (if applicable) the
 713 Zebra database.  Koha's CGI scripts and templates will
 714 be run from the current directory.
 715
 716 Configuration directory:);
 717         # FIXME - home directory portability consideration apply
 718         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
 719     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 720         $msg = "\nPlease specify the directory in which to install Koha";
 721         # FIXME -- we're assuming under a 'single' mode install
 722         # that user will likely want to install under the home
 723         # directory.  This is OK in and of itself, but we should
 724         # use File::HomeDir to locate the home directory portably.
 725         # This is deferred for now because File::HomeDir is not yet
 726         # core.
 727                 # --we must also keep this portable to the major OS's -fbcit
 728         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
 729     } else {
 730         # must be standard
 731         $msg = q(
 732 Please specify the directory under which most Koha files
 733 will be installed.
 734
 735 Note that if you are planning in installing more than
 736 one instance of Koha, you may want to modify the last
 737 component of the directory path, which will be used
 738 as the package name in the FHS layout.
 739
 740 Base installation directory);
 741     }
 742     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values);
 743
 744     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 745         print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
 746     if ($config{'INSTALL_MODE'} eq "standard") {
 747         $msg = q(
 748 Since you are using the 'standard' install
 749 mode, you should run 'make install' as root.
 750 However, it is recommended that a non-root
 751 user (on Unix and Linux platforms) have
 752 ownership of Koha's files, including the
 753 Zebra indexes if applicable.
 754
 755 Please specify a user account.  This
 756 user account does not need to exist
 757 right now, but it needs to exist
 758 before you run 'make install'.  Please
 759 note that for security reasons, this
 760 user should not be the same as the user
 761 account Apache runs under.
 762
 763 User account);
 764         $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values);
 765
 766         $msg = q(
 767 Please specify the group that should own
 768 Koha's files.  As above, this group need
 769 not exist right now, but should be created
 770 before you run 'make install'.
 771
 772 Group);
 773         $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values);
 774     }
 775
 776     $msg = q(
 777 Please specify which database engine you will use
 778 to store data in Koha.  The choices are MySQL and
 779 PostgreSQL; please note that at the moment
 780 PostgreSQL support is highly experimental.
 781
 782 DBMS to use);
 783     $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
 784     $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values);
 785
 786     $msg = q(
 787 Please specify the name or address of your
 788 database server.  Note that the database
 789 does not have to exist at this point, it
 790 can be created after running 'make install'
 791 and before you try using Koha for the first time.
 792
 793 Database server);
 794     $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values);
 795
 796     $msg = q(
 797 Please specify the port used to connect to the
 798 DMBS);
 799     my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
 800     $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values);
 801
 802     $msg = q(
 803 Please specify the name of the database to be
 804 used by Koha);
 805     $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values);
 806
 807     $msg = q(
 808 Please specify the user that owns the database to be
 809 used by Koha);
 810     $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values);
 811
 812     $msg = q(
 813 Please specify the password of the user that owns the
 814 database to be used by Koha);
 815     $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values);
 816
 817     $msg = q(
 818 Koha can use the Zebra search engine for high-performance
 819 searching of bibliographic and authority records.  If you
 820 have installed the Zebra software and would like to use it,
 821 please answer 'yes' to the following question.  Otherwise,
 822 Koha will default to using its internal search engine.
 823
 824 Please note that if you choose *NOT* to install Zebra,
 825 koha-conf.xml will still contain some references to Zebra
 826 settings.  Those references will be ignored by Koha.
 827
 828 Install the Zebra configuration files?);
 829     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
 830     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values);
 831
 832     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
 833         $msg = q(
 834 Since you've chosen to use Zebra with Koha,
 835 you must specify the primary MARC format of the
 836 records to be indexed by Zebra.
 837
 838 Koha provides Zebra configuration files for MARC 21
 839 and UNIMARC.
 840
 841 MARC format for Zebra indexing);
 842         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
 843         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values);
 844         $msg = q(
 845 Koha supplies Zebra configuration files tuned for
 846 searching either English (en) or French (fr) MARC
 847 records.
 848
 849 Primary language for Zebra indexing);
 850         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
 851         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values);
 852
 853         $msg = q(
 854 Please specify Zebra database user);
 855         $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values);
 856
 857         $msg = q(
 858 Please specify the Zebra database password);
 859         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values);
 860
 861     }
 862
 863     print "\n\n";
 864     return %config;
 865 }
 866
 867 sub _add_valid_values_disp {
 868     my $key = shift;
 869     my $valid_values = shift;
 870
 871     my $disp = "";
 872     if (exists $valid_values->{$key}) {
 873         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
 874     }
 875     return $disp;
 876 }
 877
 878 sub _get_value {
 879     my $key = shift;
 880     my $msg = shift;
 881     my $default = shift;
 882     my $valid_values = shift;
 883
 884     # override default value from environment
 885     if (exists $ENV{$key}) {
 886         $default = $ENV{$key};
 887         $msg .= " (default from environment)";
 888     }
 889
 890     my $val = prompt($msg, $default);
 891
 892     while (exists $valid_values->{$key} and
 893            $val ne $default and
 894            not exists $valid_values->{$key}->{$val}) {
 895         my $retry_msg = "Value '$val' is not a valid option.\n";
 896         $retry_msg .= "Please enter a value";
 897         $retry_msg .= _add_valid_values_disp($key, $valid_values);
 898         $val = prompt($retry_msg, $default);
 899     }
 900     return $val;
 901 }
 902
 903 =head2 get_target_directories
 904
 905 Creates a hash mapping from symbols for installation target
 906 directories to actual directory paths.
 907
 908 Also returns a hash indicating targets for which
 909 files need not be copied -- this is used for the 'dev'
 910 mode installation, where some files are installed in place.
 911
 912 =cut
 913
 914 sub get_target_directories {
 915     my $config = shift;
 916
 917     my $base = $config->{'INSTALL_BASE'};
 918     my $mode = $config->{'INSTALL_MODE'};
 919
 920     # get last component of install base directory
 921     # to treat as package name
 922     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
 923
 924     my @basedir = File::Spec->splitdir($directories);
 925
 926         # for Win32 we need to prepend the volume to the directory path
 927         if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
 928         elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
 929
 930     my $package = pop @basedir;
 931
 932
 933     my %dirmap = ();
 934     my %skipdirs = ();
 935     if ($mode eq 'single') {
 936         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
 937         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
 938         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
 939         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
 940         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
 941         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
 942         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
 943         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
 944         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
 945         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
 946         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 947         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 948         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 949         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
 950         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
 951         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
 952         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
 953     } elsif ($mode eq 'dev') {
 954         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
 955         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
 956         $skipdirs{'INTRANET_CGI_DIR'} = 1;
 957         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
 958         $skipdirs{'INTRANET_TMPL_DIR'} = 1;
 959         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
 960         $skipdirs{'INTRANET_WWW_DIR'} = 1;
 961         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
 962         $skipdirs{'OPAC_CGI_DIR'} = 1;
 963         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
 964         $skipdirs{'OPAC_TMPL_DIR'} = 1;
 965         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
 966         $skipdirs{'OPAC_WWW_DIR'} = 1;
 967         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
 968         $skipdirs{'PERL_MODULE_DIR'} = 1;
 969         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
 970         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
 971         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
 972         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 973         $skipdirs{'SCRIPT_DIR'} = 1;
 974         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 975         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 976         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
 977         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
 978         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
 979         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
 980     } else {
 981         # mode is standard, i.e., 'fhs'
 982         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
 983         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
 984         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
 985         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
 986         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
 987         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
 988         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
 989         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
 990         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
 991         $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
 992         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 993         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 994         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 995         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
 996         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
 997         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
 998         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
 999     }
1000
1001     _get_env_overrides(\%dirmap);
1002     _get_argv_overrides(\%dirmap);
1003
1004     return \%dirmap, \%skipdirs;
1005 }
1006
1007 sub _get_env_overrides {
1008     my $dirmap = shift;
1009
1010     foreach my $key (keys %$dirmap) {
1011         if (exists $ENV{$key}) {
1012             $dirmap->{$key} = $ENV{$key};
1013             print "Setting $key from environment\n";
1014         }
1015     }
1016 }
1017
1018 sub _get_argv_overrides {
1019     my $dirmap = shift;
1020
1021     my @new_argv = ();
1022     for (my $i = 0; $i <= $#ARGV; $i++) {
1023         if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1024             $dirmap->{$1} = $2;
1025         } else {
1026             push @new_argv, $ARGV[$i];
1027         }
1028     }
1029     @ARGV = @new_argv;
1030 }
1031
1032 sub display_configuration {
1033     my $config = shift;
1034     my $dirmap = shift;
1035     print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1036     foreach my $key (sort keys %$config) {
1037         print sprintf("%-25.25s%s\n", $key, $config->{$key});
1038     }
1039
1040     print "\nand in the following directories:\n\n";
1041     foreach my $key (sort keys %$dirmap) {
1042         print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1043     }
1044     print "\n\nTo change any configuration setting, please run\n";
1045     print "perl Makefile.PL again.  To override one of the target\n";
1046     print "directories, you can do so on the command line like this:\n";
1047     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
1048     print "You can also set different default values for parameters\n";
1049     print "or override directory locations by using environment variables.\n";
1050     print "\nFor example:\n\n";
1051     print "export DB_USER=my_koha\n";
1052     print "perl Makefile.PL\n";
1053     print "\nor\n\n";
1054     print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
1055 }
1056
1057 package MY;
1058
1059 # This will have to be reworked in order to accommodate Win32...
1060
1061 sub test {
1062     my $self = shift;
1063     my $test = $self->SUPER::test(@_);
1064     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
1065     return $test;
1066 }
1067
1068 sub install {
1069     my $self = shift;
1070     my $install = "";
1071     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1072     # This means that we're completely overriding EU::MM's default
1073     # installation and uninstallation targets.
1074
1075 # If installation is on Win32, we need to do permissions different from *nix
1076     if ( $^O =~ /darwin|linux|cygwin/ ) { # this value needs to be verified for each platform and modified accordingly
1077             foreach my $key (sort keys %$target_directories) {
1078                     $install .= qq(
1079 KOHA_INST_$key = blib/$key
1080 KOHA_DEST_$key = $target_directories->{$key}
1081 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1082                 }
1083                 $install .= qq(
1084 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
1085 \t\$(NOECHO) \$(NOOP)
1086 );
1087                         $install .= "install_koha ::\n";
1088                         $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1089                         foreach my $key (sort keys %$target_directories) {
1090                                 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1091                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1092                         }
1093                         $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1094                         $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1095
1096                         $install .= "\n";
1097                         $install .= "set_koha_ownership ::\n";
1098                         if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1099                                 foreach my $key (sort keys %$target_directories) {
1100                                         $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
1101                                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1102                                 }
1103                         } else {
1104                                 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1105                         }
1106
1107                         $install .= "\n";
1108                         $install .= "set_koha_permissions ::\n";
1109                         # This is necessary because EU::MM installs files
1110                         # as either 0444 or 0555, and we want the owner
1111                         # of Koha's files to have write permission by default.
1112                         foreach my $key (sort keys %$target_directories) {
1113                                 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1114                                         unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1115                         }
1116         }
1117         elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
1118                                                                 # We can attempt some creative things with command line utils such as CACLS which allows permission
1119                                                                 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1120             foreach my $key (sort keys %$target_directories) {
1121                     $install .= qq(
1122 KOHA_INST_$key = blib/$key
1123 KOHA_DEST_$key = $target_directories->{$key}
1124 )                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1125                 }
1126                 $install .= qq(
1127 install :: all install_koha warn_koha_env_vars
1128 \t\$(NOECHO) \$(NOOP)
1129 );
1130                 $install .= "install_koha ::\n";
1131                 $install .= "\t\$(MOD_INSTALL) \\\n";
1132                 foreach my $key (sort keys %$target_directories) {
1133                         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1134                                 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1135                 }
1136         }
1137         $install .= "\n";
1138
1139     $install .= "warn_koha_env_vars ::\n";
1140     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1141     $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1142     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1143     $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1144     $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1145     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1146     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1147     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1148     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1149     $install .= "\t\$(NOECHO) \$(ECHO) If installing on a Win32 platform, be sure to use:\n";
1150     $install .= "\t\$(NOECHO) \$(ECHO) 'dmake -x MAXLINELENGTH=300000'\n";
1151     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1152     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1153     $install .= "\t\$(NOECHO) \$(ECHO)\n";
1154
1155     return $install;
1156 }
1157
1158 sub postamble {
1159     # put directory mappings into Makefile
1160     # so that Make will export as environment
1161     # variables -- this is for the use of
1162     # rewrite-confg.PL
1163
1164     # quote '$' in the two password parameters
1165     my %config = %config;
1166     $config{'DB_PASS'} =~ s/\$/\$\$/g;
1167     if ($config{'INSTALL_ZEBRA'} eq "yes") {
1168         $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
1169     }
1170
1171         # Hereagain, we must alter syntax per platform...
1172         if ( $^O eq 'MSWin32' ) {
1173                 # NOTE: it is imperative that there be no whitespaces in ENV=value...
1174                 my $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories);
1175                 $env .= "\n\n";
1176                 $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
1177                 return "$env\n";
1178         }
1179     else {
1180                 my $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories);
1181                 $env .= "\n\n";
1182                 $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
1183                 return "$env\n";
1184         }
1185 }
1186
1187
1188 __END__
1189
1190
1191 =head1 SEE ALSO
1192
1193 ExtUtils::MakeMaker(3)
1194
1195 =head1 AUTHORS
1196
1197 MJ Ray mjr at phonecoop.coop
1198 Galen Charlton galen.charlton at liblime.com
1199
1200 =cut
1201 FIXME: deal with .htaccess