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
  15 # with Koha; if not, write to the Free Software Foundation, Inc.,
  16 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 if ( $myhost = $ENV{WEBSERVER_HOST} || hostname ) {
  64     ( $mydomain = $myhost ) =~ s/.*?\.//;
  65 } else {
  66     $myhost   = 'localhost';
  67     $mydomain = 'localdomain';
  68 }
  69
  70 unless ( $myip = $ENV{WEBSERVER_IP} ) {
  71     my $byname = gethostbyname( $myhost )
  72         or die "Could not get the IP address of $myhost, DNS fault? ($!)";
  73     $myip = inet_ntoa $byname
  74         or die "can't inet_ntoa ($!)";
  75 }
  76
  77
  78 $prefix = $ENV{'INSTALL_BASE'} || "/usr";
  79
  80 # These are our configuration guesses
  81 # Keys were extracted by
  82 # <grep -o '__.*__' etc/* | cut -f2 -d: | sort -u | sed -e 's/^/  "/;s/$/" => "",/'
  83 %configuration = (
  84   "__KOHA_INSTALLED_VERSION__" => "no_version_found",
  85   "__LOG_DIR__" => "/var/log",
  86   "__DB_TYPE__" => "mysql",
  87   "__DB_NAME__" => "koha",
  88   "__DB_HOST__" => $myhost,
  89   "__DB_PORT__" => "3306",
  90   "__DB_USER__" => "kohaadmin",
  91   "__DB_PASS__" => "katikoan",
  92   "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
  93   "__WEBSERVER_DOMAIN__" => $mydomain,
  94   "__WEBSERVER_HOST__" => $myhost,
  95   "__WEBSERVER_IP__" => $myip,
  96   "__WEBSERVER_PORT__" => "80",
  97   "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
  98   "__ZEBRA_SRU_HOST__" => $myhost,
  99   "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
 100   "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
 101   "__KOHA_USER__" => "koha",
 102   "__KOHA_GROUP__" => "koha",
 103   "__ZEBRA_PASS__" => "zebrastripes",
 104   "__ZEBRA_USER__" => "kohauser",
 105   '__INTRANET_CGI_DIR__' => "$prefix/intranet/cgi-bin",
 106   '__INTRANET_TMPL_DIR__' => "$prefix/intranet/templates",
 107   '__INTRANET_WWW_DIR__' => "$prefix/intranet/www",
 108   '__OPAC_CGI_DIR__' => "$prefix/opac/cgi-bin",
 109   '__OPAC_TMPL_DIR__' => "$prefix/opac/templates",
 110   '__OPAC_WWW_DIR__' => "$prefix/opac/www",
 111   '__PERL_MODULE_DIR__' =>  ($ENV{'INSTALLSITELIB'} || sprintf($prefix."/lib/perl5/site_perl/%vd",$^V))."/koha",
 112   '__KOHA_CONF_DIR__' => "$prefix/etc/koha",
 113   '__ZEBRA_CONF_DIR__' => "$prefix/etc/koha/zebradb",
 114   '__PAZPAR2_CONF_DIR__' => "$prefix/etc/koha/pazpar2",
 115   '__MISC_DIR__' => "$prefix/misc",
 116   '__SCRIPT_DIR__' => "$prefix/bin",
 117   '__MAN_DIR__' => "$prefix/man",
 118   '__DOC_DIR__' => "$prefix/doc",
 119   '__ZEBRA_LOCK_DIR__' => "$prefix/var/lock/zebradb",
 120   '__ZEBRA_DATA_DIR__' => "$prefix/var/lib/zebradb",
 121   '__ZEBRA_RUN_DIR__' => "$prefix/var/run/zebradb",
 122   '__ZEBRA_MARC_FORMAT__' => 'marc21',
 123   '__ZEBRA_LANGUAGE__' => 'en',
 124   '__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
 125   '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
 126   "__MERGE_SERVER_HOST__" => $myhost,
 127   "__MERGE_SERVER_PORT__" => '11001',
 128   "__PAZPAR2_HOST__" => $myhost,
 129   "__PAZPAR2_PORT__" => '11002',
 130   "__INSTALL_MODE__" => 'standard',
 131   "__INSTALL_BASE__" => '/usr/share/koha',
 132   "__INSTALL_ZEBRA__" => 'yes',
 133   "__INSTALL_SRU__" => 'yes',
 134   "__INSTALL_PAZPAR2__" => 'no',
 135   "__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
 136   "__PAZPAR2_TOGGLE_XML_POST__" => '-->',
 137   "__AUTH_INDEX_MODE__" => 'grs1',
 138   "__RUN_DATABASE_TESTS__" => 'no',
 139   "__PATH_TO_ZEBRA__" => "",
 140   "__USE_MEMCACHED__" => 'no',
 141   "__MEMCACHED_SERVERS__" => "",
 142   "__MEMCACHED_NAMESPACE__" => "",
 143 );
 144
 145 # Override configuration from the environment
 146 foreach $key (keys %configuration) {
 147   if (defined($ENV{$key})) {
 148     $configuration{$key} = $ENV{$key};
 149   }
 150 }
 151
 152 # munge commenting out the PazPar2 mergeserver
 153 # entry in koha-conf.xml if necessary
 154 if ($configuration{'__INSTALL_PAZPAR2__'} eq 'yes') {
 155     $configuration{'__PAZPAR2_TOGGLE_XML_PRE__'} = '';
 156     $configuration{'__PAZPAR2_TOGGLE_XML_POST__'} = '';
 157 }
 158
 159 $fname = $ARGV[0];
 160 $file = &read_file($fname);
 161 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
 162
 163 # At this point, file is in 'blib' and by default
 164 # has mode a-w.  Therefore, must change permission
 165 # to make it writable.  Note that stat and chmod
 166 # (the Perl functions) should work on Win32
 167 my $old_perm;
 168 $old_perm = (stat $fname)[2] & 07777;
 169 my $new_perm = $old_perm | 0200;
 170 chmod $new_perm, $fname;
 171
 172 open(OUTPUT,">$fname") || die "Can't open $fname for write: $!";
 173 print OUTPUT $file;
 174 close(OUTPUT);
 175
 176 chmod $old_perm, $fname;
 177
 178 # Idea taken from perlfaq5
 179 sub read_file($) {
 180   local(*INPUT,$/);
 181   open(INPUT,$_[0]) || die "Can't open $_[0] for read";
 182   my $file = <INPUT>;
 183   return $file;
 184 }
 185
 186 __END__
 187
 188
 189 =head1 SEE ALSO
 190
 191 Makefile.PL, ExtUtils::MakeMaker(3)
 192
 193 =head1 AUTHOR
 194
 195 MJ Ray mjr at phonecoop.coop
 196
 197 =cut