rewrite-config.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 # 2007/11/12    Added DB_PORT and changed other keywords to reflect multi-dbms support. -fbcit
  22
  23 use Sys::Hostname;
  24 use Socket;
  25
  26 =head1 NAME
  27
  28 rewrite-config.PL - helper for the Koha packager and installer
  29
  30 =head1 SYNOPSIS
  31
  32         perl rewrite-config.PL configurationfile
  33
  34 =head1 DESCRIPTION
  35
  36 This helper script replaces keywords in the
  37 configuration files with value either supplied through
  38 the environment (with export, or by putting them on
  39 the start of the make command line) or with reasonable
  40 guesses worked out by the script.
  41
  42 =head2 KEYWORDS
  43
  44 The following configuration keywords are available:
  45
  46 PREFIX,
  47 BASE_DIR, CGI_DIR, LOG_DIR, INSTALL_BASE,
  48 DB_TYPE, DB_HOST, DB_PORT, DB_NAME, DB_PASS, DB_USER, WEBMASTER_EMAIL, WEBSERVER_DOMAIN,
  49 WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER
  50
  51 =head1 EXAMPLES
  52
  53 To override the guessed hostname and email address, run:
  54
  55         WEBSERVER_HOST=mysecrethostname.com.invalid \
  56         WEBMASTER_EMAIL=webmaster@publichost.com make install
  57
  58 Note that if WEBSERVER_HOST does not resolve to an IP address, you will
  59 also need to override WEBSERVER_IP.
  60
  61 =cut
  62
  63 $myhost = hostname();
  64 $mydomain = $myhost;
  65 $mydomain =~ s/^.*?\.//;
  66 # This is set here to rescue systems with broken DNS
  67 $myip = $ENV{'WEBSERVER_IP'} || inet_ntoa(scalar gethostbyname($myhost||'localhost')) || die "Cannot get our own IP address: DNS fault?";
  68 $prefix = $ENV{'INSTALL_BASE'} || "/usr";
  69
  70 # These are our configuration guesses
  71 # Keys were extracted by
  72 # <grep -o '__.*__' etc/* | cut -f2 -d: | sort -u | sed -e 's/^/  "/;s/$/" => "",/'
  73 %configuration = (
  74   "__KOHA_INSTALLED_VERSION__" => "no_version_found",
  75   "__LOG_DIR__" => "/var/log",
  76   "__DB_TYPE__" => "mysql",
  77   "__DB_NAME__" => "koha",
  78   "__DB_HOST__" => $myhost,
  79   "__DB_PORT__" => "3306",
  80   "__DB_USER__" => "kohaadmin",
  81   "__DB_PASS__" => "katikoan",
  82   "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
  83   "__WEBSERVER_DOMAIN__" => $mydomain,
  84   "__WEBSERVER_HOST__" => $myhost,
  85   "__WEBSERVER_IP__" => $myip,
  86   "__WEBSERVER_PORT__" => "80",
  87   "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
  88   "__ZEBRA_SRU_HOST__" => $myhost,
  89   "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
  90   "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
  91   "__KOHA_USER__" => "koha",
  92   "__KOHA_GROUP__" => "koha",
  93   "__ZEBRA_PASS__" => "zebrastripes",
  94   "__ZEBRA_USER__" => "kohauser",
  95   '__INTRANET_CGI_DIR__' => "$prefix/intranet/cgi-bin",
  96   '__INTRANET_TMPL_DIR__' => "$prefix/intranet/templates",
  97   '__INTRANET_WWW_DIR__' => "$prefix/intranet/www",
  98   '__OPAC_CGI_DIR__' => "$prefix/opac/cgi-bin",
  99   '__OPAC_TMPL_DIR__' => "$prefix/opac/templates",
 100   '__OPAC_WWW_DIR__' => "$prefix/opac/www",
 101   '__PERL_MODULE_DIR__' =>  ($ENV{'INSTALLSITELIB'} || sprintf($prefix."/lib/perl5/site_perl/%vd",$^V))."/koha",
 102   '__KOHA_CONF_DIR__' => "$prefix/etc/koha",
 103   '__ZEBRA_CONF_DIR__' => "$prefix/etc/koha/zebradb",
 104   '__PAZPAR2_CONF_DIR__' => "$prefix/etc/koha/pazpar2",
 105   '__MISC_DIR__' => "$prefix/misc",
 106   '__SCRIPT_DIR__' => "$prefix/bin",
 107   '__MAN_DIR__' => "$prefix/man",
 108   '__DOC_DIR__' => "$prefix/doc",
 109   '__ZEBRA_LOCK_DIR__' => "$prefix/var/lock/zebradb",
 110   '__ZEBRA_DATA_DIR__' => "$prefix/var/lib/zebradb",
 111   '__ZEBRA_RUN_DIR__' => "$prefix/var/run/zebradb",
 112   '__ZEBRA_MARC_FORMAT__' => 'marc21',
 113   '__ZEBRA_LANGUAGE__' => 'en',
 114   '__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
 115   '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
 116   "__MERGE_SERVER_HOST__" => $myhost,
 117   "__MERGE_SERVER_PORT__" => '11001',
 118   "__PAZPAR2_HOST__" => $myhost,
 119   "__PAZPAR2_PORT__" => '11002',
 120   "__INSTALL_MODE__" => 'standard',
 121   "__INSTALL_BASE__" => '/usr/share/koha',
 122   "__INSTALL_ZEBRA__" => 'yes',
 123   "__INSTALL_SRU__" => 'yes',
 124   "__INSTALL_PAZPAR2__" => 'no',
 125   "__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
 126   "__PAZPAR2_TOGGLE_XML_POST__" => '-->',
 127   "__AUTH_INDEX_MODE__" => 'grs1',
 128   "__RUN_DATABASE_TESTS__" => 'no',
 129 );
 130
 131 # Override configuration from the environment
 132 foreach $key (keys %configuration) {
 133   if (defined($ENV{$key})) {
 134     $configuration{$key} = $ENV{$key};
 135   }
 136 }
 137
 138 # munge commenting out the PazPar2 mergeserver
 139 # entry in koha-conf.xml if necessary
 140 if ($configuration{'__INSTALL_PAZPAR2__'} eq 'yes') {
 141     $configuration{'__PAZPAR2_TOGGLE_XML_PRE__'} = '';
 142     $configuration{'__PAZPAR2_TOGGLE_XML_POST__'} = '';
 143 }
 144
 145 $fname = $ARGV[0];
 146 $file = &read_file($fname);
 147 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
 148
 149 # At this point, file is in 'blib' and by default
 150 # has mode a-w.  Therefore, must change permission
 151 # to make it writable.  Note that stat and chmod
 152 # (the Perl functions) should work on Win32
 153 my $old_perm;
 154 $old_perm = (stat $fname)[2] & 07777;
 155 my $new_perm = $old_perm | 0200;
 156 chmod $new_perm, $fname;
 157
 158 open(OUTPUT,">$fname") || die "Can't open $fname for write: $!";
 159 print OUTPUT $file;
 160 close(OUTPUT);
 161
 162 chmod $old_perm, $fname;
 163
 164 # Idea taken from perlfaq5
 165 sub read_file($) {
 166   local(*INPUT,$/);
 167   open(INPUT,$_[0]) || die "Can't open $_[0] for read";
 168   my $file = <INPUT>;
 169   return $file;
 170 }
 171
 172 __END__
 173
 174
 175 =head1 SEE ALSO
 176
 177 Makefile.PL, ExtUtils::MakeMaker(3)
 178
 179 =head1 AUTHOR
 180
 181 MJ Ray mjr at phonecoop.coop
 182
 183 =cut
 184