source: trunk/Build.PL @ 1238

Last change on this file since 1238 was 1238, checked in by Dominic Hargreaves, 13 years ago

Add Config::Tiny into configure_requires; new enough CPAN will install Config::Tiny before running Build.PL (fixes #224)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.5 KB
Line 
1use strict;
2use lib "lib";
3use Data::Dumper;
4use Getopt::Long;
5
6eval {
7    require Config::Tiny;
8    # OpenGuides::Build and OpenGuides::Config both use Config::Tiny.
9    require OpenGuides::Build;
10    require OpenGuides::Config;
11};
12
13die "Problem loading OpenGuides module or a missing module\n\n$@.\n" if $@;
14
15my $force;
16
17GetOptions('force' => \$force);
18
19unless ($force) {
20        print <<EOF;
21
22Beginning install process... if you already have an OpenGuides
23configuration file and you don't want to have to type in all your config
24parameters over again, abort this process now, copy that file to this
25directory, and start again.
26
27EOF
28
29my $continue = Module::Build->y_n("Continue with install?", "y");
30exit 0 unless $continue;
31}
32
33my $existing_config_file = 'wiki.conf';
34my $existing_config;
35
36if (-f $existing_config_file) {
37    $existing_config = OpenGuides::Config->new(file => $existing_config_file);
38} else {
39    print <<EOF;
40No existing configuration file found; assuming this is a new install.
41See the message above if this isn't correct.
42
43EOF
44    $existing_config = OpenGuides::Config->new();
45}
46
47my %yn_vars = map { $_ => 1 }
48   qw(use_plucene enable_page_deletion navbar_on_home_page backlinks_in_title
49      moderation_requires_password enable_node_image enable_common_categories
50      enable_common_locales recent_changes_on_home_page
51      random_page_omits_locales random_page_omits_categories
52      content_above_navbar_in_html show_gmap_in_node_display force_wgs84
53      send_moderation_notifications);
54
55my $skip_config = $force ? 'y' : Module::Build->y_n("Skip OpenGuides configuration?", "n");
56if ( $skip_config ) {
57    print <<EOF;
58===========================================================================
59Skipping OpenGuides configuration - any configuration options previously
60saved will be used instead.  You may tweak your configuration now by
61editing the 'wiki.conf' file produced by this script.
62===========================================================================
63EOF
64}
65
66my @answers;
67
68# It is an ancient Configurer, and he chooseth one of three.
69my $dbtype;
70my $dbtype_qu = $existing_config->dbtype__qu;
71if ( $skip_config ) {
72    $dbtype = $existing_config->dbtype;
73} else {
74    until ( $dbtype ) {
75        my $def = $existing_config->dbtype;
76        $dbtype = Module::Build->prompt("\n$dbtype_qu", $def);
77        $dbtype = lc($dbtype);
78        $dbtype =~ s/^\s*//;
79        $dbtype =~ s/\s*$//;
80        unless ( $dbtype eq "postgres" or $dbtype eq "mysql"
81                 or $dbtype eq "sqlite" ) {
82            undef $dbtype;
83        }
84    }
85}
86
87# Check they have the relevant DBD driver installed.
88my %drivers = ( postgres => "DBD::Pg",
89                mysql    => "DBD::mysql",
90                sqlite   => "DBD::SQLite",
91              );
92eval "require $drivers{$dbtype}";
93warn "$drivers{$dbtype} is needed to run a $dbtype database" if $@;
94
95push @answers, { question => $dbtype_qu,
96                 variable => "dbtype",
97                 value    => $dbtype };
98
99my $install_directory; # used to suggest template paths
100my $use_plucene = 1; # keep track of this so we know what to put in prereqs
101my $centre_lat = ''; # contains centre lat derived from Google Maps URL
102foreach my $var ( qw(
103   dbname dbuser dbpass dbhost dbport script_name
104   install_directory template_path custom_template_path script_url
105   custom_lib_path use_plucene indexing_directory enable_page_deletion
106   admin_pass stylesheet_url site_name navbar_on_home_page
107   recent_changes_on_home_page random_page_omits_locales
108   random_page_omits_categories content_above_navbar_in_html home_name
109   site_desc default_city default_country contact_email default_language
110   formatting_rules_node backlinks_in_title gmaps_api_key centre_long
111   centre_lat show_gmap_in_node_display default_gmaps_zoom
112   default_gmaps_search_zoom force_wgs84 google_analytics_key
113   licence_name licence_url licence_info_url moderation_requires_password
114   enable_node_image enable_common_categories enable_common_locales
115   spam_detector_module host_checker_module static_path static_url
116   send_moderation_notifications
117  ) ) {
118    my $q_method = $var . "__qu";
119    my $qu  = $existing_config->$q_method;
120    my $type = $yn_vars{$var} ? "y_n" : "";
121    my $def = $existing_config->$var;
122    my $val = $def;
123
124    # Override dbname question for SQLite only.
125    if ( $dbtype eq "sqlite" and $var eq "dbname" ) {
126        $qu = "what's the full filename of the SQLite database this site runs on?";
127    }
128
129    if ( $dbtype eq "sqlite" and
130         ( $var eq "dbuser" or $var eq "dbpass" or $var eq "dbhost" or
131           $var eq "dbport")
132       ) {
133        print "$var not relevant for SQLite... skipping...\n"
134            unless $skip_config;
135        push @answers, { question => $qu,
136                            variable => $var,
137                         value    => "not-used" };
138        next;
139    }
140
141    # We don't ask this for new installs as Search::InvertedIndex is
142    # deprecated
143    if ( $var eq "use_plucene" and $existing_config->$var == 1) {
144        print "Skipping question about plucene\n"
145            unless $skip_config;
146        push @answers, { question => $qu,
147                         variable => $var,
148                         value => 1 };
149        next;
150    }
151
152    # Make sensible suggestions for template paths if we don't already
153    # have them stored.  Not really a default, but a useful hint/shortcut.
154    if ( $var eq "template_path" && !defined $existing_config->$var ) {
155        $def = $install_directory;
156        $def .= "/" unless $def =~ m|/$|;
157        $def .= "templates";
158    }
159    if ( $var eq "custom_template_path" && !defined $existing_config->$var ) {
160        $def = $install_directory;
161        $def .= "/" unless $def =~ m|/$|;
162        $def .= "custom-templates";
163    }
164
165    # If a Google Maps URL was provided last time we know the centre_lat
166    if ( $var eq 'centre_lat' && $centre_lat ) {
167        $val = $centre_lat;
168        next;
169    }   
170
171    # Here is where we actually ask the questions.
172    unless ( $skip_config ) {
173        if ( $type eq "y_n" ) {
174            # may be stored as true/false integer value
175            if ( $def =~ /^\d+$/ ) {
176                $def = $def ? "y" : "n";
177            }
178            $val = Module::Build->y_n("\n$qu ", $def);
179        } else {
180            $val = Module::Build->prompt("\n$qu ", $def);
181        }
182    }
183
184    # Allow user to use a Google Maps URL rather than enter lat/long by hand.
185    # We assume centre_long is being asked for first; ensure so in big list above.
186    if ( $var eq 'centre_long' ) {
187        if ( $val =~ /ll=([-\d.]+),([-\d.]+)/ ) {
188            print "Got a Google Maps URL with centre long,lat: [$1, $2]\n";
189            $val = $1;
190            $centre_lat = $2;
191        }
192    }
193
194    # Store install_directory so we can use it to suggest template paths.
195    $install_directory = $val if $var eq "install_directory";
196
197    # Keep track of chosen search method so we know what to put in prereqs.
198    # From Module::Build docs: ->y_n returns a Perl boolean true or false.
199    $use_plucene = 1 if $var eq "use_plucene" and $val;
200
201    # Make sure that script_url ends in a /
202    if ( $var eq "script_url" and $val !~ /\/$/ ) {
203        $val .= "/";
204    }
205
206    push @answers, { question => $qu,
207                     variable => $var,
208                     value    => $val };
209}
210
211# Now deal with the geo stuff.
212my $geo_handler;
213my $geo_handler_qu = "Distance calculation methods available are:"
214                   . "\n  1) British National Grid"
215                   . "\n  2) Irish National Grid"
216                   . "\n  3) UTM ellipsoid"
217                   . "\nWhich would you like to use?";
218
219if ( $skip_config ) {
220    # We default to GB National Grid for historical reasons.
221    $geo_handler = $existing_config->geo_handler;
222} else {
223    my $choice;
224    until ( $choice ) {
225        my $def = $existing_config->geo_handler;
226        $choice = Module::Build->prompt("\n".$geo_handler_qu, $def);
227        $choice =~ s/^\s*//;
228        $choice =~ s/\s*$//;
229        unless ( $choice eq "1" or $choice eq "2" or $choice eq "3" ) {
230            undef $choice;
231        }
232    }
233    $geo_handler = $choice;
234}
235
236$geo_handler_qu =~ s/\n//gs;
237push @answers, {
238                 question => $geo_handler_qu,
239                 variable => "geo_handler",
240                 value    => $geo_handler,
241               };
242
243if ( $geo_handler eq "3" ) {
244    my $qu = $existing_config->ellipsoid__qu;
245    my $ellipsoid;
246    if ( $skip_config ) {
247        $ellipsoid = $existing_config->ellipsoid;
248    } else {
249        my $def = $existing_config->ellipsoid;
250        $ellipsoid = Module::Build->prompt("\n".$qu, $def);
251        $ellipsoid =~ s/^\s*//;
252        $ellipsoid =~ s/\s*$//;
253    }
254    push @answers, {
255                     question => $qu,
256                     variable => "ellipsoid",
257                     value    => $ellipsoid,
258                   };
259}
260
261# Create a user-friendly config file from answers to prompts.
262open FILE, ">wiki.conf" or die "Can't open wiki.conf for writing: $!";
263foreach my $ans (@answers) {
264    print FILE "# $ans->{question}\n";
265    print FILE "$ans->{variable} = $ans->{value}\n\n";
266}
267close FILE or die "Can't close wiki.conf: $!";
268
269# We currently only support Plucene for new installs, but may support
270# others in future
271my $search_module = $use_plucene ? "Plucene" : "Search::InvertedIndex";
272
273# Create the build object.
274my $build = OpenGuides::Build->new(
275    sign => 1,
276    dist_name => "OpenGuides",
277    module_name => "OpenGuides",
278    dist_version_from => "wiki.cgi",
279    license => "perl",
280    requires => {
281        'Algorithm::Diff'                     => '0.13',  # for sdiff
282        'CGI'                                 => '2.92',  # avoid escapeHTML bug
283        'CGI::Carp'                           => 0,
284        'CGI::Cookie'                         => 0,
285        'Wiki::Toolkit'                       => '0.77',
286        'Wiki::Toolkit::Feed::Atom'           => 0,
287        'Wiki::Toolkit::Feed::RSS'            => 0,
288        'Wiki::Toolkit::Formatter::UseMod'    => 0,
289        'Wiki::Toolkit::Plugin::Categoriser'  => 0,
290        'Wiki::Toolkit::Plugin::Diff'         => 0,
291        'Wiki::Toolkit::Plugin::JSON'         => 0,
292        'Wiki::Toolkit::Plugin::Locator::Grid'=> 0,
293        'Wiki::Toolkit::Plugin::RSS::Reader'  => 0,
294        'Class::Accessor'                     => 0,
295        'Config::Tiny'                        => 0,
296        'Data::Dumper'                        => 0,
297        $drivers{$dbtype}                     => 0,
298        'File::Spec::Functions'               => 0,
299        'File::Temp'                          => 0,
300                'Geo::Coordinates::UTM'               => 0,
301        'Geography::NationalGrid'             => 0,
302        'HTML::Entities'                      => 0,
303        'LWP::Simple'                         => 0,
304        'MIME::Lite'                          => 0,
305        'Parse::RecDescent'                   => 0,
306        $search_module                        => 0,
307        'POSIX'                               => 0,
308        'Template'                            => '2.15', # for hash.delete and string.remove vmethods
309        'Time::Piece'                         => 0,
310        'URI::Escape'                         => 0,
311        'XML::RSS'                            => 0,
312        'Data::Validate::URI'                 => 0,
313        },
314    build_requires => {
315        'Module::Build' => '0.26', # API change for accessing config data
316        'Class::Accessor'                     => 0,
317        'Config::Tiny'                        => 0,
318        'Data::Dumper'                        => 0,
319        },
320    configure_requires => {
321        'Config::Tiny'                        => 0,
322        },
323    recommends => {
324        'DBD::SQLite'                         => 0, # for testing
325        'Test::HTML::Content'                 => 0, # for testing, oddly enough
326        'Wiki::Toolkit::Plugin::Ping' => 0, # for pinging external services
327        'Geo::HelmertTransform'  => 0,      # for correct WGS84 lat/long
328                                            # when using grid systems
329
330    },
331    dynamic_config => 1,
332    create_makefile_pl => "passthrough"
333);
334
335$build->add_to_cleanup( "t/indexes/" );
336$build->add_to_cleanup( "t/node.db" );
337$build->add_to_cleanup( "t/templates/tmp/" );
338
339# Tell OpenGuides::Build which additional scripts and templates to install.
340$build->config_data( __extra_scripts => 
341                      [ "wiki.conf", "preferences.cgi", "search.cgi",
342                        "newpage.cgi" ] );
343$build->config_data( __templates     => [
344                      "admin_home.tt",
345                      "admin_revert_user.tt",
346                      "backlink_results.tt",
347                      "banner.tt",
348                      "blacklisted_host.tt",
349                      "delete_confirm.tt",
350                      "delete_done.tt",
351                      "delete_password_wrong.tt",
352                      "differences.tt",
353                      "display_metadata.tt",
354                      "edit_form.tt",
355                      "edit_form_actions.tt",
356                      "error.tt",
357                      "footer.tt",
358                      "header.tt",
359                      "home_node.tt",
360                      "map_index.tt",
361                      "missing_metadata.tt",
362                      "moderate_confirm.tt",
363                      "moderate_password_wrong.tt",
364                      "navbar.tt",
365                      "navbar_categories.tt",
366                      "navbar_locales.tt",
367                      "navbar_help.tt",
368                      "navbar_admin.tt",
369                      "navbar_home_link.tt",
370                      "navbar_options.tt",
371                      "navbar_revision_info.tt",
372                      "navbar_search.tt",
373                      "navbar_this_page.tt",
374                      "navbar_tools.tt",
375                      "needing_moderation.tt",
376                      "newpage.tt",
377                      "node.tt",
378                      "node_history.tt",
379                      "node_image_fields.tt",
380                      "node_photo_notes.tt",
381                      "node_rdf.tt",
382                      "openguides_information_boxes.tt",
383                      "preferences.tt",
384                      "random_page_failure.tt",
385                      "rdf_index.tt",
386                      "recent_changes.tt",
387                      "search_results.tt",
388                      "site_index.tt",
389                      "search.tt",
390                      "spam_detected.tt",
391                      "userstats.tt",
392                      "wanted_pages.tt"
393    ] );
394
395$build->config_data( __static_files => [
396    # XXX to be supplied when we have some
397    ] );
398
399# Finally write the build script.
400$build->create_build_script;
Note: See TracBrowser for help on using the repository browser.