Changeset 294

Timestamp:

05/18/06 16:44:39 (6 years ago)

Author:

nick

Message:

More splitting of data fetch and rendering, this time for Atom

Location:

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed

Files:

• Atom.pm (modified) (5 diffs)
• RSS.pm (modified) (3 diffs)

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/Atom.pm

@@ -55 +55 @@
 
   my $wiki = $self->{wiki};
+
+  my %criteria = (
+                   ignore_case => 1,
+                 );
+
+  # If we're not passed any parameters to limit the items returned, default to 15.
+  $args{days} ? $criteria{days}           = $args{days}
+              : $criteria{last_n_changes} = $args{items} || 15;
+  
+  $criteria{metadata_wasnt} = { major_change => 0 }     if $args{ignore_minor_edits};
+  $criteria{metadata_was}   = $args{filter_on_metadata} if $args{filter_on_metadata};
+
+  my @changes = $wiki->list_recent_changes(%criteria);
+  my $atom_timestamp = $self->feed_timestamp(%args);
+
+  return $self->generate_node_list_feed($atom_timestamp, @changes);
+}
+
+=item <generate_node_list_feed>
+  
+Generate and return an Atom feed for a list of nodes
+  
+=cut
+sub generate_node_list_feed {
+  my ($self,$atom_timestamp,@nodes) = @_;
 
   my $generator = '';
@@ -67 +92 @@
   }                          
 
-  my %criteria = (
-                   ignore_case => 1,
-                 );
-
-  # If we're not passed any parameters to limit the items returned, default to 15.
-  $args{days} ? $criteria{days}           = $args{days}
-              : $criteria{last_n_changes} = $args{items} || 15;
-  
-  $criteria{metadata_wasnt} = { major_change => 0 }     if $args{ignore_minor_edits};
-  $criteria{metadata_was}   = $args{filter_on_metadata} if $args{filter_on_metadata};
-
-  my @changes = $wiki->list_recent_changes(%criteria);
-
   my $subtitle = $self->{site_description}
                  ? '<subtitle>' . $self->{site_description} . "</subtitle>\n"
@@ -88 +100 @@
 <feed xmlns="http://www.w3.org/2005/Atom">
 
-  <link href="}            . $self->{site_url}            . qq{" />
-  <title>}                 . $self->{site_name}           . qq{</title>
-  <link rel="self" href="} . $self->{atom_link}           . qq{" />
-  <updated>}               . $self->feed_timestamp(%args) . qq{</updated>
-  <id>}                    . $self->{site_url}            . qq{</id>
+  <link href="}            . $self->{site_url}     . qq{" />
+  <title>}                 . $self->{site_name}    . qq{</title>
+  <link rel="self" href="} . $self->{atom_link}    . qq{" />
+  <updated>}               . $atom_timestamp       . qq{</updated>
+  <id>}                    . $self->{site_url}     . qq{</id>
   $subtitle};
 
   my (@urls, @items);
 
-  foreach my $change (@changes)
-  {
-    my $node_name = $change->{name};
-
-    my $item_timestamp = $change->{last_modified};
+  foreach my $node (@nodes)
+  {
+    my $node_name = $node->{name};
+
+    my $item_timestamp = $node->{last_modified};
     
     # Make a Time::Piece object.
@@ -110 +122 @@
     $item_timestamp = $time->strftime( "%Y-%m-%dT%H:%M:%S$utc_offset" );
 
-    my $author      = $change->{metadata}{username}[0] || $change->{metadata}{host}[0] || 'Anonymous';
-    my $description = $change->{metadata}{comment}[0]  || 'No description given for change';
+    my $author      = $node->{metadata}{username}[0] || $node->{metadata}{host}[0] || 'Anonymous';
+    my $description = $node->{metadata}{comment}[0]  || 'No description given for node';
 
     $description .= " [$author]" if $author;
 
-    my $version = $change->{version};
+    my $version = $node->{version};
     my $status  = (1 == $version) ? 'new' : 'updated';
 
-    my $major_change = $change->{metadata}{major_change}[0];
+    my $major_change = $node->{metadata}{major_change}[0];
        $major_change = 1 unless defined $major_change;
     my $importance = $major_change ? 'major' : 'minor';
@@ -182 +194 @@
 =head1 NAME
 
-  Wiki::Toolkit::Feed::Atom - A Wiki::Toolkit plugin to output RecentChanges RSS.
+  Wiki::Toolkit::Feed::Atom - A Wiki::Toolkit plugin to output RecentChanges Atom.
 
 =head1 DESCRIPTION

wiki-toolkit/trunk/lib/Wiki/Toolkit/Feed/RSS.pm

@@ -154 +154 @@
   my (@urls, @items);
 
-  foreach my $change (@nodes)
-  {
-    my $node_name = $change->{name};
-
-    my $timestamp = $change->{last_modified};
+  foreach my $node (@nodes)
+  {
+    my $node_name = $node->{name};
+
+    my $timestamp = $node->{last_modified};
     
     # Make a Time::Piece object.
@@ -167 +167 @@
     $timestamp = $time->strftime( "%Y-%m-%dT%H:%M:%S$utc_offset" );
 
-    my $author      = $change->{metadata}{username}[0] || $change->{metadata}{host}[0] || '';
-    my $description = $change->{metadata}{comment}[0]  || '';
+    my $author      = $node->{metadata}{username}[0] || $node->{metadata}{host}[0] || '';
+    my $description = $node->{metadata}{comment}[0]  || '';
 
     $description .= " [$author]" if $author;
 
-    my $version = $change->{version};
+    my $version = $node->{version};
     my $status  = (1 == $version) ? 'new' : 'updated';
 
-    my $major_change = $change->{metadata}{major_change}[0];
+    my $major_change = $node->{metadata}{major_change}[0];
        $major_change = 1 unless defined $major_change;
     my $importance = $major_change ? 'major' : 'minor';
@@ -239 +239 @@
 }
 
+=item B<rss_timestamp>
+
+Generate the timestamp for the RSS, by figuring out the age range of
+the source data for the feed
+
+=cut
 sub rss_timestamp
 {