source: trunk/Build.PL @ 1037

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

Added experimental support for local spam detection modules.

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