[catagits/XML-Feed.git] / lib / XML / Feed / Format / Atom.pm

# $Id: Atom.pm 1958 2006-08-14 05:31:27Z btrott $

package XML::Feed::Format::Atom;
use strict;

use base qw( XML::Feed );
use XML::Atom::Feed;
use XML::Atom::Util qw( iso2dt );
use List::Util qw( first );
use DateTime::Format::W3CDTF;

use XML::Atom::Entry;
XML::Atom::Entry->mk_elem_accessors(qw( lat long ), ['http://www.w3.org/2003/01/geo/wgs84_pos#']);

use XML::Atom::Content;

sub identify {
    my $class   = shift;
    my $xml     = shift;
    my $tag     = $class->_get_first_tag($xml);
    return ($tag eq 'feed');
}


sub init_empty {
    my ($feed, %args) = @_;
    $args{'Version'} ||= '1.0';
    
    $feed->{atom} = XML::Atom::Feed->new(%args);
    $feed;
}

# monkey patch
{
    my $sub =  sub {
        my $item = shift;
        if (XML::Atom::LIBXML) {
            my $elem = $item->elem;
            if (@_) {
                $elem->setAttributeNS('http://www.w3.org/XML/1998/namespace',
                    'base', $_[0]);
            }
            return $elem->getAttributeNS('http://www.w3.org/XML/1998/namespace', 'base');
        } else {
            if (@_) {
                $item->elem->setAttribute('xml:base', $_[0]);
            }
            return $item->elem->getAttribute('xml:base');
        }

    };
    no strict 'refs';
    *XML::Atom::Feed::base    = $sub unless XML::Atom::Feed->can('base');
    *XML::Atom::Entry::base   = $sub unless XML::Atom::Entry->can('base');
    *XML::Atom::Content::base = $sub unless XML::Atom::Content->can('base');
}

sub init_string {
    my $feed = shift;
    my($str) = @_;
    if ($str) {
        $feed->{atom} = XML::Atom::Feed->new(Stream => $str)
            or return $feed->error(XML::Atom::Feed->errstr);
    }
    $feed;
}

sub format { 'Atom' }

sub title { shift->{atom}->title(@_) }
sub link {
    my $feed = shift;
    if (@_) {
        $feed->{atom}->add_link({ rel => 'alternate', href => $_[0],
                                  type => 'text/html', });
    } else {
        my $l = first { !defined $_->rel || $_->rel eq 'alternate' } $feed->{atom}->link;
        $l ? $l->href : undef;
    }
}

sub self_link {
    my $feed = shift;
    if (@_) {
        my $uri = shift;
        $feed->{atom}->add_link({type => "application/atom+xml", rel => "self", href => $uri});
        return $uri;
    } 
    else
    {
        my $l =
            first
            { !defined $_->rel || $_->rel eq 'self' }
            $feed->{atom}->link;
            ;

        return $l ? $l->href : undef;
    }
}

sub description { shift->{atom}->tagline(@_) }
sub copyright   { shift->{atom}->copyright(@_) }
sub language    { shift->{atom}->language(@_) }
sub generator   { shift->{atom}->generator(@_) }
sub id          { shift->{atom}->id(@_) }
sub updated     { shift->{atom}->updated(@_) }
sub add_link    { shift->{atom}->add_link(@_) }
sub base        { shift->{atom}->base(@_) }

sub author {
    my $feed = shift;
    if (@_ && $_[0]) {
        my $person = XML::Atom::Person->new(Version => 1.0);
        $person->name($_[0]);
        $feed->{atom}->author($person);
    } else {
        $feed->{atom}->author ? $feed->{atom}->author->name : undef;
    }
}


sub modified {
    my $feed = shift;
    if (@_) {
        $feed->{atom}->modified(DateTime::Format::W3CDTF->format_datetime($_[0]));
    } else {
        return iso2dt($feed->{atom}->modified) if $feed->{atom}->modified;
        return iso2dt($feed->{atom}->updated)  if $feed->{atom}->updated;
        return undef;
    }
}

sub entries {
    my @entries;
    for my $entry ($_[0]->{atom}->entries) {
        push @entries, XML::Feed::Entry::Format::Atom->wrap($entry);
    }

    @entries;
}

sub add_entry {
    my $feed  = shift;
    my $entry = shift || return;
    $entry    = $feed->_convert_entry($entry);
    $feed->{atom}->add_entry($entry->unwrap);
}

sub as_xml { $_[0]->{atom}->as_xml }

package XML::Feed::Entry::Format::Atom;
use strict;

use base qw( XML::Feed::Entry );
use XML::Atom::Util qw( iso2dt );
use XML::Feed::Content;
use XML::Atom::Entry;
use List::Util qw( first );

