Changeset 753

Timestamp:

04/05/06 02:26:00 (3 years ago)

Author:

earle

Message:

New module, OpenGuides::Feed: this extracts the stuff formerly in OpenGuides::RDF (as sub make_recentchanges_rss) that was invoking CGI::Wiki::Plugin::RSS::ModWiki, and replaces it with a single make_feed method that can be used for any feed format, including Atom (using the new CGI::Wiki::Plugin::Atom). Changes to OpenGuides.pm and wiki.cgi are to use this new module appropriately.

Location:

trunk

Files:

• Build.PL (modified) (1 diff)
• MANIFEST (modified) (1 diff)
• PREREQUISITES (modified) (1 diff)
• lib/OpenGuides.pm (modified) (8 diffs)
• lib/OpenGuides/Feed.pm (added)
• lib/OpenGuides/RDF.pm (modified) (5 diffs)
• t/22_rss_modwiki.t (modified) (2 diffs)
• wiki.cgi (modified) (3 diffs)

trunk/Build.PL

@@ -221 +221 @@
         'CGI::Wiki'                       => '0.62',  # fixed delete version
         'CGI::Wiki::Formatter::UseMod'    => '0.16',  # macros
+        'CGI::Wiki::Plugin::Atom'         => 0,
         'CGI::Wiki::Plugin::Categoriser'  => 0,
         'CGI::Wiki::Plugin::Diff'         => '0.08',  # earlier buggy

trunk/MANIFEST

@@ -18 +18 @@
 lib/OpenGuides/CGI.pm
 lib/OpenGuides/Config.pm
+lib/OpenGuides/Feed.pm
 lib/OpenGuides/RDF.pm
 lib/OpenGuides/Search.pm

trunk/PREREQUISITES

@@ -9 +9 @@
 CGI::Wiki (version 0.62 or later)
 CGI::Wiki::Formatter::UseMod (version 0.16 or later)
+CGI::Wiki::Plugin::Atom
 CGI::Wiki::Plugin::Categoriser
 CGI::Wiki::Plugin::Diff (version 0.08 or later)

trunk/lib/OpenGuides.pm

@@ -7 +7 @@
 use CGI::Wiki::Plugin::Locator::Grid;
 use OpenGuides::CGI;
+use OpenGuides::Feed;
 use OpenGuides::Template;
 use OpenGuides::Utils;
@@ -14 +15 @@
 use vars qw( $VERSION );
 
-$VERSION = '0.52';
+$VERSION = '0.53';
 
 =head1 NAME
@@ -155 +156 @@
         $tt_vars{"rss_".lc($type)."_url"} =
                            $config->script_name . "?action=rc;format=rss;"
+                           . lc($type) . "=" . lc(CGI->escape($2));
+        $tt_vars{"atom_".lc($type)."_url"} =
+                           $config->script_name . "?action=rc;format=atom;"
                            . lc($type) . "=" . lc(CGI->escape($2));
     }
@@ -637 +641 @@
 }
 
