1 # Copyright 2007 MJ Ray
3 # This file is part of Koha.
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.
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.
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>.
18 # Current maintainer MJR http://mjr.towers.org.uk/
20 # 2007/11/12 Added DB_PORT and changed other keywords to reflect multi-dbms support. -fbcit
28 rewrite-config.PL - helper for the Koha packager and installer
32 perl rewrite-config.PL configurationfile
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.
44 The following configuration keywords are available:
47 BASE_DIR, CGI_DIR, LOG_DIR, PLUGINS_DIR, INSTALL_BASE,
48 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,
49 WEBSERVER_HOST, WEBSERVER_IP, WEBSERVER_PORT, WEBSERVER_PORT_LIBRARIAN, ZEBRA_PASS, ZEBRA_USER
53 To override the guessed hostname and email address, run:
55 WEBSERVER_HOST=mysecrethostname.com.invalid \
56 WEBMASTER_EMAIL=webmaster@publichost.com make install
58 Note that if WEBSERVER_HOST does not resolve to an IP address, you will
59 also need to override WEBSERVER_IP.
63 if ( $myhost = $ENV{WEBSERVER_HOST} || hostname ) {
64 ( $mydomain = $myhost ) =~ s/.*?\.//;
66 $myhost = 'localhost';
67 $mydomain = 'localdomain';
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 ($!)";
78 $prefix = $ENV{'INSTALL_BASE'} || "/usr";
80 # These are our configuration guesses
81 # Keys were extracted by
82 # <grep -o '__.*__' etc/* | cut -f2 -d: | sort -u | sed -e 's/^/ "/;s/$/" => "",/'
84 "__KOHA_INSTALLED_VERSION__" => "no_version_found",
85 "__LOG_DIR__" => "/var/log",
86 "__PLUGINS_DIR__" => "/var/lib/koha/plugins",
87 "__DB_TYPE__" => "mysql",
88 "__DB_NAME__" => "koha",
89 "__DB_HOST__" => $myhost,
90 "__DB_PORT__" => "3306",
91 "__DB_USER__" => "kohaadmin",
92 "__DB_PASS__" => "katikoan",
93 "__DB_USE_TLS__" => "no",
94 "__DB_TLS_CA_CERTIFICATE__" => "",
95 "__DB_TLS_CLIENT_CERTIFICATE__" => "",
96 "__DB_TLS_CLIENT_KEY__"=>"",
97 "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
98 "__WEBSERVER_DOMAIN__" => $mydomain,
99 "__WEBSERVER_HOST__" => $myhost,
100 "__WEBSERVER_IP__" => $myip,
101 "__WEBSERVER_PORT__" => "80",
102 "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
103 "__ZEBRA_SRU_HOST__" => $myhost,
104 "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
105 "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
106 "__KOHA_USER__" => "koha",
107 "__KOHA_GROUP__" => "koha",
108 "__ZEBRA_PASS__" => "zebrastripes",
109 "__ZEBRA_USER__" => "kohauser",
110 '__BACKUP_DIR__' => "$prefix/var/spool",
111 '__API_CGI_DIR__' => "$prefix/api",
112 '__INTRANET_CGI_DIR__' => "$prefix/intranet/cgi-bin",
113 '__INTRANET_TMPL_DIR__' => "$prefix/intranet/templates",
114 '__INTRANET_WWW_DIR__' => "$prefix/intranet/www",
115 '__OPAC_CGI_DIR__' => "$prefix/opac/cgi-bin",
116 '__OPAC_TMPL_DIR__' => "$prefix/opac/templates",
117 '__OPAC_WWW_DIR__' => "$prefix/opac/www",
118 '__PERL_MODULE_DIR__' => ($ENV{'INSTALLSITELIB'} || sprintf($prefix."/lib/perl5/site_perl/%vd",$^V))."/koha",
119 '__KOHA_CONF_DIR__' => "$prefix/etc/koha",
120 '__ZEBRA_CONF_DIR__' => "$prefix/etc/koha/zebradb",
121 '__PAZPAR2_CONF_DIR__' => "$prefix/etc/koha/pazpar2",
122 '__MISC_DIR__' => "$prefix/misc",
123 '__SCRIPT_DIR__' => "$prefix/bin",
124 '__SCRIPT_NONDEV_DIR__' => "$prefix/bin",
125 '__MAN_DIR__' => "$prefix/man",
126 '__DOC_DIR__' => "$prefix/doc",
127 '__ZEBRA_LOCK_DIR__' => "$prefix/var/lock/zebradb",
128 '__ZEBRA_DATA_DIR__' => "$prefix/var/lib/zebradb",
129 '__ZEBRA_RUN_DIR__' => "$prefix/var/run/zebradb",
130 '__ZEBRA_MARC_FORMAT__' => 'marc21',
131 '__ZEBRA_LANGUAGE__' => 'en',
132 '__ZEBRA_TOKENIZER__' => 'chr',
133 '__ZEBRA_TOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
134 '__ZEBRA_PTOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
135 '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-dom.xml',
136 '__BIB_RETRIEVAL_CFG__' => 'retrieval-info-bib-dom.xml',
137 '__ZEBRA_AUTH_CFG__' => 'zebra-authorities-dom.cfg',
138 '__ZEBRA_BIB_CFG__' => 'zebra-biblios-dom.cfg',
139 "__MERGE_SERVER_HOST__" => $myhost,
140 "__MERGE_SERVER_PORT__" => '11001',
141 "__PAZPAR2_HOST__" => $myhost,
142 "__PAZPAR2_PORT__" => '11002',
143 "__INSTALL_MODE__" => 'standard',
144 "__INSTALL_BASE__" => '/usr/share/koha',
145 "__INSTALL_SRU__" => 'yes',
146 "__INSTALL_PAZPAR2__" => 'no',
147 "__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
148 "__PAZPAR2_TOGGLE_XML_POST__" => '-->',
149 "__RUN_DATABASE_TESTS__" => 'no',
150 "__PATH_TO_ZEBRA__" => "",
151 "__USE_MEMCACHED__" => 'yes',
152 "__MEMCACHED_SERVERS__" => "",
153 "__MEMCACHED_NAMESPACE__" => "",
154 "__USE_ELASTICSEARCH__" => 'no',
155 "__ELASTICSEARCH_SERVERS__" => "localhost:9200",
156 "__ELASTICSEARCH_INDEX__" => "koha",
157 "__FONT_DIR__" => "/usr/share/fonts/truetype/ttf-dejavu",
158 "__TEMPLATE_CACHE_DIR__" => "/tmp/koha"
161 # Override configuration from the environment
162 foreach my $key (keys %configuration) {
163 if (defined($ENV{$key})) {
164 $configuration{$key} = $ENV{$key};
168 # munge commenting out the PazPar2 mergeserver
169 # entry in koha-conf.xml if necessary
170 if ($configuration{'__INSTALL_PAZPAR2__'} eq 'yes') {
171 $configuration{'__PAZPAR2_TOGGLE_XML_PRE__'} = '';
172 $configuration{'__PAZPAR2_TOGGLE_XML_POST__'} = '';
176 $file = &read_file($fname);
177 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
179 # At this point, file is in 'blib' and by default
180 # has mode a-w. Therefore, must change permission
181 # to make it writable. Note that stat and chmod
182 # (the Perl functions) should work on Win32
184 $old_perm = (stat $fname)[2] & oct(7777);
185 my $new_perm = $old_perm | oct(200);
186 chmod $new_perm, $fname;
188 open(my $output, ">", $fname) || die "Can't open $fname for write: $!";
192 chmod $old_perm, $fname;
194 # Idea taken from perlfaq5
197 open(my $fh , '<', $_[0]) || die "Can't open $_[0] for read";
208 Makefile.PL, ExtUtils::MakeMaker(3)
212 MJ Ray mjr at phonecoop.coop