Bug 6679 - [SIGNED-OFF] fix 3 perlcritic violations in C4/Items.pm
[koha.git] / 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
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, INSTALL_BASE,
47 DB_TYPE, DB_HOST, DB_PORT, DB_NAME, DB_PASS, DB_USER, 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   "__DB_TYPE__" => "mysql",
86   "__DB_NAME__" => "koha",
87   "__DB_HOST__" => $myhost,
88   "__DB_PORT__" => "3306",
89   "__DB_USER__" => "kohaadmin",
90   "__DB_PASS__" => "katikoan",
91   "__WEBMASTER_EMAIL__" => 'webmaster@'.$mydomain,
92   "__WEBSERVER_DOMAIN__" => $mydomain,
93   "__WEBSERVER_HOST__" => $myhost,
94   "__WEBSERVER_IP__" => $myip,
95   "__WEBSERVER_PORT__" => "80",
96   "__WEBSERVER_PORT_LIBRARIAN__" => "8080",
97   "__ZEBRA_SRU_HOST__" => $myhost,
98   "__ZEBRA_SRU_BIBLIOS_PORT__" => "9998",
99   "__ZEBRA_SRU_AUTHORITIES_PORT__" => "9999",
100   "__KOHA_USER__" => "koha",
101   "__KOHA_GROUP__" => "koha",
102   "__ZEBRA_PASS__" => "zebrastripes",
103   "__ZEBRA_USER__" => "kohauser",
104   '__BACKUP_DIR__' => "$prefix/var/spool",
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_TOKENIZER_STMT__' => 'charmap word-phrase-utf.chr',
125   '__ZEBRA_AUTH_CFG__' => 'zebra-authorities.cfg',
126   '__ZEBRA_BIB_CFG__' => 'zebra-biblios.cfg',
127   '__AUTH_RETRIEVAL_CFG__' => 'retrieval-info-auth-grs1.xml',
128   '__BIB_RETRIEVAL_CFG__' => 'retrieval-info-bib-grs1.xml',
129   "__MERGE_SERVER_HOST__" => $myhost,
130   "__MERGE_SERVER_PORT__" => '11001',
131   "__PAZPAR2_HOST__" => $myhost,
132   "__PAZPAR2_PORT__" => '11002',
133   "__INSTALL_MODE__" => 'standard',
134   "__INSTALL_BASE__" => '/usr/share/koha',
135   "__INSTALL_ZEBRA__" => 'yes',
136   "__INSTALL_SRU__" => 'yes',
137   "__INSTALL_PAZPAR2__" => 'no',
138   "__PAZPAR2_TOGGLE_XML_PRE__" => '<!--',
139   "__PAZPAR2_TOGGLE_XML_POST__" => '-->',
140   "__AUTH_INDEX_MODE__" => 'grs1',
141   "__BIB_INDEX_MODE__" => 'grs1',
142   "__RUN_DATABASE_TESTS__" => 'no',
143   "__PATH_TO_ZEBRA__" => "",
144   "__USE_MEMCACHED__" => 'no',
145   "__MEMCACHED_SERVERS__" => "",
146   "__MEMCACHED_NAMESPACE__" => "",
147 );
148
149 # Override configuration from the environment
150 foreach $key (keys %configuration) {
151   if (defined($ENV{$key})) {
152     $configuration{$key} = $ENV{$key};
153   }
154 }
155
156 # munge commenting out the PazPar2 mergeserver
157 # entry in koha-conf.xml if necessary
158 if ($configuration{'__INSTALL_PAZPAR2__'} eq 'yes') {
159     $configuration{'__PAZPAR2_TOGGLE_XML_PRE__'} = '';
160     $configuration{'__PAZPAR2_TOGGLE_XML_POST__'} = '';
161 }
162
163 $fname = $ARGV[0];
164 $file = &read_file($fname);
165 $file =~ s/__.*?__/exists $configuration{$&} ? $configuration{$&} : $&/seg;
166
167 # At this point, file is in 'blib' and by default
168 # has mode a-w.  Therefore, must change permission
169 # to make it writable.  Note that stat and chmod
170 # (the Perl functions) should work on Win32
171 my $old_perm;
172 $old_perm = (stat $fname)[2] & 07777;
173 my $new_perm = $old_perm | 0200;
174 chmod $new_perm, $fname;
175
176 open(OUTPUT,">$fname") || die "Can't open $fname for write: $!";
177 print OUTPUT $file;
178 close(OUTPUT);
179
180 chmod $old_perm, $fname;
181
182 # Idea taken from perlfaq5
183 sub read_file($) {
184   local(*INPUT,$/);
185   open(INPUT,$_[0]) || die "Can't open $_[0] for read";
186   my $file = <INPUT>;
187   return $file;
188 }
189
190 __END__
191
192
193 =head1 SEE ALSO
194
195 Makefile.PL, ExtUtils::MakeMaker(3)
196
197 =head1 AUTHOR
198
199 MJ Ray mjr at phonecoop.coop
200
201 =cut