3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2009-2010, StatusNet, Inc.
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
21 * @package OStatusPlugin
22 * @maintainer Brion Vibber <brion@status.net>
25 class Ostatus_profile extends Memcached_DataObject
27 public $__table = 'ostatus_profile';
36 public $avatar; // remote URL of the last avatar we saved
41 public /*static*/ function staticGet($k, $v=null)
43 return parent::staticGet(__CLASS__, $k, $v);
47 * return table definition for DB_DataObject
49 * DB_DataObject needs to know something about the table to manipulate
50 * instances. This method provides all the DB_DataObject needs to know.
52 * @return array array of column definitions
57 return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
58 'profile_id' => DB_DATAOBJECT_INT,
59 'group_id' => DB_DATAOBJECT_INT,
60 'feeduri' => DB_DATAOBJECT_STR,
61 'salmonuri' => DB_DATAOBJECT_STR,
62 'avatar' => DB_DATAOBJECT_STR,
63 'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
64 'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
67 static function schemaDef()
69 return array(new ColumnDef('uri', 'varchar',
71 new ColumnDef('profile_id', 'integer',
73 new ColumnDef('group_id', 'integer',
75 new ColumnDef('feeduri', 'varchar',
77 new ColumnDef('salmonuri', 'text',
79 new ColumnDef('avatar', 'text',
81 new ColumnDef('created', 'datetime',
83 new ColumnDef('modified', 'datetime',
88 * return key definitions for DB_DataObject
90 * DB_DataObject needs to know about keys that the table has; this function
93 * @return array key definitions
98 return array_keys($this->keyTypes());
102 * return key definitions for Memcached_DataObject
104 * Our caching system uses the same key definitions, but uses a different
105 * method to get them.
107 * @return array key definitions
112 return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
115 function sequenceKey()
117 return array(false, false, false);
121 * Fetch the StatusNet-side profile for this feed
124 public function localProfile()
126 if ($this->profile_id) {
127 return Profile::staticGet('id', $this->profile_id);
133 * Fetch the StatusNet-side profile for this feed
136 public function localGroup()
138 if ($this->group_id) {
139 return User_group::staticGet('id', $this->group_id);
145 * Returns an ActivityObject describing this remote user or group profile.
146 * Can then be used to generate Atom chunks.
148 * @return ActivityObject
150 function asActivityObject()
152 if ($this->isGroup()) {
153 return ActivityObject::fromGroup($this->localGroup());
155 return ActivityObject::fromProfile($this->localProfile());
160 * Returns an XML string fragment with profile information as an
161 * Activity Streams noun object with the given element type.
163 * Assumes that 'activity' namespace has been previously defined.
165 * @fixme replace with wrappers on asActivityObject when it's got everything.
167 * @param string $element one of 'actor', 'subject', 'object', 'target'
170 function asActivityNoun($element)
172 if ($this->isGroup()) {
173 $noun = ActivityObject::fromGroup($this->localGroup());
174 return $noun->asString('activity:' . $element);
176 $noun = ActivityObject::fromProfile($this->localProfile());
177 return $noun->asString('activity:' . $element);
182 * @return boolean true if this is a remote group
186 if ($this->profile_id && !$this->group_id) {
188 } else if ($this->group_id && !$this->profile_id) {
190 } else if ($this->group_id && $this->profile_id) {
191 throw new ServerException("Invalid ostatus_profile state: both group and profile IDs set for $this->uri");
193 throw new ServerException("Invalid ostatus_profile state: both group and profile IDs empty for $this->uri");
198 * Send a subscription request to the hub for this feed.
199 * The hub will later send us a confirmation POST to /main/push/callback.
201 * @return bool true on success, false on failure
202 * @throws ServerException if feed state is not valid
204 public function subscribe()
206 $feedsub = FeedSub::ensureFeed($this->feeduri);
207 if ($feedsub->sub_state == 'active') {
208 // Active subscription, we don't need to do anything.
211 // Inactive or we got left in an inconsistent state.
212 // Run a subscription request to make sure we're current!
213 return $feedsub->subscribe();
218 * Send a PuSH unsubscription request to the hub for this feed.
219 * The hub will later send us a confirmation POST to /main/push/callback.
221 * @return bool true on success, false on failure
222 * @throws ServerException if feed state is not valid
224 public function unsubscribe() {
225 $feedsub = FeedSub::staticGet('uri', $this->feeduri);
226 if (!$feedsub || $feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
227 // No active PuSH subscription, we can just leave it be.
230 // PuSH subscription is either active or in an indeterminate state.
231 // Send an unsubscribe.
232 return $feedsub->unsubscribe();
237 * Check if this remote profile has any active local subscriptions, and
238 * if not drop the PuSH subscription feed.
242 public function garbageCollect()
244 if ($this->isGroup()) {
245 $members = $this->localGroup()->getMembers(0, 1);
246 $count = $members->N;
248 $count = $this->localProfile()->subscriberCount();
251 common_log(LOG_INFO, "Unsubscribing from now-unused remote feed $this->feeduri");
252 $this->unsubscribe();
260 * Send an Activity Streams notification to the remote Salmon endpoint,
263 * @param Profile $actor Actor who did the activity
264 * @param string $verb Activity::SUBSCRIBE or Activity::JOIN
265 * @param Object $object object of the action; must define asActivityNoun($tag)
267 public function notify($actor, $verb, $object=null)
269 if (!($actor instanceof Profile)) {
270 $type = gettype($actor);
271 if ($type == 'object') {
272 $type = get_class($actor);
274 throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
276 if ($object == null) {
279 if ($this->salmonuri) {
282 $id = TagURI::mint('%s:%s:%s',
285 common_date_iso8601(time()));
287 // @fixme consolidate all these NS settings somewhere
288 $attributes = array('xmlns' => Activity::ATOM,
289 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
290 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
291 'xmlns:georss' => 'http://www.georss.org/georss',
292 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
293 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
294 'xmlns:media' => 'http://purl.org/syndication/atommedia');
296 $entry = new XMLStringer();
297 $entry->elementStart('entry', $attributes);
298 $entry->element('id', null, $id);
299 $entry->element('title', null, $text);
300 $entry->element('summary', null, $text);
301 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
303 $entry->element('activity:verb', null, $verb);
304 $entry->raw($actor->asAtomAuthor());
305 $entry->raw($actor->asActivityActor());
306 $entry->raw($object->asActivityNoun('object'));
307 $entry->elementEnd('entry');
309 $xml = $entry->getString();
310 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
312 $salmon = new Salmon(); // ?
313 return $salmon->post($this->salmonuri, $xml, $actor);
319 * Send a Salmon notification ping immediately, and confirm that we got
320 * an acceptable response from the remote site.
322 * @param mixed $entry XML string, Notice, or Activity
323 * @return boolean success
325 public function notifyActivity($entry, $actor)
327 if ($this->salmonuri) {
328 $salmon = new Salmon();
329 return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
336 * Queue a Salmon notification for later. If queues are disabled we'll
337 * send immediately but won't get the return value.
339 * @param mixed $entry XML string, Notice, or Activity
340 * @return boolean success
342 public function notifyDeferred($entry, $actor)
344 if ($this->salmonuri) {
345 $data = array('salmonuri' => $this->salmonuri,
346 'entry' => $this->notifyPrepXml($entry),
347 'actor' => $actor->id);
349 $qm = QueueManager::get();
350 return $qm->enqueue($data, 'salmon');
356 protected function notifyPrepXml($entry)
358 $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
359 if (is_string($entry)) {
361 } else if ($entry instanceof Activity) {
362 return $preamble . $entry->asString(true);
363 } else if ($entry instanceof Notice) {
364 return $preamble . $entry->asAtomEntry(true, true);
366 throw new ServerException("Invalid type passed to Ostatus_profile::notify; must be XML string or Activity entry");
370 function getBestName()
372 if ($this->isGroup()) {
373 return $this->localGroup()->getBestName();
375 return $this->localProfile()->getBestName();
380 * Read and post notices for updates from the feed.
381 * Currently assumes that all items in the feed are new,
382 * coming from a PuSH hub.
384 * @param DOMDocument $doc
385 * @param string $source identifier ("push")
387 public function processFeed(DOMDocument $doc, $source)
389 $feed = $doc->documentElement;
391 if ($feed->localName == 'feed' && $feed->namespaceURI == Activity::ATOM) {
392 $this->processAtomFeed($feed, $source);
393 } else if ($feed->localName == 'rss') { // @fixme check namespace
394 $this->processRssFeed($feed, $source);
396 throw new Exception("Unknown feed format.");
400 public function processAtomFeed(DOMElement $feed, $source)
402 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
403 if ($entries->length == 0) {
404 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
408 for ($i = 0; $i < $entries->length; $i++) {
409 $entry = $entries->item($i);
410 $this->processEntry($entry, $feed, $source);
414 public function processRssFeed(DOMElement $rss, $source)
416 $channels = $rss->getElementsByTagName('channel');
418 if ($channels->length == 0) {
419 throw new Exception("RSS feed without a channel.");
420 } else if ($channels->length > 1) {
421 common_log(LOG_WARNING, __METHOD__ . ": more than one channel in an RSS feed");
424 $channel = $channels->item(0);
426 $items = $channel->getElementsByTagName('item');
428 for ($i = 0; $i < $items->length; $i++) {
429 $item = $items->item($i);
430 $this->processEntry($item, $channel, $source);
435 * Process a posted entry from this feed source.
437 * @param DOMElement $entry
438 * @param DOMElement $feed for context
439 * @param string $source identifier ("push" or "salmon")
441 public function processEntry($entry, $feed, $source)
443 $activity = new Activity($entry, $feed);
445 if ($activity->verb == ActivityVerb::POST) {
446 $this->processPost($activity, $source);
448 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
453 * Process an incoming post activity from this remote feed.
454 * @param Activity $activity
455 * @param string $method 'push' or 'salmon'
456 * @return mixed saved Notice or false
457 * @fixme break up this function, it's getting nasty long
459 public function processPost($activity, $method)
461 if ($this->isGroup()) {
462 // A group feed will contain posts from multiple authors.
463 // @fixme validate these profiles in some way!
464 $oprofile = self::ensureActorProfile($activity);
465 if ($oprofile->isGroup()) {
466 // Groups can't post notices in StatusNet.
467 common_log(LOG_WARNING, "OStatus: skipping post with group listed as author: $oprofile->uri in feed from $this->uri");
471 $actor = $activity->actor;
474 // OK here! assume the default
475 } else if ($actor->id == $this->uri || $actor->link == $this->uri) {
476 $this->updateFromActivityObject($actor);
478 throw new Exception("Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for {$this->uri}");
484 // The id URI will be used as a unique identifier for for the notice,
485 // protecting against duplicate saves. It isn't required to be a URL;
486 // tag: URIs for instance are found in Google Buzz feeds.
487 $sourceUri = $activity->object->id;
488 $dupe = Notice::staticGet('uri', $sourceUri);
490 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
494 // We'll also want to save a web link to the original notice, if provided.
496 if ($activity->object->link) {
497 $sourceUrl = $activity->object->link;
498 } else if ($activity->link) {
499 $sourceUrl = $activity->link;
500 } else if (preg_match('!^https?://!', $activity->object->id)) {
501 $sourceUrl = $activity->object->id;
504 // Get (safe!) HTML and text versions of the content
505 $rendered = $this->purify($activity->object->content);
506 $content = html_entity_decode(strip_tags($rendered));
508 $shortened = common_shorten_links($content);
510 // If it's too long, try using the summary, and make the
511 // HTML an attachment.
515 if (Notice::contentTooLong($shortened)) {
516 $attachment = $this->saveHTMLFile($activity->object->title, $rendered);
517 $summary = $activity->object->summary;
518 if (empty($summary)) {
521 $shortSummary = common_shorten_links($summary);
522 if (Notice::contentTooLong($shortSummary)) {
523 $url = common_shorten_url(common_local_url('attachment',
524 array('attachment' => $attachment->id)));
525 $shortSummary = substr($shortSummary,
527 Notice::maxContent() - (mb_strlen($url) + 2));
528 $shortSummary .= '… ' . $url;
529 $content = $shortSummary;
530 $rendered = common_render_text($content);
534 $options = array('is_local' => Notice::REMOTE_OMB,
537 'rendered' => $rendered,
538 'replies' => array(),
543 // Check for optional attributes...
545 if (!empty($activity->time)) {
546 $options['created'] = common_sql_date($activity->time);
549 if ($activity->context) {
550 // Any individual or group attn: targets?
551 $replies = $activity->context->attention;
552 $options['groups'] = $this->filterReplies($oprofile, $replies);
553 $options['replies'] = $replies;
555 // Maintain direct reply associations
556 // @fixme what about conversation ID?
557 if (!empty($activity->context->replyToID)) {
558 $orig = Notice::staticGet('uri',
559 $activity->context->replyToID);
561 $options['reply_to'] = $orig->id;
565 $location = $activity->context->location;
567 $options['lat'] = $location->lat;
568 $options['lon'] = $location->lon;
569 if ($location->location_id) {
570 $options['location_ns'] = $location->location_ns;
571 $options['location_id'] = $location->location_id;
576 // Atom categories <-> hashtags
577 foreach ($activity->categories as $cat) {
579 $term = common_canonical_tag($cat->term);
581 $options['tags'][] = $term;
586 // Atom enclosures -> attachment URLs
587 foreach ($activity->enclosures as $href) {
588 // @fixme save these locally or....?
589 $options['urls'][] = $href;
593 $saved = Notice::saveNew($oprofile->profile_id,
598 Ostatus_source::saveNew($saved, $this, $method);
599 if (!empty($attachment)) {
600 File_to_post::processNew($attachment->id, $saved->id);
603 } catch (Exception $e) {
604 common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
607 common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
614 protected function purify($html)
616 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
617 $config = array('safe' => 1,
618 'deny_attribute' => 'id,style,on*');
619 return htmLawed($html, $config);
623 * Filters a list of recipient ID URIs to just those for local delivery.
624 * @param Ostatus_profile local profile of sender
625 * @param array in/out &$attention_uris set of URIs, will be pruned on output
626 * @return array of group IDs
628 protected function filterReplies($sender, &$attention_uris)
630 common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
633 foreach ($attention_uris as $recipient) {
634 // Is the recipient a local user?
635 $user = User::staticGet('uri', $recipient);
637 // @fixme sender verification, spam etc?
638 $replies[] = $recipient;
642 // Is the recipient a remote group?
643 $oprofile = Ostatus_profile::staticGet('uri', $recipient);
645 if ($oprofile->isGroup()) {
646 // Deliver to local members of this remote group.
647 // @fixme sender verification?
648 $groups[] = $oprofile->group_id;
650 common_log(LOG_DEBUG, "Skipping reply to remote profile $recipient");
655 // Is the recipient a local group?
656 // @fixme uri on user_group isn't reliable yet
657 // $group = User_group::staticGet('uri', $recipient);
658 $id = OStatusPlugin::localGroupFromUrl($recipient);
660 $group = User_group::staticGet('id', $id);
662 // Deliver to all members of this local group if allowed.
663 $profile = $sender->localProfile();
664 if ($profile->isMember($group)) {
665 $groups[] = $group->id;
667 common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
671 common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
675 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient");
678 $attention_uris = $replies;
679 common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
680 common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
685 * @param string $profile_url
686 * @return Ostatus_profile
687 * @throws FeedSubException
690 public static function ensureProfileURL($profile_url, $hints=array())
692 $oprofile = self::getFromProfileURL($profile_url);
694 if (!empty($oprofile)) {
698 $hints['profileurl'] = $profile_url;
703 $client = new HTTPClient();
704 $client->setHeader('Accept', 'text/html,application/xhtml+xml');
705 $response = $client->get($profile_url);
707 if (!$response->isOk()) {
711 // Check if we have a non-canonical URL
713 $finalUrl = $response->getUrl();
715 if ($finalUrl != $profile_url) {
717 $hints['profileurl'] = $finalUrl;
719 $oprofile = self::getFromProfileURL($finalUrl);
721 if (!empty($oprofile)) {
726 // Try to get some hCard data
728 $body = $response->getBody();
730 $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
732 if (!empty($hcardHints)) {
733 $hints = array_merge($hints, $hcardHints);
736 // Check if they've got an LRDD header
738 $lrdd = LinkHeader::getLink($response, 'lrdd', 'application/xrd+xml');
742 $xrd = Discovery::fetchXrd($lrdd);
743 $xrdHints = DiscoveryHints::fromXRD($xrd);
745 $hints = array_merge($hints, $xrdHints);
748 // If discovery found a feedurl (probably from LRDD), use it.
750 if (array_key_exists('feedurl', $hints)) {
751 return self::ensureFeedURL($hints['feedurl'], $hints);
754 // Get the feed URL from HTML
756 $discover = new FeedDiscovery();
758 $feedurl = $discover->discoverFromHTML($finalUrl, $body);
760 if (!empty($feedurl)) {
761 $hints['feedurl'] = $feedurl;
763 return self::ensureFeedURL($feedurl, $hints);
767 static function getFromProfileURL($profile_url)
769 $profile = Profile::staticGet('profileurl', $profile_url);
771 if (empty($profile)) {
775 // Is it a known Ostatus profile?
777 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
779 if (!empty($oprofile)) {
783 // Is it a local user?
785 $user = User::staticGet('id', $profile->id);
788 throw new Exception("'$profile_url' is the profile for local user '{$user->nickname}'.");
791 // Continue discovery; it's a remote profile
792 // for OMB or some other protocol, may also
798 public static function ensureFeedURL($feed_url, $hints=array())
800 $discover = new FeedDiscovery();
802 $feeduri = $discover->discoverFromFeedURL($feed_url);
803 $hints['feedurl'] = $feeduri;
805 $huburi = $discover->getAtomLink('hub');
806 $hints['hub'] = $huburi;
807 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
808 $hints['salmon'] = $salmonuri;
811 // We can only deal with folks with a PuSH hub
812 throw new FeedSubNoHubException();
815 $feedEl = $discover->root;
817 if ($feedEl->tagName == 'feed') {
818 return self::ensureAtomFeed($feedEl, $hints);
819 } else if ($feedEl->tagName == 'channel') {
820 return self::ensureRssChannel($feedEl, $hints);
822 throw new FeedSubBadXmlException($feeduri);
826 public static function ensureAtomFeed($feedEl, $hints)
828 // Try to get a profile from the feed activity:subject
830 $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
832 if (!empty($subject)) {
833 $subjObject = new ActivityObject($subject);
834 return self::ensureActivityObjectProfile($subjObject, $hints);
837 // Otherwise, try the feed author
839 $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
841 if (!empty($author)) {
842 $authorObject = new ActivityObject($author);
843 return self::ensureActivityObjectProfile($authorObject, $hints);
846 // Sheesh. Not a very nice feed! Let's try fingerpoken in the
849 $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
851 if (!empty($entries) && $entries->length > 0) {
853 $entry = $entries->item(0);
855 $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
857 if (!empty($actor)) {
858 $actorObject = new ActivityObject($actor);
859 return self::ensureActivityObjectProfile($actorObject, $hints);
863 $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
865 if (!empty($author)) {
866 $authorObject = new ActivityObject($author);
867 return self::ensureActivityObjectProfile($authorObject, $hints);
871 // XXX: make some educated guesses here
873 throw new FeedSubException("Can't find enough profile information to make a feed.");
876 public static function ensureRssChannel($feedEl, $hints)
878 // @fixme we should check whether this feed has elements
879 // with different <author> or <dc:creator> elements, and... I dunno.
880 // Do something about that.
882 $obj = ActivityObject::fromRssChannel($feedEl);
884 return self::ensureActivityObjectProfile($obj, $hints);
888 * Download and update given avatar image
891 * @throws Exception in various failure cases
893 protected function updateAvatar($url)
895 if ($url == $this->avatar) {
896 // We've already got this one.
899 if (!common_valid_http_url($url)) {
900 throw new ServerException(_m("Invalid avatar URL %s"), $url);
903 if ($this->isGroup()) {
904 $self = $this->localGroup();
906 $self = $this->localProfile();
909 throw new ServerException(sprintf(
910 _m("Tried to update avatar for unsaved remote profile %s"),
914 // @fixme this should be better encapsulated
915 // ripped from oauthstore.php (for old OMB client)
916 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
917 if (!copy($url, $temp_filename)) {
918 throw new ServerException(sprintf(_m("Unable to fetch avatar from %s"), $url));
921 if ($this->isGroup()) {
922 $id = $this->group_id;
924 $id = $this->profile_id;
926 // @fixme should we be using different ids?
927 $imagefile = new ImageFile($id, $temp_filename);
928 $filename = Avatar::filename($id,
929 image_type_to_extension($imagefile->type),
932 rename($temp_filename, Avatar::path($filename));
933 $self->setOriginal($filename);
935 $orig = clone($this);
936 $this->avatar = $url;
937 $this->update($orig);
941 * Pull avatar URL from ActivityObject or profile hints
943 * @param ActivityObject $object
944 * @param array $hints
945 * @return mixed URL string or false
948 protected static function getActivityObjectAvatar($object, $hints=array())
950 if ($object->avatarLinks) {
952 // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
953 foreach ($object->avatarLinks as $avatar) {
954 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
959 if (!$best || $avatar->width > $best->width) {
964 } else if (array_key_exists('avatar', $hints)) {
965 return $hints['avatar'];
971 * Get an appropriate avatar image source URL, if available.
973 * @param ActivityObject $actor
974 * @param DOMElement $feed
978 protected static function getAvatar($actor, $feed)
982 if ($actor->avatar) {
983 $url = trim($actor->avatar);
986 // Check <atom:logo> and <atom:icon> on the feed
987 $els = $feed->childNodes();
988 if ($els && $els->length) {
989 for ($i = 0; $i < $els->length; $i++) {
990 $el = $els->item($i);
991 if ($el->namespaceURI == Activity::ATOM) {
992 if (empty($url) && $el->localName == 'logo') {
993 $url = trim($el->textContent);
996 if (empty($icon) && $el->localName == 'icon') {
998 $icon = trim($el->textContent);
1003 if ($icon && !$url) {
1008 $opts = array('allowed_schemes' => array('http', 'https'));
1009 if (Validate::uri($url, $opts)) {
1013 return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
1017 * Fetch, or build if necessary, an Ostatus_profile for the actor
1018 * in a given Activity Streams activity.
1020 * @param Activity $activity
1021 * @param string $feeduri if we already know the canonical feed URI!
1022 * @param string $salmonuri if we already know the salmon return channel URI
1023 * @return Ostatus_profile
1026 public static function ensureActorProfile($activity, $hints=array())
1028 return self::ensureActivityObjectProfile($activity->actor, $hints);
1031 public static function ensureActivityObjectProfile($object, $hints=array())
1033 $profile = self::getActivityObjectProfile($object);
1035 $profile->updateFromActivityObject($object, $hints);
1037 $profile = self::createActivityObjectProfile($object, $hints);
1043 * @param Activity $activity
1044 * @return mixed matching Ostatus_profile or false if none known
1046 public static function getActorProfile($activity)
1048 return self::getActivityObjectProfile($activity->actor);
1051 protected static function getActivityObjectProfile($object)
1053 $uri = self::getActivityObjectProfileURI($object);
1054 return Ostatus_profile::staticGet('uri', $uri);
1057 protected static function getActorProfileURI($activity)
1059 return self::getActivityObjectProfileURI($activity->actor);
1063 * @param Activity $activity
1065 * @throws ServerException
1067 protected static function getActivityObjectProfileURI($object)
1069 $opts = array('allowed_schemes' => array('http', 'https'));
1070 if ($object->id && Validate::uri($object->id, $opts)) {
1073 if ($object->link && Validate::uri($object->link, $opts)) {
1074 return $object->link;
1076 throw new ServerException("No author ID URI found");
1080 * @fixme validate stuff somewhere
1084 * Create local ostatus_profile and profile/user_group entries for
1085 * the provided remote user or group.
1087 * @param ActivityObject $object
1088 * @param array $hints
1090 * @return Ostatus_profile
1092 protected static function createActivityObjectProfile($object, $hints=array())
1094 $homeuri = $object->id;
1098 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1099 throw new Exception("No profile URI");
1102 if (OStatusPlugin::localProfileFromUrl($homeuri)) {
1103 throw new Exception("Local user can't be referenced as remote.");
1106 if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1107 throw new Exception("Local group can't be referenced as remote.");
1110 if (array_key_exists('feedurl', $hints)) {
1111 $feeduri = $hints['feedurl'];
1113 $discover = new FeedDiscovery();
1114 $feeduri = $discover->discoverFromURL($homeuri);
1117 if (array_key_exists('salmon', $hints)) {
1118 $salmonuri = $hints['salmon'];
1121 $discover = new FeedDiscovery();
1122 $discover->discoverFromFeedURL($hints['feedurl']);
1124 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1127 if (array_key_exists('hub', $hints)) {
1128 $huburi = $hints['hub'];
1131 $discover = new FeedDiscovery();
1132 $discover->discoverFromFeedURL($hints['feedurl']);
1134 $huburi = $discover->getAtomLink('hub');
1138 // We can only deal with folks with a PuSH hub
1139 throw new FeedSubNoHubException();
1142 $oprofile = new Ostatus_profile();
1144 $oprofile->uri = $homeuri;
1145 $oprofile->feeduri = $feeduri;
1146 $oprofile->salmonuri = $salmonuri;
1148 $oprofile->created = common_sql_now();
1149 $oprofile->modified = common_sql_now();
1151 if ($object->type == ActivityObject::PERSON) {
1152 $profile = new Profile();
1153 $profile->created = common_sql_now();
1154 self::updateProfile($profile, $object, $hints);
1156 $oprofile->profile_id = $profile->insert();
1157 if (!$oprofile->profile_id) {
1158 throw new ServerException("Can't save local profile");
1161 $group = new User_group();
1162 $group->uri = $homeuri;
1163 $group->created = common_sql_now();
1164 self::updateGroup($group, $object, $hints);
1166 $oprofile->group_id = $group->insert();
1167 if (!$oprofile->group_id) {
1168 throw new ServerException("Can't save local profile");
1172 $ok = $oprofile->insert();
1175 $avatar = self::getActivityObjectAvatar($object, $hints);
1177 $oprofile->updateAvatar($avatar);
1181 throw new ServerException("Can't save OStatus profile");
1186 * Save any updated profile information to our local copy.
1187 * @param ActivityObject $object
1188 * @param array $hints
1190 public function updateFromActivityObject($object, $hints=array())
1192 if ($this->isGroup()) {
1193 $group = $this->localGroup();
1194 self::updateGroup($group, $object, $hints);
1196 $profile = $this->localProfile();
1197 self::updateProfile($profile, $object, $hints);
1199 $avatar = self::getActivityObjectAvatar($object, $hints);
1201 $this->updateAvatar($avatar);
1205 protected static function updateProfile($profile, $object, $hints=array())
1207 $orig = clone($profile);
1209 $profile->nickname = self::getActivityObjectNickname($object, $hints);
1211 if (!empty($object->title)) {
1212 $profile->fullname = $object->title;
1213 } else if (array_key_exists('fullname', $hints)) {
1214 $profile->fullname = $hints['fullname'];
1217 if (!empty($object->link)) {
1218 $profile->profileurl = $object->link;
1219 } else if (array_key_exists('profileurl', $hints)) {
1220 $profile->profileurl = $hints['profileurl'];
1221 } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1222 $profile->profileurl = $object->id;
1225 $profile->bio = self::getActivityObjectBio($object, $hints);
1226 $profile->location = self::getActivityObjectLocation($object, $hints);
1227 $profile->homepage = self::getActivityObjectHomepage($object, $hints);
1229 if (!empty($object->geopoint)) {
1230 $location = ActivityContext::locationFromPoint($object->geopoint);
1231 if (!empty($location)) {
1232 $profile->lat = $location->lat;
1233 $profile->lon = $location->lon;
1237 // @fixme tags/categories
1238 // @todo tags from categories
1241 common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1242 $profile->update($orig);
1246 protected static function updateGroup($group, $object, $hints=array())
1248 $orig = clone($group);
1250 $group->nickname = self::getActivityObjectNickname($object, $hints);
1251 $group->fullname = $object->title;
1253 if (!empty($object->link)) {
1254 $group->mainpage = $object->link;
1255 } else if (array_key_exists('profileurl', $hints)) {
1256 $group->mainpage = $hints['profileurl'];
1259 // @todo tags from categories
1260 $group->description = self::getActivityObjectBio($object, $hints);
1261 $group->location = self::getActivityObjectLocation($object, $hints);
1262 $group->homepage = self::getActivityObjectHomepage($object, $hints);
1265 common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1266 $group->update($orig);
1270 protected static function getActivityObjectHomepage($object, $hints=array())
1273 $poco = $object->poco;
1275 if (!empty($poco)) {
1276 $url = $poco->getPrimaryURL();
1277 if ($url && $url->type == 'homepage') {
1278 $homepage = $url->value;
1282 // @todo Try for a another PoCo URL?
1287 protected static function getActivityObjectLocation($object, $hints=array())
1291 if (!empty($object->poco) &&
1292 isset($object->poco->address->formatted)) {
1293 $location = $object->poco->address->formatted;
1294 } else if (array_key_exists('location', $hints)) {
1295 $location = $hints['location'];
1298 if (!empty($location)) {
1299 if (mb_strlen($location) > 255) {
1300 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1304 // @todo Try to find location some othe way? Via goerss point?
1309 protected static function getActivityObjectBio($object, $hints=array())
1313 if (!empty($object->poco)) {
1314 $note = $object->poco->note;
1315 } else if (array_key_exists('bio', $hints)) {
1316 $note = $hints['bio'];
1319 if (!empty($note)) {
1320 if (Profile::bioTooLong($note)) {
1321 // XXX: truncate ok?
1322 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1328 // @todo Try to get bio info some other way?
1333 protected static function getActivityObjectNickname($object, $hints=array())
1335 if ($object->poco) {
1336 if (!empty($object->poco->preferredUsername)) {
1337 return common_nicknamize($object->poco->preferredUsername);
1341 if (!empty($object->nickname)) {
1342 return common_nicknamize($object->nickname);
1345 if (array_key_exists('nickname', $hints)) {
1346 return $hints['nickname'];
1349 // Try the profile url (like foo.example.com or example.com/user/foo)
1351 $profileUrl = ($object->link) ? $object->link : $hints['profileurl'];
1353 if (!empty($profileUrl)) {
1354 $nickname = self::nicknameFromURI($profileUrl);
1357 // Try the URI (may be a tag:, http:, acct:, ...
1359 if (empty($nickname)) {
1360 $nickname = self::nicknameFromURI($object->id);
1363 // Try a Webfinger if one was passed (way) down
1365 if (empty($nickname)) {
1366 if (array_key_exists('webfinger', $hints)) {
1367 $nickname = self::nicknameFromURI($hints['webfinger']);
1373 if (empty($nickname)) {
1374 $nickname = common_nicknamize($object->title);
1380 protected static function nicknameFromURI($uri)
1382 preg_match('/(\w+):/', $uri, $matches);
1384 $protocol = $matches[1];
1386 switch ($protocol) {
1389 if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1390 return common_canonical_nickname($matches[1]);
1394 return common_url_to_nickname($uri);
1402 * @param string $addr webfinger address
1403 * @return Ostatus_profile
1404 * @throws Exception on error conditions
1406 public static function ensureWebfinger($addr)
1408 // First, try the cache
1410 $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1412 if ($uri !== false) {
1413 if (is_null($uri)) {
1414 // Negative cache entry
1415 throw new Exception('Not a valid webfinger address.');
1417 $oprofile = Ostatus_profile::staticGet('uri', $uri);
1418 if (!empty($oprofile)) {
1423 // Try looking it up
1425 $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1427 if (!empty($oprofile)) {
1428 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1432 // Now, try some discovery
1434 $disco = new Discovery();
1437 $xrd = $disco->lookup($addr);
1438 } catch (Exception $e) {
1439 // Save negative cache entry so we don't waste time looking it up again.
1440 // @fixme distinguish temporary failures?
1441 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1442 throw new Exception('Not a valid webfinger address.');
1445 $hints = array('webfinger' => $addr);
1447 $dhints = DiscoveryHints::fromXRD($xrd);
1449 $hints = array_merge($hints, $dhints);
1451 // If there's an Hcard, let's grab its info
1453 if (array_key_exists('hcard', $hints)) {
1454 if (!array_key_exists('profileurl', $hints) ||
1455 $hints['hcard'] != $hints['profileurl']) {
1456 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1457 $hints = array_merge($hcardHints, $hints);
1461 // If we got a feed URL, try that
1463 if (array_key_exists('feedurl', $hints)) {
1465 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1466 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
1467 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1469 } catch (Exception $e) {
1470 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1475 // If we got a profile page, try that!
1477 if (array_key_exists('profileurl', $hints)) {
1479 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1480 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
1481 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1483 } catch (Exception $e) {
1484 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1492 if (array_key_exists('salmon', $hints)) {
1494 $salmonEndpoint = $hints['salmon'];
1496 // An account URL, a salmon endpoint, and a dream? Not much to go
1497 // on, but let's give it a try
1499 $uri = 'acct:'.$addr;
1501 $profile = new Profile();
1503 $profile->nickname = self::nicknameFromUri($uri);
1504 $profile->created = common_sql_now();
1506 if (isset($profileUrl)) {
1507 $profile->profileurl = $profileUrl;
1510 $profile_id = $profile->insert();
1513 common_log_db_error($profile, 'INSERT', __FILE__);
1514 throw new Exception("Couldn't save profile for '$addr'");
1517 $oprofile = new Ostatus_profile();
1519 $oprofile->uri = $uri;
1520 $oprofile->salmonuri = $salmonEndpoint;
1521 $oprofile->profile_id = $profile_id;
1522 $oprofile->created = common_sql_now();
1524 if (isset($feedUrl)) {
1525 $profile->feeduri = $feedUrl;
1528 $result = $oprofile->insert();
1531 common_log_db_error($oprofile, 'INSERT', __FILE__);
1532 throw new Exception("Couldn't save ostatus_profile for '$addr'");
1535 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1539 throw new Exception("Couldn't find a valid profile for '$addr'");
1542 function saveHTMLFile($title, $rendered)
1544 $final = sprintf("<!DOCTYPE html>\n<html><head><title>%s</title></head>".
1545 '<body><div>%s</div></body></html>',
1546 htmlspecialchars($title),
1549 $filename = File::filename($this->localProfile(),
1550 'ostatus', // ignored?
1553 $filepath = File::path($filename);
1555 file_put_contents($filepath, $final);
1559 $file->filename = $filename;
1560 $file->url = File::url($filename);
1561 $file->size = filesize($filepath);
1562 $file->date = time();
1563 $file->mimetype = 'text/html';
1565 $file_id = $file->insert();
1567 if ($file_id === false) {
1568 common_log_db_error($file, "INSERT", __FILE__);
1569 throw new ServerException(_('Could not store HTML content of long post as file.'));