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 (Exception $e) {
  87                 common_log(LOG_ERR, $e->getMessage());
  88                 $done = true;
  89             }
  90         }
  91         return $done;
  92     }
  93
  94     function subscribeProfile($user, $author, $activity)
  95     {
  96         $profile = $user->getProfile();
  97
  98         if ($activity->objects[0]->id == $author->id) {
  99             if (!$this->trusted) {
 100                 // TRANS: Client exception thrown when trying to force a subscription for an untrusted user.
 101                 throw new ClientException(_("Cannot force subscription for untrusted user."));
 102             }
 103
 104             $other = $activity->actor;
 105             $otherUser = User::staticGet('uri', $other->id);
 106
 107             if (!empty($otherUser)) {
 108                 $otherProfile = $otherUser->getProfile();
 109             } else {
 110                 // TRANS: Client exception thrown when trying to for a remote user to subscribe.
 111                 throw new Exception(_("Cannot force remote user to subscribe."));
 112             }
 113
 114             // XXX: don't do this for untrusted input!
 115
 116             Subscription::start($otherProfile, $profile);
 117         } else if (empty($activity->actor)
 118                    || $activity->actor->id == $author->id) {
 119
 120             $other = $activity->objects[0];
 121
 122             $otherProfile = Profile::fromUri($other->id);
 123
 124             if (empty($otherProfile)) {
 125                 // TRANS: Client exception thrown when trying to subscribe to an unknown profile.
 126                 throw new ClientException(_("Unknown profile."));
 127             }
 128
 129             Subscription::start($profile, $otherProfile);
 130         } else {
 131             // TRANS: Client exception thrown when trying to import an event not related to the importing user.
 132             throw new Exception(_("This activity seems unrelated to our user."));
 133         }
 134     }
 135
 136     function joinGroup($user, $activity)
 137     {
 138         // XXX: check that actor == subject
 139
 140         $uri = $activity->objects[0]->id;
 141
 142         $group = User_group::staticGet('uri', $uri);
 143
 144         if (empty($group)) {
 145             $oprofile = Ostatus_profile::ensureActivityObjectProfile($activity->objects[0]);
 146             if (!$oprofile->isGroup()) {
 147                 // TRANS: Client exception thrown when trying to join a remote group that is not a group.
 148                 throw new ClientException(_("Remote profile is not a group!"));
 149             }
 150             $group = $oprofile->localGroup();
 151         }
 152
 153         assert(!empty($group));
 154
 155         if ($user->isMember($group)) {
 156             // TRANS: Client exception thrown when trying to join a group the importing user is already a member of.
 157             throw new ClientException(_("User is already a member of this group."));
 158         }
 159
 160         if (Event::handle('StartJoinGroup', array($group, $user))) {
 161             Group_member::join($group->id, $user->id);
 162             Event::handle('EndJoinGroup', array($group, $user));
 163         }
 164     }
 165
 166     // XXX: largely cadged from Ostatus_profile::processNote()
 167
 168     function postNote($user, $author, $activity)
 169     {
 170         $note = $activity->objects[0];
 171
 172         $sourceUri = $note->id;
 173
 174         $notice = Notice::staticGet('uri', $sourceUri);
 175
 176         if (!empty($notice)) {
 177
 178             common_log(LOG_INFO, "Notice {$sourceUri} already exists.");
 179
 180             if ($this->trusted) {
 181
 182                 $profile = $notice->getProfile();
 183
 184                 $uri = $profile->getUri();
 185
 186                 if ($uri == $author->id) {
 187                     common_log(LOG_INFO, "Updating notice author from $author->id to $user->uri");
 188                     $orig = clone($notice);
 189                     $notice->profile_id = $user->id;
 190                     $notice->update($orig);
 191                     return;
 192                 } else {
 193                     // TRANS: Client exception thrown when trying to import a notice by another user.
 194                     // TRANS: %1$s is the source URI of the notice, %2$s is the URI of the author.
 195                     throw new ClientException(sprintf(_('Already know about notice %1$s and '.
 196                                                         ' it has a different author %2$s.'),
 197                                                       $sourceUri, $uri));
 198                 }
 199             } else {
 200                 // TRANS: Client exception thrown when trying to overwrite the author information for a non-trusted user during import.
 201                 throw new ClientException(_("Not overwriting author info for non-trusted user."));
 202             }
 203         }
 204
 205         // Use summary as fallback for content
 206
 207         if (!empty($note->content)) {
 208             $sourceContent = $note->content;
 209         } else if (!empty($note->summary)) {
 210             $sourceContent = $note->summary;
 211         } else if (!empty($note->title)) {
 212             $sourceContent = $note->title;
 213         } else {
 214             // @fixme fetch from $sourceUrl?
 215             // TRANS: Client exception thrown when trying to import a notice without content.
 216             // TRANS: %s is the notice URI.
 217             throw new ClientException(sprintf(_("No content for notice %s."),$sourceUri));
 218         }
 219
 220         // Get (safe!) HTML and text versions of the content
 221
 222         $rendered = $this->purify($sourceContent);
 223         $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
 224
 225         $shortened = $user->shortenLinks($content);
 226
 227         $options = array('is_local' => Notice::LOCAL_PUBLIC,
 228                          'uri' => $sourceUri,
 229                          'rendered' => $rendered,
 230                          'replies' => array(),
 231                          'groups' => array(),
 232                          'tags' => array(),
 233                          'urls' => array(),
 234                          'distribute' => false);
 235
 236         // Check for optional attributes...
 237
 238         if (!empty($activity->time)) {
 239             $options['created'] = common_sql_date($activity->time);
 240         }
 241
 242         if ($activity->context) {
 243             // Any individual or group attn: targets?
 244
 245             list($options['groups'], $options['replies']) = $this->filterAttention($activity->context->attention);
 246
 247             // Maintain direct reply associations
 248             // @fixme what about conversation ID?
 249             if (!empty($activity->context->replyToID)) {
 250                 $orig = Notice::staticGet('uri',
 251                                           $activity->context->replyToID);
 252                 if (!empty($orig)) {
 253                     $options['reply_to'] = $orig->id;
 254                 }
 255             }
 256
 257             $location = $activity->context->location;
 258
 259             if ($location) {
 260                 $options['lat'] = $location->lat;
 261                 $options['lon'] = $location->lon;
 262                 if ($location->location_id) {
 263                     $options['location_ns'] = $location->location_ns;
 264                     $options['location_id'] = $location->location_id;
 265                 }
 266             }
 267         }
 268
 269         // Atom categories <-> hashtags
 270
 271         foreach ($activity->categories as $cat) {
 272             if ($cat->term) {
 273                 $term = common_canonical_tag($cat->term);
 274                 if ($term) {
 275                     $options['tags'][] = $term;
 276                 }
 277             }
 278         }
 279
 280         // Atom enclosures -> attachment URLs
 281         foreach ($activity->enclosures as $href) {
 282             // @fixme save these locally or....?
 283             $options['urls'][] = $href;
 284         }
 285
 286         common_log(LOG_INFO, "Saving notice {$options['uri']}");
 287
 288         $saved = Notice::saveNew($user->id,
 289                                  $content,
 290                                  'restore', // TODO: restore the actual source
 291                                  $options);
 292
 293         return $saved;
 294     }
 295
 296     function filterAttention($attn)
 297     {
 298         $groups = array();
 299         $replies = array();
 300
 301         foreach (array_unique($attn) as $recipient) {
 302
 303             // Is the recipient a local user?
 304
 305             $user = User::staticGet('uri', $recipient);
 306
 307             if ($user) {
 308                 // @fixme sender verification, spam etc?
 309                 $replies[] = $recipient;
 310                 continue;
 311             }
 312
 313             // Is the recipient a remote group?
 314             $oprofile = Ostatus_profile::ensureProfileURI($recipient);
 315
 316             if ($oprofile) {
 317                 if (!$oprofile->isGroup()) {
 318                     // may be canonicalized or something
 319                     $replies[] = $oprofile->uri;
 320                 }
 321                 continue;
 322             }
 323
 324             // Is the recipient a local group?
 325             // @fixme uri on user_group isn't reliable yet
 326             // $group = User_group::staticGet('uri', $recipient);
 327             $id = OStatusPlugin::localGroupFromUrl($recipient);
 328
 329             if ($id) {
 330                 $group = User_group::staticGet('id', $id);
 331                 if ($group) {
 332                     // Deliver to all members of this local group if allowed.
 333                     $profile = $sender->localProfile();
 334                     if ($profile->isMember($group)) {
 335                         $groups[] = $group->id;
 336                     } else {
 337                         common_log(LOG_INFO, "Skipping reply to local group {$group->nickname} as sender {$profile->id} is not a member");
 338                     }
 339                     continue;
 340                 } else {
 341                     common_log(LOG_INFO, "Skipping reply to bogus group $recipient");
 342                 }
 343             }
 344         }
 345
 346         return array($groups, $replies);
 347     }
 348
 349
 350     function purify($content)
 351     {
 352         require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
 353
 354         $config = array('safe' => 1,
 355                         'deny_attribute' => 'id,style,on*');
 356
 357         return htmLawed($content, $config);
 358     }
 359 }