source: trunk/wiki.cgi @ 1014

Last change on this file since 1014 was 1014, checked in by kake, 15 years ago

Move random page functionality from wiki.cgi into OpenGuides.pm and add some tests.

  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 13.8 KB
Line 
1#!/usr/local/bin/perl
2
3use strict;
4use warnings;
5
6use vars qw( $VERSION );
7$VERSION = '0.59';
8
9use CGI qw/:standard/;
10use CGI::Carp qw(croak);
11use Wiki::Toolkit;
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    # If we did a post, then CGI->param probably hasn't fully de-escaped,
44    #  in the same way as a get would've done
45    my $request_method = $q->request_method() || '';
46    if($request_method eq 'POST') {
47        $node = uri_unescape($node);
48    }
49
50    # Grab our common parameters
51    my $action       = $q->param('action')  || 'display';
52    my $commit       = $q->param('Save')    || 0;
53    my $preview      = $q->param('preview') || 0;
54    my $search_terms = $q->param('terms')   || $q->param('search') || '';
55    my $format       = $q->param('format')  || '';
56    my $oldid        = $q->param('oldid')   || '';
57
58    # Alternative method of calling search, supported by usemod.
59    $action = 'search' if $q->param("search");
60
61    if ($commit) {
62        $guide->commit_node(
63                             id      => $node,
64                             cgi_obj => $q,
65                           );
66    } elsif ($preview) {
67        $guide->preview_edit(
68                              id      => $node,
69                              cgi_obj => $q,
70                            );
71    } elsif ($action eq 'edit') {
72        $guide->display_edit_form( id => $node );
73    } elsif ($action eq 'search') {
74        do_search($search_terms);
75    } elsif ($action eq 'show_backlinks') {
76        $guide->show_backlinks( id => $node );
77    } elsif ($action eq 'show_wanted_pages') {
78        show_wanted_pages();
79    } elsif ($action eq 'show_needing_moderation') {
80        show_needing_moderation();
81    } elsif ($action eq 'index') {
82        $guide->show_index(
83                            type   => $q->param("index_type") || "Full",
84                            value  => $q->param("index_value") || "",
85                            format => $format,
86                          );
87    } elsif ($action eq 'random') {
88        print $guide->display_random_page;
89    } elsif ($action eq 'find_within_distance') {
90        $guide->find_within_distance(
91                                      id => $node,
92                                      metres => $q->param("distance_in_metres")
93                                    );
94    } elsif ( $action eq 'admin' ) {
95        $guide->display_admin_interface(
96                             moderation_completed => $q->param("moderation"),
97        );
98    } elsif ( $action eq 'revert_user' ) {
99        $guide->revert_user_interface(
100                        username => $q->param("username") || "",
101                        host     => $q->param("host") || "",
102                        password => $q->param("password") || "",
103        );
104    } elsif ( $action eq 'show_missing_metadata' ) {
105        $guide->show_missing_metadata(
106                   metadata_type  => $q->param("metadata_type") || "",
107                   metadata_value => $q->param("metadata_value") || "",
108                   exclude_locales => $q->param("exclude_locales") || "",
109                   exclude_categories => $q->param("exclude_categories") || ""
110        );
111    } elsif ( $action eq 'set_moderation' ) {
112        $guide->set_node_moderation(
113                             id       => $node,
114                             password => $q->param("password") || "",
115                             moderation_flag => $q->param("moderation_flag") || "",
116                           );
117    } elsif ( $action eq 'moderate' ) {
118        $guide->moderate_node(
119                             id       => $node,
120                             version  => $q->param("version") || "",
121                             password => $q->param("password") || "",
122                           );
123    } elsif ( $action eq 'delete'
124              and ( lc($config->enable_page_deletion) eq "y"
125                    or $config->enable_page_deletion eq "1" )
126            ) {
127        $guide->delete_node(
128                             id       => $node,
129                             version  => $q->param("version") || "",
130                             password => $q->param("password") || "",
131                           );
132    } elsif ($action eq 'userstats') {
133        show_userstats(
134                        username => $q->param("username") || "",
135                        host     => $q->param("host") || "",
136                      );
137    } elsif ($action eq 'list_all_versions') {
138        if($format && ($format eq "rss" || $format eq "atom")) {
139            my %args = (
140                            feed_type    => $format,
141                            feed_listing => 'node_all_versions',
142                            name         => $node
143            );
144            $guide->display_feed( %args );
145        } else {
146            $guide->list_all_versions( id => $node );
147        }
148    } elsif ($action eq 'rc') {
149        if ($format && $format eq 'rss') {
150            my $feed = $q->param("feed");
151            if ( !defined $feed or $feed eq "recent_changes" ) {
152                my %args = map { $_ => ( $q->param($_) || "" ) }
153                           qw( feed items days ignore_minor_edits username
154                               category locale );
155                $args{feed_type} = 'rss';
156                $args{feed_listing} = 'recent_changes';
157                $guide->display_feed( %args );
158            } elsif ( $feed eq "chef_dan" ) {
159                display_node_rdf( node => $node );
160            } else {
161                croak "Unknown RSS feed type '$feed'";
162            }
163        } elsif ($format && $format eq 'atom') {
164            my %args = map { $_ => ( $q->param($_) || "" ) }
165                       qw( feed items days ignore_minor_edits username
166                           category locale );
167            $args{feed_type} = 'atom';
168            $args{feed_listing} = 'recent_changes';
169            $guide->display_feed( %args );
170        } else {
171            $guide->display_node( id => 'RecentChanges' );
172        }
173    } elsif ($action eq 'rss') {
174        my $redir_target = $script_url . $script_name . '?action=rc;format=rss';
175        my %args = map { $_ => ( $q->param($_) || "" ) }
176            qw( feed items days ignore_minor_edits username
177                category locale );
178        foreach my $arg (sort keys %args) {
179            if ($args{$arg} ne "") {
180                $redir_target .= ";$arg=$args{$arg}";
181            }
182        }
183        print $q->redirect( $redir_target );
184    } elsif ($action eq 'about') {
185        $guide->display_about(format => $format);
186    } else { # Default is to display a node.
187        if ( $format and $format eq "rdf" ) {
188            display_node_rdf( node => $node );
189        } elsif ( $format and $format eq 'raw' ) {
190            $guide->display_node(
191                                  id       => $node,
192                                  format   => 'raw',
193                                );
194        } else {
195            my $version = $q->param("version");
196            my $other_ver = $q->param("diffversion");
197            if ( $other_ver ) {
198                $guide->display_diffs(
199                                       id            => $node,
200                                       version       => $version,
201                                       other_version => $other_ver,
202                                     );
203            } else {
204                my $redirect;
205               
206                if ((defined $q->param("redirect")) && ($q->param("redirect") == 0)) {
207                  $redirect = 0;
208                } else {
209                  $redirect = 1;               
210                }
211               
212                $guide->display_node(
213                                      id       => $node,
214                                      version  => $version,
215                                      oldid    => $oldid,
216                                      redirect => $redirect,
217                                    );
218            }
219        }
220    }
221};
222
223if ($@) {
224    my $error = $@;
225    warn $error;
226    print $q->header;
227    my $contact_email = $config->contact_email;
228    print qq(<html><head><title>ERROR</title></head><body>
229             <p>Sorry!  Something went wrong.  Please contact the
230             Wiki administrator at
231             <a href="mailto:$contact_email">$contact_email</a> and quote
232             the following error message:</p><blockquote>)
233      . $q->escapeHTML($error)
234      . qq(</blockquote><p><a href="$script_name">Return to the Wiki home page</a>
235           </body></html>);
236}
237
238############################ subroutines ###################################
239
240sub show_userstats {
241    my %args = @_;
242    my ($username, $host) = @args{ qw( username host ) };
243    croak "No username or host supplied to show_userstats"
244        unless $username or $host;
245    my %criteria = ( last_n_changes => 5 );
246    $criteria{metadata_was} = $username ? { username => $username }
247                                        : { host     => $host };
248    my @nodes = $wiki->list_recent_changes( %criteria );
249    @nodes = map { {name          => $q->escapeHTML($_->{name}),
250            last_modified => $q->escapeHTML($_->{last_modified}),
251            comment       => $q->escapeHTML($_->{metadata}{comment}[0]),
252            url           => "$script_name?"
253          . $q->escape($formatter->node_name_to_node_param($_->{name})) }
254                       } @nodes;
255    my %tt_vars = ( last_five_nodes => \@nodes,
256            username        => $username,
257            username_param  => $wiki->formatter->node_name_to_node_param($username),
258                    host            => $host,
259                  );
260    process_template("userstats.tt", "", \%tt_vars);
261}
262
263sub get_cookie {
264    my $pref_name = shift or return "";
265    my %cookie_data = OpenGuides::CGI->get_prefs_from_cookie(config=>$config);
266    return $cookie_data{$pref_name};
267}
268
269sub display_node_rdf {
270    my %args = @_;
271    my $rdf_writer = OpenGuides::RDF->new( wiki      => $wiki,
272                       config => $config );
273    print "Content-type: application/rdf+xml\n\n";
274    print $rdf_writer->emit_rdfxml( node => $args{node} );
275}
276
277sub process_template {
278    my ($template, $node, $vars, $conf, $omit_header) = @_;
279
280    my %output_conf = ( wiki     => $wiki,
281            config   => $config,
282                        node     => $node,
283            template => $template,
284            vars     => $vars
285    );
286    $output_conf{content_type} = "" if $omit_header; # defaults otherwise
287    print OpenGuides::Template->output( %output_conf );
288}
289
290
291sub do_search {
292    my $terms = shift;
293    my %finds = $wiki->search_nodes($terms);
294#    my @sorted = sort { $finds{$a} cmp $finds{$b} } keys %finds;
295    my @sorted = sort keys %finds;
296    my @results = map {
297        { url   => $q->escape($formatter->node_name_to_node_param($_)),
298      title => $q->escapeHTML($_)
299        }             } @sorted;
300    my %tt_vars = ( results      => \@results,
301                    num_results  => scalar @results,
302                    not_editable => 1,
303                    search_terms => $q->escapeHTML($terms) );
304    process_template("search_results.tt", "", \%tt_vars);
305}
306
307sub show_wanted_pages {
308    my @dangling = $wiki->list_dangling_links;
309    my @wanted;
310    my %backlinks_count;
311    foreach my $node_name (@dangling) {
312        $backlinks_count{$node_name} = scalar($wiki->list_backlinks( node => $node_name ));
313    }
314    foreach my $node_name (sort { $backlinks_count{$b} <=> $backlinks_count{$a} } @dangling) {
315        my $node_param =
316         uri_escape($formatter->node_name_to_node_param($node_name));
317        push @wanted, {
318            name          => $q->escapeHTML($node_name),
319            edit_link     => $script_url . uri_escape($script_name)
320                           . "?action=edit;id=$node_param",
321            backlink_link => $script_url . uri_escape($script_name)
322                    . "?action=show_backlinks;id=$node_param",
323            backlinks_count => $backlinks_count{$node_name}
324        };
325    }
326    process_template( "wanted_pages.tt",
327                      "",
328                      { not_editable  => 1,
329                        not_deletable => 1,
330                        deter_robots  => 1,
331                        wanted        => \@wanted } );
332}
333
334sub show_needing_moderation {
335    my @nodes = $wiki->list_unmoderated_nodes;
336
337    # Build the moderate links
338    foreach my $node (@nodes) {
339        my $node_param =
340            uri_escape($formatter->node_name_to_node_param($node->{'name'}));
341        $node->{'moderate_url'} = $script_name . "?action=moderate;id=".$node_param.";version=".$node->{'version'};
342        $node->{'view_url'} = $script_name . "?id=".$node_param.";version=".$node->{'version'};
343        $node->{'diff_url'} = $script_name . "?id=".$node_param.";version=".$node->{'moderated_version'}.";diffversion=".$node->{'version'};
344        $node->{'delete_url'} = $script_name . "?action=delete;version=".$node->{'version'}.";id=".$node_param;
345    }
346
347    process_template( "needing_moderation.tt",
348                      "",
349                      { not_editable  => 1,
350                        not_deletable => 1,
351                        deter_robots  => 1,
352                        nodes        => \@nodes } );
353}
Note: See TracBrowser for help on using the repository browser.