Perltidy mainpage.pl
[wip/koha-chris_n.git] / Makefile.PL
1 # Copyright 2007 MJ Ray
2 #
3 # This file is part of Koha.
4 #
5 # Koha is free software; you can redistribute it and/or modify it under the
6 # terms of the GNU General Public License as published by the Free Software
7 # Foundation; either version 2 of the License, or (at your option) any later
8 # version.
9 #
10 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
11 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
12 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
13 #
14 # You should have received a copy of the GNU General Public License along 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
20
21 use ExtUtils::MakeMaker;
22 use POSIX;
23
24 die "perl 5.6.1 or later required" unless ($] >= 5.006001);
25
26 =head1 NAME
27
28 Makefile.PL - Koha packager and installer
29
30 =head1 SYNOPSIS
31
32         perl Makefile.PL
33         make
34         sudo make install
35         make manifest tardist
36         make manifest zipdist
37
38 =head1 DESCRIPTION
39
40 This is a packager and installer that uses
41 ExtUtils::MakeMaker, which is fairly common
42 on perl systems.
43 As well as building tar or zip files
44 and installing,
45 it allows us to check pre-requisites
46 and generate configuration files.
47
48 =head1 VARIABLES
49
50 =head2 NAME, VERSION, ABSTRACT, AUTHOR
51
52 Basic metadata about this software.
53
54 =head2 NO_META
55
56 Suppress generation of META.yml file.
57
58 =head2 PREREQ_PM
59
60 Hash of perl modules and versions required.
61
62 =head2 PM
63
64 Hash of file mappings
65
66 =head2 CONFIGURE
67
68 Maybe use prompt() here in future to get configuration values at installation time.
69
70 =head2 PL_FILES
71
72 This is a hash of PL scripts to run after installation and
73 the files to ask them to generate.
74 Maybe use the values from CONFIGURE
75 to generate initial configuration files.
76
77 =cut
78
79 WriteMakefile(
80
81     NAME => 'koha',
82     VERSION => strftime('2.9.%Y%m%d%H',gmtime),
83     ABSTRACT => 'Award-winning integrated library system (ILS) and Web OPAC',
84     AUTHOR => 'Koha Developers <koha-devel@nongnu.org>',
85     NO_META => 1,
86     PREREQ_PM => {
87 'CGI' => 3.15,
88 'CGI::Carp' => 1.29,
89 'DBI' => 1.53,
90 'Data::Dumper' => 2.121_08,
91 'Data::Random' => 0.05,
92 'Date::Calc' => 5.4,
93 'Date::Manip' => 5.44,
94 'Digest::MD5' => 2.36,
95 'File::Temp' => 0.16,
96 'GD::Barcode::UPCE' => 1.1,
97 'Getopt::Long' => 2.35,
98 'Getopt::Std' => 1.05,
99 'HTML::Template::Pro' => 0.65,
100 'HTML::Tree' => 3.1901,
101 'HTTP::Cookies' => 1.39,
102 'HTTP::Request::Common' => 1.26,
103 'LWP::Simple' => 1.41,
104 'LWP::UserAgent' => 2.033,
105 'Lingua::Stem' => 0.82,
106 'List::Util' => 1.18,
107 'Locale::Language' => 2.07,
108 'MARC::Charset' => 0.95,
109 'MARC::File::XML' => 0.86,
110 'MARC::Record' => 1.38,
111 'MIME::Base64' => 3.07,
112 'MIME::QuotedPrint' => 3.07,
113 'Mail::Sendmail' => 0.79,
114 'PDF::API2' => 2.000,
115 'PDF::API2::Page' => 2.000,
116 'PDF::API2::Util' => 2.000,
117 'PDF::Reuse' => 0.33,
118 'PDF::Reuse::Barcode' => 0.05,
119 'POSIX' => 1.09,
120 'Term::ANSIColor' => 1.10,
121 'Test' => 1.25,
122 'Test::Harness' => 2.56,
123 'Test::More' => 0.62,
124 'Text::Wrap' => 2005.082401,
125 'Time::HiRes' => 1.86,
126 'Time::localtime' => 1.02,
127 'Unicode::Normalize' => 0.32,
128 'XML::LibXML' => 1.59,
129 'XML::SAX::ParserFactory' => 1.01,
130 'XML::Simple' => 2.14,
131 'ZOOM' => 0,
132         },
133
134         # File tree mapping
135         PM => map_tree(),
136
137 #   CONFIGURE => sub {
138 #     # Ask for options with prompt($question,$default) calls here?
139 #     return { macro => { 'export TEST' => '755' } }
140 #     },
141
142 #   PL_FILES => { # generator => target
143 #     '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'],
144 #     'misc/koha.conf.PL' => '$(INST_LIBDIR)/../etc/koha.conf',
145 #     'misc/apache-koha.conf.PL' => '$(INST_LIBDIR)/../etc/apache-koha.conf',
146 #     'misc/koha.sql.PL' => '$(INST_LIBDIR)/intranet/scripts/koha.sql',
147 #     'z3950/z3950-daemon-options.PL' => '$(INST_LIBDIR)/intranet/scripts/z3950daemon/z3950-daemon-options',
148 #     # fake target to check permissions
149 #     'misc/chmod.PL' => '$(INST_LIBDIR)/fake-target'
150 #     }
151    # need to set ownerships
152    # need to load koha.sql
153    # need to link koha-httpd.conf
154    # need to start z3950-daemon
155 );
156
157 =head1 FUNCTIONS
158
159 =head2 map_tree
160
161 This function lists all files and where to install each one.
162 It returns a hash reference suitable for PM.
163
164 =cut
165
166 sub map_tree {
167         my %result => ();
168
169 =pod
170
171 C4/*.pm is copied to perl's lib namespace.
172
173 =cut
174         foreach my $src (glob("C4/*.pm")) {
175                 $result{$src} = '$(INST_LIBDIR)/'.$src;
176         }
177
178 =pod
179
180 CGIs are copied to koha/cgi-bin
181 and other scripts to koha/examples.
182
183 =cut
184         # Misc scripts to koha/examples
185         foreach my $src (glob("*.pl"),glob("*/*.pl"),glob("installer/*.pm"),glob("*/*/*.pl"),glob("*/*/*/*.pl")) {
186                 if ($src =~ /(misc|updater|rss)\//) {
187                         $result{$src} = '$(INST_LIBDIR)/koha/scripts/'.$src;
188                 } else {
189                         $result{$src} = '$(INST_LIBDIR)/koha/cgi-bin/'.$src;
190                 }
191         }
192
193 =pod
194
195 Templates are copied to koha/templates,
196
197 =cut
198         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/*/*/*/*/*")) {
199
200 =pod
201
202 excluding non-files, CVS files and whitespace in filenames.
203
204 =cut
205                 if ((-f $src) && ($src !~ /(\/CVS\/|\s)/)) {
206                         $result{$src} = '$(INST_LIBDIR)/koha/templates/'.$src;
207                 }
208         }
209
210         return \%result;
211 }
212
213 __END__
214
215
216 =head1 SEE ALSO
217
218 ExtUtils::MakeMaker(3)
219
220 =cut
221