* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
* @link http://status.net/
*/
-
class ActivityObject
{
const ARTICLE = 'http://activitystrea.ms/schema/1.0/article';
public $thumbnail;
public $largerImage;
public $description;
+ public $extra = array();
/**
* Constructor
*
* @param DOMElement $element DOM thing to turn into an Activity thing
*/
-
function __construct($element = null)
{
if (empty($element)) {
ActivityObject::MEDIA_DESCRIPTION,
Activity::MEDIA
);
-
}
}
private function _fromAuthor($element)
{
- $this->type = self::PERSON; // XXX: is this fair?
- $this->title = $this->_childContent($element, self::NAME);
+ $this->type = $this->_childContent($element,
+ Activity::OBJECTTYPE,
+ Activity::SPEC);
+
+ if (empty($this->type)) {
+ $this->type = self::PERSON; // XXX: is this fair?
+ }
- $this->id = $this->_childContent($element, self::URI);
+ // start with <atom:title>
+
+ $title = ActivityUtils::childHtmlContent($element, self::TITLE);
+
+ if (!empty($title)) {
+ $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
+ }
+
+ // fall back to <atom:name>
+
+ if (empty($this->title)) {
+ $this->title = $this->_childContent($element, self::NAME);
+ }
+
+ // start with <atom:id>
+
+ $this->id = $this->_childContent($element, self::ID);
+
+ // fall back to <atom:uri>
+
+ if (empty($this->id)) {
+ $this->id = $this->_childContent($element, self::URI);
+ }
+
+ // fall further back to <atom:email>
if (empty($this->id)) {
$email = $this->_childContent($element, self::EMAIL);
$this->id = 'mailto:'.$email;
}
}
+
+ $this->link = ActivityUtils::getPermalink($element);
+
+ // fall finally back to <link rel=alternate>
+
+ if (empty($this->id) && !empty($this->link)) { // fallback if there's no ID
+ $this->id = $this->link;
+ }
}
private function _fromAtomEntry($element)
$title = ActivityUtils::childHtmlContent($element, self::TITLE);
- $this->title = html_entity_decode(strip_tags($title));
+ $this->title = html_entity_decode(strip_tags($title), ENT_QUOTES, 'UTF-8');
$this->source = $this->_getSource($element);
}
}
- // @fixme rationalize with Activity::_fromRssItem()
-
+ // @todo FIXME: rationalize with Activity::_fromRssItem()
private function _fromRssItem($item)
{
$this->title = ActivityUtils::childContent($item, ActivityObject::TITLE, Activity::RSS);
{
$object = new ActivityObject();
- $object->type = ActivityObject::NOTE;
+ if (Event::handle('StartActivityObjectFromNotice', array($notice, &$object))) {
+
+ $object->type = ActivityObject::NOTE;
+
+ $object->id = $notice->uri;
+ $object->title = $notice->content;
+ $object->content = $notice->rendered;
+ $object->link = $notice->bestUrl();
- $object->id = $notice->uri;
- $object->title = $notice->content;
- $object->content = $notice->rendered;
- $object->link = $notice->bestUrl();
+ Event::handle('EndActivityObjectFromNotice', array($notice, &$object));
+ }
return $object;
}
{
$object = new ActivityObject();
- $object->type = ActivityObject::PERSON;
- $object->id = $profile->getUri();
- $object->title = $profile->getBestName();
- $object->link = $profile->profileurl;
+ if (Event::handle('StartActivityObjectFromProfile', array($profile, &$object))) {
- $orig = $profile->getOriginalAvatar();
+ $object->type = ActivityObject::PERSON;
+ $object->id = $profile->getUri();
+ $object->title = $profile->getBestName();
+ $object->link = $profile->profileurl;
- if (!empty($orig)) {
- $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
- }
-
- $sizes = array(
- AVATAR_PROFILE_SIZE,
- AVATAR_STREAM_SIZE,
- AVATAR_MINI_SIZE
- );
+ $orig = $profile->getOriginalAvatar();
- foreach ($sizes as $size) {
+ if (!empty($orig)) {
+ $object->avatarLinks[] = AvatarLink::fromAvatar($orig);
+ }
- $alink = null;
- $avatar = $profile->getAvatar($size);
-
- if (!empty($avatar)) {
- $alink = AvatarLink::fromAvatar($avatar);
- } else {
- $alink = new AvatarLink();
- $alink->type = 'image/png';
- $alink->height = $size;
- $alink->width = $size;
- $alink->url = Avatar::defaultImage($size);
-
- if ($size == AVATAR_PROFILE_SIZE) {
- // Hack for Twitter import: we don't have a 96x96 image,
- // but we do have a 73x73 image. For now, fake it with that.
- $avatar = $profile->getAvatar(73);
- if ($avatar) {
- $alink = AvatarLink::fromAvatar($avatar);
- $alink->height= $size;
- $alink->width = $size;
- }
- }
- }
-
- $object->avatarLinks[] = $alink;
- }
-
- if (isset($profile->lat) && isset($profile->lon)) {
- $object->geopoint = (float)$profile->lat
- . ' ' . (float)$profile->lon;
- }
+ $sizes = array(
+ AVATAR_PROFILE_SIZE,
+ AVATAR_STREAM_SIZE,
+ AVATAR_MINI_SIZE
+ );
- $object->poco = PoCo::fromProfile($profile);
+ foreach ($sizes as $size) {
+ $alink = null;
+ $avatar = $profile->getAvatar($size);
+
+ if (!empty($avatar)) {
+ $alink = AvatarLink::fromAvatar($avatar);
+ } else {
+ $alink = new AvatarLink();
+ $alink->type = 'image/png';
+ $alink->height = $size;
+ $alink->width = $size;
+ $alink->url = Avatar::defaultImage($size);
+
+ if ($size == AVATAR_PROFILE_SIZE) {
+ // Hack for Twitter import: we don't have a 96x96 image,
+ // but we do have a 73x73 image. For now, fake it with that.
+ $avatar = $profile->getAvatar(73);
+ if ($avatar) {
+ $alink = AvatarLink::fromAvatar($avatar);
+ $alink->height= $size;
+ $alink->width = $size;
+ }
+ }
+ }
+
+ $object->avatarLinks[] = $alink;
+ }
+
+ if (isset($profile->lat) && isset($profile->lon)) {
+ $object->geopoint = (float)$profile->lat
+ . ' ' . (float)$profile->lon;
+ }
+
+ $object->poco = PoCo::fromProfile($profile);
+
+ Event::handle('EndActivityObjectFromProfile', array($profile, &$object));
+ }
return $object;
}
{
$object = new ActivityObject();
- $object->type = ActivityObject::GROUP;
- $object->id = $group->getUri();
- $object->title = $group->getBestName();
- $object->link = $group->getUri();
+ if (Event::handle('StartActivityObjectFromGroup', array($group, &$object))) {
- $object->avatarLinks[] = AvatarLink::fromFilename(
- $group->homepage_logo,
- AVATAR_PROFILE_SIZE
- );
+ $object->type = ActivityObject::GROUP;
+ $object->id = $group->getUri();
+ $object->title = $group->getBestName();
+ $object->link = $group->getUri();
- $object->avatarLinks[] = AvatarLink::fromFilename(
- $group->stream_logo,
- AVATAR_STREAM_SIZE
- );
+ $object->avatarLinks[] = AvatarLink::fromFilename($group->homepage_logo,
+ AVATAR_PROFILE_SIZE);
- $object->avatarLinks[] = AvatarLink::fromFilename(
- $group->mini_logo,
- AVATAR_MINI_SIZE
- );
+ $object->avatarLinks[] = AvatarLink::fromFilename($group->stream_logo,
+ AVATAR_STREAM_SIZE);
- $object->poco = PoCo::fromGroup($group);
+ $object->avatarLinks[] = AvatarLink::fromFilename($group->mini_logo,
+ AVATAR_MINI_SIZE);
+
+ $object->poco = PoCo::fromGroup($group);
+
+ Event::handle('EndActivityObjectFromGroup', array($group, &$object));
+ }
return $object;
}
- function asString($tag='activity:object')
- {
- $xs = new XMLStringer(true);
+ function outputTo($xo, $tag='activity:object')
+ {
+ if (!empty($tag)) {
+ $xo->elementStart($tag);
+ }
- $xs->elementStart($tag);
+ $xo->element('activity:object-type', null, $this->type);
- $xs->element('activity:object-type', null, $this->type);
+ // <author> uses URI
- $xs->element(self::ID, null, $this->id);
+ if ($tag == 'author') {
+ $xo->element(self::URI, null, $this->id);
+ } else {
+ $xo->element(self::ID, null, $this->id);
+ }
if (!empty($this->title)) {
- $xs->element(
- self::TITLE,
- null,
- common_xml_safe_str($this->title)
- );
+ $name = common_xml_safe_str($this->title);
+ if ($tag == 'author') {
+ // XXX: Backward compatibility hack -- atom:name should contain
+ // full name here, instead of nickname, i.e.: $name. Change
+ // this in the next version.
+ $xo->element(self::NAME, null, $this->poco->preferredUsername);
+ } else {
+ $xo->element(self::TITLE, null, $name);
+ }
}
if (!empty($this->summary)) {
- $xs->element(
+ $xo->element(
self::SUMMARY,
null,
common_xml_safe_str($this->summary)
if (!empty($this->content)) {
// XXX: assuming HTML content here
- $xs->element(
+ $xo->element(
ActivityUtils::CONTENT,
array('type' => 'html'),
common_xml_safe_str($this->content)
}
if (!empty($this->link)) {
- $xs->element(
+ $xo->element(
'link',
array(
'rel' => 'alternate',
|| $this->type == ActivityObject::GROUP) {
foreach ($this->avatarLinks as $avatar) {
- $xs->element(
+ $xo->element(
'link', array(
'rel' => 'avatar',
'type' => $avatar->type,
}
if (!empty($this->geopoint)) {
- $xs->element(
+ $xo->element(
'georss:point',
null,
$this->geopoint
}
if (!empty($this->poco)) {
- $xs->raw($this->poco->asString());
+ $this->poco->outputTo($xo);
+ }
+
+ foreach ($this->extra as $el) {
+ list($extraTag, $attrs, $content) = $el;
+ $xo->element($extraTag, $attrs, $content);
}
- $xs->elementEnd($tag);
+ if (!empty($tag)) {
+ $xo->elementEnd($tag);
+ }
+
+ return;
+ }
+
+ function asString($tag='activity:object')
+ {
+ $xs = new XMLStringer(true);
+
+ $this->outputTo($xs, $tag);
return $xs->getString();
}
+
+ /*
+ * Returns an array based on this Activity Object suitable for
+ * encoding as JSON.
+ *
+ * @return array $object the activity object array
+ */
+
+ function asArray()
+ {
+ $object = array();
+
+ // XXX: attachedObjects are added by Activity
+
+ // displayName
+ $object['displayName'] = $this->title;
+
+ // TODO: downstreamDuplicates
+
+ // embedCode (used for video)
+
+ // id
+ //
+ // XXX: Should we use URL here? or a crazy tag URI?
+ $object['id'] = $this->id;
+
+ if ($this->type == ActivityObject::PERSON
+ || $this->type == ActivityObject::GROUP) {
+
+ // XXX: Not sure what the best avatar is to use for the
+ // author's "image". For now, I'm using the large size.
+
+ $avatarLarge = null;
+ $avatarMediaLinks = array();
+
+ foreach ($this->avatarLinks as $a) {
+
+ // Make a MediaLink for every other Avatar
+ $avatar = new ActivityStreamsMediaLink(
+ $a->url,
+ $a->width,
+ $a->height,
+ $a->type,
+ 'avatar'
+ );
+
+ // Find the big avatar to use as the "image"
+ if ($a->height == AVATAR_PROFILE_SIZE) {
+ $imgLink = $avatar;
+ }
+
+ $avatarMediaLinks[] = $avatar->asArray();
+ }
+
+ $object['avatars'] = $avatarMediaLinks; // extension
+
+ // image
+ $object['image'] = $imgLink->asArray();
+ }
+
+ // objectType
+ //
+ // We can probably use the whole schema URL here but probably the
+ // relative simple name is easier to parse
+ $object['type'] = substr($this->type, strrpos($this->type, '/') + 1);
+
+ // summary
+ $object['summary'] = $this->summary;
+
+ // TODO: upstreamDuplicates
+
+ // url (XXX: need to put the right thing here...)
+ $object['url'] = $this->id;
+
+ /* Extensions */
+
+ foreach ($this->extra as $e) {
+ list($objectName, $props, $txt) = $e;
+ $object[$objectName] = $props;
+ }
+
+ return array_filter($object);
+ }
}