]> git.mxchange.org Git - quix0rs-gnu-social.git/blob - plugins/OStatus/classes/Ostatus_profile.php
d9cb7a6e1be704a0ef302ebe0c4aa5f22d2b43bc
[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 /**
21  * @package OStatusPlugin
22  * @maintainer Brion Vibber <brion@status.net>
23  */
24
25 class Ostatus_profile extends Memcached_DataObject
26 {
27     public $__table = 'ostatus_profile';
28
29     public $uri;
30
31     public $profile_id;
32     public $group_id;
33
34     public $feeduri;
35     public $salmonuri;
36
37     public $created;
38     public $modified;
39
40     public /*static*/ function staticGet($k, $v=null)
41     {
42         return parent::staticGet(__CLASS__, $k, $v);
43     }
44
45     /**
46      * return table definition for DB_DataObject
47      *
48      * DB_DataObject needs to know something about the table to manipulate
49      * instances. This method provides all the DB_DataObject needs to know.
50      *
51      * @return array array of column definitions
52      */
53
54     function table()
55     {
56         return array('uri' => DB_DATAOBJECT_STR + DB_DATAOBJECT_NOTNULL,
57                      'profile_id' => DB_DATAOBJECT_INT,
58                      'group_id' => DB_DATAOBJECT_INT,
59                      'feeduri' => DB_DATAOBJECT_STR,
60                      'salmonuri' =>  DB_DATAOBJECT_STR,
61                      'created' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL,
62                      'modified' => DB_DATAOBJECT_STR + DB_DATAOBJECT_DATE + DB_DATAOBJECT_TIME + DB_DATAOBJECT_NOTNULL);
63     }
64
65     static function schemaDef()
66     {
67         return array(new ColumnDef('uri', 'varchar',
68                                    255, false, 'PRI'),
69                      new ColumnDef('profile_id', 'integer',
70                                    null, true, 'UNI'),
71                      new ColumnDef('group_id', 'integer',
72                                    null, true, 'UNI'),
73                      new ColumnDef('feeduri', 'varchar',
74                                    255, true, 'UNI'),
75                      new ColumnDef('salmonuri', 'text',
76                                    null, true),
77                      new ColumnDef('created', 'datetime',
78                                    null, false),
79                      new ColumnDef('modified', 'datetime',
80                                    null, false));
81     }
82
83     /**
84      * return key definitions for DB_DataObject
85      *
86      * DB_DataObject needs to know about keys that the table has; this function
87      * defines them.
88      *
89      * @return array key definitions
90      */
91
92     function keys()
93     {
94         return array_keys($this->keyTypes());
95     }
96
97     /**
98      * return key definitions for Memcached_DataObject
99      *
100      * Our caching system uses the same key definitions, but uses a different
101      * method to get them.
102      *
103      * @return array key definitions
104      */
105
106     function keyTypes()
107     {
108         return array('uri' => 'K', 'profile_id' => 'U', 'group_id' => 'U', 'feeduri' => 'U');
109     }
110
111     function sequenceKey()
112     {
113         return array(false, false, false);
114     }
115
116     /**
117      * Fetch the StatusNet-side profile for this feed
118      * @return Profile
119      */
120     public function localProfile()
121     {
122         if ($this->profile_id) {
123             return Profile::staticGet('id', $this->profile_id);
124         }
125         return null;
126     }
127
128     /**
129      * Fetch the StatusNet-side profile for this feed
130      * @return Profile
131      */
132     public function localGroup()
133     {
134         if ($this->group_id) {
135             return User_group::staticGet('id', $this->group_id);
136         }
137         return null;
138     }
139
140     /**
141      * Returns an XML string fragment with profile information as an
142      * Activity Streams noun object with the given element type.
143      *
144      * Assumes that 'activity' namespace has been previously defined.
145      *
146      * @param string $element one of 'actor', 'subject', 'object', 'target'
147      * @return string
148      */
149     function asActivityNoun($element)
150     {
151         $xs = new XMLStringer(true);
152         $avatarHref = Avatar::defaultImage(AVATAR_PROFILE_SIZE);
153         $avatarType = 'image/png';
154         if ($this->isGroup()) {
155             $type = 'http://activitystrea.ms/schema/1.0/group';
156             $self = $this->localGroup();
157
158             // @fixme put a standard getAvatar() interface on groups too
159             if ($self->homepage_logo) {
160                 $avatarHref = $self->homepage_logo;
161                 $map = array('png' => 'image/png',
162                              'jpg' => 'image/jpeg',
163                              'jpeg' => 'image/jpeg',
164                              'gif' => 'image/gif');
165                 $extension = pathinfo(parse_url($avatarHref, PHP_URL_PATH), PATHINFO_EXTENSION);
166                 if (isset($map[$extension])) {
167                     $avatarType = $map[$extension];
168                 }
169             }
170         } else {
171             $type = 'http://activitystrea.ms/schema/1.0/person';
172             $self = $this->localProfile();
173             $avatar = $self->getAvatar(AVATAR_PROFILE_SIZE);
174             if ($avatar) {
175                   $avatarHref = $avatar->url;
176                   $avatarType = $avatar->mediatype;
177             }
178         }
179         $xs->elementStart('activity:' . $element);
180         $xs->element(
181             'activity:object-type',
182             null,
183             $type
184         );
185         $xs->element(
186             'id',
187             null,
188             $this->uri); // ?
189         $xs->element('title', null, $self->getBestName());
190
191         $xs->element(
192             'link', array(
193                 'type' => $avatarType,
194                 'href' => $avatarHref
195             ),
196             ''
197         );
198
199         $xs->elementEnd('activity:' . $element);
200
201         return $xs->getString();
202     }
203
204     /**
205      * Damn dirty hack!
206      */
207     function isGroup()
208     {
209         return (strpos($this->feeduri, '/groups/') !== false);
210     }
211
212     /**
213      * Subscribe a local user to this remote user.
214      * PuSH subscription will be started if necessary, and we'll
215      * send a Salmon notification to the remote server if available
216      * notifying them of the sub.
217      *
218      * @param User $user
219      * @return boolean success
220      * @throws FeedException
221      */
222     public function subscribeLocalToRemote(User $user)
223     {
224         if ($this->isGroup()) {
225             throw new ServerException("Can't subscribe to a remote group");
226         }
227
228         if ($this->subscribe()) {
229             if ($user->subscribeTo($this->localProfile())) {
230                 $this->notify($user->getProfile(), ActivityVerb::FOLLOW, $this);
231                 return true;
232             }
233         }
234         return false;
235     }
236
237     /**
238      * Mark this remote profile as subscribing to the given local user,
239      * and send appropriate notifications to the user.
240      *
241      * This will generally be in response to a subscription notification
242      * from a foreign site to our local Salmon response channel.
243      *
244      * @param User $user
245      * @return boolean success
246      */
247     public function subscribeRemoteToLocal(User $user)
248     {
249         if ($this->isGroup()) {
250             throw new ServerException("Remote groups can't subscribe to local users");
251         }
252
253         // @fixme use regular channels for subbing, once they accept remote profiles
254         $sub = new Subscription();
255         $sub->subscriber = $this->profile_id;
256         $sub->subscribed = $user->id;
257         $sub->created = common_sql_now(); // current time
258
259         if ($sub->insert()) {
260             // @fixme use subs_notify() if refactored to take profiles?
261             mail_subscribe_notify_profile($user, $this->localProfile());
262             return true;
263         }
264         return false;
265     }
266
267     /**
268      * Send a subscription request to the hub for this feed.
269      * The hub will later send us a confirmation POST to /main/push/callback.
270      *
271      * @return bool true on success, false on failure
272      * @throws ServerException if feed state is not valid
273      */
274     public function subscribe()
275     {
276         $feedsub = FeedSub::ensureFeed($this->feeduri);
277         if ($feedsub->sub_state == 'active' || $feedsub->sub_state == 'subscribe') {
278             return true;
279         } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive') {
280             return $feedsub->subscribe();
281         } else if ('unsubscribe') {
282             throw new FeedSubException("Unsub is pending, can't subscribe...");
283         }
284     }
285
286     /**
287      * Send a PuSH unsubscription request to the hub for this feed.
288      * The hub will later send us a confirmation POST to /main/push/callback.
289      *
290      * @return bool true on success, false on failure
291      * @throws ServerException if feed state is not valid
292      */
293     public function unsubscribe() {
294         $feedsub = FeedSub::staticGet('uri', $this->feeduri);
295         if ($feedsub->sub_state == 'active') {
296             return $feedsub->unsubscribe();
297         } else if ($feedsub->sub_state == '' || $feedsub->sub_state == 'inactive' || $feedsub->sub_state == 'unsubscribe') {
298             return true;
299         } else if ($feedsub->sub_state == 'subscribe') {
300             throw new FeedSubException("Feed is awaiting subscription, can't unsub...");
301         }
302     }
303
304     /**
305      * Send an Activity Streams notification to the remote Salmon endpoint,
306      * if so configured.
307      *
308      * @param Profile $actor
309      * @param $verb eg Activity::SUBSCRIBE or Activity::JOIN
310      * @param string $object object of the action; if null, the remote entity itself is assumed
311      */
312     public function notify($actor, $verb, $object=null)
313     {
314         if (!($actor instanceof Profile)) {
315             $type = gettype($actor);
316             if ($type == 'object') {
317                 $type = get_class($actor);
318             }
319             throw new ServerException("Invalid actor passed to " . __METHOD__ . ": " . $type);
320         }
321         if ($object == null) {
322             $object = $this;
323         }
324         if ($this->salmonuri) {
325             $text = 'update'; // @fixme
326             $id = 'tag:' . common_config('site', 'server') .
327                 ':' . $verb .
328                 ':' . $actor->id .
329                 ':' . time(); // @fixme
330
331             // @fixme consolidate all these NS settings somewhere
332             $attributes = array('xmlns' => Activity::ATOM,
333                                 'xmlns:activity' => 'http://activitystrea.ms/spec/1.0/',
334                                 'xmlns:thr' => 'http://purl.org/syndication/thread/1.0',
335                                 'xmlns:georss' => 'http://www.georss.org/georss',
336                                 'xmlns:ostatus' => 'http://ostatus.org/schema/1.0');
337
338             $entry = new XMLStringer();
339             $entry->elementStart('entry', $attributes);
340             $entry->element('id', null, $id);
341             $entry->element('title', null, $text);
342             $entry->element('summary', null, $text);
343             $entry->element('published', null, common_date_w3dtf(common_sql_now()));
344
345             $entry->element('activity:verb', null, $verb);
346             $entry->raw($actor->asAtomAuthor());
347             $entry->raw($actor->asActivityActor());
348             $entry->raw($object->asActivityNoun('object'));
349             $entry->elementEnd('entry');
350
351             $xml = $entry->getString();
352             common_log(LOG_INFO, "Posting to Salmon endpoint $this->salmonuri: $xml");
353
354             $salmon = new Salmon(); // ?
355             $salmon->post($this->salmonuri, $xml);
356         }
357     }
358
359     function getBestName()
360     {
361         if ($this->isGroup()) {
362             return $this->localGroup()->getBestName();
363         } else {
364             return $this->localProfile()->getBestName();
365         }
366     }
367
368     function atomFeed($actor)
369     {
370         $feed = new Atom10Feed();
371         // @fixme should these be set up somewhere else?
372         $feed->addNamespace('activity', 'http://activitystrea.ms/spec/1.0/');
373         $feed->addNamespace('thr', 'http://purl.org/syndication/thread/1.0');
374         $feed->addNamespace('georss', 'http://www.georss.org/georss');
375         $feed->addNamespace('ostatus', 'http://ostatus.org/schema/1.0');
376
377         $taguribase = common_config('integration', 'taguri');
378         $feed->setId("tag:{$taguribase}:UserTimeline:{$actor->id}"); // ???
379
380         $feed->setTitle($actor->getBestName() . ' timeline'); // @fixme
381         $feed->setUpdated(time());
382         $feed->setPublished(time());
383
384         $feed->addLink(common_local_url('ApiTimelineUser',
385                                         array('id' => $actor->id,
386                                               'type' => 'atom')),
387                        array('rel' => 'self',
388                              'type' => 'application/atom+xml'));
389
390         $feed->addLink(common_local_url('userbyid',
391                                         array('id' => $actor->id)),
392                        array('rel' => 'alternate',
393                              'type' => 'text/html'));
394
395         return $feed;
396     }
397
398     /**
399      * Read and post notices for updates from the feed.
400      * Currently assumes that all items in the feed are new,
401      * coming from a PuSH hub.
402      *
403      * @param DOMDocument $feed
404      */
405     public function processFeed($feed)
406     {
407         $entries = $feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
408         if ($entries->length == 0) {
409             common_log(LOG_ERR, __METHOD__ . ": no entries in feed update, ignoring");
410             return;
411         }
412
413         for ($i = 0; $i < $entries->length; $i++) {
414             $entry = $entries->item($i);
415             $this->processEntry($entry, $feed);
416         }
417     }
418
419     /**
420      * Process a posted entry from this feed source.
421      *
422      * @param DOMElement $entry
423      * @param DOMElement $feed for context
424      */
425     protected function processEntry($entry, $feed)
426     {
427         $activity = new Activity($entry, $feed);
428
429         $debug = var_export($activity, true);
430         common_log(LOG_DEBUG, $debug);
431
432         if ($activity->verb == ActivityVerb::POST) {
433             $this->processPost($activity);
434         } else {
435             common_log(LOG_INFO, "Ignoring activity with unrecognized verb $activity->verb");
436         }
437     }
438
439     /**
440      * Process an incoming post activity from this remote feed.
441      * @param Activity $activity
442      */
443     protected function processPost($activity)
444     {
445         if ($this->isGroup()) {
446             // @fixme validate these profiles in some way!
447             $oprofile = self::ensureActorProfile($activity);
448         } else {
449             $actorUri = self::getActorProfileURI($activity);
450             if ($actorUri == $this->uri) {
451                 // @fixme check if profile info has changed and update it
452             } else {
453                 // @fixme drop or reject the messages once we've got the canonical profile URI recorded sanely
454                 common_log(LOG_INFO, "OStatus: Warning: non-group post with unexpected author: $actorUri expected $this->uri");
455                 //return;
456             }
457             $oprofile = $this;
458         }
459
460         $sourceUri = $activity->object->id;
461
462         $dupe = Notice::staticGet('uri', $sourceUri);
463
464         if ($dupe) {
465             common_log(LOG_INFO, "OStatus: ignoring duplicate post: $sourceUri");
466             return;
467         }
468
469         $sourceUrl = null;
470
471         if ($activity->object->link) {
472             $sourceUrl = $activity->object->link;
473         } else if (preg_match('!^https?://!', $activity->object->id)) {
474             $sourceUrl = $activity->object->id;
475         }
476
477         // @fixme sanitize and save HTML content if available
478
479         $content = $activity->object->title;
480
481         $params = array('is_local' => Notice::REMOTE_OMB,
482                         'url' => $sourceUrl,
483                         'uri' => $sourceUri);
484
485         $location = $activity->context->location;
486
487         if ($location) {
488             $params['lat'] = $location->lat;
489             $params['lon'] = $location->lon;
490             if ($location->location_id) {
491                 $params['location_ns'] = $location->location_ns;
492                 $params['location_id'] = $location->location_id;
493             }
494         }
495
496         // @fixme save detailed ostatus source info
497         // @fixme ensure that groups get handled correctly
498
499         $saved = Notice::saveNew($oprofile->localProfile()->id,
500                                  $content,
501                                  'ostatus',
502                                  $params);
503     }
504
505     /**
506      * @param string $profile_url
507      * @return Ostatus_profile
508      * @throws FeedSubException
509      */
510     public static function ensureProfile($profile_uri)
511     {
512         // Get the canonical feed URI and check it
513         $discover = new FeedDiscovery();
514         $feeduri = $discover->discoverFromURL($profile_uri);
515
516         //$feedsub = FeedSub::ensureFeed($feeduri, $discover->feed);
517         $huburi = $discover->getAtomLink('hub');
518         $salmonuri = $discover->getAtomLink('salmon');
519
520         if (!$huburi) {
521             // We can only deal with folks with a PuSH hub
522             throw new FeedSubNoHubException();
523         }
524
525         // Ok this is going to be a terrible hack!
526         // Won't be suitable for groups, empty feeds, or getting
527         // info that's only available on the profile page.
528         $entries = $discover->feed->getElementsByTagNameNS(Activity::ATOM, 'entry');
529         if (!$entries || $entries->length == 0) {
530             throw new FeedSubException('empty feed');
531         }
532         $first = new Activity($entries->item(0), $discover->feed);
533         return self::ensureActorProfile($first, $feeduri, $salmonuri);
534     }
535
536     /**
537      * Download and update given avatar image
538      * @param string $url
539      * @throws Exception in various failure cases
540      */
541     protected function updateAvatar($url)
542     {
543         // @fixme this should be better encapsulated
544         // ripped from oauthstore.php (for old OMB client)
545         $temp_filename = tempnam(sys_get_temp_dir(), 'listener_avatar');
546         copy($url, $temp_filename);
547
548         if ($this->isGroup()) {
549             $id = $this->group_id;
550         } else {
551             $id = $this->profile_id;
552         }
553         // @fixme should we be using different ids?
554         $imagefile = new ImageFile($id, $temp_filename);
555         $filename = Avatar::filename($id,
556                                      image_type_to_extension($imagefile->type),
557                                      null,
558                                      common_timestamp());
559         rename($temp_filename, Avatar::path($filename));
560         if ($this->isGroup()) {
561             $group = $this->localGroup();
562             $group->setOriginal($filename);
563         } else {
564             $profile = $this->localProfile();
565             $profile->setOriginal($filename);
566         }
567     }
568
569     /**
570      * Get an appropriate avatar image source URL, if available.
571      *
572      * @param ActivityObject $actor
573      * @param DOMElement $feed
574      * @return string
575      */
576     protected static function getAvatar($actor, $feed)
577     {
578         $url = '';
579         $icon = '';
580         if ($actor->avatar) {
581             $url = trim($actor->avatar);
582         }
583         if (!$url) {
584             // Check <atom:logo> and <atom:icon> on the feed
585             $els = $feed->childNodes();
586             if ($els && $els->length) {
587                 for ($i = 0; $i < $els->length; $i++) {
588                     $el = $els->item($i);
589                     if ($el->namespaceURI == Activity::ATOM) {
590                         if (empty($url) && $el->localName == 'logo') {
591                             $url = trim($el->textContent);
592                             break;
593                         }
594                         if (empty($icon) && $el->localName == 'icon') {
595                             // Use as a fallback
596                             $icon = trim($el->textContent);
597                         }
598                     }
599                 }
600             }
601             if ($icon && !$url) {
602                 $url = $icon;
603             }
604         }
605         if ($url) {
606             $opts = array('allowed_schemes' => array('http', 'https'));
607             if (Validate::uri($url, $opts)) {
608                 return $url;
609             }
610         }
611         return common_path('plugins/OStatus/images/96px-Feed-icon.svg.png');
612     }
613
614     /**
615      * Fetch, or build if necessary, an Ostatus_profile for the actor
616      * in a given Activity Streams activity.
617      *
618      * @param Activity $activity
619      * @param string $feeduri if we already know the canonical feed URI!
620      * @param string $salmonuri if we already know the salmon return channel URI
621      * @return Ostatus_profile
622      */
623     public static function ensureActorProfile($activity, $feeduri=null, $salmonuri=null)
624     {
625         $profile = self::getActorProfile($activity);
626         if (!$profile) {
627             $profile = self::createActorProfile($activity, $feeduri, $salmonuri);
628         }
629         return $profile;
630     }
631
632     /**
633      * @param Activity $activity
634      * @return mixed matching Ostatus_profile or false if none known
635      */
636     protected static function getActorProfile($activity)
637     {
638         $homeuri = self::getActorProfileURI($activity);
639         return self::staticGet('uri', $homeuri);
640     }
641
642     /**
643      * @param Activity $activity
644      * @return string
645      * @throws ServerException
646      */
647     protected static function getActorProfileURI($activity)
648     {
649         $opts = array('allowed_schemes' => array('http', 'https'));
650         $actor = $activity->actor;
651         if ($actor->id && Validate::uri($actor->id, $opts)) {
652             return $actor->id;
653         }
654         if ($actor->link && Validate::uri($actor->link, $opts)) {
655             return $actor->link;
656         }
657         throw new ServerException("No author ID URI found");
658     }
659
660     /**
661      * @fixme validate stuff somewhere
662      */
663     protected static function createActorProfile($activity, $feeduri=null, $salmonuri=null)
664     {
665         $actor = $activity->actor;
666         $homeuri = self::getActorProfileURI($activity);
667         $nickname = self::getAuthorNick($activity);
668         $avatar = self::getAvatar($actor, $activity->feed);
669
670         if (!$homeuri) {
671             common_log(LOG_DEBUG, __METHOD__ . " empty actor profile URI: " . var_export($activity, true));
672             throw new ServerException("No profile URI");
673         }
674
675         if (!$feeduri || !$salmonuri) {
676             // Get the canonical feed URI and check it
677             $discover = new FeedDiscovery();
678             $feeduri = $discover->discoverFromURL($homeuri);
679
680             $huburi = $discover->getAtomLink('hub');
681             $salmonuri = $discover->getAtomLink('salmon');
682
683             if (!$huburi) {
684                 // We can only deal with folks with a PuSH hub
685                 throw new FeedSubNoHubException();
686             }
687         }
688
689         $profile = new Profile();
690         $profile->nickname   = $nickname;
691         $profile->fullname   = $actor->displayName;
692         $profile->homepage   = $actor->link; // @fixme
693         $profile->profileurl = $homeuri;
694         // @fixme bio
695         // @fixme tags/categories
696         // @fixme location?
697         // @todo tags from categories
698         // @todo lat/lon/location?
699
700         $ok = $profile->insert();
701         if (!$ok) {
702             throw new ServerException("Can't save local profile");
703         }
704
705         // @fixme either need to do feed discovery here
706         // or need to split out some of the feed stuff
707         // so we can leave it empty until later.
708         $oprofile = new Ostatus_profile();
709         $oprofile->uri = $homeuri;
710         $oprofile->feeduri = $feeduri;
711         $oprofile->salmonuri = $salmonuri;
712         $oprofile->profile_id = $profile->id;
713
714         $oprofile->created = common_sql_now();
715         $oprofile->modified = common_sql_now();
716
717         $ok = $oprofile->insert();
718         if ($ok) {
719             $oprofile->updateAvatar($avatar);
720             return $oprofile;
721         } else {
722             throw new ServerException("Can't save OStatus profile");
723         }
724     }
725
726     /**
727      * @fixme move this into Activity?
728      * @param Activity $activity
729      * @return string
730      */
731     protected static function getAuthorNick($activity)
732     {
733         // @fixme not technically part of the actor?
734         foreach (array($activity->entry, $activity->feed) as $source) {
735             $author = ActivityUtils::child($source, 'author', Activity::ATOM);
736             if ($author) {
737                 $name = ActivityUtils::child($author, 'name', Activity::ATOM);
738                 if ($name) {
739                     return trim($name->textContent);
740                 }
741             }
742         }
743         return false;
744     }
745
746 }