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