NAME¶

XML::Feed - Syndication feed parser and auto-discovery

SYNOPSIS¶

    use XML::Feed;
    my $feed = XML::Feed->parse(URI->new('http://example.com/atom.xml'))
        or die XML::Feed->errstr;
    print $feed->title, "\n";
    for my $entry ($feed->entries) {
    }
    ## Find all of the syndication feeds on a given page, using
    ## auto-discovery.
    my @feeds = XML::Feed->find_feeds('http://example.com/');

DESCRIPTION¶

XML::Feed is a syndication feed parser for both RSS and Atom feeds. It also implements feed auto-discovery for finding feeds, given a URI.

XML::Feed supports the following syndication feed formats:

• RSS 0.91
• RSS 1.0
• RSS 2.0
• Atom

The goal of XML::Feed is to provide a unified API for parsing and using the various syndication formats. The different flavors of RSS and Atom handle data in different ways: date handling; summaries and content; escaping and quoting; etc. This module attempts to remove those differences by providing a wrapper around the formats and the classes implementing those formats (XML::RSS and XML::Atom::Feed). For example, dates are handled differently in each of the above formats. To provide a unified API for date handling, XML::Feed converts all date formats transparently into DateTime objects, which it then returns to the caller.

USAGE¶

    $feed = XML::Feed->new('Atom');
    $feed = XML::Feed->new('RSS');
    $feed = XML::Feed->new('RSS', version => '0.91');

PACKAGE VARIABLES¶

$XML::Feed::Format::RSS::PREFERRED_PARSER

If you want to use another RSS parser class than XML::RSS (default), you can change the class by setting $PREFERRED_PARSER variable in the XML::Feed::Format::RSS package.

    $XML::Feed::Format::RSS::PREFERRED_PARSER = "XML::RSS::LibXML";
    

Note: this will only work for parsing feeds, not creating feeds.

Note: Only "XML::RSS::LibXML" version 0.3004 is known to work at the moment.

$XML::Feed::MULTIPLE_ENCLOSURES

Although the RSS specification states that there can be at most one enclosure per item some feeds break this rule.

If this variable is set then "XML::Feed" captures all of them and makes them available as a list.

Otherwise it returns the last enclosure parsed.

Note: "XML::RSS" version 1.44 is needed for this to work.

VALID FEEDS¶

For reference, this cgi script will create valid, albeit nonsensical feeds (according to "http://feedvalidator.org" anyway) for Atom 1.0 and RSS 0.90, 0.91, 1.0 and 2.0.

    #!perl -w
    use strict;
    use CGI;
    use CGI::Carp qw(fatalsToBrowser);
    use DateTime;
    use XML::Feed;
    my $cgi  = CGI->new;
    my @args = ( $cgi->param('format') // "Atom" );
    push @args, ( version => $cgi->param('version') ) if $cgi->param('version');
    my $feed = XML::Feed->new(@args);
    $feed->id("http://".time.rand()."/");
    $feed->title('Test Feed');
    $feed->link($cgi->url);
    $feed->self_link($cgi->url( -query => 1, -full => 1, -rewrite => 1) );
    $feed->modified(DateTime->now);
    my $entry = XML::Feed::Entry->new();
    $entry->id("http://".time.rand()."/");
    $entry->link("http://example.com");
    $entry->title("Test entry");
    $entry->summary("Test summary");
    $entry->content("Foo");
    $entry->modified(DateTime->now);
    $entry->author('test@example.com (Testy McTesterson)');
    $feed->add_entry($entry);
    my $mime = ("Atom" eq $feed->format) ? "application/atom+xml" : "application/rss+xml";
    print $cgi->header($mime);
    print $feed->as_xml;

LICENSE¶

XML::Feed is free software; you may redistribute it and/or modify it under the same terms as Perl itself.

AUTHOR & COPYRIGHT¶

Except where otherwise noted, XML::Feed is Copyright 2004-2008 Six Apart. All rights reserved.

SUPPORT¶

For support contact the XML::Feed mailing list - xml-feed@perlhacks.com.

SOURCE CODE¶

The latest version of XML::Feed can be found at

    http://github.com/davorg/XML-Feed