Another round of changes to fix (and test) https://rt.cpan.org/Public/Bug/Display...
[catagits/XML-Feed.git] / lib / XML / Feed / Format / Atom.pm
CommitLineData
3353d70c 1# $Id$
0d5e38d1 2
729cd7a8 3package XML::Feed::Format::Atom;
0d5e38d1 4use strict;
5
6use base qw( XML::Feed );
7use XML::Atom::Feed;
8use XML::Atom::Util qw( iso2dt );
9use List::Util qw( first );
ecac864a 10use DateTime::Format::W3CDTF;
b7c406f5 11use HTML::Entities;
0d5e38d1 12
9a36f82c 13use XML::Atom::Entry;
14XML::Atom::Entry->mk_elem_accessors(qw( lat long ), ['http://www.w3.org/2003/01/geo/wgs84_pos#']);
15
5383a560 16use XML::Atom::Content;
17
9b6bc912 18sub identify {
19 my $class = shift;
20 my $xml = shift;
21 my $tag = $class->_get_first_tag($xml);
22 return ($tag eq 'feed');
23}
24
25
973e1f9e 26sub init_empty {
4e9c4625 27 my ($feed, %args) = @_;
28 $args{'Version'} ||= '1.0';
29
30 $feed->{atom} = XML::Atom::Feed->new(%args);
973e1f9e 31 $feed;
32}
33
0d5e38d1 34sub init_string {
35 my $feed = shift;
36 my($str) = @_;
fe71566d 37 if ($str) {
38 $feed->{atom} = XML::Atom::Feed->new(Stream => $str)
39 or return $feed->error(XML::Atom::Feed->errstr);
40 }
0d5e38d1 41 $feed;
42}
43
44sub format { 'Atom' }
45
973e1f9e 46sub title { shift->{atom}->title(@_) }
0d5e38d1 47sub link {
973e1f9e 48 my $feed = shift;
49 if (@_) {
50 $feed->{atom}->add_link({ rel => 'alternate', href => $_[0],
51 type => 'text/html', });
52 } else {
4679cf3f 53 my $l = first { !defined $_->rel || $_->rel eq 'alternate' } $feed->{atom}->link;
973e1f9e 54 $l ? $l->href : undef;
55 }
56}
9a36f82c 57
58sub self_link {
59 my $feed = shift;
60 if (@_) {
61 my $uri = shift;
62 $feed->{atom}->add_link({type => "application/atom+xml", rel => "self", href => $uri});
63 return $uri;
64 }
65 else
66 {
67 my $l =
68 first
69 { !defined $_->rel || $_->rel eq 'self' }
70 $feed->{atom}->link;
71 ;
72
73 return $l ? $l->href : undef;
74 }
75}
76
973e1f9e 77sub description { shift->{atom}->tagline(@_) }
78sub copyright { shift->{atom}->copyright(@_) }
79sub language { shift->{atom}->language(@_) }
80sub generator { shift->{atom}->generator(@_) }
e8fcbc5b 81sub id { shift->{atom}->id(@_) }
82sub updated { shift->{atom}->updated(@_) }
83sub add_link { shift->{atom}->add_link(@_) }
5383a560 84sub base { shift->{atom}->base(@_) }
973e1f9e 85
86sub author {
87 my $feed = shift;
88 if (@_ && $_[0]) {
c4d4c98e 89 my $person = XML::Atom::Person->new(Version => 1.0);
973e1f9e 90 $person->name($_[0]);
91 $feed->{atom}->author($person);
92 } else {
93 $feed->{atom}->author ? $feed->{atom}->author->name : undef;
94 }
95}
96
5383a560 97
98
99
973e1f9e 100sub modified {
101 my $feed = shift;
102 if (@_) {
ecac864a 103 $feed->{atom}->modified(DateTime::Format::W3CDTF->format_datetime($_[0]));
973e1f9e 104 } else {
1ee56ab5 105 return iso2dt($feed->{atom}->modified) if $feed->{atom}->modified;
106 return iso2dt($feed->{atom}->updated) if $feed->{atom}->updated;
107 return undef;
973e1f9e 108 }
0d5e38d1 109}
0d5e38d1 110
c4d4c98e 111sub entries {
0d5e38d1 112 my @entries;
113 for my $entry ($_[0]->{atom}->entries) {
729cd7a8 114 push @entries, XML::Feed::Entry::Format::Atom->wrap($entry);
0d5e38d1 115 }
c4d4c98e 116
0d5e38d1 117 @entries;
118}
119
973e1f9e 120sub add_entry {
33d4cb3f 121 my $feed = shift;
122 my $entry = shift || return;
123 $entry = $feed->_convert_entry($entry);
973e1f9e 124 $feed->{atom}->add_entry($entry->unwrap);
125}
126
127sub as_xml { $_[0]->{atom}->as_xml }
128
729cd7a8 129package XML::Feed::Entry::Format::Atom;
0d5e38d1 130use strict;
131
132use base qw( XML::Feed::Entry );
133use XML::Atom::Util qw( iso2dt );
a749d9b9 134use XML::Feed::Content;
973e1f9e 135use XML::Atom::Entry;
0d5e38d1 136use List::Util qw( first );
137
973e1f9e 138sub init_empty {
139 my $entry = shift;
c4d4c98e 140 $entry->{entry} = XML::Atom::Entry->new(Version => 1.0);
973e1f9e 141 1;
142}
143
3bdbab6f 144sub format { 'Atom' }
145
973e1f9e 146sub title { shift->{entry}->title(@_) }
e8fcbc5b 147sub source { shift->{entry}->source(@_) }
148sub updated { shift->{entry}->updated(@_) }
5383a560 149sub base { shift->{entry}->base(@_) }
e8fcbc5b 150
0d5e38d1 151sub link {
973e1f9e 152 my $entry = shift;
153 if (@_) {
154 $entry->{entry}->add_link({ rel => 'alternate', href => $_[0],
155 type => 'text/html', });
156 } else {
4679cf3f 157 my $l = first { !defined $_->rel || $_->rel eq 'alternate' } $entry->{entry}->link;
973e1f9e 158 $l ? $l->href : undef;
159 }
0d5e38d1 160}
a749d9b9 161
162sub summary {
973e1f9e 163 my $entry = shift;
164 if (@_) {
f4278e1c 165 my %param;
166 if (ref($_[0]) eq 'XML::Feed::Content') {
167 %param = (Body => $_[0]->body);
168 } else {
169 %param = (Body => $_[0]);
170 }
171 $entry->{entry}->summary(XML::Atom::Content->new(%param, Version => 1.0));
973e1f9e 172 } else {
f4278e1c 173 my $s = $entry->{entry}->summary;
ac9492d2 174 # map Atom types to MIME types
175 my $type = ($s && ref($s) eq 'XML::Feed::Content') ? $s->type : undef;
176 if ($type) {
177 $type = 'text/html' if $type eq 'xhtml' || $type eq 'html';
178 $type = 'text/plain' if $type eq 'text';
179 }
f4278e1c 180 my $body = $s;
181 if (defined $s && ref($s) eq 'XML::Feed::Content') {
182 $body = $s->body;
183 }
ac9492d2 184 XML::Feed::Content->wrap({ type => $type,
185 body => $body });
973e1f9e 186 }
a749d9b9 187}
188
4f413435 189my %types = (
f4278e1c 190 'text/xhtml' => 'xhtml',
191 'text/html' => 'html',
192 'text/plain' => 'text',
4f413435 193);
194
a749d9b9 195sub content {
973e1f9e 196 my $entry = shift;
197 if (@_) {
198 my %param;
5383a560 199 my $base;
b7c406f5 200 my $orig_body;
973e1f9e 201 if (ref($_[0]) eq 'XML::Feed::Content') {
b7c406f5 202 $orig_body = $_[0]->body;
89495df9 203 if (defined $_[0]->type && defined $types{$_[0]->type}) {
204 %param = (Body => $orig_body, Type => $types{$_[0]->type});
b7c406f5 205
f4278e1c 206 if ($param{'Type'} eq "html") {
207 $param{'Body'} = HTML::Entities::encode_entities($param{'Body'});
b7c406f5 208 }
89495df9 209 } else {
89495df9 210 }
5383a560 211 $base = $_[0]->base if defined $_[0]->base;
973e1f9e 212 } else {
89495df9 213 $orig_body = $_[0];
89495df9 214 }
f4278e1c 215 if (!exists($param{Body}))
216 {
89495df9 217 $param{Body} = $orig_body;
973e1f9e 218 }
c4d4c98e 219 $entry->{entry}->content(XML::Atom::Content->new(%param, Version => 1.0));
f4278e1c 220 # Assigning again so the type will be normalized. This seems to be
221 # an XML-Atom do-what-I-don't-meannery.
222 $entry->{entry}->content->body($orig_body);
5383a560 223 $entry->{entry}->content->base($base) if defined $base;
973e1f9e 224 } else {
225 my $c = $entry->{entry}->content;
c4d4c98e 226
227 # map Atom types to MIME types
228 my $type = $c ? $c->type : undef;
229 if ($type) {
230 $type = 'text/html' if $type eq 'xhtml' || $type eq 'html';
231 $type = 'text/plain' if $type eq 'text';
232 }
233
234 XML::Feed::Content->wrap({ type => $type,
5383a560 235 base => $c ? $c->base : undef,
973e1f9e 236 body => $c ? $c->body : undef });
237 }
a749d9b9 238}
0d5e38d1 239
240sub category {
973e1f9e 241 my $entry = shift;
0d5e38d1 242 my $ns = XML::Atom::Namespace->new(dc => 'http://purl.org/dc/elements/1.1/');
973e1f9e 243 if (@_) {
a0cca2a4 244 $entry->{entry}->add_category({ term => $_ }) for @_;
245 return 1
973e1f9e 246 } else {
a0cca2a4 247
248
249 my @category = ($entry->{entry}->can('categories')) ? $entry->{entry}->categories : $entry->{entry}->category;
250 my @return = @category
251 ? (map { $_->label || $_->term } @category)
252 : $entry->{entry}->getlist($ns, 'subject');
253
bf34c07e 254 return wantarray? @return : $return[0];
973e1f9e 255 }
256}
257
258sub author {
259 my $entry = shift;
260 if (@_ && $_[0]) {
c4d4c98e 261 my $person = XML::Atom::Person->new(Version => 1.0);
973e1f9e 262 $person->name($_[0]);
263 $entry->{entry}->author($person);
264 } else {
265 $entry->{entry}->author ? $entry->{entry}->author->name : undef;
266 }
267}
268
269sub id { shift->{entry}->id(@_) }
270
271sub issued {
272 my $entry = shift;
273 if (@_) {
ecac864a 274 $entry->{entry}->issued(DateTime::Format::W3CDTF->format_datetime($_[0])) if $_[0];
973e1f9e 275 } else {
276 $entry->{entry}->issued ? iso2dt($entry->{entry}->issued) : undef;
277 }
0d5e38d1 278}
279
973e1f9e 280sub modified {
281 my $entry = shift;
282 if (@_) {
ecac864a 283 $entry->{entry}->modified(DateTime::Format::W3CDTF->format_datetime($_[0])) if $_[0];
973e1f9e 284 } else {
1ee56ab5 285 return iso2dt($entry->{entry}->modified) if $entry->{entry}->modified;
286 return iso2dt($entry->{entry}->updated) if $entry->{entry}->updated;
287 return undef;
973e1f9e 288 }
289}
0d5e38d1 290
9a36f82c 291sub lat {
292 my $entry = shift;
293 if (@_) {
294 $entry->{entry}->lat($_[0]) if $_[0];
295 } else {
296 $entry->{entry}->lat;
297 }
298}
299
300sub long {
301 my $entry = shift;
302 if (@_) {
303 $entry->{entry}->long($_[0]) if $_[0];
304 } else {
305 $entry->{entry}->long;
306 }
307}
308
af6b00a4 309
12a4079f 310sub enclosure {
311 my $entry = shift;
312
313 if (@_) {
314 my $enclosure = shift;
b1aa7a62 315 my $method = ($XML::Feed::MULTIPLE_ENCLOSURES)? 'add_link' : 'link';
316 $entry->{entry}->$method({ rel => 'enclosure', href => $enclosure->{url},
12a4079f 317 length => $enclosure->{length},
318 type => $enclosure->{type} });
319 return 1;
320 } else {
b1aa7a62 321 my @links = grep { defined $_->rel && $_->rel eq 'enclosure' } $entry->{entry}->link;
322 return undef unless @links;
323 my @encs = map { XML::Feed::Enclosure->new({ url => $_->href, length => $_->length, type => $_->type }) } @links ;
324 return ($XML::Feed::MULTIPLE_ENCLOSURES)? @encs : $encs[-1];
12a4079f 325 }
326}
af6b00a4 327
328
0d5e38d1 3291;