source: trunk/Build.PL @ 1034

Last change on this file since 1034 was 1029, checked in by kake, 14 years ago

Don't print stuff about skipping individual questions (SQLite, Plucene) if we're skipping the config step altogether (thanks Bob).

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