sub init_empty {
    my $entry = shift;
    $entry->{entry} = XML::Atom::Entry->new(Version => 1.0);
    1;
}

sub title { shift->{entry}->title(@_) }
sub source { shift->{entry}->source(@_) }
sub updated { shift->{entry}->updated(@_) }
sub base { shift->{entry}->base(@_) }

sub link {
    my $entry = shift;
    if (@_) {
        $entry->{entry}->add_link({ rel => 'alternate', href => $_[0],
                                    type => 'text/html', });
    } else {
        my $l = first { !defined $_->rel || $_->rel eq 'alternate' } $entry->{entry}->link;
        $l ? $l->href : undef;
    }
}

sub summary {
    my $entry = shift;
    if (@_) {
		my %param;
		if (ref($_[0]) eq 'XML::Feed::Content') {
			%param = (Body => $_[0]->body);
		} else {
			 %param = (Body => $_[0]);
		}
		$entry->{entry}->summary(XML::Atom::Content->new(%param, Version => 1.0));
    } else {
		my $s = $entry->{entry}->summary;
        # map Atom types to MIME types
        my $type = ($s && ref($s) eq 'XML::Feed::Content') ? $s->type : undef;
        if ($type) {
            $type = 'text/html'  if $type eq 'xhtml' || $type eq 'html';
            $type = 'text/plain' if $type eq 'text';
        }
		my $body = $s;	
		if (defined $s && ref($s) eq 'XML::Feed::Content') {
			$body = $s->body;
		}
        XML::Feed::Content->wrap({ type => $type,
                                   body => $body });
    }
}

my %types = (
	'text/xhtml' => 'xhtml',
	'text/html'  => 'html',
	'text/plain' => 'text',
);

sub content {
    my $entry = shift;
    if (@_) {
        my %param;
        my $base;
        if (ref($_[0]) eq 'XML::Feed::Content') {
			if (defined $_[0]->type && defined $types{$_[0]->type}) {
	            %param = (Body => $_[0]->body, Type => $types{$_[0]->type});
			} else {
	            %param = (Body => $_[0]->body);
			}
            $base = $_[0]->base if defined $_[0]->base;
        } else {
            %param = (Body => $_[0]);
        }
        $entry->{entry}->content(XML::Atom::Content->new(%param, Version => 1.0));
        $entry->{entry}->content->base($base) if defined $base;
    } else {
        my $c = $entry->{entry}->content;

        # map Atom types to MIME types
        my $type = $c ? $c->type : undef;
        if ($type) {
            $type = 'text/html'  if $type eq 'xhtml' || $type eq 'html';
            $type = 'text/plain' if $type eq 'text';
        }

        XML::Feed::Content->wrap({ type => $type,
                                   base => $c ? $c->base : undef, 
                                   body => $c ? $c->body : undef });
    }
}

sub category {
    my $entry = shift;
    my $ns = XML::Atom::Namespace->new(dc => 'http://purl.org/dc/elements/1.1/');
    if (@_) {
        $entry->{entry}->add_category({ term => $_[0] });
    } else {
        my $category = $entry->{entry}->category;
        my @return = $category ? ($category->label || $category->term) : $entry->{entry}->getlist($ns, 'subject');
        return wantarray? @return : $return[0];
    }
}

sub author {
    my $entry = shift;
    if (@_ && $_[0]) {
        my $person = XML::Atom::Person->new(Version => 1.0);
        $person->name($_[0]);
        $entry->{entry}->author($person);
    } else {
        $entry->{entry}->author ? $entry->{entry}->author->name : undef;
    }
}

sub id { shift->{entry}->id(@_) }

sub issued {
    my $entry = shift;
    if (@_) {
        $entry->{entry}->issued(DateTime::Format::W3CDTF->format_datetime($_[0])) if $_[0];
    } else {
        $entry->{entry}->issued ? iso2dt($entry->{entry}->issued) : undef;
    }
}

sub modified {
    my $entry = shift;
    if (@_) {
        $entry->{entry}->modified(DateTime::Format::W3CDTF->format_datetime($_[0])) if $_[0];
    } else {
        return iso2dt($entry->{entry}->modified) if $entry->{entry}->modified;
        return iso2dt($entry->{entry}->updated)  if $entry->{entry}->updated;
        return undef;
    }
}

sub lat {
    my $entry = shift;
    if (@_) {
   $entry->{entry}->lat($_[0]) if $_[0];
    } else {
   $entry->{entry}->lat;
    }
}

sub long {
    my $entry = shift;
    if (@_) {
   $entry->{entry}->long($_[0]) if $_[0];
    } else {
   $entry->{entry}->long;
    }
}

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