[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;
}

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 format { 'Atom' }

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;
    }
}


sub add_enclosure {
    my($entry, $enclosure) = @_;
    my $link = XML::Atom::Link->new;
    $link->rel('enclosure');
    $link->type($enclosure->type);
    $link->href($enclosure->url);
    $link->length($enclosure->length);
    $entry->{entry}->add_link($link);
};


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