source: trunk/Build.PL @ 998

Last change on this file since 998 was 998, checked in by Dominic Hargreaves, 15 years ago

Update for new templates

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