activityimporter.php 11.9 KB
Newer Older
1 2 3 4 5 6
<?php
/**
 * StatusNet - the distributed open-source microblogging tool
 * Copyright (C) 2010, StatusNet, Inc.
 *
 * class to import activities as part of a user's timeline
7
 *
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
 * PHP version 5
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  Cache
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */

31
if (!defined('GNUSOCIAL')) { exit(1); }
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

/**
 * Class comment
 *
 * @category  General
 * @package   StatusNet
 * @author    Evan Prodromou <evan@status.net>
 * @copyright 2010 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0
 * @link      http://status.net/
 */
class ActivityImporter extends QueueHandler
{
    private $trusted = false;

    /**
     * Function comment
     *
     * @param
     *
     * @return
     */
    function handle($data)
    {
        list($user, $author, $activity, $trusted) = $data;

        $this->trusted = $trusted;

60 61
        $done = null;

62 63 64
        try {
            if (Event::handle('StartImportActivity',
                              array($user, $author, $activity, $trusted, &$done))) {
65 66 67 68 69 70 71 72 73 74 75
                switch ($activity->verb) {
                case ActivityVerb::FOLLOW:
                    $this->subscribeProfile($user, $author, $activity);
                    break;
                case ActivityVerb::JOIN:
                    $this->joinGroup($user, $activity);
                    break;
                case ActivityVerb::POST:
                    $this->postNote($user, $author, $activity);
                    break;
                default:
76 77
                    // TRANS: Client exception thrown when using an unknown verb for the activity importer.
                    throw new ClientException(sprintf(_("Unknown verb: \"%s\"."),$activity->verb));
78
                }
79
                Event::handle('EndImportActivity',
80 81
                              array($user, $author, $activity, $trusted));
                $done = true;
82
            }
83 84 85
        } catch (Exception $e) {
            common_log(LOG_ERR, $e->getMessage());
            $done = true;
86
        }
87
        return $done;
88
    }
89

90 91 92 93 94
    function subscribeProfile($user, $author, $activity)
    {
        $profile = $user->getProfile();

        if ($activity->objects[0]->id == $author->id) {
95
            if (!$this->trusted) {
96
                // TRANS: Client exception thrown when trying to force a subscription for an untrusted user.
97
                throw new ClientException(_('Cannot force subscription for untrusted user.'));
98 99
            }

100
            $other = $activity->actor;
101
            $otherUser = User::getKV('uri', $other->id);
102

103
            if (!$otherUser instanceof User) {
104 105
                // TRANS: Client exception thrown when trying to force a remote user to subscribe.
                throw new Exception(_('Cannot force remote user to subscribe.'));
106 107
            }

108 109
            $otherProfile = $otherUser->getProfile();

110 111
            // XXX: don't do this for untrusted input!

112
            Subscription::ensureStart($otherProfile, $profile);
113
        } else if (empty($activity->actor)
114 115 116 117
                   || $activity->actor->id == $author->id) {

            $other = $activity->objects[0];

118 119
            try {
                $otherProfile = Profile::fromUri($other->id);
120
                // TRANS: Client exception thrown when trying to subscribe to an unknown profile.
121 122
            } catch (UnknownUriException $e) {
                // Let's convert it to a client exception instead of server.
123
                throw new ClientException(_('Unknown profile.'));
124 125
            }

126
            Subscription::ensureStart($profile, $otherProfile);
127
        } else {
128
            // TRANS: Client exception thrown when trying to import an event not related to the importing user.
129
            throw new Exception(_('This activity seems unrelated to our user.'));
130 131 132 133 134 135 136 137 138
        }
    }

    function joinGroup($user, $activity)
    {
        // XXX: check that actor == subject

        $uri = $activity->objects[0]->id;

139
        $group = User_group::getKV('uri', $uri);
140

141
        if (!$group instanceof User_group) {
142 143
            $oprofile = Ostatus_profile::ensureActivityObjectProfile($activity->objects[0]);
            if (!$oprofile->isGroup()) {
144
                // TRANS: Client exception thrown when trying to join a remote group that is not a group.
145
                throw new ClientException(_('Remote profile is not a group!'));
146 147 148 149 150 151
            }
            $group = $oprofile->localGroup();
        }

        assert(!empty($group));

152
        if ($user->isMember($group)) {
153 154
            // TRANS: Client exception thrown when trying to join a group the importing user is already a member of.
            throw new ClientException(_("User is already a member of this group."));
155 156
        }

157
        $user->joinGroup($group);
158 159 160 161
    }

