lib/activityimporter.php

   1 <?php
   2 /**
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2010, StatusNet, Inc.
   5  *
   6  * class to import activities as part of a user's timeline
   7  *
   8  * PHP version 5
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  Cache
  24  * @package   StatusNet
  25  * @author    Evan Prodromou <evan@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     // This check helps protect against security problems;
  33     // your code file can't be executed directly from the web.
  34     exit(1);
  35 }
  36
  37 /**
  38  * Class comment
  39  *
  40  * @category  General
  41  * @package   StatusNet
  42  * @author    Evan Prodromou <evan@status.net>
  43  * @copyright 2010 StatusNet, Inc.
  44  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
  45  * @link      http://status.net/
  46  */
  47 class ActivityImporter extends QueueHandler
  48 {
  49     private $trusted = false;
  50
  51     /**
  52      * Function comment
  53      *
  54      * @param
  55      *
  56      * @return
  57      */
  58     function handle($data)
  59     {
  60         list($user, $author, $activity, $trusted) = $data;
  61
  62         $this->trusted = $trusted;
  63
  64         $done = null;
  65
  66         if (Event::handle('StartImportActivity',
  67                           array($user, $author, $activity, $trusted, &$done))) {
  68             try {
  69                 switch ($activity->verb) {
  70                 case ActivityVerb::FOLLOW:
  71                     $this->subscribeProfile($user, $author, $activity);
  72                     break;
  73                 case ActivityVerb::JOIN:
  74                     $this->joinGroup($user, $activity);
  75                     break;
  76                 case ActivityVerb::POST:
  77                     $this->postNote($user, $author, $activity);
  78                     break;
  79                 default:
  80                     // TRANS: Client exception thrown when using an unknown verb for the activity importer.
  81                     throw new ClientException(sprintf(_("Unknown verb: \"%s\"."),$activity->verb));
  82                 }
  83                 Event::handle('EndImportActivity',
  84                               array($user, $author, $activity, $trusted));
  85                 $done = true;
  86             } catch (ClientException $ce) {
  87                 common_log(LOG_WARNING, $ce->getMessage());
  88                 $done = true;
  89             } catch (ServerException $se) {
  90                 common_log(LOG_ERR, $se->getMessage());
  91                 $done = false;
  92             } catch (Exception $e) {
  93                 common_log(LOG_ERR, $e->getMessage());
  94                 $done = false;
  95             }
  96         }
  97         return $done;
  98     }
  99
 100     function subscribeProfile($user, $author, $activity)
 101     {
 102         $profile = $user->getProfile();
 103
 104         if ($activity->objects[0]->id == $author->id) {
 105             if (!$this->trusted) {
 106                 // TRANS: Client exception thrown when trying to force a subscription for an untrusted user.
 107                 throw new ClientException(_("Cannot force subscription for untrusted user."));
 108             }
 109
 110             $other = $activity->actor;
 111             $otherUser = User::staticGet('uri', $other->id);
 112
 113             if (!empty($otherUser)) {
 114                 $otherProfile = $otherUser->getProfile();
 115             } else {
 116                 // TRANS: Client exception thrown when trying to for a remote user to subscribe.
 117                 throw new Exception(_("Cannot force remote user to subscribe."));
 118             }
 119
 120             // XXX: don't do this for untrusted input!
 121
 122             Subscription::start($otherProfile, $profile);
 123         } else if (empty($activity->actor)
 124                    || $activity->actor->id == $author->id) {
 125
 126             $other = $activity->objects[0];
 127
 128             $otherProfile = Profile::fromUri($other->id);
 129
 130             if (empty($otherProfile)) {
 131                 // TRANS: Client exception thrown when trying to subscribe to an unknown profile.
 132                 throw new ClientException(_("Unknown profile."));
 133             }
 134
 135             Subscription::start($profile, $otherProfile);
 136         } else {
 137             // TRANS: Client exception thrown when trying to import an event not related to the importing user.
 138             throw new Exception(_("This activity seems unrelated to our user."));
 139         }
 140     }
 141
 142     function joinGroup($user, $activity)
 143     {
 144         // XXX: check that actor == subject
 145
 146         $uri = $activity->objects[0]->id;
 147
 148         $group = User_group::staticGet('uri', $uri);
 149
 150         if (empty($group)) {
 151             $oprofile = Ostatus_profile::ensureActivityObjectProfile($activity->objects[0]);
 152             if (!$oprofile->isGroup()) {
 153                 // TRANS: Client exception thrown when trying to join a remote group that is not a group.
 154                 throw new ClientException(_("Remote profile is not a group!"));
 155             }
 156             $group = $oprofile->localGroup();
 157         }
 158
 159         assert(!empty($group));
 160
 161         if ($user->isMember($group)) {
 162             // TRANS: Client exception thrown when trying to join a group the importing user is already a member of.
 163             throw new ClientException(_("User is already a member of this group."));
 164         }
 165
 166         $user->joinGroup($group);
 167     }
 168
 169     // XXX: largely cadged from Ostatus_profile::processNote()
 170
 171     function postNote($user, $author, $activity)
 172     {
 173         $note = $activity->objects[0];
 174
 175         $sourceUri = $note->id;
 176
 177         $notice = Notice::staticGet('uri', $sourceUri);
 178
 179         if (!empty($notice)) {
 180
 181             common_log(LOG_INFO, "Notice {$sourceUri} already exists.");
 182
 183             if ($this->trusted) {
 184
 185                 $profile = $notice->getProfile();
 186
 187                 $uri = $profile->getUri();
 188
 189                 if ($uri == $author->id) {
 190                     common_log(LOG_INFO, "Updating notice author from $author->id to $user->uri");
 191                     $orig = clone($notice);
 192                     $notice->profile_id = $user->id;
 193                     $notice->update($orig);
 194                     return;
 195                 } else {
 196                     // TRANS: Client exception thrown when trying to import a notice by another user.
 197                     // TRANS: %1$s is the source URI of the notice, %2$s is the URI of the author.
 198                     throw new ClientException(sprintf(_('Already know about notice %1$s and '.
 199                                                         ' it has a different author %2$s.'),
 200                                                       $sourceUri, $uri));
 201                 }
 202             } else {
 203                 // TRANS: Client exception thrown when trying to overwrite the author information for a non-trusted user during import.
 204                 throw new ClientException(_("Not overwriting author info for non-trusted user."));
 205             }
 206         }
 207
 208         // Use summary as fallback for content
 209
 210         if (!empty($note->content)) {
 211             $sourceContent = $note->content;
 212         } else if (!empty($note->summary)) {
 213             $sourceContent = $note->summary;
 214         } else if (!empty($note->title)) {
 215             $sourceContent = $note->title;
 216         } else {
 217             // @fixme fetch from $sourceUrl?
 218             // TRANS: Client exception thrown when trying to import a notice without content.
 219             // TRANS: %s is the notice URI.
 220             throw new ClientException(sprintf(_("No content for notice %s."),$sourceUri));
 221         }
 222
 223         // Get (safe!) HTML and text versions of the content
 224
 225         $rendered = $this->purify($sourceContent);
 226         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
 227
 228         $shortened = $user->shortenLinks($content);
 229
 230         $options = array('is_local' => Notice::LOCAL_PUBLIC,
 231                          'uri' => $sourceUri,
 232                          'rendered' => $rendered,
 233                          'replies' => array(),
 234                          'groups' => array(),
 235                          'tags' => array(),
 236                          'urls' => array(),
 237                          'distribute' => false);
 238
 239         // Check for optional attributes...
 240
 241         if (!empty($activity->time)) {
 242             $options['created'] = common_sql_date($activity->time);
 243         }
 244
 245         if ($activity->context) {
 246             // Any individual or group attn: targets?
 247
 248             list($options['groups'], $options['replies']) = $this->filterAttention($activity->context->attention);
 249
 250             // Maintain direct reply associations
 251             // @fixme what about conversation ID?
 252             if (!empty($activity->context->replyToID)) {
 253                 $orig = Notice::staticGet('uri',
 254                                           $activity->context->replyToID);
 255                 if (!empty($orig)) {
 256                     $options['reply_to'] = $orig->id;
 257                 }
 258             }
 259
 260             $location = $activity->context->location;
 261
 262             if ($location) {
 263                 $options['lat'] = $location->lat;
 264                 $options['lon'] = $location->lon;
 265                 if ($location->location_id) {
 266                     $options['location_ns'] = $location->location_ns;
 267                     $options['location_id'] = $location->location_id;
 268                 }
 269             }
 270         }
 271
 272         // Atom categories <-> hashtags
 273
 274         foreach ($activity->categories as $cat) {
 275             if ($cat->term) {
 276                 $term = common_canonical_tag($cat->term);
 277                 if ($term) {
 278                     $options['tags'][] = $term;
 279                 }
 280             }
 281         }
 282
 283         // Atom enclosures -> attachment URLs
 284         foreach ($activity->enclosures as $href) {
 285             // @fixme save these locally or....?
 286             $options['urls'][] = $href;
 287         }
 288
 289         common_log(LOG_INFO, "Saving notice {$options['uri']}");
 290
 291         $saved = Notice::saveNew($user->id,
 292                                  $content,
 293                                  'restore', // TODO: restore the actual source
 294                                  $options);
 295
 296         return $saved;
 297     }
 298
 299     function filterAttention($attn)
 300     {
 301         $groups = array();
 302         $replies = array();
 303
 304         foreach (array_unique($attn) as $recipient) {
 305
 306             // Is the recipient a local user?
 307
 308             $user = User::staticGet('uri', $recipient);
 309
 310             if ($user) {
 311                 // @fixme sender verification, spam etc?
 312                 $replies[] = $recipient;
 313                 continue;
 314             }
 315
 316             // Is the recipient a remote group?
 317             $oprofile = Ostatus_profile::ensureProfileURI($recipient);
 318
 319             if ($oprofile) {
 320                 if (!$oprofile->isGroup()) {
 321                     // may be canonicalized or something
 322                     $replies[] = $oprofile->uri;
 323                 }
 324                 continue;
 325             }
 326
 327             // Is the recipient a local group?
 328             // @fixme uri on user_group isn't reliable yet
 329             // $group = User_group::staticGet('uri', $recipient);
 330             $id = OStatusPlugin::localGroupFromUrl($recipient);
 331
 332             if ($id) {
 333                 $group = User_group::staticGet('id', $id);
 334                 if ($group) {
 335                     // Deliver to all members of this local group if allowed.
 336                     $profile = $sender->localProfile();
 337                     if ($profile->isMember($group)) {
 338                         $groups[] = $group->id;
 339                     } else {
 340                         common_log(LOG_INFO, "Skipping reply to local group {$group->nickname} as sender {$profile->id} is not a member");
 341                     }
 342                     continue;
 343                 } else {
 344                     common_log(LOG_INFO, "Skipping reply to bogus group $recipient");
 345                 }
 346             }
 347         }
 348
 349         return array($groups, $replies);
 350     }
 351
 352
 353     function purify($content)
 354     {
 355         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 356
 357         $config = array('safe' => 1,
 358                         'deny_attribute' => 'id,style,on*');
 359
 360         return htmLawed($content, $config);
 361     }
 362 }