source: trunk/wiki.cgi @ 621

Last change on this file since 621 was 621, checked in by Dominic Hargreaves, 17 years ago

Use environment variable OPENGUIDES_CONFIG_FILE for config file location;
will be useful for mod_perl. Also add error checking to OpenGuides::Config
config file opening.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 11.4 KB
Line 
1#!/usr/local/bin/perl
2
3use strict;
4use warnings;
5
6use vars qw( $VERSION );
7$VERSION = '0.47';
8
9use CGI qw/:standard/;
10use CGI::Carp qw(croak);
11use CGI::Wiki;
12use Geography::NationalGrid;
13use Geography::NationalGrid::GB;
14use OpenGuides;
15use OpenGuides::CGI;
16use OpenGuides::Config;
17use OpenGuides::RDF;
18use OpenGuides::Utils;
19use OpenGuides::Template;
20use Time::Piece;
21use URI::Escape;
22
23my $config_file = $ENV{OPENGUIDES_CONFIG_FILE} || "wiki.conf";
24my $config = OpenGuides::Config->new( file => $config_file );
25
26my $script_name = $config->script_name;
27my $script_url  = $config->script_url;
28
29my ($guide, $wiki, $formatter, $q);
30eval {
31    $guide = OpenGuides->new( config => $config );
32    $wiki = $guide->wiki;
33    $formatter = $wiki->formatter;
34
35    # Get CGI object, find out what to do.
36    $q = CGI->new;
37
38    # Note $q->param('keywords') gives you the entire param string.
39    # We need this to do URLs like foo.com/wiki.cgi?This_Page
40    my $node = $q->param('id') || $q->param('title') || $q->param('keywords') || "";
41    $node = $formatter->node_param_to_node_name( $node );
42
43    my $action = $q->param('action') || 'display';
44    my $commit = $q->param('Save') || 0;
45    my $preview = $q->param('preview') || 0;
46    my $search_terms = $q->param('terms') || $q->param('search') || '';
47    my $format = $q->param('format') || '';
48
49    # Alternative method of calling search, supported by usemod.
50    $action = 'search' if $q->param("search");
51
52    if ($commit) {
53        $guide->commit_node(
54                             id      => $node,
55                             cgi_obj => $q,
56                           );
57    } elsif ($preview) {
58        preview_node($node);
59    } elsif ($action eq 'edit') {
60        edit_node($node);
61    } elsif ($action eq 'search') {
62        do_search($search_terms);
63    } elsif ($action eq 'show_backlinks') {
64        $guide->show_backlinks( id => $node );
65    } elsif ($action eq 'show_wanted_pages') {
66        show_wanted_pages();
67    } elsif ($action eq 'index') {
68        $guide->show_index(
69                            type   => $q->param("index_type") || "Full",
70                            value  => $q->param("index_value") || "",
71                            format => $format,
72                          );
73    } elsif ($action eq 'random') {
74        my @nodes = $wiki->list_all_nodes();
75        $node = $nodes[int(rand(scalar(@nodes) + 1)) + 1];
76        print $guide->redirect_to_node($node);
77        exit 0;
78    } elsif ($action eq 'find_within_distance') {
79        $guide->find_within_distance(
80                                      id => $node,
81                                      metres => $q->param("distance_in_metres")
82                                    );
83    } elsif ( $action eq 'delete'
84              and ( lc($config->enable_page_deletion) eq "y"
85                    or $config->enable_page_deletion eq "1" )
86            ) {
87        $guide->delete_node(
88                             id       => $node,
89                             version  => $q->param("version") || "",
90                             password => $q->param("password") || "",
91                           );
92    } elsif ($action eq 'userstats') {
93        show_userstats(
94                        username => $q->param("username") || "",
95                        host     => $q->param("host") || "",
96                      );
97    } elsif ($action eq 'list_all_versions') {
98        $guide->list_all_versions( id => $node );
99    } elsif ($action eq 'rss') {
100        my $feed = $q->param("feed");
101        if ( !defined $feed or $feed eq "recent_changes" ) {
102            my %args = map { $_ => ( $q->param($_) || "" ) }
103                       qw( feed items days ignore_minor_edits username
104                           category locale );
105            $guide->display_rss( %args );
106        } elsif ( $feed eq "chef_dan" ) {
107            display_node_rdf( node => $node );
108        } else {
109            croak "Unknown RSS feed type '$feed'";
110        }
111    } else { # Default is to display a node.
112        if ( $format and $format eq "rdf" ) {
113            display_node_rdf( node => $node );
114        } else {
115            my $version = $q->param("version");
116            my $other_ver = $q->param("diffversion");
117            if ( $other_ver ) {
118                $guide->display_diffs(
119                                       id            => $node,
120                                       version       => $version,
121                                       other_version => $other_ver,
122                                     );
123            } else {
124                $guide->display_node( id => $node, version => $version );
125            }
126        }
127    }
128};
129
130if ($@) {
131    my $error = $@;
132    warn $error;
133    print $q->header;
134    my $contact_email = $config->contact_email;
135    print qq(<html><head><title>ERROR</title></head><body>
136             <p>Sorry!  Something went wrong.  Please contact the
137             Wiki administrator at
138             <a href="mailto:$contact_email">$contact_email</a> and quote
139             the following error message:</p><blockquote>)
140      . $q->escapeHTML($error)
141      . qq(</blockquote><p><a href="$script_name">Return to the Wiki home page</a>
142           </body></html>);
143}
144exit 0;
145
146############################ subroutines ###################################
147
148sub show_userstats {
149    my %args = @_;
150    my ($username, $host) = @args{ qw( username host ) };
151    croak "No username or host supplied to show_userstats"
152        unless $username or $host;
153    my %criteria = ( last_n_changes => 5 );
154    $criteria{metadata_was} = $username ? { username => $username }
155                                        : { host     => $host };
156    my @nodes = $wiki->list_recent_changes( %criteria );
157    @nodes = map { {name          => $q->escapeHTML($_->{name}),
158                    last_modified => $q->escapeHTML($_->{last_modified}),
159                    comment       => $q->escapeHTML($_->{metadata}{comment}[0]),
160                    url           => "$script_name?"
161          . $q->escape($formatter->node_name_to_node_param($_->{name})) }
162                       } @nodes;
163    my %tt_vars = ( last_five_nodes => \@nodes,
164                    username        => $username,
165                    username_param  => $wiki->formatter->node_name_to_node_param($username),
166                    host            => $host,
167                  );
168    process_template("userstats.tt", "", \%tt_vars);
169}
170
171sub preview_node {
172    my $node = shift;
173    my $content  = $q->param('content');
174    $content     =~ s/\r\n/\n/gs;
175    my $checksum = $q->param('checksum');
176
177    my %tt_metadata_vars = OpenGuides::Template->extract_metadata_vars(
178                                               wiki                 => $wiki,
179                                               config               => $config,
180                                               cgi_obj              => $q,
181                                               set_coord_field_vars => 1,
182    );
183    foreach my $var ( qw( username comment edit_type ) ) {
184        $tt_metadata_vars{$var} = $q->escapeHTML($q->param($var));
185    }
186
187    if ($wiki->verify_checksum($node, $checksum)) {
188        my %tt_vars = (
189            %tt_metadata_vars,
190            content                => $q->escapeHTML($content),
191            preview_html           => $wiki->format($content),
192            preview_above_edit_box => get_cookie( "preview_above_edit_box" ),
193            checksum               => $q->escapeHTML($checksum)
194        );
195        process_template("edit_form.tt", $node, \%tt_vars);
196    } else {
197        my %node_data = $wiki->retrieve_node($node);
198        my %tt_vars = ( checksum       => $node_data{checksum},
199                        new_content    => $content,
200                        stored_content => $node_data{content} );
201        foreach my $mdvar ( keys %tt_metadata_vars ) {
202            if ($mdvar eq "locales") {
203                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{locale};
204                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{locale};
205            } elsif ($mdvar eq "categories") {
206                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{category};
207                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{category};
208            } elsif ($mdvar eq "username" or $mdvar eq "comment"
209                      or $mdvar eq "edit_type" ) {
210                $tt_vars{$mdvar} = $tt_metadata_vars{$mdvar};
211            } else {
212                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{$mdvar}[0];
213                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{$mdvar};
214            }
215        }
216        process_template("edit_conflict.tt", $node, \%tt_vars);
217    }
218}
219
220sub edit_node {
221    my $node = shift;
222    my %node_data = $wiki->retrieve_node($node);
223    my ($content, $checksum) = @node_data{ qw( content checksum ) };
224    my $username = get_cookie( "username" );
225    my $edit_type = get_cookie( "default_edit_type" ) eq "normal" ?
226                        "Normal edit" : "Minor tidying";
227
228    my %metadata_vars = OpenGuides::Template->extract_metadata_vars(
229                             wiki     => $wiki,
230                             config   => $config,
231                             metadata => $node_data{metadata} );
232
233    my %tt_vars = ( content         => $q->escapeHTML($content),
234                    checksum        => $q->escapeHTML($checksum),
235                    %metadata_vars,
236                    username        => $username,
237                    edit_type       => $edit_type,
238                    deter_robots    => 1,
239    );
240
241    process_template("edit_form.tt", $node, \%tt_vars);
242}
243
244sub get_cookie {
245    my $pref_name = shift or return "";
246    my %cookie_data = OpenGuides::CGI->get_prefs_from_cookie(config=>$config);
247    return $cookie_data{$pref_name};
248}
249
250sub display_node_rdf {
251    my %args = @_;
252    my $rdf_writer = OpenGuides::RDF->new( wiki      => $wiki,
253                                           config => $config );
254    print "Content-type: text/plain\n\n";
255    print $rdf_writer->emit_rdfxml( node => $args{node} );
256    exit 0;
257}
258
259sub process_template {
260    my ($template, $node, $vars, $conf, $omit_header) = @_;
261
262    my %output_conf = ( wiki     => $wiki,
263                        config   => $config,
264                        node     => $node,
265                        template => $template,
266                        vars     => $vars
267    );
268    $output_conf{content_type} = "" if $omit_header; # defaults otherwise
269    print OpenGuides::Template->output( %output_conf );
270}
271
272
273sub do_search {
274    my $terms = shift;
275    my %finds = $wiki->search_nodes($terms);
276#    my @sorted = sort { $finds{$a} cmp $finds{$b} } keys %finds;
277    my @sorted = sort keys %finds;
278    my @results = map {
279        { url   => $q->escape($formatter->node_name_to_node_param($_)),
280          title => $q->escapeHTML($_)
281        }             } @sorted;
282    my %tt_vars = ( results      => \@results,
283                    num_results  => scalar @results,
284                    not_editable => 1,
285                    search_terms => $q->escapeHTML($terms) );
286    process_template("search_results.tt", "", \%tt_vars);
287}
288
289sub show_wanted_pages {
290    my @dangling = $wiki->list_dangling_links;
291    @dangling = sort @dangling;
292    my @wanted;
293    foreach my $node_name (@dangling) {
294        my $node_param =
295            uri_escape($formatter->node_name_to_node_param($node_name));
296        push @wanted, {
297            name          => $q->escapeHTML($node_name),
298            edit_link     => $script_url . uri_escape($script_name)
299                           . "?action=edit;id=$node_param",
300            backlink_link => $script_url . uri_escape($script_name)
301                           . "?action=show_backlinks;id=$node_param"
302        };
303    }
304    process_template( "wanted_pages.tt",
305                      "",
306                      { not_editable  => 1,
307                        not_deletable => 1,
308                        deter_robots  => 1,
309                        wanted        => \@wanted } );
310}
311
Note: See TracBrowser for help on using the repository browser.