source: trunk/wiki.cgi @ 551

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

Release 0.44.

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