Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 1630 lines (1327 sloc) 63.186 kb
d0cc4b2 New installer and exclusions file
slef authored
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
7d99474 Corrected CGI copy to include entire 'installer' subdir structure
Chris Nighswonger authored
20 #
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
21
5befdd2 installer (part 2): more work
Galen Charlton authored
22 use strict;
23 use warnings;
d0cc4b2 New installer and exclusions file
slef authored
24 use ExtUtils::MakeMaker;
25 use POSIX;
44efd0f installer (part 1): started major changes
Galen Charlton authored
26 use File::Spec;
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
27 use Getopt::Long;
d0cc4b2 New installer and exclusions file
slef authored
28
5befdd2 installer (part 2): more work
Galen Charlton authored
29 my $DEBUG = 0;
d0cc4b2 New installer and exclusions file
slef authored
30 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
31
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
32 # Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
33
34 my $dirtree = hashdir('.');
35 my %result = ();
36
d0cc4b2 New installer and exclusions file
slef authored
37 =head1 NAME
38
39 Makefile.PL - Koha packager and installer
40
41 =head1 SYNOPSIS
42
61190e9 @mjray New installation instructions and release notes.
mjray authored
43 =head2 BASIC INSTALLATION
44
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
45 perl Makefile.PL
46 make
47 make test
48 sudo make install
49
50 =head2 UPGRADE INSTALLATION
981a345 Clairifying pod for upgrade and correcting dmake message for Win32
Chris Nighswonger authored
51
52 NOTE: This option is only available if koha-install-log exists.
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
53
54 perl Makefile.PL --prev-install-log /path/to/koha-install-log
55
56 make
57 make test
58 sudo make upgrade
61190e9 @mjray New installation instructions and release notes.
mjray authored
59
60 =head2 PACKAGING RELEASE TARBALLS
61
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
62 make manifest tardist
63 make manifest zipdist
d0cc4b2 New installer and exclusions file
slef authored
64
61190e9 @mjray New installation instructions and release notes.
mjray authored
65 =head2 CLEANING UP
66
67 make clean
68
d0cc4b2 New installer and exclusions file
slef authored
69 =head1 DESCRIPTION
70
44efd0f installer (part 1): started major changes
Galen Charlton authored
71 This is a packager and installer that uses
d0cc4b2 New installer and exclusions file
slef authored
72 ExtUtils::MakeMaker, which is fairly common
73 on perl systems.
74 As well as building tar or zip files
61190e9 @mjray New installation instructions and release notes.
mjray authored
75 and installing with the above commands,
d0cc4b2 New installer and exclusions file
slef authored
76 it allows us to check pre-requisites
77 and generate configuration files.
78
79 =head1 VARIABLES
80
e449c13 @mjray Add configuration file helper to the installer
mjray authored
81 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
d0cc4b2 New installer and exclusions file
slef authored
82
83 Basic metadata about this software.
84
85 =head2 NO_META
86
87 Suppress generation of META.yml file.
88
89 =head2 PREREQ_PM
90
91 Hash of perl modules and versions required.
92
93 =head2 PM
94
95 Hash of file mappings
96
97 =head2 PL_FILES
98
99 This is a hash of PL scripts to run after installation and
100 the files to ask them to generate.
101 Maybe use the values from CONFIGURE
61190e9 @mjray New installation instructions and release notes.
mjray authored
102 to generate initial configuration files in future.
d0cc4b2 New installer and exclusions file
slef authored
103
104 =cut
105
44efd0f installer (part 1): started major changes
Galen Charlton authored
106 =head2 target_map
4b1d132 More work on the installer, just have to fix make now
Chris Cormack authored
107
44efd0f installer (part 1): started major changes
Galen Charlton authored
108 This is a hash mapping directories and files in the
109 source tree to installation target directories. The rules
110 for this mapping are:
4b1d132 More work on the installer, just have to fix make now
Chris Cormack authored
111
44efd0f installer (part 1): started major changes
Galen Charlton authored
112 =over 4
677f10b Working on the installer setting up the right zebra config
Chris Cormack authored
113
44efd0f installer (part 1): started major changes
Galen Charlton authored
114 =item If a directory or file is specified, it and its
115 contents will be copied to the installation target directory.
116
117 =item If a subdirectory of a mapped directory is specified,
118 its target overrides the parent's target for that subdirectory.
119
120 =item The value of each map entry may either be a scalar containing
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
121 one target or a reference to a hash containing 'target' and 'trimdir'
122 keys.
44efd0f installer (part 1): started major changes
Galen Charlton authored
123
124 =item Any files at the top level of the source tree that are
125 not included in the map will not be installed.
126
127 =item Any directories at the top level of the source tree
128 that are not included in the map will be installed in
129 INTRANET_CGI_DIR. This is a sensible default given the
130 current organization of the source tree, but (FIXME) it
131 would be better to reorganize the source tree to better
132 match the installation system, to allow adding new directories
133 without having to adjust Makefile.PL each time. The idea
5befdd2 installer (part 2): more work
Galen Charlton authored
134 is to make the C<$target_map> hash as minimal as possible.
44efd0f installer (part 1): started major changes
Galen Charlton authored
135
136 =back
137
138 The permitted installation targets are:
139
140 =over 4
141
142 =item INTRANET_CGI_DIR
143
144 CGI scripts for intranet (staff) interface.
145
146 =item INTRANET_TMPL_DIR
147
148 HTML templates for the intranet interface.
149
150 =item INTRANET_WWW_DIR
151
152 HTML files, images, etc. for DocumentRoot for the intranet interface.
153
154 =item OPAC_CGI_DIR
155
156 CGI scripts for OPAC (public) interface.
157
158 =item OPAC_TMPL_DIR
159
160 HTML templates for the OPAC interface.
161
162 =item OPAC_WWW_DIR
163
164 HTML files, images, etc. for DocumentRoot for the OPAC interface.
165
166 =item PERL_MODULE_DIR
167
168 Perl modules (at present just the C4 modules) that are intimately
169 tied to Koha. Depending on the installation options, these
170 may or may not be installed one of the standard directories
171 in Perl's default @LIB.
172
173 =item KOHA_CONF_DIR
174
175 Directory for Koha configuration files.
176
177 =item ZEBRA_CONF_DIR
178
179 Directory for Zebra configuration files.
180
5befdd2 installer (part 2): more work
Galen Charlton authored
181 =item ZEBRA_LOCK_DIR
182
183 Directory for Zebra's lock files.
184
185 =item ZEBRA_DATA_DIR
186
187 Directory for Zebra's data files.
188
189 =item ZEBRA_RUN_DIR
190
191 Directory for Zebra's UNIX-domain sockets.
192
1b71360 installer: various changes
Galen Charlton authored
193 =item MISC_DIR
5befdd2 installer (part 2): more work
Galen Charlton authored
194
1b71360 installer: various changes
Galen Charlton authored
195 Directory for for miscellaenous scripts, among other
196 things the translation toolkit and RSS feed tools.
5befdd2 installer (part 2): more work
Galen Charlton authored
197
198 =item SCRIPT_DIR
199
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
200 Directory for command-line scripts and daemons to
201 be set up all for installation modes.
202
203 =item SCRIPT_NONDEV_DIR
204
205 Directory for command-line scripts that should
206 be installed in the same directory as the
207 SCRIPT_DIR target except 'dev' installs.
5befdd2 installer (part 2): more work
Galen Charlton authored
208
209 =item MAN_DIR
210
211 Directory for man pages created from POD -- will mostly
212 contain information of interest to Koha developers.
213
214 =item DOC_DIR
215
216 Directory for Koha documentation accessed from the
217 command-line, e.g., READMEs.
218
219 =item LOG_DIR
220
221 Directory for Apache and Zebra logs produced by Koha.
222
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
223 =item PAZPAR2_CONF_DIR
224
225 Directory for PazPar2 configuration files.
226
44efd0f installer (part 1): started major changes
Galen Charlton authored
227 =item NONE
228
229 This is a dummy target used to explicitly state
230 that a given file or directory is not to be installed.
231 This is used either for parts of the installer itself
232 or for development tools that are not applicable to a
233 production installation.
234
235 =back
236
237 =cut
238
5befdd2 installer (part 2): more work
Galen Charlton authored
239 my $target_map = {
240 './about.pl' => 'INTRANET_CGI_DIR',
241 './acqui' => 'INTRANET_CGI_DIR',
242 './admin' => 'INTRANET_CGI_DIR',
243 './authorities' => 'INTRANET_CGI_DIR',
244 './C4' => 'PERL_MODULE_DIR',
245 './C4/SIP/t' => 'NONE',
246 './C4/SIP/koha_test' => 'NONE',
247 './C4/tests' => 'NONE',
248 './catalogue' => 'INTRANET_CGI_DIR',
249 './cataloguing' => 'INTRANET_CGI_DIR',
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
250 './changelanguage.pl' => 'INTRANET_CGI_DIR',
5befdd2 installer (part 2): more work
Galen Charlton authored
251 './check_sysprefs.pl' => 'NONE',
252 './circ' => 'INTRANET_CGI_DIR',
e512077 Tweak offline_circ - honor itemBarcodeInputFilter and add to Makefile.PL
Michael Hafen authored
253 './offline_circ' => 'INTRANET_CGI_DIR',
5befdd2 installer (part 2): more work
Galen Charlton authored
254 './edithelp.pl' => 'INTRANET_CGI_DIR',
255 './etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
256 './etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
257 './etc/pazpar2' => { target => 'PAZPAR2_CONF_DIR', trimdir => -1 },
1b71360 installer: various changes
Galen Charlton authored
258 './help.pl' => 'INTRANET_CGI_DIR',
5befdd2 installer (part 2): more work
Galen Charlton authored
259 './installer-CPAN.pl' => 'NONE',
260 './installer' => 'INTRANET_CGI_DIR',
f53d084 bug 1803 - fix error page handling
Galen Charlton authored
261 './errors' => {target => 'INTRANET_CGI_DIR'},
5befdd2 installer (part 2): more work
Galen Charlton authored
262 './koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
263 './koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
1b71360 installer: various changes
Galen Charlton authored
264 './kohaversion.pl' => 'INTRANET_CGI_DIR',
5befdd2 installer (part 2): more work
Galen Charlton authored
265 './labels' => 'INTRANET_CGI_DIR',
266 './mainpage.pl' => 'INTRANET_CGI_DIR',
267 './Makefile.PL' => 'NONE',
268 './MANIFEST.SKIP' => 'NONE',
269 './members' => 'INTRANET_CGI_DIR',
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
270 './misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
e6ee69b various installer changes
Galen Charlton authored
271 './misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
bbd043f adding three new variables for installation:
Joshua Ferraro authored
272 './misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
1b71360 installer: various changes
Galen Charlton authored
273 './misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
82daf0a installer: added install log
Galen Charlton authored
274 './misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
5befdd2 installer (part 2): more work
Galen Charlton authored
275 './misc/installer_devel_notes' => 'NONE',
276 './opac' => 'OPAC_CGI_DIR',
277 './README.txt' => 'NONE',
278 './reports' => 'INTRANET_CGI_DIR',
279 './reserve' => 'INTRANET_CGI_DIR',
280 './reviews' => 'INTRANET_CGI_DIR',
281 './rewrite-config.PL' => 'NONE',
282 './reviews' => 'INTRANET_CGI_DIR',
283 './serials' => 'INTRANET_CGI_DIR',
190a7f4 installer: created skel directory
Galen Charlton authored
284 './skel' => 'NONE',
ca8f75e installer: KOHA_LOG_DIR => LOG_DIR
Galen Charlton authored
285 './skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
190a7f4 installer: created skel directory
Galen Charlton authored
286 './skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
287 './skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
288 './skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
289 './skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
290 './skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
291 './skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
292 './skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
293 './skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
294 './skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
295 './skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
296 './skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
5befdd2 installer (part 2): more work
Galen Charlton authored
297 './sms' => 'INTRANET_CGI_DIR',
298 './suggestion' => 'INTRANET_CGI_DIR',
299 './svc' => 'INTRANET_CGI_DIR',
300 './t' => 'NONE',
3efe32e bug 2305: install tags/* to intranet CGI directory
Galen Charlton authored
301 './tags' => 'INTRANET_CGI_DIR',
1b71360 installer: various changes
Galen Charlton authored
302 './tmp' => 'NONE', # FIXME need to determine whether
303 # Koha generates any persistent temp files
304 # that should go in /var/tmp/koha
5befdd2 installer (part 2): more work
Galen Charlton authored
305 './tools' => 'INTRANET_CGI_DIR',
306 './virtualshelves' => 'INTRANET_CGI_DIR',
307 # ignore files and directories created by the install itself
308 './pm_to_blib' => 'NONE',
309 './blib' => 'NONE',
310 };
44efd0f installer (part 1): started major changes
Galen Charlton authored
311
312 =head1 CONFIGURATION OPTIONS
313
314 The following configuration options are used by the installer.
315
316 =over 4
317
318 =item INSTALL_MODE
319
320 Specifies whether installation will be FHS-compliant (default,
321 assumes user has root), put everything under
322 a single directory (for users installing on a web host
323 that allows CGI scripts and a MySQL database but not root
324 access), or development (for a developer who wants to run
325 Koha from a git clone with no fuss).
326
327 =item INSTALL_BASE
d0cc4b2 New installer and exclusions file
slef authored
328
44efd0f installer (part 1): started major changes
Galen Charlton authored
329 Directory under which most components will go. Default
330 value will vary depending on INSTALL_MODE.
331
1b71360 installer: various changes
Galen Charlton authored
332 =item DB_TYPE
333
334 Type of DBMS (e.g., mysql or Pg).
335
336 =item DB_HOST
337
338 Name of DBMS server.
339
340 =item DB_PORT
341
342 Port that DBMS server is listening on.
343
344 =item DB_NAME
345
346 Name of the DBMS database for Koha.
347
348 =item DB_USER
349
350 Name of DBMS user account for Koha's database.
351
352 =item DB_PASS
353
354 Pasword of DMBS user account for Koha's database.
355
44efd0f installer (part 1): started major changes
Galen Charlton authored
356 =item INSTALL_ZEBRA
357
358 Whether to install Zebra configuration files and data
359 directories.
360
361 =item ZEBRA_MARC_FORMAT
362
363 Specifies format of MARC records to be indexed by Zebra.
364
365 =item ZEBRA_LANGUAGE
366
367 Specifies primary language of records that will be
368 indexed by Zebra.
369
1b71360 installer: various changes
Galen Charlton authored
370 =item ZEBRA_USER
371
372 Internal Zebra user account for the index.
373
374 =item ZEBRA_PASS
375
376 Internal Zebra user account's password.
377
378 =item KOHA_USER
379
380 System user account that will own Koha's files.
381
382 =item KOHA_GROUP
383
384 System group that will own Koha's files.
385
44efd0f installer (part 1): started major changes
Galen Charlton authored
386 =back
387
388 =cut
389
390 # default configuration options
391 my %config_defaults = (
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
392 'DB_TYPE' => 'mysql',
393 'DB_HOST' => 'localhost',
394 'DB_NAME' => 'koha',
395 'DB_USER' => 'kohaadmin',
396 'DB_PASS' => 'katikoan',
44efd0f installer (part 1): started major changes
Galen Charlton authored
397 'INSTALL_ZEBRA' => 'yes',
bbd043f adding three new variables for installation:
Joshua Ferraro authored
398 'INSTALL_SRU' => 'yes',
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
399 'INSTALL_PAZPAR2' => 'no',
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
400 'AUTH_INDEX_MODE' => 'grs1',
44efd0f installer (part 1): started major changes
Galen Charlton authored
401 'ZEBRA_MARC_FORMAT' => 'marc21',
402 'ZEBRA_LANGUAGE' => 'en',
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
403 'ZEBRA_USER' => 'kohauser',
404 'ZEBRA_PASS' => 'zebrastripes',
bbd043f adding three new variables for installation:
Joshua Ferraro authored
405 'ZEBRA_SRU_HOST' => 'localhost',
406 'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
407 'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
be79314 installer: start support for non-root file owner
Galen Charlton authored
408 'KOHA_USER' => 'koha',
409 'KOHA_GROUP' => 'koha',
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
410 'MERGE_SERVER_HOST' => 'localhost',
411 'MERGE_SERVER_PORT' => '11001',
412 'PAZPAR2_HOST' => 'localhost',
413 'PAZPAR2_PORT' => '11002',
8056846 @amoore improvements to automated tests, including a testing database
amoore authored
414 'RUN_DATABASE_TESTS' => 'no',
2fafa14 kohabug 1776 - try to locate Zebra during install
Galen Charlton authored
415 'PATH_TO_ZEBRA' => '',
44efd0f installer (part 1): started major changes
Galen Charlton authored
416 );
417
e64f395 @Elwell Minor documentation typos
Elwell authored
418 # set some default configuration options based on OS
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
419 # more conditions need to be added for other OS's
420 # this should probably also incorporate usage of Win32::GetOSName() and/or Win32::GetOSVersion()
421 # to allow for more granular decisions based on which Win32 platform
422
423 warn "Your platform appears to be $^O.\n" if $DEBUG;
424
425 if ( $^O eq 'MSWin32' ) {
426 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
427 # this could be changed to put some files (ie. libraries) into system32, etc.
428 $config_defaults{'INSTALL_MODE'} = 'single';
429 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
430 }
431 elsif ( $^O eq 'cygwin' ) {
432 # Most Unix2Win32 ports seem to poke everything into the Program Files directory
433 # this could be changed to put some files (ie. libraries) into system32, etc.
434 $config_defaults{'INSTALL_MODE'} = 'single';
435 $config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
436 }
437 else {
438 $config_defaults{'INSTALL_MODE'} = 'standard';
439 $config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
440 }
441
44efd0f installer (part 1): started major changes
Galen Charlton authored
442 # valid values for certain configuration options
443 my %valid_config_values = (
444 'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
445 'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
44efd0f installer (part 1): started major changes
Galen Charlton authored
446 'INSTALL_ZEBRA' => { 'yes' => 1, 'no' => 1 },
bbd043f adding three new variables for installation:
Joshua Ferraro authored
447 'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
448 'AUTH_INDEX_MODE' => { 'grs1' => 1, 'dom' => 1 },
44efd0f installer (part 1): started major changes
Galen Charlton authored
449 'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
450 'ZEBRA_LANGUAGE' => { 'en' => 1, 'fr' => 1 }, # FIXME should generate from contents of distribution
8056846 @amoore improvements to automated tests, including a testing database
amoore authored
451 'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
44efd0f installer (part 1): started major changes
Galen Charlton authored
452 );
453
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
454 # get settings from command-line
455 my $koha_install_log = "";
456 Getopt::Long::Configure('pass_through');
457 my $results = GetOptions(
458 "prev-install-log=s" => \$koha_install_log
459 );
460
461 my %install_log_values = ();
462 if ($koha_install_log ne "") {
463 get_install_log_values($koha_install_log, \%install_log_values);
464 }
465
466 my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
1b71360 installer: various changes
Galen Charlton authored
467 my ($target_directories, $skip_directories) = get_target_directories(\%config);
468 display_configuration(\%config, $target_directories);
5befdd2 installer (part 2): more work
Galen Charlton authored
469 my $file_map = {};
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
470 get_file_map($target_map, $dirtree, $file_map, $config{'INSTALL_ZEBRA'} eq "yes" ? 1: 0);
471
472 my $pl_files = {
473 'rewrite-config.PL' => [
474 'blib/KOHA_CONF_DIR/koha-conf.xml',
82daf0a installer: added install log
Galen Charlton authored
475 'blib/KOHA_CONF_DIR/koha-httpd.conf',
476 'blib/MISC_DIR/koha-install-log'
4c991a4 Win32 support: Moved shebang sub to separate script to be called in pl_f...
Chris Nighswonger authored
477 ],
478 'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
479 'blib'
480 ]
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
481 };
482
483 if ($config{'INSTALL_ZEBRA'} eq "yes") {
484 push @{ $pl_files->{'rewrite-config.PL'} }, (
f5903fb installer: location of koha-conf.xml
Galen Charlton authored
485 'blib/ZEBRA_CONF_DIR/etc/passwd',
486 'blib/ZEBRA_CONF_DIR/zebra-biblios.cfg',
bbd043f adding three new variables for installation:
Joshua Ferraro authored
487 'blib/ZEBRA_CONF_DIR/zebra-authorities.cfg',
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
488 'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
bbd043f adding three new variables for installation:
Joshua Ferraro authored
489 'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
490 'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
491 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-grs1.xml',
492 'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
f5903fb installer: location of koha-conf.xml
Galen Charlton authored
493 );
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
494 push @{ $pl_files->{'rewrite-config.PL'} }, (
495 'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
496 'blib/SCRIPT_DIR/koha-pazpar2-ctl.sh',
497 'blib/SCRIPT_DIR/koha-zebraqueue-ctl.sh',
498 );
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
499 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
500 push @{ $pl_files->{'rewrite-config.PL'} }, (
501 'blib/PAZPAR2_CONF_DIR/koha-biblios.xml',
502 'blib/PAZPAR2_CONF_DIR/pazpar2.xml'
503 );
504 }
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
505 $config{'ZEBRA_AUTH_CFG'} = $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'zebra-authorities-dom.cfg' : 'zebra-authorities.cfg';
506 $config{'AUTH_RETRIEVAL_CFG'} =
507 $config{'AUTH_INDEX_MODE'} eq 'dom' ? 'retrieval-info-auth-dom.xml' : 'retrieval-info-auth-grs1.xml';
f5903fb installer: location of koha-conf.xml
Galen Charlton authored
508 }
509
510 if ($config{'INSTALL_MODE'} ne "dev") {
511 push @{ $pl_files->{'rewrite-config.PL'} }, (
b8a58c4 installer: command-line scripts improve finding C4 modules
Galen Charlton authored
512 'blib/PERL_MODULE_DIR/C4/Context.pm',
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
513 'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
514 );
515 }
44efd0f installer (part 1): started major changes
Galen Charlton authored
516
33036c4 test suite - various changes
Galen Charlton authored
517 my %test_suite_override_dirs = (
518 KOHA_CONF_DIR => ['etc'],
519 ZEBRA_CONF_DIR => ['etc', 'zebradb'],
520 LOG_DIR => ['var', 'log'],
521 SCRIPT_DIR => ['bin'],
522 ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
523 ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
524 ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
525 );
526
44efd0f installer (part 1): started major changes
Galen Charlton authored
527 WriteMakefile(
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
528 NAME => 'koha',
529 #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
530 VERSION_FROM => 'kohaversion.pl',
531 ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
532 AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
533 NO_META => 1,
534 PREREQ_PM => {
50533a1 @Elwell Consistency check between Makefile.pl and about.pl We weren't picking up...
Elwell authored
535 'Algorithm::CheckDigits' => 0.50,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
536 'Biblio::EndnoteStyle' => 0.05,
537 'CGI' => 3.15,
538 'CGI::Carp' => 1.29,
50533a1 @Elwell Consistency check between Makefile.pl and about.pl We weren't picking up...
Elwell authored
539 'CGI::Session' => 4.20,
540 'CGI::Session::Serialize::yaml' => 4.20,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
541 'Class::Factory::Util' => 1.6,
542 'Class::Accessor' => 0.30,
543 'DBD::mysql' => 4.004,
6c0dbfb offline_circ must use SQLite v2 - because Kyles PHP does
Michael Hafen authored
544 'DBD::SQLite2' => 0.33, # optional, used for offline circulation
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
545 'DBI' => 1.53,
546 'Data::Dumper' => 2.121,
50533a1 @Elwell Consistency check between Makefile.pl and about.pl We weren't picking up...
Elwell authored
547 'Data::ICal' => 0.13,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
548 'Date::Calc' => 5.4,
549 'Date::ICal' => 1.72,
550 'Date::Manip' => 5.44,
551 'Digest::MD5' => 2.36,
54f7ca4 @laurenthdl bug 3204: implement request signing for Amazon Web Services
laurenthdl authored
552 'Digest::SHA' => 5.43,
f896384 @PaulPoulain Adding Email::Date dependancy, requested by MIME::Lite
PaulPoulain authored
553 'Email::Date' => 1.103,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
554 'File::Temp' => 0.16,
639a3cf kohabug 2457 Minor patch to correct GD
Chris Nighswonger authored
555 'GD' => 2.39, #optional
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
556 'GD::Barcode::UPCE' => 1.1,
557 'Getopt::Long' => 2.35,
558 'Getopt::Std' => 1.05,
559 'HTML::Template::Pro' => 0.69,
560 'HTML::Scrubber' => 0.08,
561 'HTTP::Cookies' => 1.39,
9c4a717 added dependencies for new OAI-PMH server
Galen Charlton authored
562 'HTTP::OAI' => 3.20,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
563 'HTTP::Request::Common' => 1.26,
5cd357e @gmcharlt bug 3465: enhance DB update reporting by web installer
gmcharlt authored
564 'IPC::Cmd' => 0.46,
50533a1 @Elwell Consistency check between Makefile.pl and about.pl We weren't picking up...
Elwell authored
565 'JSON' => 2.07, # Needed by admin/item_circulation_alerts.pl
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
566 'LWP::Simple' => 1.41,
567 'LWP::UserAgent' => 2.033,
568 'Lingua::Stem' => 0.82,
569 'List::Util' => 1.18,
570 'List::MoreUtils' => 0.21,
571 'Locale::Language' => 2.07,
572 'MARC::Charset' => 0.98,
573 'MARC::Crosswalk::DublinCore' => 0.02,
574 'MARC::File::XML' => 0.88,
575 'MARC::Record' => 2.00,
576 'MIME::Base64' => 3.07,
d0c0df9 @amoore Bug 2274: reducing MIME::Lite requirement to 3.0
amoore authored
577 'MIME::Lite' => 3.00,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
578 'MIME::QuotedPrint' => 3.07,
579 'Mail::Sendmail' => 0.79,
4bc2303 @mjray Note optional modules, for later reference.
mjray authored
580 'Net::LDAP' => 0.33, # optional
581 'Net::LDAP::Filter' => 0.14, # optional
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
582 'Net::Z3950::ZOOM' => 1.16,
583 'PDF::API2' => 2.000,
584 'PDF::API2::Page' => 2.000,
585 'PDF::API2::Util' => 2.000,
586 'PDF::Reuse' => 0.33,
587 'PDF::Reuse::Barcode' => 0.05,
588 'POE' => 0.9999,
589 'POSIX' => 1.09,
590 'Schedule::At' => 1.06,
4bc2303 @mjray Note optional modules, for later reference.
mjray authored
591 'SMS::Send' => 0.05, # optional
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
592 'Term::ANSIColor' => 1.10,
593 'Test' => 1.25,
594 'Test::Harness' => 2.56,
595 'Test::More' => 0.62,
596 'Text::CSV' => 0.01,
597 'Text::CSV_XS' => 0.32,
598 'Text::Iconv' => 1.7,
599 'Text::Wrap' => 2005.082401,
600 'Time::HiRes' => 1.86,
601 'Time::localtime' => 1.02,
602 'Unicode::Normalize' => 0.32,
54f7ca4 @laurenthdl bug 3204: implement request signing for Amazon Web Services
laurenthdl authored
603 'URI::Escape' => 1.36,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
604 'XML::Dumper' => 0.81,
605 'XML::LibXML' => 1.59,
606 'XML::LibXSLT' => 1.59,
607 'XML::SAX::ParserFactory' => 1.01,
9c4a717 added dependencies for new OAI-PMH server
Galen Charlton authored
608 'XML::SAX::Writer' => 0.44,
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
609 'XML::Simple' => 2.14,
610 'XML::RSS' => 1.31,
611 'YAML::Syck' => 0.71,
612 },
613
614 # File tree mapping
615 PM => $file_map,
616
617 # Man pages generated from POD
9087249 @vdanjean Add support for DESTDIR
vdanjean authored
618 # ExtUtils::MakeMaker already manage $(DESTDIR)
619 INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
620 INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
11aed99 @amoore Bug 2176: adding SMS::Send to list of dependencies
amoore authored
621
622 PL_FILES => $pl_files,
d0cc4b2 New installer and exclusions file
slef authored
623 );
624
625 =head1 FUNCTIONS
626
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
627 =head2 hashdir
d0cc4b2 New installer and exclusions file
slef authored
628
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
629 This function recurses through the directory structure and builds
630 a hash of hashes containing the structure with arrays holding filenames.
631 This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
d0cc4b2 New installer and exclusions file
slef authored
632
633 =cut
634
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
635 sub hashdir{
636 my $dir = shift;
637 opendir my $dh, $dir or die $!;
638 my $tree = {}->{$dir} = {};
639 while( my $file = readdir($dh) ) {
61ca8a3 installer: use htdocs instead of www; handle .htaccess
Galen Charlton authored
640 next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
faaf13a Cleaned up recursion routine a bit
Chris Nighswonger authored
641 my $path = $dir .'/' . $file;
642 $tree->{$file} = hashdir($path), next if -d $path;
643 push @{$tree->{'.'}}, $file;
644 }
645 return $tree;
646 }
d0cc4b2 New installer and exclusions file
slef authored
647
5befdd2 installer (part 2): more work
Galen Charlton authored
648 =head2 get_file_map
649
650 This function combines the target_map and file hash to
651 map each source file to its destination relative to
652 the set of installation targets.
653
654 Output will be a hash mapping from each source file
655 to its destination value, like this:
656
657 'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
658
659 =cut
660
661 sub get_file_map {
662 my $target_map = shift;
663 my $dirtree = shift;
664 my $file_map = shift;
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
665 my $install_zebra = shift;
5befdd2 installer (part 2): more work
Galen Charlton authored
666 my $curr_path = @_ ? shift : ['.'];
667
668 # Traverse the directory tree.
669 # For each file or directory, identify the
670 # most specific match in the target_map
671 foreach my $dir (sort keys %{ $dirtree }) {
672 if ($dir eq '.') {
673 # deal with files in directory
674 foreach my $file (sort @{ $dirtree->{$dir} }) {
675 my $targetdir = undef;
676 my $matchlevel = undef;
677 # first, see if there is a match on this specific
678 # file in the target map
679 my $filepath = join("/", @$curr_path, $file);
680 if (exists $target_map->{$filepath}) {
681 $targetdir = $target_map->{$filepath};
682 $matchlevel = scalar(@$curr_path) + 1;
683 } else {
684 # no match on the specific file; look for
685 # a directory match
686 for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
687 my $dirpath = join("/", @$curr_path[0..$i]);
688 if (exists $target_map->{$dirpath}) {
689 $targetdir = $target_map->{$dirpath};
690 $matchlevel = $i + 1;
691 last;
692 }
693 }
694 }
695 if (defined $targetdir) {
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
696 _add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel, $install_zebra);
5befdd2 installer (part 2): more work
Galen Charlton authored
697 } else {
698 my $path = join("/", @$curr_path);
699 print "failed to map: $path/$file\n" if $DEBUG;
700 }
701 }
702 } else {
703 # dealing with subdirectory
704 push @$curr_path, $dir;
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
705 get_file_map($target_map, $dirtree->{$dir}, $file_map, $install_zebra, $curr_path);
5befdd2 installer (part 2): more work
Galen Charlton authored
706 pop @$curr_path;
707 }
708 }
709 }
710
711 sub _add_to_file_map {
712 my $file_map = shift;
713 my $targetdir = shift;
714 my $curr_path = shift;
715 my $file = shift;
716 my $matchlevel = shift;
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
717 my $install_zebra = shift;
5befdd2 installer (part 2): more work
Galen Charlton authored
718 my $dest_path = @_ ? shift : $curr_path;
719
720 # The target can be one of the following:
721 # 1. scalar representing target symbol
722 # 2. hash ref containing target and trimdir keys
723 #
724 # Consequently, this routine traverses this structure,
725 # calling itself recursively, until it deals with
726 # all of the scalar target symbols.
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
727 if (ref $targetdir eq 'HASH') {
5befdd2 installer (part 2): more work
Galen Charlton authored
728 my $subtarget = $targetdir->{target};
729 if (exists $targetdir->{trimdir}) {
730 # if we get here, we've specified that
731 # rather than installing the file to
732 # $(TARGET)/matching/dirs/subdirs/file,
733 # we want to install it to
734 # $(TARGET)/subdirs/file
735 #
736 # Note that this the only place where
737 # $matchlevel is used.
738 my @new_dest_path = @$dest_path;
739 if ($targetdir->{trimdir} == -1) {
740 splice @new_dest_path, 0, $matchlevel;
741 } else {
742 splice @new_dest_path, 0, $targetdir->{trimdir};
743 }
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
744 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra, \@new_dest_path);
5befdd2 installer (part 2): more work
Galen Charlton authored
745 } else {
746 # actually getting here means that the
747 # target was unnecessarily listed
748 # as a hash, but we'll forgive that
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
749 _add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, $install_zebra);
5befdd2 installer (part 2): more work
Galen Charlton authored
750 }
751 } elsif ($targetdir ne 'NONE' and $targetdir ne '') {
752 my $source = File::Spec->catfile(@$curr_path, $file);
753 my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
754 #print "$source => $destination\n"; # DEBUG
eebd56b install: handle spaces in file names
Galen Charlton authored
755 # quote spaces in file names
756 # FIXME: this is of questionable portability and
757 # probably depends on user's make recognizing this
758 # quoting syntax -- probably better to remove
759 # spaces and shell metacharacters from all file names
760 $source =~ s/ /\\ /g;
761 $destination =~ s/ /\\ /g;
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
762
763 $file_map->{$source} = $destination unless (!$install_zebra and $targetdir =~ /ZEBRA/);
5befdd2 installer (part 2): more work
Galen Charlton authored
764 }
765 }
766
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
767 =head2 get_install_log_values
768
769 Reads value from the Koha install log specified by
770 --prev-install-log
771
772 =cut
773
774 sub get_install_log_values {
775 my $install_log = shift;
776 my $values = shift;
777
778 open LOG, "<$install_log" or die "Cannot open install log $install_log: $!\n";
779 while (<LOG>) {
780 chomp;
781 next if /^#/ or /^\s*$/;
782 next if /^=/;
783 next unless m/=/;
25e1b9e installer: added 'make upgrade' target
Galen Charlton authored
784 s/\s+$//g;
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
785 my ($key, $value) = split /=/, $_, 2;
786 $values->{$key} = $value;
787 }
788 close LOG;
789
790 print <<_EXPLAIN_INSTALL_LOG_;
791 Reading values from install log $install_log. You
792 will be prompted only for settings that have been
793 added since the last time you installed Koha. To
794 be prompted for all settings, run 'perl Makefile.PL'
795 without the --prev-install-log option.
796 _EXPLAIN_INSTALL_LOG_
797 }
798
5d6cc9c Makefile.PL - trivial perldoc correction
Joe Atzberger authored
799 =head2 get_configuration
44efd0f installer (part 1): started major changes
Galen Charlton authored
800
801 This prompts the user for various configuration options.
802
803 =cut
804
805 sub get_configuration {
806 my $defaults = shift;
807 my $valid_values = shift;
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
808 my $install_log_values = shift;
44efd0f installer (part 1): started major changes
Galen Charlton authored
809 my %config = ();
810
811 my $msg = q(
812 By default, Koha can be installed in one of three ways:
813
814 standard: Install files in conformance with the Filesystem
815 Hierarchy Standard (FHS). This is the default mode
816 and should be used when installing a production
817 Koha system. On Unix systems, root access is
818 needed to complete a standard installation.
819
820 single: Install files under a single directory. This option
821 is useful for installing Koha without root access, e.g.,
822 on a web host that allows CGI scripts and MySQL databases
823 but requires the user to keep all files under the user's
824 HOME directory.
825
826 dev: Create a set of symbolic links and configuration files to
827 allow Koha to run directly from the source distribution.
828 This mode is useful for developers who want to run
829 Koha from a git clone.
830
d7a09ca installer: modified wording of some questions
Galen Charlton authored
831 Installation mode);
44efd0f installer (part 1): started major changes
Galen Charlton authored
832 $msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
833 $config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
44efd0f installer (part 1): started major changes
Galen Charlton authored
834
835 # set message and default value for INSTALL_BASE
836 # depending on value of INSTALL_MODE
837 my $install_base_default = $defaults->{'INSTALL_BASE'};
838 if ($config{'INSTALL_MODE'} eq 'dev') {
839 $msg = q(
840 Please specify the directory in which to install Koha's
841 active configuration files and (if applicable) the
842 Zebra database. Koha's CGI scripts and templates will
d7a09ca installer: modified wording of some questions
Galen Charlton authored
843 be run from the current directory.
844
845 Configuration directory:);
44efd0f installer (part 1): started major changes
Galen Charlton authored
846 # FIXME - home directory portability consideration apply
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
847 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha-dev" : "$defaults->{'INSTALL_BASE'}-dev";
44efd0f installer (part 1): started major changes
Galen Charlton authored
848 } elsif ($config{'INSTALL_MODE'} eq 'single') {
849 $msg = "\nPlease specify the directory in which to install Koha";
850 # FIXME -- we're assuming under a 'single' mode install
851 # that user will likely want to install under the home
852 # directory. This is OK in and of itself, but we should
853 # use File::HomeDir to locate the home directory portably.
854 # This is deferred for now because File::HomeDir is not yet
855 # core.
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
856 # --we must also keep this portable to the major OS's -fbcit
857 $install_base_default = (exists $ENV{'HOME'}) ? "$ENV{'HOME'}/koha" : $defaults->{'INSTALL_BASE'};
44efd0f installer (part 1): started major changes
Galen Charlton authored
858 } else {
859 # must be standard
860 $msg = q(
861 Please specify the directory under which most Koha files
862 will be installed.
863
864 Note that if you are planning in installing more than
865 one instance of Koha, you may want to modify the last
866 component of the directory path, which will be used
d7a09ca installer: modified wording of some questions
Galen Charlton authored
867 as the package name in the FHS layout.
868
869 Base installation directory);
44efd0f installer (part 1): started major changes
Galen Charlton authored
870 }
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
871 $config{'INSTALL_BASE'} = _get_value('INSTALL_BASE', $msg, $install_base_default, $valid_values, $install_log_values);
44efd0f installer (part 1): started major changes
Galen Charlton authored
872
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
873 $config{'INSTALL_BASE'} = File::Spec->rel2abs($config{'INSTALL_BASE'});
874 print "INSTALL_BASE=$config{'INSTALL_BASE'}\r\n" if $DEBUG;
be79314 installer: start support for non-root file owner
Galen Charlton authored
875 if ($config{'INSTALL_MODE'} eq "standard") {
876 $msg = q(
877 Since you are using the 'standard' install
878 mode, you should run 'make install' as root.
879 However, it is recommended that a non-root
880 user (on Unix and Linux platforms) have
881 ownership of Koha's files, including the
882 Zebra indexes if applicable.
883
884 Please specify a user account. This
885 user account does not need to exist
886 right now, but it needs to exist
887 before you run 'make install'. Please
888 note that for security reasons, this
889 user should not be the same as the user
890 account Apache runs under.
891
892 User account);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
893 $config{'KOHA_USER'} = _get_value('KOHA_USER', $msg, $defaults->{'KOHA_USER'}, $valid_values, $install_log_values);
be79314 installer: start support for non-root file owner
Galen Charlton authored
894
895 $msg = q(
896 Please specify the group that should own
897 Koha's files. As above, this group need
898 not exist right now, but should be created
899 before you run 'make install'.
900
901 Group);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
902 $config{'KOHA_GROUP'} = _get_value('KOHA_GROUP', $msg, $defaults->{'KOHA_GROUP'}, $valid_values, $install_log_values);
be79314 installer: start support for non-root file owner
Galen Charlton authored
903 }
904
44efd0f installer (part 1): started major changes
Galen Charlton authored
905 $msg = q(
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
906 Please specify which database engine you will use
907 to store data in Koha. The choices are MySQL and
908 PostgreSQL; please note that at the moment
909 PostgreSQL support is highly experimental.
910
911 DBMS to use);
912 $msg .= _add_valid_values_disp('DB_TYPE', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
913 $config{'DB_TYPE'} = _get_value('DB_TYPE', $msg, $defaults->{'DB_TYPE'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
914
915 $msg = q(
916 Please specify the name or address of your
917 database server. Note that the database
918 does not have to exist at this point, it
919 can be created after running 'make install'
920 and before you try using Koha for the first time.
921
922 Database server);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
923 $config{'DB_HOST'} = _get_value('DB_HOST', $msg, $defaults->{'DB_HOST'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
924
925 $msg = q(
926 Please specify the port used to connect to the
927 DMBS);
928 my $db_port_default = $config{'DB_TYPE'} eq 'mysql' ? '3306' : '5432';
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
929 $config{'DB_PORT'} = _get_value('DB_PORT', $msg, $db_port_default, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
930
931 $msg = q(
932 Please specify the name of the database to be
933 used by Koha);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
934 $config{'DB_NAME'} = _get_value('DB_NAME', $msg, $defaults->{'DB_NAME'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
935
936 $msg = q(
937 Please specify the user that owns the database to be
938 used by Koha);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
939 $config{'DB_USER'} = _get_value('DB_USER', $msg, $defaults->{'DB_USER'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
940
941 $msg = q(
942 Please specify the password of the user that owns the
943 database to be used by Koha);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
944 $config{'DB_PASS'} = _get_value('DB_PASS', $msg, $defaults->{'DB_PASS'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
945
946 $msg = q(
44efd0f installer (part 1): started major changes
Galen Charlton authored
947 Koha can use the Zebra search engine for high-performance
948 searching of bibliographic and authority records. If you
949 have installed the Zebra software and would like to use it,
950 please answer 'yes' to the following question. Otherwise,
951 Koha will default to using its internal search engine.
952
3b58e09 installer: now respects INSTALL_ZEBRA = no
Galen Charlton authored
953 Please note that if you choose *NOT* to install Zebra,
954 koha-conf.xml will still contain some references to Zebra
955 settings. Those references will be ignored by Koha.
956
d7a09ca installer: modified wording of some questions
Galen Charlton authored
957 Install the Zebra configuration files?);
44efd0f installer (part 1): started major changes
Galen Charlton authored
958 $msg .= _add_valid_values_disp('INSTALL_ZEBRA', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
959 $config{'INSTALL_ZEBRA'} = _get_value('INSTALL_ZEBRA', $msg, $defaults->{'INSTALL_ZEBRA'}, $valid_values, $install_log_values);
44efd0f installer (part 1): started major changes
Galen Charlton authored
960
961 if ($config{'INSTALL_ZEBRA'} eq 'yes') {
2fafa14 kohabug 1776 - try to locate Zebra during install
Galen Charlton authored
962
963 if (defined(my $zebra_path = find_zebra())) {
964 $config{'PATH_TO_ZEBRA'} = $zebra_path;
965 print qq(
966 Found 'zebrasrv' and 'zebraidx' in $zebra_path.
967 );
968 } else {
969 print q(
970 Unable to find the Zebra programs 'zebrasrv' and 'zebraidx'
971 in your PATH or in some of the usual places. If you haven't
972 installed Zebra yet, please do so and run Makefile.PL again.
973
974 );
975 }
976
44efd0f installer (part 1): started major changes
Galen Charlton authored
977 $msg = q(
978 Since you've chosen to use Zebra with Koha,
979 you must specify the primary MARC format of the
980 records to be indexed by Zebra.
981
982 Koha provides Zebra configuration files for MARC 21
983 and UNIMARC.
984
d7a09ca installer: modified wording of some questions
Galen Charlton authored
985 MARC format for Zebra indexing);
44efd0f installer (part 1): started major changes
Galen Charlton authored
986 $msg .= _add_valid_values_disp('ZEBRA_MARC_FORMAT', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
987 $config{'ZEBRA_MARC_FORMAT'} = _get_value('ZEBRA_MARC_FORMAT', $msg, $defaults->{'ZEBRA_MARC_FORMAT'}, $valid_values, $install_log_values);
44efd0f installer (part 1): started major changes
Galen Charlton authored
988 $msg = q(
989 Koha supplies Zebra configuration files tuned for
990 searching either English (en) or French (fr) MARC
991 records.
992
d7a09ca installer: modified wording of some questions
Galen Charlton authored
993 Primary language for Zebra indexing);
44efd0f installer (part 1): started major changes
Galen Charlton authored
994 $msg .= _add_valid_values_disp('ZEBRA_LANGUAGE', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
995 $config{'ZEBRA_LANGUAGE'} = _get_value('ZEBRA_LANGUAGE', $msg, $defaults->{'ZEBRA_LANGUAGE'}, $valid_values, $install_log_values);
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
996
997 $msg = q(
998 Koha can use one of two different indexing modes
999 for the MARC authorities records:
1000
1001 grs1 - uses the Zebra GRS-1 filter, available
1002 for legacy support
1003 dom - uses the DOM XML filter; offers improved
1004 functionality.
1005
1006 Authorities indexing mode);
1007 $msg .= _add_valid_values_disp('AUTH_INDEX_MODE', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1008 $config{'AUTH_INDEX_MODE'} = _get_value('AUTH_INDEX_MODE', $msg, $defaults->{'AUTH_INDEX_MODE'}, $valid_values, $install_log_values);
1c0401e authorities - enabled DOM indexing
Galen Charlton authored
1009
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1010 $msg = q(
1011 Please specify Zebra database user);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1012 $config{'ZEBRA_USER'} = _get_value('ZEBRA_USER', $msg, $defaults->{'ZEBRA_USER'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1013
1014 $msg = q(
1015 Please specify the Zebra database password);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1016 $config{'ZEBRA_PASS'} = _get_value('ZEBRA_PASS', $msg, $defaults->{'ZEBRA_PASS'}, $valid_values, $install_log_values);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1017
bbd043f adding three new variables for installation:
Joshua Ferraro authored
1018 $msg = q(
1019 Since you've chosen to use Zebra, you can enable the SRU/
1020 Z39.50 Server if you so choose, but you must specify a
1021 few configuration options for it.
1022
1023 Please note that if you choose *NOT* to configure SRU,
1024 koha-conf.xml will still contain some references to SRU
1025 settings. Those references will be ignored by Koha.
1026
1027 Install the SRU configuration files?);
1028 $msg .= _add_valid_values_disp('INSTALL_SRU', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1029 $config{'INSTALL_SRU'} = _get_value('INSTALL_SRU', $msg, $defaults->{'INSTALL_SRU'}, $valid_values, $install_log_values);
bbd043f adding three new variables for installation:
Joshua Ferraro authored
1030
1031 if ($config{'INSTALL_SRU'} eq 'yes') {
1032 $msg = q(
1033 Since you've chosen to configure SRU, you must
1034 specify the host and port(s) that the SRU
1035 Servers (bibliographic and authority) should run on.
1036 );
1037 $msg = q(
1038 SRU Database host?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1039 $config{'ZEBRA_SRU_HOST'} = _get_value('ZEBRA_SRU_HOST', $msg, $defaults->{'ZEBRA_SRU_HOST'}, $valid_values, $install_log_values);
bbd043f adding three new variables for installation:
Joshua Ferraro authored
1040
1041 $msg = q(
1042 SRU port for bibliographic data?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1043 $config{'ZEBRA_SRU_BIBLIOS_PORT'} = _get_value('ZEBRA_SRU_BIBLIOS_PORT', $msg, $defaults->{'ZEBRA_SRU_BIBLIOS_PORT'}, $valid_values, $install_log_values);
bbd043f adding three new variables for installation:
Joshua Ferraro authored
1044
1045 $msg = q(
1046 SRU port for authority data?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1047 $config{'ZEBRA_SRU_AUTHORITIES_PORT'} = _get_value('ZEBRA_SRU_AUTHORITIES_PORT', $msg, $defaults->{'ZEBRA_SRU_AUTHORITIES_PORT'}, $valid_values, $install_log_values);
bbd043f adding three new variables for installation:
Joshua Ferraro authored
1048
1049 }
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1050
1051 $msg = q(
1052 Since you've chosen to use Zebra, you can also choose to
1053 install PazPar2, which is a metasearch tool. With PazPar2,
1054 Koha can perform on-the-fly merging of bibliographic
1055 records during searching, allowing for FRBRization of
1056 the results list.
1057
1058 Install the PazPar2 configuration files?);
1059 $msg .= _add_valid_values_disp('INSTALL_PAZPAR2', $valid_values);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1060 $config{'INSTALL_PAZPAR2'} = _get_value('INSTALL_PAZPAR2', $msg, $defaults->{'INSTALL_PAZPAR2'}, $valid_values, $install_log_values);
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1061
1062 if ($config{'INSTALL_PAZPAR2'} eq 'yes') {
1063 $msg = q(
1064 Since you've chosen to configure PazPar2, you must
1065 specify the host and port(s) that PazPar2
1066 uses:
1067 );
1068 $msg = q(
1069 Zebra bibliographic server host?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1070 $config{'MERGE_SERVER_HOST'} = _get_value('MERGE_SERVER_HOST', $msg, $defaults->{'MERGE_SERVER_HOST'}, $valid_values, $install_log_values);
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1071
1072 $msg = q(
1073 Zebra bibliographic port for PazPar2 to use?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1074 $config{'MERGE_SERVER_PORT'} = _get_value('MERGE_SERVER_PORT', $msg, $defaults->{'MERGE_SERVER_PORT'}, $valid_values, $install_log_values);
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1075
1076 $msg = q(
1077 PazPar2 host?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1078 $config{'PAZPAR2_HOST'} = _get_value('PAZPAR2_HOST', $msg, $defaults->{'PAZPAR2_HOST'}, $valid_values, $install_log_values);
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1079
1080 $msg = q(
1081 PazPar2 port?);
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1082 $config{'PAZPAR2_PORT'} = _get_value('PAZPAR2_PORT', $msg, $defaults->{'PAZPAR2_PORT'}, $valid_values, $install_log_values);
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1083
1084 }
44efd0f installer (part 1): started major changes
Galen Charlton authored
1085 }
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1086
8056846 @amoore improvements to automated tests, including a testing database
amoore authored
1087 $msg = q(
1088 Would you like to run the database-dependent test suite?);
1089 $msg .= _add_valid_values_disp( 'RUN_DATABASE_TESTS', $valid_values );
1090 $config{'RUN_DATABASE_TESTS'} = _get_value( 'RUN_DATABASE_TESTS', $msg, $defaults->{'RUN_DATABASE_TESTS'}, $valid_values, $install_log_values );
1091
1092 if ( $config{'RUN_DATABASE_TESTS'} eq 'yes' ) {
1093 $config{'TEST_DB_TYPE'} = $config{'DB_TYPE'};
1094 $config{'TEST_DB_HOST'} = $config{'DB_HOST'};
1a6d84c @amoore testing framework: adding more warnings about possible data loss
amoore authored
1095 $msg = q(TEST DATABASE
1096
1097 THE DATA IN THIS DATABASE WILL BE DESTROYED during the process of
1098 testing. Please don't do this on your production database. It is not
1099 reversable.
1100
1101 YOU WILL SUFFER DATA LOSS if you run this test suite on your test
1102 database. You are better off not running this optional test suite than
1103 doing it in a database that you don't want to lose.
1104
8056846 @amoore improvements to automated tests, including a testing database
amoore authored
1105 Please specify the name of the test database to be
1106 used by Koha);
1a6d84c @amoore testing framework: adding more warnings about possible data loss
amoore authored
1107
05b334d @amoore bug 2083: requiring that the test database have a different name from th...
amoore authored
1108 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1109 while ( $config{'TEST_DB_NAME'} eq $config{'DB_NAME'} ) {
1110 $msg = q(Please do not use the same database for testing as you do for production. You run the severe risk of data loss.);
1111 $config{'TEST_DB_NAME'} = _get_value('TEST_DB_NAME', $msg, $defaults->{'TEST_DB_NAME'}, $valid_values, $install_log_values);
1112 }
8056846 @amoore improvements to automated tests, including a testing database
amoore authored
1113
1114 $msg = q(
1115 Please specify the user that owns the database to be
1116 used by Koha);
1117 $config{'TEST_DB_USER'} = _get_value('TEST_DB_USER', $msg, $defaults->{'TEST_DB_USER'}, $valid_values, $install_log_values);
1118
1119 $msg = q(
1120 Please specify the password of the user that owns the
1121 database to be used by Koha);
1122 $config{'TEST_DB_PASS'} = _get_value('TEST_DB_PASS', $msg, $defaults->{'TEST_DB_PASS'}, $valid_values, $install_log_values);
1123 }
1124
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1125 print "\n\n";
82daf0a installer: added install log
Galen Charlton authored
1126
1127 # add version number
1128 my $version = "no_version_found";
1129 eval {
1130 require 'kohaversion.pl';
1131 $version = kohaversion();
1132 };
1133 $config{'KOHA_INSTALLED_VERSION'} = $version;
1134
44efd0f installer (part 1): started major changes
Galen Charlton authored
1135 return %config;
1136 }
1137
1138 sub _add_valid_values_disp {
1139 my $key = shift;
1140 my $valid_values = shift;
1141
1142 my $disp = "";
1143 if (exists $valid_values->{$key}) {
1144 $disp = " (" . join(", ", sort keys %{ $valid_values->{$key} }) . ")";
1145 }
1146 return $disp;
1147 }
1148
1149 sub _get_value {
1150 my $key = shift;
1151 my $msg = shift;
1152 my $default = shift;
1153 my $valid_values = shift;
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1154 my $install_log_values = shift;
1155
1156 # take value from install log if present
1157 if (exists $install_log_values{$key}) {
1158 return $install_log_values{$key};
1159 }
44efd0f installer (part 1): started major changes
Galen Charlton authored
1160
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1161 # override default value from environment
1162 if (exists $ENV{$key}) {
1163 $default = $ENV{$key};
1164 $msg .= " (default from environment)";
1165 }
1166
44efd0f installer (part 1): started major changes
Galen Charlton authored
1167 my $val = prompt($msg, $default);
3f5c71d installer: always accept default value as valid
Galen Charlton authored
1168
1169 while (exists $valid_values->{$key} and
1170 $val ne $default and
1171 not exists $valid_values->{$key}->{$val}) {
44efd0f installer (part 1): started major changes
Galen Charlton authored
1172 my $retry_msg = "Value '$val' is not a valid option.\n";
1173 $retry_msg .= "Please enter a value";
1174 $retry_msg .= _add_valid_values_disp($key, $valid_values);
1175 $val = prompt($retry_msg, $default);
1176 }
1177 return $val;
1178 }
1179
1180 =head2 get_target_directories
1181
1182 Creates a hash mapping from symbols for installation target
1183 directories to actual directory paths.
1184
1b71360 installer: various changes
Galen Charlton authored
1185 Also returns a hash indicating targets for which
1186 files need not be copied -- this is used for the 'dev'
1187 mode installation, where some files are installed in place.
1188
44efd0f installer (part 1): started major changes
Galen Charlton authored
1189 =cut
1190
1191 sub get_target_directories {
1192 my $config = shift;
1193
1194 my $base = $config->{'INSTALL_BASE'};
1195 my $mode = $config->{'INSTALL_MODE'};
1196
1197 # get last component of install base directory
1198 # to treat as package name
1199 my ($volume, $directories, $file) = File::Spec->splitpath($base, 1);
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1200
44efd0f installer (part 1): started major changes
Galen Charlton authored
1201 my @basedir = File::Spec->splitdir($directories);
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1202
1203 # for Win32 we need to prepend the volume to the directory path
1204 if ( $^O eq 'MSWin32' ) { shift @basedir; unshift @basedir, $volume; }
1205 elsif ( $^O eq 'cygwin' ) { shift @basedir; unshift @basedir, 'c:'; } # in a cygwin environment, $volume is returned empty
1206
44efd0f installer (part 1): started major changes
Galen Charlton authored
1207 my $package = pop @basedir;
1208
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1209
44efd0f installer (part 1): started major changes
Galen Charlton authored
1210 my %dirmap = ();
1b71360 installer: various changes
Galen Charlton authored
1211 my %skipdirs = ();
44efd0f installer (part 1): started major changes
Galen Charlton authored
1212 if ($mode eq 'single') {
1213 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
1214 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
61ca8a3 installer: use htdocs instead of www; handle .htaccess
Galen Charlton authored
1215 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1216 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
1217 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
61ca8a3 installer: use htdocs instead of www; handle .htaccess
Galen Charlton authored
1218 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1219 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1220 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1221 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1222 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1b71360 installer: various changes
Galen Charlton authored
1223 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1224 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
1225 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
44efd0f installer (part 1): started major changes
Galen Charlton authored
1226 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1227 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1228 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1229 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1230 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
5befdd2 installer (part 2): more work
Galen Charlton authored
1231 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1232 } elsif ($mode eq 'dev') {
1233 my $curdir = File::Spec->rel2abs(File::Spec->curdir());
1234 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir($curdir);
1b71360 installer: various changes
Galen Charlton authored
1235 $skipdirs{'INTRANET_CGI_DIR'} = 1;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1236 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'intranet-tmpl');
1b71360 installer: various changes
Galen Charlton authored
1237 $skipdirs{'INTRANET_TMPL_DIR'} = 1;
b3b3609 installer: fixed *_WWW_DIR for 'dev' install mode
Galen Charlton authored
1238 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1b71360 installer: various changes
Galen Charlton authored
1239 $skipdirs{'INTRANET_WWW_DIR'} = 1;
1dbc30e bug 1676: fixed location of OPAC_CGI_DIR for 'dev' install
Galen Charlton authored
1240 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir($curdir);
1b71360 installer: various changes
Galen Charlton authored
1241 $skipdirs{'OPAC_CGI_DIR'} = 1;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1242 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl', 'opac-tmpl');
1b71360 installer: various changes
Galen Charlton authored
1243 $skipdirs{'OPAC_TMPL_DIR'} = 1;
b3b3609 installer: fixed *_WWW_DIR for 'dev' install mode
Galen Charlton authored
1244 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir($curdir, 'koha-tmpl');
1b71360 installer: various changes
Galen Charlton authored
1245 $skipdirs{'OPAC_WWW_DIR'} = 1;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1246 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir($curdir);
1b71360 installer: various changes
Galen Charlton authored
1247 $skipdirs{'PERL_MODULE_DIR'} = 1;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1248 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc');
1249 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'zebradb');
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1250 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(@basedir, $package, 'etc', 'pazpar2');
1b71360 installer: various changes
Galen Charlton authored
1251 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1252 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
1253 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
1254 $skipdirs{'SCRIPT_NONDEV_DIR'} = 1;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1255 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1256 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1257 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lock', 'zebradb');
1258 $dirmap{'LOG_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'log');
1259 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'lib', 'zebradb');
5befdd2 installer (part 2): more work
Galen Charlton authored
1260 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(@basedir, $package, 'var', 'run', 'zebradb');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1261 } else {
1262 # mode is standard, i.e., 'fhs'
1263 $dirmap{'INTRANET_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'cgi-bin');
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
1264 $dirmap{'INTRANET_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs', 'intranet-tmpl');
61ca8a3 installer: use htdocs instead of www; handle .htaccess
Galen Charlton authored
1265 $dirmap{'INTRANET_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'intranet', 'htdocs');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1266 $dirmap{'OPAC_CGI_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'cgi-bin');
c31b5c2 installer: moved web template dirs; got rid of multi-targets
Galen Charlton authored
1267 $dirmap{'OPAC_TMPL_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs', 'opac-tmpl');
61ca8a3 installer: use htdocs instead of www; handle .htaccess
Galen Charlton authored
1268 $dirmap{'OPAC_WWW_DIR'} = File::Spec->catdir(@basedir, $package, 'opac', 'htdocs');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1269 $dirmap{'PERL_MODULE_DIR'} = File::Spec->catdir(@basedir, $package, 'lib');
1270 $dirmap{'KOHA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package);
1271 $dirmap{'ZEBRA_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'zebradb');
70dccac FRBR: configure PazPar2 during installation
Galen Charlton authored
1272 $dirmap{'PAZPAR2_CONF_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'etc', $package, 'pazpar2');
1b71360 installer: various changes
Galen Charlton authored
1273 $dirmap{'MISC_DIR'} = File::Spec->catdir(@basedir, $package, 'misc');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1274 $dirmap{'SCRIPT_DIR'} = File::Spec->catdir(@basedir, $package, 'bin');
f20a581 kohabug 1776 - enable daemon controls scripts for 'dev' mode
Galen Charlton authored
1275 $dirmap{'SCRIPT_NONDEV_DIR'} = $dirmap{'SCRIPT_DIR'};
44efd0f installer (part 1): started major changes
Galen Charlton authored
1276 $dirmap{'MAN_DIR'} = File::Spec->catdir(@basedir, $package, 'man');
1277 $dirmap{'DOC_DIR'} = File::Spec->catdir(@basedir, $package, 'doc');
1278 $dirmap{'ZEBRA_LOCK_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lock', $package, 'zebradb');
1279 $dirmap{'LOG_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'log', $package);
1280 $dirmap{'ZEBRA_DATA_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'lib', $package, 'zebradb');
5befdd2 installer (part 2): more work
Galen Charlton authored
1281 $dirmap{'ZEBRA_RUN_DIR'} = File::Spec->catdir(File::Spec->rootdir(), 'var', 'run', $package, 'zebradb');
44efd0f installer (part 1): started major changes
Galen Charlton authored
1282 }
1283
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1284 _get_env_overrides(\%dirmap);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1285 _get_argv_overrides(\%dirmap);
9087249 @vdanjean Add support for DESTDIR
vdanjean authored
1286 _add_destdir(\%dirmap);
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1287
1b71360 installer: various changes
Galen Charlton authored
1288 return \%dirmap, \%skipdirs;
44efd0f installer (part 1): started major changes
Galen Charlton authored
1289 }
1290
33036c4 test suite - various changes
Galen Charlton authored
1291 =head2 get_test_dir
1292
1293 Map a directory target to the corresponding path for
1294 the test suite.
1295
1296 =cut
1297
1298 sub get_test_dir {
1299 my ($dirname) = @_;
1300
1301 my @basedir = (File::Spec->rel2abs(File::Spec->curdir()), 't', 'run');
1302 if (exists $test_suite_override_dirs{$dirname}) {
1303 return File::Spec->catdir(@basedir, @{ $test_suite_override_dirs{$dirname} });
1304 } else {
1305 return;
1306 }
1307
1308 }
1309
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1310 sub _get_env_overrides {
1311 my $dirmap = shift;
1312
1313 foreach my $key (keys %$dirmap) {
1314 if (exists $ENV{$key}) {
1315 $dirmap->{$key} = $ENV{$key};
1316 print "Setting $key from environment\n";
1317 }
1318 }
1319 }
1320
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1321 sub _get_argv_overrides {
1322 my $dirmap = shift;
1323
1324 my @new_argv = ();
1325 for (my $i = 0; $i <= $#ARGV; $i++) {
1326 if ($ARGV[$i] =~ /^([^=]+)=([^=]+)$/ and exists $dirmap->{$1}) {
1327 $dirmap->{$1} = $2;
1328 } else {
1329 push @new_argv, $ARGV[$i];
1330 }
1331 }
1332 @ARGV = @new_argv;
1333 }
1334
9087249 @vdanjean Add support for DESTDIR
vdanjean authored
1335 sub _strip_destdir {
1336 my $dir = shift;
1337 $dir =~ s/^\$\(DESTDIR\)//;
1338 return $dir;
1339 }
1340
1341 sub _add_destdir {
1342 my $dirmap = shift;
1343
1344 foreach my $key (keys %$dirmap) {
1345 $dirmap->{$key} = '$(DESTDIR)'.$dirmap->{$key};
1346 }
1347 }
1348
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1349 sub display_configuration {
1350 my $config = shift;
1351 my $dirmap = shift;
1352 print "\n\nKoha will be installed with the following configuration parameters:\n\n";
1353 foreach my $key (sort keys %$config) {
1354 print sprintf("%-25.25s%s\n", $key, $config->{$key});
1355 }
1356
1357 print "\nand in the following directories:\n\n";
1358 foreach my $key (sort keys %$dirmap) {
1359 print sprintf("%-25.25s%s\n", $key, $dirmap->{$key});
1360 }
1361 print "\n\nTo change any configuration setting, please run\n";
1362 print "perl Makefile.PL again. To override one of the target\n";
1363 print "directories, you can do so on the command line like this:\n";
1364 print "\nperl Makefile.PL PERL_MODULE_DIR=/usr/share/perl/5.8\n\n";
d6eba77 installer: now can use env vars to set installation variables
Galen Charlton authored
1365 print "You can also set different default values for parameters\n";
1366 print "or override directory locations by using environment variables.\n";
1367 print "\nFor example:\n\n";
1368 print "export DB_USER=my_koha\n";
1369 print "perl Makefile.PL\n";
1370 print "\nor\n\n";
1371 print "DB_USER=my_koha DOC_DIR=/usr/local/info perl Makefile.PL\n\n";
981a345 Clairifying pod for upgrade and correcting dmake message for Win32
Chris Nighswonger authored
1372 print "If installing on a Win32 platform, be sure to use:\n";
1373 print "'dmake -x MAXLINELENGTH=300000'\n\n";
bd0877f installer: prompt for more configuration parameters
Galen Charlton authored
1374 }
1375
2fafa14 kohabug 1776 - try to locate Zebra during install
Galen Charlton authored
1376 =head2 find_zebra
1377
1378 Attempt to find Zebra - check user's PATH and
1379 a few other directories for zebrasrv and zebraidx.
1380
1381 FIXME: doesn't handle Win32
1382
1383 =cut
1384
1385 sub find_zebra {
1386 my @search_dirs = map {
1387 my $abs = File::Spec->rel2abs($_);
1388 my ($toss, $directories);
1389 ($toss, $directories, $toss) = File::Spec->splitpath($abs, 1);
1390 $directories;
1391 } split /:/, $ENV{PATH};
1392 push @search_dirs, qw(/usr/local/bin /opt/local/bin /usr/bin);
1393 my @zebrasrv_dirs = grep { -x File::Spec->catpath('', $_, 'zebrasrv') } @search_dirs;
1394 return unless @zebrasrv_dirs;
1395 # verify that directory that contains zebrasrv also contains zebraidx
1396 foreach my $dir (@zebrasrv_dirs) {
1397 return $dir if -x File::Spec->catpath('', $dir, 'zebraidx');
1398 }
1399 return;
1400 }
1401
5befdd2 installer (part 2): more work
Galen Charlton authored
1402 package MY;
7f01995 installer (part 3): enabled 'make test'
Galen Charlton authored
1403
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1404 # This will have to be reworked in order to accommodate Win32...
1405
7f01995 installer (part 3): enabled 'make test'
Galen Charlton authored
1406 sub test {
1407 my $self = shift;
1408 my $test = $self->SUPER::test(@_);
1409 $test =~ s!\$\(INST_LIB\)!blib/PERL_MODULE_DIR!g;
6530b68 Makefile.PL - set KOHA_CONF for make test
Galen Charlton authored
1410
1411 # set KOHA_CONF
1412 $test =~ s!\$\(FULLPERLRUN\)!KOHA_CONF=blib/KOHA_CONF_DIR/koha-conf.xml \$(FULLPERLRUN)!g;
7f01995 installer (part 3): enabled 'make test'
Galen Charlton authored
1413 return $test;
1414 }
1415
5befdd2 installer (part 2): more work
Galen Charlton authored
1416 sub install {
1417 my $self = shift;
1418 my $install = "";
1419 # NOTE: we're *not* doing this: my $install = $self->SUPER::install(@_);
1420 # This means that we're completely overriding EU::MM's default
1421 # installation and uninstallation targets.
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1422
1423 # If installation is on Win32, we need to do permissions different from *nix
deba213 @fredericd Bug #3036 Avoid command-line installer blocking on opensolaris plateform
fredericd authored
1424 if ( $^O =~ /darwin|linux|cygwin|freebsd|solaris/ ) { # this value needs to be verified for each platform and modified accordingly
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1425 foreach my $key (sort keys %$target_directories) {
1426 $install .= qq(
5befdd2 installer (part 2): more work
Galen Charlton authored
1427 KOHA_INST_$key = blib/$key
1b71360 installer: various changes
Galen Charlton authored
1428 KOHA_DEST_$key = $target_directories->{$key}
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1429 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1430 }
1431 $install .= qq(
1b71360 installer: various changes
Galen Charlton authored
1432 install :: all install_koha set_koha_ownership set_koha_permissions warn_koha_env_vars
5befdd2 installer (part 2): more work
Galen Charlton authored
1433 \t\$(NOECHO) \$(NOOP)
1434 );
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1435 $install .= "install_koha ::\n";
1436 $install .= "\t\$(NOECHO) umask 022; \$(MOD_INSTALL) \\\n";
1437 foreach my $key (sort keys %$target_directories) {
1438 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1439 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1440 }
1441 $install .= "\t\t\$(INST_MAN1DIR) \$(DESTINSTALLMAN1DIR) \\\n";
1442 $install .= "\t\t\$(INST_MAN3DIR) \$(DESTINSTALLMAN3DIR)\n";
1443
1444 $install .= "\n";
1445 $install .= "set_koha_ownership ::\n";
9087249 @vdanjean Add support for DESTDIR
vdanjean authored
1446 # Do not try to change ownership if DESTDIR is set
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1447 if ($config{'INSTALL_MODE'} eq 'standard' and $config{'KOHA_USER'} ne "root") {
1448 foreach my $key (sort keys %$target_directories) {
9087249 @vdanjean Add support for DESTDIR
vdanjean authored
1449 $install .= "\t\$(NOECHO) if test -z \"\$(DESTDIR)\"; then chown -R $config{'KOHA_USER'}:$config{'KOHA_GROUP'} \$(KOHA_DEST_$key); fi\n"
118283b Initial work on adding Win32 support to installer.
Chris Nighswonger authored
1450 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1451 }
1452 } else {
1453 $install .= "\t\t\$(NOECHO) \$(NOOP)\n\n";
1454 }
1455
1456 $install .= "\n";
1457 $install .= "set_koha_permissions ::\n";
1458 # This is necessary because EU::MM installs files
1459 # as either 0444 or 0555, and we want the owner
1460 # of Koha's files to have write permission by default.
1461 foreach my $key (sort keys %$target_directories) {
1462 $install .= "\t\$(NOECHO) chmod -R u+w \$(KOHA_DEST_$key)\n"
1463 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1464 }
1465 }
1466 elsif ($^O eq 'MSWin32' ) { # On Win32, the install probably needs to be done under the user account koha will be running as...
1467 # We can attempt some creative things with command line utils such as CACLS which allows permission
1468 # management from Win32 cmd.exe, but permissions really only apply to NTFS.
1469 foreach my $key (sort keys %$target_directories) {
1470 $install .= qq(
1471 KOHA_INST_$key = blib/$key
1472 KOHA_DEST_$key = $target_directories->{$key}
1473 ) unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1474 }
1475 $install .= qq(
1476 install :: all install_koha warn_koha_env_vars
1477 \t\$(NOECHO) \$(NOOP)
1478 );
1479 $install .= "install_koha ::\n";
1480 $install .= "\t\$(MOD_INSTALL) \\\n";
1481 foreach my $key (sort keys %$target_directories) {
1482 $install .= "\t\t\$(KOHA_INST_$key) \$(KOHA_DEST_$key) \\\n"
1483 unless ($config{'INSTALL_ZEBRA'} ne "yes" and $key =~ /ZEBRA/) or exists $skip_directories->{$key};
1484 }
1485 }
1486 $install .= "\n";
1b71360 installer: various changes
Galen Charlton authored
1487
1488 $install .= "warn_koha_env_vars ::\n";
1489 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1490 $install .= "\t\$(NOECHO) \$(ECHO) Koha\\'s files have now been installed. \n";
1491 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1492 $install .= "\t\$(NOECHO) \$(ECHO) In order to use Koha\\'s command-line batch jobs,\n";
1493 $install .= "\t\$(NOECHO) \$(ECHO) you should set the following environment variables:\n";
1494 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1495 $install .= "\t\$(NOECHO) \$(ECHO) export KOHA_CONF=\$(KOHA_DEST_KOHA_CONF_DIR)/koha-conf.xml\n";
1496 $install .= "\t\$(NOECHO) \$(ECHO) export PERL5LIB=$target_directories->{'PERL_MODULE_DIR'}\n";
1497 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1498 $install .= "\t\$(NOECHO) \$(ECHO) For other post-installation tasks, please consult the README.\n";
1499 $install .= "\t\$(NOECHO) \$(ECHO)\n";
1500
1b603d0 installer: added update_zebra_conf target
Galen Charlton authored
1501 if ($config{'INSTALL_ZEBRA'} eq "yes") {
1502 $install .= _update_zebra_conf_target();
1503 }
1504
25e1b9e installer: added 'make upgrade' target
Galen Charlton authored
1505 $install .= upgrade();
1506
5befdd2 installer (part 2): more work
Galen Charlton authored
1507 return $install;
1508 }
1509
20f1c41 install: added --prev-install-log option to Makefile.PL
Galen Charlton authored
1510 =head2 _update_zebra_conf_target
1b603d0 installer: added update_zebra_conf target <