Win32 support: Switch DEBUG off and corrected warning bug.
[koha.git] / Makefile.PL
index c529ad0..7dec276 100644 (file)
@@ -363,8 +363,6 @@ System group that will own Koha's files.
 
 # default configuration options
 my %config_defaults = (
-  'INSTALL_MODE'      => 'standard',
-  'INSTALL_BASE'      => '/usr/share/koha',
   'DB_TYPE'           => 'mysql',
   'DB_HOST'           => 'localhost',
   'DB_NAME'           => 'koha',    
@@ -379,6 +377,30 @@ my %config_defaults = (
   'KOHA_GROUP'        => 'koha',
 );
 
+# set some default configuratio options based on OS
+# more conditions need to be added for other OS's
+# this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
+# to allow for more granular decisions based on which Win32 platform
+
+warn "Your platform appears to be $^O.\n" if $DEBUG;
+
+if ( $^O eq 'MSWin32' ) {
+       # Most Unix2Win32 ports seem to poke everything into the Program Files directory
+       # this could be changed to put some files (ie. libraries) into system32, etc.
+       $config_defaults{'INSTALL_MODE'} = 'single';
+       $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
+}
+elsif ( $^O eq 'cygwin' ) {
+       # Most Unix2Win32 ports seem to poke everything into the Program Files directory
+       # this could be changed to put some files (ie. libraries) into system32, etc.
+       $config_defaults{'INSTALL_MODE'} = 'single';
+       $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha';  # Use 8.3 names to be safe...
+}
+else {
+       $config_defaults{'INSTALL_MODE'} = 'standard';
+       $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
+}
+
 # valid values for certain configuration options
 my %valid_config_values = (
   'INSTALL_MODE'  => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
@@ -397,8 +419,11 @@ get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes"
 my $pl_files = {
       'rewrite-config.PL' => [
          'blib/KOHA_CONF_DIR/koha-conf.xml',
-         'blib/KOHA_CONF_DIR/koha-httpd.conf',
-         ]
+         'blib/KOHA_CONF_DIR/koha-httpd.conf'
+         ],
+         'fix-perl-path.PL' => [       # this script ensures the correct shebang line for the platform installed on...
+                'blib'
+                ]
 };
 
 if ($config{'INSTALL_ZEBRA'} eq "yes") {
@@ -411,18 +436,21 @@ if ($config{'INSTALL_ZEBRA'} eq "yes") {
 
 if ($config{'INSTALL_MODE'} ne "dev") {
     push @{ $pl_files->{'rewrite-config.PL'} }, (
-        'blib/PERL_MODULE_DIR/C4/Context.pm'
+        'blib/PERL_MODULE_DIR/C4/Context.pm',
+        'blib/SCRIPT_DIR/kohalib.pl'
     );
 }
 
 WriteMakefile(
     NAME => 'koha',
     #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
-    VERSION_FROM => 'C4/Context.pm',
+    VERSION_FROM => 'kohaversion.pl',
     ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
     AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
     NO_META => 1,
     PREREQ_PM => {
+'Algorithm::CheckDigits' => 0.48,
+'Biblio::EndnoteStyle' => 0.05,
 'CGI' => 3.15,
 'CGI::Carp' => 1.29,
 'CGI::Session' => '4.10',
@@ -430,8 +458,10 @@ WriteMakefile(
 'Class::Accessor' => 0.30,
 'DBD::mysql' => 3.0008,
 'DBI' => 1.53,
+'Data::ICal' => 0.13,
 'Data::Dumper' => 2.121_08,
 'Date::Calc' => 5.4,
+'Date::ICal' => 1.72,
 'Date::Manip' => 5.44,
 'Digest::MD5' => 2.36,
 'File::Temp' => 0.16,
@@ -445,20 +475,24 @@ WriteMakefile(
 'LWP::UserAgent' => 2.033,
 'Lingua::Stem' => 0.82,
 'List::Util' => 1.18,
+'List::MoreUtils' => 0.22,
 'Locale::Language' => 2.07,
 'MARC::Charset' => 0.98,
-'MARC::Crosswalk::DublinCore' => 0.03,
+'MARC::Crosswalk::DublinCore' => 0.02,
 'MARC::File::XML' => 0.88,
 'MARC::Record' => 2.00,
 'MIME::Base64' => 3.07,
 'MIME::QuotedPrint' => 3.07,
 'Mail::Sendmail' => 0.79,
+'Net::LDAP' => 0.34,
+'Net::LDAP::Filter' => 0.34,
 'Net::Z3950::ZOOM' => 1.16,
 'PDF::API2' => 2.000,
 'PDF::API2::Page' => 2.000,
 'PDF::API2::Util' => 2.000,
 'PDF::Reuse' => 0.33,
 'PDF::Reuse::Barcode' => 0.05,
+'POE' => 0.9999,
 'POSIX' => 1.09,
 'Schedule::At' => 1.06,
 'Term::ANSIColor' => 1.10,
@@ -473,6 +507,7 @@ WriteMakefile(
 'Unicode::Normalize' => 0.32,
 'XML::Dumper' => 0.81,
 'XML::LibXML' => 1.59,
+'XML::LibXSLT' => 1.63,
 'XML::SAX::ParserFactory' => 1.01,
 'XML::Simple' => 2.14,
 'XML::RSS' => 1.31,
@@ -485,7 +520,7 @@ WriteMakefile(
     INSTALLMAN1DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man1'),
     INSTALLMAN3DIR => File::Spec->catdir($target_directories->{'MAN_DIR'}, 'man3'),
 
-   PL_FILES => $pl_files,
+    PL_FILES => $pl_files,
 
 );
 
@@ -678,7 +713,7 @@ be run from the current directory.
 
 Configuration directory:);
         # FIXME - home directory portability consideration apply
-        $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "/usr/share/koha-dev";
+        $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
     } elsif ($config{'INSTALL_MODE'} eq 'single') {
         $msg = "\nPlease specify the directory in which to install Koha";
         # FIXME -- we're assuming under a 'single' mode install
@@ -687,7 +722,8 @@ Configuration directory:);
         # use File::HomeDir to locate the home directory portably.  
         # This is deferred for now because File::HomeDir is not yet
         # core.
-        $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : "/usr/share/koha";
+               # --we must also keep this portable to the major OS's -fbcit
+        $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
     } else {
         # must be standard
         $msg = q(
@@ -702,8 +738,9 @@ as the package name in the FHS layout.
 Base installation directory);
     }
     $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values);
-    $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
 
+    $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
+       print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
     if ($config{'INSTALL_MODE'} eq "standard") {
         $msg = q(
 Since you are using the 'standard' install
@@ -820,6 +857,8 @@ Please specify the Zebra database password);
         $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values);
 
     }
+
+    print "\n\n";
     return %config;
 }
 
@@ -840,8 +879,17 @@ sub _get_value {
     my $default = shift;
     my $valid_values = shift;
 
+    # override default value from environment
+    if (exists $ENV{$key}) {
+        $default = $ENV{$key};
+        $msg .= " (default from environment)";
+    }
+
     my $val = prompt($msg, $default);
-    while (exists $valid_values->{$key} and not exists $valid_values->{$key}->{$val}) {
+
+    while (exists $valid_values->{$key} and 
+           $val ne $default and
+           not exists $valid_values->{$key}->{$val}) {
         my $retry_msg = "Value '$val' is not a valid option.\n";
         $retry_msg .= "Please enter a value";
         $retry_msg .= _add_valid_values_disp($key, $valid_values);
@@ -870,9 +918,16 @@ sub get_target_directories {
     # get last component of install base directory
     # to treat as package name
     my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
+
     my @basedir = File::Spec->splitdir($directories);
+
+       # for Win32 we need to prepend the volume to the directory path
+       if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
+       elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; }   # in a cygwin environment, $volume is returned empty
+
     my $package = pop @basedir;
 
+
     my %dirmap = ();
     my %skipdirs = ();
     if ($mode eq 'single') {
@@ -941,11 +996,23 @@ sub get_target_directories {
         $dirmap{'ZEBRA_RUN_DIR'} =  File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
     }
 
+    _get_env_overrides(\%dirmap);
     _get_argv_overrides(\%dirmap);
 
     return \%dirmap, \%skipdirs;
 }
 
+sub _get_env_overrides {
+    my $dirmap = shift;
+
+    foreach my $key (keys %$dirmap) {
+        if (exists $ENV{$key}) {
+            $dirmap->{$key} = $ENV{$key};
+            print "Setting $key from environment\n";
+        }
+    }
+}
+
 sub _get_argv_overrides {
     my $dirmap = shift;
     
@@ -976,10 +1043,19 @@ sub display_configuration {
     print "perl Makefile.PL again.  To override one of the target\n";
     print "directories, you can do so on the command line like this:\n";
     print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
+    print "You can also set different default values for parameters\n";
+    print "or override directory locations by using environment variables.\n";
+    print "\nFor example:\n\n";
+    print "export DB_USER=my_koha\n";
+    print "perl Makefile.PL\n";
+    print "\nor\n\n";
+    print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
 }
 
 package MY;
 
+# This will have to be reworked in order to accommodate Win32...
+
 sub test {
     my $self = shift;
     my $test = $self->SUPER::test(@_);
@@ -993,47 +1069,73 @@ sub install {
     # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
     # This means that we're completely overriding EU::MM's default
     # installation and uninstallation targets.
-    foreach my $key (sort keys %$target_directories) {
-        $install .= qq(
+
+# If installation is on Win32, we need to do permissions different from *nix
+    if ( $^O =~ /linux|cygwin/ ) { # this value needs to be verified for each platform and modified accordingly
+           foreach my $key (sort keys %$target_directories) {
+                   $install .= qq(
 KOHA_INST_$key = blib/$key
 KOHA_DEST_$key = $target_directories->{$key}
-) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
-    }
-
-    $install .= qq(
+)                      unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+               }
+               $install .= qq(
 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
 \t\$(NOECHO) \$(NOOP)
 );
-    $install .= "install_koha ::\n";      
-    $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
-    foreach my $key (sort keys %$target_directories) {
-        $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
-            unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
-    }
-    $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
-    $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
-
-    $install .= "\n";
-    $install .= "set_koha_ownership ::\n";
-    if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
-        foreach my $key (sort keys %$target_directories) {
-            $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
-                unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
-        }
-    } else {
-        $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
-    }
-
-    $install .= "\n";
-    $install .= "set_koha_permissions ::\n";
-    # This is necessary because EU::MM installs files
-    # as either 0444 or 0555, and we want the owner
-    # of Koha's files to have write permission by default.
-    foreach my $key (sort keys %$target_directories) {
-        $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
-            unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
-    }
-    $install .= "\n";
+                       $install .= "install_koha ::\n";      
+                       $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
+                       foreach my $key (sort keys %$target_directories) {
+                               $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
+                                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+                       }
+                       $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
+                       $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
+
+                       $install .= "\n";
+                       $install .= "set_koha_ownership ::\n";
+                       if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
+                               foreach my $key (sort keys %$target_directories) {
+                                       $install .= "\t\$(NOECHO) chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key)\n"
+                                               unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+                               }
+                       } else {
+                               $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
+                       }
+
+                       $install .= "\n";
+                       $install .= "set_koha_permissions ::\n";
+                       # This is necessary because EU::MM installs files
+                       # as either 0444 or 0555, and we want the owner
+                       # of Koha's files to have write permission by default.
+                       foreach my $key (sort keys %$target_directories) {
+                               $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
+                                       unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+                       }
+       }
+       elsif ($^O eq 'MSWin32' ) {     # On Win32, the install probably needs to be done under the user account koha will be running as...
+                                                               # We can attempt some creative things with command line utils such as CACLS which allows permission
+                                                               # management from Win32 cmd.exe, but permissions really only apply to NTFS.
+           foreach my $key (sort keys %$target_directories) {
+                   $install .= qq(
+KOHA_INST_$key = blib/$key
+KOHA_DEST_$key = $target_directories->{$key}
+)                      unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+               }
+               $install .= qq(
+install :: all install_koha warn_koha_env_vars
+\t\$(NOECHO) \$(NOOP)
+);
+               $install .= "install_koha ::\n";
+               $install .= "\t\$(MOD_INSTALL) \\\n";
+               foreach my $key (sort keys %$target_directories) {
+                       $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n" 
+                               unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
+               }
+       }
+       $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
+       $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
+
+       $install .= "\n";
 
     $install .= "warn_koha_env_vars ::\n";
     $install .= "\t\$(NOECHO) \$(ECHO)\n";
@@ -1045,6 +1147,9 @@ install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_en
     $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
     $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
     $install .= "\t\$(NOECHO) \$(ECHO)\n";
+    $install .= "\t\$(NOECHO) \$(ECHO) If installing on a Win32 platform, be sure to use:\n";
+    $install .= "\t\$(NOECHO) \$(ECHO) 'dmake -x MAXLINELENGTH=300000'\n";
+    $install .= "\t\$(NOECHO) \$(ECHO)\n";
     $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
     $install .= "\t\$(NOECHO) \$(ECHO)\n";
 
@@ -1056,12 +1161,29 @@ sub postamble {
     # so that Make will export as environment
     # variables -- this is for the use of
     # rewrite-confg.PL
-    my $env = join("\n", map { "export __${_}__ = $target_directories->{$_}" } keys %$target_directories); 
-    $env .= "\n\n";
-    $env .= join("\n", map { "export __${_}__ = $config{$_}" } keys %config);
-    return "$env\n";
+
+    # quote '$' in the two password parameters
+    my %config = %config;
+    $config{'DB_PASS'} =~ s/\$/\$\$/g;
+    $config{'ZEBRA_PASS'} =~ s/\$/\$\$/g;
+
+       # Hereagain, we must alter syntax per platform...
+       if ( $^O =~ /linux|cygwin/ ) {
+               my $env = join("\n", map { "export __${_}__ := $target_directories->{$_}" } keys %$target_directories); 
+               $env .= "\n\n";
+               $env .= join("\n", map { "export __${_}__ := $config{$_}" } keys %config);
+               return "$env\n";
+       }
+       elsif ( $^O eq 'MSWin32' ) {
+               # NOTE: it is imperative that there be no whitespaces in ENV=value...
+               my $env = join("\n", map { "__${_}__=$target_directories->{$_}" } keys %$target_directories); 
+               $env .= "\n\n";
+               $env .= join("\n", map { "__${_}__=$config{$_}" } keys %config);
+               return "$env\n";
+       }
 }
 
+
 __END__