Force a non-segfaulting version of XML::LibXML
[catagits/XML-Feed.git] / lib / XML / Feed.pm
1 # $Id: Feed.pm 1958 2006-08-14 05:31:27Z btrott $
2
3 package XML::Feed;
4 use strict;
5
6 use base qw( Class::ErrorHandler );
7 use Feed::Find;
8 use URI::Fetch;
9 use Carp;
10
11 our $VERSION = '0.20';
12
13 sub new {
14     my $class = shift;
15     my $format = shift || 'Atom';
16     my $format_class = 'XML::Feed::' . $format;
17     eval "use $format_class";
18     Carp::croak("Unsupported format $format: $@") if $@;
19     my $feed = bless {}, join('::', __PACKAGE__, $format);
20     $feed->init_empty(@_) or return $class->error($feed->errstr);
21     $feed;
22 }
23
24 sub init_empty { 1 }
25
26 sub parse {
27     my $class = shift;
28     my($stream, $specified_format) = @_;
29     return $class->error("Stream parameter is required") unless $stream;
30     my $feed = bless {}, $class;
31     my $xml = '';
32     if (UNIVERSAL::isa($stream, 'URI')) {
33         my $res = URI::Fetch->fetch($stream)
34             or return $class->error(URI::Fetch->errstr);
35         return $class->error("This feed has been permanently removed")
36             if $res->status == URI::Fetch::URI_GONE();
37         $xml = $res->content;
38     } elsif (ref($stream) eq 'SCALAR') {
39         $xml = $$stream;
40     } elsif (ref($stream)) {
41         while (read($stream, my($chunk), 8192)) {
42             $xml .= $chunk;
43         }
44     } else {
45         open my $fh, $stream
46             or return $class->error("Can't open $stream: $!");
47         while (read $fh, my($chunk), 8192) {
48             $xml .= $chunk;
49         }
50         close $fh;
51     }
52     return $class->error("Can't get feed XML content from $stream")
53         unless $xml;
54     my $format;
55     if ($specified_format) {
56         $format = $specified_format;
57     } else {
58         $format = $feed->identify_format(\$xml) or return $class->error($feed->errstr);
59     }
60
61     my $format_class = join '::', __PACKAGE__, $format;
62     eval "use $format_class";
63     return $class->error("Unsupported format $format: $@") if $@;
64     bless $feed, $format_class;
65     $feed->init_string(\$xml) or return $class->error($feed->errstr);
66     $feed;
67 }
68
69 sub identify_format {
70     my $feed = shift;
71     my($xml) = @_;
72     ## Auto-detect feed type based on first element. This is prone
73     ## to breakage, but then again we don't want to parse the whole
74     ## feed ourselves.
75     my $tag;
76     while ($$xml =~ /<(\S+)/sg) {
77         (my $t = $1) =~ tr/a-zA-Z0-9:\-\?!//cd;
78         my $first = substr $t, 0, 1;
79         $tag = $t, last unless $first eq '?' || $first eq '!';
80     }
81     return $feed->error("Cannot find first element") unless $tag;
82     $tag =~ s/^.*://;
83     if ($tag eq 'rss' || $tag eq 'RDF') {
84         return 'RSS';
85     } elsif ($tag eq 'feed') {
86         return 'Atom';
87     } else {
88         return $feed->error("Cannot detect feed type");
89     }
90 }
91
92 sub find_feeds {
93     my $class = shift;
94     my($uri) = @_;
95     my @feeds = Feed::Find->find($uri)
96         or return $class->error(Feed::Find->errstr);
97     @feeds;
98 }
99
100 sub convert {
101     my $feed = shift;
102     my($format) = @_;
103     my $new = __PACKAGE__->new($format);
104     for my $field (qw( title link description language author copyright modified generator )) {
105         my $val = $feed->$field();
106         next unless defined $val;
107         $new->$field($val);
108     }
109     for my $entry ($feed->entries) {
110         $new->add_entry($entry->convert($format));
111     }
112     $new;
113 }
114
115 sub splice {
116     my $feed = shift;
117     my($other) = @_;
118     my %ids = map { $_->id => 1 } $feed->entries;
119     for my $entry ($other->entries) {
120         $feed->add_entry($entry) unless $ids{$entry->id}++;
121     }
122 }
123
124 sub format;
125 sub title;
126 sub link;
127 sub description;
128 sub language;
129 sub author;
130 sub copyright;
131 sub modified;
132 sub generator;
133 sub add_entry;
134 sub entries;
135 sub as_xml;
136
137 sub tagline { shift->description(@_) }
138 sub items   { $_[0]->entries     }
139
140 1;
141 __END__
142
143 =head1 NAME
144
145 XML::Feed - Syndication feed parser and auto-discovery
146
147 =head1 SYNOPSIS
148
149     use XML::Feed;
150     my $feed = XML::Feed->parse(URI->new('http://example.com/atom.xml'))
151         or die XML::Feed->errstr;
152     print $feed->title, "\n";
153     for my $entry ($feed->entries) {
154     }
155
156     ## Find all of the syndication feeds on a given page, using
157     ## auto-discovery.
158     my @feeds = XML::Feed->find_feeds('http://example.com/');
159
160 =head1 DESCRIPTION
161
162 I<XML::Feed> is a syndication feed parser for both RSS and Atom feeds. It
163 also implements feed auto-discovery for finding feeds, given a URI.
164
165 I<XML::Feed> supports the following syndication feed formats:
166
167 =over 4
168
169 =item * RSS 0.91
170
171 =item * RSS 1.0
172
173 =item * RSS 2.0
174
175 =item * Atom
176
177 =back
178
179 The goal of I<XML::Feed> is to provide a unified API for parsing and using
180 the various syndication formats. The different flavors of RSS and Atom
181 handle data in different ways: date handling; summaries and content;
182 escaping and quoting; etc. This module attempts to remove those differences
183 by providing a wrapper around the formats and the classes implementing
184 those formats (I<XML::RSS> and I<XML::Atom::Feed>). For example, dates are
185 handled differently in each of the above formats. To provide a unified API for
186 date handling, I<XML::Feed> converts all date formats transparently into
187 I<DateTime> objects, which it then returns to the caller.
188
189 =head1 USAGE
190
191 =head2 XML::Feed->new($format)
192
193 Creates a new empty I<XML::Feed> object using the format I<$format>.
194
195 =head2 XML::Feed->parse($stream)
196
197 =head2 XML::Feed->parse($stream, $format)
198
199 Parses a syndication feed identified by I<$stream>. I<$stream> can be any
200 one of the following:
201
202 =over 4
203
204 =item * Scalar reference
205
206 A reference to string containing the XML body of the feed.
207
208 =item * Filehandle
209
210 An open filehandle from which the feed XML will be read.
211
212 =item * File name
213
214 The name of a file containing the feed XML.
215
216 =item * URI object
217
218 A URI from which the feed XML will be retrieved.
219
220 =back
221
222 C<$format> allows you to override format guessing.
223
224 =head2 XML::Feed->find_feeds($uri)
225
226 Given a URI I<$uri>, use auto-discovery to find all of the feeds linked
227 from that page (using I<E<lt>linkE<gt>> tags).
228
229 Returns a list of feed URIs.
230
231 =head2 $feed->convert($format)
232
233 Converts the I<XML::Feed> object into the I<$format> format, and returns
234 the new object.
235
236 =head2 $feed->splice($other_feed)
237
238 Splices in all of the entries from the feed I<$other_feed> into I<$feed>,
239 skipping posts that are already in I<$feed>.
240
241 =head2 $feed->format
242
243 Returns the format of the feed (C<Atom>, or some version of C<RSS>).
244
245 =head2 $feed->title([ $title ])
246
247 The title of the feed/channel.
248
249 =head2 $feed->link([ $uri ])
250
251 The permalink of the feed/channel.
252
253 =head2 $feed->tagline([ $tagline ])
254
255 The description or tagline of the feed/channel.
256
257 =head2 $feed->description([ $description ])
258
259 Alias for I<$feed-E<gt>tagline>.
260
261 =head2 $feed->author([ $author ])
262
263 The author of the feed/channel.
264
265 =head2 $feed->language([ $language ])
266
267 The language of the feed.
268
269 =head2 $feed->copyright([ $copyright ])
270
271 The copyright notice of the feed.
272
273 =head2 $feed->modified([ $modified ])
274
275 A I<DateTime> object representing the last-modified date of the feed.
276
277 If present, I<$modified> should be a I<DateTime> object.
278
279 =head2 $feed->generator([ $generator ])
280
281 The generator of the feed.
282
283 =head2 $feed->entries
284
285 A list of the entries/items in the feed. Returns an array containing
286 I<XML::Feed::Entry> objects.
287
288 =head2 $feed->add_entry($entry)
289
290 Adds an entry to the feed. I<$entry> should be an I<XML::Feed::Entry>
291 object in the correct format for the feed.
292
293 =head2 $feed->as_xml
294
295 Returns an XML representation of the feed, in the format determined by
296 the current format of the I<$feed> object.
297
298 =head1 PACKAGE VARIABLES
299
300 =over 4
301
302 =item C<$XML::Feed::RSS::PREFERRED_PARSER>
303
304 If you want to use another RSS parser class than XML::RSS (default), you can
305 change the class by setting C<$PREFERRED_PARSER> variable in XML::Feed::RSS
306 package.
307
308     $XML::Feed::RSS::PREFERRED_PARSER = "XML::RSS::LibXML";
309
310 B<Note:> this will only work for parsing feeds, not creating feeds.
311
312 =back
313
314 =head1 LICENSE
315
316 I<XML::Feed> is free software; you may redistribute it and/or modify it
317 under the same terms as Perl itself.
318
319 =head1 AUTHOR & COPYRIGHT
320
321 Except where otherwise noted, I<XML::Feed> is Copyright 2004-2008
322 Six Apart, cpan@sixapart.com. All rights reserved.
323
324 =head1 SUBVERSION 
325
326 The latest version of I<XML::Feed> can be found at
327
328     http://code.sixapart.com/svn/XML-Feed/trunk/
329
330 =cut