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
 102         try {
 103             $options = [ 'source' => 'ostatus' ];
 104             common_debug('Save salmon slap directly with Notice::saveActivity for actor=='.$this->actor->getID());
 105             $stored = Notice::saveActivity($this->activity, $this->actor, $options);
 106             common_debug('Save salmon slap finished, notice id=='.$stored->getID());
 107             return true;
 108         } catch (AlreadyFulfilledException $e) {
 109             // The action's results are already fulfilled. Maybe it was a
 110             // duplicate? Maybe someone's database is out of sync?
 111             // Let's just accept it and move on.
 112             common_log(LOG_INFO, 'Salmon slap carried an event which had already been fulfilled.');
 113             return true;
 114         } catch (NoticeSaveException $e) {
 115             common_debug('Notice::saveActivity did not save our '._ve($this->activity->verb).' activity, trying old-fashioned salmon saving.');
 116         }
 117
 118         try {
 119             if (Event::handle('StartHandleSalmonTarget', array($this->activity, $this->target)) &&
 120                     Event::handle('StartHandleSalmon', array($this->activity))) {
 121                 switch ($this->activity->verb) {
 122                 case ActivityVerb::POST:
 123                     $this->handlePost();
 124                     break;
 125                 case ActivityVerb::SHARE:
 126                     $this->handleShare();
 127                     break;
 128                 case ActivityVerb::FOLLOW:
 129                 case ActivityVerb::FRIEND:
 130                     $this->handleFollow();
 131                     break;
 132                 case ActivityVerb::UNFOLLOW:
 133                     $this->handleUnfollow();
 134                     break;
 135                 case ActivityVerb::JOIN:
 136                     $this->handleJoin();
 137                     break;
 138                 case ActivityVerb::LEAVE:
 139                     $this->handleLeave();
 140                     break;
 141                 case ActivityVerb::TAG:
 142                     $this->handleTag();
 143                     break;
 144                 case ActivityVerb::UNTAG:
 145                     $this->handleUntag();
 146                     break;
 147                 case ActivityVerb::UPDATE_PROFILE:
 148                     $this->handleUpdateProfile();
 149                     break;
 150                 default:
 151                     // TRANS: Client exception.
 152                     throw new ClientException(_m('Unrecognized activity type.'));
 153                 }
 154                 Event::handle('EndHandleSalmon', array($this->activity));
 155                 Event::handle('EndHandleSalmonTarget', array($this->activity, $this->target));
 156             }
 157         } catch (AlreadyFulfilledException $e) {
 158             // The action's results are already fulfilled. Maybe it was a
 159             // duplicate? Maybe someone's database is out of sync?
 160             // Let's just accept it and move on.
 161             common_log(LOG_INFO, 'Salmon slap carried an event which had already been fulfilled.');
 162         }
 163     }
 164
 165     function handlePost()
 166     {
 167         // TRANS: Client exception.
 168         throw new ClientException(_m('This target does not understand posts.'));
 169     }
 170
 171     function handleFollow()
 172     {
 173         // TRANS: Client exception.
 174         throw new ClientException(_m('This target does not understand follows.'));
 175     }
 176
 177     function handleUnfollow()
 178     {
 179         // TRANS: Client exception.
 180         throw new ClientException(_m('This target does not understand unfollows.'));
 181     }
 182
 183     function handleShare()
 184     {
 185         // TRANS: Client exception.
 186         throw new ClientException(_m('This target does not understand share events.'));
 187     }
 188
 189     function handleJoin()
 190     {
 191         // TRANS: Client exception.
 192         throw new ClientException(_m('This target does not understand joins.'));
 193     }
 194
 195     function handleLeave()
 196     {
 197         // TRANS: Client exception.
 198         throw new ClientException(_m('This target does not understand leave events.'));
 199     }
 200
 201     function handleTag()
 202     {
 203         // TRANS: Client exception.
 204         throw new ClientException(_m('This target does not understand list events.'));
 205     }
 206
 207     function handleUntag()
 208     {
 209         // TRANS: Client exception.
 210         throw new ClientException(_m('This target does not understand unlist events.'));
 211     }
 212
 213     /**
 214      * Remote user sent us an update to their profile.
 215      * If we already know them, accept the updates.
 216      */
 217     function handleUpdateProfile()
 218     {
 219         $oprofile = Ostatus_profile::getActorProfile($this->activity);
 220         if ($oprofile instanceof Ostatus_profile) {
 221             common_log(LOG_INFO, "Got a profile-update ping from $oprofile->uri");
 222             $oprofile->updateFromActivityObject($this->activity->actor);
 223         } else {
 224             common_log(LOG_INFO, "Ignoring profile-update ping from unknown " . $this->activity->actor->id);
 225         }
 226     }
 227
 228     function ensureProfiles()
 229     {
 230         try {
 231             $this->oprofile = Ostatus_profile::getActorProfile($this->activity);
 232             if (!$this->oprofile instanceof Ostatus_profile) {
 233                 throw new UnknownUriException($this->activity->actor->id);
 234             }
 235         } catch (UnknownUriException $e) {
 236             // Apparently we didn't find the Profile object based on our URI,
 237             // so OStatus doesn't have it with this URI in ostatus_profile.
 238             // Try to look it up again, remote side may have changed from http to https
 239             // or maybe publish an acct: URI now instead of an http: URL.
 240             //
 241             // Steps:
 242             // 1. Check the newly received URI. Who does it say it is?
 243             // 2. Compare these alleged identities to our local database.
 244             // 3. If we found any locally stored identities, ask it about its aliases.
 245             // 4. Do any of the aliases from our known identity match the recently introduced one?
 246             //
 247             // Example: We have stored http://example.com/user/1 but this URI says https://example.com/user/1
 248             common_debug('No local Profile object found for a magicsigned activity author URI: '.$e->object_uri);
 249             $disco = new Discovery();
 250             $xrd = $disco->lookup($e->object_uri);
 251             // Step 1: We got a bunch of discovery data for https://example.com/user/1 which includes
 252             //         aliases https://example.com/user and hopefully our original http://example.com/user/1 too
 253             $all_ids = array_merge(array($xrd->subject), $xrd->aliases);
 254
 255             if (!in_array($e->object_uri, $all_ids)) {
 256                 common_debug('The activity author URI we got was not listed itself when doing discovery on it.');
 257                 throw $e;
 258             }
 259
 260             // Go through each reported alias from lookup to see if we know this already
 261             foreach ($all_ids as $aliased_uri) {
 262                 $oprofile = Ostatus_profile::getKV('uri', $aliased_uri);
 263                 if (!$oprofile instanceof Ostatus_profile) {
 264                     continue;   // unknown locally, check the next alias
 265                 }
 266                 // Step 2: We found the alleged http://example.com/user/1 URI in our local database,
 267                 //         but this can't be trusted yet because anyone can publish any alias.
 268                 common_debug('Found a local Ostatus_profile for "'.$e->object_uri.'" with this URI: '.$aliased_uri);
 269
 270                 // We found an existing OStatus profile, but is it really the same? Do a callback to the URI's origin
 271                 // Step 3: lookup our previously known http://example.com/user/1 webfinger etc.
 272                 $xrd = $disco->lookup($oprofile->getUri()); // getUri returns ->uri, which we filtered on earlier
 273                 $doublecheck_aliases = array_merge(array($xrd->subject), $xrd->aliases);
 274                 common_debug('Trying to match known "'.$aliased_uri.'" against its returned aliases: '.implode(' ', $doublecheck_aliases));
 275                 // if we find our original URI here, it is a legitimate alias
 276                 // Step 4: Is the newly introduced https://example.com/user/1 URI in the list of aliases
 277                 //         presented by http://example.com/user/1 (i.e. do they both say they are the same identity?)
 278                 if (in_array($e->object_uri, $doublecheck_aliases)) {
 279                     $oprofile->updateUriKeys($e->object_uri, DiscoveryHints::fromXRD($xrd));
 280                     $this->oprofile = $oprofile;
 281                     break;  // don't iterate through aliases anymore
 282                 }
 283             }
 284
 285             // We might end up here after $all_ids is iterated through without a $this->oprofile value,
 286             if (!$this->oprofile instanceof Ostatus_profile) {
 287                 common_debug("We do not have a local profile to connect to this activity's author. Let's create one.");
 288                 // ensureActivityObjectProfile throws exception on failure
 289                 $this->oprofile = Ostatus_profile::ensureActivityObjectProfile($this->activity->actor);
 290             }
 291         }
 292
 293         assert($this->oprofile instanceof Ostatus_profile);
 294
 295         $this->actor = $this->oprofile->localProfile();
 296     }
 297
 298     function saveNotice()
 299     {
 300         if (!$this->oprofile instanceof Ostatus_profile) {
 301             common_debug('Ostatus_profile missing in ' . get_class(). ' profile: '.var_export($this->profile, true));
 302         }
 303         return $this->oprofile->processPost($this->activity, 'salmon');
 304     }
 305 }