Commit | Line | Data |
fe3b3201 |
1 | # $Id: RSS.pm 1934 2006-04-22 05:13:55Z btrott $ |
0d5e38d1 |
2 | |
3 | package XML::Feed::RSS; |
4 | use strict; |
5 | |
6 | use base qw( XML::Feed ); |
0d5e38d1 |
7 | use DateTime::Format::Mail; |
8 | use DateTime::Format::W3CDTF; |
9 | |
973e1f9e |
10 | our $PREFERRED_PARSER = "XML::RSS"; |
11 | |
12 | sub init_empty { |
4e9c4625 |
13 | my ($feed, %args) = @_; |
14 | $args{'version'} ||= '2.0'; |
973e1f9e |
15 | eval "use $PREFERRED_PARSER"; die $@ if $@; |
4e9c4625 |
16 | $feed->{rss} = $PREFERRED_PARSER->new(%args); |
fe3b3201 |
17 | $feed->{rss}->add_module(prefix => "content", uri => 'http://purl.org/rss/1.0/modules/content/'); |
813f78d8 |
18 | $feed->{rss}->add_module(prefix => "dcterms", uri => 'http://purl.org/dc/terms/'); |
9a36f82c |
19 | $feed->{rss}->add_module(prefix => "atom", uri => 'http://www.w3.org/2005/Atom'); |
20 | $feed->{rss}->add_module(prefix => "geo", uri => 'http://www.w3.org/2003/01/geo/wgs84_pos#'); |
973e1f9e |
21 | $feed; |
22 | } |
23 | |
0d5e38d1 |
24 | sub init_string { |
25 | my $feed = shift; |
26 | my($str) = @_; |
973e1f9e |
27 | $feed->init_empty; |
0d5e38d1 |
28 | if ($str) { |
973e1f9e |
29 | $feed->{rss}->parse($$str); |
0d5e38d1 |
30 | } |
31 | $feed; |
32 | } |
33 | |
34 | sub format { 'RSS ' . $_[0]->{rss}->{'version'} } |
35 | |
36 | ## The following elements are the same in all versions of RSS. |
973e1f9e |
37 | sub title { shift->{rss}->channel('title', @_) } |
38 | sub link { shift->{rss}->channel('link', @_) } |
39 | sub description { shift->{rss}->channel('description', @_) } |
0d5e38d1 |
40 | |
813f78d8 |
41 | # This doesn't exist in RSS |
42 | sub id { } |
43 | |
0d5e38d1 |
44 | ## This is RSS 2.0 only--what's the equivalent in RSS 1.0? |
973e1f9e |
45 | sub copyright { shift->{rss}->channel('copyright', @_) } |
0d5e38d1 |
46 | |
5383a560 |
47 | sub base { |
48 | my $feed = shift; |
49 | if (@_) { |
50 | $feed->{rss}->{'xml:base'} = $_[0]; |
51 | } else { |
52 | $feed->{rss}->{'xml:base'}; |
53 | } |
54 | } |
55 | |
0d5e38d1 |
56 | ## The following all work transparently in any RSS version. |
57 | sub language { |
973e1f9e |
58 | my $feed = shift; |
59 | if (@_) { |
60 | $feed->{rss}->channel('language', $_[0]); |
61 | $feed->{rss}->channel->{dc}{language} = $_[0]; |
62 | } else { |
63 | $feed->{rss}->channel('language') || |
64 | $feed->{rss}->channel->{dc}{language}; |
65 | } |
0d5e38d1 |
66 | } |
67 | |
9a36f82c |
68 | sub self_link { |
69 | my $feed = shift; |
70 | |
71 | if (@_) { |
72 | my $uri = shift; |
73 | |
74 | $feed->{rss}->channel->{'atom'}{'link'} = |
75 | { |
76 | rel => "self", |
77 | href => $uri, |
78 | type => "application/rss+xml", |
79 | }; |
80 | } |
81 | |
82 | return $feed->{rss}->channel->{'atom'}{'link'}; |
83 | } |
84 | |
85 | |
0d5e38d1 |
86 | sub generator { |
973e1f9e |
87 | my $feed = shift; |
88 | if (@_) { |
89 | $feed->{rss}->channel('generator', $_[0]); |
90 | $feed->{rss}->channel->{'http://webns.net/mvcb/'}{generatorAgent} = |
91 | $_[0]; |
92 | } else { |
93 | $feed->{rss}->channel('generator') || |
94 | $feed->{rss}->channel->{'http://webns.net/mvcb/'}{generatorAgent}; |
95 | } |
0d5e38d1 |
96 | } |
97 | |
98 | sub author { |
973e1f9e |
99 | my $feed = shift; |
100 | if (@_) { |
101 | $feed->{rss}->channel('webMaster', $_[0]); |
102 | $feed->{rss}->channel->{dc}{creator} = $_[0]; |
103 | } else { |
104 | $feed->{rss}->channel('webMaster') || |
105 | $feed->{rss}->channel->{dc}{creator}; |
106 | } |
0d5e38d1 |
107 | } |
108 | |
109 | sub modified { |
973e1f9e |
110 | my $rss = shift->{rss}; |
111 | if (@_) { |
112 | $rss->channel('pubDate', |
113 | DateTime::Format::Mail->format_datetime($_[0])); |
114 | ## XML::RSS is so weird... if I set this, it will try to use |
115 | ## the value for the lastBuildDate, which I don't want--because |
116 | ## this date is formatted for an RSS 1.0 feed. So it's commented out. |
117 | #$rss->channel->{dc}{date} = |
118 | # DateTime::Format::W3CDTF->format_datetime($_[0]); |
fe3b3201 |
119 | } else { |
120 | my $date; |
121 | eval { |
122 | if (my $ts = $rss->channel('pubDate')) { |
123 | $date = DateTime::Format::Mail->parse_datetime($ts); |
124 | } elsif ($ts = $rss->channel->{dc}{date}) { |
125 | $date = DateTime::Format::W3CDTF->parse_datetime($ts); |
126 | } |
127 | }; |
128 | return $date; |
0d5e38d1 |
129 | } |
130 | } |
131 | |
132 | sub entries { |
133 | my $rss = $_[0]->{rss}; |
134 | my @entries; |
135 | for my $item (@{ $rss->{items} }) { |
973e1f9e |
136 | push @entries, XML::Feed::Entry::RSS->wrap($item); |
0d5e38d1 |
137 | } |
138 | @entries; |
139 | } |
140 | |
973e1f9e |
141 | sub add_entry { |
33d4cb3f |
142 | my $feed = shift; |
143 | my $entry = shift || return; |
144 | $entry = $feed->_convert_entry($entry); |
973e1f9e |
145 | $feed->{rss}->add_item(%{ $entry->unwrap }); |
146 | } |
147 | |
148 | sub as_xml { $_[0]->{rss}->as_string } |
149 | |
150 | package XML::Feed::Entry::RSS; |
0d5e38d1 |
151 | use strict; |
152 | |
a749d9b9 |
153 | use XML::Feed::Content; |
154 | |
0d5e38d1 |
155 | use base qw( XML::Feed::Entry ); |
156 | |
973e1f9e |
157 | sub init_empty { $_[0]->{entry} = { } } |
158 | |
5383a560 |
159 | sub base { |
160 | my $entry = shift; |
161 | @_ ? $entry->{entry}->{'xml:base'} = $_[0] : $entry->{entry}->{'xml:base'}; |
162 | } |
163 | |
973e1f9e |
164 | sub title { |
165 | my $entry = shift; |
166 | @_ ? $entry->{entry}{title} = $_[0] : $entry->{entry}{title}; |
167 | } |
168 | |
169 | sub link { |
170 | my $entry = shift; |
171 | if (@_) { |
172 | $entry->{entry}{link} = $_[0]; |
173 | ## For RSS 2.0 output from XML::RSS. Sigh. |
174 | $entry->{entry}{permaLink} = $_[0]; |
175 | } else { |
176 | $entry->{entry}{link} || $entry->{entry}{guid}; |
177 | } |
178 | } |
a749d9b9 |
179 | |
180 | sub summary { |
973e1f9e |
181 | my $item = shift->{entry}; |
182 | if (@_) { |
183 | $item->{description} = ref($_[0]) eq 'XML::Feed::Content' ? |
184 | $_[0]->body : $_[0]; |
185 | ## Because of the logic below, we need to add some dummy content, |
186 | ## so that we'll properly recognize the description we enter as |
187 | ## the summary. |
fe3b3201 |
188 | if (!$item->{content}{encoded} && |
973e1f9e |
189 | !$item->{'http://www.w3.org/1999/xhtml'}{body}) { |
fe3b3201 |
190 | $item->{content}{encoded} = ' '; |
973e1f9e |
191 | } |
192 | } else { |
193 | ## Some RSS feeds use <description> for a summary, and some use it |
194 | ## for the full content. Pretty gross. We don't want to return the |
195 | ## full content if the caller expects a summary, so the heuristic is: |
196 | ## if the <entry> contains both a <description> and one of the elements |
197 | ## typically used for the full content, use <description> as summary. |
198 | my $txt; |
199 | if ($item->{description} && |
fe3b3201 |
200 | ($item->{content}{encoded} || |
973e1f9e |
201 | $item->{'http://www.w3.org/1999/xhtml'}{body})) { |
202 | $txt = $item->{description}; |
203 | } |
204 | XML::Feed::Content->wrap({ type => 'text/plain', body => $txt }); |
a749d9b9 |
205 | } |
a749d9b9 |
206 | } |
0d5e38d1 |
207 | |
208 | sub content { |
973e1f9e |
209 | my $item = shift->{entry}; |
210 | if (@_) { |
211 | my $c = ref($_[0]) eq 'XML::Feed::Content' ? $_[0]->body : $_[0]; |
fe3b3201 |
212 | $item->{content}{encoded} = $c; |
973e1f9e |
213 | } else { |
7c89ffff |
214 | my $description = $item->{description}; |
215 | my $base; |
216 | if ('HASH' eq ref($description)) { |
217 | $base = $description->{'xml:base'}; |
218 | $description = $description->{content}; |
219 | } |
973e1f9e |
220 | my $body = |
fe3b3201 |
221 | $item->{content}{encoded} || |
973e1f9e |
222 | $item->{'http://www.w3.org/1999/xhtml'}{body} || |
7c89ffff |
223 | $description; |
224 | XML::Feed::Content->wrap({ type => 'text/html', body => $body, base => $base }); |
973e1f9e |
225 | } |
0d5e38d1 |
226 | } |
227 | |
228 | sub category { |
973e1f9e |
229 | my $item = shift->{entry}; |
230 | if (@_) { |
231 | $item->{category} = $item->{dc}{subject} = $_[0]; |
232 | } else { |
233 | $item->{category} || $item->{dc}{subject}; |
234 | } |
0d5e38d1 |
235 | } |
236 | |
237 | sub author { |
973e1f9e |
238 | my $item = shift->{entry}; |
239 | if (@_) { |
240 | $item->{author} = $item->{dc}{creator} = $_[0]; |
241 | } else { |
242 | $item->{author} || $item->{dc}{creator}; |
243 | } |
0d5e38d1 |
244 | } |
245 | |
246 | ## XML::RSS doesn't give us access to the rdf:about for the <item>, |
247 | ## so we have to fall back to the <link> element in RSS 1.0 feeds. |
248 | sub id { |
973e1f9e |
249 | my $item = shift->{entry}; |
250 | if (@_) { |
251 | $item->{guid} = $_[0]; |
252 | } else { |
253 | $item->{guid} || $item->{link}; |
254 | } |
0d5e38d1 |
255 | } |
256 | |
257 | sub issued { |
973e1f9e |
258 | my $item = shift->{entry}; |
259 | if (@_) { |
260 | $item->{dc}{date} = DateTime::Format::W3CDTF->format_datetime($_[0]); |
261 | $item->{pubDate} = DateTime::Format::Mail->format_datetime($_[0]); |
262 | } else { |
ecac864a |
263 | ## Either of these could die if the format is invalid. |
264 | my $date; |
265 | eval { |
266 | if (my $ts = $item->{pubDate}) { |
267 | my $parser = DateTime::Format::Mail->new; |
268 | $parser->loose; |
269 | $date = $parser->parse_datetime($ts); |
270 | } elsif ($ts = $item->{dc}{date}) { |
271 | $date = DateTime::Format::W3CDTF->parse_datetime($ts); |
272 | } |
273 | }; |
274 | return $date; |
0d5e38d1 |
275 | } |
276 | } |
277 | |
278 | sub modified { |
973e1f9e |
279 | my $item = shift->{entry}; |
280 | if (@_) { |
fe3b3201 |
281 | $item->{dcterms}{modified} = |
973e1f9e |
282 | DateTime::Format::W3CDTF->format_datetime($_[0]); |
283 | } else { |
fe3b3201 |
284 | if (my $ts = $item->{dcterms}{modified}) { |
ecac864a |
285 | return eval { DateTime::Format::W3CDTF->parse_datetime($ts) }; |
973e1f9e |
286 | } |
0d5e38d1 |
287 | } |
288 | } |
289 | |
9a36f82c |
290 | sub lat { |
291 | my $item = shift->{entry}; |
292 | if (@_) { |
293 | $item->{geo}{lat} = $_[0]; |
294 | } else { |
295 | return $item->{geo}{lat}; |
296 | } |
297 | } |
298 | |
299 | sub long { |
300 | my $item = shift->{entry}; |
301 | if (@_) { |
302 | $item->{geo}{long} = $_[0]; |
303 | } else { |
304 | return $item->{geo}{long}; |
305 | } |
306 | } |
307 | |
308 | |
0d5e38d1 |
309 | 1; |