Initial upgraded Atom output for group timelines

This commit is contained in:
Zach Copley 2010-02-12 12:22:12 -08:00
parent fd3c9334bf
commit 506c2d7491
4 changed files with 149 additions and 18 deletions

View File

@ -109,15 +109,13 @@ class ApiTimelineGroupAction extends ApiPrivateAuthAction
$title = sprintf(_("%s timeline"), $this->group->nickname); $title = sprintf(_("%s timeline"), $this->group->nickname);
$taguribase = common_config('integration', 'taguri'); $taguribase = common_config('integration', 'taguri');
$id = "tag:$taguribase:GroupTimeline:" . $this->group->id; $id = "tag:$taguribase:GroupTimeline:" . $this->group->id;
$link = common_local_url(
'showgroup',
array('nickname' => $this->group->nickname)
);
$subtitle = sprintf( $subtitle = sprintf(
_('Updates from %1$s on %2$s!'), _('Updates from %1$s on %2$s!'),
$this->group->nickname, $this->group->nickname,
$sitename $sitename
); );
$logo = ($avatar) ? $avatar : User_group::defaultLogo(AVATAR_PROFILE_SIZE); $logo = ($avatar) ? $avatar : User_group::defaultLogo(AVATAR_PROFILE_SIZE);
switch($this->format) { switch($this->format) {
@ -125,22 +123,56 @@ class ApiTimelineGroupAction extends ApiPrivateAuthAction
$this->showXmlTimeline($this->notices); $this->showXmlTimeline($this->notices);
break; break;
case 'rss': case 'rss':
$this->showRssTimeline($this->notices, $title, $link, $subtitle, null, $logo); $this->showRssTimeline(
break;
case 'atom':
$selfuri = common_root_url() .
'api/statusnet/groups/timeline/' .
$this->group->id . '.atom';
$this->showAtomTimeline(
$this->notices, $this->notices,
$title, $title,
$id, $this->group->homeUrl(),
$link,
$subtitle, $subtitle,
null, null,
$selfuri,
$logo $logo
); );
break;
case 'atom':
header('Content-Type: application/atom+xml; charset=utf-8');
try {
$atom = new AtomNoticeFeed();
$atom->setId($id);
$atom->setTitle($title);
$atom->setSubtitle($subtitle);
$atom->setLogo($logo);
$atom->setUpdated('now');
$atom->addAuthorRaw($this->group->asAtomAuthor());
$atom->setActivitySubject($this->group->asActivitySubject());
$atom->addLink($this->group->homeUrl());
$id = $this->arg('id');
$aargs = array('format' => 'atom');
if (!empty($id)) {
$aargs['id'] = $id;
}
$atom->addLink(
$this->getSelfUri('ApiTimelineGroup', $aargs),
array('rel' => 'self', 'type' => 'application/atom+xml')
);
$atom->addEntryFromNotices($this->notices);
$this->raw($atom->getString());
} catch (Atom10FeedException $e) {
$this->serverError(
'Could not generate feed for group - ' . $e->getMessage()
);
return;
}
break; break;
case 'json': case 'json':
$this->showJsonTimeline($this->notices); $this->showJsonTimeline($this->notices);

View File

@ -355,6 +355,39 @@ class User_group extends Memcached_DataObject
return $xs->getString(); return $xs->getString();
} }
function asAtomAuthor()
{
$xs = new XMLStringer(true);
$xs->elementStart('author');
$xs->element('name', null, $this->nickname);
$xs->element('uri', null, $this->permalink());
$xs->elementEnd('author');
return $xs->getString();
}
function asActivitySubject()
{
$xs = new XMLStringer(true);
$xs->elementStart('activity:subject');
$xs->element('activity:object', null, 'http://activitystrea.ms/schema/1.0/group');
$xs->element('id', null, $this->permalink());
$xs->element('title', null, $this->getBestName());
$xs->element(
'link', array(
'rel' => 'avatar',
'href' => empty($this->homepage_logo)
? User_group::defaultLogo(AVATAR_PROFILE_SIZE)
: $this->homepage_logo
)
);
$xs->elementEnd('activity:subject');
return $xs->getString();
}
static function register($fields) { static function register($fields) {
// MAGICALLY put fields into current scope // MAGICALLY put fields into current scope

View File

@ -1103,7 +1103,7 @@ class ApiAction extends Action
} }
} }
function serverError($msg, $code = 500, $content_type = 'json') function serverError($msg, $code = 500, $content_type = 'xml')
{ {
$action = $this->trimmed('action'); $action = $this->trimmed('action');

View File

@ -51,6 +51,7 @@ class Atom10Feed extends XMLStringer
public $xw; public $xw;
private $namespaces; private $namespaces;
private $authors; private $authors;
private $subject;
private $categories; private $categories;
private $contributors; private $contributors;
private $generator; private $generator;
@ -74,6 +75,7 @@ class Atom10Feed extends XMLStringer
function __construct($indent = true) { function __construct($indent = true) {
parent::__construct($indent); parent::__construct($indent);
$this->namespaces = array(); $this->namespaces = array();
$this->authors = array();
$this->links = array(); $this->links = array();
$this->entries = array(); $this->entries = array();
$this->addNamespace('xmlns', 'http://www.w3.org/2005/Atom'); $this->addNamespace('xmlns', 'http://www.w3.org/2005/Atom');
@ -93,6 +95,64 @@ class Atom10Feed extends XMLStringer
$this->namespaces = array_merge($this->namespaces, $ns); $this->namespaces = array_merge($this->namespaces, $ns);
} }
function addAuthor($name, $uri = null, $email = null)
{
$xs = new XMLStringer(true);
$xs->elementStart('author');
if (!empty($name)) {
$xs->element('name', null, $name);
} else {
throw new Atom10FeedException(
'author element must contain a name element.'
);
}
if (!is_null($uri)) {
$xs->element('uri', null, $uri);
}
if (!is_null(email)) {
$xs->element('email', null, $email);
}
$xs->elementEnd('author');
array_push($this->authors, $xs->getString());
}
/**
* Add an Author to the feed via raw XML string
*
* @param string $xmlAuthor An XML string representation author
*
* @return void
*/
function addAuthorRaw($xmlAuthor)
{
array_push($this->authors, $xmlAuthor);
}
function renderAuthors()
{
foreach ($this->authors as $author) {
$this->raw($author);
}
}
/**
* Add a activity feed subject via raw XML string
*
* @param string $xmlSubject An XML string representation of the subject
*
* @return void
*/
function setActivitySubject($xmlSubject)
{
$this->subject = $xmlSubject;
}
function getNamespaces() function getNamespaces()
{ {
return $this->namespaces; return $this->namespaces;
@ -136,9 +196,9 @@ class Atom10Feed extends XMLStringer
} }
} }
function addEntryRaw($entry) function addEntryRaw($xmlEntry)
{ {
array_push($this->entries, $entry); array_push($this->entries, $xmlEntry);
} }
function addEntry($entry) function addEntry($entry)
@ -164,6 +224,12 @@ class Atom10Feed extends XMLStringer
$this->validate(); $this->validate();
$this->initFeed(); $this->initFeed();
$this->renderAuthors();
if (!empty($this->subject)) {
$this->raw($this->subject);
}
$this->renderEntries(); $this->renderEntries();
$this->endFeed(); $this->endFeed();