]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OStatus/classes/Ostatus_profile.php
ID is a string
[quix0rs-gnu-social.git] / plugins / OStatus / classes / Ostatus_profile.php
1 <?php
2 /*
3  * StatusNet - the distributed open-source microblogging tool
4  * Copyright (C) 2009-2010, StatusNet, Inc.
5  *
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.
10  *
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.
15  *
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/>.
18  */
19
20 if (!defined('STATUSNET')) {
21     exit(1);
22 }
23
24 /**
25  * @package OStatusPlugin
26  * @maintainer Brion Vibber <brion@status.net>
27  */
28
29 class Ostatus_profile extends Managed_DataObject
30 {
31     public $__table = 'ostatus_profile';
32
33     public $uri;
34
35     public $profile_id;
36     public $group_id;
37     public $peopletag_id;
38
39     public $feeduri;
40     public $salmonuri;
41     public $avatar; // remote URL of the last avatar we saved
42
43     public $created;
44     public $modified;
45
46     public /*static*/ function staticGet($k, $v=null)
47     {
48         return parent::staticGet(__CLASS__, $k, $v);
49     }
50
51     /**
52      * Return table definition for Schema setup and DB_DataObject usage.
53      *
54      * @return array array of column definitions
55      */
56     static function schemaDef()
57     {
58         return array(
59             'fields' => array(
60                 'uri' => array('type' => 'varchar', 'length' => 255, 'not null' => true),
61                 'profile_id' => array('type' => 'integer'),
62                 'group_id' => array('type' => 'integer'),
63                 'peopletag_id' => array('type' => 'integer'),
64                 'feeduri' => array('type' => 'varchar', 'length' => 255),
65                 'salmonuri' => array('type' => 'varchar', 'length' => 255),
66                 'avatar' => array('type' => 'text'),
67                 'created' => array('type' => 'datetime', 'not null' => true),
68                 'modified' => array('type' => 'datetime', 'not null' => true),
69             ),
70             'primary key' => array('uri'),
71             'unique keys' => array(
72                 'ostatus_profile_profile_id_idx' => array('profile_id'),
73                 'ostatus_profile_group_id_idx' => array('group_id'),
74                 'ostatus_profile_peopletag_id_idx' => array('peopletag_id'),
75                 'ostatus_profile_feeduri_idx' => array('feeduri'),
76             ),
77             'foreign keys' => array(
78                 'ostatus_profile_profile_id_fkey' => array('profile', array('profile_id' => 'id')),
79                 'ostatus_profile_group_id_fkey' => array('user_group', array('group_id' => 'id')),
80                 'ostatus_profile_peopletag_id_fkey' => array('profile_list', array('peopletag_id' => 'id')),
81             ),
82         );
83     }
84
85     /**
86      * Fetch the StatusNet-side profile for this feed
87      * @return Profile
88      */
89     public function localProfile()
90     {
91         if ($this->profile_id) {
92             return Profile::staticGet('id', $this->profile_id);
93         }
94         return null;
95     }
96
97     /**
98      * Fetch the StatusNet-side profile for this feed
99      * @return Profile
100      */
101     public function localGroup()
102     {
103         if ($this->group_id) {
104             return User_group::staticGet('id', $this->group_id);
105         }
106         return null;
107     }
108
109     /**
110      * Fetch the StatusNet-side peopletag for this feed
111      * @return Profile
112      */
113     public function localPeopletag()
114     {
115         if ($this->peopletag_id) {
116             return Profile_list::staticGet('id', $this->peopletag_id);
117         }
118         return null;
119     }
120
121     /**
122      * Returns an ActivityObject describing this remote user or group profile.
123      * Can then be used to generate Atom chunks.
124      *
125      * @return ActivityObject
126      */
127     function asActivityObject()
128     {
129         if ($this->isGroup()) {
130             return ActivityObject::fromGroup($this->localGroup());
131         } else if ($this->isPeopletag()) {
132             return ActivityObject::fromPeopletag($this->localPeopletag());
133         } else {
134             return ActivityObject::fromProfile($this->localProfile());
135         }
136     }
137
138     /**
139      * Returns an XML string fragment with profile information as an
140      * Activity Streams noun object with the given element type.
141      *
142      * Assumes that 'activity' namespace has been previously defined.
143      *
144      * @fixme replace with wrappers on asActivityObject when it's got everything.
145      *
146      * @param string $element one of 'actor', 'subject', 'object', 'target'
147      * @return string
148      */
149     function asActivityNoun($element)
150     {
151         if ($this->isGroup()) {
152             $noun = ActivityObject::fromGroup($this->localGroup());
153             return $noun->asString('activity:' . $element);
154         } else if ($this->isPeopletag()) {
155             $noun = ActivityObject::fromPeopletag($this->localPeopletag());
156             return $noun->asString('activity:' . $element);
157         } else {
158             $noun = ActivityObject::fromProfile($this->localProfile());
159             return $noun->asString('activity:' . $element);
160         }
161     }
162
163     /**
164      * @return boolean true if this is a remote group
165      */
166     function isGroup()
167     {
168         if ($this->profile_id || $this->peopletag_id && !$this->group_id) {
169             return false;
170         } else if ($this->group_id && !$this->profile_id && !$this->peopletag_id) {
171             return true;
172         } else if ($this->group_id && ($this->profile_id || $this->peopletag_id)) {
173             // TRANS: Server exception. %s is a URI
174             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->uri));
175         } else {
176             // TRANS: Server exception. %s is a URI
177             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->uri));
178         }
179     }
180
181     /**
182      * @return boolean true if this is a remote peopletag
183      */
184     function isPeopletag()
185     {
186         if ($this->profile_id || $this->group_id && !$this->peopletag_id) {
187             return false;
188         } else if ($this->peopletag_id && !$this->profile_id && !$this->group_id) {
189             return true;
190         } else if ($this->peopletag_id && ($this->profile_id || $this->group_id)) {
191             // TRANS: Server exception. %s is a URI
192             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: Two or more IDs set for %s.'), $this->uri));
193         } else {
194             // TRANS: Server exception. %s is a URI
195             throw new ServerException(sprintf(_m('Invalid ostatus_profile state: All IDs empty for %s.'), $this->uri));
196         }
197     }
198
199     /**
200      * Send a subscription request to the hub for this feed.
201      * The hub will later send us a confirmation POST to /main/push/callback.
202      *
203      * @return bool true on success, false on failure
204      * @throws ServerException if feed state is not valid
205      */
206     public function subscribe()
207     {
208         $feedsub = FeedSub::ensureFeed($this->feeduri);
209         if ($feedsub->sub_state == 'active') {
210             // Active subscription, we don't need to do anything.
211             return true;
212         } else {
213             // Inactive or we got left in an inconsistent state.
214             // Run a subscription request to make sure we're current!
215             return $feedsub->subscribe();
216         }
217     }
218
219     /**
220      * Check if this remote profile has any active local subscriptions, and
221      * if not drop the PuSH subscription feed.
222      *
223      * @return bool true on success, false on failure
224      */
225     public function unsubscribe() {
226         $this->garbageCollect();
227     }
228
229     /**
230      * Check if this remote profile has any active local subscriptions, and
231      * if not drop the PuSH subscription feed.
232      *
233      * @return boolean
234      */
235     public function garbageCollect()
236     {
237         $feedsub = FeedSub::staticGet('uri', $this->feeduri);
238         return $feedsub->garbageCollect();
239     }
240
241     /**
242      * Check if this remote profile has any active local subscriptions, so the
243      * PuSH subscription layer can decide if it can drop the feed.
244      *
245      * This gets called via the FeedSubSubscriberCount event when running
246      * FeedSub::garbageCollect().
247      *
248      * @return int
249      */
250     public function subscriberCount()
251     {
252         if ($this->isGroup()) {
253             $members = $this->localGroup()->getMembers(0, 1);
254             $count = $members->N;
255         } else if ($this->isPeopletag()) {
256             $subscribers = $this->localPeopletag()->getSubscribers(0, 1);
257             $count = $subscribers->N;
258         } else {
259             $profile = $this->localProfile();
260             $count = $profile->subscriberCount();
261             if ($profile->hasLocalTags()) {
262                 $count = 1;
263             }
264         }
265         common_log(LOG_INFO, __METHOD__ . " SUB COUNT BEFORE: $count");
266
267         // Other plugins may be piggybacking on OStatus without having
268         // an active group or user-to-user subscription we know about.
269         Event::handle('Ostatus_profileSubscriberCount', array($this, &$count));
270         common_log(LOG_INFO, __METHOD__ . " SUB COUNT AFTER: $count");
271
272         return $count;
273     }
274
275     /**
276      * Send an Activity Streams notification to the remote Salmon endpoint,
277      * if so configured.
278      *
279      * @param Profile $actor  Actor who did the activity
280      * @param string  $verb   Activity::SUBSCRIBE or Activity::JOIN
281      * @param Object  $object object of the action; must define asActivityNoun($tag)
282      */
283     public function notify($actor, $verb, $object=null, $target=null)
284     {
285         if (!($actor instanceof Profile)) {
286             $type = gettype($actor);
287             if ($type == 'object') {
288                 $type = get_class($actor);
289             }
290             // TRANS: Server exception.
291             // TRANS: %1$s is the method name the exception occured in, %2$s is the actor type.
292             throw new ServerException(sprintf(_m('Invalid actor passed to %1$s: %2$s.'),__METHOD__,$type));
293         }
294         if ($object == null) {
295             $object = $this;
296         }
297         if ($this->salmonuri) {
298             $text = 'update';
299             $id = TagURI::mint('%s:%s:%s',
300                                $verb,
301                                $actor->getURI(),
302                                common_date_iso8601(time()));
303
304             // @fixme consolidate all these NS settings somewhere
305             $attributes = array('xmlns' => Activity::ATOM,
306                                 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
307                                 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
308                                 'xmlns:georss' => 'http://www.georss.org/georss',
309                                 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0',
310                                 'xmlns:poco' => 'http://portablecontacts.net/spec/1.0',
311                                 'xmlns:media' => 'http://purl.org/syndication/atommedia');
312
313             $entry = new XMLStringer();
314             $entry->elementStart('entry', $attributes);
315             $entry->element('id', null, $id);
316             $entry->element('title', null, $text);
317             $entry->element('summary', null, $text);
318             $entry->element('published', null, common_date_w3dtf(common_sql_now()));
319
320             $entry->element('activity:verb', null, $verb);
321             $entry->raw($actor->asAtomAuthor());
322             $entry->raw($actor->asActivityActor());
323             $entry->raw($object->asActivityNoun('object'));
324             if ($target != null) {
325                 $entry->raw($target->asActivityNoun('target'));
326             }
327             $entry->elementEnd('entry');
328
329             $xml = $entry->getString();
330             common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
331
332             $salmon = new Salmon(); // ?
333             return $salmon->post($this->salmonuri, $xml, $actor);
334         }
335         return false;
336     }
337
338     /**
339      * Send a Salmon notification ping immediately, and confirm that we got
340      * an acceptable response from the remote site.
341      *
342      * @param mixed $entry XML string, Notice, or Activity
343      * @param Profile $actor
344      * @return boolean success
345      */
346     public function notifyActivity($entry, $actor)
347     {
348         if ($this->salmonuri) {
349             $salmon = new Salmon();
350             return $salmon->post($this->salmonuri, $this->notifyPrepXml($entry), $actor);
351         }
352
353         return false;
354     }
355
356     /**
357      * Queue a Salmon notification for later. If queues are disabled we'll
358      * send immediately but won't get the return value.
359      *
360      * @param mixed $entry XML string, Notice, or Activity
361      * @return boolean success
362      */
363     public function notifyDeferred($entry, $actor)
364     {
365         if ($this->salmonuri) {
366             $data = array('salmonuri' => $this->salmonuri,
367                           'entry' => $this->notifyPrepXml($entry),
368                           'actor' => $actor->id);
369
370             $qm = QueueManager::get();
371             return $qm->enqueue($data, 'salmon');
372         }
373
374         return false;
375     }
376
377     protected function notifyPrepXml($entry)
378     {
379         $preamble = '<?xml version="1.0" encoding="UTF-8" ?' . '>';
380         if (is_string($entry)) {
381             return $entry;
382         } else if ($entry instanceof Activity) {
383             return $preamble . $entry->asString(true);
384         } else if ($entry instanceof Notice) {
385             return $preamble . $entry->asAtomEntry(true, true);
386         } else {
387             // TRANS: Server exception.
388             throw new ServerException(_m('Invalid type passed to Ostatus_profile::notify. It must be XML string or Activity entry.'));
389         }
390     }
391
392     function getBestName()
393     {
394         if ($this->isGroup()) {
395             return $this->localGroup()->getBestName();
396         } else if ($this->isPeopletag()) {
397             return $this->localPeopletag()->getBestName();
398         } else {
399             return $this->localProfile()->getBestName();
400         }
401     }
402
403     /**
404      * Read and post notices for updates from the feed.
405      * Currently assumes that all items in the feed are new,
406      * coming from a PuSH hub.
407      *
408      * @param DOMDocument $doc
409      * @param string $source identifier ("push")
410      */
411     public function processFeed(DOMDocument $doc, $source)
412     {
413         $feed = $doc->documentElement;
414
415         if ($feed->localName == 'feed' && $feed->namespaceURI == Activity::ATOM) {
416             $this->processAtomFeed($feed, $source);
417         } else if ($feed->localName == 'rss') { // @fixme check namespace
418             $this->processRssFeed($feed, $source);
419         } else {
420             // TRANS: Exception.
421             throw new Exception(_m('Unknown feed format.'));
422         }
423     }
424
425     public function processAtomFeed(DOMElement $feed, $source)
426     {
427         $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
428         if ($entries->length == 0) {
429             common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
430             return;
431         }
432
433         for ($i = 0; $i < $entries->length; $i++) {
434             $entry = $entries->item($i);
435             $this->processEntry($entry, $feed, $source);
436         }
437     }
438
439     public function processRssFeed(DOMElement $rss, $source)
440     {
441         $channels = $rss->getElementsByTagName('channel');
442
443         if ($channels->length == 0) {
444             // TRANS: Exception.
445             throw new Exception(_m('RSS feed without a channel.'));
446         } else if ($channels->length > 1) {
447             common_log(LOG_WARNING, __METHOD__ . ": more than one channel in an RSS feed");
448         }
449
450         $channel = $channels->item(0);
451
452         $items = $channel->getElementsByTagName('item');
453
454         for ($i = 0; $i < $items->length; $i++) {
455             $item = $items->item($i);
456             $this->processEntry($item, $channel, $source);
457         }
458     }
459
460     /**
461      * Process a posted entry from this feed source.
462      *
463      * @param DOMElement $entry
464      * @param DOMElement $feed for context
465      * @param string $source identifier ("push" or "salmon")
466      */
467     public function processEntry($entry, $feed, $source)
468     {
469         $activity = new Activity($entry, $feed);
470         $this->processActivity($activity, $source);
471     }
472
473     public function processActivity($activity, $source)
474     {
475         // The "WithProfile" events were added later.
476
477         if (Event::handle('StartHandleFeedEntryWithProfile', array($activity, $this)) &&
478             Event::handle('StartHandleFeedEntry', array($activity))) {
479
480             switch ($activity->verb) {
481             case ActivityVerb::POST:
482                 // @todo process all activity objects
483                 switch ($activity->objects[0]->type) {
484                 case ActivityObject::ARTICLE:
485                 case ActivityObject::BLOGENTRY:
486                 case ActivityObject::NOTE:
487                 case ActivityObject::STATUS:
488                 case ActivityObject::COMMENT:
489                 case null:
490                     $this->processPost($activity, $source);
491                     break;
492                 default:
493                     // TRANS: Client exception.
494                     throw new ClientException(_m('Cannot handle that kind of post.'));
495                 }
496                 break;
497             case ActivityVerb::SHARE:
498                 $result = $this->processShare($activity, $source);
499                 break;
500             default:
501                 common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
502             }
503
504             Event::handle('EndHandleFeedEntry', array($activity));
505             Event::handle('EndHandleFeedEntryWithProfile', array($activity, $this));
506         }
507     }
508
509     public function processShare($activity, $method)
510     {
511         $oprofile = $this->checkAuthorship($activity);
512
513         if (empty($oprofile)) {
514             common_log(LOG_INFO, "No author matched share activity");
515             return false;
516         }
517
518         if (count($activity->objects) != 1) {
519             throw new ClientException(_m("Can only handle share activities with exactly one object."));
520         }
521
522         $shared = $activity->objects[0];
523
524         if (!($shared instanceof Activity)) {
525             throw new ClientException(_m("Can only handle shared activities."));
526         }
527
528         $other = Ostatus_profile::ensureActivityObjectProfile($shared->actor);
529
530         // Save the item (or check for a dupe)
531
532         $other->processActivity($shared, $method);
533         
534         // XXX: process*() should return the new or existing notice. They don't, so we have to
535         // go fishing for it now.
536
537         $sharedId = ($shared->id) ? $shared->id : $shared->objects[0]->id;
538
539         $sharedNotice = Notice::staticGet('uri', $sharedId);
540
541         if (empty($sharedNotice)) {
542             throw new ClientException(sprintf(_m("Failed to save activity %s"),
543                                               $sharedId));
544         }
545
546         // The id URI will be used as a unique identifier for for the notice,
547         // protecting against duplicate saves. It isn't required to be a URL;
548         // tag: URIs for instance are found in Google Buzz feeds.
549
550         $sourceUri = $activity->id;
551
552         $dupe = Notice::staticGet('uri', $sourceUri);
553         if ($dupe) {
554             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
555             return false;
556         }
557
558         // We'll also want to save a web link to the original notice, if provided.
559
560         $sourceUrl = null;
561         if ($activity->link) {
562             $sourceUrl = $activity->link;
563         } else if ($activity->link) {
564             $sourceUrl = $activity->link;
565         } else if (preg_match('!^https?://!', $activity->id)) {
566             $sourceUrl = $activity->id;
567         }
568
569         // Use summary as fallback for content
570
571         if (!empty($activity->content)) {
572             $sourceContent = $activity->content;
573         } else if (!empty($activity->summary)) {
574             $sourceContent = $activity->summary;
575         } else if (!empty($activity->title)) {
576             $sourceContent = $activity->title;
577         } else {
578             // @fixme fetch from $sourceUrl?
579             // TRANS: Client exception. %s is a source URI.
580             throw new ClientException(sprintf(_m('No content for notice %s.'),$sourceUri));
581         }
582
583         // Get (safe!) HTML and text versions of the content
584
585         $rendered = $this->purify($sourceContent);
586         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
587
588         $shortened = common_shorten_links($content);
589
590         // If it's too long, try using the summary, and make the
591         // HTML an attachment.
592
593         $attachment = null;
594
595         if (Notice::contentTooLong($shortened)) {
596             $attachment = $this->saveHTMLFile($activity->title, $rendered);
597             $summary = html_entity_decode(strip_tags($activity->summary), ENT_QUOTES, 'UTF-8');
598             if (empty($summary)) {
599                 $summary = $content;
600             }
601             $shortSummary = common_shorten_links($summary);
602             if (Notice::contentTooLong($shortSummary)) {
603                 $url = common_shorten_url($sourceUrl);
604                 $shortSummary = substr($shortSummary,
605                                        0,
606                                        Notice::maxContent() - (mb_strlen($url) + 2));
607                 $content = $shortSummary . ' ' . $url;
608
609                 // We mark up the attachment link specially for the HTML output
610                 // so we can fold-out the full version inline.
611
612                 // @todo FIXME i18n: This tooltip will be saved with the site's default language
613                 // TRANS: Shown when a notice is longer than supported and/or when attachments are present. At runtime
614                 // TRANS: this will usually be replaced with localised text from StatusNet core messages.
615                 $showMoreText = _m('Show more');
616                 $attachUrl = common_local_url('attachment',
617                                               array('attachment' => $attachment->id));
618                 $rendered = common_render_text($shortSummary) .
619                             '<a href="' . htmlspecialchars($attachUrl) .'"'.
620                             ' class="attachment more"' .
621                             ' title="'. htmlspecialchars($showMoreText) . '">' .
622                             '&#8230;' .
623                             '</a>';
624             }
625         }
626
627         $options = array('is_local' => Notice::REMOTE,
628                          'url' => $sourceUrl,
629                          'uri' => $sourceUri,
630                          'rendered' => $rendered,
631                          'replies' => array(),
632                          'groups' => array(),
633                          'peopletags' => array(),
634                          'tags' => array(),
635                          'urls' => array(),
636                          'repeat_of' => $sharedNotice->id,
637                          'scope' => $sharedNotice->scope);
638
639         // Check for optional attributes...
640
641         if (!empty($activity->time)) {
642             $options['created'] = common_sql_date($activity->time);
643         }
644
645         if ($activity->context) {
646             // Any individual or group attn: targets?
647             $replies = $activity->context->attention;
648             $options['groups'] = $this->filterReplies($oprofile, $replies);
649             $options['replies'] = $replies;
650
651             // Maintain direct reply associations
652             // @fixme what about conversation ID?
653             if (!empty($activity->context->replyToID)) {
654                 $orig = Notice::staticGet('uri',
655                                           $activity->context->replyToID);
656                 if (!empty($orig)) {
657                     $options['reply_to'] = $orig->id;
658                 }
659             }
660
661             $location = $activity->context->location;
662             if ($location) {
663                 $options['lat'] = $location->lat;
664                 $options['lon'] = $location->lon;
665                 if ($location->location_id) {
666                     $options['location_ns'] = $location->location_ns;
667                     $options['location_id'] = $location->location_id;
668                 }
669             }
670         }
671
672         if ($this->isPeopletag()) {
673             $options['peopletags'][] = $this->localPeopletag();
674         }
675
676         // Atom categories <-> hashtags
677         foreach ($activity->categories as $cat) {
678             if ($cat->term) {
679                 $term = common_canonical_tag($cat->term);
680                 if ($term) {
681                     $options['tags'][] = $term;
682                 }
683             }
684         }
685
686         // Atom enclosures -> attachment URLs
687         foreach ($activity->enclosures as $href) {
688             // @fixme save these locally or....?
689             $options['urls'][] = $href;
690         }
691
692         return Notice::saveNew($oprofile->profile_id,
693                                $content,
694                                'ostatus',
695                                $content);
696     }
697
698     /**
699      * Process an incoming post activity from this remote feed.
700      * @param Activity $activity
701      * @param string $method 'push' or 'salmon'
702      * @return mixed saved Notice or false
703      * @fixme break up this function, it's getting nasty long
704      */
705     public function processPost($activity, $method)
706     {
707         $oprofile = $this->checkAuthorship($activity);
708
709         if (empty($oprofile)) {
710             return false;
711         }
712
713         // It's not always an ActivityObject::NOTE, but... let's just say it is.
714
715         $note = $activity->objects[0];
716
717         // The id URI will be used as a unique identifier for for the notice,
718         // protecting against duplicate saves. It isn't required to be a URL;
719         // tag: URIs for instance are found in Google Buzz feeds.
720         $sourceUri = $note->id;
721         $dupe = Notice::staticGet('uri', $sourceUri);
722         if ($dupe) {
723             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
724             return false;
725         }
726
727         // We'll also want to save a web link to the original notice, if provided.
728         $sourceUrl = null;
729         if ($note->link) {
730             $sourceUrl = $note->link;
731         } else if ($activity->link) {
732             $sourceUrl = $activity->link;
733         } else if (preg_match('!^https?://!', $note->id)) {
734             $sourceUrl = $note->id;
735         }
736
737         // Use summary as fallback for content
738
739         if (!empty($note->content)) {
740             $sourceContent = $note->content;
741         } else if (!empty($note->summary)) {
742             $sourceContent = $note->summary;
743         } else if (!empty($note->title)) {
744             $sourceContent = $note->title;
745         } else {
746             // @fixme fetch from $sourceUrl?
747             // TRANS: Client exception. %s is a source URI.
748             throw new ClientException(sprintf(_m('No content for notice %s.'),$sourceUri));
749         }
750
751         // Get (safe!) HTML and text versions of the content
752
753         $rendered = $this->purify($sourceContent);
754         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
755
756         $shortened = common_shorten_links($content);
757
758         // If it's too long, try using the summary, and make the
759         // HTML an attachment.
760
761         $attachment = null;
762
763         if (Notice::contentTooLong($shortened)) {
764             $attachment = $this->saveHTMLFile($note->title, $rendered);
765             $summary = html_entity_decode(strip_tags($note->summary), ENT_QUOTES, 'UTF-8');
766             if (empty($summary)) {
767                 $summary = $content;
768             }
769             $shortSummary = common_shorten_links($summary);
770             if (Notice::contentTooLong($shortSummary)) {
771                 $url = common_shorten_url($sourceUrl);
772                 $shortSummary = substr($shortSummary,
773                                        0,
774                                        Notice::maxContent() - (mb_strlen($url) + 2));
775                 $content = $shortSummary . ' ' . $url;
776
777                 // We mark up the attachment link specially for the HTML output
778                 // so we can fold-out the full version inline.
779
780                 // @todo FIXME i18n: This tooltip will be saved with the site's default language
781                 // TRANS: Shown when a notice is longer than supported and/or when attachments are present. At runtime
782                 // TRANS: this will usually be replaced with localised text from StatusNet core messages.
783                 $showMoreText = _m('Show more');
784                 $attachUrl = common_local_url('attachment',
785                                               array('attachment' => $attachment->id));
786                 $rendered = common_render_text($shortSummary) .
787                             '<a href="' . htmlspecialchars($attachUrl) .'"'.
788                             ' class="attachment more"' .
789                             ' title="'. htmlspecialchars($showMoreText) . '">' .
790                             '&#8230;' .
791                             '</a>';
792             }
793         }
794
795         $options = array('is_local' => Notice::REMOTE,
796                         'url' => $sourceUrl,
797                         'uri' => $sourceUri,
798                         'rendered' => $rendered,
799                         'replies' => array(),
800                         'groups' => array(),
801                         'peopletags' => array(),
802                         'tags' => array(),
803                         'urls' => array());
804
805         // Check for optional attributes...
806
807         if (!empty($activity->time)) {
808             $options['created'] = common_sql_date($activity->time);
809         }
810
811         if ($activity->context) {
812             // Any individual or group attn: targets?
813             $replies = $activity->context->attention;
814             $options['groups'] = $this->filterReplies($oprofile, $replies);
815             $options['replies'] = $replies;
816
817             // Maintain direct reply associations
818             // @fixme what about conversation ID?
819             if (!empty($activity->context->replyToID)) {
820                 $orig = Notice::staticGet('uri',
821                                           $activity->context->replyToID);
822                 if (!empty($orig)) {
823                     $options['reply_to'] = $orig->id;
824                 }
825             }
826
827             $location = $activity->context->location;
828             if ($location) {
829                 $options['lat'] = $location->lat;
830                 $options['lon'] = $location->lon;
831                 if ($location->location_id) {
832                     $options['location_ns'] = $location->location_ns;
833                     $options['location_id'] = $location->location_id;
834                 }
835             }
836         }
837
838         if ($this->isPeopletag()) {
839             $options['peopletags'][] = $this->localPeopletag();
840         }
841
842         // Atom categories <-> hashtags
843         foreach ($activity->categories as $cat) {
844             if ($cat->term) {
845                 $term = common_canonical_tag($cat->term);
846                 if ($term) {
847                     $options['tags'][] = $term;
848                 }
849             }
850         }
851
852         // Atom enclosures -> attachment URLs
853         foreach ($activity->enclosures as $href) {
854             // @fixme save these locally or....?
855             $options['urls'][] = $href;
856         }
857
858         try {
859             $saved = Notice::saveNew($oprofile->profile_id,
860                                      $content,
861                                      'ostatus',
862                                      $options);
863             if ($saved) {
864                 Ostatus_source::saveNew($saved, $this, $method);
865                 if (!empty($attachment)) {
866                     File_to_post::processNew($attachment->id, $saved->id);
867                 }
868             }
869         } catch (Exception $e) {
870             common_log(LOG_ERR, "OStatus save of remote message $sourceUri failed: " . $e->getMessage());
871             throw $e;
872         }
873         common_log(LOG_INFO, "OStatus saved remote message $sourceUri as notice id $saved->id");
874         return $saved;
875     }
876
877     /**
878      * Clean up HTML
879      */
880     protected function purify($html)
881     {
882         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
883         $config = array('safe' => 1,
884                         'deny_attribute' => 'id,style,on*');
885         return htmLawed($html, $config);
886     }
887
888     /**
889      * Filters a list of recipient ID URIs to just those for local delivery.
890      * @param Ostatus_profile local profile of sender
891      * @param array in/out &$attention_uris set of URIs, will be pruned on output
892      * @return array of group IDs
893      */
894     protected function filterReplies($sender, &$attention_uris)
895     {
896         common_log(LOG_DEBUG, "Original reply recipients: " . implode(', ', $attention_uris));
897         $groups = array();
898         $replies = array();
899         foreach (array_unique($attention_uris) as $recipient) {
900             // Is the recipient a local user?
901             $user = User::staticGet('uri', $recipient);
902             if ($user) {
903                 // @fixme sender verification, spam etc?
904                 $replies[] = $recipient;
905                 continue;
906             }
907
908             // Is the recipient a local group?
909             // $group = User_group::staticGet('uri', $recipient);
910             $id = OStatusPlugin::localGroupFromUrl($recipient);
911             if ($id) {
912                 $group = User_group::staticGet('id', $id);
913                 if ($group) {
914                     // Deliver to all members of this local group if allowed.
915                     $profile = $sender->localProfile();
916                     if ($profile->isMember($group)) {
917                         $groups[] = $group->id;
918                     } else {
919                         common_log(LOG_DEBUG, "Skipping reply to local group $group->nickname as sender $profile->id is not a member");
920                     }
921                     continue;
922                 } else {
923                     common_log(LOG_DEBUG, "Skipping reply to bogus group $recipient");
924                 }
925             }
926
927             // Is the recipient a remote user or group?
928             try {
929                 $oprofile = Ostatus_profile::ensureProfileURI($recipient);
930                 if ($oprofile->isGroup()) {
931                     // Deliver to local members of this remote group.
932                     // @fixme sender verification?
933                     $groups[] = $oprofile->group_id;
934                 } else {
935                     // may be canonicalized or something
936                     $replies[] = $oprofile->uri;
937                 }
938                 continue;
939             } catch (Exception $e) {
940                 // Neither a recognizable local nor remote user!
941                 common_log(LOG_DEBUG, "Skipping reply to unrecognized profile $recipient: " . $e->getMessage());
942             }
943
944         }
945         $attention_uris = $replies;
946         common_log(LOG_DEBUG, "Local reply recipients: " . implode(', ', $replies));
947         common_log(LOG_DEBUG, "Local group recipients: " . implode(', ', $groups));
948         return $groups;
949     }
950
951     /**
952      * Look up and if necessary create an Ostatus_profile for the remote entity
953      * with the given profile page URL. This should never return null -- you
954      * will either get an object or an exception will be thrown.
955      *
956      * @param string $profile_url
957      * @return Ostatus_profile
958      * @throws Exception on various error conditions
959      * @throws OStatusShadowException if this reference would obscure a local user/group
960      */
961     public static function ensureProfileURL($profile_url, $hints=array())
962     {
963         $oprofile = self::getFromProfileURL($profile_url);
964
965         if (!empty($oprofile)) {
966             return $oprofile;
967         }
968
969         $hints['profileurl'] = $profile_url;
970
971         // Fetch the URL
972         // XXX: HTTP caching
973
974         $client = new HTTPClient();
975         $client->setHeader('Accept', 'text/html,application/xhtml+xml');
976         $response = $client->get($profile_url);
977
978         if (!$response->isOk()) {
979             // TRANS: Exception. %s is a profile URL.
980             throw new Exception(sprintf(_m('Could not reach profile page %s.'),$profile_url));
981         }
982
983         // Check if we have a non-canonical URL
984
985         $finalUrl = $response->getUrl();
986
987         if ($finalUrl != $profile_url) {
988
989             $hints['profileurl'] = $finalUrl;
990
991             $oprofile = self::getFromProfileURL($finalUrl);
992
993             if (!empty($oprofile)) {
994                 return $oprofile;
995             }
996         }
997
998         // Try to get some hCard data
999
1000         $body = $response->getBody();
1001
1002         $hcardHints = DiscoveryHints::hcardHints($body, $finalUrl);
1003
1004         if (!empty($hcardHints)) {
1005             $hints = array_merge($hints, $hcardHints);
1006         }
1007
1008         // Check if they've got an LRDD header
1009
1010         $lrdd = LinkHeader::getLink($response, 'lrdd', 'application/xrd+xml');
1011
1012         if (!empty($lrdd)) {
1013
1014             $xrd = Discovery::fetchXrd($lrdd);
1015             $xrdHints = DiscoveryHints::fromXRD($xrd);
1016
1017             $hints = array_merge($hints, $xrdHints);
1018         }
1019
1020         // If discovery found a feedurl (probably from LRDD), use it.
1021
1022         if (array_key_exists('feedurl', $hints)) {
1023             return self::ensureFeedURL($hints['feedurl'], $hints);
1024         }
1025
1026         // Get the feed URL from HTML
1027
1028         $discover = new FeedDiscovery();
1029
1030         $feedurl = $discover->discoverFromHTML($finalUrl, $body);
1031
1032         if (!empty($feedurl)) {
1033             $hints['feedurl'] = $feedurl;
1034             return self::ensureFeedURL($feedurl, $hints);
1035         }
1036
1037         // TRANS: Exception. %s is a URL.
1038         throw new Exception(sprintf(_m('Could not find a feed URL for profile page %s.'),$finalUrl));
1039     }
1040
1041     /**
1042      * Look up the Ostatus_profile, if present, for a remote entity with the
1043      * given profile page URL. Will return null for both unknown and invalid
1044      * remote profiles.
1045      *
1046      * @return mixed Ostatus_profile or null
1047      * @throws OStatusShadowException for local profiles
1048      */
1049     static function getFromProfileURL($profile_url)
1050     {
1051         $profile = Profile::staticGet('profileurl', $profile_url);
1052
1053         if (empty($profile)) {
1054             return null;
1055         }
1056
1057         // Is it a known Ostatus profile?
1058
1059         $oprofile = Ostatus_profile::staticGet('profile_id', $profile->id);
1060
1061         if (!empty($oprofile)) {
1062             return $oprofile;
1063         }
1064
1065         // Is it a local user?
1066
1067         $user = User::staticGet('id', $profile->id);
1068
1069         if (!empty($user)) {
1070             // @todo i18n FIXME: use sprintf and add i18n (?)
1071             throw new OStatusShadowException($profile, "'$profile_url' is the profile for local user '{$user->nickname}'.");
1072         }
1073
1074         // Continue discovery; it's a remote profile
1075         // for OMB or some other protocol, may also
1076         // support OStatus
1077
1078         return null;
1079     }
1080
1081     /**
1082      * Look up and if necessary create an Ostatus_profile for remote entity
1083      * with the given update feed. This should never return null -- you will
1084      * either get an object or an exception will be thrown.
1085      *
1086      * @return Ostatus_profile
1087      * @throws Exception
1088      */
1089     public static function ensureFeedURL($feed_url, $hints=array())
1090     {
1091         $discover = new FeedDiscovery();
1092
1093         $feeduri = $discover->discoverFromFeedURL($feed_url);
1094         $hints['feedurl'] = $feeduri;
1095
1096         $huburi = $discover->getHubLink();
1097         $hints['hub'] = $huburi;
1098         $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1099         $hints['salmon'] = $salmonuri;
1100
1101         if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
1102             // We can only deal with folks with a PuSH hub
1103             throw new FeedSubNoHubException();
1104         }
1105
1106         $feedEl = $discover->root;
1107
1108         if ($feedEl->tagName == 'feed') {
1109             return self::ensureAtomFeed($feedEl, $hints);
1110         } else if ($feedEl->tagName == 'channel') {
1111             return self::ensureRssChannel($feedEl, $hints);
1112         } else {
1113             throw new FeedSubBadXmlException($feeduri);
1114         }
1115     }
1116
1117     /**
1118      * Look up and, if necessary, create an Ostatus_profile for the remote
1119      * profile with the given Atom feed - actually loaded from the feed.
1120      * This should never return null -- you will either get an object or
1121      * an exception will be thrown.
1122      *
1123      * @param DOMElement $feedEl root element of a loaded Atom feed
1124      * @param array $hints additional discovery information passed from higher levels
1125      * @fixme should this be marked public?
1126      * @return Ostatus_profile
1127      * @throws Exception
1128      */
1129     public static function ensureAtomFeed($feedEl, $hints)
1130     {
1131         $author = ActivityUtils::getFeedAuthor($feedEl);
1132
1133         if (empty($author)) {
1134             // XXX: make some educated guesses here
1135             // TRANS: Feed sub exception.
1136             throw new FeedSubException(_m('Cannot find enough profile '.
1137                                           'information to make a feed.'));
1138         }
1139
1140         return self::ensureActivityObjectProfile($author, $hints);
1141     }
1142
1143     /**
1144      * Look up and, if necessary, create an Ostatus_profile for the remote
1145      * profile with the given RSS feed - actually loaded from the feed.
1146      * This should never return null -- you will either get an object or
1147      * an exception will be thrown.
1148      *
1149      * @param DOMElement $feedEl root element of a loaded RSS feed
1150      * @param array $hints additional discovery information passed from higher levels
1151      * @fixme should this be marked public?
1152      * @return Ostatus_profile
1153      * @throws Exception
1154      */
1155     public static function ensureRssChannel($feedEl, $hints)
1156     {
1157         // Special-case for Posterous. They have some nice metadata in their
1158         // posterous:author elements. We should use them instead of the channel.
1159
1160         $items = $feedEl->getElementsByTagName('item');
1161
1162         if ($items->length > 0) {
1163             $item = $items->item(0);
1164             $authorEl = ActivityUtils::child($item, ActivityObject::AUTHOR, ActivityObject::POSTEROUS);
1165             if (!empty($authorEl)) {
1166                 $obj = ActivityObject::fromPosterousAuthor($authorEl);
1167                 // Posterous has multiple authors per feed, and multiple feeds
1168                 // per author. We check if this is the "main" feed for this author.
1169                 if (array_key_exists('profileurl', $hints) &&
1170                     !empty($obj->poco) &&
1171                     common_url_to_nickname($hints['profileurl']) == $obj->poco->preferredUsername) {
1172                     return self::ensureActivityObjectProfile($obj, $hints);
1173                 }
1174             }
1175         }
1176
1177         // @fixme we should check whether this feed has elements
1178         // with different <author> or <dc:creator> elements, and... I dunno.
1179         // Do something about that.
1180
1181         $obj = ActivityObject::fromRssChannel($feedEl);
1182
1183         return self::ensureActivityObjectProfile($obj, $hints);
1184     }
1185
1186     /**
1187      * Download and update given avatar image
1188      *
1189      * @param string $url
1190      * @throws Exception in various failure cases
1191      */
1192     protected function updateAvatar($url)
1193     {
1194         if ($url == $this->avatar) {
1195             // We've already got this one.
1196             return;
1197         }
1198         if (!common_valid_http_url($url)) {
1199             // TRANS: Server exception. %s is a URL.
1200             throw new ServerException(sprintf(_m('Invalid avatar URL %s.'), $url));
1201         }
1202
1203         if ($this->isGroup()) {
1204             $self = $this->localGroup();
1205         } else {
1206             $self = $this->localProfile();
1207         }
1208         if (!$self) {
1209             throw new ServerException(sprintf(
1210                 // TRANS: Server exception. %s is a URI.
1211                 _m('Tried to update avatar for unsaved remote profile %s.'),
1212                 $this->uri));
1213         }
1214
1215         // @fixme this should be better encapsulated
1216         // ripped from oauthstore.php (for old OMB client)
1217         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
1218         try {
1219             if (!copy($url, $temp_filename)) {
1220                 // TRANS: Server exception. %s is a URL.
1221                 throw new ServerException(sprintf(_m('Unable to fetch avatar from %s.'), $url));
1222             }
1223
1224             if ($this->isGroup()) {
1225                 $id = $this->group_id;
1226             } else {
1227                 $id = $this->profile_id;
1228             }
1229             // @fixme should we be using different ids?
1230             $imagefile = new ImageFile($id, $temp_filename);
1231             $filename = Avatar::filename($id,
1232                                          image_type_to_extension($imagefile->type),
1233                                          null,
1234                                          common_timestamp());
1235             rename($temp_filename, Avatar::path($filename));
1236         } catch (Exception $e) {
1237             unlink($temp_filename);
1238             throw $e;
1239         }
1240         // @fixme hardcoded chmod is lame, but seems to be necessary to
1241         // keep from accidentally saving images from command-line (queues)
1242         // that can't be read from web server, which causes hard-to-notice
1243         // problems later on:
1244         //
1245         // http://status.net/open-source/issues/2663
1246         chmod(Avatar::path($filename), 0644);
1247
1248         $profile = $this->localProfile();
1249         
1250         if (!empty($profile)) {
1251             $profile->setOriginal($filename);
1252         }
1253
1254         $orig = clone($this);
1255         $this->avatar = $url;
1256         $this->update($orig);
1257     }
1258
1259     /**
1260      * Pull avatar URL from ActivityObject or profile hints
1261      *
1262      * @param ActivityObject $object
1263      * @param array $hints
1264      * @return mixed URL string or false
1265      */
1266     public static function getActivityObjectAvatar($object, $hints=array())
1267     {
1268         if ($object->avatarLinks) {
1269             $best = false;
1270             // Take the exact-size avatar, or the largest avatar, or the first avatar if all sizeless
1271             foreach ($object->avatarLinks as $avatar) {
1272                 if ($avatar->width == AVATAR_PROFILE_SIZE && $avatar->height = AVATAR_PROFILE_SIZE) {
1273                     // Exact match!
1274                     $best = $avatar;
1275                     break;
1276                 }
1277                 if (!$best || $avatar->width > $best->width) {
1278                     $best = $avatar;
1279                 }
1280             }
1281             return $best->url;
1282         } else if (array_key_exists('avatar', $hints)) {
1283             return $hints['avatar'];
1284         }
1285         return false;
1286     }
1287
1288     /**
1289      * Get an appropriate avatar image source URL, if available.
1290      *
1291      * @param ActivityObject $actor
1292      * @param DOMElement $feed
1293      * @return string
1294      */
1295     protected static function getAvatar($actor, $feed)
1296     {
1297         $url = '';
1298         $icon = '';
1299         if ($actor->avatar) {
1300             $url = trim($actor->avatar);
1301         }
1302         if (!$url) {
1303             // Check <atom:logo> and <atom:icon> on the feed
1304             $els = $feed->childNodes();
1305             if ($els && $els->length) {
1306                 for ($i = 0; $i < $els->length; $i++) {
1307                     $el = $els->item($i);
1308                     if ($el->namespaceURI == Activity::ATOM) {
1309                         if (empty($url) && $el->localName == 'logo') {
1310                             $url = trim($el->textContent);
1311                             break;
1312                         }
1313                         if (empty($icon) && $el->localName == 'icon') {
1314                             // Use as a fallback
1315                             $icon = trim($el->textContent);
1316                         }
1317                     }
1318                 }
1319             }
1320             if ($icon && !$url) {
1321                 $url = $icon;
1322             }
1323         }
1324         if ($url) {
1325             $opts = array('allowed_schemes' => array('http', 'https'));
1326             if (Validate::uri($url, $opts)) {
1327                 return $url;
1328             }
1329         }
1330
1331         return Plugin::staticPath('OStatus', 'images/96px-Feed-icon.svg.png');
1332     }
1333
1334     /**
1335      * Fetch, or build if necessary, an Ostatus_profile for the actor
1336      * in a given Activity Streams activity.
1337      * This should never return null -- you will either get an object or
1338      * an exception will be thrown.
1339      *
1340      * @param Activity $activity
1341      * @param string $feeduri if we already know the canonical feed URI!
1342      * @param string $salmonuri if we already know the salmon return channel URI
1343      * @return Ostatus_profile
1344      * @throws Exception
1345      */
1346     public static function ensureActorProfile($activity, $hints=array())
1347     {
1348         return self::ensureActivityObjectProfile($activity->actor, $hints);
1349     }
1350
1351     /**
1352      * Fetch, or build if necessary, an Ostatus_profile for the profile
1353      * in a given Activity Streams object (can be subject, actor, or object).
1354      * This should never return null -- you will either get an object or
1355      * an exception will be thrown.
1356      *
1357      * @param ActivityObject $object
1358      * @param array $hints additional discovery information passed from higher levels
1359      * @return Ostatus_profile
1360      * @throws Exception
1361      */
1362     public static function ensureActivityObjectProfile($object, $hints=array())
1363     {
1364         $profile = self::getActivityObjectProfile($object);
1365         if ($profile) {
1366             $profile->updateFromActivityObject($object, $hints);
1367         } else {
1368             $profile = self::createActivityObjectProfile($object, $hints);
1369         }
1370         return $profile;
1371     }
1372
1373     /**
1374      * @param Activity $activity
1375      * @return mixed matching Ostatus_profile or false if none known
1376      * @throws ServerException if feed info invalid
1377      */
1378     public static function getActorProfile($activity)
1379     {
1380         return self::getActivityObjectProfile($activity->actor);
1381     }
1382
1383     /**
1384      * @param ActivityObject $activity
1385      * @return mixed matching Ostatus_profile or false if none known
1386      * @throws ServerException if feed info invalid
1387      */
1388     protected static function getActivityObjectProfile($object)
1389     {
1390         $uri = self::getActivityObjectProfileURI($object);
1391         return Ostatus_profile::staticGet('uri', $uri);
1392     }
1393
1394     /**
1395      * Get the identifier URI for the remote entity described
1396      * by this ActivityObject. This URI is *not* guaranteed to be
1397      * a resolvable HTTP/HTTPS URL.
1398      *
1399      * @param ActivityObject $object
1400      * @return string
1401      * @throws ServerException if feed info invalid
1402      */
1403     protected static function getActivityObjectProfileURI($object)
1404     {
1405         if ($object->id) {
1406             if (ActivityUtils::validateUri($object->id)) {
1407                 return $object->id;
1408             }
1409         }
1410
1411         // If the id is missing or invalid (we've seen feeds mistakenly listing
1412         // things like local usernames in that field) then we'll use the profile
1413         // page link, if valid.
1414         if ($object->link && common_valid_http_url($object->link)) {
1415             return $object->link;
1416         }
1417         // TRANS: Server exception.
1418         throw new ServerException(_m('No author ID URI found.'));
1419     }
1420
1421     /**
1422      * @fixme validate stuff somewhere
1423      */
1424
1425     /**
1426      * Create local ostatus_profile and profile/user_group entries for
1427      * the provided remote user or group.
1428      * This should never return null -- you will either get an object or
1429      * an exception will be thrown.
1430      *
1431      * @param ActivityObject $object
1432      * @param array $hints
1433      *
1434      * @return Ostatus_profile
1435      */
1436     protected static function createActivityObjectProfile($object, $hints=array())
1437     {
1438         $homeuri = $object->id;
1439         $discover = false;
1440
1441         if (!$homeuri) {
1442             common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
1443             // TRANS: Exception.
1444             throw new Exception(_m('No profile URI.'));
1445         }
1446
1447         $user = User::staticGet('uri', $homeuri);
1448         if ($user) {
1449             // TRANS: Exception.
1450             throw new Exception(_m('Local user cannot be referenced as remote.'));
1451         }
1452
1453         if (OStatusPlugin::localGroupFromUrl($homeuri)) {
1454             // TRANS: Exception.
1455             throw new Exception(_m('Local group cannot be referenced as remote.'));
1456         }
1457
1458         $ptag = Profile_list::staticGet('uri', $homeuri);
1459         if ($ptag) {
1460             $local_user = User::staticGet('id', $ptag->tagger);
1461             if (!empty($local_user)) {
1462                 // TRANS: Exception.
1463                 throw new Exception(_m('Local list cannot be referenced as remote.'));
1464             }
1465         }
1466
1467         if (array_key_exists('feedurl', $hints)) {
1468             $feeduri = $hints['feedurl'];
1469         } else {
1470             $discover = new FeedDiscovery();
1471             $feeduri = $discover->discoverFromURL($homeuri);
1472         }
1473
1474         if (array_key_exists('salmon', $hints)) {
1475             $salmonuri = $hints['salmon'];
1476         } else {
1477             if (!$discover) {
1478                 $discover = new FeedDiscovery();
1479                 $discover->discoverFromFeedURL($hints['feedurl']);
1480             }
1481             $salmonuri = $discover->getAtomLink(Salmon::NS_REPLIES);
1482         }
1483
1484         if (array_key_exists('hub', $hints)) {
1485             $huburi = $hints['hub'];
1486         } else {
1487             if (!$discover) {
1488                 $discover = new FeedDiscovery();
1489                 $discover->discoverFromFeedURL($hints['feedurl']);
1490             }
1491             $huburi = $discover->getHubLink();
1492         }
1493
1494         if (!$huburi && !common_config('feedsub', 'fallback_hub')) {
1495             // We can only deal with folks with a PuSH hub
1496             throw new FeedSubNoHubException();
1497         }
1498
1499         $oprofile = new Ostatus_profile();
1500
1501         $oprofile->uri        = $homeuri;
1502         $oprofile->feeduri    = $feeduri;
1503         $oprofile->salmonuri  = $salmonuri;
1504
1505         $oprofile->created    = common_sql_now();
1506         $oprofile->modified   = common_sql_now();
1507
1508         if ($object->type == ActivityObject::PERSON) {
1509             $profile = new Profile();
1510             $profile->created = common_sql_now();
1511             self::updateProfile($profile, $object, $hints);
1512
1513             $oprofile->profile_id = $profile->insert();
1514             if (!$oprofile->profile_id) {
1515             // TRANS: Server exception.
1516                 throw new ServerException(_m('Cannot save local profile.'));
1517             }
1518         } else if ($object->type == ActivityObject::GROUP) {
1519             $group = new User_group();
1520             $group->uri = $homeuri;
1521             $group->created = common_sql_now();
1522             self::updateGroup($group, $object, $hints);
1523
1524             $oprofile->group_id = $group->insert();
1525             if (!$oprofile->group_id) {
1526                 // TRANS: Server exception.
1527                 throw new ServerException(_m('Cannot save local profile.'));
1528             }
1529         } else if ($object->type == ActivityObject::_LIST) {
1530             $ptag = new Profile_list();
1531             $ptag->uri = $homeuri;
1532             $ptag->created = common_sql_now();
1533             self::updatePeopletag($ptag, $object, $hints);
1534
1535             $oprofile->peopletag_id = $ptag->insert();
1536             if (!$oprofile->peopletag_id) {
1537             // TRANS: Server exception.
1538                 throw new ServerException(_m('Cannot save local list.'));
1539             }
1540         }
1541
1542         $ok = $oprofile->insert();
1543
1544         if (!$ok) {
1545             // TRANS: Server exception.
1546             throw new ServerException(_m('Cannot save OStatus profile.'));
1547         }
1548
1549         $avatar = self::getActivityObjectAvatar($object, $hints);
1550
1551         if ($avatar) {
1552             try {
1553                 $oprofile->updateAvatar($avatar);
1554             } catch (Exception $ex) {
1555                 // Profile is saved, but Avatar is messed up. We're
1556                 // just going to continue.
1557                 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: ". $ex->getMessage());
1558             }
1559         }
1560
1561         return $oprofile;
1562     }
1563
1564     /**
1565      * Save any updated profile information to our local copy.
1566      * @param ActivityObject $object
1567      * @param array $hints
1568      */
1569     public function updateFromActivityObject($object, $hints=array())
1570     {
1571         if ($this->isGroup()) {
1572             $group = $this->localGroup();
1573             self::updateGroup($group, $object, $hints);
1574         } else if ($this->isPeopletag()) {
1575             $ptag = $this->localPeopletag();
1576             self::updatePeopletag($ptag, $object, $hints);
1577         } else {
1578             $profile = $this->localProfile();
1579             self::updateProfile($profile, $object, $hints);
1580         }
1581
1582         $avatar = self::getActivityObjectAvatar($object, $hints);
1583         if ($avatar && !isset($ptag)) {
1584             try {
1585                 $this->updateAvatar($avatar);
1586             } catch (Exception $ex) {
1587                 common_log(LOG_WARNING, "Exception saving OStatus profile avatar: " . $ex->getMessage());
1588             }
1589         }
1590     }
1591
1592     public static function updateProfile($profile, $object, $hints=array())
1593     {
1594         $orig = clone($profile);
1595
1596         // Existing nickname is better than nothing.
1597
1598         if (!array_key_exists('nickname', $hints)) {
1599             $hints['nickname'] = $profile->nickname;
1600         }
1601
1602         $nickname = self::getActivityObjectNickname($object, $hints);
1603
1604         if (!empty($nickname)) {
1605             $profile->nickname = $nickname;
1606         }
1607
1608         if (!empty($object->title)) {
1609             $profile->fullname = $object->title;
1610         } else if (array_key_exists('fullname', $hints)) {
1611             $profile->fullname = $hints['fullname'];
1612         }
1613
1614         if (!empty($object->link)) {
1615             $profile->profileurl = $object->link;
1616         } else if (array_key_exists('profileurl', $hints)) {
1617             $profile->profileurl = $hints['profileurl'];
1618         } else if (Validate::uri($object->id, array('allowed_schemes' => array('http', 'https')))) {
1619             $profile->profileurl = $object->id;
1620         }
1621
1622         $bio = self::getActivityObjectBio($object, $hints);
1623
1624         if (!empty($bio)) {
1625             $profile->bio = $bio;
1626         }
1627
1628         $location = self::getActivityObjectLocation($object, $hints);
1629
1630         if (!empty($location)) {
1631             $profile->location = $location;
1632         }
1633
1634         $homepage = self::getActivityObjectHomepage($object, $hints);
1635
1636         if (!empty($homepage)) {
1637             $profile->homepage = $homepage;
1638         }
1639
1640         if (!empty($object->geopoint)) {
1641             $location = ActivityContext::locationFromPoint($object->geopoint);
1642             if (!empty($location)) {
1643                 $profile->lat = $location->lat;
1644                 $profile->lon = $location->lon;
1645             }
1646         }
1647
1648         // @fixme tags/categories
1649         // @todo tags from categories
1650
1651         if ($profile->id) {
1652             common_log(LOG_DEBUG, "Updating OStatus profile $profile->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1653             $profile->update($orig);
1654         }
1655     }
1656
1657     protected static function updateGroup($group, $object, $hints=array())
1658     {
1659         $orig = clone($group);
1660
1661         $group->nickname = self::getActivityObjectNickname($object, $hints);
1662         $group->fullname = $object->title;
1663
1664         if (!empty($object->link)) {
1665             $group->mainpage = $object->link;
1666         } else if (array_key_exists('profileurl', $hints)) {
1667             $group->mainpage = $hints['profileurl'];
1668         }
1669
1670         // @todo tags from categories
1671         $group->description = self::getActivityObjectBio($object, $hints);
1672         $group->location = self::getActivityObjectLocation($object, $hints);
1673         $group->homepage = self::getActivityObjectHomepage($object, $hints);
1674
1675         if ($group->id) {
1676             common_log(LOG_DEBUG, "Updating OStatus group $group->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1677             $group->update($orig);
1678         }
1679     }
1680
1681     protected static function updatePeopletag($tag, $object, $hints=array()) {
1682         $orig = clone($tag);
1683
1684         $tag->tag = $object->title;
1685
1686         if (!empty($object->link)) {
1687             $tag->mainpage = $object->link;
1688         } else if (array_key_exists('profileurl', $hints)) {
1689             $tag->mainpage = $hints['profileurl'];
1690         }
1691
1692         $tag->description = $object->summary;
1693         $tagger = self::ensureActivityObjectProfile($object->owner);
1694         $tag->tagger = $tagger->profile_id;
1695
1696         if ($tag->id) {
1697             common_log(LOG_DEBUG, "Updating OStatus peopletag $tag->id from remote info $object->id: " . var_export($object, true) . var_export($hints, true));
1698             $tag->update($orig);
1699         }
1700     }
1701
1702     protected static function getActivityObjectHomepage($object, $hints=array())
1703     {
1704         $homepage = null;
1705         $poco     = $object->poco;
1706
1707         if (!empty($poco)) {
1708             $url = $poco->getPrimaryURL();
1709             if ($url && $url->type == 'homepage') {
1710                 $homepage = $url->value;
1711             }
1712         }
1713
1714         // @todo Try for a another PoCo URL?
1715
1716         return $homepage;
1717     }
1718
1719     protected static function getActivityObjectLocation($object, $hints=array())
1720     {
1721         $location = null;
1722
1723         if (!empty($object->poco) &&
1724             isset($object->poco->address->formatted)) {
1725             $location = $object->poco->address->formatted;
1726         } else if (array_key_exists('location', $hints)) {
1727             $location = $hints['location'];
1728         }
1729
1730         if (!empty($location)) {
1731             if (mb_strlen($location) > 255) {
1732                 $location = mb_substr($note, 0, 255 - 3) . ' â€¦ ';
1733             }
1734         }
1735
1736         // @todo Try to find location some othe way? Via goerss point?
1737
1738         return $location;
1739     }
1740
1741     protected static function getActivityObjectBio($object, $hints=array())
1742     {
1743         $bio  = null;
1744
1745         if (!empty($object->poco)) {
1746             $note = $object->poco->note;
1747         } else if (array_key_exists('bio', $hints)) {
1748             $note = $hints['bio'];
1749         }
1750
1751         if (!empty($note)) {
1752             if (Profile::bioTooLong($note)) {
1753                 // XXX: truncate ok?
1754                 $bio = mb_substr($note, 0, Profile::maxBio() - 3) . ' â€¦ ';
1755             } else {
1756                 $bio = $note;
1757             }
1758         }
1759
1760         // @todo Try to get bio info some other way?
1761
1762         return $bio;
1763     }
1764
1765     public static function getActivityObjectNickname($object, $hints=array())
1766     {
1767         if ($object->poco) {
1768             if (!empty($object->poco->preferredUsername)) {
1769                 return common_nicknamize($object->poco->preferredUsername);
1770             }
1771         }
1772
1773         if (!empty($object->nickname)) {
1774             return common_nicknamize($object->nickname);
1775         }
1776
1777         if (array_key_exists('nickname', $hints)) {
1778             return $hints['nickname'];
1779         }
1780
1781         // Try the profile url (like foo.example.com or example.com/user/foo)
1782         if (!empty($object->link)) {
1783             $profileUrl = $object->link;
1784         } else if (!empty($hints['profileurl'])) {
1785             $profileUrl = $hints['profileurl'];
1786         }
1787
1788         if (!empty($profileUrl)) {
1789             $nickname = self::nicknameFromURI($profileUrl);
1790         }
1791
1792         // Try the URI (may be a tag:, http:, acct:, ...
1793
1794         if (empty($nickname)) {
1795             $nickname = self::nicknameFromURI($object->id);
1796         }
1797
1798         // Try a Webfinger if one was passed (way) down
1799
1800         if (empty($nickname)) {
1801             if (array_key_exists('webfinger', $hints)) {
1802                 $nickname = self::nicknameFromURI($hints['webfinger']);
1803             }
1804         }
1805
1806         // Try the name
1807
1808         if (empty($nickname)) {
1809             $nickname = common_nicknamize($object->title);
1810         }
1811
1812         return $nickname;
1813     }
1814
1815     protected static function nicknameFromURI($uri)
1816     {
1817         if (preg_match('/(\w+):/', $uri, $matches)) {
1818             $protocol = $matches[1];
1819         } else {
1820             return null;
1821         }
1822
1823         switch ($protocol) {
1824         case 'acct':
1825         case 'mailto':
1826             if (preg_match("/^$protocol:(.*)?@.*\$/", $uri, $matches)) {
1827                 return common_canonical_nickname($matches[1]);
1828             }
1829             return null;
1830         case 'http':
1831             return common_url_to_nickname($uri);
1832             break;
1833         default:
1834             return null;
1835         }
1836     }
1837
1838     /**
1839      * Look up, and if necessary create, an Ostatus_profile for the remote
1840      * entity with the given webfinger address.
1841      * This should never return null -- you will either get an object or
1842      * an exception will be thrown.
1843      *
1844      * @param string $addr webfinger address
1845      * @return Ostatus_profile
1846      * @throws Exception on error conditions
1847      * @throws OStatusShadowException if this reference would obscure a local user/group
1848      */
1849     public static function ensureWebfinger($addr)
1850     {
1851         // First, try the cache
1852
1853         $uri = self::cacheGet(sprintf('ostatus_profile:webfinger:%s', $addr));
1854
1855         if ($uri !== false) {
1856             if (is_null($uri)) {
1857                 // Negative cache entry
1858                 // TRANS: Exception.
1859                 throw new Exception(_m('Not a valid webfinger address.'));
1860             }
1861             $oprofile = Ostatus_profile::staticGet('uri', $uri);
1862             if (!empty($oprofile)) {
1863                 return $oprofile;
1864             }
1865         }
1866
1867         // Try looking it up
1868         $oprofile = Ostatus_profile::staticGet('uri', 'acct:'.$addr);
1869
1870         if (!empty($oprofile)) {
1871             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1872             return $oprofile;
1873         }
1874
1875         // Now, try some discovery
1876
1877         $disco = new Discovery();
1878
1879         try {
1880             $xrd = $disco->lookup($addr);
1881         } catch (Exception $e) {
1882             // Save negative cache entry so we don't waste time looking it up again.
1883             // @fixme distinguish temporary failures?
1884             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), null);
1885             // TRANS: Exception.
1886             throw new Exception(_m('Not a valid webfinger address.'));
1887         }
1888
1889         $hints = array('webfinger' => $addr);
1890
1891         $dhints = DiscoveryHints::fromXRD($xrd);
1892
1893         $hints = array_merge($hints, $dhints);
1894
1895         // If there's an Hcard, let's grab its info
1896         if (array_key_exists('hcard', $hints)) {
1897             if (!array_key_exists('profileurl', $hints) ||
1898                 $hints['hcard'] != $hints['profileurl']) {
1899                 $hcardHints = DiscoveryHints::fromHcardUrl($hints['hcard']);
1900                 $hints = array_merge($hcardHints, $hints);
1901             }
1902         }
1903
1904         // If we got a feed URL, try that
1905         if (array_key_exists('feedurl', $hints)) {
1906             try {
1907                 common_log(LOG_INFO, "Discovery on acct:$addr with feed URL " . $hints['feedurl']);
1908                 $oprofile = self::ensureFeedURL($hints['feedurl'], $hints);
1909                 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1910                 return $oprofile;
1911             } catch (Exception $e) {
1912                 common_log(LOG_WARNING, "Failed creating profile from feed URL '$feedUrl': " . $e->getMessage());
1913                 // keep looking
1914             }
1915         }
1916
1917         // If we got a profile page, try that!
1918         if (array_key_exists('profileurl', $hints)) {
1919             try {
1920                 common_log(LOG_INFO, "Discovery on acct:$addr with profile URL $profileUrl");
1921                 $oprofile = self::ensureProfileURL($hints['profileurl'], $hints);
1922                 self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1923                 return $oprofile;
1924             } catch (OStatusShadowException $e) {
1925                 // We've ended up with a remote reference to a local user or group.
1926                 // @fixme ideally we should be able to say who it was so we can
1927                 // go back and refer to it the regular way
1928                 throw $e;
1929             } catch (Exception $e) {
1930                 common_log(LOG_WARNING, "Failed creating profile from profile URL '$profileUrl': " . $e->getMessage());
1931                 // keep looking
1932                 //
1933                 // @fixme this means an error discovering from profile page
1934                 // may give us a corrupt entry using the webfinger URI, which
1935                 // will obscure the correct page-keyed profile later on.
1936             }
1937         }
1938
1939         // XXX: try hcard
1940         // XXX: try FOAF
1941
1942         if (array_key_exists('salmon', $hints)) {
1943             $salmonEndpoint = $hints['salmon'];
1944
1945             // An account URL, a salmon endpoint, and a dream? Not much to go
1946             // on, but let's give it a try
1947
1948             $uri = 'acct:'.$addr;
1949
1950             $profile = new Profile();
1951
1952             $profile->nickname = self::nicknameFromUri($uri);
1953             $profile->created  = common_sql_now();
1954
1955             if (isset($profileUrl)) {
1956                 $profile->profileurl = $profileUrl;
1957             }
1958
1959             $profile_id = $profile->insert();
1960
1961             if (!$profile_id) {
1962                 common_log_db_error($profile, 'INSERT', __FILE__);
1963                 // TRANS: Exception. %s is a webfinger address.
1964                 throw new Exception(sprintf(_m('Could not save profile for "%s".'),$addr));
1965             }
1966
1967             $oprofile = new Ostatus_profile();
1968
1969             $oprofile->uri        = $uri;
1970             $oprofile->salmonuri  = $salmonEndpoint;
1971             $oprofile->profile_id = $profile_id;
1972             $oprofile->created    = common_sql_now();
1973
1974             if (isset($feedUrl)) {
1975                 $profile->feeduri = $feedUrl;
1976             }
1977
1978             $result = $oprofile->insert();
1979
1980             if (!$result) {
1981                 common_log_db_error($oprofile, 'INSERT', __FILE__);
1982                 // TRANS: Exception. %s is a webfinger address.
1983                 throw new Exception(sprintf(_m('Could not save OStatus profile for "%s".'),$addr));
1984             }
1985
1986             self::cacheSet(sprintf('ostatus_profile:webfinger:%s', $addr), $oprofile->uri);
1987             return $oprofile;
1988         }
1989
1990         // TRANS: Exception. %s is a webfinger address.
1991         throw new Exception(sprintf(_m('Could not find a valid profile for "%s".'),$addr));
1992     }
1993
1994     /**
1995      * Store the full-length scrubbed HTML of a remote notice to an attachment
1996      * file on our server. We'll link to this at the end of the cropped version.
1997      *
1998      * @param string $title plaintext for HTML page's title
1999      * @param string $rendered HTML fragment for HTML page's body
2000      * @return File
2001      */
2002     function saveHTMLFile($title, $rendered)
2003     {
2004         $final = sprintf("<!DOCTYPE html>\n" .
2005                          '<html><head>' .
2006                          '<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">' .
2007                          '<title>%s</title>' .
2008                          '</head>' .
2009                          '<body>%s</body></html>',
2010                          htmlspecialchars($title),
2011                          $rendered);
2012
2013         $filename = File::filename($this->localProfile(),
2014                                    'ostatus', // ignored?
2015                                    'text/html');
2016
2017         $filepath = File::path($filename);
2018
2019         file_put_contents($filepath, $final);
2020
2021         $file = new File;
2022
2023         $file->filename = $filename;
2024         $file->url      = File::url($filename);
2025         $file->size     = filesize($filepath);
2026         $file->date     = time();
2027         $file->mimetype = 'text/html';
2028
2029         $file_id = $file->insert();
2030
2031         if ($file_id === false) {
2032             common_log_db_error($file, "INSERT", __FILE__);
2033             // TRANS: Server exception.
2034             throw new ServerException(_m('Could not store HTML content of long post as file.'));
2035         }
2036
2037         return $file;
2038     }
2039
2040     static function ensureProfileURI($uri)
2041     {
2042         $oprofile = null;
2043
2044         // First, try to query it
2045
2046         $oprofile = Ostatus_profile::staticGet('uri', $uri);
2047
2048         // If unfound, do discovery stuff
2049
2050         if (empty($oprofile)) {
2051             if (preg_match("/^(\w+)\:(.*)/", $uri, $match)) {
2052                 $protocol = $match[1];
2053                 switch ($protocol) {
2054                 case 'http':
2055                 case 'https':
2056                     $oprofile = Ostatus_profile::ensureProfileURL($uri);
2057                     break;
2058                 case 'acct':
2059                 case 'mailto':
2060                     $rest = $match[2];
2061                     $oprofile = Ostatus_profile::ensureWebfinger($rest);
2062                     break;
2063                 default:
2064                     // TRANS: Server exception.
2065                     // TRANS: %1$s is a protocol, %2$s is a URI.
2066                     throw new ServerException(sprintf(_m('Unrecognized URI protocol for profile: %1$s (%2$s).'),
2067                                                       $protocol,
2068                                                       $uri));
2069                     break;
2070                 }
2071             } else {
2072                 // TRANS: Server exception. %s is a URI.
2073                 throw new ServerException(sprintf(_m('No URI protocol for profile: %s.'),$uri));
2074             }
2075         }
2076
2077         return $oprofile;
2078     }
2079
2080     function checkAuthorship($activity)
2081     {
2082         if ($this->isGroup() || $this->isPeopletag()) {
2083             // A group or propletag feed will contain posts from multiple authors.
2084             $oprofile = self::ensureActorProfile($activity);
2085             if ($oprofile->isGroup() || $oprofile->isPeopletag()) {
2086                 // Groups can't post notices in StatusNet.
2087                 common_log(LOG_WARNING,
2088                     "OStatus: skipping post with group listed ".
2089                     "as author: $oprofile->uri in feed from $this->uri");
2090                 return false;
2091             }
2092         } else {
2093             $actor = $activity->actor;
2094
2095             if (empty($actor)) {
2096                 // OK here! assume the default
2097             } else if ($actor->id == $this->uri || $actor->link == $this->uri) {
2098                 $this->updateFromActivityObject($actor);
2099             } else if ($actor->id) {
2100                 // We have an ActivityStreams actor with an explicit ID that doesn't match the feed owner.
2101                 // This isn't what we expect from mainline OStatus person feeds!
2102                 // Group feeds go down another path, with different validation...
2103                 // Most likely this is a plain ol' blog feed of some kind which
2104                 // doesn't match our expectations. We'll take the entry, but ignore
2105                 // the <author> info.
2106                 common_log(LOG_WARNING, "Got an actor '{$actor->title}' ({$actor->id}) on single-user feed for {$this->uri}");
2107             } else {
2108                 // Plain <author> without ActivityStreams actor info.
2109                 // We'll just ignore this info for now and save the update under the feed's identity.
2110             }
2111
2112             $oprofile = $this;
2113         }
2114
2115         return $oprofile;
2116     }
2117 }
2118
2119 /**
2120  * Exception indicating we've got a remote reference to a local user,
2121  * not a remote user!
2122  *
2123  * If we can ue a local profile after all, it's available as $e->profile.
2124  */
2125 class OStatusShadowException extends Exception
2126 {
2127     public $profile;
2128
2129     /**
2130      * @param Profile $profile
2131      * @param string $message
2132      */
2133     function __construct($profile, $message) {
2134         $this->profile = $profile;
2135         parent::__construct($message);
2136     }
2137 }