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 EXAMPLE_DIR
 182
 183 Directory for example configuration files.  This directory
 184 exists primarily to make it easier to change the
 185 MARC format or language of the active Zebra
 186 indexes.
 187
 188 =item SCRIPT_DIR
 189
 190 Directory for command-line scripts and daemons.
 191
 192 =item MAN_DIR
 193
 194 Directory for man pages created from POD -- will mostly
 195 contain information of interest to Koha developers.
 196
 197 =item DOC_DIR
 198
 199 Directory for Koha documentation accessed from the
 200 command-line, e.g., READMEs.
 201
 202 =item LOG_DIR
 203
 204 Directory for Apache and Zebra logs produced by Koha.
 205
 206 =item NONE
 207
 208 This is a dummy target used to explicitly state
 209 that a given file or directory is not to be installed.
 210 This is used either for parts of the installer itself
 211 or for development tools that are not applicable to a
 212 production installation.
 213
 214 =back
 215
 216 =cut
 217
 218 my $target_map = {
 219   './about.pl'                  => 'INTRANET_CGI_DIR',
 220   './acqui'                     => 'INTRANET_CGI_DIR',
 221   './admin'                     => 'INTRANET_CGI_DIR',
 222   './authorities'               => 'INTRANET_CGI_DIR',
 223   './C4'                        => 'PERL_MODULE_DIR',
 224   './C4/SIP/t'                  => 'NONE',
 225   './C4/SIP/koha_test'          => 'NONE',
 226   './C4/tests'                  => 'NONE',
 227   './catalogue'                 => 'INTRANET_CGI_DIR',
 228   './cataloguing'               => 'INTRANET_CGI_DIR',
 229   './changelanguage.pl'         => 'INTRANET_CGI_DIR',
 230   './check_sysprefs.pl'         => 'NONE',
 231   './circ'                      => 'INTRANET_CGI_DIR',
 232   './edithelp.pl'               => 'INTRANET_CGI_DIR',
 233   './etc'                       => { target => 'KOHA_CONF_DIR', trimdir => -1 },
 234   './etc/zebradb'               => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
 235   './help.pl'                   => 'NONE', # FIXME
 236   './installer-CPAN.pl'         => 'NONE',
 237   './installer'                 => 'INTRANET_CGI_DIR',
 238   './koha-tmpl/errors'          => {target => 'INTRANET_CGI_DIR', trimdir => 2},
 239   './koha-tmpl/intranet-tmpl'   => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
 240   './koha-tmpl/opac-tmpl'       => {target => 'OPAC_TMPL_DIR', trimdir => -1},
 241   './kohaversion.pl'            => 'INTRANET_CGI_DIR', # FIXME this may need to be in OPAC_CGI_DIR as well, with an update to C4::Context
 242   './labels'                    => 'INTRANET_CGI_DIR',
 243   './mainpage.pl'               => 'INTRANET_CGI_DIR',
 244   './Makefile.PL'               => 'NONE',
 245   './MANIFEST.SKIP'             => 'NONE',
 246   './members'                   => 'INTRANET_CGI_DIR',
 247   './misc'                      => { target => 'SCRIPT_DIR', trimdir => -1 },
 248   './misc/info'                 => { target => 'DOC_DIR', trimdir => 2 },
 249   './misc/release notes'        => { target => 'DOC_DIR', trimdir => 2 },
 250   './misc/translator'           => { target => 'EXAMPLE_DIR', trimdir => 2 },
 251   './misc/installer_devel_notes' => 'NONE',
 252   './opac'                      => 'OPAC_CGI_DIR',
 253   './README.txt'                => 'NONE',
 254   './reports'                   => 'INTRANET_CGI_DIR',
 255   './reserve'                   => 'INTRANET_CGI_DIR',
 256   './reviews'                   => 'INTRANET_CGI_DIR',
 257   './rewrite-config.PL'         => 'NONE',
 258   './reviews'                   => 'INTRANET_CGI_DIR',
 259   './rss'                       => 'NONE', # FIXME deal with a little later
 260   './serials'                   => 'INTRANET_CGI_DIR',
 261   './sms'                       => 'INTRANET_CGI_DIR',
 262   './suggestion'                => 'INTRANET_CGI_DIR',
 263   './svc'                       => 'INTRANET_CGI_DIR',
 264   './t'                         => 'NONE',
 265   './tmp'                       => 'NONE', # FIXME deal with later
 266   './tools'                     => 'INTRANET_CGI_DIR',
 267   './virtualshelves'            => 'INTRANET_CGI_DIR',
 268   # ignore files and directories created by the install itself
 269   './pm_to_blib'                => 'NONE',
 270   './blib'                      => 'NONE',
 271 };
 272
 273 =head1 CONFIGURATION OPTIONS
 274
 275 The following configuration options are used by the installer.
 276
 277 =over 4
 278
 279 =item INSTALL_MODE
 280
 281 Specifies whether installation will be FHS-compliant (default,
 282 assumes user has root), put everything under
 283 a single directory (for users installing on a web host
 284 that allows CGI scripts and a MySQL database but not root
 285 access), or development (for a developer who wants to run
 286 Koha from a git clone with no fuss).
 287
 288 =item INSTALL_BASE
 289
 290 Directory under which most components will go.  Default
 291 value will vary depending on INSTALL_MODE.
 292
 293 =item INSTALL_ZEBRA
 294
 295 Whether to install Zebra configuration files and data
 296 directories.
 297
 298 =item ZEBRA_MARC_FORMAT
 299
 300 Specifies format of MARC records to be indexed by Zebra.
 301
 302 =item ZEBRA_LANGUAGE
 303
 304 Specifies primary language of records that will be
 305 indexed by Zebra.
 306
 307 =back
 308
 309 =cut
 310
 311 # default configuration options
 312 my %config_defaults = (
 313   'INSTALL_MODE'      => 'standard',
 314   'INSTALL_BASE'      => '/usr/share/koha',
 315   'INSTALL_ZEBRA'     => 'yes',
 316   'ZEBRA_MARC_FORMAT' => 'marc21',
 317   'ZEBRA_LANGUAGE'    => 'en',
 318 );
 319
 320 # valid values for certain configuration options
 321 my %valid_config_values = (
 322   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
 323   'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
 324   'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
 325   'ZEBRA_LANGUAGE'    => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
 326 );
 327
 328 my %config = get_configuration(\%config_defaults, \%valid_config_values);
 329 my %target_directories = get_target_directories(\%config);
 330 my $file_map = {};
 331 get_file_map($target_map, $dirtree, $file_map);
 332
 333 WriteMakefile(
 334     NAME => 'koha',
 335     #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
 336     VERSION_FROM => 'C4/Context.pm',
 337     ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
 338     AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
 339     NO_META => 1,
 340     PREREQ_PM => {
 341 'CGI' => 3.15,
 342 'CGI::Carp' => 1.29,
 343 'CGI::Session' => '4.10',
 344 'Class::Factory::Util' => 1.7,
 345 'Class::Accessor' => 0.30,
 346 'DBD::mysql' => 3.0008,
 347 'DBI' => 1.53,
 348 'Data::Dumper' => 2.121_08,
 349 'Date::Calc' => 5.4,
 350 'Date::Manip' => 5.44,
 351 'Digest::MD5' => 2.36,
 352 'File::Temp' => 0.16,
 353 'GD::Barcode::UPCE' => 1.1,
 354 'Getopt::Long' => 2.35,
 355 'Getopt::Std' => 1.05,
 356 'HTML::Template::Pro' => 0.65,
 357 'HTTP::Cookies' => 1.39,
 358 'HTTP::Request::Common' => 1.26,
 359 'LWP::Simple' => 1.41,
 360 'LWP::UserAgent' => 2.033,
 361 'Lingua::Stem' => 0.82,
 362 'List::Util' => 1.18,
 363 'Locale::Language' => 2.07,
 364 'MARC::Charset' => 0.98,
 365 'MARC::Crosswalk::DublinCore' => 0.03,
 366 'MARC::File::XML' => 0.88,
 367 'MARC::Record' => 2.00,
 368 'MIME::Base64' => 3.07,
 369 'MIME::QuotedPrint' => 3.07,
 370 'Mail::Sendmail' => 0.79,
 371 'PDF::API2' => 2.000,
 372 'PDF::API2::Page' => 2.000,
 373 'PDF::API2::Util' => 2.000,
 374 'PDF::Reuse' => 0.33,
 375 'PDF::Reuse::Barcode' => 0.05,
 376 'POSIX' => 1.09,
 377 'Schedule::At' => 1.06,
 378 'Term::ANSIColor' => 1.10,
 379 'Test' => 1.25,
 380 'Test::Harness' => 2.56,
 381 'Test::More' => 0.62,
 382 'Text::CSV' => 0.01,
 383 'Text::CSV_XS' => 0.32,
 384 'Text::Wrap' => 2005.082401,
 385 'Time::HiRes' => 1.86,
 386 'Time::localtime' => 1.02,
 387 'Unicode::Normalize' => 0.32,
 388 'XML::Dumper' => 0.81,
 389 'XML::LibXML' => 1.59,
 390 'XML::SAX::ParserFactory' => 1.01,
 391 'XML::Simple' => 2.14,
 392 'XML::RSS' => 1.31,
 393 'ZOOM' => 1.16,
 394         },
 395
 396         # File tree mapping
 397         PM => $file_map,
 398
 399     # Man pages generated from POD
 400     INSTALLMAN1DIR => File::Spec->catdir($target_directories{'MAN_DIR'}, 'man1'),
 401     INSTALLMAN3DIR => File::Spec->catdir($target_directories{'MAN_DIR'}, 'man3'),
 402
 403 #   CONFIGURE => sub {
 404 #     # Ask for options with prompt($question,$default) calls here?
 405 #     return { macro => { 'export TEST' => '755' } }
 406 #     },
 407
 408    PL_FILES => { # generator => target(s)
 409       'rewrite-config.PL' => [
 410          'blib/KOHA_CONF_DIR/koha-conf.xml',
 411          'blib/KOHA_CONF_DIR/koha-httpd.conf',
 412          'blib/ZEBRA_CONF_DIR/etc/passwd',
 413          'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
 414          'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg'
 415          ]
 416    }
 417 #     'opac/getfromintranet.PL' => ['$(INST_LIBDIR)/opac/cgi-bin/detail.pl','$(INST_LIBDIR)/opac/cgi-bin/moredetail.pl','$(INST_LIBDIR)/opac/cgi-bin/search.pl','$(INST_LIBDIR)/opac/cgi-bin/subjectsearch.pl','$(INST_LIBDIR)/opac/cgi-bin/logout.pl'],
 418 #     'misc/koha.conf.PL' => '$(INST_LIBDIR)/../etc/koha.conf',
 419 #     'misc/apache-koha.conf.PL' => '$(INST_LIBDIR)/../etc/apache-koha.conf',
 420 #     'misc/koha.sql.PL' => '$(INST_LIBDIR)/intranet/scripts/koha.sql',
 421 #     'z3950/z3950-daemon-options.PL' => '$(INST_LIBDIR)/intranet/scripts/z3950daemon/z3950-daemon-options',
 422 #     # fake target to check permissions
 423 #     'misc/chmod.PL' => '$(INST_LIBDIR)/fake-target'
 424 #     }
 425    # need to set ownerships
 426    # need to load koha.sql
 427    # need to link koha-httpd.conf
 428    # need to start z3950-daemon
 429 );
 430
 431 =head1 FUNCTIONS
 432
 433 =head2 hashdir
 434
 435 This function recurses through the directory structure and builds
 436 a hash of hashes containing the structure with arrays holding filenames.
 437 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
 438
 439 =cut
 440
 441 sub hashdir{
 442     my $dir = shift;
 443     opendir my $dh, $dir or die $!;
 444     my $tree = {}->{$dir} = {};
 445     while( my $file = readdir($dh) ) {
 446         next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
 447         my $path = $dir .'/' . $file;
 448         $tree->{$file} = hashdir($path), next if -d $path;
 449         push @{$tree->{'.'}}, $file;
 450     }
 451     return $tree;
 452 }
 453
 454 =head2 get_file_map
 455
 456 This function combines the target_map and file hash to
 457 map each source file to its destination relative to
 458 the set of installation targets.
 459
 460 Output will be a hash mapping from each source file
 461 to its destination value, like this:
 462
 463 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
 464
 465 =cut
 466
 467 sub get_file_map {
 468     my $target_map = shift;
 469     my $dirtree = shift;
 470     my $file_map = shift;
 471     my $curr_path = @_ ? shift : ['.'];
 472
 473     # Traverse the directory tree.
 474     # For each file or directory, identify the
 475     # most specific match in the target_map
 476     foreach my $dir (sort keys %{ $dirtree }) {
 477         if ($dir eq '.') {
 478             # deal with files in directory
 479             foreach my $file (sort @{ $dirtree->{$dir} }) {
 480                 my $targetdir = undef;
 481                 my $matchlevel = undef;
 482                 # first, see if there is a match on this specific
 483                 # file in the target map
 484                 my $filepath = join("/", @$curr_path, $file);
 485                 if (exists $target_map->{$filepath}) {
 486                     $targetdir = $target_map->{$filepath};
 487                     $matchlevel = scalar(@$curr_path) + 1;
 488                 } else {
 489                     # no match on the specific file; look for
 490                     # a directory match
 491                     for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--)  {
 492                         my $dirpath = join("/", @$curr_path[0..$i]);
 493                         if (exists $target_map->{$dirpath}) {
 494                             $targetdir = $target_map->{$dirpath};
 495                             $matchlevel = $i + 1;
 496                             last;
 497                         }
 498                     }
 499                 }
 500                 if (defined $targetdir) {
 501                      _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
 502                 } else {
 503                     my $path = join("/", @$curr_path);
 504                     print "failed to map: $path/$file\n" if $DEBUG;
 505                 }
 506             }
 507         } else {
 508             # dealing with subdirectory
 509             push @$curr_path, $dir;
 510             get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
 511             pop @$curr_path;
 512         }
 513     }
 514 }
 515
 516 sub _add_to_file_map {
 517     my $file_map = shift;
 518     my $targetdir = shift;
 519     my $curr_path = shift;
 520     my $file = shift;
 521     my $matchlevel = shift;
 522     my $dest_path = @_ ? shift : $curr_path;
 523
 524     # The target can be one of the following:
 525     # 1. scalar representing target symbol
 526     # 2. hash ref containing target and trimdir keys
 527     #
 528     # Consequently, this routine traverses this structure,
 529     # calling itself recursively, until it deals with
 530     # all of the scalar target symbols.
 531     if (ref $targetdir eq 'HASH') {
 532         my $subtarget = $targetdir->{target};
 533         if (exists $targetdir->{trimdir}) {
 534             # if we get here, we've specified that
 535             # rather than installing the file to
 536             # $(TARGET)/matching/dirs/subdirs/file,
 537             # we want to install it to
 538             # $(TARGET)/subdirs/file
 539             #
 540             # Note that this the only place where
 541             # $matchlevel is used.
 542             my @new_dest_path = @$dest_path;
 543             if ($targetdir->{trimdir} == -1)  {
 544                 splice @new_dest_path, 0, $matchlevel;
 545             } else {
 546                 splice @new_dest_path, 0, $targetdir->{trimdir};
 547             }
 548             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
 549         } else {
 550             # actually getting here means that the
 551             # target was unnecessarily listed
 552             # as a hash, but we'll forgive that
 553             _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
 554         }
 555     } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
 556         my $source = File::Spec->catfile(@$curr_path, $file);
 557         my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
 558         #print "$source => $destination\n"; # DEBUG
 559         # quote spaces in file names
 560         # FIXME: this is of questionable portability and
 561         # probably depends on user's make recognizing this
 562         # quoting syntax -- probably better to remove
 563         # spaces and shell metacharacters from all file names
 564         $source =~ s/ /\\ /g;
 565         $destination =~ s/ /\\ /g;
 566
 567         $file_map->{$source} = $destination;
 568     }
 569 }
 570
 571 =head2 get_configuration_options
 572
 573 This prompts the user for various configuration options.
 574
 575 =cut
 576
 577 sub get_configuration {
 578   my $defaults = shift;
 579   my $valid_values = shift;
 580   my %config = ();
 581
 582   my $msg = q(
 583 By default, Koha can be installed in one of three ways:
 584
 585 standard: Install files in conformance with the Filesystem
 586           Hierarchy Standard (FHS).  This is the default mode
 587           and should be used when installing a production
 588           Koha system.  On Unix systems, root access is
 589           needed to complete a standard installation.
 590
 591 single:   Install files under a single directory.  This option
 592           is useful for installing Koha without root access, e.g.,
 593           on a web host that allows CGI scripts and MySQL databases
 594           but requires the user to keep all files under the user's
 595           HOME directory.
 596
 597 dev:      Create a set of symbolic links and configuration files to
 598           allow Koha to run directly from the source distribution.
 599           This mode is useful for developers who want to run
 600           Koha from a git clone.
 601
 602 Please choose the installation mode);
 603     $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
 604     $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values);
 605
 606     # set message and default value for INSTALL_BASE
 607     # depending on value of INSTALL_MODE
 608     my $install_base_default = $defaults->{'INSTALL_BASE'};
 609     if ($config{'INSTALL_MODE'} eq 'dev') {
 610         $msg = q(
 611 Please specify the directory in which to install Koha's
 612 active configuration files and (if applicable) the
 613 Zebra database.  Koha's CGI scripts and templates will
 614 be run from the current directory.);
 615         # FIXME - home directory portability consideration apply
 616         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "/usr/share/koha-dev";
 617     } elsif ($config{'INSTALL_MODE'} eq 'single') {
 618         $msg = "\nPlease specify the directory in which to install Koha";
 619         # FIXME -- we're assuming under a 'single' mode install
 620         # that user will likely want to install under the home
 621         # directory.  This is OK in and of itself, but we should
 622         # use File::HomeDir to locate the home directory portably.
 623         # This is deferred for now because File::HomeDir is not yet
 624         # core.
 625         $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : "/usr/share/koha";
 626     } else {
 627         # must be standard
 628         $msg = q(
 629 Please specify the directory under which most Koha files
 630 will be installed.
 631
 632 Note that if you are planning in installing more than
 633 one instance of Koha, you may want to modify the last
 634 component of the directory path, which will be used
 635 as the package name in the FHS layout.);
 636     }
 637     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values);
 638     $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 639
 640     $msg = q(
 641 Koha can use the Zebra search engine for high-performance
 642 searching of bibliographic and authority records.  If you
 643 have installed the Zebra software and would like to use it,
 644 please answer 'yes' to the following question.  Otherwise,
 645 Koha will default to using its internal search engine.
 646
 647 Please specify whether to install the Zebra configuration files);
 648     $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
 649     $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values);
 650
 651     if ($config{'INSTALL_ZEBRA'} eq 'yes') {
 652         $msg = q(
 653 Since you've chosen to use Zebra with Koha,
 654 you must specify the primary MARC format of the
 655 records to be indexed by Zebra.
 656
 657 Koha provides Zebra configuration files for MARC 21
 658 and UNIMARC.
 659
 660 Please specify the MARC format);
 661         $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
 662         $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values);
 663         $msg = q(
 664 Koha supplies Zebra configuration files tuned for
 665 searching either English (en) or French (fr) MARC
 666 records.
 667
 668 Please specify the primary language of the MARC records);
 669         $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
 670         $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values);
 671     }
 672     return %config;
 673 }
 674
 675 sub _add_valid_values_disp {
 676     my $key = shift;
 677     my $valid_values = shift;
 678
 679     my $disp = "";
 680     if (exists $valid_values->{$key}) {
 681         $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
 682     }
 683     return $disp;
 684 }
 685
 686 sub _get_value {
 687     my $key = shift;
 688     my $msg = shift;
 689     my $default = shift;
 690     my $valid_values = shift;
 691
 692     my $val = prompt($msg, $default);
 693     while (exists $valid_values->{$key} and not exists $valid_values->{$key}->{$val}) {
 694         my $retry_msg = "Value '$val' is not a valid option.\n";
 695         $retry_msg .= "Please enter a value";
 696         $retry_msg .= _add_valid_values_disp($key, $valid_values);
 697         $val = prompt($retry_msg, $default);
 698     }
 699     return $val;
 700 }
 701
 702 =head2 get_target_directories
 703
 704 Creates a hash mapping from symbols for installation target
 705 directories to actual directory paths.
 706
 707 =cut
 708
 709 sub get_target_directories {
 710     my $config = shift;
 711
 712     my $base = $config->{'INSTALL_BASE'};
 713     my $mode = $config->{'INSTALL_MODE'};
 714
 715     # get last component of install base directory
 716     # to treat as package name
 717     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
 718     my @basedir = File::Spec->splitdir($directories);
 719     my $package = pop @basedir;
 720
 721     my %dirmap = ();
 722     if ($mode eq 'single') {
 723         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
 724         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
 725         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
 726         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
 727         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
 728         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
 729         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
 730         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
 731         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
 732         $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
 733         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 734         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 735         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 736         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
 737         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
 738         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
 739         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
 740     } elsif ($mode eq 'dev') {
 741         my $curdir = File::Spec->rel2abs(File::Spec->curdir());
 742         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
 743         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
 744         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
 745         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir, 'opac');
 746         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
 747         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
 748         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
 749         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
 750         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
 751         $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
 752         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 753         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 754         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 755         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
 756         $dirmap{'LOG_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'log');
 757         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
 758         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
 759     } else {
 760         # mode is standard, i.e., 'fhs'
 761         $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
 762         $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
 763         $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
 764         $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
 765         $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
 766         $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
 767         $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
 768         $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
 769         $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
 770         $dirmap{'EXAMPLE_DIR'} = File::Spec->catdir(@basedir, $package, 'example');
 771         $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
 772         $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
 773         $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
 774         $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
 775         $dirmap{'LOG_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
 776         $dirmap{'ZEBRA_DATA_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
 777         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
 778     }
 779
 780     foreach my $key (sort keys %dirmap) {
 781         print sprintf("%-25.25s%s\n", $key, $dirmap{$key});
 782     }
 783     return %dirmap;
 784 }
 785
 786 package MY;
 787
 788 sub test {
 789     my $self = shift;
 790     my $test = $self->SUPER::test(@_);
 791     $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
 792     return $test;
 793 }
 794
 795 sub install {
 796     my $self = shift;
 797     my $install = "";
 798     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
 799     # This means that we're completely overriding EU::MM's default
 800     # installation and uninstallation targets.
 801     foreach my $key (sort keys %target_directories) {
 802         $install .= qq(
 803 KOHA_INST_$key = blib/$key
 804 KOHA_DEST_$key = $target_directories{$key}
 805 );
 806     }
 807
 808     $install .= qq(
 809 install :: all install_koha
 810 \t\$(NOECHO) \$(NOOP)
 811 );
 812     $install .= "install_koha ::\n";
 813     $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
 814     foreach my $key (sort keys %target_directories) {
 815         $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n";
 816     }
 817     $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
 818     $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
 819     return $install;
 820 }
 821
 822 sub postamble {
 823     # put directory mappings into Makefile
 824     # so that Make will export as environment
 825     # variables -- this is for the use of
 826     # rewrite-confg.PL
 827     my $env = join("\n", map { "export __${_}__ = $target_directories{$_}" } keys %target_directories);
 828     return "$env\n";
 829 }
 830
 831 __END__
 832
 833
 834 =head1 SEE ALSO
 835
 836 ExtUtils::MakeMaker(3)
 837
 838 =head1 AUTHORS
 839
 840 MJ Ray mjr at phonecoop.coop
 841
 842 =cut
 843 FIXME: Zebra lang/MARC mapping
 844 FIXME: deal with .htaccess