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' || $feedsub->sub_state == 'subscribe') {
209 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
210 return $feedsub->subscribe();
211 } else if ('unsubscribe') {
212 throw new FeedSubException("Unsub is pending, can't subscribe...");
217 * Send a PuSH unsubscription request to the hub for this feed.
218 * The hub will later send us a confirmation POST to /main/push/callback.
220 * @return bool true on success, false on failure
221 * @throws ServerException if feed state is not valid
223 public function unsubscribe() {
224 $feedsub = FeedSub::staticGet('uri', $this->feeduri);
228 if ($feedsub->sub_state == 'active') {
229 return $feedsub->unsubscribe();
230 } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive' || $feedsub->sub_state == 'unsubscribe') {
232 } else if ($feedsub->sub_state == 'subscribe') {
233 throw new FeedSubException("Feed is awaiting subscription, can't unsub...");
238 * Check if this remote profile has any active local subscriptions, and
239 * if not drop the PuSH subscription feed.
243 public function garbageCollect()
245 if ($this->isGroup()) {
246 $members = $this->localGroup()->getMembers(0, 1);
247 $count = $members->N;
249 $count = $this->localProfile()->subscriberCount();
252 common_log(LOG_INFO, "Unsubscribing from now-unused remote feed $this->feeduri");
253 $this->unsubscribe();
261 * Send an Activity Streams notification to the remote Salmon endpoint,
264 * @param Profile $actor Actor who did the activity
265 * @param string $verb Activity::SUBSCRIBE or Activity::JOIN
266 * @param Object $object object of the action; must define asActivityNoun($tag)
268 public function notify($actor, $verb, $object=null)
270 if (!($actor instanceof Profile)) {
271 $type = gettype($actor);
272 if ($type == 'object') {
273 $type = get_class($actor);
275 throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
277 if ($object == null) {
280 if ($this->salmonuri) {
283 $id = TagURI::mint('%s:%s:%s',
286 common_date_iso8601(time()));
288 // @fixme consolidate all these NS settings somewhere
289 $attributes = array('xmlns' => Activity::ATOM,
290 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
291 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
292 'xmlns:georss' => 'http://www.georss.org/georss',
293 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
294 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
295 'xmlns:media' => 'http://purl.org/syndication/atommedia');
297 $entry = new XMLStringer();
298 $entry->elementStart('entry', $attributes);
299 $entry->element('id', null, $id);
300 $entry->element('title', null, $text);
301 $entry->element('summary', null, $text);
302 $entry->element('published', null, common_date_w3dtf(common_sql_now()));
304 $entry->element('activity:verb', null, $verb);
305 $entry->raw($actor->asAtomAuthor());
306 $entry->raw($actor->asActivityActor());
307 $entry->raw($object->asActivityNoun('object'));
308 $entry->elementEnd('entry');
310 $xml = $entry->getString();
311 common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
313 $salmon = new Salmon(); // ?
314 return $salmon->post($this->salmonuri, $xml, $actor);
320 * Send a Salmon notification ping immediately, and confirm that we got
321 * an acceptable response from the remote site.
323 * @param mixed $entry XML string, Notice, or Activity
324 * @return boolean success
326 public function notifyActivity($entry, $actor)
328 if ($this->salmonuri) {
329 $salmon = new Salmon();
330 return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
337 * Queue a Salmon notification for later. If queues are disabled we'll
338 * send immediately but won't get the return value.
340 * @param mixed $entry XML string, Notice, or Activity
341 * @return boolean success
343 public function notifyDeferred($entry, $actor)
345 if ($this->salmonuri) {
346 $data = array('salmonuri' => $this->salmonuri,
347 'entry' => $this->notifyPrepXml($entry),
348 'actor' => $actor->id);
350 $qm = QueueManager::get();
351 return $qm->enqueue($data, 'salmon');
357 protected function notifyPrepXml($entry)
359 $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
360 if (is_string($entry)) {
362 } else if ($entry instanceof Activity) {
363 return $preamble . $entry->asString(true);
364 } else if ($entry instanceof Notice) {
365 return $preamble . $entry->asAtomEntry(true, true);
367 throw new ServerException("Invalid type passed to Ostatus_profile::notify; must be XML string or Activity entry");
371 function getBestName()
373 if ($this->isGroup()) {
374 return $this->localGroup()->getBestName();
376 return $this->localProfile()->getBestName();
381 * Read and post notices for updates from the feed.
382 * Currently assumes that all items in the feed are new,
383 * coming from a PuSH hub.
385 * @param DOMDocument $doc
386 * @param string $source identifier ("push")
388 public function processFeed(DOMDocument $doc, $source)
390 $feed = $doc->documentElement;
392 if ($feed->localName != 'feed' || $feed->namespaceURI != Activity::ATOM) {
393 common_log(LOG_ERR, __METHOD__ . ": not an Atom feed, ignoring");
397 $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
398 if ($entries->length == 0) {
399 common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
403 for ($i = 0; $i < $entries->length; $i++) {
404 $entry = $entries->item($i);
405 $this->processEntry($entry, $feed, $source);
410 * Process a posted entry from this feed source.
412 * @param DOMElement $entry
413 * @param DOMElement $feed for context
414 * @param string $source identifier ("push" or "salmon")
416 public function processEntry($entry, $feed, $source)
418 $activity = new Activity($entry, $feed);
420 if ($activity->verb == ActivityVerb::POST) {
421 $this->processPost($activity, $source);
423 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
428 * Process an incoming post activity from this remote feed.
429 * @param Activity $activity
430 * @param string $method 'push' or 'salmon'
431 * @return mixed saved Notice or false
432 * @fixme break up this function, it's getting nasty long
434 public function processPost($activity, $method)
436 if ($this->isGroup()) {
437 // A group feed will contain posts from multiple authors.
438 // @fixme validate these profiles in some way!
439 $oprofile = self::ensureActorProfile($activity);
440 if ($oprofile->isGroup()) {
441 // Groups can't post notices in StatusNet.
442 common_log(LOG_WARNING, "OStatus: skipping post with group listed as author: $oprofile->uri in feed from $this->uri");
446 // Individual user feeds may contain only posts from themselves.
447 // Authorship is validated against the profile URI on upper layers,
448 // through PuSH setup or Salmon signature checks.
449 $actorUri = self::getActorProfileURI($activity);
450 if ($actorUri == $this->uri) {
451 // Check if profile info has changed and update it
452 $this->updateFromActivityObject($activity->actor);
454 common_log(LOG_WARNING, "OStatus: skipping post with bad author: got $actorUri expected $this->uri");
460 // The id URI will be used as a unique identifier for for the notice,
461 // protecting against duplicate saves. It isn't required to be a URL;
462 // tag: URIs for instance are found in Google Buzz feeds.
463 $sourceUri = $activity->object->id;
464 $dupe = Notice::staticGet('uri', $sourceUri);
466 common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
470 // We'll also want to save a web link to the original notice, if provided.
472 if ($activity->object->link) {
473 $sourceUrl = $activity->object->link;
474 } else if ($activity->link) {
475 $sourceUrl = $activity->link;
476 } else if (preg_match('!^https?://!', $activity->object->id)) {
477 $sourceUrl = $activity->object->id;
480 // Get (safe!) HTML and text versions of the content
481 $rendered = $this->purify($activity->object->content);
482 $content = html_entity_decode(strip_tags($rendered));
484 $shortened = common_shorten_links($content);
486 // If it's too long, try using the summary, and make the
487 // HTML an attachment.
491 if (Notice::contentTooLong($shortened)) {
492 $attachment = $this->saveHTMLFile($activity->object->title, $rendered);
493 $summary = $activity->object->summary;
494 if (empty($summary)) {
497 $shortSummary = common_shorten_links($summary);
498 if (Notice::contentTooLong($shortSummary)) {
499 $url = common_shorten_url($sourceUrl);
500 $shortSummary = substr($shortSummary,
502 Notice::maxContent() - (mb_strlen($url) + 2));
503 $shortSummary .= '…';
504 $content = $shortSummary . ' ' . $url;
506 // We mark up the attachment link specially for the HTML output
507 // so we can fold-out the full version inline.
508 $attachUrl = common_local_url('attachment',
509 array('attachment' => $attachment->id));
510 $rendered = common_render_text($shortSummary) .
513 htmlspecialchars($attachUrl) .
514 '" class="attachment more">' .
515 // TRANS: expansion link for too-long remote messages
516 htmlspecialchars(_m('more')) .
521 $options = array('is_local' => Notice::REMOTE_OMB,
524 'rendered' => $rendered,
525 'replies' => array(),
530 // Check for optional attributes...
532 if (!empty($activity->time)) {
533 $options['created'] = common_sql_date($activity->time);
536 if ($activity->context) {
537 // Any individual or group attn: targets?
538 $replies = $activity->context->attention;
539 $options['groups'] = $this->filterReplies($oprofile, $replies);
540 $options['replies'] = $replies;
542 // Maintain direct reply associations
543 // @fixme what about conversation ID?
544 if (!empty($activity->context->replyToID)) {
545 $orig = Notice::staticGet('uri',
546 $activity->context->replyToID);
548 $options['reply_to'] = $orig->id;
552 $location = $activity->context->location;
554 $options['lat'] = $location->lat;
555 $options['lon'] = $location->lon;
556 if ($location->location_id) {
557 $options['location_ns'] = $location->location_ns;
558 $options['location_id'] = $location->location_id;
563 // Atom categories <-> hashtags
564 foreach ($activity->categories as $cat) {
566 $term = common_canonical_tag($cat->term);
568 $options['tags'][] = $term;
573 // Atom enclosures -> attachment URLs
574 foreach ($activity->enclosures as $href) {
575 // @fixme save these locally or....?
576 $options['urls'][] = $href;
580 $saved = Notice::saveNew($oprofile->profile_id,
585 Ostatus_source::saveNew($saved, $this, $method);
586 if (!empty($attachment)) {
587 File_to_post::processNew($attachment->id, $saved->id);
590 } catch (Exception $e) {
591 common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
594 common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
601 protected function purify($html)
603 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
604 $config = array('safe' => 1,
605 'deny_attribute' => 'id,style,on*');
606 return htmLawed($html, $config);
610 * Filters a list of recipient ID URIs to just those for local delivery.
611 * @param Ostatus_profile local profile of sender
612 * @param array in/out &$attention_uris set of URIs, will be pruned on output
613 * @return array of group IDs
615 protected function filterReplies($sender, &$attention_uris)
617 common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
620 foreach ($attention_uris as $recipient) {
621 // Is the recipient a local user?
622 $user = User::staticGet('uri', $recipient);
624 // @fixme sender verification, spam etc?
625 $replies[] = $recipient;
629 // Is the recipient a remote group?
630 $oprofile = Ostatus_profile::staticGet('uri', $recipient);
632 if ($oprofile->isGroup()) {
633 // Deliver to local members of this remote group.
634 // @fixme sender verification?
635 $groups[] = $oprofile->group_id;
637 common_log(LOG_DEBUG, "Skipping reply to remote profile $recipient");
642 // Is the recipient a local group?
643 // @fixme uri on user_group isn't reliable yet
644 // $group = User_group::staticGet('uri', $recipient);
645 $id = OStatusPlugin::localGroupFromUrl($recipient);
647 $group = User_group::staticGet('id', $id);
649 // Deliver to all members of this local group if allowed.
650 $profile = $sender->localProfile();
651 if ($profile->isMember($group)) {
652 $groups[] = $group->id;
654 common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
658 common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
662 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient");
665 $attention_uris = $replies;
666 common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
667 common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
672 * @param string $profile_url
673 * @return Ostatus_profile
674 * @throws FeedSubException
677 public static function ensureProfileURL($profile_url, $hints=array())
679 $oprofile = self::getFromProfileURL($profile_url);
681 if (!empty($oprofile)) {
685 $hints['profileurl'] = $profile_url;
690 $client = new HTTPClient();
691 $client->setHeader('Accept', 'text/html,application/xhtml+xml');
692 $response = $client->get($profile_url);
694 if (!$response->isOk()) {
698 // Check if we have a non-canonical URL
700 $finalUrl = $response->getUrl();
702 if ($finalUrl != $profile_url) {
704 $hints['profileurl'] = $finalUrl;
706 $oprofile = self::getFromProfileURL($finalUrl);
708 if (!empty($oprofile)) {
713 // Try to get some hCard data
715 $body = $response->getBody();
717 $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
719 if (!empty($hcardHints)) {
720 $hints = array_merge($hints, $hcardHints);
723 // Check if they've got an LRDD header
725 $lrdd = LinkHeader::getLink($response, 'lrdd', 'application/xrd+xml');
729 $xrd = Discovery::fetchXrd($lrdd);
730 $xrdHints = DiscoveryHints::fromXRD($xrd);
732 $hints = array_merge($hints, $xrdHints);
735 // If discovery found a feedurl (probably from LRDD), use it.
737 if (array_key_exists('feedurl', $hints)) {
738 return self::ensureFeedURL($hints['feedurl'], $hints);
741 // Get the feed URL from HTML
743 $discover = new FeedDiscovery();
745 $feedurl = $discover->discoverFromHTML($finalUrl, $body);
747 if (!empty($feedurl)) {
748 $hints['feedurl'] = $feedurl;
750 return self::ensureFeedURL($feedurl, $hints);
754 static function getFromProfileURL($profile_url)
756 $profile = Profile::staticGet('profileurl', $profile_url);
758 if (empty($profile)) {
762 // Is it a known Ostatus profile?
764 $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
766 if (!empty($oprofile)) {
770 // Is it a local user?
772 $user = User::staticGet('id', $profile->id);
775 throw new Exception("'$profile_url' is the profile for local user '{$user->nickname}'.");
778 // Continue discovery; it's a remote profile
779 // for OMB or some other protocol, may also
785 public static function ensureFeedURL($feed_url, $hints=array())
787 $discover = new FeedDiscovery();
789 $feeduri = $discover->discoverFromFeedURL($feed_url);
790 $hints['feedurl'] = $feeduri;
792 $huburi = $discover->getAtomLink('hub');
793 $hints['hub'] = $huburi;
794 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
795 $hints['salmon'] = $salmonuri;
798 // We can only deal with folks with a PuSH hub
799 throw new FeedSubNoHubException();
802 // Try to get a profile from the feed activity:subject
804 $feedEl = $discover->feed->documentElement;
806 $subject = ActivityUtils::child($feedEl, Activity::SUBJECT, Activity::SPEC);
808 if (!empty($subject)) {
809 $subjObject = new ActivityObject($subject);
810 return self::ensureActivityObjectProfile($subjObject, $hints);
813 // Otherwise, try the feed author
815 $author = ActivityUtils::child($feedEl, Activity::AUTHOR, Activity::ATOM);
817 if (!empty($author)) {
818 $authorObject = new ActivityObject($author);
819 return self::ensureActivityObjectProfile($authorObject, $hints);
822 // Sheesh. Not a very nice feed! Let's try fingerpoken in the
825 $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
827 if (!empty($entries) && $entries->length > 0) {
829 $entry = $entries->item(0);
831 $actor = ActivityUtils::child($entry, Activity::ACTOR, Activity::SPEC);
833 if (!empty($actor)) {
834 $actorObject = new ActivityObject($actor);
835 return self::ensureActivityObjectProfile($actorObject, $hints);
839 $author = ActivityUtils::child($entry, Activity::AUTHOR, Activity::ATOM);
841 if (!empty($author)) {
842 $authorObject = new ActivityObject($author);
843 return self::ensureActivityObjectProfile($authorObject, $hints);
847 // XXX: make some educated guesses here
849 throw new FeedSubException("Can't find enough profile information to make a feed.");
854 * Download and update given avatar image
856 * @throws Exception in various failure cases
858 protected function updateAvatar($url)
860 if ($url == $this->avatar) {
861 // We've already got this one.
865 if ($this->isGroup()) {
866 $self = $this->localGroup();
868 $self = $this->localProfile();
871 throw new ServerException(sprintf(
872 _m("Tried to update avatar for unsaved remote profile %s"),
876 // @fixme this should be better encapsulated
877 // ripped from oauthstore.php (for old OMB client)
878 $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
879 if (!copy($url, $temp_filename)) {
880 throw new ServerException(sprintf(_m("Unable to fetch avatar from %s"), $url));
883 if ($this->isGroup()) {
884 $id = $this->group_id;
886 $id = $this->profile_id;
888 // @fixme should we be using different ids?
889 $imagefile = new ImageFile($id, $temp_filename);
890 $filename = Avatar::filename($id,
891 image_type_to_extension($imagefile->type),
894 rename($temp_filename, Avatar::path($filename));
895 $self->setOriginal($filename);
897 $orig = clone($this);
898 $this->avatar = $url;
899 $this->update($orig);
903 * Pull avatar URL from ActivityObject or profile hints
905 * @param ActivityObject $object
906 * @param array $hints
907 * @return mixed URL string or false
910 protected static function getActivityObjectAvatar($object, $hints=array())
912 if ($object->avatarLinks) {
914 // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
915 foreach ($object->avatarLinks as $avatar) {
916 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
921 if (!$best || $avatar->width > $best->width) {
926 } else if (array_key_exists('avatar', $hints)) {
927 return $hints['avatar'];
933 * Get an appropriate avatar image source URL, if available.
935 * @param ActivityObject $actor
936 * @param DOMElement $feed
940 protected static function getAvatar($actor, $feed)
944 if ($actor->avatar) {
945 $url = trim($actor->avatar);
948 // Check <atom:logo> and <atom:icon> on the feed
949 $els = $feed->childNodes();
950 if ($els && $els->length) {
951 for ($i = 0; $i < $els->length; $i++) {
952 $el = $els->item($i);
953 if ($el->namespaceURI == Activity::ATOM) {
954 if (empty($url) && $el->localName == 'logo') {
955 $url = trim($el->textContent);
958 if (empty($icon) && $el->localName == 'icon') {
960 $icon = trim($el->textContent);
965 if ($icon && !$url) {
970 $opts = array('allowed_schemes' => array('http', 'https'));
971 if (Validate::uri($url, $opts)) {
975 return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
979 * Fetch, or build if necessary, an Ostatus_profile for the actor
980 * in a given Activity Streams activity.
982 * @param Activity $activity
983 * @param string $feeduri if we already know the canonical feed URI!
984 * @param string $salmonuri if we already know the salmon return channel URI
985 * @return Ostatus_profile
988 public static function ensureActorProfile($activity, $hints=array())
990 return self::ensureActivityObjectProfile($activity->actor, $hints);
993 public static function ensureActivityObjectProfile($object, $hints=array())
995 $profile = self::getActivityObjectProfile($object);
997 $profile->updateFromActivityObject($object, $hints);
999 $profile = self::createActivityObjectProfile($object, $hints);
1005 * @param Activity $activity
1006 * @return mixed matching Ostatus_profile or false if none known
1008 public static function getActorProfile($activity)
1010 return self::getActivityObjectProfile($activity->actor);
1013 protected static function getActivityObjectProfile($object)
1015 $uri = self::getActivityObjectProfileURI($object);
1016 return Ostatus_profile::staticGet('uri', $uri);
1019 protected static function getActorProfileURI($activity)
1021 return self::getActivityObjectProfileURI($activity->actor);
1025 * @param Activity $activity
1027 * @throws ServerException
1029 protected static function getActivityObjectProfileURI($object)
1031 $opts = array('allowed_schemes' => array('http', 'https'));
1032 if ($object->id && Validate::uri($object->id, $opts)) {
1035 if ($object->link && Validate::uri($object->link, $opts)) {
1036 return $object->link;
1038 throw new ServerException("No author ID URI found");
1042 * @fixme validate stuff somewhere
1046 * Create local ostatus_profile and profile/user_group entries for
1047 * the provided remote user or group.
1049 * @param ActivityObject $object
1050 * @param array $hints
1052 * @return Ostatus_profile
1054 protected static function createActivityObjectProfile($object, $hints=array())
1056 $homeuri = $object->id;
1060 common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1061 throw new Exception("No profile URI");
1064 if (OStatusPlugin::localProfileFromUrl($homeuri)) {
1065 throw new Exception("Local user can't be referenced as remote.");
1068 if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1069 throw new Exception("Local group can't be referenced as remote.");
1072 if (array_key_exists('feedurl', $hints)) {
1073 $feeduri = $hints['feedurl'];
1075 $discover = new FeedDiscovery();
1076 $feeduri = $discover->discoverFromURL($homeuri);
1079 if (array_key_exists('salmon', $hints)) {
1080 $salmonuri = $hints['salmon'];
1083 $discover = new FeedDiscovery();
1084 $discover->discoverFromFeedURL($hints['feedurl']);
1086 $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1089 if (array_key_exists('hub', $hints)) {
1090 $huburi = $hints['hub'];
1093 $discover = new FeedDiscovery();
1094 $discover->discoverFromFeedURL($hints['feedurl']);
1096 $huburi = $discover->getAtomLink('hub');
1100 // We can only deal with folks with a PuSH hub
1101 throw new FeedSubNoHubException();
1104 $oprofile = new Ostatus_profile();
1106 $oprofile->uri = $homeuri;
1107 $oprofile->feeduri = $feeduri;
1108 $oprofile->salmonuri = $salmonuri;
1110 $oprofile->created = common_sql_now();
1111 $oprofile->modified = common_sql_now();
1113 if ($object->type == ActivityObject::PERSON) {
1114 $profile = new Profile();
1115 $profile->created = common_sql_now();
1116 self::updateProfile($profile, $object, $hints);
1118 $oprofile->profile_id = $profile->insert();
1119 if (!$oprofile->profile_id) {
1120 throw new ServerException("Can't save local profile");
1123 $group = new User_group();
1124 $group->uri = $homeuri;
1125 $group->created = common_sql_now();
1126 self::updateGroup($group, $object, $hints);
1128 $oprofile->group_id = $group->insert();
1129 if (!$oprofile->group_id) {
1130 throw new ServerException("Can't save local profile");
1134 $ok = $oprofile->insert();
1137 $avatar = self::getActivityObjectAvatar($object, $hints);
1139 $oprofile->updateAvatar($avatar);
1143 throw new ServerException("Can't save OStatus profile");
1148 * Save any updated profile information to our local copy.
1149 * @param ActivityObject $object
1150 * @param array $hints
1152 public function updateFromActivityObject($object, $hints=array())
1154 if ($this->isGroup()) {
1155 $group = $this->localGroup();
1156 self::updateGroup($group, $object, $hints);
1158 $profile = $this->localProfile();
1159 self::updateProfile($profile, $object, $hints);
1161 $avatar = self::getActivityObjectAvatar($object, $hints);
1163 $this->updateAvatar($avatar);
1167 protected static function updateProfile($profile, $object, $hints=array())
1169 $orig = clone($profile);
1171 $profile->nickname = self::getActivityObjectNickname($object, $hints);
1173 if (!empty($object->title)) {
1174 $profile->fullname = $object->title;
1175 } else if (array_key_exists('fullname', $hints)) {
1176 $profile->fullname = $hints['fullname'];
1179 if (!empty($object->link)) {
1180 $profile->profileurl = $object->link;
1181 } else if (array_key_exists('profileurl', $hints)) {
1182 $profile->profileurl = $hints['profileurl'];
1183 } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1184 $profile->profileurl = $object->id;
1187 $profile->bio = self::getActivityObjectBio($object, $hints);
1188 $profile->location = self::getActivityObjectLocation($object, $hints);
1189 $profile->homepage = self::getActivityObjectHomepage($object, $hints);
1191 if (!empty($object->geopoint)) {
1192 $location = ActivityContext::locationFromPoint($object->geopoint);
1193 if (!empty($location)) {
1194 $profile->lat = $location->lat;
1195 $profile->lon = $location->lon;
1199 // @fixme tags/categories
1200 // @todo tags from categories
1203 common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1204 $profile->update($orig);
1208 protected static function updateGroup($group, $object, $hints=array())
1210 $orig = clone($group);
1212 $group->nickname = self::getActivityObjectNickname($object, $hints);
1213 $group->fullname = $object->title;
1215 if (!empty($object->link)) {
1216 $group->mainpage = $object->link;
1217 } else if (array_key_exists('profileurl', $hints)) {
1218 $group->mainpage = $hints['profileurl'];
1221 // @todo tags from categories
1222 $group->description = self::getActivityObjectBio($object, $hints);
1223 $group->location = self::getActivityObjectLocation($object, $hints);
1224 $group->homepage = self::getActivityObjectHomepage($object, $hints);
1227 common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1228 $group->update($orig);
1232 protected static function getActivityObjectHomepage($object, $hints=array())
1235 $poco = $object->poco;
1237 if (!empty($poco)) {
1238 $url = $poco->getPrimaryURL();
1239 if ($url && $url->type == 'homepage') {
1240 $homepage = $url->value;
1244 // @todo Try for a another PoCo URL?
1249 protected static function getActivityObjectLocation($object, $hints=array())
1253 if (!empty($object->poco) &&
1254 isset($object->poco->address->formatted)) {
1255 $location = $object->poco->address->formatted;
1256 } else if (array_key_exists('location', $hints)) {
1257 $location = $hints['location'];
1260 if (!empty($location)) {
1261 if (mb_strlen($location) > 255) {
1262 $location = mb_substr($note, 0, 255 - 3) . ' … ';
1266 // @todo Try to find location some othe way? Via goerss point?
1271 protected static function getActivityObjectBio($object, $hints=array())
1275 if (!empty($object->poco)) {
1276 $note = $object->poco->note;
1277 } else if (array_key_exists('bio', $hints)) {
1278 $note = $hints['bio'];
1281 if (!empty($note)) {
1282 if (Profile::bioTooLong($note)) {
1283 // XXX: truncate ok?
1284 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' … ';
1290 // @todo Try to get bio info some other way?
1295 protected static function getActivityObjectNickname($object, $hints=array())
1297 if ($object->poco) {
1298 if (!empty($object->poco->preferredUsername)) {
1299 return common_nicknamize($object->poco->preferredUsername);
1303 if (!empty($object->nickname)) {
1304 return common_nicknamize($object->nickname);
1307 if (array_key_exists('nickname', $hints)) {
1308 return $hints['nickname'];
1311 // Try the definitive ID
1313 $nickname = self::nicknameFromURI($object->id);
1315 // Try a Webfinger if one was passed (way) down
1317 if (empty($nickname)) {
1318 if (array_key_exists('webfinger', $hints)) {
1319 $nickname = self::nicknameFromURI($hints['webfinger']);
1325 if (empty($nickname)) {
1326 $nickname = common_nicknamize($object->title);
1332 protected static function nicknameFromURI($uri)
1334 preg_match('/(\w+):/', $uri, $matches);
1336 $protocol = $matches[1];
1338 switch ($protocol) {
1341 if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1342 return common_canonical_nickname($matches[1]);
1346 return common_url_to_nickname($uri);
1354 * @param string $addr webfinger address
1355 * @return Ostatus_profile
1356 * @throws Exception on error conditions
1358 public static function ensureWebfinger($addr)
1360 // First, try the cache
1362 $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1364 if ($uri !== false) {
1365 if (is_null($uri)) {
1366 // Negative cache entry
1367 throw new Exception('Not a valid webfinger address.');
1369 $oprofile = Ostatus_profile::staticGet('uri', $uri);
1370 if (!empty($oprofile)) {
1375 // Try looking it up
1377 $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1379 if (!empty($oprofile)) {
1380 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1384 // Now, try some discovery
1386 $disco = new Discovery();
1389 $xrd = $disco->lookup($addr);
1390 } catch (Exception $e) {
1391 // Save negative cache entry so we don't waste time looking it up again.
1392 // @fixme distinguish temporary failures?
1393 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1394 throw new Exception('Not a valid webfinger address.');
1397 $hints = array('webfinger' => $addr);
1399 $dhints = DiscoveryHints::fromXRD($xrd);
1401 $hints = array_merge($hints, $dhints);
1403 // If there's an Hcard, let's grab its info
1405 if (array_key_exists('hcard', $hints)) {
1406 if (!array_key_exists('profileurl', $hints) ||
1407 $hints['hcard'] != $hints['profileurl']) {
1408 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1409 $hints = array_merge($hcardHints, $hints);
1413 // If we got a feed URL, try that
1415 if (array_key_exists('feedurl', $hints)) {
1417 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1418 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
1419 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1421 } catch (Exception $e) {
1422 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1427 // If we got a profile page, try that!
1429 if (array_key_exists('profileurl', $hints)) {
1431 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1432 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
1433 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1435 } catch (Exception $e) {
1436 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1444 if (array_key_exists('salmon', $hints)) {
1446 $salmonEndpoint = $hints['salmon'];
1448 // An account URL, a salmon endpoint, and a dream? Not much to go
1449 // on, but let's give it a try
1451 $uri = 'acct:'.$addr;
1453 $profile = new Profile();
1455 $profile->nickname = self::nicknameFromUri($uri);
1456 $profile->created = common_sql_now();
1458 if (isset($profileUrl)) {
1459 $profile->profileurl = $profileUrl;
1462 $profile_id = $profile->insert();
1465 common_log_db_error($profile, 'INSERT', __FILE__);
1466 throw new Exception("Couldn't save profile for '$addr'");
1469 $oprofile = new Ostatus_profile();
1471 $oprofile->uri = $uri;
1472 $oprofile->salmonuri = $salmonEndpoint;
1473 $oprofile->profile_id = $profile_id;
1474 $oprofile->created = common_sql_now();
1476 if (isset($feedUrl)) {
1477 $profile->feeduri = $feedUrl;
1480 $result = $oprofile->insert();
1483 common_log_db_error($oprofile, 'INSERT', __FILE__);
1484 throw new Exception("Couldn't save ostatus_profile for '$addr'");
1487 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1491 throw new Exception("Couldn't find a valid profile for '$addr'");
1495 * Store the full-length scrubbed HTML of a remote notice to an attachment
1496 * file on our server. We'll link to this at the end of the cropped version.
1498 * @param string $title plaintext for HTML page's title
1499 * @param string $rendered HTML fragment for HTML page's body
1502 function saveHTMLFile($title, $rendered)
1504 $final = sprintf("<!DOCTYPE html>\n<html><head><title>%s</title></head>".
1505 '<body>%s</body></html>',
1506 htmlspecialchars($title),
1509 $filename = File::filename($this->localProfile(),
1510 'ostatus', // ignored?
1513 $filepath = File::path($filename);
1515 file_put_contents($filepath, $final);
1519 $file->filename = $filename;
1520 $file->url = File::url($filename);
1521 $file->size = filesize($filepath);
1522 $file->date = time();
1523 $file->mimetype = 'text/html';
1525 $file_id = $file->insert();
1527 if ($file_id === false) {
1528 common_log_db_error($file, "INSERT", __FILE__);
1529 throw new ServerException(_('Could not store HTML content of long post as file.'));