Add support for RFC 5005 Feed Paging and Archiving in Atom feeds
[catagits/XML-Feed.git] / lib / XML / Feed / Format / Atom.pm
1 # $Id$
2
3 package XML::Feed::Format::Atom;
4 use strict;
5
6 use base qw( XML::Feed );
7 use XML::Atom::Feed;
8 use XML::Atom::Util qw( iso2dt );
9 use List::Util qw( first );
10 use DateTime::Format::W3CDTF;
11 use HTML::Entities;
12
13 use XML::Atom::Entry;
14 XML::Atom::Entry->mk_elem_accessors(qw( lat long ), ['http://www.w3.org/2003/01/geo/wgs84_pos#']);
15
16 use XML::Atom::Content;
17 use XML::Feed::Entry::Format::Atom;
18
19 sub identify {
20     my $class   = shift;
21     my $xml     = shift;
22     my $tag     = $class->_get_first_tag($xml);
23     return ($tag eq 'feed');
24 }
25
26
27 sub init_empty {
28     my ($feed, %args) = @_;
29     $args{'Version'} ||= '1.0';
30     
31     $feed->{atom} = XML::Atom::Feed->new(%args);
32     $feed;
33 }
34
35 sub init_string {
36     my $feed = shift;
37     my($str) = @_;
38     if ($str) {
39         $feed->{atom} = XML::Atom::Feed->new(Stream => $str)
40             or return $feed->error(XML::Atom::Feed->errstr);
41     }
42     $feed;
43 }
44
45 sub format { 'Atom' }
46
47 sub title { shift->{atom}->title(@_) }
48 sub link {
49     my $feed = shift;
50     if (@_) {
51         $feed->{atom}->add_link({ rel => 'alternate', href => $_[0],
52                                   type => 'text/html', });
53     } else {
54         my $l = first { !defined $_->rel || $_->rel eq 'alternate' } $feed->{atom}->link;
55         $l ? $l->href : undef;
56     }
57 }
58
59 sub _rel_link {
60     my $feed = shift;
61     my $rel  = shift;
62     if (@_) {
63         my $uri = shift;
64         $feed->{atom}->add_link({type => "application/atom+xml", rel => $rel, href => $uri});
65         return $uri;
66     } 
67     else
68     {
69         my $l;
70
71         if ($rel eq 'self') {
72             $l = first
73                 { !defined $_->rel || $_->rel eq 'self' }
74                 $feed->{atom}->link;
75                 ;
76         } else {
77             $l = first
78                 { !defined $_->rel || $_->rel eq $rel }
79                 $feed->{atom}->link;
80                 ;
81         }
82
83         return $l ? $l->href : undef;
84     }
85 }
86
87 sub self_link   { shift->_rel_link( 'self', @_ ) }
88 sub first_link  { shift->_rel_link( 'first', @_ ) }
89 sub last_link   { shift->_rel_link( 'last', @_ ) }
90 sub next_link   { shift->_rel_link( 'next', @_ ) }
91 sub previous_link     { shift->_rel_link( 'previous', @_ ) };
92 sub current_link      { shift->_rel_link( 'current', @_ ) }
93 sub prev_archive_link { shift->_rel_link( 'prev-archive', @_ ) }
94 sub next_archive_link { shift->_rel_link( 'next-archive', @_ ) }
95
96 sub description { shift->{atom}->tagline(@_) }
97 sub copyright   { shift->{atom}->copyright(@_) }
98 sub language    { shift->{atom}->language(@_) }
99 sub generator   { shift->{atom}->generator(@_) }
100 sub id          { shift->{atom}->id(@_) }
101 sub updated     { shift->{atom}->updated(@_) }
102 sub add_link    { shift->{atom}->add_link(@_) }
103 sub base        { shift->{atom}->base(@_) }
104
105 sub author {
106     my $feed = shift;
107     if (@_ && $_[0]) {
108         my $person = XML::Atom::Person->new(Version => 1.0);
109         $person->name($_[0]);
110         $feed->{atom}->author($person);
111     } else {
112         $feed->{atom}->author ? $feed->{atom}->author->name : undef;
113     }
114 }
115
116
117
118
119 sub modified {
120     my $feed = shift;
121     if (@_) {
122         $feed->{atom}->modified(DateTime::Format::W3CDTF->format_datetime($_[0]));
123     } else {
124         return iso2dt($feed->{atom}->modified) if $feed->{atom}->modified;
125         return iso2dt($feed->{atom}->updated)  if $feed->{atom}->updated;
126         return undef;
127     }
128 }
129
130 sub entries {
131     my @entries;
132     for my $entry ($_[0]->{atom}->entries) {
133         push @entries, XML::Feed::Entry::Format::Atom->wrap($entry);
134     }
135
136     @entries;
137 }
138
139 sub add_entry {
140     my $feed  = shift;
141     my $entry = shift || return;
142     $entry    = $feed->_convert_entry($entry);
143     $feed->{atom}->add_entry($entry->unwrap);
144 }
145
146 sub as_xml { $_[0]->{atom}->as_xml }
147
148 1;