source: trunk/wiki.cgi @ 854

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

More cleanups after nick in admin code:

  • remove unnecessary capitalization
  • fix all links to wiki.cgi
  • Property svn:eol-style set to native
  • Property svn:executable set to *
  • Property svn:keywords set to Author Date Id Revision
File size: 16.3 KB
Line 
1#!/usr/local/bin/perl
2
3use strict;
4use warnings;
5
6use vars qw( $VERSION );
7$VERSION = '0.56';
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    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    my $oldid        = $q->param('oldid')   || '';
49
50    # Alternative method of calling search, supported by usemod.
51    $action = 'search' if $q->param("search");
52
53    if ($commit) {
54        $guide->commit_node(
55                             id      => $node,
56                             cgi_obj => $q,
57                           );
58    } elsif ($preview) {
59        preview_node($node);
60    } elsif ($action eq 'edit') {
61        edit_node($node);
62    } elsif ($action eq 'search') {
63        do_search($search_terms);
64    } elsif ($action eq 'show_backlinks') {
65        $guide->show_backlinks( id => $node );
66    } elsif ($action eq 'show_wanted_pages') {
67        show_wanted_pages();
68    } elsif ($action eq 'show_needing_moderation') {
69        show_needing_moderation();
70    } elsif ($action eq 'index') {
71        $guide->show_index(
72                            type   => $q->param("index_type") || "Full",
73                            value  => $q->param("index_value") || "",
74                            format => $format,
75                          );
76    } elsif ($action eq 'random') {
77        my @nodes = $wiki->list_all_nodes();
78        $node = $nodes[int(rand(scalar(@nodes) + 1)) + 1];
79        print $guide->redirect_to_node($node);
80    } elsif ($action eq 'find_within_distance') {
81        $guide->find_within_distance(
82                                      id => $node,
83                                      metres => $q->param("distance_in_metres")
84                                    );
85    } elsif ( $action eq 'admin' ) {
86        $guide->display_admin_interface(
87                             moderation_completed => $q->param("moderation"),
88        );
89    } elsif ( $action eq 'show_missing_metadata' ) {
90        $guide->show_missing_metadata(
91                   metadata_type  => $q->param("metadata_type") || "",
92                   metadata_value => $q->param("metadata_value") || "",
93                   exclude_locales => $q->param("exclude_locales") || "",
94                   exclude_categories => $q->param("exclude_categories") || ""
95        );
96    } elsif ( $action eq 'set_moderation' ) {
97        $guide->set_node_moderation(
98                             id       => $node,
99                             password => $q->param("password") || "",
100                             moderation_flag => $q->param("moderation_flag") || "",
101                           );
102    } elsif ( $action eq 'moderate' ) {
103        $guide->moderate_node(
104                             id       => $node,
105                             version  => $q->param("version") || "",
106                             password => $q->param("password") || "",
107                           );
108    } elsif ( $action eq 'delete'
109              and ( lc($config->enable_page_deletion) eq "y"
110                    or $config->enable_page_deletion eq "1" )
111            ) {
112        $guide->delete_node(
113                             id       => $node,
114                             version  => $q->param("version") || "",
115                             password => $q->param("password") || "",
116                           );
117    } elsif ($action eq 'userstats') {
118        show_userstats(
119                        username => $q->param("username") || "",
120                        host     => $q->param("host") || "",
121                      );
122    } elsif ($action eq 'list_all_versions') {
123        if($format && ($format eq "rss" || $format eq "atom")) {
124            my %args = (
125                            feed_type    => $format,
126                            feed_listing => 'node_all_versions',
127                            name         => $node
128            );
129            $guide->display_feed( %args );
130        } else {
131            $guide->list_all_versions( id => $node );
132        }
133    } elsif ($action eq 'rc') {
134        if ($format && $format eq 'rss') {
135            my $feed = $q->param("feed");
136            if ( !defined $feed or $feed eq "recent_changes" ) {
137                my %args = map { $_ => ( $q->param($_) || "" ) }
138                           qw( feed items days ignore_minor_edits username
139                               category locale );
140                $args{feed_type} = 'rss';
141                $args{feed_listing} = 'recent_changes';
142                $guide->display_feed( %args );
143            } elsif ( $feed eq "chef_dan" ) {
144                display_node_rdf( node => $node );
145            } else {
146                croak "Unknown RSS feed type '$feed'";
147            }
148        } elsif ($format && $format eq 'atom') {
149            my %args = map { $_ => ( $q->param($_) || "" ) }
150                       qw( feed items days ignore_minor_edits username
151                           category locale );
152            $args{feed_type} = 'atom';
153            $args{feed_listing} = 'recent_changes';
154            $guide->display_feed( %args );
155        } else {
156            $guide->display_node( id => 'RecentChanges' );
157        }
158    } elsif ($action eq 'rss') {
159        my $redir_target = $script_url . $script_name . '?action=rc;format=rss';
160        my %args = map { $_ => ( $q->param($_) || "" ) }
161            qw( feed items days ignore_minor_edits username
162                category locale );
163        foreach my $arg (sort keys %args) {
164            if ($args{$arg} ne "") {
165                $redir_target .= ";$arg=$args{$arg}";
166            }
167        }
168        print $q->redirect( $redir_target );
169    } elsif ($action eq 'about') {
170        $guide->display_about(format => $format);
171    } else { # Default is to display a node.
172        if ( $format and $format eq "rdf" ) {
173            display_node_rdf( node => $node );
174        } elsif ( $format and $format eq 'raw' ) {
175            $guide->display_node(
176                                  id       => $node,
177                                  format   => 'raw',
178                                );
179        } else {
180            my $version = $q->param("version");
181            my $other_ver = $q->param("diffversion");
182            if ( $other_ver ) {
183                $guide->display_diffs(
184                                       id            => $node,
185                                       version       => $version,
186                                       other_version => $other_ver,
187                                     );
188            } else {
189                my $redirect;
190               
191                if ((defined $q->param("redirect")) && ($q->param("redirect") == 0)) {
192                  $redirect = 0;
193                } else {
194                  $redirect = 1;               
195                }
196               
197                $guide->display_node(
198                                      id       => $node,
199                                      version  => $version,
200                                      oldid    => $oldid,
201                                      redirect => $redirect,
202                                    );
203            }
204        }
205    }
206};
207
208if ($@) {
209    my $error = $@;
210    warn $error;
211    print $q->header;
212    my $contact_email = $config->contact_email;
213    print qq(<html><head><title>ERROR</title></head><body>
214             <p>Sorry!  Something went wrong.  Please contact the
215             Wiki administrator at
216             <a href="mailto:$contact_email">$contact_email</a> and quote
217             the following error message:</p><blockquote>)
218      . $q->escapeHTML($error)
219      . qq(</blockquote><p><a href="$script_name">Return to the Wiki home page</a>
220           </body></html>);
221}
222
223############################ subroutines ###################################
224
225sub show_userstats {
226    my %args = @_;
227    my ($username, $host) = @args{ qw( username host ) };
228    croak "No username or host supplied to show_userstats"
229        unless $username or $host;
230    my %criteria = ( last_n_changes => 5 );
231    $criteria{metadata_was} = $username ? { username => $username }
232                                        : { host     => $host };
233    my @nodes = $wiki->list_recent_changes( %criteria );
234    @nodes = map { {name          => $q->escapeHTML($_->{name}),
235            last_modified => $q->escapeHTML($_->{last_modified}),
236            comment       => $q->escapeHTML($_->{metadata}{comment}[0]),
237            url           => "$script_name?"
238          . $q->escape($formatter->node_name_to_node_param($_->{name})) }
239                       } @nodes;
240    my %tt_vars = ( last_five_nodes => \@nodes,
241            username        => $username,
242            username_param  => $wiki->formatter->node_name_to_node_param($username),
243                    host            => $host,
244                  );
245    process_template("userstats.tt", "", \%tt_vars);
246}
247
248sub preview_node {
249    my $node = shift;
250    my $content  = $q->param('content');
251    $content     =~ s/\r\n/\n/gs;
252    my $checksum = $q->param('checksum');
253
254    my %tt_metadata_vars = OpenGuides::Template->extract_metadata_vars(
255                                               wiki                 => $wiki,
256                           config               => $config,
257                           cgi_obj              => $q,
258                                               set_coord_field_vars => 1,
259    );
260    foreach my $var ( qw( username comment edit_type ) ) {
261        $tt_metadata_vars{$var} = $q->escapeHTML($q->param($var));
262    }
263
264    if ($wiki->verify_checksum($node, $checksum)) {
265        my %tt_vars = (
266            %tt_metadata_vars,
267            config                 => $config,
268            content                => $q->escapeHTML($content),
269            preview_html           => $wiki->format($content),
270            preview_above_edit_box => get_cookie( "preview_above_edit_box" ),
271            checksum               => $q->escapeHTML($checksum)
272        );
273        process_template("edit_form.tt", $node, \%tt_vars);
274    } else {
275        my %node_data = $wiki->retrieve_node($node);
276        my %tt_vars = ( checksum       => $node_data{checksum},
277                        config         => $config,
278                        new_content    => $content,
279                        stored_content => $node_data{content} );
280        foreach my $mdvar ( keys %tt_metadata_vars ) {
281            if ($mdvar eq "locales") {
282                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{locale};
283                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{locale};
284            } elsif ($mdvar eq "categories") {
285                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{category};
286                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{category};
287            } elsif ($mdvar eq "username" or $mdvar eq "comment"
288                      or $mdvar eq "edit_type" ) {
289                $tt_vars{$mdvar} = $tt_metadata_vars{$mdvar};
290            } else {
291                $tt_vars{"stored_$mdvar"} = $node_data{metadata}{$mdvar}[0];
292                $tt_vars{"new_$mdvar"}    = $tt_metadata_vars{$mdvar};
293            }
294        }
295        process_template("edit_conflict.tt", $node, \%tt_vars);
296    }
297}
298
299sub edit_node {
300    my $node = shift;
301    my %node_data = $wiki->retrieve_node($node);
302    my ($content, $checksum) = @node_data{ qw( content checksum ) };
303    my $username = get_cookie( "username" );
304    my $edit_type = get_cookie( "default_edit_type" ) eq "normal" ?
305                        "Normal edit" : "Minor tidying";
306
307    my %metadata_vars = OpenGuides::Template->extract_metadata_vars(
308                             wiki     => $wiki,
309                             config   => $config,
310                 metadata => $node_data{metadata} );
311
312    $metadata_vars{website} ||= 'http://';
313
314    my %tt_vars = ( content         => $q->escapeHTML($content),
315                    checksum        => $q->escapeHTML($checksum),
316                    %metadata_vars,
317                    config          => $config,
318                    username        => $username,
319                    edit_type       => $edit_type,
320                    deter_robots    => 1,
321    );
322
323    process_template("edit_form.tt", $node, \%tt_vars);
324}
325
326sub get_cookie {
327    my $pref_name = shift or return "";
328    my %cookie_data = OpenGuides::CGI->get_prefs_from_cookie(config=>$config);
329    return $cookie_data{$pref_name};
330}
331
332sub display_node_rdf {
333    my %args = @_;
334    my $rdf_writer = OpenGuides::RDF->new( wiki      => $wiki,
335                       config => $config );
336    print "Content-type: application/rdf+xml\n\n";
337    print $rdf_writer->emit_rdfxml( node => $args{node} );
338}
339
340sub process_template {
341    my ($template, $node, $vars, $conf, $omit_header) = @_;
342
343    my %output_conf = ( wiki     => $wiki,
344            config   => $config,
345                        node     => $node,
346            template => $template,
347            vars     => $vars
348    );
349    $output_conf{content_type} = "" if $omit_header; # defaults otherwise
350    print OpenGuides::Template->output( %output_conf );
351}
352
353
354sub do_search {
355    my $terms = shift;
356    my %finds = $wiki->search_nodes($terms);
357#    my @sorted = sort { $finds{$a} cmp $finds{$b} } keys %finds;
358    my @sorted = sort keys %finds;
359    my @results = map {
360        { url   => $q->escape($formatter->node_name_to_node_param($_)),
361      title => $q->escapeHTML($_)
362        }             } @sorted;
363    my %tt_vars = ( results      => \@results,
364                    num_results  => scalar @results,
365                    not_editable => 1,
366                    search_terms => $q->escapeHTML($terms) );
367    process_template("search_results.tt", "", \%tt_vars);
368}
369
370sub show_wanted_pages {
371    my @dangling = $wiki->list_dangling_links;
372    my @wanted;
373    my %backlinks_count;
374    foreach my $node_name (@dangling) {
375        $backlinks_count{$node_name} = scalar($wiki->list_backlinks( node => $node_name ));
376    }
377    foreach my $node_name (sort { $backlinks_count{$b} <=> $backlinks_count{$a} } @dangling) {
378        my $node_param =
379         uri_escape($formatter->node_name_to_node_param($node_name));
380        push @wanted, {
381            name          => $q->escapeHTML($node_name),
382            edit_link     => $script_url . uri_escape($script_name)
383                           . "?action=edit;id=$node_param",
384            backlink_link => $script_url . uri_escape($script_name)
385                    . "?action=show_backlinks;id=$node_param",
386            backlinks_count => $backlinks_count{$node_name}
387        };
388    }
389    process_template( "wanted_pages.tt",
390                      "",
391                      { not_editable  => 1,
392                        not_deletable => 1,
393                        deter_robots  => 1,
394                        wanted        => \@wanted } );
395}
396
397sub show_needing_moderation {
398    my @nodes = $wiki->list_unmoderated_nodes;
399
400    # Build the moderate links
401    foreach my $node (@nodes) {
402        my $node_param =
403            uri_escape($formatter->node_name_to_node_param($node->{'name'}));
404        $node->{'moderate_url'} = $script_name . "?action=moderate&id=".$node_param."&version=".$node->{'version'};
405        $node->{'view_url'} = $script_name . "?id=".$node_param."&version=".$node->{'version'};
406        $node->{'diff_url'} = $script_name . "?id=".$node_param."&version=".$node->{'moderated_version'}."&diffversion=".$node->{'version'};
407    }
408
409    process_template( "needing_moderation.tt",
410                      "",
411                      { not_editable  => 1,
412                        not_deletable => 1,
413                        deter_robots  => 1,
414                        nodes        => \@nodes } );
415}
Note: See TracBrowser for help on using the repository browser.