plugins/OStatus/lib/salmonaction.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 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  * @author James Walker <james@status.net>
  23  */
  24
  25 if (!defined('GNUSOCIAL')) { exit(1); }
  26
  27 class SalmonAction extends Action
  28 {
  29     protected $needPost = true;
  30
  31     protected $oprofile = null; // Ostatus_profile of the actor
  32     protected $actor    = null; // Profile object of the actor
  33
  34     var $xml      = null;
  35     var $activity = null;
  36     var $target   = null;
  37
  38     protected function prepare(array $args=array())
  39     {
  40         GNUsocial::setApi(true); // Send smaller error pages
  41
  42         parent::prepare($args);
  43
  44         if (!isset($_SERVER['CONTENT_TYPE'])) {
  45             // TRANS: Client error. Do not translate "Content-type"
  46             $this->clientError(_m('Salmon requires a Content-type header.'));
  47         }
  48         $envxml = null;
  49         switch ($_SERVER['CONTENT_TYPE']) {
  50         case 'application/magic-envelope+xml':
  51             $envxml = file_get_contents('php://input');
  52             break;
  53         case 'application/x-www-form-urlencoded':
  54             $envxml = Magicsig::base64_url_decode($this->trimmed('xml'));
  55             break;
  56         default:
  57             // TRANS: Client error. Do not translate the quoted "application/[type]" strings.
  58             throw new ClientException(_m('Salmon requires "application/magic-envelope+xml". For Diaspora we also accept "application/x-www-form-urlencoded" with an "xml" parameter.', 415));
  59         }
  60
  61         if (empty($envxml)) {
  62             throw new ClientException('No magic envelope supplied in POST.');
  63         }
  64         try {
  65             $magic_env = new MagicEnvelope($envxml);   // parse incoming XML as a MagicEnvelope
  66
  67             $entry = $magic_env->getPayload();  // Not cryptographically verified yet!
  68             $this->activity = new Activity($entry->documentElement);
  69             if (empty($this->activity->actor->id)) {
  70                 common_log(LOG_ERR, "broken actor: " . var_export($this->activity->actor->id, true));
  71                 common_log(LOG_ERR, "activity with no actor: " . var_export($this->activity, true));
  72                 // TRANS: Exception.
  73                 throw new ClientException(_m('Activity in salmon slap has no actor id.'));
  74             }
  75             // ensureProfiles sets $this->actor and $this->oprofile
  76             $this->ensureProfiles();
  77         } catch (Exception $e) {
  78             common_debug('Salmon envelope parsing failed with: '.$e->getMessage());
  79             // convert exception to ClientException
  80             throw new ClientException($e->getMessage());
  81         }
  82
  83         // Cryptographic verification test, throws exception on failure
  84         $magic_env->verify($this->actor);
  85
  86         return true;
  87     }
  88
  89     /**
  90      * Check the posted activity type and break out to appropriate processing.
  91      */
  92
  93     protected function handle()
  94     {
  95         parent::handle();
  96
  97         assert($this->activity instanceof Activity);
  98         assert($this->target instanceof Profile);
  99
 100         common_log(LOG_DEBUG, "Got a " . $this->activity->verb);
 101         try {
 102             $options = [ 'source' => 'ostatus' ];
 103             common_debug('Save salmon slap directly with Notice::saveActivity for actor=='.$this->actor->getID());
 104             $stored = Notice::saveActivity($this->activity, $this->actor, $options);
 105             common_debug('Save salmon slap finished, notice id=='.$stored->getID());
 106             return true;
 107         } catch (AlreadyFulfilledException $e) {
 108             // The action's results are already fulfilled. Maybe it was a
 109             // duplicate? Maybe someone's database is out of sync?
 110             // Let's just accept it and move on.
 111             common_log(LOG_INFO, 'Salmon slap carried an event which had already been fulfilled.');
 112             return true;
 113         } catch (NoticeSaveException $e) {
 114             common_debug('Notice::saveActivity did not save our '._ve($this->activity->verb).' activity, trying old-fashioned salmon saving.');
 115         }
 116
 117         try {
 118             if (Event::handle('StartHandleSalmonTarget', array($this->activity, $this->target)) &&
 119                     Event::handle('StartHandleSalmon', array($this->activity))) {
 120                 switch ($this->activity->verb) {
 121                 case ActivityVerb::POST:
 122                     $this->handlePost();
 123                     break;
 124                 case ActivityVerb::SHARE:
 125                     $this->handleShare();
 126                     break;
 127                 case ActivityVerb::FOLLOW:
 128                 case ActivityVerb::FRIEND:
 129                     $this->handleFollow();
 130                     break;
 131                 case ActivityVerb::UNFOLLOW:
 132                     $this->handleUnfollow();
 133                     break;
 134                 case ActivityVerb::JOIN:
 135                     $this->handleJoin();
 136                     break;
 137                 case ActivityVerb::LEAVE:
 138                     $this->handleLeave();
 139                     break;
 140                 case ActivityVerb::TAG:
 141                     $this->handleTag();
 142                     break;
 143                 case ActivityVerb::UNTAG:
 144                     $this->handleUntag();
 145                     break;
 146                 case ActivityVerb::UPDATE_PROFILE:
 147                     $this->handleUpdateProfile();
 148                     break;
 149                 default:
 150                     // TRANS: Client exception.
 151                     throw new ClientException(_m('Unrecognized activity type.'));
 152                 }
 153                 Event::handle('EndHandleSalmon', array($this->activity));
 154                 Event::handle('EndHandleSalmonTarget', array($this->activity, $this->target));
 155             }
 156         } catch (AlreadyFulfilledException $e) {
 157             // The action's results are already fulfilled. Maybe it was a
 158             // duplicate? Maybe someone's database is out of sync?
 159             // Let's just accept it and move on.
 160             common_log(LOG_INFO, 'Salmon slap carried an event which had already been fulfilled.');
 161         }
 162     }
 163
 164     function handlePost()
 165     {
 166         // TRANS: Client exception.
 167         throw new ClientException(_m('This target does not understand posts.'));
 168     }
 169
 170     function handleFollow()
 171     {
 172         // TRANS: Client exception.
 173         throw new ClientException(_m('This target does not understand follows.'));
 174     }
 175
 176     function handleUnfollow()
 177     {
 178         // TRANS: Client exception.
 179         throw new ClientException(_m('This target does not understand unfollows.'));
 180     }
 181
 182     function handleShare()
 183     {
 184         // TRANS: Client exception.
 185         throw new ClientException(_m('This target does not understand share events.'));
 186     }
 187
 188     function handleJoin()
 189     {
 190         // TRANS: Client exception.
 191         throw new ClientException(_m('This target does not understand joins.'));
 192     }
 193
 194     function handleLeave()
 195     {
 196         // TRANS: Client exception.
 197         throw new ClientException(_m('This target does not understand leave events.'));
 198     }
 199
 200     function handleTag()
 201     {
 202         // TRANS: Client exception.
 203         throw new ClientException(_m('This target does not understand list events.'));
 204     }
 205
 206     function handleUntag()
 207     {
 208         // TRANS: Client exception.
 209         throw new ClientException(_m('This target does not understand unlist events.'));
 210     }
 211
 212     /**
 213      * Remote user sent us an update to their profile.
 214      * If we already know them, accept the updates.
 215      */
 216     function handleUpdateProfile()
 217     {
 218         $oprofile = Ostatus_profile::getActorProfile($this->activity);
 219         if ($oprofile instanceof Ostatus_profile) {
 220             common_log(LOG_INFO, "Got a profile-update ping from $oprofile->uri");
 221             $oprofile->updateFromActivityObject($this->activity->actor);
 222         } else {
 223             common_log(LOG_INFO, "Ignoring profile-update ping from unknown " . $this->activity->actor->id);
 224         }
 225     }
 226
 227     function ensureProfiles()
 228     {
 229         try {
 230             $this->oprofile = Ostatus_profile::getActorProfile($this->activity);
 231             if (!$this->oprofile instanceof Ostatus_profile) {
 232                 throw new UnknownUriException($this->activity->actor->id);
 233             }
 234         } catch (UnknownUriException $e) {
 235             // Apparently we didn't find the Profile object based on our URI,
 236             // so OStatus doesn't have it with this URI in ostatus_profile.
 237             // Try to look it up again, remote side may have changed from http to https
 238             // or maybe publish an acct: URI now instead of an http: URL.
 239             //
 240             // Steps:
 241             // 1. Check the newly received URI. Who does it say it is?
 242             // 2. Compare these alleged identities to our local database.
 243             // 3. If we found any locally stored identities, ask it about its aliases.
 244             // 4. Do any of the aliases from our known identity match the recently introduced one?
 245             //
 246             // Example: We have stored http://example.com/user/1 but this URI says https://example.com/user/1
 247             common_debug('No local Profile object found for a magicsigned activity author URI: '.$e->object_uri);
 248             $disco = new Discovery();
 249             $xrd = $disco->lookup($e->object_uri);
 250             // Step 1: We got a bunch of discovery data for https://example.com/user/1 which includes
 251             //         aliases https://example.com/user and hopefully our original http://example.com/user/1 too
 252             $all_ids = array_merge(array($xrd->subject), $xrd->aliases);
 253
 254             if (!in_array($e->object_uri, $all_ids)) {
 255                 common_debug('The activity author URI we got was not listed itself when doing discovery on it.');
 256                 throw $e;
 257             }
 258
 259             // Go through each reported alias from lookup to see if we know this already
 260             foreach ($all_ids as $aliased_uri) {
 261                 $oprofile = Ostatus_profile::getKV('uri', $aliased_uri);
 262                 if (!$oprofile instanceof Ostatus_profile) {
 263                     continue;   // unknown locally, check the next alias
 264                 }
 265                 // Step 2: We found the alleged http://example.com/user/1 URI in our local database,
 266                 //         but this can't be trusted yet because anyone can publish any alias.
 267                 common_debug('Found a local Ostatus_profile for "'.$e->object_uri.'" with this URI: '.$aliased_uri);
 268
 269                 // We found an existing OStatus profile, but is it really the same? Do a callback to the URI's origin
 270                 // Step 3: lookup our previously known http://example.com/user/1 webfinger etc.
 271                 $xrd = $disco->lookup($oprofile->getUri()); // getUri returns ->uri, which we filtered on earlier
 272                 $doublecheck_aliases = array_merge(array($xrd->subject), $xrd->aliases);
 273                 common_debug('Trying to match known "'.$aliased_uri.'" against its returned aliases: '.implode(' ', $doublecheck_aliases));
 274                 // if we find our original URI here, it is a legitimate alias
 275                 // Step 4: Is the newly introduced https://example.com/user/1 URI in the list of aliases
 276                 //         presented by http://example.com/user/1 (i.e. do they both say they are the same identity?)
 277                 if (in_array($e->object_uri, $doublecheck_aliases)) {
 278                     $oprofile->updateUriKeys($e->object_uri, DiscoveryHints::fromXRD($xrd));
 279                     $this->oprofile = $oprofile;
 280                     break;  // don't iterate through aliases anymore
 281                 }
 282             }
 283
 284             // We might end up here after $all_ids is iterated through without a $this->oprofile value,
 285             if (!$this->oprofile instanceof Ostatus_profile) {
 286                 common_debug("We do not have a local profile to connect to this activity's author. Let's create one.");
 287                 // ensureActivityObjectProfile throws exception on failure
 288                 $this->oprofile = Ostatus_profile::ensureActivityObjectProfile($this->activity->actor);
 289             }
 290         }
 291
 292         assert($this->oprofile instanceof Ostatus_profile);
 293
 294         $this->actor = $this->oprofile->localProfile();
 295     }
 296
 297     function saveNotice()
 298     {
 299         if (!$this->oprofile instanceof Ostatus_profile) {
 300             common_debug('Ostatus_profile missing in ' . get_class(). ' profile: '.var_export($this->profile, true));
 301         }
 302         return $this->oprofile->processPost($this->activity, 'salmon');
 303     }
 304 }