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 * Subscribe a local user to this remote user.
199 * PuSH subscription will be started if necessary, and we'll
200 * send a Salmon notification to the remote server if available
201 * notifying them of the sub.
204 * @return boolean success
205 * @throws FeedException
207 public function subscribeLocalToRemote(User $user)
209 if ($this->isGroup()) {
210 throw new ServerException("Can't subscribe to a remote group");
213 if ($this->subscribe()) {
214 if ($user->subscribeTo($this->localProfile())) {
215 $this->notify($user->getProfile(), ActivityVerb::FOLLOW, $this);
223 * Mark this remote profile as subscribing to the given local user,
224 * and send appropriate notifications to the user.
226 * This will generally be in response to a subscription notification
227 * from a foreign site to our local Salmon response channel.
230 * @return boolean success
232 public function subscribeRemoteToLocal(User $user)
234 if ($this->isGroup()) {
235 throw new ServerException("Remote groups can't subscribe to local users");
238 Subscription::start($this->localProfile(), $user->getProfile());
244 * Send a subscription request to the hub for this feed.
245 * The hub will later send us a confirmation POST to /main/push/callback.
247 * @return bool true on success, false on failure
248 * @throws ServerException if feed state is not valid
250 public function subscribe()
252 $feedsub = FeedSub::ensureFeed($this->feeduri);
253 if ($feedsub->sub_state == 'active' || $feedsub->sub_state == 'subscribe') {
255 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
256 return $feedsub->subscribe();
257 } else if ('unsubscribe') {
258 throw new FeedSubException("Unsub is pending, can't subscribe...");
263 * Send a PuSH unsubscription request to the hub for this feed.
264 * The hub will later send us a confirmation POST to /main/push/callback.
266 * @return bool true on success, false on failure
267 * @throws ServerException if feed state is not valid
269 public function unsubscribe() {
270 $feedsub = FeedSub::staticGet('uri', $this->feeduri);
274 if ($feedsub->sub_state == 'active') {
275 return $feedsub->unsubscribe();
276 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive' || $feedsub->sub_state == 'unsubscribe') {
278 } else if ($feedsub->sub_state == 'subscribe') {
279 throw new FeedSubException("Feed is awaiting subscription, can't unsub...");
284 * Check if this remote profile has any active local subscriptions, and
285 * if not drop the PuSH subscription feed.
289 public function garbageCollect()
291 if ($this->isGroup()) {
292 $members = $this->localGroup()->getMembers(0, 1);
293 $count = $members->N;
295 $count = $this->localProfile()->subscriberCount();
298 common_log(LOG_INFO, "Unsubscribing from now-unused remote feed $this->feeduri");
299 $this->unsubscribe();
307 * Send an Activity Streams notification to the remote Salmon endpoint,
310 * @param Profile $actor Actor who did the activity
311 * @param string $verb Activity::SUBSCRIBE or Activity::JOIN
312 * @param Object $object object of the action; must define asActivityNoun($tag)
314 public function notify($actor, $verb, $object=null)
316 if (!($actor instanceof Profile)) {
317 $type = gettype($actor);
318 if ($type == 'object') {
319 $type = get_class($actor);
321 throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
323 if ($object == null) {
326 if ($this->salmonuri) {
329 $id = TagURI::mint('%s:%s:%s',
332 common_date_iso8601(time()));
334 // @fixme consolidate all these NS settings somewhere
335 $attributes = array('xmlns' => Activity::ATOM,
336 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
337 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
338 'xmlns:georss' => 'http://www.georss.org/georss',
339 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
340 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
341 'xmlns:media' => 'http://purl.org/syndication/atommedia');
343 $entry = new XMLStringer();
344 $entry->elementStart('entry', $attributes);
345 $entry->element('id', null, $id);
346 $entry->element('title', null, $text);
347 $entry->element('summary', null, $text);
348 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
350 $entry->element('activity:verb', null, $verb);
351 $entry->raw($actor->asAtomAuthor());
352 $entry->raw($actor->asActivityActor());
353 $entry->raw($object->asActivityNoun('object'));
354 $entry->elementEnd('entry');
356 $xml = $entry->getString();
357 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
359 $salmon = new Salmon(); // ?
360 return $salmon->post($this->salmonuri, $xml, $actor);
366 * Send a Salmon notification ping immediately, and confirm that we got
367 * an acceptable response from the remote site.
369 * @param mixed $entry XML string, Notice, or Activity
370 * @return boolean success
372 public function notifyActivity($entry, $actor)
374 if ($this->salmonuri) {
375 $salmon = new Salmon();
376 return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
383 * Queue a Salmon notification for later. If queues are disabled we'll
384 * send immediately but won't get the return value.
386 * @param mixed $entry XML string, Notice, or Activity
387 * @return boolean success
389 public function notifyDeferred($entry, $actor)
391 if ($this->salmonuri) {
392 $data = array('salmonuri' => $this->salmonuri,
393 'entry' => $this->notifyPrepXml($entry),
394 'actor' => $actor->id);
396 $qm = QueueManager::get();
397 return $qm->enqueue($data, 'salmon');
403 protected function notifyPrepXml($entry)
405 $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
406 if (is_string($entry)) {
408 } else if ($entry instanceof Activity) {
409 return $preamble . $entry->asString(true);
410 } else if ($entry instanceof Notice) {
411 return $preamble . $entry->asAtomEntry(true, true);
413 throw new ServerException("Invalid type passed to Ostatus_profile::notify; must be XML string or Activity entry");
417 function getBestName()
419 if ($this->isGroup()) {
420 return $this->localGroup()->getBestName();
422 return $this->localProfile()->getBestName();
427 * Read and post notices for updates from the feed.
428 * Currently assumes that all items in the feed are new,
429 * coming from a PuSH hub.
431 * @param DOMDocument $feed
433 public function processFeed($feed, $source)
435 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
436 if ($entries->length == 0) {
437 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
441 for ($i = 0; $i < $entries->length; $i++) {
442 $entry = $entries->item($i);
443 $this->processEntry($entry, $feed, $source);
448 * Process a posted entry from this feed source.
450 * @param DOMElement $entry
451 * @param DOMElement $feed for context
453 public function processEntry($entry, $feed, $source)
455 $activity = new Activity($entry, $feed);
457 if ($activity->verb == ActivityVerb::POST) {
458 $this->processPost($activity, $source);
460 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
465 * Process an incoming post activity from this remote feed.
466 * @param Activity $activity
467 * @param string $method 'push' or 'salmon'
468 * @return mixed saved Notice or false
469 * @fixme break up this function, it's getting nasty long
471 public function processPost($activity, $method)
473 if ($this->isGroup()) {
474 // A group feed will contain posts from multiple authors.
475 // @fixme validate these profiles in some way!
476 $oprofile = self::ensureActorProfile($activity);
477 if ($oprofile->isGroup()) {
478 // Groups can't post notices in StatusNet.
479 common_log(LOG_WARNING, "OStatus: skipping post with group listed as author: $oprofile->uri in feed from $this->uri");
483 // Individual user feeds may contain only posts from themselves.
484 // Authorship is validated against the profile URI on upper layers,
485 // through PuSH setup or Salmon signature checks.
486 $actorUri = self::getActorProfileURI($activity);
487 if ($actorUri == $this->uri) {
488 // Check if profile info has changed and update it
489 $this->updateFromActivityObject($activity->actor);
491 common_log(LOG_WARNING, "OStatus: skipping post with bad author: got $actorUri expected $this->uri");
497 // The id URI will be used as a unique identifier for for the notice,
498 // protecting against duplicate saves. It isn't required to be a URL;
499 // tag: URIs for instance are found in Google Buzz feeds.
500 $sourceUri = $activity->object->id;
501 $dupe = Notice::staticGet('uri', $sourceUri);
503 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
507 // We'll also want to save a web link to the original notice, if provided.
509 if ($activity->object->link) {
510 $sourceUrl = $activity->object->link;
511 } else if ($activity->link) {
512 $sourceUrl = $activity->link;
513 } else if (preg_match('!^https?://!', $activity->object->id)) {
514 $sourceUrl = $activity->object->id;
517 // Get (safe!) HTML and text versions of the content
518 $rendered = $this->purify($activity->object->content);
519 $content = html_entity_decode(strip_tags($rendered));
521 $shortened = common_shorten_links($content);
523 // If it's too long, try using the summary, and make the
524 // HTML an attachment.
528 if (Notice::contentTooLong($shortened)) {
529 $attachment = $this->saveHTMLFile($activity->object->title, $rendered);
530 $summary = $activity->object->summary;
531 if (empty($summary)) {
534 $shortSummary = common_shorten_links($summary);
535 if (Notice::contentTooLong($shortSummary)) {
536 $url = common_shorten_url(common_local_url('attachment',
537 array('attachment' => $attachment->id)));
538 $shortSummary = substr($shortSummary,
540 Notice::maxContent() - (mb_strlen($url) + 2));
541 $shortSummary .= '… ' . $url;
542 $content = $shortSummary;
543 $rendered = common_render_text($content);
547 $options = array('is_local' => Notice::REMOTE_OMB,
550 'rendered' => $rendered,
551 'replies' => array(),
556 // Check for optional attributes...
558 if (!empty($activity->time)) {
559 $options['created'] = common_sql_date($activity->time);
562 if ($activity->context) {
563 // Any individual or group attn: targets?
564 $replies = $activity->context->attention;
565 $options['groups'] = $this->filterReplies($oprofile, $replies);
566 $options['replies'] = $replies;
568 // Maintain direct reply associations
569 // @fixme what about conversation ID?
570 if (!empty($activity->context->replyToID)) {
571 $orig = Notice::staticGet('uri',
572 $activity->context->replyToID);
574 $options['reply_to'] = $orig->id;
578 $location = $activity->context->location;
580 $options['lat'] = $location->lat;
581 $options['lon'] = $location->lon;
582 if ($location->location_id) {
583 $options['location_ns'] = $location->location_ns;
584 $options['location_id'] = $location->location_id;
589 // Atom categories <-> hashtags
590 foreach ($activity->categories as $cat) {
592 $term = common_canonical_tag($cat->term);
594 $options['tags'][] = $term;
599 // Atom enclosures -> attachment URLs
600 foreach ($activity->enclosures as $href) {
601 // @fixme save these locally or....?
602 $options['urls'][] = $href;
606 $saved = Notice::saveNew($oprofile->profile_id,
611 Ostatus_source::saveNew($saved, $this, $method);
612 if (!empty($attachment)) {
613 File_to_post::processNew($attachment->id, $saved->id);
616 } catch (Exception $e) {
617 common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
620 common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
627 protected function purify($html)
629 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
630 $config = array('safe' => 1,
631 'deny_attribute' => 'id,style,on*');
632 return htmLawed($html, $config);
636 * Filters a list of recipient ID URIs to just those for local delivery.
637 * @param Ostatus_profile local profile of sender
638 * @param array in/out &$attention_uris set of URIs, will be pruned on output
639 * @return array of group IDs
641 protected function filterReplies($sender, &$attention_uris)
643 common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
646 foreach ($attention_uris as $recipient) {
647 // Is the recipient a local user?
648 $user = User::staticGet('uri', $recipient);
650 // @fixme sender verification, spam etc?
651 $replies[] = $recipient;
655 // Is the recipient a remote group?
656 $oprofile = Ostatus_profile::staticGet('uri', $recipient);
658 if ($oprofile->isGroup()) {
659 // Deliver to local members of this remote group.
660 // @fixme sender verification?
661 $groups[] = $oprofile->group_id;
663 common_log(LOG_DEBUG, "Skipping reply to remote profile $recipient");
668 // Is the recipient a local group?
669 // @fixme we need a uri on user_group
670 // $group = User_group::staticGet('uri', $recipient);
671 $template = common_local_url('groupbyid', array('id' => '31337'));
672 $template = preg_quote($template, '/');
673 $template = str_replace('31337', '(\d+)', $template);
674 if (preg_match("/$template/", $recipient, $matches)) {
676 $group = User_group::staticGet('id', $id);
678 // Deliver to all members of this local group if allowed.
679 $profile = $sender->localProfile();
680 if ($profile->isMember($group)) {
681 $groups[] = $group->id;
683 common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
687 common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
691 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient");
694 $attention_uris = $replies;
695 common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
696 common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
701 * @param string $profile_url
702 * @return Ostatus_profile
703 * @throws FeedSubException
705 public static function ensureProfile($profile_uri, $hints=array())
707 // Get the canonical feed URI and check it
708 $discover = new FeedDiscovery();
709 if (isset($hints['feedurl'])) {
710 $feeduri = $hints['feedurl'];
711 $feeduri = $discover->discoverFromFeedURL($feeduri);
713 $feeduri = $discover->discoverFromURL($profile_uri);
714 $hints['feedurl'] = $feeduri;
717 $huburi = $discover->getAtomLink('hub');
718 $hints['hub'] = $huburi;
719 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
720 $hints['salmon'] = $salmonuri;
723 // We can only deal with folks with a PuSH hub
724 throw new FeedSubNoHubException();
727 // Try to get a profile from the feed activity:subject
729 $feedEl = $discover->feed->documentElement;
731 $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
733 if (!empty($subject)) {
734 $subjObject = new ActivityObject($subject);
735 return self::ensureActivityObjectProfile($subjObject, $hints);
738 // Otherwise, try the feed author
740 $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
742 if (!empty($author)) {
743 $authorObject = new ActivityObject($author);
744 return self::ensureActivityObjectProfile($authorObject, $hints);
747 // Sheesh. Not a very nice feed! Let's try fingerpoken in the
750 $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
752 if (!empty($entries) && $entries->length > 0) {
754 $entry = $entries->item(0);
756 $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
758 if (!empty($actor)) {
759 $actorObject = new ActivityObject($actor);
760 return self::ensureActivityObjectProfile($actorObject, $hints);
764 $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
766 if (!empty($author)) {
767 $authorObject = new ActivityObject($author);
768 return self::ensureActivityObjectProfile($authorObject, $hints);
772 // XXX: make some educated guesses here
774 throw new FeedSubException("Can't find enough profile information to make a feed.");
779 * Download and update given avatar image
781 * @throws Exception in various failure cases
783 protected function updateAvatar($url)
785 if ($url == $this->avatar) {
786 // We've already got this one.
790 if ($this->isGroup()) {
791 $self = $this->localGroup();
793 $self = $this->localProfile();
796 throw new ServerException(sprintf(
797 _m("Tried to update avatar for unsaved remote profile %s"),
801 // @fixme this should be better encapsulated
802 // ripped from oauthstore.php (for old OMB client)
803 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
804 if (!copy($url, $temp_filename)) {
805 throw new ServerException(sprintf(_m("Unable to fetch avatar from %s"), $url));
808 if ($this->isGroup()) {
809 $id = $this->group_id;
811 $id = $this->profile_id;
813 // @fixme should we be using different ids?
814 $imagefile = new ImageFile($id, $temp_filename);
815 $filename = Avatar::filename($id,
816 image_type_to_extension($imagefile->type),
819 rename($temp_filename, Avatar::path($filename));
820 $self->setOriginal($filename);
822 $orig = clone($this);
823 $this->avatar = $url;
824 $this->update($orig);
828 * Pull avatar URL from ActivityObject or profile hints
830 * @param ActivityObject $object
831 * @param array $hints
832 * @return mixed URL string or false
835 protected static function getActivityObjectAvatar($object, $hints=array())
837 if ($object->avatarLinks) {
839 // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
840 foreach ($object->avatarLinks as $avatar) {
841 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
846 if (!$best || $avatar->width > $best->width) {
851 } else if (array_key_exists('avatar', $hints)) {
852 return $hints['avatar'];
858 * Get an appropriate avatar image source URL, if available.
860 * @param ActivityObject $actor
861 * @param DOMElement $feed
865 protected static function getAvatar($actor, $feed)
869 if ($actor->avatar) {
870 $url = trim($actor->avatar);
873 // Check <atom:logo> and <atom:icon> on the feed
874 $els = $feed->childNodes();
875 if ($els && $els->length) {
876 for ($i = 0; $i < $els->length; $i++) {
877 $el = $els->item($i);
878 if ($el->namespaceURI == Activity::ATOM) {
879 if (empty($url) && $el->localName == 'logo') {
880 $url = trim($el->textContent);
883 if (empty($icon) && $el->localName == 'icon') {
885 $icon = trim($el->textContent);
890 if ($icon && !$url) {
895 $opts = array('allowed_schemes' => array('http', 'https'));
896 if (Validate::uri($url, $opts)) {
900 return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
904 * Fetch, or build if necessary, an Ostatus_profile for the actor
905 * in a given Activity Streams activity.
907 * @param Activity $activity
908 * @param string $feeduri if we already know the canonical feed URI!
909 * @param string $salmonuri if we already know the salmon return channel URI
910 * @return Ostatus_profile
913 public static function ensureActorProfile($activity, $hints=array())
915 return self::ensureActivityObjectProfile($activity->actor, $hints);
918 public static function ensureActivityObjectProfile($object, $hints=array())
920 $profile = self::getActivityObjectProfile($object);
922 $profile->updateFromActivityObject($object, $hints);
924 $profile = self::createActivityObjectProfile($object, $hints);
930 * @param Activity $activity
931 * @return mixed matching Ostatus_profile or false if none known
933 public static function getActorProfile($activity)
935 return self::getActivityObjectProfile($activity->actor);
938 protected static function getActivityObjectProfile($object)
940 $uri = self::getActivityObjectProfileURI($object);
941 return Ostatus_profile::staticGet('uri', $uri);
944 protected static function getActorProfileURI($activity)
946 return self::getActivityObjectProfileURI($activity->actor);
950 * @param Activity $activity
952 * @throws ServerException
954 protected static function getActivityObjectProfileURI($object)
956 $opts = array('allowed_schemes' => array('http', 'https'));
957 if ($object->id && Validate::uri($object->id, $opts)) {
960 if ($object->link && Validate::uri($object->link, $opts)) {
961 return $object->link;
963 throw new ServerException("No author ID URI found");
967 * @fixme validate stuff somewhere
971 * Create local ostatus_profile and profile/user_group entries for
972 * the provided remote user or group.
974 * @param ActivityObject $object
975 * @param array $hints
977 * @return Ostatus_profile
979 protected static function createActivityObjectProfile($object, $hints=array())
981 $homeuri = $object->id;
985 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
986 throw new ServerException("No profile URI");
989 if (array_key_exists('feedurl', $hints)) {
990 $feeduri = $hints['feedurl'];
992 $discover = new FeedDiscovery();
993 $feeduri = $discover->discoverFromURL($homeuri);
996 if (array_key_exists('salmon', $hints)) {
997 $salmonuri = $hints['salmon'];
1000 $discover = new FeedDiscovery();
1001 $discover->discoverFromFeedURL($hints['feedurl']);
1003 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1006 if (array_key_exists('hub', $hints)) {
1007 $huburi = $hints['hub'];
1010 $discover = new FeedDiscovery();
1011 $discover->discoverFromFeedURL($hints['feedurl']);
1013 $huburi = $discover->getAtomLink('hub');
1017 // We can only deal with folks with a PuSH hub
1018 throw new FeedSubNoHubException();
1021 $oprofile = new Ostatus_profile();
1023 $oprofile->uri = $homeuri;
1024 $oprofile->feeduri = $feeduri;
1025 $oprofile->salmonuri = $salmonuri;
1027 $oprofile->created = common_sql_now();
1028 $oprofile->modified = common_sql_now();
1030 if ($object->type == ActivityObject::PERSON) {
1031 $profile = new Profile();
1032 $profile->created = common_sql_now();
1033 self::updateProfile($profile, $object, $hints);
1035 $oprofile->profile_id = $profile->insert();
1036 if (!$oprofile->profile_id) {
1037 throw new ServerException("Can't save local profile");
1040 $group = new User_group();
1041 $group->uri = $homeuri;
1042 $group->created = common_sql_now();
1043 self::updateGroup($group, $object, $hints);
1045 $oprofile->group_id = $group->insert();
1046 if (!$oprofile->group_id) {
1047 throw new ServerException("Can't save local profile");
1051 $ok = $oprofile->insert();
1054 $avatar = self::getActivityObjectAvatar($object, $hints);
1056 $oprofile->updateAvatar($avatar);
1060 throw new ServerException("Can't save OStatus profile");
1065 * Save any updated profile information to our local copy.
1066 * @param ActivityObject $object
1067 * @param array $hints
1069 public function updateFromActivityObject($object, $hints=array())
1071 if ($this->isGroup()) {
1072 $group = $this->localGroup();
1073 self::updateGroup($group, $object, $hints);
1075 $profile = $this->localProfile();
1076 self::updateProfile($profile, $object, $hints);
1078 $avatar = self::getActivityObjectAvatar($object, $hints);
1080 $this->updateAvatar($avatar);
1084 protected static function updateProfile($profile, $object, $hints=array())
1086 $orig = clone($profile);
1088 $profile->nickname = self::getActivityObjectNickname($object, $hints);
1090 if (!empty($object->title)) {
1091 $profile->fullname = $object->title;
1092 } else if (array_key_exists('fullname', $hints)) {
1093 $profile->fullname = $hints['fullname'];
1096 if (!empty($object->link)) {
1097 $profile->profileurl = $object->link;
1098 } else if (array_key_exists('profileurl', $hints)) {
1099 $profile->profileurl = $hints['profileurl'];
1100 } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1101 $profile->profileurl = $object->id;
1104 $profile->bio = self::getActivityObjectBio($object, $hints);
1105 $profile->location = self::getActivityObjectLocation($object, $hints);
1106 $profile->homepage = self::getActivityObjectHomepage($object, $hints);
1108 if (!empty($object->geopoint)) {
1109 $location = ActivityContext::locationFromPoint($object->geopoint);
1110 if (!empty($location)) {
1111 $profile->lat = $location->lat;
1112 $profile->lon = $location->lon;
1116 // @fixme tags/categories
1117 // @todo tags from categories
1120 common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1121 $profile->update($orig);
1125 protected static function updateGroup($group, $object, $hints=array())
1127 $orig = clone($group);
1129 $group->nickname = self::getActivityObjectNickname($object, $hints);
1130 $group->fullname = $object->title;
1132 if (!empty($object->link)) {
1133 $group->mainpage = $object->link;
1134 } else if (array_key_exists('profileurl', $hints)) {
1135 $group->mainpage = $hints['profileurl'];
1138 // @todo tags from categories
1139 $group->description = self::getActivityObjectBio($object, $hints);
1140 $group->location = self::getActivityObjectLocation($object, $hints);
1141 $group->homepage = self::getActivityObjectHomepage($object, $hints);
1144 common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1145 $group->update($orig);
1149 protected static function getActivityObjectHomepage($object, $hints=array())
1152 $poco = $object->poco;
1154 if (!empty($poco)) {
1155 $url = $poco->getPrimaryURL();
1156 if ($url && $url->type == 'homepage') {
1157 $homepage = $url->value;
1161 // @todo Try for a another PoCo URL?
1166 protected static function getActivityObjectLocation($object, $hints=array())
1170 if (!empty($object->poco) &&
1171 isset($object->poco->address->formatted)) {
1172 $location = $object->poco->address->formatted;
1173 } else if (array_key_exists('location', $hints)) {
1174 $location = $hints['location'];
1177 if (!empty($location)) {
1178 if (mb_strlen($location) > 255) {
1179 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1183 // @todo Try to find location some othe way? Via goerss point?
1188 protected static function getActivityObjectBio($object, $hints=array())
1192 if (!empty($object->poco)) {
1193 $note = $object->poco->note;
1194 } else if (array_key_exists('bio', $hints)) {
1195 $note = $hints['bio'];
1198 if (!empty($note)) {
1199 if (Profile::bioTooLong($note)) {
1200 // XXX: truncate ok?
1201 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1207 // @todo Try to get bio info some other way?
1212 protected static function getActivityObjectNickname($object, $hints=array())
1214 if ($object->poco) {
1215 if (!empty($object->poco->preferredUsername)) {
1216 return common_nicknamize($object->poco->preferredUsername);
1220 if (!empty($object->nickname)) {
1221 return common_nicknamize($object->nickname);
1224 if (array_key_exists('nickname', $hints)) {
1225 return $hints['nickname'];
1228 // Try the definitive ID
1230 $nickname = self::nicknameFromURI($object->id);
1232 // Try a Webfinger if one was passed (way) down
1234 if (empty($nickname)) {
1235 if (array_key_exists('webfinger', $hints)) {
1236 $nickname = self::nicknameFromURI($hints['webfinger']);
1242 if (empty($nickname)) {
1243 $nickname = common_nicknamize($object->title);
1249 protected static function nicknameFromURI($uri)
1251 preg_match('/(\w+):/', $uri, $matches);
1253 $protocol = $matches[1];
1255 switch ($protocol) {
1258 if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1259 return common_canonical_nickname($matches[1]);
1263 return common_url_to_nickname($uri);
1271 * @param string $addr webfinger address
1272 * @return Ostatus_profile
1273 * @throws Exception on error conditions
1275 public static function ensureWebfinger($addr)
1277 // First, try the cache
1279 $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1281 if ($uri !== false) {
1282 if (is_null($uri)) {
1283 // Negative cache entry
1284 throw new Exception('Not a valid webfinger address.');
1286 $oprofile = Ostatus_profile::staticGet('uri', $uri);
1287 if (!empty($oprofile)) {
1292 // First, look it up
1294 $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1296 if (!empty($oprofile)) {
1297 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1301 // Now, try some discovery
1303 $disco = new Discovery();
1306 $result = $disco->lookup($addr);
1307 } catch (Exception $e) {
1308 // Save negative cache entry so we don't waste time looking it up again.
1309 // @fixme distinguish temporary failures?
1310 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1311 throw new Exception('Not a valid webfinger address.');
1314 $hints = array('webfinger' => $addr);
1316 foreach ($result->links as $link) {
1317 switch ($link['rel']) {
1318 case Discovery::PROFILEPAGE:
1319 $hints['profileurl'] = $profileUrl = $link['href'];
1321 case Salmon::NS_REPLIES:
1322 $hints['salmon'] = $salmonEndpoint = $link['href'];
1324 case Discovery::UPDATESFROM:
1325 $hints['feedurl'] = $feedUrl = $link['href'];
1327 case Discovery::HCARD:
1328 $hcardUrl = $link['href'];
1331 common_log(LOG_NOTICE, "Don't know what to do with rel = '{$link['rel']}'");
1336 if (isset($hcardUrl)) {
1337 $hcardHints = self::slurpHcard($hcardUrl);
1338 // Note: Webfinger > hcard
1339 $hints = array_merge($hcardHints, $hints);
1342 // If we got a feed URL, try that
1344 if (isset($feedUrl)) {
1346 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL $feedUrl");
1347 $oprofile = self::ensureProfile($feedUrl, $hints);
1348 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1350 } catch (Exception $e) {
1351 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1356 // If we got a profile page, try that!
1358 if (isset($profileUrl)) {
1360 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1361 $oprofile = self::ensureProfile($profileUrl, $hints);
1362 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1364 } catch (Exception $e) {
1365 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1373 if (isset($salmonEndpoint)) {
1375 // An account URL, a salmon endpoint, and a dream? Not much to go
1376 // on, but let's give it a try
1378 $uri = 'acct:'.$addr;
1380 $profile = new Profile();
1382 $profile->nickname = self::nicknameFromUri($uri);
1383 $profile->created = common_sql_now();
1385 if (isset($profileUrl)) {
1386 $profile->profileurl = $profileUrl;
1389 $profile_id = $profile->insert();
1392 common_log_db_error($profile, 'INSERT', __FILE__);
1393 throw new Exception("Couldn't save profile for '$addr'");
1396 $oprofile = new Ostatus_profile();
1398 $oprofile->uri = $uri;
1399 $oprofile->salmonuri = $salmonEndpoint;
1400 $oprofile->profile_id = $profile_id;
1401 $oprofile->created = common_sql_now();
1403 if (isset($feedUrl)) {
1404 $profile->feeduri = $feedUrl;
1407 $result = $oprofile->insert();
1410 common_log_db_error($oprofile, 'INSERT', __FILE__);
1411 throw new Exception("Couldn't save ostatus_profile for '$addr'");
1414 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1418 throw new Exception("Couldn't find a valid profile for '$addr'");
1421 function saveHTMLFile($title, $rendered)
1423 $final = sprintf("<!DOCTYPE html>\n<html><head><title>%s</title></head>".
1424 '<body><div>%s</div></body></html>',
1425 htmlspecialchars($title),
1428 $filename = File::filename($this->localProfile(),
1429 'ostatus', // ignored?
1432 $filepath = File::path($filename);
1434 file_put_contents($filepath, $final);
1438 $file->filename = $filename;
1439 $file->url = File::url($filename);
1440 $file->size = filesize($filepath);
1441 $file->date = time();
1442 $file->mimetype = 'text/html';
1444 $file_id = $file->insert();
1446 if ($file_id === false) {
1447 common_log_db_error($file, "INSERT", __FILE__);
1448 throw new ServerException(_('Could not store HTML content of long post as file.'));
1454 protected static function slurpHcard($url)
1456 set_include_path(get_include_path() . PATH_SEPARATOR . INSTALLDIR . '/plugins/OStatus/extlib/hkit/');
1457 require_once('hkit.class.php');
1461 // Google Buzz hcards need to be tidied. Probably others too.
1463 $h->tidy_mode = 'proxy'; // 'proxy', 'exec', 'php' or 'none'
1466 $hcards = $h->getByURL('hcard', $url);
1468 if (empty($hcards)) {
1472 // @fixme more intelligent guess on multi-hcard pages
1473 $hcard = $hcards[0];
1477 $hints['profileurl'] = $url;
1479 if (array_key_exists('nickname', $hcard)) {
1480 $hints['nickname'] = $hcard['nickname'];
1483 if (array_key_exists('fn', $hcard)) {
1484 $hints['fullname'] = $hcard['fn'];
1485 } else if (array_key_exists('n', $hcard)) {
1486 $hints['fullname'] = implode(' ', $hcard['n']);
1489 if (array_key_exists('photo', $hcard)) {
1490 $hints['avatar'] = $hcard['photo'];
1493 if (array_key_exists('note', $hcard)) {
1494 $hints['bio'] = $hcard['note'];
1497 if (array_key_exists('adr', $hcard)) {
1498 if (is_string($hcard['adr'])) {
1499 $hints['location'] = $hcard['adr'];
1500 } else if (is_array($hcard['adr'])) {
1501 $hints['location'] = implode(' ', $hcard['adr']);
1505 if (array_key_exists('url', $hcard)) {
1506 if (is_string($hcard['url'])) {
1507 $hints['homepage'] = $hcard['url'];
1508 } else if (is_array($hcard['url'])) {
1509 // HACK get the last one; that's how our hcards look
1510 $hints['homepage'] = $hcard['url'][count($hcard['url'])-1];