source: trunk/Build.PL @ 1128

Last change on this file since 1128 was 1128, checked in by Earle Martin, 14 years ago

Add Geo::Coordinates::UTM to prerequisites - RDF test was failing and others were being skipped.

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