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
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17 #
  18 # Current maintainer MJR http://mjr.towers.org.uk/
  19 #
  20 # 2007/11/12    Added DB_PORT and changed other keywords to reflect multi-dbms support. -fbcit
  21
  22 use Sys::Hostname;
  23 use Socket;
  24
  25 =head1 NAME
  26
  27 rewrite-config.PL - helper for the Koha packager and installer
  28
  29 =head1 SYNOPSIS
  30
  31         perl rewrite-config.PL configurationfile
  32
  33 =head1 DESCRIPTION
  34
  35 This helper script replaces keywords in the
  36 configuration files with value either supplied through
  37 the environment (with export, or by putting them on
  38 the start of the make command line) or with reasonable
  39 guesses worked out by the script.
  40
  41 =head2 KEYWORDS
  42
  43 The following configuration keywords are available:
  44
  45 PREFIX,
  46 BASE_DIR, CGI_DIR, LOG_DIR, PLUGINS_DIR, INSTALL_BASE,
  47 DB_TYPE, DB_HOST, DB_PORT, DB_NAME, DB_PASS, DB_USER, DB_USE_TLS, DB_TLS_CA_CERT, DB_TLS_CLIENT_KEY, DB_TLS_CLIENT_CERT, WEBMASTER_EMAIL, WEBSERVER_DOMAIN,
  48 WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER
  49
  50 =head1 EXAMPLES
  51
  52 To override the guessed hostname and email address, run:
  53
  54         WEBSERVER_HOST=mysecrethostname.com.invalid \
  55         WEBMASTER_EMAIL=webmaster@publichost.com make install
  56
  57 Note that if WEBSERVER_HOST does not resolve to an IP address, you will
  58 also need to override WEBSERVER_IP.
  59
  60 =cut
  61
  62 if ( $myhost = $ENV{WEBSERVER_HOST} || hostname ) {
  63     ( $mydomain = $myhost ) =~ s/.*?\.//;
  64 } else {
  65     $myhost   = 'localhost';
  66     $mydomain = 'localdomain';
  67 }
  68
  69 unless ( $myip = $ENV{WEBSERVER_IP} ) {
  70     my $byname = gethostbyname( $myhost )
  71         or die "Could not get the IP address of $myhost, DNS fault? ($!)";
  72     $myip = inet_ntoa $byname
  73         or die "can't inet_ntoa ($!)";
  74 }
  75
  76
  77 $prefix = $ENV{'INSTALL_BASE'} || "/usr";
  78
  79 # These are our configuration guesses
  80 # Keys were extracted by
  81 # <grep -o '__.*__' etc/* | cut -f2 -d: | sort -u | sed -e 's/^/  "/;s/$/" => "",/'
  82 %configuration = (
  83   "__KOHA_INSTALLED_VERSION__" => "no_version_found",
  84   "__LOG_DIR__" => "/var/log",
  85   "__PLUGINS_DIR__" => "/var/lib/koha/plugins",
  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   "__DB_USE_TLS__" => "no",
  93   "__DB_TLS_CA_CERTIFICATE__" => "",
  94   "__DB_TLS_CLIENT_CERTIFICATE__" => "",
  95   "__DB_TLS_CLIENT_KEY__"=>"",
  96   "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
  97   "__WEBSERVER_DOMAIN__" => $mydomain,
  98   "__WEBSERVER_HOST__" => $myhost,
  99   "__WEBSERVER_IP__" => $myip,
 100   "__WEBSERVER_PORT__" => "80",
 101   "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
 102   "__ZEBRA_SRU_HOST__" => $myhost,
 103   "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
 104   "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
 105   "__KOHA_USER__" => "koha",
 106   "__KOHA_GROUP__" => "koha",
 107   "__ZEBRA_PASS__" => "zebrastripes",
 108   "__ZEBRA_USER__" => "kohauser",
 109   '__BACKUP_DIR__' => "$prefix/var/spool",
 110   '__API_CGI_DIR__' => "$prefix/api",
 111   '__INTRANET_CGI_DIR__' => "$prefix/intranet/cgi-bin",
 112   '__INTRANET_TMPL_DIR__' => "$prefix/intranet/templates",
 113   '__INTRANET_WWW_DIR__' => "$prefix/intranet/www",
 114   '__OPAC_CGI_DIR__' => "$prefix/opac/cgi-bin",
 115   '__OPAC_TMPL_DIR__' => "$prefix/opac/templates",
 116   '__OPAC_WWW_DIR__' => "$prefix/opac/www",
 117   '__PERL_MODULE_DIR__' =>  ($ENV{'INSTALLSITELIB'} || sprintf($prefix."/lib/perl5/site_perl/%vd",$^V))."/koha",
 118   '__KOHA_CONF_DIR__' => "$prefix/etc/koha",
 119   '__ZEBRA_CONF_DIR__' => "$prefix/etc/koha/zebradb",
 120   '__PAZPAR2_CONF_DIR__' => "$prefix/etc/koha/pazpar2",
 121   '__MISC_DIR__' => "$prefix/misc",
 122   '__SCRIPT_DIR__' => "$prefix/bin",
 123   '__SCRIPT_NONDEV_DIR__' => "$prefix/bin",
 124   '__MAN_DIR__' => "$prefix/man",
 125   '__DOC_DIR__' => "$prefix/doc",
 126   '__ZEBRA_LOCK_DIR__' => "$prefix/var/lock/zebradb",
 127   '__ZEBRA_DATA_DIR__' => "$prefix/var/lib/zebradb",
 128   '__ZEBRA_RUN_DIR__' => "$prefix/var/run/zebradb",
 129   '__ZEBRA_MARC_FORMAT__' => 'marc21',
 130   '__ZEBRA_LANGUAGE__' => 'en',
 131   '__ZEBRA_TOKENIZER__' => 'chr',
 132   '__ZEBRA_TOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
 133   '__ZEBRA_PTOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
 134   '__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
 135   '__ZEBRA_BIB_CFG__' => 'zebra-biblios.cfg',
 136   '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
 137   '__BIB_RETRIEVAL_CFG__' => 'retrieval-info-bib-grs1.xml',
 138   "__MERGE_SERVER_HOST__" => $myhost,
 139   "__MERGE_SERVER_PORT__" => '11001',
 140   "__PAZPAR2_HOST__" => $myhost,
 141   "__PAZPAR2_PORT__" => '11002',
 142   "__INSTALL_MODE__" => 'standard',
 143   "__INSTALL_BASE__" => '/usr/share/koha',
 144   "__INSTALL_SRU__" => 'yes',
 145   "__INSTALL_PAZPAR2__" => 'no',
 146   "__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
 147   "__PAZPAR2_TOGGLE_XML_POST__" => '-->',
 148   "__AUTH_INDEX_MODE__" => 'grs1',
 149   "__BIB_INDEX_MODE__" => 'grs1',
 150   "__RUN_DATABASE_TESTS__" => 'no',
 151   "__PATH_TO_ZEBRA__" => "",
 152   "__USE_MEMCACHED__" => 'no',
 153   "__MEMCACHED_SERVERS__" => "",
 154   "__MEMCACHED_NAMESPACE__" => "",
 155   "__FONT_DIR__" => "/usr/share/fonts/truetype/ttf-dejavu",
 156 );
 157
 158 # Override configuration from the environment
 159 foreach $key (keys %configuration) {
 160   if (defined($ENV{$key})) {
 161     $configuration{$key} = $ENV{$key};
 162   }
 163 }
 164
 165 # munge commenting out the PazPar2 mergeserver
 166 # entry in koha-conf.xml if necessary
 167 if ($configuration{'__INSTALL_PAZPAR2__'} eq 'yes') {
 168     $configuration{'__PAZPAR2_TOGGLE_XML_PRE__'} = '';
 169     $configuration{'__PAZPAR2_TOGGLE_XML_POST__'} = '';
 170 }
 171
 172 $fname = $ARGV[0];
 173 $file = &read_file($fname);
 174 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
 175
 176 # At this point, file is in 'blib' and by default
 177 # has mode a-w.  Therefore, must change permission
 178 # to make it writable.  Note that stat and chmod
 179 # (the Perl functions) should work on Win32
 180 my $old_perm;
 181 $old_perm = (stat $fname)[2] & 07777;
 182 my $new_perm = $old_perm | 0200;
 183 chmod $new_perm, $fname;
 184
 185 open(OUTPUT,">$fname") || die "Can't open $fname for write: $!";
 186 print OUTPUT $file;
 187 close(OUTPUT);
 188
 189 chmod $old_perm, $fname;
 190
 191 # Idea taken from perlfaq5
 192 sub read_file($) {
 193   local(*INPUT,$/);
 194   open(INPUT,$_[0]) || die "Can't open $_[0] for read";
 195   my $file = <INPUT>;
 196   return $file;
 197 }
 198
 199 __END__
 200
 201
 202 =head1 SEE ALSO
 203
 204 Makefile.PL, ExtUtils::MakeMaker(3)
 205
 206 =head1 AUTHOR
 207
 208 MJ Ray mjr at phonecoop.coop
 209
 210 =cut