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