3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * @package OStatusPlugin
22 * @maintainer Brion Vibber <brion@status.net>
25 class Ostatus_profile extends Memcached_DataObject
27 public $__table = 'ostatus_profile';
36 public $avatar; // remote URL of the last avatar we saved
41 public /*static*/ function staticGet($k, $v=null)
43 return parent::staticGet(__CLASS__, $k, $v);
47 * return table definition for DB_DataObject
49 * DB_DataObject needs to know something about the table to manipulate
50 * instances. This method provides all the DB_DataObject needs to know.
52 * @return array array of column definitions
57 return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
58 'profile_id' => DB_DATAOBJECT_INT,
59 'group_id' => DB_DATAOBJECT_INT,
60 'feeduri' => DB_DATAOBJECT_STR,
61 'salmonuri' => DB_DATAOBJECT_STR,
62 'avatar' => DB_DATAOBJECT_STR,
63 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
64 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
67 static function schemaDef()
69 return array(new ColumnDef('uri', 'varchar',
71 new ColumnDef('profile_id', 'integer',
73 new ColumnDef('group_id', 'integer',
75 new ColumnDef('feeduri', 'varchar',
77 new ColumnDef('salmonuri', 'text',
79 new ColumnDef('avatar', 'text',
81 new ColumnDef('created', 'datetime',
83 new ColumnDef('modified', 'datetime',
88 * return key definitions for DB_DataObject
90 * DB_DataObject needs to know about keys that the table has; this function
93 * @return array key definitions
98 return array_keys($this->keyTypes());
102 * return key definitions for Memcached_DataObject
104 * Our caching system uses the same key definitions, but uses a different
105 * method to get them.
107 * @return array key definitions
112 return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
115 function sequenceKey()
117 return array(false, false, false);
121 * Fetch the StatusNet-side profile for this feed
124 public function localProfile()
126 if ($this->profile_id) {
127 return Profile::staticGet('id', $this->profile_id);
133 * Fetch the StatusNet-side profile for this feed
136 public function localGroup()
138 if ($this->group_id) {
139 return User_group::staticGet('id', $this->group_id);
145 * Returns an ActivityObject describing this remote user or group profile.
146 * Can then be used to generate Atom chunks.
148 * @return ActivityObject
150 function asActivityObject()
152 if ($this->isGroup()) {
153 return ActivityObject::fromGroup($this->localGroup());
155 return ActivityObject::fromProfile($this->localProfile());
160 * Returns an XML string fragment with profile information as an
161 * Activity Streams noun object with the given element type.
163 * Assumes that 'activity' namespace has been previously defined.
165 * @fixme replace with wrappers on asActivityObject when it's got everything.
167 * @param string $element one of 'actor', 'subject', 'object', 'target'
170 function asActivityNoun($element)
172 if ($this->isGroup()) {
173 $noun = ActivityObject::fromGroup($this->localGroup());
174 return $noun->asString('activity:' . $element);
176 $noun = ActivityObject::fromProfile($this->localProfile());
177 return $noun->asString('activity:' . $element);
182 * @return boolean true if this is a remote group
186 if ($this->profile_id && !$this->group_id) {
188 } else if ($this->group_id && !$this->profile_id) {
190 } else if ($this->group_id && $this->profile_id) {
191 throw new ServerException("Invalid ostatus_profile state: both group and profile IDs set for $this->uri");
193 throw new ServerException("Invalid ostatus_profile state: both group and profile IDs empty for $this->uri");
198 * Send a subscription request to the hub for this feed.
199 * The hub will later send us a confirmation POST to /main/push/callback.
201 * @return bool true on success, false on failure
202 * @throws ServerException if feed state is not valid
204 public function subscribe()
206 $feedsub = FeedSub::ensureFeed($this->feeduri);
207 if ($feedsub->sub_state == 'active') {
208 // Active subscription, we don't need to do anything.
211 // Inactive or we got left in an inconsistent state.
212 // Run a subscription request to make sure we're current!
213 return $feedsub->subscribe();
218 * Check if this remote profile has any active local subscriptions, and
219 * if not drop the PuSH subscription feed.
221 * @return bool true on success, false on failure
223 public function unsubscribe() {
224 $this->garbageCollect();
228 * Check if this remote profile has any active local subscriptions, and
229 * if not drop the PuSH subscription feed.
233 public function garbageCollect()
235 $feedsub = FeedSub::staticGet('uri', $this->feeduri);
236 return $feedsub->garbageCollect();
240 * Check if this remote profile has any active local subscriptions, so the
241 * PuSH subscription layer can decide if it can drop the feed.
243 * This gets called via the FeedSubSubscriberCount event when running
244 * FeedSub::garbageCollect().
248 public function subscriberCount()
250 if ($this->isGroup()) {
251 $members = $this->localGroup()->getMembers(0, 1);
252 $count = $members->N;
254 $count = $this->localProfile()->subscriberCount();
256 common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
258 // Other plugins may be piggybacking on OStatus without having
259 // an active group or user-to-user subscription we know about.
260 Event::handle('Ostatus_profileSubscriberCount', array($this, &$count));
261 common_log(LOG_INFO, __METHOD__ . " SUB COUNT AFTER: $count");
267 * Send an Activity Streams notification to the remote Salmon endpoint,
270 * @param Profile $actor Actor who did the activity
271 * @param string $verb Activity::SUBSCRIBE or Activity::JOIN
272 * @param Object $object object of the action; must define asActivityNoun($tag)
274 public function notify($actor, $verb, $object=null)
276 if (!($actor instanceof Profile)) {
277 $type = gettype($actor);
278 if ($type == 'object') {
279 $type = get_class($actor);
281 throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
283 if ($object == null) {
286 if ($this->salmonuri) {
289 $id = TagURI::mint('%s:%s:%s',
292 common_date_iso8601(time()));
294 // @fixme consolidate all these NS settings somewhere
295 $attributes = array('xmlns' => Activity::ATOM,
296 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
297 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
298 'xmlns:georss' => 'http://www.georss.org/georss',
299 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
300 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
301 'xmlns:media' => 'http://purl.org/syndication/atommedia');
303 $entry = new XMLStringer();
304 $entry->elementStart('entry', $attributes);
305 $entry->element('id', null, $id);
306 $entry->element('title', null, $text);
307 $entry->element('summary', null, $text);
308 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
310 $entry->element('activity:verb', null, $verb);
311 $entry->raw($actor->asAtomAuthor());
312 $entry->raw($actor->asActivityActor());
313 $entry->raw($object->asActivityNoun('object'));
314 $entry->elementEnd('entry');
316 $xml = $entry->getString();
317 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
319 $salmon = new Salmon(); // ?
320 return $salmon->post($this->salmonuri, $xml, $actor);
326 * Send a Salmon notification ping immediately, and confirm that we got
327 * an acceptable response from the remote site.
329 * @param mixed $entry XML string, Notice, or Activity
330 * @return boolean success
332 public function notifyActivity($entry, $actor)
334 if ($this->salmonuri) {
335 $salmon = new Salmon();
336 return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
343 * Queue a Salmon notification for later. If queues are disabled we'll
344 * send immediately but won't get the return value.
346 * @param mixed $entry XML string, Notice, or Activity
347 * @return boolean success
349 public function notifyDeferred($entry, $actor)
351 if ($this->salmonuri) {
352 $data = array('salmonuri' => $this->salmonuri,
353 'entry' => $this->notifyPrepXml($entry),
354 'actor' => $actor->id);
356 $qm = QueueManager::get();
357 return $qm->enqueue($data, 'salmon');
363 protected function notifyPrepXml($entry)
365 $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
366 if (is_string($entry)) {
368 } else if ($entry instanceof Activity) {
369 return $preamble . $entry->asString(true);
370 } else if ($entry instanceof Notice) {
371 return $preamble . $entry->asAtomEntry(true, true);
373 throw new ServerException("Invalid type passed to Ostatus_profile::notify; must be XML string or Activity entry");
377 function getBestName()
379 if ($this->isGroup()) {
380 return $this->localGroup()->getBestName();
382 return $this->localProfile()->getBestName();
387 * Read and post notices for updates from the feed.
388 * Currently assumes that all items in the feed are new,
389 * coming from a PuSH hub.
391 * @param DOMDocument $doc
392 * @param string $source identifier ("push")
394 public function processFeed(DOMDocument $doc, $source)
396 $feed = $doc->documentElement;
398 if ($feed->localName == 'feed' && $feed->namespaceURI == Activity::ATOM) {
399 $this->processAtomFeed($feed, $source);
400 } else if ($feed->localName == 'rss') { // @fixme check namespace
401 $this->processRssFeed($feed, $source);
403 throw new Exception("Unknown feed format.");
407 public function processAtomFeed(DOMElement $feed, $source)
409 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
410 if ($entries->length == 0) {
411 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
415 for ($i = 0; $i < $entries->length; $i++) {
416 $entry = $entries->item($i);
417 $this->processEntry($entry, $feed, $source);
421 public function processRssFeed(DOMElement $rss, $source)
423 $channels = $rss->getElementsByTagName('channel');
425 if ($channels->length == 0) {
426 throw new Exception("RSS feed without a channel.");
427 } else if ($channels->length > 1) {
428 common_log(LOG_WARNING, __METHOD__ . ": more than one channel in an RSS feed");
431 $channel = $channels->item(0);
433 $items = $channel->getElementsByTagName('item');
435 for ($i = 0; $i < $items->length; $i++) {
436 $item = $items->item($i);
437 $this->processEntry($item, $channel, $source);
442 * Process a posted entry from this feed source.
444 * @param DOMElement $entry
445 * @param DOMElement $feed for context
446 * @param string $source identifier ("push" or "salmon")
449 public function processEntry($entry, $feed, $source)
451 $activity = new Activity($entry, $feed);
453 if (Event::handle('StartHandleFeedEntry', array($activity))) {
455 // @todo process all activity objects
456 switch ($activity->objects[0]->type) {
457 case ActivityObject::ARTICLE:
458 case ActivityObject::BLOGENTRY:
459 case ActivityObject::NOTE:
460 case ActivityObject::STATUS:
461 case ActivityObject::COMMENT:
462 if ($activity->verb == ActivityVerb::POST) {
463 $this->processPost($activity, $source);
465 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
469 throw new ClientException("Can't handle that kind of post.");
472 Event::handle('EndHandleFeedEntry', array($activity));
477 * Process an incoming post activity from this remote feed.
478 * @param Activity $activity
479 * @param string $method 'push' or 'salmon'
480 * @return mixed saved Notice or false
481 * @fixme break up this function, it's getting nasty long
483 public function processPost($activity, $method)
485 if ($this->isGroup()) {
486 // A group feed will contain posts from multiple authors.
487 // @fixme validate these profiles in some way!
488 $oprofile = self::ensureActorProfile($activity);
489 if ($oprofile->isGroup()) {
490 // Groups can't post notices in StatusNet.
491 common_log(LOG_WARNING, "OStatus: skipping post with group listed as author: $oprofile->uri in feed from $this->uri");
495 $actor = $activity->actor;
498 // OK here! assume the default
499 } else if ($actor->id == $this->uri || $actor->link == $this->uri) {
500 $this->updateFromActivityObject($actor);
501 } else if ($actor->id) {
502 // We have an ActivityStreams actor with an explicit ID that doesn't match the feed owner.
503 // This isn't what we expect from mainline OStatus person feeds!
504 // Group feeds go down another path, with different validation...
505 // Most likely this is a plain ol' blog feed of some kind which
506 // doesn't match our expectations. We'll take the entry, but ignore
507 // the <author> info.
508 common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for {$this->uri}");
510 // Plain <author> without ActivityStreams actor info.
511 // We'll just ignore this info for now and save the update under the feed's identity.
517 // It's not always an ActivityObject::NOTE, but... let's just say it is.
519 $note = $activity->objects[0];
521 // The id URI will be used as a unique identifier for for the notice,
522 // protecting against duplicate saves. It isn't required to be a URL;
523 // tag: URIs for instance are found in Google Buzz feeds.
524 $sourceUri = $note->id;
525 $dupe = Notice::staticGet('uri', $sourceUri);
527 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
531 // We'll also want to save a web link to the original notice, if provided.
534 $sourceUrl = $note->link;
535 } else if ($activity->link) {
536 $sourceUrl = $activity->link;
537 } else if (preg_match('!^https?://!', $note->id)) {
538 $sourceUrl = $note->id;
541 // Use summary as fallback for content
543 if (!empty($note->content)) {
544 $sourceContent = $note->content;
545 } else if (!empty($note->summary)) {
546 $sourceContent = $note->summary;
547 } else if (!empty($note->title)) {
548 $sourceContent = $note->title;
550 // @fixme fetch from $sourceUrl?
551 throw new ClientException("No content for notice {$sourceUri}");
554 // Get (safe!) HTML and text versions of the content
556 $rendered = $this->purify($sourceContent);
557 $content = html_entity_decode(strip_tags($rendered));
559 $shortened = common_shorten_links($content);
561 // If it's too long, try using the summary, and make the
562 // HTML an attachment.
566 if (Notice::contentTooLong($shortened)) {
567 $attachment = $this->saveHTMLFile($note->title, $rendered);
568 $summary = html_entity_decode(strip_tags($note->summary));
569 if (empty($summary)) {
572 $shortSummary = common_shorten_links($summary);
573 if (Notice::contentTooLong($shortSummary)) {
574 $url = common_shorten_url($sourceUrl);
575 $shortSummary = substr($shortSummary,
577 Notice::maxContent() - (mb_strlen($url) + 2));
578 $content = $shortSummary . ' ' . $url;
580 // We mark up the attachment link specially for the HTML output
581 // so we can fold-out the full version inline.
582 $attachUrl = common_local_url('attachment',
583 array('attachment' => $attachment->id));
584 $rendered = common_render_text($shortSummary) .
585 '<a href="' . htmlspecialchars($attachUrl) .'"'.
586 ' class="attachment more"' .
587 ' title="'. htmlspecialchars(_m('Show more')) . '">' .
593 $options = array('is_local' => Notice::REMOTE_OMB,
596 'rendered' => $rendered,
597 'replies' => array(),
602 // Check for optional attributes...
604 if (!empty($activity->time)) {
605 $options['created'] = common_sql_date($activity->time);
608 if ($activity->context) {
609 // Any individual or group attn: targets?
610 $replies = $activity->context->attention;
611 $options['groups'] = $this->filterReplies($oprofile, $replies);
612 $options['replies'] = $replies;
614 // Maintain direct reply associations
615 // @fixme what about conversation ID?
616 if (!empty($activity->context->replyToID)) {
617 $orig = Notice::staticGet('uri',
618 $activity->context->replyToID);
620 $options['reply_to'] = $orig->id;
624 $location = $activity->context->location;
626 $options['lat'] = $location->lat;
627 $options['lon'] = $location->lon;
628 if ($location->location_id) {
629 $options['location_ns'] = $location->location_ns;
630 $options['location_id'] = $location->location_id;
635 // Atom categories <-> hashtags
636 foreach ($activity->categories as $cat) {
638 $term = common_canonical_tag($cat->term);
640 $options['tags'][] = $term;
645 // Atom enclosures -> attachment URLs
646 foreach ($activity->enclosures as $href) {
647 // @fixme save these locally or....?
648 $options['urls'][] = $href;
652 $saved = Notice::saveNew($oprofile->profile_id,
657 Ostatus_source::saveNew($saved, $this, $method);
658 if (!empty($attachment)) {
659 File_to_post::processNew($attachment->id, $saved->id);
662 } catch (Exception $e) {
663 common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
666 common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
673 protected function purify($html)
675 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
676 $config = array('safe' => 1,
677 'deny_attribute' => 'id,style,on*');
678 return htmLawed($html, $config);
682 * Filters a list of recipient ID URIs to just those for local delivery.
683 * @param Ostatus_profile local profile of sender
684 * @param array in/out &$attention_uris set of URIs, will be pruned on output
685 * @return array of group IDs
687 protected function filterReplies($sender, &$attention_uris)
689 common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
692 foreach (array_unique($attention_uris) as $recipient) {
693 // Is the recipient a local user?
694 $user = User::staticGet('uri', $recipient);
696 // @fixme sender verification, spam etc?
697 $replies[] = $recipient;
701 // Is the recipient a remote group?
702 $oprofile = Ostatus_profile::ensureProfileURI($recipient);
705 if ($oprofile->isGroup()) {
706 // Deliver to local members of this remote group.
707 // @fixme sender verification?
708 $groups[] = $oprofile->group_id;
710 // may be canonicalized or something
711 $replies[] = $oprofile->uri;
716 // Is the recipient a local group?
717 // @fixme uri on user_group isn't reliable yet
718 // $group = User_group::staticGet('uri', $recipient);
719 $id = OStatusPlugin::localGroupFromUrl($recipient);
721 $group = User_group::staticGet('id', $id);
723 // Deliver to all members of this local group if allowed.
724 $profile = $sender->localProfile();
725 if ($profile->isMember($group)) {
726 $groups[] = $group->id;
728 common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
732 common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
736 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient");
739 $attention_uris = $replies;
740 common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
741 common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
746 * Look up and if necessary create an Ostatus_profile for the remote entity
747 * with the given profile page URL. This should never return null -- you
748 * will either get an object or an exception will be thrown.
750 * @param string $profile_url
751 * @return Ostatus_profile
752 * @throws Exception on various error conditions
753 * @throws OStatusShadowException if this reference would obscure a local user/group
756 public static function ensureProfileURL($profile_url, $hints=array())
758 $oprofile = self::getFromProfileURL($profile_url);
760 if (!empty($oprofile)) {
764 $hints['profileurl'] = $profile_url;
769 $client = new HTTPClient();
770 $client->setHeader('Accept', 'text/html,application/xhtml+xml');
771 $response = $client->get($profile_url);
773 if (!$response->isOk()) {
774 throw new Exception("Could not reach profile page: " . $profile_url);
777 // Check if we have a non-canonical URL
779 $finalUrl = $response->getUrl();
781 if ($finalUrl != $profile_url) {
783 $hints['profileurl'] = $finalUrl;
785 $oprofile = self::getFromProfileURL($finalUrl);
787 if (!empty($oprofile)) {
792 // Try to get some hCard data
794 $body = $response->getBody();
796 $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
798 if (!empty($hcardHints)) {
799 $hints = array_merge($hints, $hcardHints);
802 // Check if they've got an LRDD header
804 $lrdd = LinkHeader::getLink($response, 'lrdd', 'application/xrd+xml');
808 $xrd = Discovery::fetchXrd($lrdd);
809 $xrdHints = DiscoveryHints::fromXRD($xrd);
811 $hints = array_merge($hints, $xrdHints);
814 // If discovery found a feedurl (probably from LRDD), use it.
816 if (array_key_exists('feedurl', $hints)) {
817 return self::ensureFeedURL($hints['feedurl'], $hints);
820 // Get the feed URL from HTML
822 $discover = new FeedDiscovery();
824 $feedurl = $discover->discoverFromHTML($finalUrl, $body);
826 if (!empty($feedurl)) {
827 $hints['feedurl'] = $feedurl;
828 return self::ensureFeedURL($feedurl, $hints);
831 throw new Exception("Could not find a feed URL for profile page " . $finalUrl);
835 * Look up the Ostatus_profile, if present, for a remote entity with the
836 * given profile page URL. Will return null for both unknown and invalid
839 * @return mixed Ostatus_profile or null
840 * @throws OStatusShadowException for local profiles
842 static function getFromProfileURL($profile_url)
844 $profile = Profile::staticGet('profileurl', $profile_url);
846 if (empty($profile)) {
850 // Is it a known Ostatus profile?
852 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
854 if (!empty($oprofile)) {
858 // Is it a local user?
860 $user = User::staticGet('id', $profile->id);
863 throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
866 // Continue discovery; it's a remote profile
867 // for OMB or some other protocol, may also
874 * Look up and if necessary create an Ostatus_profile for remote entity
875 * with the given update feed. This should never return null -- you will
876 * either get an object or an exception will be thrown.
878 * @return Ostatus_profile
881 public static function ensureFeedURL($feed_url, $hints=array())
883 $discover = new FeedDiscovery();
885 $feeduri = $discover->discoverFromFeedURL($feed_url);
886 $hints['feedurl'] = $feeduri;
888 $huburi = $discover->getHubLink();
889 $hints['hub'] = $huburi;
890 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
891 $hints['salmon'] = $salmonuri;
893 if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
894 // We can only deal with folks with a PuSH hub
895 throw new FeedSubNoHubException();
898 $feedEl = $discover->root;
900 if ($feedEl->tagName == 'feed') {
901 return self::ensureAtomFeed($feedEl, $hints);
902 } else if ($feedEl->tagName == 'channel') {
903 return self::ensureRssChannel($feedEl, $hints);
905 throw new FeedSubBadXmlException($feeduri);
910 * Look up and, if necessary, create an Ostatus_profile for the remote
911 * profile with the given Atom feed - actually loaded from the feed.
912 * This should never return null -- you will either get an object or
913 * an exception will be thrown.
915 * @param DOMElement $feedEl root element of a loaded Atom feed
916 * @param array $hints additional discovery information passed from higher levels
917 * @fixme should this be marked public?
918 * @return Ostatus_profile
921 public static function ensureAtomFeed($feedEl, $hints)
923 // Try to get a profile from the feed activity:subject
925 $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
927 if (!empty($subject)) {
928 $subjObject = new ActivityObject($subject);
929 return self::ensureActivityObjectProfile($subjObject, $hints);
932 // Otherwise, try the feed author
934 $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
936 if (!empty($author)) {
937 $authorObject = new ActivityObject($author);
938 return self::ensureActivityObjectProfile($authorObject, $hints);
941 // Sheesh. Not a very nice feed! Let's try fingerpoken in the
944 $entries = $feedEl->getElementsByTagNameNS(Activity::ATOM, 'entry');
946 if (!empty($entries) && $entries->length > 0) {
948 $entry = $entries->item(0);
950 $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
952 if (!empty($actor)) {
953 $actorObject = new ActivityObject($actor);
954 return self::ensureActivityObjectProfile($actorObject, $hints);
958 $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
960 if (!empty($author)) {
961 $authorObject = new ActivityObject($author);
962 return self::ensureActivityObjectProfile($authorObject, $hints);
966 // XXX: make some educated guesses here
968 throw new FeedSubException("Can't find enough profile information to make a feed.");
972 * Look up and, if necessary, create an Ostatus_profile for the remote
973 * profile with the given RSS feed - actually loaded from the feed.
974 * This should never return null -- you will either get an object or
975 * an exception will be thrown.
977 * @param DOMElement $feedEl root element of a loaded RSS feed
978 * @param array $hints additional discovery information passed from higher levels
979 * @fixme should this be marked public?
980 * @return Ostatus_profile
983 public static function ensureRssChannel($feedEl, $hints)
985 // Special-case for Posterous. They have some nice metadata in their
986 // posterous:author elements. We should use them instead of the channel.
988 $items = $feedEl->getElementsByTagName('item');
990 if ($items->length > 0) {
991 $item = $items->item(0);
992 $authorEl = ActivityUtils::child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS);
993 if (!empty($authorEl)) {
994 $obj = ActivityObject::fromPosterousAuthor($authorEl);
995 // Posterous has multiple authors per feed, and multiple feeds
996 // per author. We check if this is the "main" feed for this author.
997 if (array_key_exists('profileurl', $hints) &&
998 !empty($obj->poco) &&
999 common_url_to_nickname($hints['profileurl']) == $obj->poco->preferredUsername) {
1000 return self::ensureActivityObjectProfile($obj, $hints);
1005 // @fixme we should check whether this feed has elements
1006 // with different <author> or <dc:creator> elements, and... I dunno.
1007 // Do something about that.
1009 $obj = ActivityObject::fromRssChannel($feedEl);
1011 return self::ensureActivityObjectProfile($obj, $hints);
1015 * Download and update given avatar image
1017 * @param string $url
1018 * @throws Exception in various failure cases
1020 protected function updateAvatar($url)
1022 if ($url == $this->avatar) {
1023 // We've already got this one.
1026 if (!common_valid_http_url($url)) {
1027 throw new ServerException(sprintf(_m("Invalid avatar URL %s"), $url));
1030 if ($this->isGroup()) {
1031 $self = $this->localGroup();
1033 $self = $this->localProfile();
1036 throw new ServerException(sprintf(
1037 _m("Tried to update avatar for unsaved remote profile %s"),
1041 // @fixme this should be better encapsulated
1042 // ripped from oauthstore.php (for old OMB client)
1043 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
1044 if (!copy($url, $temp_filename)) {
1045 throw new ServerException(sprintf(_m("Unable to fetch avatar from %s"), $url));
1048 if ($this->isGroup()) {
1049 $id = $this->group_id;
1051 $id = $this->profile_id;
1053 // @fixme should we be using different ids?
1054 $imagefile = new ImageFile($id, $temp_filename);
1055 $filename = Avatar::filename($id,
1056 image_type_to_extension($imagefile->type),
1058 common_timestamp());
1059 rename($temp_filename, Avatar::path($filename));
1060 $self->setOriginal($filename);
1062 $orig = clone($this);
1063 $this->avatar = $url;
1064 $this->update($orig);
1068 * Pull avatar URL from ActivityObject or profile hints
1070 * @param ActivityObject $object
1071 * @param array $hints
1072 * @return mixed URL string or false
1075 protected static function getActivityObjectAvatar($object, $hints=array())
1077 if ($object->avatarLinks) {
1079 // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
1080 foreach ($object->avatarLinks as $avatar) {
1081 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
1086 if (!$best || $avatar->width > $best->width) {
1091 } else if (array_key_exists('avatar', $hints)) {
1092 return $hints['avatar'];
1098 * Get an appropriate avatar image source URL, if available.
1100 * @param ActivityObject $actor
1101 * @param DOMElement $feed
1105 protected static function getAvatar($actor, $feed)
1109 if ($actor->avatar) {
1110 $url = trim($actor->avatar);
1113 // Check <atom:logo> and <atom:icon> on the feed
1114 $els = $feed->childNodes();
1115 if ($els && $els->length) {
1116 for ($i = 0; $i < $els->length; $i++) {
1117 $el = $els->item($i);
1118 if ($el->namespaceURI == Activity::ATOM) {
1119 if (empty($url) && $el->localName == 'logo') {
1120 $url = trim($el->textContent);
1123 if (empty($icon) && $el->localName == 'icon') {
1124 // Use as a fallback
1125 $icon = trim($el->textContent);
1130 if ($icon && !$url) {
1135 $opts = array('allowed_schemes' => array('http', 'https'));
1136 if (Validate::uri($url, $opts)) {
1140 return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
1144 * Fetch, or build if necessary, an Ostatus_profile for the actor
1145 * in a given Activity Streams activity.
1146 * This should never return null -- you will either get an object or
1147 * an exception will be thrown.
1149 * @param Activity $activity
1150 * @param string $feeduri if we already know the canonical feed URI!
1151 * @param string $salmonuri if we already know the salmon return channel URI
1152 * @return Ostatus_profile
1156 public static function ensureActorProfile($activity, $hints=array())
1158 return self::ensureActivityObjectProfile($activity->actor, $hints);
1162 * Fetch, or build if necessary, an Ostatus_profile for the profile
1163 * in a given Activity Streams object (can be subject, actor, or object).
1164 * This should never return null -- you will either get an object or
1165 * an exception will be thrown.
1167 * @param ActivityObject $object
1168 * @param array $hints additional discovery information passed from higher levels
1169 * @return Ostatus_profile
1173 public static function ensureActivityObjectProfile($object, $hints=array())
1175 $profile = self::getActivityObjectProfile($object);
1177 $profile->updateFromActivityObject($object, $hints);
1179 $profile = self::createActivityObjectProfile($object, $hints);
1185 * @param Activity $activity
1186 * @return mixed matching Ostatus_profile or false if none known
1187 * @throws ServerException if feed info invalid
1189 public static function getActorProfile($activity)
1191 return self::getActivityObjectProfile($activity->actor);
1195 * @param ActivityObject $activity
1196 * @return mixed matching Ostatus_profile or false if none known
1197 * @throws ServerException if feed info invalid
1199 protected static function getActivityObjectProfile($object)
1201 $uri = self::getActivityObjectProfileURI($object);
1202 return Ostatus_profile::staticGet('uri', $uri);
1206 * Get the identifier URI for the remote entity described
1207 * by this ActivityObject. This URI is *not* guaranteed to be
1208 * a resolvable HTTP/HTTPS URL.
1210 * @param ActivityObject $object
1212 * @throws ServerException if feed info invalid
1214 protected static function getActivityObjectProfileURI($object)
1217 if (ActivityUtils::validateUri($object->id)) {
1222 // If the id is missing or invalid (we've seen feeds mistakenly listing
1223 // things like local usernames in that field) then we'll use the profile
1224 // page link, if valid.
1225 if ($object->link && common_valid_http_url($object->link)) {
1226 return $object->link;
1228 throw new ServerException("No author ID URI found");
1232 * @fixme validate stuff somewhere
1236 * Create local ostatus_profile and profile/user_group entries for
1237 * the provided remote user or group.
1238 * This should never return null -- you will either get an object or
1239 * an exception will be thrown.
1241 * @param ActivityObject $object
1242 * @param array $hints
1244 * @return Ostatus_profile
1246 protected static function createActivityObjectProfile($object, $hints=array())
1248 $homeuri = $object->id;
1252 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1253 throw new Exception("No profile URI");
1256 $user = User::staticGet('uri', $homeuri);
1258 throw new Exception("Local user can't be referenced as remote.");
1261 if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1262 throw new Exception("Local group can't be referenced as remote.");
1265 if (array_key_exists('feedurl', $hints)) {
1266 $feeduri = $hints['feedurl'];
1268 $discover = new FeedDiscovery();
1269 $feeduri = $discover->discoverFromURL($homeuri);
1272 if (array_key_exists('salmon', $hints)) {
1273 $salmonuri = $hints['salmon'];
1276 $discover = new FeedDiscovery();
1277 $discover->discoverFromFeedURL($hints['feedurl']);
1279 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1282 if (array_key_exists('hub', $hints)) {
1283 $huburi = $hints['hub'];
1286 $discover = new FeedDiscovery();
1287 $discover->discoverFromFeedURL($hints['feedurl']);
1289 $huburi = $discover->getHubLink();
1292 if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
1293 // We can only deal with folks with a PuSH hub
1294 throw new FeedSubNoHubException();
1297 $oprofile = new Ostatus_profile();
1299 $oprofile->uri = $homeuri;
1300 $oprofile->feeduri = $feeduri;
1301 $oprofile->salmonuri = $salmonuri;
1303 $oprofile->created = common_sql_now();
1304 $oprofile->modified = common_sql_now();
1306 if ($object->type == ActivityObject::PERSON) {
1307 $profile = new Profile();
1308 $profile->created = common_sql_now();
1309 self::updateProfile($profile, $object, $hints);
1311 $oprofile->profile_id = $profile->insert();
1312 if (!$oprofile->profile_id) {
1313 throw new ServerException("Can't save local profile");
1316 $group = new User_group();
1317 $group->uri = $homeuri;
1318 $group->created = common_sql_now();
1319 self::updateGroup($group, $object, $hints);
1321 $oprofile->group_id = $group->insert();
1322 if (!$oprofile->group_id) {
1323 throw new ServerException("Can't save local profile");
1327 $ok = $oprofile->insert();
1330 throw new ServerException("Can't save OStatus profile");
1333 $avatar = self::getActivityObjectAvatar($object, $hints);
1337 $oprofile->updateAvatar($avatar);
1338 } catch (Exception $ex) {
1339 // Profile is saved, but Avatar is messed up. We're
1340 // just going to continue.
1341 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: ". $ex->getMessage());
1349 * Save any updated profile information to our local copy.
1350 * @param ActivityObject $object
1351 * @param array $hints
1353 public function updateFromActivityObject($object, $hints=array())
1355 if ($this->isGroup()) {
1356 $group = $this->localGroup();
1357 self::updateGroup($group, $object, $hints);
1359 $profile = $this->localProfile();
1360 self::updateProfile($profile, $object, $hints);
1362 $avatar = self::getActivityObjectAvatar($object, $hints);
1365 $this->updateAvatar($avatar);
1366 } catch (Exception $ex) {
1367 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: " . $ex->getMessage());
1372 protected static function updateProfile($profile, $object, $hints=array())
1374 $orig = clone($profile);
1376 $profile->nickname = self::getActivityObjectNickname($object, $hints);
1378 if (!empty($object->title)) {
1379 $profile->fullname = $object->title;
1380 } else if (array_key_exists('fullname', $hints)) {
1381 $profile->fullname = $hints['fullname'];
1384 if (!empty($object->link)) {
1385 $profile->profileurl = $object->link;
1386 } else if (array_key_exists('profileurl', $hints)) {
1387 $profile->profileurl = $hints['profileurl'];
1388 } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1389 $profile->profileurl = $object->id;
1392 $profile->bio = self::getActivityObjectBio($object, $hints);
1393 $profile->location = self::getActivityObjectLocation($object, $hints);
1394 $profile->homepage = self::getActivityObjectHomepage($object, $hints);
1396 if (!empty($object->geopoint)) {
1397 $location = ActivityContext::locationFromPoint($object->geopoint);
1398 if (!empty($location)) {
1399 $profile->lat = $location->lat;
1400 $profile->lon = $location->lon;
1404 // @fixme tags/categories
1405 // @todo tags from categories
1408 common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1409 $profile->update($orig);
1413 protected static function updateGroup($group, $object, $hints=array())
1415 $orig = clone($group);
1417 $group->nickname = self::getActivityObjectNickname($object, $hints);
1418 $group->fullname = $object->title;
1420 if (!empty($object->link)) {
1421 $group->mainpage = $object->link;
1422 } else if (array_key_exists('profileurl', $hints)) {
1423 $group->mainpage = $hints['profileurl'];
1426 // @todo tags from categories
1427 $group->description = self::getActivityObjectBio($object, $hints);
1428 $group->location = self::getActivityObjectLocation($object, $hints);
1429 $group->homepage = self::getActivityObjectHomepage($object, $hints);
1432 common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1433 $group->update($orig);
1437 protected static function getActivityObjectHomepage($object, $hints=array())
1440 $poco = $object->poco;
1442 if (!empty($poco)) {
1443 $url = $poco->getPrimaryURL();
1444 if ($url && $url->type == 'homepage') {
1445 $homepage = $url->value;
1449 // @todo Try for a another PoCo URL?
1454 protected static function getActivityObjectLocation($object, $hints=array())
1458 if (!empty($object->poco) &&
1459 isset($object->poco->address->formatted)) {
1460 $location = $object->poco->address->formatted;
1461 } else if (array_key_exists('location', $hints)) {
1462 $location = $hints['location'];
1465 if (!empty($location)) {
1466 if (mb_strlen($location) > 255) {
1467 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1471 // @todo Try to find location some othe way? Via goerss point?
1476 protected static function getActivityObjectBio($object, $hints=array())
1480 if (!empty($object->poco)) {
1481 $note = $object->poco->note;
1482 } else if (array_key_exists('bio', $hints)) {
1483 $note = $hints['bio'];
1486 if (!empty($note)) {
1487 if (Profile::bioTooLong($note)) {
1488 // XXX: truncate ok?
1489 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1495 // @todo Try to get bio info some other way?
1500 protected static function getActivityObjectNickname($object, $hints=array())
1502 if ($object->poco) {
1503 if (!empty($object->poco->preferredUsername)) {
1504 return common_nicknamize($object->poco->preferredUsername);
1508 if (!empty($object->nickname)) {
1509 return common_nicknamize($object->nickname);
1512 if (array_key_exists('nickname', $hints)) {
1513 return $hints['nickname'];
1516 // Try the profile url (like foo.example.com or example.com/user/foo)
1518 $profileUrl = ($object->link) ? $object->link : $hints['profileurl'];
1520 if (!empty($profileUrl)) {
1521 $nickname = self::nicknameFromURI($profileUrl);
1524 // Try the URI (may be a tag:, http:, acct:, ...
1526 if (empty($nickname)) {
1527 $nickname = self::nicknameFromURI($object->id);
1530 // Try a Webfinger if one was passed (way) down
1532 if (empty($nickname)) {
1533 if (array_key_exists('webfinger', $hints)) {
1534 $nickname = self::nicknameFromURI($hints['webfinger']);
1540 if (empty($nickname)) {
1541 $nickname = common_nicknamize($object->title);
1547 protected static function nicknameFromURI($uri)
1549 preg_match('/(\w+):/', $uri, $matches);
1551 $protocol = $matches[1];
1553 switch ($protocol) {
1556 if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1557 return common_canonical_nickname($matches[1]);
1561 return common_url_to_nickname($uri);
1569 * Look up, and if necessary create, an Ostatus_profile for the remote
1570 * entity with the given webfinger address.
1571 * This should never return null -- you will either get an object or
1572 * an exception will be thrown.
1574 * @param string $addr webfinger address
1575 * @return Ostatus_profile
1576 * @throws Exception on error conditions
1577 * @throws OStatusShadowException if this reference would obscure a local user/group
1579 public static function ensureWebfinger($addr)
1581 // First, try the cache
1583 $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1585 if ($uri !== false) {
1586 if (is_null($uri)) {
1587 // Negative cache entry
1588 throw new Exception('Not a valid webfinger address.');
1590 $oprofile = Ostatus_profile::staticGet('uri', $uri);
1591 if (!empty($oprofile)) {
1596 // Try looking it up
1598 $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1600 if (!empty($oprofile)) {
1601 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1605 // Now, try some discovery
1607 $disco = new Discovery();
1610 $xrd = $disco->lookup($addr);
1611 } catch (Exception $e) {
1612 // Save negative cache entry so we don't waste time looking it up again.
1613 // @fixme distinguish temporary failures?
1614 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1615 throw new Exception('Not a valid webfinger address.');
1618 $hints = array('webfinger' => $addr);
1620 $dhints = DiscoveryHints::fromXRD($xrd);
1622 $hints = array_merge($hints, $dhints);
1624 // If there's an Hcard, let's grab its info
1626 if (array_key_exists('hcard', $hints)) {
1627 if (!array_key_exists('profileurl', $hints) ||
1628 $hints['hcard'] != $hints['profileurl']) {
1629 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1630 $hints = array_merge($hcardHints, $hints);
1634 // If we got a feed URL, try that
1636 if (array_key_exists('feedurl', $hints)) {
1638 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1639 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
1640 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1642 } catch (Exception $e) {
1643 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1648 // If we got a profile page, try that!
1650 if (array_key_exists('profileurl', $hints)) {
1652 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1653 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
1654 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1656 } catch (OStatusShadowException $e) {
1657 // We've ended up with a remote reference to a local user or group.
1658 // @fixme ideally we should be able to say who it was so we can
1659 // go back and refer to it the regular way
1661 } catch (Exception $e) {
1662 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1665 // @fixme this means an error discovering from profile page
1666 // may give us a corrupt entry using the webfinger URI, which
1667 // will obscure the correct page-keyed profile later on.
1674 if (array_key_exists('salmon', $hints)) {
1676 $salmonEndpoint = $hints['salmon'];
1678 // An account URL, a salmon endpoint, and a dream? Not much to go
1679 // on, but let's give it a try
1681 $uri = 'acct:'.$addr;
1683 $profile = new Profile();
1685 $profile->nickname = self::nicknameFromUri($uri);
1686 $profile->created = common_sql_now();
1688 if (isset($profileUrl)) {
1689 $profile->profileurl = $profileUrl;
1692 $profile_id = $profile->insert();
1695 common_log_db_error($profile, 'INSERT', __FILE__);
1696 throw new Exception("Couldn't save profile for '$addr'");
1699 $oprofile = new Ostatus_profile();
1701 $oprofile->uri = $uri;
1702 $oprofile->salmonuri = $salmonEndpoint;
1703 $oprofile->profile_id = $profile_id;
1704 $oprofile->created = common_sql_now();
1706 if (isset($feedUrl)) {
1707 $profile->feeduri = $feedUrl;
1710 $result = $oprofile->insert();
1713 common_log_db_error($oprofile, 'INSERT', __FILE__);
1714 throw new Exception("Couldn't save ostatus_profile for '$addr'");
1717 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1721 throw new Exception("Couldn't find a valid profile for '$addr'");
1725 * Store the full-length scrubbed HTML of a remote notice to an attachment
1726 * file on our server. We'll link to this at the end of the cropped version.
1728 * @param string $title plaintext for HTML page's title
1729 * @param string $rendered HTML fragment for HTML page's body
1732 function saveHTMLFile($title, $rendered)
1734 $final = sprintf("<!DOCTYPE html>\n" .
1736 '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">' .
1737 '<title>%s</title>' .
1739 '<body>%s</body></html>',
1740 htmlspecialchars($title),
1743 $filename = File::filename($this->localProfile(),
1744 'ostatus', // ignored?
1747 $filepath = File::path($filename);
1749 file_put_contents($filepath, $final);
1753 $file->filename = $filename;
1754 $file->url = File::url($filename);
1755 $file->size = filesize($filepath);
1756 $file->date = time();
1757 $file->mimetype = 'text/html';
1759 $file_id = $file->insert();
1761 if ($file_id === false) {
1762 common_log_db_error($file, "INSERT", __FILE__);
1763 throw new ServerException(_('Could not store HTML content of long post as file.'));
1769 static function ensureProfileURI($uri)
1773 // First, try to query it
1775 $oprofile = Ostatus_profile::staticGet('uri', $uri);
1777 // If unfound, do discovery stuff
1779 if (empty($oprofile)) {
1780 if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
1781 $protocol = $match[1];
1782 switch ($protocol) {
1785 $oprofile = Ostatus_profile::ensureProfileURL($uri);
1790 $oprofile = Ostatus_profile::ensureWebfinger($rest);
1792 common_log("Unrecognized URI protocol for profile: $protocol ($uri)");
1802 * Exception indicating we've got a remote reference to a local user,
1803 * not a remote user!
1805 * If we can ue a local profile after all, it's available as $e->profile.
1807 class OStatusShadowException extends Exception
1812 * @param Profile $profile
1813 * @param string $message
1815 function __construct($profile, $message) {
1816 $this->profile = $profile;
1817 parent::__construct($message);