    // XXX: largely cadged from Ostatus_profile::processNote()

162
    function postNote($user, $author, $activity)
163 164 165 166 167
    {
        $note = $activity->objects[0];

        $sourceUri = $note->id;

168
        $notice = Notice::getKV('uri', $sourceUri);
169

170
        if ($notice instanceof Notice) {
171

172 173 174 175 176 177 178 179
            common_log(LOG_INFO, "Notice {$sourceUri} already exists.");

            if ($this->trusted) {

                $profile = $notice->getProfile();

                $uri = $profile->getUri();

180 181
                if ($uri === $author->id) {
                    common_log(LOG_INFO, sprintf('Updating notice author from %s to %s', $author->id, $user->getUri()));
182 183 184 185 186
                    $orig = clone($notice);
                    $notice->profile_id = $user->id;
                    $notice->update($orig);
                    return;
                } else {
187 188
                    // TRANS: Client exception thrown when trying to import a notice by another user.
                    // TRANS: %1$s is the source URI of the notice, %2$s is the URI of the author.
189 190
                    throw new ClientException(sprintf(_('Already know about notice %1$s and '.
                                                        ' it has a different author %2$s.'),
191 192
                                                      $sourceUri, $uri));
                }
193
            } else {
194
                // TRANS: Client exception thrown when trying to overwrite the author information for a non-trusted user during import.
195
                throw new ClientException(_('Not overwriting author info for non-trusted user.'));
196
            }
197 198 199 200 201 202 203 204 205 206 207 208
        }

        // Use summary as fallback for content

        if (!empty($note->content)) {
            $sourceContent = $note->content;
        } else if (!empty($note->summary)) {
            $sourceContent = $note->summary;
        } else if (!empty($note->title)) {
            $sourceContent = $note->title;
        } else {
            // @fixme fetch from $sourceUrl?
209 210
            // TRANS: Client exception thrown when trying to import a notice without content.
            // TRANS: %s is the notice URI.
211
            throw new ClientException(sprintf(_('No content for notice %s.'),$sourceUri));
212 213 214 215
        }

        // Get (safe!) HTML and text versions of the content

216
        $rendered = common_purify($sourceContent);
217
        $content = common_strip_html($rendered);
218 219 220 221 222 223 224 225 226

        $shortened = $user->shortenLinks($content);

        $options = array('is_local' => Notice::LOCAL_PUBLIC,
                         'uri' => $sourceUri,
                         'rendered' => $rendered,
                         'replies' => array(),
                         'groups' => array(),
                         'tags' => array(),
227 228
                         'urls' => array(),
                         'distribute' => false);
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243

        // Check for optional attributes...

        if (!empty($activity->time)) {
            $options['created'] = common_sql_date($activity->time);
        }

        if ($activity->context) {
            // Any individual or group attn: targets?

            list($options['groups'], $options['replies']) = $this->filterAttention($activity->context->attention);

            // Maintain direct reply associations
            // @fixme what about conversation ID?
            if (!empty($activity->context->replyToID)) {
244 245
                $orig = Notice::getKV('uri', $activity->context->replyToID);
                if ($orig instanceof Notice) {
246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
                    $options['reply_to'] = $orig->id;
                }
            }

            $location = $activity->context->location;

            if ($location) {
                $options['lat'] = $location->lat;
                $options['lon'] = $location->lon;
                if ($location->location_id) {
                    $options['location_ns'] = $location->location_ns;
                    $options['location_id'] = $location->location_id;
                }
            }
        }

        // Atom categories <-> hashtags

        foreach ($activity->categories as $cat) {
            if ($cat->term) {
                $term = common_canonical_tag($cat->term);
                if ($term) {
                    $options['tags'][] = $term;
                }
            }
        }

        // Atom enclosures -> attachment URLs
        foreach ($activity->enclosures as $href) {
            // @fixme save these locally or....?
            $options['urls'][] = $href;
        }

279 280
        common_log(LOG_INFO, "Saving notice {$options['uri']}");

281 282 283 284 285 286 287 288
        $saved = Notice::saveNew($user->id,
                                 $content,
                                 'restore', // TODO: restore the actual source
                                 $options);

        return $saved;
    }

289
    protected function filterAttention(array $attn)
290
    {
291 292
        $groups = array();  // TODO: context->attention
        $replies = array(); // TODO: context->attention
293

294
        foreach ($attn as $recipient=>$type) {
295 296 297

            // Is the recipient a local user?

298
            $user = User::getKV('uri', $recipient);
299

300 301
            if ($user instanceof User) {
                // TODO: @fixme sender verification, spam etc?
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317
                $replies[] = $recipient;
                continue;
            }

            // Is the recipient a remote group?
            $oprofile = Ostatus_profile::ensureProfileURI($recipient);

            if ($oprofile) {
                if (!$oprofile->isGroup()) {
                    // may be canonicalized or something
                    $replies[] = $oprofile->uri;
                }
                continue;
            }

            // Is the recipient a local group?
318
            // TODO: @fixme uri on user_group isn't reliable yet
319
            // $group = User_group::getKV('uri', $recipient);
320 321 322
            $id = OStatusPlugin::localGroupFromUrl($recipient);

            if ($id) {
323
                $group = User_group::getKV('id', $id);
324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341
                if ($group) {
                    // Deliver to all members of this local group if allowed.
                    $profile = $sender->localProfile();
                    if ($profile->isMember($group)) {
                        $groups[] = $group->id;
                    } else {
                        common_log(LOG_INFO, "Skipping reply to local group {$group->nickname} as sender {$profile->id} is not a member");
                    }
                    continue;
                } else {
                    common_log(LOG_INFO, "Skipping reply to bogus group $recipient");
                }
            }
        }

        return array($groups, $replies);
    }
}