forked from Koha-Community/Koha
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Makefile.PL
1795 lines (1458 loc) · 65.9 KB
/
Makefile.PL
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2007 MJ Ray
# Copyright 2016 PTFS Europe
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
#
# Current maintainer MJR http://mjr.towers.org.uk/
#
use strict;
use warnings;
use ExtUtils::MakeMaker;
use POSIX;
use File::Spec;
use Getopt::Long qw/HelpMessage/;
use FindBin; # we need to enforce which C4::Installer::PerlModule is used in case more than one is installed
use lib $FindBin::Bin;
use C4::Installer::PerlModules;
my $koha_pm = C4::Installer::PerlModules->new;
my $DEBUG = 0;
die "perl 5.10 or later required" unless ($] >= 5.010000);
# Hash up directory structure & files beginning with the directory we were called from (should be the base of koha)...
my $dirtree = hashdir('.');
my %result = ();
=head1 NAME
Makefile.PL - Koha packager and installer
=head1 SYNOPSIS
=head2 BASIC INSTALLATION
perl Makefile.PL
make
make test
sudo make install
=head2 UPGRADE INSTALLATION
NOTE: This option is only available if koha-install-log exists.
perl Makefile.PL --prev-install-log /path/to/koha-install-log
make
make test
sudo make upgrade
=head2 PACKAGING RELEASE TARBALLS
make manifest tardist
make manifest zipdist
=head2 CLEANING UP
make clean
=head2 CLI PARAMETERS
--prev-install-log Read configuration from previous installation
--install_mode Installation mode (dev, standard, single)
--db_type Database (mysql, Pg)
--db_host Database host (e.g. localhost)
--db_port Database port (e.g. 3306)
--db_name Database name (e.g. koha)
--db_user Database user (e.g. kohaadmin)
--db_pass Database password (e.g. katikoan)
--zebra_marc_format Zebra MARC format (marc21, normarc, unimarc)
--zebra_language Zebra language (e.g. en)
--zebra_tokenizer Zebra tokenizer (chr, icu)
--zebra_user Zebra user (e.g. kohauser)
--zebra_pass Zebra password (e.g. zebrastripes)
--zebra_sru_host Zebra SRU servername (e.g. localhost)
--zebra_sru_biblios_port Zebra SRU biblios port (e.g. 9998)
--zebra_sru_authorities_port Zebra SRU biblios port (e.g. 9999)
--koha_user Koha Unix user (e.g. koha)
--koha_group Koha Unix group (e.g. koha)
--install_sru Install the SRU server (yes, no)
--use_memcached Use Memcached (yes, no)
--font_dir Location of fonts (e.g. /usr/share/fonts/truetype/dejavu)
--run_database_tests Run database dependent tests (yes, no)
--install_base Base directory of installation (e.g. /usr/share/koha)
--template-cache-dir Specify a template cache directory (e.g. /var/cache/koha)
--help Display this help message
=head1 DESCRIPTION
This is a packager and installer that uses
ExtUtils::MakeMaker, which is fairly common
on perl systems.
As well as building tar or zip files
and installing with the above commands,
it allows us to check pre-requisites
and generate configuration files.
=head1 VARIABLES
=head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
Basic metadata about this software.
=head2 NO_META
Suppress generation of META.yml file.
=head2 PREREQ_PM
Hash of perl modules and versions required.
=head2 PM
Hash of file mappings
=head2 PL_FILES
This is a hash of PL scripts to run after installation and
the files to ask them to generate.
Maybe use the values from CONFIGURE
to generate initial configuration files in future.
=cut
=head2 target_map
This is a hash mapping directories and files in the
source tree to installation target directories. The rules
for this mapping are:
=over 4
=item If a directory or file is specified, it and its
contents will be copied to the installation target directory.
=item If a subdirectory of a mapped directory is specified,
its target overrides the parent's target for that subdirectory.
=item The value of each map entry may either be a scalar containing
one target or a reference to a hash containing 'target' and 'trimdir'
keys.
=item Any files at the top level of the source tree that are
not included in the map will not be installed.
=item Any directories at the top level of the source tree
that are not included in the map will be installed in
INTRANET_CGI_DIR. This is a sensible default given the
current organization of the source tree, but (FIXME) it
would be better to reorganize the source tree to better
match the installation system, to allow adding new directories
without having to adjust Makefile.PL each time. The idea
is to make the C<$target_map> hash as minimal as possible.
=back
The permitted installation targets are:
=over 4
=item INTRANET_CGI_DIR
CGI scripts for intranet (staff) interface.
=item INTRANET_TMPL_DIR
HTML templates for the intranet interface.
=item INTRANET_WWW_DIR
HTML files, images, etc. for DocumentRoot for the intranet interface.
=item OPAC_CGI_DIR
CGI scripts for OPAC (public) interface.
=item OPAC_TMPL_DIR
HTML templates for the OPAC interface.
=item OPAC_WWW_DIR
HTML files, images, etc. for DocumentRoot for the OPAC interface.
=item PERL_MODULE_DIR
Perl modules (at present just the C4 modules) that are intimately
tied to Koha. Depending on the installation options, these
may or may not be installed one of the standard directories
in Perl's default @LIB.
=item KOHA_CONF_DIR
Directory for Koha configuration files.
=item ZEBRA_CONF_DIR
Directory for Zebra configuration files.
=item ZEBRA_LOCK_DIR
Directory for Zebra's lock files. This includes subdirs for authorities,
biblios, and the zebra rebuild function. Any activity to reindex
zebra from koha should interlock here with rebuild_zebra.pl.
=item ZEBRA_DATA_DIR
Directory for Zebra's data files.
=item ZEBRA_RUN_DIR
Directory for Zebra's UNIX-domain sockets.
=item ELASTICSEARCH_SERVERS
Server:port of the Elasticsearch server to use, as a comma separated list:
eg. 192.168.0.100:9200, localhost:9200
=item ELASTICSEARCH_INDEX
Unique index in Elasticsearch, for this Koha-instance
eg. koha-mykoha or just koha
=item MISC_DIR
Directory for for miscellaenous scripts, among other
things the translation toolkit and RSS feed tools.
=item SCRIPT_DIR
Directory for command-line scripts and daemons to
be set up all for installation modes.
=item SCRIPT_NONDEV_DIR
Directory for command-line scripts that should
be installed in the same directory as the
SCRIPT_DIR target except 'dev' installs.
=item MAN_DIR
Directory for man pages created from POD -- will mostly
contain information of interest to Koha developers.
=item DOC_DIR
Directory for Koha documentation accessed from the
command-line, e.g., READMEs.
=item LOCK_DIR
Directory for Koha scripts to put their locks.
=item LOG_DIR
Directory for Apache and Zebra logs produced by Koha.
=item BACKUP_DIR
Directory for backup files produced by Koha.
=item PLUGINS_DIR
Directory for external Koha plugins.
=item FONT_DIR
Directory where DejaVu fonts are installed.
=item NONE
This is a dummy target used to explicitly state
that a given file or directory is not to be installed.
This is used either for parts of the installer itself
or for development tools that are not applicable to a
production installation.
=back
=cut
my $target_map = {
'./about.pl' => 'INTRANET_CGI_DIR',
'./acqui' => 'INTRANET_CGI_DIR',
'./admin' => 'INTRANET_CGI_DIR',
'./api' => { target => 'API_CGI_DIR', trimdir => -1 },
'./app.psgi' => 'SCRIPT_DIR',
'./authorities' => 'INTRANET_CGI_DIR',
'./basket' => 'INTRANET_CGI_DIR',
'./bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
'./C4' => 'PERL_MODULE_DIR',
'./C4/SIP/t' => 'NONE',
'./C4/SIP/koha_test' => 'NONE',
'./C4/tests' => 'NONE',
'./catalogue' => 'INTRANET_CGI_DIR',
'./cataloguing' => 'INTRANET_CGI_DIR',
'./changelanguage.pl' => 'INTRANET_CGI_DIR',
'./check_sysprefs.pl' => 'NONE',
'./circ' => 'INTRANET_CGI_DIR',
'./clubs' => 'INTRANET_CGI_DIR',
'./course_reserves' => 'INTRANET_CGI_DIR',
'./cpanfile' => 'PERL_MODULE_DIR',
'./docs/history.txt' => { target => 'DOC_DIR', trimdir => -1 },
'./docs/contributors.yaml' => { target => 'DOC_DIR', trimdir => -1 },
'./docs/teams.yaml' => { target => 'DOC_DIR', trimdir => -1 },
'./offline_circ' => 'INTRANET_CGI_DIR',
'./etc' => { target => 'KOHA_CONF_DIR', trimdir => -1 },
'./etc/zebradb' => { target => 'ZEBRA_CONF_DIR', trimdir => -1 },
'./etc/z3950' => { target => 'Z3950_CONF_DIR', trimdir => -1 },
'./help.pl' => 'INTRANET_CGI_DIR',
'./ill' => 'INTRANET_CGI_DIR',
'./installer-CPAN.pl' => 'NONE',
'./installer' => 'INTRANET_CGI_DIR',
'./errors' => {target => 'INTRANET_CGI_DIR'},
'./Koha' => 'PERL_MODULE_DIR',
'./Koha.pm' => 'PERL_MODULE_DIR',
'./koha-tmpl/intranet-tmpl' => {target => 'INTRANET_TMPL_DIR', trimdir => -1},
'./koha-tmpl/opac-tmpl' => {target => 'OPAC_TMPL_DIR', trimdir => -1},
'./kohaversion.pl' => 'INTRANET_CGI_DIR',
'./labels' => 'INTRANET_CGI_DIR',
'./mainpage.pl' => 'INTRANET_CGI_DIR',
'./Makefile.PL' => 'NONE',
'./MANIFEST.SKIP' => 'NONE',
'./members' => 'INTRANET_CGI_DIR',
'./misc' => { target => 'SCRIPT_NONDEV_DIR', trimdir => -1 },
'./misc/bin' => { target => 'SCRIPT_DIR', trimdir => -1 },
'./misc/release_notes' => { target => 'DOC_DIR', trimdir => 2 },
'./misc/translator' => { target => 'MISC_DIR', trimdir => 2 },
'./misc/koha-install-log' => { target => 'MISC_DIR', trimdir => -1 },
'./misc/installer_devel_notes' => 'NONE',
'./opac' => 'OPAC_CGI_DIR',
'./OpenILS' => 'PERL_MODULE_DIR',
'./README.txt' => 'NONE',
'./patroncards' => 'INTRANET_CGI_DIR',
'./patron_lists' => 'INTRANET_CGI_DIR',
'./plugins' => 'INTRANET_CGI_DIR',
'./pos' => 'INTRANET_CGI_DIR',
'./reports' => 'INTRANET_CGI_DIR',
'./reserve' => 'INTRANET_CGI_DIR',
'./reviews' => 'INTRANET_CGI_DIR',
'./rewrite-config.PL' => 'NONE',
'./reviews' => 'INTRANET_CGI_DIR',
'./rotating_collections' => 'INTRANET_CGI_DIR',
'./serials' => 'INTRANET_CGI_DIR',
'./services' => 'INTRANET_CGI_DIR',
'./skel' => 'NONE',
'./skel/var/lock/koha' => { target => 'LOCK_DIR', trimdir => -1 },
'./skel/var/log/koha' => { target => 'LOG_DIR', trimdir => -1 },
'./skel/var/spool/koha' => { target => 'BACKUP_DIR', trimdir => -1 },
'./skel/var/run/koha/zebradb' => { target => 'ZEBRA_RUN_DIR', trimdir => -1 },
'./skel/var/lock/koha/zebradb/authorities' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/authorities/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/authorities/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/authorities/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/authorities/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lock/koha/zebradb/biblios' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/biblios/key' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/biblios/register' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/biblios/shadow' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lib/koha/zebradb/biblios/tmp' => { target => 'ZEBRA_DATA_DIR', trimdir => 6 },
'./skel/var/lock/koha/zebradb/rebuild' => { target => 'ZEBRA_LOCK_DIR', trimdir => 6 },
'./skel/var/lib/koha/plugins' => { target => 'PLUGINS_DIR', trimdir => 6 },
'./sms' => 'INTRANET_CGI_DIR',
'./suggestion' => 'INTRANET_CGI_DIR',
'./svc' => 'INTRANET_CGI_DIR',
'./t' => 'NONE',
'./xt' => 'NONE',
'./tags' => 'INTRANET_CGI_DIR',
'./tmp' => 'NONE', # FIXME need to determine whether
# Koha generates any persistent temp files
# that should go in /var/tmp/koha
'./tools' => 'INTRANET_CGI_DIR',
'./virtualshelves' => 'INTRANET_CGI_DIR',
# ignore files and directories created by the install itself
'./pm_to_blib' => 'NONE',
'./blib' => 'NONE',
'.sass-lint.yml' => 'NONE',
'.scss-lint.yml' => 'NONE',
'.eslintrc.json' => 'NONE',
'gulpfile.js' => 'NONE',
'package.json' => 'NONE',
'yarn.lock' => 'NONE',
};
=head1 CONFIGURATION OPTIONS
The following configuration options are used by the installer.
=over 4
=item INSTALL_MODE
Specifies whether installation will be FHS-compliant (default,
assumes user has root), put everything under
a single directory (for users installing on a web host
that allows CGI scripts and a MySQL database but not root
access), or development (for a developer who wants to run
Koha from a git clone with no fuss).
=item INSTALL_BASE
Directory under which most components will go. Default
value will vary depending on INSTALL_MODE.
=item DB_TYPE
Type of DBMS (e.g., mysql or Pg).
=item DB_HOST
Name of DBMS server.
=item DB_PORT
Port that DBMS server is listening on.
=item DB_NAME
Name of the DBMS database for Koha.
=item DB_USER
Name of DBMS user account for Koha's database.
=item DB_PASS
Pasword of DMBS user account for Koha's database.
=item ZEBRA_MARC_FORMAT
Specifies format of MARC records to be indexed by Zebra.
=item ZEBRA_LANGUAGE
Specifies primary language of records that will be
indexed by Zebra.
=item ZEBRA_USER
Internal Zebra user account for the index.
=item ZEBRA_PASS
Internal Zebra user account's password.
=item KOHA_USER
System user account that will own Koha's files.
=item KOHA_GROUP
System group that will own Koha's files.
=item SMTP_HOST
SMTP server host name (default: localhost)
=item SMTP_PORT
SMTP server port (default: 25)
=item SMTP_TIMEOUT
Connection timeour in seconds (default: 120)
=item SMTP_SSL_MODE
SSL mode. Options are 'disabled' (default), 'ssl' and 'starttls'
=item SMTP_USER_NAME
SMTP authentication user name
=item SMTP_PASSWORD
SMTP authentication password
=item SMTP_DEBUG
Enable debug mode for SMTP (default: no)
=back
=cut
# default configuration options
my %config_defaults = (
'DB_TYPE' => 'mysql',
'DB_HOST' => 'localhost',
'DB_NAME' => 'koha',
'DB_USER' => 'kohaadmin',
'DB_PASS' => 'katikoan',
'DB_USE_TLS' => 'no',
'DB_TLS_CA_CERTIFICATE' => '/etc/mysql-ssl/server-ca.pem',
'DB_TLS_CLIENT_CERTIFICATE' => '/etc/mysql-ssl/client-cert.pem',
'DB_TLS_CLIENT_KEY' => '/etc/mysql-ssl/client-key.pem',
'INSTALL_SRU' => 'yes',
'ZEBRA_MARC_FORMAT' => 'marc21',
'ZEBRA_LANGUAGE' => 'en',
'ZEBRA_TOKENIZER' => 'chr',
'ZEBRA_USER' => 'kohauser',
'ZEBRA_PASS' => 'zebrastripes',
'ZEBRA_SRU_HOST' => 'localhost',
'ZEBRA_SRU_BIBLIOS_PORT' => '9998',
'ZEBRA_SRU_AUTHORITIES_PORT' => '9999',
'KOHA_USER' => 'koha',
'KOHA_GROUP' => 'koha',
'MERGE_SERVER_HOST' => 'localhost',
'MERGE_SERVER_PORT' => '11001',
'RUN_DATABASE_TESTS' => 'no',
'PATH_TO_ZEBRA' => '',
'USE_MEMCACHED' => 'yes',
'MEMCACHED_SERVERS' => '127.0.0.1:11211',
'MEMCACHED_NAMESPACE' => 'KOHA',
'TEMPLATE_CACHE_DIR' => '/tmp/koha',
'USE_ELASTICSEARCH' => 'no',
'ELASTICSEARCH_SERVERS' => 'localhost:9200',
'ELASTICSEARCH_INDEX' => 'koha',
'FONT_DIR' => '/usr/share/fonts/truetype/dejavu',
'SMTP_HOST' => 'localhost',
'SMTP_PORT' => '25',
'SMTP_TIMEOUT' => '120',
'SMTP_SSL_MODE' => 'disabled',
'SMTP_USER_NAME' => '',
'SMTP_PASSWORD' => '',
'SMTP_DEBUG' => 'no',
);
# set some default configuration options based on OS
# more conditions need to be added for other OS's
warn "Your platform appears to be $^O.\n" if $DEBUG;
if ( $^O eq 'cygwin' ) {
# Most Unix2Win32 ports seem to poke everything into the Program Files directory
# this could be changed to put some files (ie. libraries) into system32, etc.
$config_defaults{'INSTALL_MODE'} = 'single';
$config_defaults{'INSTALL_BASE'} = 'c:/progra~1/koha'; # Use 8.3 names to be safe...
}
else {
$config_defaults{'INSTALL_MODE'} = 'standard';
$config_defaults{'INSTALL_BASE'} = '/usr/share/koha';
}
# valid values for certain configuration options
my %valid_config_values = (
'INSTALL_MODE' => { 'standard' => 1, 'single' => 1, 'dev' => 1 },
'DB_TYPE' => { 'mysql' => 1, 'Pg' => 1 },
'DB_USE_TLS' => {'yes', 'no'},
'INSTALL_SRU' => { 'yes' => 1, 'no' => 1 },
'ZEBRA_MARC_FORMAT' => { 'marc21' => 1, 'normarc' => 1, 'unimarc' => 1 }, # FIXME should generate from contents of distributation
'ZEBRA_LANGUAGE' => { 'cs' => 1, 'el' => 1, 'en' => 1, 'es' => 1, 'fr' => 1, 'nb' => 1, 'ru' => 1, 'uk' => 1 }, # FIXME should generate from contents of distribution
'ZEBRA_TOKENIZER' => { chr => 1, icu => 1 },
'RUN_DATABASE_TESTS' => { 'yes' => 1, 'no' => 1 },
'USE_MEMCACHED' => { 'yes' => 1, 'no' => 1 },
'USE_ELASTICSEARCH' => { 'yes' => 1, 'no' => 1 },
'SMTP_SSL_MODE' => { 'disabled' => 1, 'ssl' => 1, 'starttls' => 1 },
'SMTP_DEBUG' => { 'yes' => 1, 'no' => 1 },
);
# get settings from command-line
my $koha_install_log = "";
my $cli_koha_install_mode = "";
my $cli_koha_db_type = "";
my $cli_koha_db_host = "";
my $cli_koha_db_port = "";
my $cli_koha_db_name = "";
my $cli_koha_db_user = "";
my $cli_koha_db_pass = "";
my $cli_zebra_marc_format = "";
my $cli_zebra_language = "",
my $cli_zebra_tokenizer = "";
my $cli_zebra_user = "";
my $cli_zebra_pass = "";
my $cli_zebra_sru_host = "";
my $cli_zebra_sru_bib_port = "";
my $cli_zebra_sru_auth_port = "";
my $cli_koha_user = "";
my $cli_koha_group = "";
my $cli_koha_install_sru = "";
my $cli_koha_use_memcached = "";
my $cli_koha_font_dir = "";
my $cli_koha_run_database_tests = "";
my $cli_koha_install_base = "";
my $cli_koha_template_cache_dir = "";
my $cli_smtp_host = "";
my $cli_smtp_port = "";
my $cli_smtp_timeout = "";
my $cli_smtp_ssl_mode = "";
my $cli_smtp_user_name = "";
my $cli_smtp_password = "";
my $cli_smtp_debug = "";
Getopt::Long::Configure('pass_through');
my $results = GetOptions(
"prev-install-log=s" => \$koha_install_log,
"install_mode=s" => \$cli_koha_install_mode,
"db_type=s" => \$cli_koha_db_type,
"db_host=s" => \$cli_koha_db_host,
"db_port=s" => \$cli_koha_db_port,
"db_name=s" => \$cli_koha_db_name,
"db_user=s" => \$cli_koha_db_user,
"db_pass=s" => \$cli_koha_db_pass,
"zebra_marc_format=s" => \$cli_zebra_marc_format,
"zebra_language=s" => \$cli_zebra_language,
"zebra_tokenizer=s" => \$cli_zebra_tokenizer,
"zebra_user=s" => \$cli_zebra_user,
"zebra_pass=s" => \$cli_zebra_pass,
"zebra_sru_host=s" => \$cli_zebra_sru_host,
"zebra_sru_biblios_port=s" => \$cli_zebra_sru_bib_port,
"zebra_sru_authorities_port=s" => \$cli_zebra_sru_auth_port,
"koha_user=s" => \$cli_koha_user,
"koha_group=s" => \$cli_koha_group,
"install_sru=s" => \$cli_koha_install_sru,
"use_memcached=s" => \$cli_koha_use_memcached,
"font_dir=s" => \$cli_koha_font_dir,
"run_database_tests=s" => \$cli_koha_run_database_tests,
"install_base=s" => \$cli_koha_install_base,
"template-cache-dir=s" => \$cli_koha_template_cache_dir,
"smtp-host=s" => \$cli_smtp_host,
"smtp-port=s" => \$cli_smtp_port,
"smtp-timeout=s" => \$cli_smtp_timeout,
"smtp-ssl-mode=s" => \$cli_smtp_ssl_mode,
"smtp-user-name=s" => \$cli_smtp_user_name,
"smtp-password=s" => \$cli_smtp_password,
"smtp-debug" => \$cli_smtp_debug,
"help" => sub { HelpMessage(0) },
) or HelpMessage(1);
my %install_log_values = ();
if ($koha_install_log ne "") {
get_install_log_values($koha_install_log, \%install_log_values);
} else {
# Try to set install_log_values for provided values;
get_cli_values(\%install_log_values);
}
my %config = get_configuration(\%config_defaults, \%valid_config_values, \%install_log_values);
my ($target_directories, $skip_directories) = get_target_directories(\%config);
display_configuration(\%config, $target_directories);
my $file_map = {};
get_file_map($target_map, $dirtree, $file_map);
my $pl_files = {
'rewrite-config.PL' => [
'blib/KOHA_CONF_DIR/koha-conf.xml',
'blib/KOHA_CONF_DIR/koha-httpd.conf',
'blib/KOHA_CONF_DIR/log4perl.conf',
'blib/KOHA_CONF_DIR/koha-worker.service',
'blib/ZEBRA_CONF_DIR/etc/default.idx',
'blib/MISC_DIR/koha-install-log'
],
'fix-perl-path.PL' => [ # this script ensures the correct shebang line for the platform installed on...
'blib'
],
};
push @{ $pl_files->{'rewrite-config.PL'} }, (
'blib/ZEBRA_CONF_DIR/etc/passwd',
'blib/ZEBRA_CONF_DIR/zebra-biblios-dom.cfg',
'blib/ZEBRA_CONF_DIR/zebra-authorities-dom.cfg',
'blib/ZEBRA_CONF_DIR/explain-authorities.xml',
'blib/ZEBRA_CONF_DIR/explain-biblios.xml',
'blib/ZEBRA_CONF_DIR/retrieval-info-auth-dom.xml',
'blib/ZEBRA_CONF_DIR/retrieval-info-bib-dom.xml',
);
push @{ $pl_files->{'rewrite-config.PL'} }, (
'blib/SCRIPT_DIR/koha-zebra-ctl.sh',
'blib/SCRIPT_DIR/koha-index-daemon-ctl.sh',
);
$config{'ZEBRA_AUTH_CFG'} = 'zebra-authorities-dom.cfg';
$config{'ZEBRA_BIB_CFG'} = 'zebra-biblios-dom.cfg';
$config{'AUTH_RETRIEVAL_CFG'} = 'retrieval-info-auth-dom.xml';
$config{'BIB_RETRIEVAL_CFG'} = 'retrieval-info-bib-dom.xml';
if ($config{'INSTALL_MODE'} ne "dev") {
push @{ $pl_files->{'rewrite-config.PL'} }, (
'blib/PERL_MODULE_DIR/C4/Context.pm',
'blib/SCRIPT_NONDEV_DIR/kohalib.pl'
);
}
$config{ZEBRA_TOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
? 'icuchain words-icu.xml'
: 'charmap word-phrase-utf.chr';
$config{ZEBRA_PTOKENIZER_STMT} = $config{ZEBRA_TOKENIZER} eq 'icu'
? 'icuchain phrases-icu.xml'
: 'charmap word-phrase-utf.chr';
my %test_suite_override_dirs = (
KOHA_CONF_DIR => ['etc'],
ZEBRA_CONF_DIR => ['etc', 'zebradb'],
Z3950_CONF_DIR => ['etc', 'z3950'],
LOCK_DIR => ['var', 'lock'],
LOG_DIR => ['var', 'log'],
BACKUP_DIR => ['var', 'spool'],
SCRIPT_DIR => ['bin'],
ZEBRA_LOCK_DIR => ['var', 'lock', 'zebradb'],
ZEBRA_DATA_DIR => ['var', 'lib', 'zebradb'],
ZEBRA_RUN_DIR => ['var', 'run', 'zebradb'],
);
WriteMakefile(
NAME => 'koha',
#VERSION => strftime('2.9.%Y%m%d%H',gmtime),
VERSION_FROM => 'kohaversion.pl',
ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
AUTHOR => 'Koha Contributors <https://koha-community.org/>',
NO_META => 1,
PREREQ_PM => $koha_pm->prereq_pm,
# File tree mapping
PM => $file_map,
# Man pages generated from POD
# ExtUtils::MakeMaker already manage $(DESTDIR)
INSTALLMAN1DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man1'),
INSTALLMAN3DIR => File::Spec->catdir(_strip_destdir($target_directories->{'MAN_DIR'}), 'man3'),
PL_FILES => $pl_files,
);
=head1 FUNCTIONS
=head2 hashdir
This function recurses through the directory structure and builds
a hash of hashes containing the structure with arrays holding filenames.
This directory hashing routine was taken from BrowserUK @ http://www.perlmonks.org/?node_id=219919
=cut
sub hashdir{
my $dir = shift;
opendir my $dh, $dir or die $!;
my $tree = {}->{$dir} = {};
while( my $file = readdir($dh) ) {
next if $file =~ m/^\.{1,2}/ and $file !~ /^\.htaccess/; # .htaccess is a special case
my $path = $dir .'/' . $file;
$tree->{$file} = hashdir($path), next if -d $path;
push @{$tree->{'.'}}, $file;
}
return $tree;
}
=head2 get_file_map
This function combines the target_map and file hash to
map each source file to its destination relative to
the set of installation targets.
Output will be a hash mapping from each source file
to its destination value, like this:
'mainpage.pl' => '$(INTRANET_CGI_DIR)/mainpage.pl'
=cut
sub get_file_map {
my $target_map = shift;
my $dirtree = shift;
my $file_map = shift;
my $curr_path = @_ ? shift : ['.'];
# Traverse the directory tree.
# For each file or directory, identify the
# most specific match in the target_map
foreach my $dir (sort keys %{ $dirtree }) {
if ($dir eq '.') {
# deal with files in directory
foreach my $file (sort @{ $dirtree->{$dir} }) {
my $targetdir = undef;
my $matchlevel = undef;
# first, see if there is a match on this specific
# file in the target map
my $filepath = join("/", @$curr_path, $file);
if (exists $target_map->{$filepath}) {
$targetdir = $target_map->{$filepath};
$matchlevel = scalar(@$curr_path) + 1;
} else {
# no match on the specific file; look for
# a directory match
for (my $i = scalar(@$curr_path) - 1; $i >= 0; $i--) {
my $dirpath = join("/", @$curr_path[0..$i]);
if (exists $target_map->{$dirpath}) {
$targetdir = $target_map->{$dirpath};
$matchlevel = $i + 1;
last;
}
}
}
if (defined $targetdir) {
_add_to_file_map($file_map, $targetdir, $curr_path, $file, $matchlevel);
} else {
my $path = join("/", @$curr_path);
print "failed to map: $path/$file\n" if $DEBUG;
}
}
} else {
# dealing with subdirectory
push @$curr_path, $dir;
get_file_map($target_map, $dirtree->{$dir}, $file_map, $curr_path);
pop @$curr_path;
}
}
}
sub _add_to_file_map {
my $file_map = shift;
my $targetdir = shift;
my $curr_path = shift;
my $file = shift;
my $matchlevel = shift;
my $dest_path = @_ ? shift : $curr_path;
# The target can be one of the following:
# 1. scalar representing target symbol
# 2. hash ref containing target and trimdir keys
#
# Consequently, this routine traverses this structure,
# calling itself recursively, until it deals with
# all of the scalar target symbols.
if (ref $targetdir eq 'HASH') {
my $subtarget = $targetdir->{target};
if (exists $targetdir->{trimdir}) {
# if we get here, we've specified that
# rather than installing the file to
# $(TARGET)/matching/dirs/subdirs/file,
# we want to install it to
# $(TARGET)/subdirs/file
#
# Note that this the only place where
# $matchlevel is used.
my @new_dest_path = @$dest_path;
if ($targetdir->{trimdir} == -1) {
splice @new_dest_path, 0, $matchlevel;
} else {
splice @new_dest_path, 0, $targetdir->{trimdir};
}
_add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel, \@new_dest_path);
} else {
# actually getting here means that the
# target was unnecessarily listed
# as a hash, but we'll forgive that
_add_to_file_map($file_map, $subtarget, $curr_path, $file, $matchlevel);
}
} elsif ($targetdir ne 'NONE' and $targetdir ne '') {
my $source = File::Spec->catfile(@$curr_path, $file);
my $destination = File::Spec->catfile('blib', $targetdir, @$dest_path, $file);
#print "$source => $destination\n"; # DEBUG
# quote spaces in file names
# FIXME: this is of questionable portability and
# probably depends on user's make recognizing this
# quoting syntax -- probably better to remove
# spaces and shell metacharacters from all file names
$source =~ s/ /\\ /g;
$destination =~ s/ /\\ /g;
$file_map->{$source} = $destination;
}
}
=head2 get_cli_values
Reads values provided on cli for configuration values
=cut
sub get_cli_values {
my $values = shift;
my $map = {
INSTALL_MODE => $cli_koha_install_mode,
DB_TYPE => $cli_koha_db_type,
DB_HOST => $cli_koha_db_host,
DB_PORT => $cli_koha_db_port,
DB_NAME => $cli_koha_db_name,
DB_USER => $cli_koha_db_user,
DB_PASS => $cli_koha_db_pass,
ZEBRA_MARC_FORMAT => $cli_zebra_marc_format,
ZEBRA_LANGUAGE => $cli_zebra_language,
ZEBRA_TOKENIZER => $cli_zebra_tokenizer,
ZEBRA_USER => $cli_zebra_user,
ZEBRA_PASS => $cli_zebra_pass,
ZEBRA_SRU_HOST => $cli_zebra_sru_host,
ZEBRA_SRU_BIBLIOS_PORT => $cli_zebra_sru_bib_port,
ZEBRA_SRU_AUTHORITIES_PORT => $cli_zebra_sru_auth_port,
KOHA_USER => $cli_koha_user,
KOHA_GROUP => $cli_koha_group,
INSTALL_SRU => $cli_koha_install_sru,
USE_MEMCACHED => $cli_koha_use_memcached,
FONT_DIR => $cli_koha_font_dir,
RUN_DATABASE_TESTS => $cli_koha_run_database_tests,
INSTALL_BASE => $cli_koha_install_base,
TEMPLATE_CACHE_DIR => $cli_koha_template_cache_dir,
SMTP_HOST => $cli_smtp_host,
SMTP_PORT => $cli_smtp_port,
SMTP_TIMEOUT => $cli_smtp_timeout,
SMTP_SSL_MODE => $cli_smtp_ssl_mode,
SMTP_USER_NAME => $cli_smtp_user_name,
SMTP_PASSWORD => $cli_smtp_password,
SMTP_DEBUG => (defined $cli_smtp_debug) ? ( $cli_smtp_debug ? 'yes' : 'no' ) : $values->{SMTP_DEBUG},
};
foreach my $key (keys %{$map}) {
$values->{$key} = $map->{$key} if ($map->{$key});
}
}
=head2 get_install_log_values
Reads value from the Koha install log specified by
--prev-install-log
=cut
sub get_install_log_values {
my $install_log = shift;
my $values = shift;
open my $log, '<', $install_log or die "Cannot open install log $install_log: $!\n";
while (<$log>) {
chomp;
next if /^#/ or /^\s*$/;
next if /^=/;
next unless m/=/;
s/\s+$//g;
my ($key, $value) = split /=/, $_, 2;
$values->{$key} = $value;
}
close $log;
print <<_EXPLAIN_INSTALL_LOG_;
Reading values from install log $install_log. You
will be prompted only for settings that have been
added since the last time you installed Koha. To
be prompted for all settings, run 'perl Makefile.PL'
without the --prev-install-log option.
_EXPLAIN_INSTALL_LOG_
}
=head2 get_configuration
This prompts the user for various configuration options.
=cut
sub get_configuration {
my $defaults = shift;
my $valid_values = shift;
my $install_log_values = shift;
my %config = ();
my $msg = q(
By default, Koha can be installed in one of three ways:
standard: Install files in conformance with the Filesystem
Hierarchy Standard (FHS). This is the default mode
and should be used when installing a production
Koha system. On Unix systems, root access is
needed to complete a standard installation.
single: Install files under a single directory. This option
is useful for installing Koha without root access, e.g.,
on a web host that allows CGI scripts and MySQL databases
but requires the user to keep all files under the user's
HOME directory.
dev: Create a set of symbolic links and configuration files to
allow Koha to run directly from the source distribution.
This mode is useful for developers who want to run
Koha from a git clone.
Installation mode);
$msg .= _add_valid_values_disp('INSTALL_MODE', $valid_values);
$config{'INSTALL_MODE'} = _get_value('INSTALL_MODE', $msg, $defaults->{'INSTALL_MODE'}, $valid_values, $install_log_values);
# set message and default value for INSTALL_BASE
# depending on value of INSTALL_MODE
my $install_base_default = $defaults->{'INSTALL_BASE'};
if ($config{'INSTALL_MODE'} eq 'dev') {
$msg = q(
Please specify the directory in which to install Koha's
active configuration files and (if applicable) the
Zebra database. Koha's CGI scripts and templates will