Gte ready for release
[catagits/XML-Feed.git] / lib / XML / Feed.pm
CommitLineData
3353d70c 1# $Id$
0d5e38d1 2
3package XML::Feed;
4use strict;
5
62d92771 6use base qw( Class::ErrorHandler );
62d92771 7use Feed::Find;
fe71566d 8use URI::Fetch;
d39809aa 9use LWP::UserAgent;
973e1f9e 10use Carp;
9b6bc912 11use Module::Pluggable search_path => "XML::Feed::Format",
12 require => 1,
13 sub_name => 'formatters';
0d5e38d1 14
a759e13e 15our $VERSION = '0.41';
9b6bc912 16our @formatters;
17BEGIN {
18 @formatters = __PACKAGE__->formatters;
19}
973e1f9e 20
21sub new {
22 my $class = shift;
4e9c4625 23 my $format = shift || 'Atom';
729cd7a8 24 my $format_class = 'XML::Feed::Format::' . $format;
973e1f9e 25 eval "use $format_class";
26 Carp::croak("Unsupported format $format: $@") if $@;
729cd7a8 27 my $feed = bless {}, join('::', __PACKAGE__, "Format", $format);
4e9c4625 28 $feed->init_empty(@_) or return $class->error($feed->errstr);
973e1f9e 29 $feed;
30}
31
32sub init_empty { 1 }
0d5e38d1 33
34sub parse {
35 my $class = shift;
41e8c132 36 my($stream, $specified_format) = @_;
0d5e38d1 37 return $class->error("Stream parameter is required") unless $stream;
38 my $feed = bless {}, $class;
39 my $xml = '';
40 if (UNIVERSAL::isa($stream, 'URI')) {
d39809aa 41 my $ua = LWP::UserAgent->new;
42 $ua->env_proxy; # force allowing of proxies
43 my $res = URI::Fetch->fetch($stream, UserAgent => $ua)
fe71566d 44 or return $class->error(URI::Fetch->errstr);
45 return $class->error("This feed has been permanently removed")
b3b6d2fc 46 if $res->status == URI::Fetch::URI_GONE();
fe71566d 47 $xml = $res->content;
0d5e38d1 48 } elsif (ref($stream) eq 'SCALAR') {
49 $xml = $$stream;
50 } elsif (ref($stream)) {
51 while (read($stream, my($chunk), 8192)) {
52 $xml .= $chunk;
53 }
54 } else {
55 open my $fh, $stream
56 or return $class->error("Can't open $stream: $!");
57 while (read $fh, my($chunk), 8192) {
58 $xml .= $chunk;
59 }
60 close $fh;
61 }
62 return $class->error("Can't get feed XML content from $stream")
63 unless $xml;
41e8c132 64 my $format;
65 if ($specified_format) {
66 $format = $specified_format;
67 } else {
0c81cb25 68 $format = $feed->identify_format(\$xml) or return $class->error($feed->errstr);
41e8c132 69 }
70
729cd7a8 71 my $format_class = join '::', __PACKAGE__, "Format", $format;
fe71566d 72 eval "use $format_class";
73 return $class->error("Unsupported format $format: $@") if $@;
74 bless $feed, $format_class;
75 $feed->init_string(\$xml) or return $class->error($feed->errstr);
76 $feed;
77}
78
79sub identify_format {
9b6bc912 80 my $feed = shift;
81 my($xml) = @_;
82 foreach my $class (@formatters) {
83 my ($name) = ($class =~ m!([^:]+)$!);
84 # TODO ugly
85 my $tmp = $$xml;
86 return $name if eval { $class->identify(\$tmp) };
87 return $feed->error($@) if $@;
88 }
89 return $feed->error("Cannot detect feed type");
90}
91
92sub _get_first_tag {
93 my $class = shift;
94 my ($xml) = @_;
95
96
0d5e38d1 97 ## Auto-detect feed type based on first element. This is prone
98 ## to breakage, but then again we don't want to parse the whole
99 ## feed ourselves.
a749d9b9 100 my $tag;
fe71566d 101 while ($$xml =~ /<(\S+)/sg) {
62d92771 102 (my $t = $1) =~ tr/a-zA-Z0-9:\-\?!//cd;
103 my $first = substr $t, 0, 1;
104 $tag = $t, last unless $first eq '?' || $first eq '!';
a749d9b9 105 }
9b6bc912 106 die ("Cannot find first element") unless $tag;
0d5e38d1 107 $tag =~ s/^.*://;
9b6bc912 108 return $tag;
0d5e38d1 109}
110
111sub find_feeds {
112 my $class = shift;
113 my($uri) = @_;
62d92771 114 my @feeds = Feed::Find->find($uri)
115 or return $class->error(Feed::Find->errstr);
0d5e38d1 116 @feeds;
117}
118
973e1f9e 119sub convert {
120 my $feed = shift;
121 my($format) = @_;
729cd7a8 122 my $new = XML::Feed->new($format);
ecac864a 123 for my $field (qw( title link description language author copyright modified generator )) {
23103173 124 my $val = $feed->$field();
125 next unless defined $val;
126 $new->$field($val);
973e1f9e 127 }
128 for my $entry ($feed->entries) {
129 $new->add_entry($entry->convert($format));
130 }
131 $new;
132}
133
23103173 134sub splice {
135 my $feed = shift;
136 my($other) = @_;
137 my %ids = map { $_->id => 1 } $feed->entries;
138 for my $entry ($other->entries) {
139 $feed->add_entry($entry) unless $ids{$entry->id}++;
140 }
141}
142
33d4cb3f 143sub _convert_entry {
144 my $feed = shift;
145 my $entry = shift;
729cd7a8 146 my $feed_format = ref($feed); $feed_format =~ s!^XML::Feed::Format::!!;
147 my $entry_format = ref($entry); $entry_format =~ s!^XML::Feed::Entry::Format::!!;
33d4cb3f 148 return $entry if $entry_format eq $feed_format;
149 return $entry->convert($feed_format);
150}
151
5383a560 152sub base;
0d5e38d1 153sub format;
154sub title;
155sub link;
9a36f82c 156sub self_link;
0d5e38d1 157sub description;
158sub language;
973e1f9e 159sub author;
0d5e38d1 160sub copyright;
161sub modified;
162sub generator;
973e1f9e 163sub add_entry;
0d5e38d1 164sub entries;
973e1f9e 165sub as_xml;
813f78d8 166sub id;
0d5e38d1 167
973e1f9e 168sub tagline { shift->description(@_) }
0d5e38d1 169sub items { $_[0]->entries }
170
1711;
172__END__
173
174=head1 NAME
175
176XML::Feed - Syndication feed parser and auto-discovery
177
178=head1 SYNOPSIS
179
180 use XML::Feed;
181 my $feed = XML::Feed->parse(URI->new('http://example.com/atom.xml'))
182 or die XML::Feed->errstr;
183 print $feed->title, "\n";
184 for my $entry ($feed->entries) {
185 }
186
187 ## Find all of the syndication feeds on a given page, using
188 ## auto-discovery.
189 my @feeds = XML::Feed->find_feeds('http://example.com/');
190
191=head1 DESCRIPTION
192
193I<XML::Feed> is a syndication feed parser for both RSS and Atom feeds. It
194also implements feed auto-discovery for finding feeds, given a URI.
195
196I<XML::Feed> supports the following syndication feed formats:
197
198=over 4
199
200=item * RSS 0.91
201
202=item * RSS 1.0
203
204=item * RSS 2.0
205
206=item * Atom
207
208=back
209
210The goal of I<XML::Feed> is to provide a unified API for parsing and using
211the various syndication formats. The different flavors of RSS and Atom
212handle data in different ways: date handling; summaries and content;
213escaping and quoting; etc. This module attempts to remove those differences
214by providing a wrapper around the formats and the classes implementing
215those formats (I<XML::RSS> and I<XML::Atom::Feed>). For example, dates are
216handled differently in each of the above formats. To provide a unified API for
217date handling, I<XML::Feed> converts all date formats transparently into
218I<DateTime> objects, which it then returns to the caller.
219
220=head1 USAGE
221
973e1f9e 222=head2 XML::Feed->new($format)
223
224Creates a new empty I<XML::Feed> object using the format I<$format>.
225
813f78d8 226 $feed = XML::Feed->new('Atom');
227 $feed = XML::Feed->new('RSS');
228 $feed = XML::Feed->new('RSS', version => '0.91');
229
0d5e38d1 230=head2 XML::Feed->parse($stream)
231
41e8c132 232=head2 XML::Feed->parse($stream, $format)
233
0d5e38d1 234Parses a syndication feed identified by I<$stream>. I<$stream> can be any
235one of the following:
236
237=over 4
238
239=item * Scalar reference
240
241A reference to string containing the XML body of the feed.
242
243=item * Filehandle
244
245An open filehandle from which the feed XML will be read.
246
247=item * File name
248
249The name of a file containing the feed XML.
250
251=item * URI object
252
253A URI from which the feed XML will be retrieved.
254
255=back
256
8c30ad3d 257I<$format> allows you to override format guessing.
41e8c132 258
0d5e38d1 259=head2 XML::Feed->find_feeds($uri)
260
261Given a URI I<$uri>, use auto-discovery to find all of the feeds linked
262from that page (using I<E<lt>linkE<gt>> tags).
263
264Returns a list of feed URIs.
265
8c30ad3d 266=head2 XML::Feed->identify_format($xml)
267
268Given the xml of a feed return what format it is in (C<Atom>, or some version of C<RSS>).
269
973e1f9e 270=head2 $feed->convert($format)
271
272Converts the I<XML::Feed> object into the I<$format> format, and returns
273the new object.
274
23103173 275=head2 $feed->splice($other_feed)
276
277Splices in all of the entries from the feed I<$other_feed> into I<$feed>,
278skipping posts that are already in I<$feed>.
279
0d5e38d1 280=head2 $feed->format
281
282Returns the format of the feed (C<Atom>, or some version of C<RSS>).
283
973e1f9e 284=head2 $feed->title([ $title ])
0d5e38d1 285
286The title of the feed/channel.
287
5383a560 288=head2 $feed->base([ $base ])
289
290The url base of the feed/channel.
291
973e1f9e 292=head2 $feed->link([ $uri ])
0d5e38d1 293
294The permalink of the feed/channel.
295
973e1f9e 296=head2 $feed->tagline([ $tagline ])
0d5e38d1 297
298The description or tagline of the feed/channel.
299
973e1f9e 300=head2 $feed->description([ $description ])
0d5e38d1 301
302Alias for I<$feed-E<gt>tagline>.
303
973e1f9e 304=head2 $feed->author([ $author ])
305
306The author of the feed/channel.
307
308=head2 $feed->language([ $language ])
0d5e38d1 309
310The language of the feed.
311
973e1f9e 312=head2 $feed->copyright([ $copyright ])
0d5e38d1 313
314The copyright notice of the feed.
315
973e1f9e 316=head2 $feed->modified([ $modified ])
0d5e38d1 317
318A I<DateTime> object representing the last-modified date of the feed.
319
973e1f9e 320If present, I<$modified> should be a I<DateTime> object.
321
322=head2 $feed->generator([ $generator ])
0d5e38d1 323
324The generator of the feed.
325
9a36f82c 326=head2 $feed->self_link ([ $uri ])
327
328The Atom Self-link of the feed:
329
330L<http://validator.w3.org/feed/docs/warning/MissingAtomSelfLink.html>
331
332A string.
333
0d5e38d1 334=head2 $feed->entries
335
336A list of the entries/items in the feed. Returns an array containing
337I<XML::Feed::Entry> objects.
338
8c30ad3d 339=head2 $feed->items
340
341A synonym for I<$feed->entries>.
342
973e1f9e 343=head2 $feed->add_entry($entry)
344
345Adds an entry to the feed. I<$entry> should be an I<XML::Feed::Entry>
346object in the correct format for the feed.
347
348=head2 $feed->as_xml
349
350Returns an XML representation of the feed, in the format determined by
351the current format of the I<$feed> object.
352
353=head1 PACKAGE VARIABLES
354
355=over 4
356
357=item C<$XML::Feed::RSS::PREFERRED_PARSER>
358
359If you want to use another RSS parser class than XML::RSS (default), you can
360change the class by setting C<$PREFERRED_PARSER> variable in XML::Feed::RSS
361package.
362
363 $XML::Feed::RSS::PREFERRED_PARSER = "XML::RSS::LibXML";
364
365B<Note:> this will only work for parsing feeds, not creating feeds.
366
367=back
368
b8bc97f3 369=head1 VALID FEEDS
370
371For reference, this cgi script will create valid, albeit nonsensical feeds
372(according to C<http://feedvalidator.org> anyway) for Atom 1.0 and RSS 0.90,
3730.91, 1.0 and 2.0.
374
375 #!perl -w
376
377 use strict;
378 use CGI;
379 use CGI::Carp qw(fatalsToBrowser);
380 use DateTime;
381 use XML::Feed;
382
383 my $cgi = CGI->new;
384 my @args = ( $cgi->param('format') || "Atom" );
385 push @args, ( version => $cgi->param('version') ) if $cgi->param('version');
386
387 my $feed = XML::Feed->new(@args);
388 $feed->id("http://".time.rand()."/");
389 $feed->title('Test Feed');
390 $feed->link($cgi->url);
391 $feed->self_link($cgi->url( -query => 1, -full => 1, -rewrite => 1) );
392 $feed->modified(DateTime->now);
393
394 my $entry = XML::Feed::Entry->new();
395 $entry->id("http://".time.rand()."/");
396 $entry->link("http://example.com");
397 $entry->title("Test entry");
398 $entry->summary("Test summary");
399 $entry->content("Foo");
400 $entry->modified(DateTime->now);
401 $entry->author('test@example.com (Testy McTesterson)');
402 $feed->add_entry($entry);
403
404 my $mime = ("Atom" eq $feed->format) ? "application/atom+xml" : "application/rss+xml";
405 print $cgi->header($mime);
406 print $feed->as_xml;
407
408
0d5e38d1 409=head1 LICENSE
410
411I<XML::Feed> is free software; you may redistribute it and/or modify it
412under the same terms as Perl itself.
413
414=head1 AUTHOR & COPYRIGHT
415
70f935cc 416Except where otherwise noted, I<XML::Feed> is Copyright 2004-2008
973e1f9e 417Six Apart, cpan@sixapart.com. All rights reserved.
0d5e38d1 418
70f935cc 419=head1 SUBVERSION
420
421The latest version of I<XML::Feed> can be found at
422
423 http://code.sixapart.com/svn/XML-Feed/trunk/
424
0d5e38d1 425=cut