small text formatting change, added spaces
[koha.git] / Makefile.PL
blobe7c6f2c769016618fc3087ac7298a31b35af3928
1 # Copyright 2007 MJ Ray
3 # This file is part of Koha.
5 # Koha is free software; you can redistribute it and/or modify it 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.
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.
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
18 # Current maintainer MJR http://mjr.towers.org.uk/
19 # See http://www.koha.org/wiki/?page=KohaInstaller
21 # 2007-11-05 Corrected CGI copy to include entire 'installer' subdir structure. -fbcit
22 use ExtUtils::MakeMaker;
23 use POSIX;
25 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
27 =head1 NAME
29 Makefile.PL - Koha packager and installer
31 =head1 SYNOPSIS
33 =head2 BASIC INSTALLATION
35         perl Makefile.PL
36         make
37         sudo make install
39 =head2 PACKAGING RELEASE TARBALLS
41         make manifest tardist
42         make manifest zipdist
44 =head2 CLEANING UP
46         make clean
48 =head1 DESCRIPTION
50 This is a packager and installer that uses
51 ExtUtils::MakeMaker, which is fairly common
52 on perl systems.
53 As well as building tar or zip files
54 and installing with the above commands,
55 it allows us to check pre-requisites
56 and generate configuration files.
58 =head1 VARIABLES
60 =head2 NAME, VERSION_FROM, ABSTRACT, AUTHOR
62 Basic metadata about this software.
64 =head2 NO_META
66 Suppress generation of META.yml file.
68 =head2 PREREQ_PM
70 Hash of perl modules and versions required.
72 =head2 PM
74 Hash of file mappings
76 =head2 CONFIGURE
78 Maybe use prompt() here in future to get configuration values 
79 interactively at installation time.
81 =head2 PL_FILES
83 This is a hash of PL scripts to run after installation and
84 the files to ask them to generate.
85 Maybe use the values from CONFIGURE
86 to generate initial configuration files in future.
88 =cut
90 WriteMakefile(
92     NAME => 'koha',
93     #VERSION => strftime('2.9.%Y%m%d%H',gmtime),
94     VERSION_FROM => 'C4/Context.pm',
95     ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
96     AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
97     NO_META => 1,
98     PREREQ_PM => {
99 'CGI' => 3.15,
100 'CGI::Carp' => 1.29,
101 'CGI::Session' => '4.10',
102 'Class::Factory::Util' => 1.7,
103 'Class::Accessor' => 0.30,
104 'DBD::mysql' => 3.0008,
105 'DBI' => 1.53,
106 'Data::Dumper' => 2.121_08,
107 'Date::Calc' => 5.4,
108 'Date::Manip' => 5.44,
109 'Digest::MD5' => 2.36,
110 'File::Temp' => 0.16,
111 'GD::Barcode::UPCE' => 1.1,
112 'Getopt::Long' => 2.35,
113 'Getopt::Std' => 1.05,
114 'HTML::Template::Pro' => 0.65,
115 'HTTP::Cookies' => 1.39,
116 'HTTP::Request::Common' => 1.26,
117 'LWP::Simple' => 1.41,
118 'LWP::UserAgent' => 2.033,
119 'Lingua::Stem' => 0.82,
120 'List::Util' => 1.18,
121 'Locale::Language' => 2.07,
122 'MARC::Charset' => 0.95,
123 'MARC::File::XML' => 0.86,
124 'MARC::Record' => 1.38,
125 'MIME::Base64' => 3.07,
126 'MIME::QuotedPrint' => 3.07,
127 'Mail::Sendmail' => 0.79,
128 'PDF::API2' => 2.000,
129 'PDF::API2::Page' => 2.000,
130 'PDF::API2::Util' => 2.000,
131 'PDF::Reuse' => 0.33,
132 'PDF::Reuse::Barcode' => 0.05,
133 'POSIX' => 1.09,
134 'Schedule::At' => 1.06,
135 'Term::ANSIColor' => 1.10,
136 'Test' => 1.25,
137 'Test::Harness' => 2.56,
138 'Test::More' => 0.62,
139 'Text::CSV' => 0.01,
140 'Text::Wrap' => 2005.082401,
141 'Time::HiRes' => 1.86,
142 'Time::localtime' => 1.02,
143 'Unicode::Normalize' => 0.32,
144 'XML::Dumper' => 0.81,
145 'XML::LibXML' => 1.59,
146 'XML::SAX::ParserFactory' => 1.01,
147 'XML::Simple' => 2.14,
148 'XML::RSS' => 1.31,
149 'ZOOM' => 1.16,
150         },
152         # File tree mapping
153         PM => map_tree(),
155         # disable tests
156         'test' => {TESTS => 't/dummy.t'},
158 #   CONFIGURE => sub {
159 #     # Ask for options with prompt($question,$default) calls here?
160 #     return { macro => { 'export TEST' => '755' } }
161 #     },
163    PL_FILES => { # generator => target(s)
164       'rewrite-config.PL' => [
165          '$(PREFIX)/share/koha/etc/koha-conf.xml',
166          '$(PREFIX)/share/koha/etc/koha-httpd.conf',
167          '$(PREFIX)/share/koha/etc/zebradb/etc/passwd',
168          '$(PREFIX)/share/koha/etc/zebradb/zebra-biblios.cfg',
169          '$(PREFIX)/share/koha/etc/zebradb/zebra-authorities.cfg'
170          ]
171    }
172 #     'opac/getfromintranet.PL' => ['$(INST_LIBDIR)/opac/cgi-bin/detail.pl','$(INST_LIBDIR)/opac/cgi-bin/moredetail.pl','$(INST_LIBDIR)/opac/cgi-bin/search.pl','$(INST_LIBDIR)/opac/cgi-bin/subjectsearch.pl','$(INST_LIBDIR)/opac/cgi-bin/logout.pl'],
173 #     'misc/koha.conf.PL' => '$(INST_LIBDIR)/../etc/koha.conf',
174 #     'misc/apache-koha.conf.PL' => '$(INST_LIBDIR)/../etc/apache-koha.conf',
175 #     'misc/koha.sql.PL' => '$(INST_LIBDIR)/intranet/scripts/koha.sql',
176 #     'z3950/z3950-daemon-options.PL' => '$(INST_LIBDIR)/intranet/scripts/z3950daemon/z3950-daemon-options',
177 #     # fake target to check permissions
178 #     'misc/chmod.PL' => '$(INST_LIBDIR)/fake-target'
179 #     }
180    # need to set ownerships
181    # need to load koha.sql
182    # need to link koha-httpd.conf
183    # need to start z3950-daemon
186 =head1 FUNCTIONS
188 =head2 map_tree
190 This function lists all files and where to install each one.
191 It returns a hash reference suitable for the PM variable above.
193 =cut
195 sub map_tree {
196         my %result => ();
198 =pod
200 C4/*.pm is copied to perl's lib namespace.
202 =cut
203         foreach my $src (glob("C4/*.pm")) {
204                 $result{$src} = '$(INST_LIBDIR)/'.$src;
205         }
207 =pod
209 CGIs are copied to $(PREFIX)/lib/cgi-bin/koha/
210 and other scripts to koha/
212 =cut
213         foreach my $src ("mainpage.pl","help.pl","kohaversion.pl",glob("*/*.pl"),glob("installer/*"),glob("installer/*/*/*/*"),glob("*/*/*.pl"),glob("*/*/*/*.pl")) {
214                 if ($src =~ /(misc|updater|rss)\//) {
215                         $result{$src} = '$(INST_LIBDIR)/koha/'.$src;
216                 } else {
217                         $result{$src} = '$(PREFIX)/lib/cgi-bin/koha/'.$src;
218                 }
219         }
221 =pod
223 Templates are copied to koha/templates,
225 =cut
226         foreach my $src (glob("koha-tmpl/*"),glob("koha-tmpl/intranet-tmpl/*/*/*"),glob("koha-tmpl/intranet-tmpl/*/*/*/*"),glob("koha-tmpl/intranet-tmpl/*/*/*/*/*"),glob("koha-tmpl/opac-tmpl/*/*/*"),glob("koha-tmpl/opac-tmpl/*/*/*/*"),glob("koha-tmpl/opac-tmpl/*/*/*/*/*")) {
228 =pod
230 excluding non-files, CVS files and whitespace in filenames.
232 =cut
233                 if ((-f $src) && ($src !~ /(\/CVS\/|\s)/)) {
234                         $result{$src} = '$(INST_LIBDIR)/koha/templates/'.$src;
235                 }
236         }
237 =pod
239 etc files are copied to /usr/share/koha/etc/
241 =cut
242         # Misc etc to koha/etc
243         foreach my $src (glob("etc/zebradb/*/*/*"),glob("etc/zebradb/*/*"),glob("etc/zebradb/*"),glob("etc/*")) {
244                 if (-f $src) {
245                         $result{$src} = '$(PREFIX)/share/koha/'.$src;
246                 }
247         }
250         return \%result;
253 __END__
256 =head1 SEE ALSO
258 ExtUtils::MakeMaker(3)
260 =head1 AUTHOR
262 MJ Ray mjr at phonecoop.coop
264 =cut