Changeset 784

Timestamp:

05/14/06 16:27:00 (3 years ago)

Author:

dom

Message:

Revert changeset 769 to reintroduce Atom support.

Location:

trunk

Files:

• Build.PL (modified) (1 diff)
• Changes (modified) (1 diff)
• PREREQUISITES (modified) (1 diff)
• lib/OpenGuides.pm (modified) (3 diffs)
• lib/OpenGuides/Feed.pm (modified) (7 diffs)
• wiki.cgi (modified) (1 diff)

trunk/Build.PL

@@ -222 +222 @@
         '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/Changes

@@ -1 +1 @@
 "#" items refer to tickets. See <http://dev.openguides.org/report/9> for details.
+
+0.55    ???
+        Support for Atom feeds for RecentChanges.
+        #118 Use Wiki::Toolkit
 
 0.54    21 April 2006

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

@@ -156 +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));
     }
@@ -648 +651 @@
                      );
 
+  # 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".
+"rss" and "atom".
 
 As with other methods, the C<return_output> parameter can be used to
@@ -694 +705 @@
     if ($feed_type eq 'rss') {
         $output = "Content-Type: application/rdf+xml\n";
-    } else {
+    }
+    elsif ($feed_type eq 'atom') {
+        $output = "Content-Type: application/atom+xml\n";
+    }
+    else {
         croak "Unknown feed type given: $feed_type";
     }

trunk/lib/OpenGuides/Feed.pm

@@ -6 +6 @@
 $VERSION = '0.01';
 
+use CGI::Wiki::Plugin::Atom;
 use CGI::Wiki::Plugin::RSS::ModWiki;
 use Time::Piece;
@@ -63 +64 @@
     my %known_types = (
                           'rss'  => 1,
+                          'atom' => 1,
                       );
                       
@@ -71 +73 @@
         return $self->rss_maker->recent_changes(%args);
     }
+    elsif ($feed_type eq 'atom') {
+        return $self->atom_maker->recent_changes(%args);
+    }
+}
+
+sub atom_maker {
+    my $self = shift;
+  
+    unless ($self->{atom_maker}) {
+        $self->{atom_maker} = CGI::Wiki::Plugin::Atom->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',
+            atom_link           => $self->{config}->script_url . '?action=rc&format=atom',
+            software_name       => 'OpenGuides',
+            software_homepage   => 'http://openguides.org/',
+            software_version    => $self->{og_version},
+        );
+    }
+    
+    $self->{atom_maker};
 }
 
@@ -107 +133 @@
 =head1 DESCRIPTION
 
-Produces RSS 1.0 feeds for OpenGuides.  Distributed and 
+Produces RSS 1.0 and Atom 1.0 feeds for OpenGuides.  Distributed and 
 installed as part of the OpenGuides project, not intended for independent
 installation.  This documentation is probably only useful to OpenGuides
@@ -151 +177 @@
 invoked this module with.
 
+=item B<atom_maker>
+
+Returns a raw L<CGI::Wiki::Plugin::Atom> object created with the values you
+invoked this module with.
+
 =item B<make_feed>
 
@@ -160 +191 @@
     print $rdf_writer->make_feed( %args );
 
+    # All the changes made by bob in the past week, ignoring minor edits, in Atom.
+    $args{days}               = 7;
+    $args{ignore_minor_edits  = 1;
+    $args{filter_on_metadata} => { username => "bob" };
+
+    print "Content-Type: application/atom+xml\n";
+    print "Last-Modified: " . $feed->feed_timestamp( %args ) . "\n\n";
+    print $feed->make_feed( %args );
+
 =item B<feed_timestamp>
 
@@ -176 +216 @@
 =over 4
 
-=item * L<CGI::Wiki> and L<CGI::Wiki::Plugin::RSS::ModWiki>
+=item * L<CGI::Wiki>, L<CGI::Wiki::Plugin::RSS::ModWiki> and L<CGI::Wiki::Plugin::Atom>
 
 =item * L<http://openguides.org/>

trunk/wiki.cgi

@@ -111 +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' );