-=item B<display_rss>
-
-  # Last ten non-minor edits to Hammersmith pages.
-  $guide->display_rss(
+=item B<display_feed>
+
+  # Last ten non-minor edits to Hammersmith pages in RSS 1.0 format
+  $guide->display_feed(
+                         feed_type          => 'rss',
                          items              => 10,
                          ignore_minor_edits => 1,
@@ -646 +651 @@
                      );
 
-  # All edits bob has made to pub pages in the last week.
-  $guide->display_rss(
-                         days     => 7,
-                         username => "bob",
-                         category => "Pubs",
+  # All edits bob has made to pub pages in the last week in Atom format
+  $guide->display_feed(
+                         feed_type => 'atom',
+                         days      => 7,
+                         username  => "bob",
+                         category  => "Pubs",
                      );
+
+C<feed_type> is a mandatory parameter. Supported values at present are 
+"rss" and "atom".
 
 As with other methods, the C<return_output> parameter can be used to
@@ -658 +667 @@
 =cut
 
-sub display_rss {
+sub display_feed {
     my ($self, %args) = @_;
 
+    my $feed_type = $args{feed_type};
+    croak "No feed type given" unless $feed_type;
+    
     my $return_output = $args{return_output} ? 1 : 0;
 
@@ -673 +685 @@
                        days               => $days,
                        ignore_minor_edits => $ignore_minor_edits,
+                       feed_type          => $feed_type,
                    );
     my %filter;
@@ -682 +695 @@
     }
 
-    my $rdf_writer = OpenGuides::RDF->new(
-                                             wiki       => $self->wiki,
-                                             config     => $self->config,
-                                             og_version => $VERSION,
-                                         );
-    my $output = "Content-Type: application/rdf+xml\n";
-    $output .= "Last-Modified: " . $rdf_writer->rss_timestamp( %criteria ) . "\n\n";
-    $output .= $rdf_writer->make_recentchanges_rss( %criteria );
+    my $feed = OpenGuides::Feed->new(
+                                        wiki       => $self->wiki,
+                                        config     => $self->config,
+                                        og_version => $VERSION,
+                                    );
+
+    my $output;
+    
+    if ($feed_type eq 'rss') {
+        $output = "Content-Type: application/rdf+xml\n";
+    }
+    elsif ($feed_type eq 'atom') {
+        $output = "Content-Type: application/atom+xml\n";
+    }
+    else {
+        croak "Unknown feed type given: $feed_type";
+    }
+    
+    $output .= "Last-Modified: " . $feed->feed_timestamp( %criteria ) . "\n\n";
+
+    $output .= $feed->make_feed( %criteria );
+
     return $output if $return_output;
     print $output;

trunk/lib/OpenGuides/RDF.pm

@@ -4 +4 @@
 
 use vars qw( $VERSION );
-$VERSION = '0.08';
+$VERSION = '0.09';
 
 use CGI::Wiki::Plugin::RSS::ModWiki;
@@ -200 +200 @@
 }
 
-sub rss_maker {
-    my $self = shift;
-
-    # OAOO, please.
-    unless ($self->{rss_maker}) {
-        $self->{rss_maker} = CGI::Wiki::Plugin::RSS::ModWiki->new(
-          wiki                => $self->{wiki},
-          site_name           => $self->{site_name},
-          site_url            => $self->{config}->script_url,
-          site_description    => $self->{site_description},
-          make_node_url       => $self->{make_node_url},
-          recent_changes_link => $self->{config}->script_url . '?action=rc',
-          software_name       => 'OpenGuides',
-          software_homepage   => 'http://openguides.org/',
-          software_version    => $self->{og_version},
-        );
-    }
-    
-    $self->{rss_maker};
-}
-
-sub make_recentchanges_rss {
-    my ($self, %args) = @_;
-
-    $self->rss_maker->recent_changes(%args);
-}
-
-sub rss_timestamp {
-    my ($self, %args) = @_;
-    
-    $self->rss_maker->rss_timestamp(%args);
-}
-
 =head1 NAME
 
@@ -258 +225 @@
     print "Content-Type: application/rdf+xml\n\n";
     print $rdf_writer->emit_rdfxml( node => "Masala Zone, N1 0NU" );
-
-    # Ten most recent changes.
-    print "Content-Type: application/rdf+xml\n";
-    print "Last-Modified: " . $self->rss_timestamp( items => 10 ) . "\n\n";
-    print $rdf_writer->make_recentchanges_rss( items => 10 );
 
 =head1 METHODS
@@ -315 +277 @@
 =back
 
-=item B<rss_maker>
-
-Returns a raw L<CGI::Wiki::Plugin::RSS::ModWiki> object created with the values you
-invoked this module with.
-
-=item B<make_recentchanges_rss>
-
-    # Ten most recent changes.
-    print "Content-Type: application/rdf+xml\n";
-    print "Last-Modified: " . $rdf_writer->rss_timestamp( items => 10 ) . "\n\n";
-    print $rdf_writer->make_recentchanges_rss( items => 10 );
-
-    # All the changes made by bob in the past week, ignoring minor edits.
-
-    my %args = (
-                 days               => 7,
-                 ignore_minor_edits => 1,
-                 filter_on_metadata => { username => "bob" },
-               );
-
-    print "Content-Type: application/rdf+xml\n";
-    print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n";
-    print $rdf_writer->make_recentchanges_rss( %args );
-
-=item B<rss_timestamp>
-
-    print "Last-Modified: " . $rdf_writer->rss_timestamp( %args ) . "\n\n";
-
-Returns the timestamp of the RSS feed in POSIX::strftime style ("Tue, 29 Feb 2000 
-12:34:56 GMT"), which is equivalent to the timestamp of the most recent item
-in the feed. Takes the same arguments as make_recentchanges_rss(). You will most 
-likely need this to print a Last-Modified HTTP header so user-agents can determine
-whether they need to reload the feed or not.
+=head1 SEE ALSO
+
+=over 4
+
+=item * L<CGI::Wiki>
+
+=item * L<http://openguides.org/>
+
+=item * L<http://chefmoz.org/>
 
 =back
 
-=head1 SEE ALSO
-
-=over 4
-
-=item * L<CGI::Wiki>
-
-=item * L<http://openguides.org/>
-
-=item * L<http://chefmoz.org/>
-
-=back
-
 =head1 AUTHOR
 
@@ -369 +295 @@
 =head1 COPYRIGHT
 
-Copyright (C) 2003-2005 The OpenGuides Project.  All Rights Reserved.
+Copyright (C) 2003-2006 The OpenGuides Project.  All Rights Reserved.
 
 This module is free software; you can redistribute it and/or modify it

trunk/t/22_rss_modwiki.t

@@ -43 +43 @@
 my $wiki = OpenGuides::Utils->make_wiki_object( config => $config );
 
-my $rdf_writer = OpenGuides::RDF->new( wiki   => $wiki,
-                                       config => $config );
+my $feed = OpenGuides::Feed->new( wiki   => $wiki,
+                                  config => $config );
 
-my $rss = eval { $rdf_writer->make_recentchanges_rss; };
-is( $@, "", "->make_recentchanges_rss doesn't croak" );
+my $rss = eval { $feed->make_feed(feed_type => 'rss'); };
+is( $@, "", "->make_feed for rss doesn't croak" );
 
 # Now write some data, first a minor edit then a non-minor one.
@@ -98 +98 @@
 
 # Check that the minor edits can be filtered out.
-$output = $guide->display_rss(
+$output = $guide->display_feed(
+                               feed_type          => "rss",
                                items              => 5,
                                username           => "bob",

trunk/wiki.cgi

@@ -5 +5 @@
 
 use vars qw( $VERSION );
-$VERSION = '0.52';
+$VERSION = '0.53';
 
 use CGI qw/:standard/;
@@ -104 +104 @@
                            qw( feed items days ignore_minor_edits username
                                category locale );
-                $guide->display_rss( %args );
+                $args{feed_type} = 'rss';
+                $guide->display_feed( %args );
             } elsif ( $feed eq "chef_dan" ) {
                 display_node_rdf( node => $node );
@@ -110 +111 @@
                 croak "Unknown RSS feed type '$feed'";
             }
+        } elsif ($format && $format eq 'atom') {
+            my %args = map { $_ => ( $q->param($_) || "" ) }
+                       qw( feed items days ignore_minor_edits username
+                           category locale );
+            $args{feed_type} = 'atom';
+            $guide->display_feed( %args );
         } else {
             $guide->display_node( id => 'RecentChanges' );