source: trunk/lib/OpenGuides.pm @ 431

Last change on this file since 431 was 431, checked in by kake, 18 years ago

Fix version prereq.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 20.9 KB
Line 
1package OpenGuides;
2use strict;
3
4use Carp "croak";
5use CGI;
6use CGI::Wiki::Plugin::Diff;
7use CGI::Wiki::Plugin::GeoCache;
8use CGI::Wiki::Plugin::Locator::UK;
9use OpenGuides::Template;
10use OpenGuides::Utils;
11use URI::Escape;
12
13use vars qw( $VERSION );
14
15$VERSION = '0.35';
16
17=head1 NAME
18
19OpenGuides - A complete web application for managing a collaboratively-written guide to a city or town.
20
21=head1 DESCRIPTION
22
23The OpenGuides software provides the framework for a collaboratively-written
24city guide.  It is similar to a wiki but provides somewhat more structured
25data storage allowing you to annotate wiki pages with information such as
26category, location, and much more.  It provides searching facilities
27including "find me everything within a certain distance of this place".
28Every page includes a link to a machine-readable (RDF) version of the page.
29
30=head1 METHODS
31
32=over
33
34=item B<new>
35
36  my $guide = OpenGuides->new( config => $config );
37
38=cut
39
40sub new {
41    my ($class, %args) = @_;
42    my $self = {};
43    bless $self, $class;
44    my $wiki = OpenGuides::Utils->make_wiki_object( config => $args{config} );
45    $self->{wiki} = $wiki;
46    $self->{config} = $args{config};
47    my $locator = CGI::Wiki::Plugin::Locator::UK->new;
48    $wiki->register_plugin( plugin => $locator );
49    $self->{locator} = $locator;
50    my $differ = CGI::Wiki::Plugin::Diff->new;
51    $wiki->register_plugin( plugin => $differ );
52    $self->{differ} = $differ;
53    return $self;
54}
55
56=item B<wiki>
57
58An accessor, returns the underlying L<CGI::Wiki> object.
59
60=cut
61
62sub wiki {
63    my $self = shift;
64    return $self->{wiki};
65}
66
67=item B<config>
68
69An accessor, returns the underlying L<Config::Tiny> object.
70
71=cut
72
73sub config {
74    my $self = shift;
75    return $self->{config};
76}
77
78=item B<locator>
79
80An accessor, returns the underlying L<CGI::Wiki::Plugin::Locator::UK> object.
81
82=cut
83
84sub locator {
85    my $self = shift;
86    return $self->{locator};
87}
88
89=item B<differ>
90
91An accessor, returns the underlying L<CGI::Wiki::Plugin::Diff> object.
92
93=cut
94
95sub differ {
96    my $self = shift;
97    return $self->{differ};
98}
99
100=item B<display_node>
101
102  # Print node to STDOUT.
103  $guide->display_node(
104                        id      => "Calthorpe Arms",
105                        version => 2,
106                      );
107
108  # Or return output as a string (useful for writing tests).
109  $guide->display_node(
110                        id            => "Calthorpe Arms",
111                        return_output => 1,
112                      );
113
114  # Or return the hash of variables that will be passed to the template
115  # (not including those set additionally by OpenGuides::Template).
116  $guide->display_node(
117                        id             => "Calthorpe Arms",
118                        return_tt_vars => 1,
119                      );
120
121If C<version> is omitted then the latest version will be displayed.
122
123=cut
124
125sub display_node {
126    my ($self, %args) = @_;
127    my $return_output = $args{return_output} || 0;
128    my $version = $args{version};
129    my $id = $args{id} || $self->config->{_}->{home_name};
130    my $wiki = $self->wiki;
131    my $config = $self->config;
132
133    my %tt_vars;
134
135    if ( $id =~ /^(Category|Locale) (.*)$/ ) {
136        my $type = $1;
137        $tt_vars{is_indexable_node} = 1;
138        $tt_vars{index_type} = lc($type);
139        $tt_vars{index_value} = $2;
140    }
141
142    my %current_data = $wiki->retrieve_node( $id );
143    my $current_version = $current_data{version};
144    undef $version if ($version && $version == $current_version);
145    my %criteria = ( name => $id );
146    $criteria{version} = $version if $version;#retrieve_node default is current
147
148    my %node_data = $wiki->retrieve_node( %criteria );
149    my $raw = $node_data{content};
150    if ( $raw =~ /^#REDIRECT\s+(.+?)\s*$/ ) {
151        my $redirect = $1;
152        # Strip off enclosing [[ ]] in case this is an extended link.
153        $redirect =~ s/^\[\[//;
154        $redirect =~ s/\]\]\s*$//;
155        # See if this is a valid node, if not then just show the page as-is.
156        if ( $wiki->node_exists($redirect) ) {
157            my $output = $self->redirect_to_node($redirect);
158            return $output if $return_output;
159            print $output;
160            exit 0;
161        }
162    }
163    my $content    = $wiki->format($raw);
164    my $modified   = $node_data{last_modified};
165    my %metadata   = %{$node_data{metadata}};
166
167    my %metadata_vars = OpenGuides::Template->extract_metadata_vars(
168                            wiki     => $wiki,
169                            config   => $config,
170                            metadata => $node_data{metadata} );
171
172    %tt_vars = (
173                 %tt_vars,
174                 %metadata_vars,
175                 content       => $content,
176                 geocache_link => $self->make_geocache_link($id),
177                 last_modified => $modified,
178                 version       => $node_data{version},
179                 node_name     => CGI->escapeHTML($id),
180                 node_param    => CGI->escape($id),
181                 language      => $config->{_}->{default_language},
182               );
183
184
185    # We've undef'ed $version above if this is the current version.
186    $tt_vars{current} = 1 unless $version;
187
188    if ($id eq "RecentChanges") {
189        my $minor_edits = $self->get_cookie( "show_minor_edits_in_rc" );
190        my %criteria = ( days => 7 );
191        $criteria{metadata_was} = { edit_type => "Normal edit" }
192          unless $minor_edits;
193        my @recent = $wiki->list_recent_changes( %criteria );
194        @recent = map { {name          => CGI->escapeHTML($_->{name}),
195                         last_modified => CGI->escapeHTML($_->{last_modified}),
196                         comment       => CGI->escapeHTML($_->{metadata}{comment}[0]),
197                         username      => CGI->escapeHTML($_->{metadata}{username}[0]),
198                         host          => CGI->escapeHTML($_->{metadata}{host}[0]),
199                         username_param => CGI->escape($_->{metadata}{username}[0]),
200                         edit_type     => CGI->escapeHTML($_->{metadata}{edit_type}[0]),
201                         url           => "$config->{_}->{script_name}?"
202          . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})) }
203                       } @recent;
204        $tt_vars{recent_changes} = \@recent;
205        $tt_vars{days} = 7;
206        return %tt_vars if $args{return_tt_vars};
207        my $output = $self->process_template(
208                                          id            => $id,
209                                          template      => "recent_changes.tt",
210                                          tt_vars       => \%tt_vars,
211                                            );
212        return $output if $return_output;
213        print $output;
214    } elsif ( $id eq $self->config->{_}->{home_name} ) {
215        my @recent = $wiki->list_recent_changes(
216            last_n_changes => 10,
217            metadata_was   => { edit_type => "Normal edit" },
218        );
219        @recent = map { {name          => CGI->escapeHTML($_->{name}),
220                         last_modified => CGI->escapeHTML($_->{last_modified}),
221                         comment       => CGI->escapeHTML($_->{metadata}{comment}[0]),
222                         username      => CGI->escapeHTML($_->{metadata}{username}[0]),
223                         url           => "$config->{_}->{script_name}?"
224          . CGI->escape($wiki->formatter->node_name_to_node_param($_->{name})) }
225                       } @recent;
226        $tt_vars{recent_changes} = \@recent;
227        return %tt_vars if $args{return_tt_vars};
228        my $output = $self->process_template(
229                                              id            => $id,
230                                              template      => "home_node.tt",
231                                              tt_vars       => \%tt_vars,
232                                            );
233        return $output if $return_output;
234        print $output;
235    } else {
236        return %tt_vars if $args{return_tt_vars};
237        my $output = $self->process_template(
238                                              id            => $id,
239                                              template      => "node.tt",
240                                              tt_vars       => \%tt_vars,
241                                            );
242        return $output if $return_output;
243        print $output;
244    }
245}
246
247=item B<display_diffs>
248
249  $guide->display_diffs(
250                         id            => "Home Page",
251                         version       => 6,
252                         other_version => 5,
253                       );
254
255  # Or return output as a string (useful for writing tests).
256  my $output = $guide->display_diffs(
257                                      id            => "Home Page",
258                                      version       => 6,
259                                      other_version => 5,
260                                      return_output => 1,
261                                    );
262
263  # Or return the hash of variables that will be passed to the template
264  # (not including those set additionally by OpenGuides::Template).
265  my %vars = $guide->display_diffs(
266                                    id             => "Home Page",
267                                    version        => 6,
268                                    other_version  => 5,
269                                    return_tt_vars => 1,
270                                  );
271
272=cut
273
274sub display_diffs {
275    my ($self, %args) = @_;
276    my %diff_vars = $self->differ->differences(
277                                        node          => $args{id},
278                                        left_version  => $args{version},
279                                        right_version => $args{other_version},
280                                              );
281    return %diff_vars if $args{return_tt_vars};
282    my $output = $self->process_template(
283                                          id       => $args{id},
284                                          template => "differences.tt",
285                                          tt_vars  => \%diff_vars
286                                        );
287    return $output if $args{return_output};
288    print $output;
289}
290
291=item B<find_within_distance>
292
293  $guide->find_within_distance(
294                                id => $node,
295                                metres => $q->param("distance_in_metres")
296                              );
297
298=cut
299
300sub find_within_distance {
301    my ($self, %args) = @_;
302    my $node = $args{id};
303    my $metres = $args{metres};
304    my $formatter = $self->wiki->formatter;
305    my @finds = $self->locator->find_within_distance(
306                                                      node   => $node,
307                                                      metres => $metres,
308                                                    );
309    my @nodes;
310    foreach my $find ( @finds ) {
311        my $distance = $self->locator->distance(
312                                                 from_node => $node,
313                                                 to_node   => $find,
314                                                 unit      => "metres"
315                                               );
316        push @nodes, {
317                       name     => $find,
318                       param    => $formatter->node_name_to_node_param($find),
319                       distance => $distance,
320                     };
321    }
322    @nodes = sort { $a->{distance} <=> $b->{distance} } @nodes;
323
324    my %tt_vars = (
325                    nodes        => \@nodes,
326                    origin       => $node,
327                    origin_param => $formatter->node_name_to_node_param($node),
328                    limit        => "$metres metres",
329                  );
330
331    print $self->process_template(
332                                   id       => "index", # KLUDGE
333                                   template => "site_index.tt",
334                                   tt_vars  => \%tt_vars,
335                                 );
336}
337
338=item B<show_index>
339
340  $guide->show_index(
341                      type   => "category",
342                      value  => "pubs",
343                    );
344
345  # RDF version.
346  $guide->show_index(
347                      type   => "locale",
348                      value  => "Holborn",
349                      format => "rdf",
350                    );
351
352  # Or return output as a string (useful for writing tests).
353  $guide->show_index(
354                      type          => "category",
355                      value         => "pubs",
356                      return_output => 1,
357                    );
358
359=cut
360
361sub show_index {
362    my ($self, %args) = @_;
363    my $wiki = $self->wiki;
364    my $formatter = $wiki->formatter;
365    my %tt_vars;
366    my @selnodes;
367
368    if ( $args{type} and $args{value} ) {
369        if ( $args{type} eq "fuzzy_title_match" ) {
370            my %finds = $wiki->fuzzy_title_match( $args{value} );
371            @selnodes = sort { $finds{$a} <=> $finds{$b} } keys %finds;
372            $tt_vars{criterion} = {
373                type  => $args{type},  # for RDF version
374                value => $args{value}, # for RDF version
375                name  => CGI->escapeHTML("Fuzzy Title Match on '$args{value}'")
376            };
377        } else {
378            @selnodes = $wiki->list_nodes_by_metadata(
379                metadata_type  => $args{type},
380                metadata_value => $args{value},
381                ignore_case    => 1,
382            );
383            my $name = ucfirst($args{type}) . " $args{value}" ;
384            my $url = $self->config->{_}->{script_name}
385                      . "?"
386                      . ucfirst( $args{type} )
387                      . "_"
388                      . uri_escape(
389                              $formatter->node_name_to_node_param($args{value})
390                                  );
391            $tt_vars{criterion} = {
392                type  => $args{type},
393                value => $args{value}, # for RDF version
394                name  => CGI->escapeHTML( $name ),
395                url   => $url,
396            };
397        }
398    } else {
399        @selnodes = $wiki->list_all_nodes();
400    }
401
402    my @nodes = map { { name      => $_,
403                        node_data => { $wiki->retrieve_node( name => $_ ) },
404                        param     => $formatter->node_name_to_node_param($_) }
405                    } sort @selnodes;
406
407    $tt_vars{nodes} = \@nodes;
408
409    my ($template, %conf);
410
411    if ( $args{format} and $args{format} eq "rdf" ) {
412        $template = "rdf_index.tt";
413        $conf{content_type} = "text/plain";
414    } else {
415        $template = "site_index.tt";
416    }
417
418    %conf = (
419              %conf,
420              node        => "$args{type} index", # KLUDGE
421              template    => $template,
422              tt_vars     => \%tt_vars,
423    );
424
425    my $output = $self->process_template( %conf );
426    return $output if $args{return_output};
427    print $output;
428}
429
430=item B<list_all_versions>
431
432  $guide->list_all_versions ( id => "Home Page" );
433
434=cut
435
436sub list_all_versions {
437    my ($self, %args) = @_;
438    my $node = $args{id};
439    my %curr_data = $self->wiki->retrieve_node($node);
440    my $curr_version = $curr_data{version};
441    croak "This is the first version" unless $curr_version > 1;
442    my @history;
443    for my $version ( 1 .. $curr_version ) {
444        my %node_data = $self->wiki->retrieve_node( name    => $node,
445                                                    version => $version );
446        # $node_data{version} will be zero if this version was deleted.
447        push @history, { version  => $version,
448                         modified => $node_data{last_modified},
449                         username => $node_data{metadata}{username}[0],
450                         comment  => $node_data{metadata}{comment}[0],
451                       } if $node_data{version};
452    }
453    @history = reverse @history;
454    my %tt_vars = ( node          => $node,
455                    version       => $curr_version,
456                    not_deletable => 1,
457                    history       => \@history );
458    print $self->process_template(
459                                   id       => $node,
460                                   template => "node_history.tt",
461                                   tt_vars  => \%tt_vars,
462                                 );
463}
464
465=item B<delete_node>
466
467  $guide->delete_node(
468                       id       => "FAQ",
469                       version  => 15,
470                       password => "beer",
471                     );
472
473C<version> is optional - if it isn't supplied then all versions of the
474node will be deleted; in other words the node will be entirely
475removed.
476
477If C<password> is not supplied then a form for entering the password
478will be displayed.
479
480=cut
481
482sub delete_node {
483    my ($self, %args) = @_;
484    my $node = $args{id} or croak "No node ID supplied for deletion";
485
486    my %tt_vars = (
487                    not_editable  => 1,
488                    not_deletable => 1,
489                  );
490    $tt_vars{delete_version} = $args{version} || "";
491
492    my $password = $args{password};
493
494    if ($password) {
495        if ($password ne $self->config->{_}->{admin_pass}) {
496            print $self->process_template(
497                                     id       => $node,
498                                     template => "delete_password_wrong.tt",
499                                     tt_vars  => \%tt_vars,
500                                   );
501        } else {
502            $self->wiki->delete_node(
503                                      name    => $node,
504                                      version => $args{version},
505                                    );
506            # Check whether any versions of this node remain.
507            my %check = $self->wiki->retrieve_node( name => $node );
508            $tt_vars{other_versions_remain} = 1 if $check{version};
509            print $self->process_template(
510                                     id       => $node,
511                                     template => "delete_done.tt",
512                                     tt_vars  => \%tt_vars,
513                                   );
514        }
515    } else {
516        print $self->process_template(
517                                 id       => $node,
518                                 template => "delete_confirm.tt",
519                                 tt_vars  => \%tt_vars,
520                               );
521    }
522}
523
524sub process_template {
525    my ($self, %args) = @_;
526    my %output_conf = ( wiki     => $self->wiki,
527                        config   => $self->config,
528                        node     => $args{id},
529                        template => $args{template},
530                        vars     => $args{tt_vars},
531    );
532    if ( $args{content_type} ) {
533        $output_conf{content_type} = "";
534        my $output = "Content-Type: $args{content_type}\n\n"
535                     . OpenGuides::Template->output( %output_conf );
536    } else {
537        return OpenGuides::Template->output( %output_conf );
538    }
539}
540
541sub redirect_to_node {
542    my ($self, $node) = @_;
543    my $script_url = $self->config->{_}->{script_url};
544    my $script_name = $self->config->{_}->{script_name};
545    my $formatter = $self->wiki->formatter;
546    my $param = $formatter->node_name_to_node_param( $node );
547    return CGI->redirect( "$script_url$script_name?$param" );
548}
549
550sub get_cookie {
551    my $self = shift;
552    my $config = $self->config;
553    my $pref_name = shift or return "";
554    my %cookie_data = OpenGuides::CGI->get_prefs_from_cookie(config=>$config);
555    return $cookie_data{$pref_name};
556}
557
558sub make_geocache_link {
559    my $self = shift;
560    my $wiki = $self->wiki;
561    my $config = $self->config;
562    return "" unless $self->get_cookie( "include_geocache_link" );
563    my $node = shift || $config->{_}->{home_name};
564    my %current_data = $wiki->retrieve_node( $node );
565    my %criteria     = ( name => $node );
566    my %node_data    = $wiki->retrieve_node( %criteria );
567    my %metadata     = %{$node_data{metadata}};
568    my $latitude     = $metadata{latitude}[0];
569    my $longitude    = $metadata{longitude}[0];
570    my $geocache     = CGI::Wiki::Plugin::GeoCache->new();
571    my $link_text    = "Look for nearby geocaches";
572
573    if ($latitude && $longitude) {
574        my $cache_url    = $geocache->make_link(
575                                        latitude  => $latitude,
576                                        longitude => $longitude,
577                                        link_text => $link_text
578                                );
579        return $cache_url;
580    }
581    else {
582        return "";
583    }
584}
585
586=back
587
588=head1 BUGS AND CAVEATS
589
590At the moment, the location data uses a United-Kingdom-specific module,
591so the location features might not work so well outside the UK.
592
593=head1 SEE ALSO
594
595=over 4
596
597=item * L<http://london.openguides.org/|The Open Guide to London>, the first and biggest OpenGuides site.
598
599=item * L<http://openguides.org/|The OpenGuides website>, with a list of all live OpenGuides installs.
600
601=item * L<CGI::Wiki>, the Wiki toolkit which does the heavy lifting for OpenGuides
602
603=back
604
605=head1 FEEDBACK
606
607If you have a question, a bug report, or a patch, or you're interested
608in joining the development team, please contact openguides-dev@openguides.org
609(moderated mailing list, will reach all current developers but you'll have
610to wait for your post to be approved) or kake@earth.li (a real person who
611may take a little while to reply to your mail if she's busy).
612
613=head1 AUTHOR
614
615The OpenGuides Project (openguides-dev@openguides.org)
616
617=head1 COPYRIGHT
618
619     Copyright (C) 2003-4 The OpenGuides Project.  All Rights Reserved.
620
621The OpenGuides distribution is free software; you can redistribute it
622and/or modify it under the same terms as Perl itself.
623
624=head1 CREDITS
625
626Programming by Earle Martin, Kake Pugh, Ivor Williams.  Testing and
627bug reporting by Cal Henderson, Bob Walker, Kerry Bosworth, Dominic
628Hargreaves, Simon Cozens, among others.  Much of the Module::Build
629stuff copied from the Siesta project L<http://siesta.unixbeard.net/>
630
631=cut
632
6331;
Note: See TracBrowser for help on using the repository browser.