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/>.
20 if (!defined('STATUSNET')) {
25 * @package OStatusPlugin
26 * @maintainer Brion Vibber <brion@status.net>
28 class Ostatus_profile extends Managed_DataObject
30 public $__table = 'ostatus_profile';
40 public $avatar; // remote URL of the last avatar we saved
46 * Return table definition for Schema setup and DB_DataObject usage.
48 * @return array array of column definitions
50 static function schemaDef()
54 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true),
55 'profile_id' => array('type' => 'integer'),
56 'group_id' => array('type' => 'integer'),
57 'peopletag_id' => array('type' => 'integer'),
58 'feeduri' => array('type' => 'varchar', 'length' => 255),
59 'salmonuri' => array('type' => 'varchar', 'length' => 255),
60 'avatar' => array('type' => 'text'),
61 'created' => array('type' => 'datetime', 'not null' => true),
62 'modified' => array('type' => 'datetime', 'not null' => true),
64 'primary key' => array('uri'),
65 'unique keys' => array(
66 'ostatus_profile_profile_id_key' => array('profile_id'),
67 'ostatus_profile_group_id_key' => array('group_id'),
68 'ostatus_profile_peopletag_id_key' => array('peopletag_id'),
69 'ostatus_profile_feeduri_key' => array('feeduri'),
71 'foreign keys' => array(
72 'ostatus_profile_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
73 'ostatus_profile_group_id_fkey' => array('user_group', array('group_id' => 'id')),
74 'ostatus_profile_peopletag_id_fkey' => array('profile_list', array('peopletag_id' => 'id')),
79 public function getUri()
84 public function fromProfile(Profile $profile)
86 $oprofile = Ostatus_profile::getKV('profile_id', $profile->id);
87 if (!$oprofile instanceof Ostatus_profile) {
88 throw new Exception('No Ostatus_profile for Profile ID: '.$profile->id);
93 * Fetch the locally stored profile for this feed
95 * @throws NoProfileException if it was not found
97 public function localProfile()
99 if ($this->isGroup()) {
100 return $this->localGroup()->getProfile();
103 $profile = Profile::getKV('id', $this->profile_id);
104 if (!$profile instanceof Profile) {
105 throw new NoProfileException($this->profile_id);
111 * Fetch the StatusNet-side profile for this feed
114 public function localGroup()
116 if ($this->group_id) {
117 return User_group::getKV('id', $this->group_id);
123 * Fetch the StatusNet-side peopletag for this feed
126 public function localPeopletag()
128 if ($this->peopletag_id) {
129 return Profile_list::getKV('id', $this->peopletag_id);
135 * Returns an ActivityObject describing this remote user or group profile.
136 * Can then be used to generate Atom chunks.
138 * @return ActivityObject
140 function asActivityObject()
142 if ($this->isGroup()) {
143 return ActivityObject::fromGroup($this->localGroup());
144 } else if ($this->isPeopletag()) {
145 return ActivityObject::fromPeopletag($this->localPeopletag());
147 return $this->localProfile()->asActivityObject();
152 * Returns an XML string fragment with profile information as an
153 * Activity Streams noun object with the given element type.
155 * Assumes that 'activity' namespace has been previously defined.
157 * @todo FIXME: Replace with wrappers on asActivityObject when it's got everything.
159 * @param string $element one of 'actor', 'subject', 'object', 'target'
162 function asActivityNoun($element)
164 if ($this->isGroup()) {
165 $noun = ActivityObject::fromGroup($this->localGroup());
166 return $noun->asString('activity:' . $element);
167 } else if ($this->isPeopletag()) {
168 $noun = ActivityObject::fromPeopletag($this->localPeopletag());
169 return $noun->asString('activity:' . $element);
171 $noun = $this->localProfile()->asActivityObject();
172 return $noun->asString('activity:' . $element);
177 * @return boolean true if this is a remote group
181 if ($this->profile_id || $this->peopletag_id && !$this->group_id) {
183 } else if ($this->group_id && !$this->profile_id && !$this->peopletag_id) {
185 } else if ($this->group_id && ($this->profile_id || $this->peopletag_id)) {
186 // TRANS: Server exception. %s is a URI
187 throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->getUri()));
189 // TRANS: Server exception. %s is a URI
190 throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->getUri()));
195 * @return boolean true if this is a remote peopletag
197 function isPeopletag()
199 if ($this->profile_id || $this->group_id && !$this->peopletag_id) {
201 } else if ($this->peopletag_id && !$this->profile_id && !$this->group_id) {
203 } else if ($this->peopletag_id && ($this->profile_id || $this->group_id)) {
204 // TRANS: Server exception. %s is a URI
205 throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->getUri()));
207 // TRANS: Server exception. %s is a URI
208 throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->getUri()));
213 * Send a subscription request to the hub for this feed.
214 * The hub will later send us a confirmation POST to /main/push/callback.
217 * @throws ServerException if feed state is not valid or subscription fails.
219 public function subscribe()
221 $feedsub = FeedSub::ensureFeed($this->feeduri);
222 if ($feedsub->sub_state == 'active') {
223 // Active subscription, we don't need to do anything.
227 // Inactive or we got left in an inconsistent state.
228 // Run a subscription request to make sure we're current!
229 return $feedsub->subscribe();
233 * Check if this remote profile has any active local subscriptions, and
234 * if not drop the PuSH subscription feed.
236 * @return boolean true if subscription is removed, false if there are still subscribers to the feed
237 * @throws Exception of various kinds on failure.
239 public function unsubscribe() {
240 return $this->garbageCollect();
244 * Check if this remote profile has any active local subscriptions, and
245 * if not drop the PuSH subscription feed.
247 * @return boolean true if subscription is removed, false if there are still subscribers to the feed
248 * @throws Exception of various kinds on failure.
250 public function garbageCollect()
252 $feedsub = FeedSub::getKV('uri', $this->feeduri);
253 if ($feedsub instanceof FeedSub) {
254 return $feedsub->garbageCollect();
256 // Since there's no FeedSub we can assume it's already garbage collected
261 * Check if this remote profile has any active local subscriptions, so the
262 * PuSH subscription layer can decide if it can drop the feed.
264 * This gets called via the FeedSubSubscriberCount event when running
265 * FeedSub::garbageCollect().
268 * @throws NoProfileException if there is no local profile for the object
270 public function subscriberCount()
272 if ($this->isGroup()) {
273 $members = $this->localGroup()->getMembers(0, 1);
274 $count = $members->N;
275 } else if ($this->isPeopletag()) {
276 $subscribers = $this->localPeopletag()->getSubscribers(0, 1);
277 $count = $subscribers->N;
279 $profile = $this->localProfile();
280 if ($profile->hasLocalTags()) {
283 $count = $profile->subscriberCount();
286 common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
288 // Other plugins may be piggybacking on OStatus without having
289 // an active group or user-to-user subscription we know about.
290 Event::handle('Ostatus_profileSubscriberCount', array($this, &$count));
291 common_log(LOG_INFO, __METHOD__ . " SUB COUNT AFTER: $count");
297 * Send an Activity Streams notification to the remote Salmon endpoint,
300 * @param Profile $actor Actor who did the activity
301 * @param string $verb Activity::SUBSCRIBE or Activity::JOIN
302 * @param Object $object object of the action; must define asActivityNoun($tag)
304 public function notify(Profile $actor, $verb, $object=null, $target=null)
306 if ($object == null) {
309 if (empty($this->salmonuri)) {
313 $id = TagURI::mint('%s:%s:%s',
316 common_date_iso8601(time()));
318 // @todo FIXME: Consolidate all these NS settings somewhere.
319 $attributes = array('xmlns' => Activity::ATOM,
320 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
321 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
322 'xmlns:georss' => 'http://www.georss.org/georss',
323 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
324 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
325 'xmlns:media' => 'http://purl.org/syndication/atommedia');
327 $entry = new XMLStringer();
328 $entry->elementStart('entry', $attributes);
329 $entry->element('id', null, $id);
330 $entry->element('title', null, $text);
331 $entry->element('summary', null, $text);
332 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
334 $entry->element('activity:verb', null, $verb);
335 $entry->raw($actor->asAtomAuthor());
336 $entry->raw($actor->asActivityActor());
337 $entry->raw($object->asActivityNoun('object'));
338 if ($target != null) {
339 $entry->raw($target->asActivityNoun('target'));
341 $entry->elementEnd('entry');
343 $xml = $entry->getString();
344 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
346 Salmon::post($this->salmonuri, $xml, $actor->getUser());
350 * Send a Salmon notification ping immediately, and confirm that we got
351 * an acceptable response from the remote site.
353 * @param mixed $entry XML string, Notice, or Activity
354 * @param Profile $actor
355 * @return boolean success
357 public function notifyActivity($entry, Profile $actor)
359 if ($this->salmonuri) {
360 return Salmon::post($this->salmonuri, $this->notifyPrepXml($entry), $actor->getUser());
362 common_debug(__CLASS__.' error: No salmonuri for Ostatus_profile uri: '.$this->uri);
368 * Queue a Salmon notification for later. If queues are disabled we'll
369 * send immediately but won't get the return value.
371 * @param mixed $entry XML string, Notice, or Activity
372 * @return boolean success
374 public function notifyDeferred($entry, $actor)
376 if ($this->salmonuri) {
377 $data = array('salmonuri' => $this->salmonuri,
378 'entry' => $this->notifyPrepXml($entry),
379 'actor' => $actor->id);
381 $qm = QueueManager::get();
382 return $qm->enqueue($data, 'salmon');
388 protected function notifyPrepXml($entry)
390 $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
391 if (is_string($entry)) {
393 } else if ($entry instanceof Activity) {
394 return $preamble . $entry->asString(true);
395 } else if ($entry instanceof Notice) {
396 return $preamble . $entry->asAtomEntry(true, true);
398 // TRANS: Server exception.
399 throw new ServerException(_m('Invalid type passed to Ostatus_profile::notify. It must be XML string or Activity entry.'));
403 function getBestName()
405 if ($this->isGroup()) {
406 return $this->localGroup()->getBestName();
407 } else if ($this->isPeopletag()) {
408 return $this->localPeopletag()->getBestName();
410 return $this->localProfile()->getBestName();
415 * Read and post notices for updates from the feed.
416 * Currently assumes that all items in the feed are new,
417 * coming from a PuSH hub.
419 * @param DOMDocument $doc
420 * @param string $source identifier ("push")
422 public function processFeed(DOMDocument $doc, $source)
424 $feed = $doc->documentElement;
426 if ($feed->localName == 'feed' && $feed->namespaceURI == Activity::ATOM) {
427 $this->processAtomFeed($feed, $source);
428 } else if ($feed->localName == 'rss') { // @todo FIXME: Check namespace.
429 $this->processRssFeed($feed, $source);
432 throw new Exception(_m('Unknown feed format.'));
436 public function processAtomFeed(DOMElement $feed, $source)
438 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
439 if ($entries->length == 0) {
440 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
444 for ($i = 0; $i < $entries->length; $i++) {
445 $entry = $entries->item($i);
446 $this->processEntry($entry, $feed, $source);
450 public function processRssFeed(DOMElement $rss, $source)
452 $channels = $rss->getElementsByTagName('channel');
454 if ($channels->length == 0) {
456 throw new Exception(_m('RSS feed without a channel.'));
457 } else if ($channels->length > 1) {
458 common_log(LOG_WARNING, __METHOD__ . ": more than one channel in an RSS feed");
461 $channel = $channels->item(0);
463 $items = $channel->getElementsByTagName('item');
465 for ($i = 0; $i < $items->length; $i++) {
466 $item = $items->item($i);
467 $this->processEntry($item, $channel, $source);
472 * Process a posted entry from this feed source.
474 * @param DOMElement $entry
475 * @param DOMElement $feed for context
476 * @param string $source identifier ("push" or "salmon")
478 * @return Notice Notice representing the new (or existing) activity
480 public function processEntry($entry, $feed, $source)
482 $activity = new Activity($entry, $feed);
483 return $this->processActivity($activity, $source);
486 // TODO: Make this throw an exception
487 public function processActivity($activity, $source)
491 // The "WithProfile" events were added later.
493 if (Event::handle('StartHandleFeedEntryWithProfile', array($activity, $this->localProfile(), &$notice)) &&
494 Event::handle('StartHandleFeedEntry', array($activity))) {
496 switch ($activity->verb) {
497 case ActivityVerb::POST:
498 // @todo process all activity objects
499 switch ($activity->objects[0]->type) {
500 case ActivityObject::ARTICLE:
501 case ActivityObject::BLOGENTRY:
502 case ActivityObject::NOTE:
503 case ActivityObject::STATUS:
504 case ActivityObject::COMMENT:
506 $notice = $this->processPost($activity, $source);
509 // TRANS: Client exception.
510 throw new ClientException(_m('Cannot handle that kind of post.'));
513 case ActivityVerb::SHARE:
514 $notice = $this->processShare($activity, $source);
517 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
520 Event::handle('EndHandleFeedEntry', array($activity));
521 Event::handle('EndHandleFeedEntryWithProfile', array($activity, $this, $notice));
527 public function processShare($activity, $method)
532 $profile = ActivityUtils::checkAuthorship($activity, $this->localProfile());
533 } catch (ServerException $e) {
537 // The id URI will be used as a unique identifier for the notice,
538 // protecting against duplicate saves. It isn't required to be a URL;
539 // tag: URIs for instance are found in Google Buzz feeds.
540 $dupe = Notice::getKV('uri', $activity->id);
541 if ($dupe instanceof Notice) {
542 common_log(LOG_INFO, "OStatus: ignoring duplicate post: {$activity->id}");
546 if (count($activity->objects) != 1) {
547 // TRANS: Client exception thrown when trying to share multiple activities at once.
548 throw new ClientException(_m('Can only handle share activities with exactly one object.'));
551 $shared = $activity->objects[0];
553 if (!$shared instanceof Activity) {
554 // TRANS: Client exception thrown when trying to share a non-activity object.
555 throw new ClientException(_m('Can only handle shared activities.'));
558 $sharedId = $shared->id;
559 if (!empty($shared->objects[0]->id)) {
560 // Because StatusNet since commit 8cc4660 sets $shared->id to a TagURI which
561 // fucks up federation, because the URI is no longer recognised by the origin.
562 // So we set it to the object ID if it exists, otherwise we trust $shared->id
563 $sharedId = $shared->objects[0]->id;
565 if (empty($sharedId)) {
566 throw new ClientException(_m('Shared activity does not have an id'));
569 // First check if we have the shared activity. This has to be done first, because
570 // we can't use these functions to "ensureActivityObjectProfile" of a local user,
571 // who might be the creator of the shared activity in question.
572 $sharedNotice = Notice::getKV('uri', $sharedId);
573 if (!$sharedNotice instanceof Notice) {
574 // If no locally stored notice is found, process it!
575 // TODO: Remember to check Deleted_notice!
576 // TODO: If a post is shared that we can't retrieve - what to do?
578 $other = self::ensureActivityObjectProfile($shared->actor);
579 $sharedNotice = $other->processActivity($shared, $method);
580 if (!$sharedNotice instanceof Notice) {
581 // And if we apparently can't get the shared notice, we'll abort the whole thing.
582 // TRANS: Client exception thrown when saving an activity share fails.
583 // TRANS: %s is a share ID.
584 throw new ClientException(sprintf(_m('Failed to save activity %s.'), $sharedId));
586 } catch (FeedSubException $e) {
587 // Remote feed could not be found or verified, should we
588 // transform this into an "RT @user Blah, blah, blah..."?
589 common_log(LOG_INFO, __METHOD__ . ' got a ' . get_class($e) . ': ' . $e->getMessage());
594 // We'll want to save a web link to the original notice, if provided.
597 if ($activity->link) {
598 $sourceUrl = $activity->link;
599 } else if ($activity->link) {
600 $sourceUrl = $activity->link;
601 } else if (preg_match('!^https?://!', $activity->id)) {
602 $sourceUrl = $activity->id;
605 // Use summary as fallback for content
607 if (!empty($activity->content)) {
608 $sourceContent = $activity->content;
609 } else if (!empty($activity->summary)) {
610 $sourceContent = $activity->summary;
611 } else if (!empty($activity->title)) {
612 $sourceContent = $activity->title;
614 // @todo FIXME: Fetch from $sourceUrl?
615 // TRANS: Client exception. %s is a source URI.
616 throw new ClientException(sprintf(_m('No content for notice %s.'), $activity->id));
619 // Get (safe!) HTML and text versions of the content
621 $rendered = $this->purify($sourceContent);
622 $content = common_strip_html($rendered);
624 $shortened = common_shorten_links($content);
626 // If it's too long, try using the summary, and make the
627 // HTML an attachment.
631 if (Notice::contentTooLong($shortened)) {
632 $attachment = $this->saveHTMLFile($activity->title, $rendered);
633 $summary = common_strip_html($activity->summary);
634 if (empty($summary)) {
637 $shortSummary = common_shorten_links($summary);
638 if (Notice::contentTooLong($shortSummary)) {
639 $url = common_shorten_url($sourceUrl);
640 $shortSummary = substr($shortSummary,
642 Notice::maxContent() - (mb_strlen($url) + 2));
643 $content = $shortSummary . ' ' . $url;
645 // We mark up the attachment link specially for the HTML output
646 // so we can fold-out the full version inline.
648 // @todo FIXME i18n: This tooltip will be saved with the site's default language
649 // TRANS: Shown when a notice is longer than supported and/or when attachments are present. At runtime
650 // TRANS: this will usually be replaced with localised text from StatusNet core messages.
651 $showMoreText = _m('Show more');
652 $attachUrl = common_local_url('attachment',
653 array('attachment' => $attachment->id));
654 $rendered = common_render_text($shortSummary) .
655 '<a href="' . htmlspecialchars($attachUrl) .'"'.
656 ' class="attachment more"' .
657 ' title="'. htmlspecialchars($showMoreText) . '">' .
663 $options = array('is_local' => Notice::REMOTE,
665 'uri' => $activity->id,
666 'rendered' => $rendered,
667 'replies' => array(),
669 'peopletags' => array(),
672 'repeat_of' => $sharedNotice->id,
673 'scope' => $sharedNotice->scope);
675 // Check for optional attributes...
677 if (!empty($activity->time)) {
678 $options['created'] = common_sql_date($activity->time);
681 if ($activity->context) {
682 // TODO: context->attention
683 list($options['groups'], $options['replies'])
684 = self::filterAttention($profile, $activity->context->attention);
686 // Maintain direct reply associations
687 // @todo FIXME: What about conversation ID?
688 if (!empty($activity->context->replyToID)) {
689 $orig = Notice::getKV('uri',
690 $activity->context->replyToID);
691 if ($orig instanceof Notice) {
692 $options['reply_to'] = $orig->id;
696 $location = $activity->context->location;
698 $options['lat'] = $location->lat;
699 $options['lon'] = $location->lon;
700 if ($location->location_id) {
701 $options['location_ns'] = $location->location_ns;
702 $options['location_id'] = $location->location_id;
707 if ($this->isPeopletag()) {
708 $options['peopletags'][] = $this->localPeopletag();
711 // Atom categories <-> hashtags
712 foreach ($activity->categories as $cat) {
714 $term = common_canonical_tag($cat->term);
716 $options['tags'][] = $term;
721 // Atom enclosures -> attachment URLs
722 foreach ($activity->enclosures as $href) {
723 // @todo FIXME: Save these locally or....?
724 $options['urls'][] = $href;
727 $notice = Notice::saveNew($profile->id,
736 * Process an incoming post activity from this remote feed.
737 * @param Activity $activity
738 * @param string $method 'push' or 'salmon'
739 * @return mixed saved Notice or false
740 * @todo FIXME: Break up this function, it's getting nasty long
742 public function processPost($activity, $method)
746 $profile = ActivityUtils::checkAuthorship($activity, $this->localProfile());
748 // It's not always an ActivityObject::NOTE, but... let's just say it is.
750 $note = $activity->objects[0];
752 // The id URI will be used as a unique identifier for the notice,
753 // protecting against duplicate saves. It isn't required to be a URL;
754 // tag: URIs for instance are found in Google Buzz feeds.
755 $sourceUri = $note->id;
756 $dupe = Notice::getKV('uri', $sourceUri);
757 if ($dupe instanceof Notice) {
758 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
762 // We'll also want to save a web link to the original notice, if provided.
765 $sourceUrl = $note->link;
766 } else if ($activity->link) {
767 $sourceUrl = $activity->link;
768 } else if (preg_match('!^https?://!', $note->id)) {
769 $sourceUrl = $note->id;
772 // Use summary as fallback for content
774 if (!empty($note->content)) {
775 $sourceContent = $note->content;
776 } else if (!empty($note->summary)) {
777 $sourceContent = $note->summary;
778 } else if (!empty($note->title)) {
779 $sourceContent = $note->title;
781 // @todo FIXME: Fetch from $sourceUrl?
782 // TRANS: Client exception. %s is a source URI.
783 throw new ClientException(sprintf(_m('No content for notice %s.'),$sourceUri));
786 // Get (safe!) HTML and text versions of the content
788 $rendered = $this->purify($sourceContent);
789 $content = common_strip_html($rendered);
791 $shortened = common_shorten_links($content);
793 // If it's too long, try using the summary, and make the
794 // HTML an attachment.
798 if (Notice::contentTooLong($shortened)) {
799 $attachment = $this->saveHTMLFile($note->title, $rendered);
800 $summary = common_strip_html($note->summary);
801 if (empty($summary)) {
804 $shortSummary = common_shorten_links($summary);
805 if (Notice::contentTooLong($shortSummary)) {
806 $url = common_shorten_url($sourceUrl);
807 $shortSummary = substr($shortSummary,
809 Notice::maxContent() - (mb_strlen($url) + 2));
810 $content = $shortSummary . ' ' . $url;
812 // We mark up the attachment link specially for the HTML output
813 // so we can fold-out the full version inline.
815 // @todo FIXME i18n: This tooltip will be saved with the site's default language
816 // TRANS: Shown when a notice is longer than supported and/or when attachments are present. At runtime
817 // TRANS: this will usually be replaced with localised text from StatusNet core messages.
818 $showMoreText = _m('Show more');
819 $attachUrl = common_local_url('attachment',
820 array('attachment' => $attachment->id));
821 $rendered = common_render_text($shortSummary) .
822 '<a href="' . htmlspecialchars($attachUrl) .'"'.
823 ' class="attachment more"' .
824 ' title="'. htmlspecialchars($showMoreText) . '">' .
830 $options = array('is_local' => Notice::REMOTE,
833 'rendered' => $rendered,
834 'replies' => array(),
836 'peopletags' => array(),
840 // Check for optional attributes...
842 if (!empty($activity->time)) {
843 $options['created'] = common_sql_date($activity->time);
846 if ($activity->context) {
847 // TODO: context->attention
848 list($options['groups'], $options['replies'])
849 = self::filterAttention($profile, $activity->context->attention);
851 // Maintain direct reply associations
852 // @todo FIXME: What about conversation ID?
853 if (!empty($activity->context->replyToID)) {
854 $orig = Notice::getKV('uri', $activity->context->replyToID);
855 if ($orig instanceof Notice) {
856 $options['reply_to'] = $orig->id;
859 if (!empty($activity->context->conversation)) {
860 // we store the URI here, Notice class can look it up later
861 $options['conversation'] = $activity->context->conversation;
864 $location = $activity->context->location;
866 $options['lat'] = $location->lat;
867 $options['lon'] = $location->lon;
868 if ($location->location_id) {
869 $options['location_ns'] = $location->location_ns;
870 $options['location_id'] = $location->location_id;
875 if ($this->isPeopletag()) {
876 $options['peopletags'][] = $this->localPeopletag();
879 // Atom categories <-> hashtags
880 foreach ($activity->categories as $cat) {
882 $term = common_canonical_tag($cat->term);
884 $options['tags'][] = $term;
889 // Atom enclosures -> attachment URLs
890 foreach ($activity->enclosures as $href) {
891 // @todo FIXME: Save these locally or....?
892 $options['urls'][] = $href;
896 $saved = Notice::saveNew($profile->id,
900 if ($saved instanceof Notice) {
901 Ostatus_source::saveNew($saved, $this, $method);
902 if (!empty($attachment)) {
903 File_to_post::processNew($attachment->id, $saved->id);
906 } catch (Exception $e) {
907 common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
910 common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
917 protected function purify($html)
919 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
920 $config = array('safe' => 1,
921 'deny_attribute' => 'id,style,on*');
922 return htmLawed($html, $config);
926 * Filters a list of recipient ID URIs to just those for local delivery.
927 * @param Profile local profile of sender
928 * @param array in/out &$attention_uris set of URIs, will be pruned on output
929 * @return array of group IDs
931 static public function filterAttention(Profile $sender, array $attention)
933 common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', array_keys($attention)));
936 foreach ($attention as $recipient=>$type) {
937 // Is the recipient a local user?
938 $user = User::getKV('uri', $recipient);
939 if ($user instanceof User) {
940 // @todo FIXME: Sender verification, spam etc?
941 $replies[] = $recipient;
945 // Is the recipient a local group?
946 // TODO: $group = User_group::getKV('uri', $recipient);
947 $id = OStatusPlugin::localGroupFromUrl($recipient);
949 $group = User_group::getKV('id', $id);
950 if ($group instanceof User_group) {
951 // Deliver to all members of this local group if allowed.
952 if ($sender->isMember($group)) {
953 $groups[] = $group->id;
955 common_log(LOG_DEBUG, sprintf('Skipping reply to local group %s as sender %d is not a member', $group->getNickname(), $sender->id));
959 common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
963 // Is the recipient a remote user or group?
965 $oprofile = self::ensureProfileURI($recipient);
966 if ($oprofile->isGroup()) {
967 // Deliver to local members of this remote group.
968 // @todo FIXME: Sender verification?
969 $groups[] = $oprofile->group_id;
971 // may be canonicalized or something
972 $replies[] = $oprofile->getUri();
975 } catch (Exception $e) {
976 // Neither a recognizable local nor remote user!
977 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient: " . $e->getMessage());
981 common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
982 common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
983 return array($groups, $replies);
987 * Look up and if necessary create an Ostatus_profile for the remote entity
988 * with the given profile page URL. This should never return null -- you
989 * will either get an object or an exception will be thrown.
991 * @param string $profile_url
992 * @return Ostatus_profile
993 * @throws Exception on various error conditions
994 * @throws OStatusShadowException if this reference would obscure a local user/group
996 public static function ensureProfileURL($profile_url, array $hints=array())
998 $oprofile = self::getFromProfileURL($profile_url);
1000 if ($oprofile instanceof Ostatus_profile) {
1004 $hints['profileurl'] = $profile_url;
1007 // XXX: HTTP caching
1009 $client = new HTTPClient();
1010 $client->setHeader('Accept', 'text/html,application/xhtml+xml');
1011 $response = $client->get($profile_url);
1013 if (!$response->isOk()) {
1014 // TRANS: Exception. %s is a profile URL.
1015 throw new Exception(sprintf(_m('Could not reach profile page %s.'),$profile_url));
1018 // Check if we have a non-canonical URL
1020 $finalUrl = $response->getUrl();
1022 if ($finalUrl != $profile_url) {
1024 $hints['profileurl'] = $finalUrl;
1026 $oprofile = self::getFromProfileURL($finalUrl);
1028 if ($oprofile instanceof Ostatus_profile) {
1033 // Try to get some hCard data
1035 $body = $response->getBody();
1037 $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
1039 if (!empty($hcardHints)) {
1040 $hints = array_merge($hints, $hcardHints);
1043 // Check if they've got an LRDD header
1045 $lrdd = LinkHeader::getLink($response, 'lrdd');
1047 $xrd = new XML_XRD();
1048 $xrd->loadFile($lrdd);
1049 $xrdHints = DiscoveryHints::fromXRD($xrd);
1050 $hints = array_merge($hints, $xrdHints);
1051 } catch (Exception $e) {
1052 // No hints available from XRD
1055 // If discovery found a feedurl (probably from LRDD), use it.
1057 if (array_key_exists('feedurl', $hints)) {
1058 return self::ensureFeedURL($hints['feedurl'], $hints);
1061 // Get the feed URL from HTML
1063 $discover = new FeedDiscovery();
1065 $feedurl = $discover->discoverFromHTML($finalUrl, $body);
1067 if (!empty($feedurl)) {
1068 $hints['feedurl'] = $feedurl;
1069 return self::ensureFeedURL($feedurl, $hints);
1072 // TRANS: Exception. %s is a URL.
1073 throw new Exception(sprintf(_m('Could not find a feed URL for profile page %s.'),$finalUrl));
1077 * Look up the Ostatus_profile, if present, for a remote entity with the
1078 * given profile page URL. Will return null for both unknown and invalid
1081 * @return mixed Ostatus_profile or null
1082 * @throws OStatusShadowException for local profiles
1084 static function getFromProfileURL($profile_url)
1086 $profile = Profile::getKV('profileurl', $profile_url);
1087 if (!$profile instanceof Profile) {
1092 $oprofile = self::getFromProfile($profile);
1093 // We found the profile, return it!
1095 } catch (NoResultException $e) {
1096 // Could not find an OStatus profile, is it instead a local user?
1097 $user = User::getKV('id', $profile->id);
1098 if ($user instanceof User) {
1099 // @todo i18n FIXME: use sprintf and add i18n (?)
1100 throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
1104 // Continue discovery; it's a remote profile
1105 // for OMB or some other protocol, may also
1111 static function getFromProfile(Profile $profile)
1113 $oprofile = new Ostatus_profile();
1114 $oprofile->profile_id = $profile->id;
1115 if (!$oprofile->find(true)) {
1116 throw new NoResultException($oprofile);
1122 * Look up and if necessary create an Ostatus_profile for remote entity
1123 * with the given update feed. This should never return null -- you will
1124 * either get an object or an exception will be thrown.
1126 * @return Ostatus_profile
1129 public static function ensureFeedURL($feed_url, array $hints=array())
1131 $discover = new FeedDiscovery();
1133 $feeduri = $discover->discoverFromFeedURL($feed_url);
1134 $hints['feedurl'] = $feeduri;
1136 $huburi = $discover->getHubLink();
1137 $hints['hub'] = $huburi;
1139 // XXX: NS_REPLIES is deprecated anyway, so let's remove it in the future.
1140 $salmonuri = $discover->getAtomLink(Salmon::REL_SALMON)
1141 ?: $discover->getAtomLink(Salmon::NS_REPLIES);
1142 $hints['salmon'] = $salmonuri;
1144 if (!$huburi && !common_config('feedsub', 'fallback_hub') && !common_config('feedsub', 'nohub')) {
1145 // We can only deal with folks with a PuSH hub
1146 // unless we have something similar available locally.
1147 throw new FeedSubNoHubException();
1150 $feedEl = $discover->root;
1152 if ($feedEl->tagName == 'feed') {
1153 return self::ensureAtomFeed($feedEl, $hints);
1154 } else if ($feedEl->tagName == 'channel') {
1155 return self::ensureRssChannel($feedEl, $hints);
1157 throw new FeedSubBadXmlException($feeduri);
1162 * Look up and, if necessary, create an Ostatus_profile for the remote
1163 * profile with the given Atom feed - actually loaded from the feed.
1164 * This should never return null -- you will either get an object or
1165 * an exception will be thrown.
1167 * @param DOMElement $feedEl root element of a loaded Atom feed
1168 * @param array $hints additional discovery information passed from higher levels
1169 * @todo FIXME: Should this be marked public?
1170 * @return Ostatus_profile
1173 public static function ensureAtomFeed(DOMElement $feedEl, array $hints)
1175 $author = ActivityUtils::getFeedAuthor($feedEl);
1177 if (empty($author)) {
1178 // XXX: make some educated guesses here
1179 // TRANS: Feed sub exception.
1180 throw new FeedSubException(_m('Cannot find enough profile '.
1181 'information to make a feed.'));
1184 return self::ensureActivityObjectProfile($author, $hints);
1188 * Look up and, if necessary, create an Ostatus_profile for the remote
1189 * profile with the given RSS feed - actually loaded from the feed.
1190 * This should never return null -- you will either get an object or
1191 * an exception will be thrown.
1193 * @param DOMElement $feedEl root element of a loaded RSS feed
1194 * @param array $hints additional discovery information passed from higher levels
1195 * @todo FIXME: Should this be marked public?
1196 * @return Ostatus_profile
1199 public static function ensureRssChannel(DOMElement $feedEl, array $hints)
1201 // Special-case for Posterous. They have some nice metadata in their
1202 // posterous:author elements. We should use them instead of the channel.
1204 $items = $feedEl->getElementsByTagName('item');
1206 if ($items->length > 0) {
1207 $item = $items->item(0);
1208 $authorEl = ActivityUtils::child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS);
1209 if (!empty($authorEl)) {
1210 $obj = ActivityObject::fromPosterousAuthor($authorEl);
1211 // Posterous has multiple authors per feed, and multiple feeds
1212 // per author. We check if this is the "main" feed for this author.
1213 if (array_key_exists('profileurl', $hints) &&
1214 !empty($obj->poco) &&
1215 common_url_to_nickname($hints['profileurl']) == $obj->poco->preferredUsername) {
1216 return self::ensureActivityObjectProfile($obj, $hints);
1221 // @todo FIXME: We should check whether this feed has elements
1222 // with different <author> or <dc:creator> elements, and... I dunno.
1223 // Do something about that.
1225 $obj = ActivityObject::fromRssChannel($feedEl);
1227 return self::ensureActivityObjectProfile($obj, $hints);
1231 * Download and update given avatar image
1233 * @param string $url
1234 * @return Avatar The Avatar we have on disk. (seldom used)
1235 * @throws Exception in various failure cases
1237 public function updateAvatar($url, $force)
1240 // If avatar URL differs: update. If URLs were identical but we're forced: update.
1241 if ($url == $this->avatar && !$force) {
1242 // If there's no locally stored avatar, throw an exception and continue fetching below.
1243 $avatar = Avatar::getUploaded($this->localProfile()) instanceof Avatar;
1246 } catch (NoAvatarException $e) {
1247 // No avatar available, let's fetch it.
1250 if (!common_valid_http_url($url)) {
1251 // TRANS: Server exception. %s is a URL.
1252 throw new ServerException(sprintf(_m('Invalid avatar URL %s.'), $url));
1255 if ($this->isGroup()) {
1256 // FIXME: throw exception for localGroup
1257 $self = $this->localGroup();
1259 // this throws an exception already
1260 $self = $this->localProfile();
1263 throw new ServerException(sprintf(
1264 // TRANS: Server exception. %s is a URI.
1265 _m('Tried to update avatar for unsaved remote profile %s.'),
1269 // @todo FIXME: This should be better encapsulated
1270 // ripped from oauthstore.php (for old OMB client)
1271 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
1273 $client = new HTTPClient();
1274 $response = $client->get($url);
1276 if (!$response->isOk()) {
1277 // TRANS: Server exception. %s is a URL.
1278 throw new ServerException(sprintf(_m('Unable to fetch avatar from %s.'), $url));
1280 // FIXME: make sure it's an image here instead of _after_ writing to a file?
1281 file_put_contents($temp_filename, $response->getBody());
1283 if ($this->isGroup()) {
1284 $id = $this->group_id;
1286 $id = $this->profile_id;
1288 // @todo FIXME: Should we be using different ids?
1289 $imagefile = new ImageFile($id, $temp_filename);
1290 $filename = Avatar::filename($id,
1291 image_type_to_extension($imagefile->type),
1293 common_timestamp());
1294 rename($temp_filename, Avatar::path($filename));
1295 } catch (Exception $e) {
1296 unlink($temp_filename);
1299 // @todo FIXME: Hardcoded chmod is lame, but seems to be necessary to
1300 // keep from accidentally saving images from command-line (queues)
1301 // that can't be read from web server, which causes hard-to-notice
1302 // problems later on:
1304 // http://status.net/open-source/issues/2663
1305 chmod(Avatar::path($filename), 0644);
1307 $self->setOriginal($filename);
1309 $orig = clone($this);
1310 $this->avatar = $url;
1311 $this->update($orig);
1313 return Avatar::getUploaded($self);
1317 * Pull avatar URL from ActivityObject or profile hints
1319 * @param ActivityObject $object
1320 * @param array $hints
1321 * @return mixed URL string or false
1323 public static function getActivityObjectAvatar(ActivityObject $object, array $hints=array())
1325 if ($object->avatarLinks) {
1327 // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
1328 foreach ($object->avatarLinks as $avatar) {
1329 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
1334 if (!$best || $avatar->width > $best->width) {
1339 } else if (array_key_exists('avatar', $hints)) {
1340 return $hints['avatar'];
1346 * Get an appropriate avatar image source URL, if available.
1348 * @param ActivityObject $actor
1349 * @param DOMElement $feed
1352 protected static function getAvatar(ActivityObject $actor, DOMElement $feed)
1356 if ($actor->avatar) {
1357 $url = trim($actor->avatar);
1360 // Check <atom:logo> and <atom:icon> on the feed
1361 $els = $feed->childNodes();
1362 if ($els && $els->length) {
1363 for ($i = 0; $i < $els->length; $i++) {
1364 $el = $els->item($i);
1365 if ($el->namespaceURI == Activity::ATOM) {
1366 if (empty($url) && $el->localName == 'logo') {
1367 $url = trim($el->textContent);
1370 if (empty($icon) && $el->localName == 'icon') {
1371 // Use as a fallback
1372 $icon = trim($el->textContent);
1377 if ($icon && !$url) {
1382 $opts = array('allowed_schemes' => array('http', 'https'));
1383 if (common_valid_http_url($url)) {
1388 return Plugin::staticPath('OStatus', 'images/96px-Feed-icon.svg.png');
1392 * Fetch, or build if necessary, an Ostatus_profile for the actor
1393 * in a given Activity Streams activity.
1394 * This should never return null -- you will either get an object or
1395 * an exception will be thrown.
1397 * @param Activity $activity
1398 * @param string $feeduri if we already know the canonical feed URI!
1399 * @param string $salmonuri if we already know the salmon return channel URI
1400 * @return Ostatus_profile
1403 public static function ensureActorProfile(Activity $activity, array $hints=array())
1405 return self::ensureActivityObjectProfile($activity->actor, $hints);
1409 * Fetch, or build if necessary, an Ostatus_profile for the profile
1410 * in a given Activity Streams object (can be subject, actor, or object).
1411 * This should never return null -- you will either get an object or
1412 * an exception will be thrown.
1414 * @param ActivityObject $object
1415 * @param array $hints additional discovery information passed from higher levels
1416 * @return Ostatus_profile
1419 public static function ensureActivityObjectProfile(ActivityObject $object, array $hints=array())
1421 $profile = self::getActivityObjectProfile($object);
1422 if ($profile instanceof Ostatus_profile) {
1423 $profile->updateFromActivityObject($object, $hints);
1425 $profile = self::createActivityObjectProfile($object, $hints);
1431 * @param Activity $activity
1432 * @return mixed matching Ostatus_profile or false if none known
1433 * @throws ServerException if feed info invalid
1435 public static function getActorProfile(Activity $activity)
1437 return self::getActivityObjectProfile($activity->actor);
1441 * @param ActivityObject $activity
1442 * @return mixed matching Ostatus_profile or false if none known
1443 * @throws ServerException if feed info invalid
1445 protected static function getActivityObjectProfile(ActivityObject $object)
1447 $uri = self::getActivityObjectProfileURI($object);
1448 return Ostatus_profile::getKV('uri', $uri);
1452 * Get the identifier URI for the remote entity described
1453 * by this ActivityObject. This URI is *not* guaranteed to be
1454 * a resolvable HTTP/HTTPS URL.
1456 * @param ActivityObject $object
1458 * @throws ServerException if feed info invalid
1460 protected static function getActivityObjectProfileURI(ActivityObject $object)
1463 if (ActivityUtils::validateUri($object->id)) {
1468 // If the id is missing or invalid (we've seen feeds mistakenly listing
1469 // things like local usernames in that field) then we'll use the profile
1470 // page link, if valid.
1471 if ($object->link && common_valid_http_url($object->link)) {
1472 return $object->link;
1474 // TRANS: Server exception.
1475 throw new ServerException(_m('No author ID URI found.'));
1479 * @todo FIXME: Validate stuff somewhere.
1483 * Create local ostatus_profile and profile/user_group entries for
1484 * the provided remote user or group.
1485 * This should never return null -- you will either get an object or
1486 * an exception will be thrown.
1488 * @param ActivityObject $object
1489 * @param array $hints
1491 * @return Ostatus_profile
1493 protected static function createActivityObjectProfile(ActivityObject $object, array $hints=array())
1495 $homeuri = $object->id;
1499 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1500 // TRANS: Exception.
1501 throw new Exception(_m('No profile URI.'));
1504 $user = User::getKV('uri', $homeuri);
1505 if ($user instanceof User) {
1506 // TRANS: Exception.
1507 throw new Exception(_m('Local user cannot be referenced as remote.'));
1510 if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1511 // TRANS: Exception.
1512 throw new Exception(_m('Local group cannot be referenced as remote.'));
1515 $ptag = Profile_list::getKV('uri', $homeuri);
1516 if ($ptag instanceof Profile_list) {
1517 $local_user = User::getKV('id', $ptag->tagger);
1518 if ($local_user instanceof User) {
1519 // TRANS: Exception.
1520 throw new Exception(_m('Local list cannot be referenced as remote.'));
1524 if (array_key_exists('feedurl', $hints)) {
1525 $feeduri = $hints['feedurl'];
1527 $discover = new FeedDiscovery();
1528 $feeduri = $discover->discoverFromURL($homeuri);
1531 if (array_key_exists('salmon', $hints)) {
1532 $salmonuri = $hints['salmon'];
1535 $discover = new FeedDiscovery();
1536 $discover->discoverFromFeedURL($hints['feedurl']);
1538 // XXX: NS_REPLIES is deprecated anyway, so let's remove it in the future.
1539 $salmonuri = $discover->getAtomLink(Salmon::REL_SALMON)
1540 ?: $discover->getAtomLink(Salmon::NS_REPLIES);
1543 if (array_key_exists('hub', $hints)) {
1544 $huburi = $hints['hub'];
1547 $discover = new FeedDiscovery();
1548 $discover->discoverFromFeedURL($hints['feedurl']);
1550 $huburi = $discover->getHubLink();
1553 if (!$huburi && !common_config('feedsub', 'fallback_hub') && !common_config('feedsub', 'nohub')) {
1554 // We can only deal with folks with a PuSH hub
1555 throw new FeedSubNoHubException();
1558 $oprofile = new Ostatus_profile();
1560 $oprofile->uri = $homeuri;
1561 $oprofile->feeduri = $feeduri;
1562 $oprofile->salmonuri = $salmonuri;
1564 $oprofile->created = common_sql_now();
1565 $oprofile->modified = common_sql_now();
1567 if ($object->type == ActivityObject::PERSON) {
1568 $profile = new Profile();
1569 $profile->created = common_sql_now();
1570 self::updateProfile($profile, $object, $hints);
1572 $oprofile->profile_id = $profile->insert();
1573 if ($oprofile->profile_id === false) {
1574 // TRANS: Server exception.
1575 throw new ServerException(_m('Cannot save local profile.'));
1577 } else if ($object->type == ActivityObject::GROUP) {
1578 $profile = new Profile();
1579 $profile->query('BEGIN');
1581 $group = new User_group();
1582 $group->uri = $homeuri;
1583 $group->created = common_sql_now();
1584 self::updateGroup($group, $object, $hints);
1586 // TODO: We should do this directly in User_group->insert()!
1587 // currently it's duplicated in User_group->update()
1588 // AND User_group->register()!!!
1589 $fields = array(/*group field => profile field*/
1590 'nickname' => 'nickname',
1591 'fullname' => 'fullname',
1592 'mainpage' => 'profileurl',
1593 'homepage' => 'homepage',
1594 'description' => 'bio',
1595 'location' => 'location',
1596 'created' => 'created',
1597 'modified' => 'modified',
1599 foreach ($fields as $gf=>$pf) {
1600 $profile->$pf = $group->$gf;
1602 $profile_id = $profile->insert();
1603 if ($profile_id === false) {
1604 $profile->query('ROLLBACK');
1605 throw new ServerException(_('Profile insertion failed.'));
1608 $group->profile_id = $profile_id;
1610 $oprofile->group_id = $group->insert();
1611 if ($oprofile->group_id === false) {
1612 $profile->query('ROLLBACK');
1613 // TRANS: Server exception.
1614 throw new ServerException(_m('Cannot save local profile.'));
1617 $profile->query('COMMIT');
1618 } else if ($object->type == ActivityObject::_LIST) {
1619 $ptag = new Profile_list();
1620 $ptag->uri = $homeuri;
1621 $ptag->created = common_sql_now();
1622 self::updatePeopletag($ptag, $object, $hints);
1624 $oprofile->peopletag_id = $ptag->insert();
1625 if ($oprofile->peopletag_id === false) {
1626 // TRANS: Server exception.
1627 throw new ServerException(_m('Cannot save local list.'));
1631 $ok = $oprofile->insert();
1633 if ($ok === false) {
1634 // TRANS: Server exception.
1635 throw new ServerException(_m('Cannot save OStatus profile.'));
1638 $avatar = self::getActivityObjectAvatar($object, $hints);
1642 $oprofile->updateAvatar($avatar);
1643 } catch (Exception $ex) {
1644 // Profile is saved, but Avatar is messed up. We're
1645 // just going to continue.
1646 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: ". $ex->getMessage());
1654 * Save any updated profile information to our local copy.
1655 * @param ActivityObject $object
1656 * @param array $hints
1658 public function updateFromActivityObject(ActivityObject $object, array $hints=array())
1660 if ($this->isGroup()) {
1661 $group = $this->localGroup();
1662 self::updateGroup($group, $object, $hints);
1663 } else if ($this->isPeopletag()) {
1664 $ptag = $this->localPeopletag();
1665 self::updatePeopletag($ptag, $object, $hints);
1667 $profile = $this->localProfile();
1668 self::updateProfile($profile, $object, $hints);
1671 $avatar = self::getActivityObjectAvatar($object, $hints);
1672 if ($avatar && !isset($ptag)) {
1674 $this->updateAvatar($avatar);
1675 } catch (Exception $ex) {
1676 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: " . $ex->getMessage());
1681 public static function updateProfile(Profile $profile, ActivityObject $object, array $hints=array())
1683 $orig = clone($profile);
1685 // Existing nickname is better than nothing.
1687 if (!array_key_exists('nickname', $hints)) {
1688 $hints['nickname'] = $profile->nickname;
1691 $nickname = self::getActivityObjectNickname($object, $hints);
1693 if (!empty($nickname)) {
1694 $profile->nickname = $nickname;
1697 if (!empty($object->title)) {
1698 $profile->fullname = $object->title;
1699 } else if (array_key_exists('fullname', $hints)) {
1700 $profile->fullname = $hints['fullname'];
1703 if (!empty($object->link)) {
1704 $profile->profileurl = $object->link;
1705 } else if (array_key_exists('profileurl', $hints)) {
1706 $profile->profileurl = $hints['profileurl'];
1707 } else if (common_valid_http_url($object->id)) {
1708 $profile->profileurl = $object->id;
1711 $bio = self::getActivityObjectBio($object, $hints);
1714 $profile->bio = $bio;
1717 $location = self::getActivityObjectLocation($object, $hints);
1719 if (!empty($location)) {
1720 $profile->location = $location;
1723 $homepage = self::getActivityObjectHomepage($object, $hints);
1725 if (!empty($homepage)) {
1726 $profile->homepage = $homepage;
1729 if (!empty($object->geopoint)) {
1730 $location = ActivityContext::locationFromPoint($object->geopoint);
1731 if (!empty($location)) {
1732 $profile->lat = $location->lat;
1733 $profile->lon = $location->lon;
1737 // @todo FIXME: tags/categories
1738 // @todo tags from categories
1741 common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1742 $profile->update($orig);
1746 protected static function updateGroup(User_group $group, ActivityObject $object, array $hints=array())
1748 $orig = clone($group);
1750 $group->nickname = self::getActivityObjectNickname($object, $hints);
1751 $group->fullname = $object->title;
1753 if (!empty($object->link)) {
1754 $group->mainpage = $object->link;
1755 } else if (array_key_exists('profileurl', $hints)) {
1756 $group->mainpage = $hints['profileurl'];
1759 // @todo tags from categories
1760 $group->description = self::getActivityObjectBio($object, $hints);
1761 $group->location = self::getActivityObjectLocation($object, $hints);
1762 $group->homepage = self::getActivityObjectHomepage($object, $hints);
1764 if ($group->id) { // If no id, we haven't called insert() yet, so don't run update()
1765 common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1766 $group->update($orig);
1770 protected static function updatePeopletag($tag, ActivityObject $object, array $hints=array()) {
1771 $orig = clone($tag);
1773 $tag->tag = $object->title;
1775 if (!empty($object->link)) {
1776 $tag->mainpage = $object->link;
1777 } else if (array_key_exists('profileurl', $hints)) {
1778 $tag->mainpage = $hints['profileurl'];
1781 $tag->description = $object->summary;
1782 $tagger = self::ensureActivityObjectProfile($object->owner);
1783 $tag->tagger = $tagger->profile_id;
1786 common_log(LOG_DEBUG, "Updating OStatus peopletag $tag->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1787 $tag->update($orig);
1791 protected static function getActivityObjectHomepage(ActivityObject $object, array $hints=array())
1794 $poco = $object->poco;
1796 if (!empty($poco)) {
1797 $url = $poco->getPrimaryURL();
1798 if ($url && $url->type == 'homepage') {
1799 $homepage = $url->value;
1803 // @todo Try for a another PoCo URL?
1808 protected static function getActivityObjectLocation(ActivityObject $object, array $hints=array())
1812 if (!empty($object->poco) &&
1813 isset($object->poco->address->formatted)) {
1814 $location = $object->poco->address->formatted;
1815 } else if (array_key_exists('location', $hints)) {
1816 $location = $hints['location'];
1819 if (!empty($location)) {
1820 if (mb_strlen($location) > 255) {
1821 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1825 // @todo Try to find location some othe way? Via goerss point?
1830 protected static function getActivityObjectBio(ActivityObject $object, array $hints=array())
1834 if (!empty($object->poco)) {
1835 $note = $object->poco->note;
1836 } else if (array_key_exists('bio', $hints)) {
1837 $note = $hints['bio'];
1840 if (!empty($note)) {
1841 if (Profile::bioTooLong($note)) {
1842 // XXX: truncate ok?
1843 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1849 // @todo Try to get bio info some other way?
1854 public static function getActivityObjectNickname(ActivityObject $object, array $hints=array())
1856 if ($object->poco) {
1857 if (!empty($object->poco->preferredUsername)) {
1858 return common_nicknamize($object->poco->preferredUsername);
1862 if (!empty($object->nickname)) {
1863 return common_nicknamize($object->nickname);
1866 if (array_key_exists('nickname', $hints)) {
1867 return $hints['nickname'];
1870 // Try the profile url (like foo.example.com or example.com/user/foo)
1871 if (!empty($object->link)) {
1872 $profileUrl = $object->link;
1873 } else if (!empty($hints['profileurl'])) {
1874 $profileUrl = $hints['profileurl'];
1877 if (!empty($profileUrl)) {
1878 $nickname = self::nicknameFromURI($profileUrl);
1881 // Try the URI (may be a tag:, http:, acct:, ...
1883 if (empty($nickname)) {
1884 $nickname = self::nicknameFromURI($object->id);
1887 // Try a Webfinger if one was passed (way) down
1889 if (empty($nickname)) {
1890 if (array_key_exists('webfinger', $hints)) {
1891 $nickname = self::nicknameFromURI($hints['webfinger']);
1897 if (empty($nickname)) {
1898 $nickname = common_nicknamize($object->title);
1904 protected static function nicknameFromURI($uri)
1906 if (preg_match('/(\w+):/', $uri, $matches)) {
1907 $protocol = $matches[1];
1912 switch ($protocol) {
1915 if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1916 return common_canonical_nickname($matches[1]);
1920 return common_url_to_nickname($uri);
1928 * Look up, and if necessary create, an Ostatus_profile for the remote
1929 * entity with the given webfinger address.
1930 * This should never return null -- you will either get an object or
1931 * an exception will be thrown.
1933 * @param string $addr webfinger address
1934 * @return Ostatus_profile
1935 * @throws Exception on error conditions
1936 * @throws OStatusShadowException if this reference would obscure a local user/group
1938 public static function ensureWebfinger($addr)
1940 // First, try the cache
1942 $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1944 if ($uri !== false) {
1945 if (is_null($uri)) {
1946 // Negative cache entry
1947 // TRANS: Exception.
1948 throw new Exception(_m('Not a valid webfinger address.'));
1950 $oprofile = Ostatus_profile::getKV('uri', $uri);
1951 if ($oprofile instanceof Ostatus_profile) {
1956 // Try looking it up
1957 $oprofile = Ostatus_profile::getKV('uri', Discovery::normalize($addr));
1959 if ($oprofile instanceof Ostatus_profile) {
1960 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
1964 // Now, try some discovery
1966 $disco = new Discovery();
1969 $xrd = $disco->lookup($addr);
1970 } catch (Exception $e) {
1971 // Save negative cache entry so we don't waste time looking it up again.
1972 // @todo FIXME: Distinguish temporary failures?
1973 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1974 // TRANS: Exception.
1975 throw new Exception(_m('Not a valid webfinger address.'));
1978 $hints = array('webfinger' => $addr);
1980 $dhints = DiscoveryHints::fromXRD($xrd);
1982 $hints = array_merge($hints, $dhints);
1984 // If there's an Hcard, let's grab its info
1985 if (array_key_exists('hcard', $hints)) {
1986 if (!array_key_exists('profileurl', $hints) ||
1987 $hints['hcard'] != $hints['profileurl']) {
1988 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1989 $hints = array_merge($hcardHints, $hints);
1993 // If we got a feed URL, try that
1995 if (array_key_exists('feedurl', $hints)) {
1996 $feedUrl = $hints['feedurl'];
1998 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1999 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
2000 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
2002 } catch (Exception $e) {
2003 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
2008 // If we got a profile page, try that!
2010 if (array_key_exists('profileurl', $hints)) {
2011 $profileUrl = $hints['profileurl'];
2013 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
2014 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
2015 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
2017 } catch (OStatusShadowException $e) {
2018 // We've ended up with a remote reference to a local user or group.
2019 // @todo FIXME: Ideally we should be able to say who it was so we can
2020 // go back and refer to it the regular way
2022 } catch (Exception $e) {
2023 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
2026 // @todo FIXME: This means an error discovering from profile page
2027 // may give us a corrupt entry using the webfinger URI, which
2028 // will obscure the correct page-keyed profile later on.
2035 if (array_key_exists('salmon', $hints)) {
2036 $salmonEndpoint = $hints['salmon'];
2038 // An account URL, a salmon endpoint, and a dream? Not much to go
2039 // on, but let's give it a try
2041 $uri = 'acct:'.$addr;
2043 $profile = new Profile();
2045 $profile->nickname = self::nicknameFromUri($uri);
2046 $profile->created = common_sql_now();
2048 if (!is_null($profileUrl)) {
2049 $profile->profileurl = $profileUrl;
2052 $profile_id = $profile->insert();
2054 if ($profile_id === false) {
2055 common_log_db_error($profile, 'INSERT', __FILE__);
2056 // TRANS: Exception. %s is a webfinger address.
2057 throw new Exception(sprintf(_m('Could not save profile for "%s".'),$addr));
2060 $oprofile = new Ostatus_profile();
2062 $oprofile->uri = $uri;
2063 $oprofile->salmonuri = $salmonEndpoint;
2064 $oprofile->profile_id = $profile_id;
2065 $oprofile->created = common_sql_now();
2067 if (!is_null($feedUrl)) {
2068 $oprofile->feeduri = $feedUrl;
2071 $result = $oprofile->insert();
2073 if ($result === false) {
2075 common_log_db_error($oprofile, 'INSERT', __FILE__);
2076 // TRANS: Exception. %s is a webfinger address.
2077 throw new Exception(sprintf(_m('Could not save OStatus profile for "%s".'),$addr));
2080 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->getUri());
2084 // TRANS: Exception. %s is a webfinger address.
2085 throw new Exception(sprintf(_m('Could not find a valid profile for "%s".'),$addr));
2089 * Store the full-length scrubbed HTML of a remote notice to an attachment
2090 * file on our server. We'll link to this at the end of the cropped version.
2092 * @param string $title plaintext for HTML page's title
2093 * @param string $rendered HTML fragment for HTML page's body
2096 function saveHTMLFile($title, $rendered)
2098 $final = sprintf("<!DOCTYPE html>\n" .
2100 '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">' .
2101 '<title>%s</title>' .
2103 '<body>%s</body></html>',
2104 htmlspecialchars($title),
2107 $filename = File::filename($this->localProfile(),
2108 'ostatus', // ignored?
2111 $filepath = File::path($filename);
2113 file_put_contents($filepath, $final);
2117 $file->filename = $filename;
2118 $file->url = File::url($filename);
2119 $file->size = filesize($filepath);
2120 $file->date = time();
2121 $file->mimetype = 'text/html';
2123 $file_id = $file->insert();
2125 if ($file_id === false) {
2126 common_log_db_error($file, "INSERT", __FILE__);
2127 // TRANS: Server exception.
2128 throw new ServerException(_m('Could not store HTML content of long post as file.'));
2134 static function ensureProfileURI($uri)
2138 // First, try to query it
2140 $oprofile = Ostatus_profile::getKV('uri', $uri);
2142 if ($oprofile instanceof Ostatus_profile) {
2146 // If unfound, do discovery stuff
2147 if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
2148 $protocol = $match[1];
2149 switch ($protocol) {
2152 $oprofile = self::ensureProfileURL($uri);
2157 $oprofile = self::ensureWebfinger($rest);
2160 // TRANS: Server exception.
2161 // TRANS: %1$s is a protocol, %2$s is a URI.
2162 throw new ServerException(sprintf(_m('Unrecognized URI protocol for profile: %1$s (%2$s).'),
2168 // TRANS: Server exception. %s is a URI.
2169 throw new ServerException(sprintf(_m('No URI protocol for profile: %s.'),$uri));
2175 public function checkAuthorship(Activity $activity)
2177 if ($this->isGroup() || $this->isPeopletag()) {
2178 // A group or propletag feed will contain posts from multiple authors.
2179 $oprofile = self::ensureActorProfile($activity);
2180 if ($oprofile->isGroup() || $oprofile->isPeopletag()) {
2181 // Groups can't post notices in StatusNet.
2182 common_log(LOG_WARNING,
2183 "OStatus: skipping post with group listed ".
2184 "as author: " . $oprofile->getUri() . " in feed from " . $this->getUri());
2185 throw new ServerException('Activity author is a non-actor');
2188 $actor = $activity->actor;
2190 if (empty($actor)) {
2191 // OK here! assume the default
2192 } else if ($actor->id == $this->getUri() || $actor->link == $this->getUri()) {
2193 $this->updateFromActivityObject($actor);
2194 } else if ($actor->id) {
2195 // We have an ActivityStreams actor with an explicit ID that doesn't match the feed owner.
2196 // This isn't what we expect from mainline OStatus person feeds!
2197 // Group feeds go down another path, with different validation...
2198 // Most likely this is a plain ol' blog feed of some kind which
2199 // doesn't match our expectations. We'll take the entry, but ignore
2200 // the <author> info.
2201 common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for " . $this->getUri());
2203 // Plain <author> without ActivityStreams actor info.
2204 // We'll just ignore this info for now and save the update under the feed's identity.
2210 return $oprofile->localProfile();
2215 * Exception indicating we've got a remote reference to a local user,
2216 * not a remote user!
2218 * If we can ue a local profile after all, it's available as $e->profile.
2220 class OStatusShadowException extends Exception
2225 * @param Profile $profile
2226 * @param string $message
2228 function __construct($profile, $message) {
2229 $this->profile = $profile;
2230 parent::__construct($message);