3 * StatusNet - the distributed open-source microblogging tool
4 * Copyright (C) 2010, StatusNet, Inc.
6 * class to import activities as part of a user's timeline
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.
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.
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/>.
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/
31 if (!defined('STATUSNET')) {
32 // This check helps protect against security problems;
33 // your code file can't be executed directly from the web.
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/
47 class ActivityImporter extends QueueHandler
49 private $trusted = false;
58 function handle($data)
60 list($user, $author, $activity, $trusted) = $data;
62 $this->trusted = $trusted;
67 if (Event::handle('StartImportActivity',
68 array($user, $author, $activity, $trusted, &$done))) {
69 switch ($activity->verb) {
70 case ActivityVerb::FOLLOW:
71 $this->subscribeProfile($user, $author, $activity);
73 case ActivityVerb::JOIN:
74 $this->joinGroup($user, $activity);
76 case ActivityVerb::POST:
77 $this->postNote($user, $author, $activity);
80 // TRANS: Client exception thrown when using an unknown verb for the activity importer.
81 throw new ClientException(sprintf(_("Unknown verb: \"%s\"."),$activity->verb));
83 Event::handle('EndImportActivity',
84 array($user, $author, $activity, $trusted));
87 } catch (Exception $e) {
88 common_log(LOG_ERR, $e->getMessage());
94 function subscribeProfile($user, $author, $activity)
96 $profile = $user->getProfile();
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.'));
104 $other = $activity->actor;
105 $otherUser = User::getKV('uri', $other->id);
107 if (!empty($otherUser)) {
108 $otherProfile = $otherUser->getProfile();
110 // TRANS: Client exception thrown when trying to force a remote user to subscribe.
111 throw new Exception(_('Cannot force remote user to subscribe.'));
114 // XXX: don't do this for untrusted input!
116 Subscription::start($otherProfile, $profile);
117 } else if (empty($activity->actor)
118 || $activity->actor->id == $author->id) {
120 $other = $activity->objects[0];
122 $otherProfile = Profile::fromUri($other->id);
124 if (empty($otherProfile)) {
125 // TRANS: Client exception thrown when trying to subscribe to an unknown profile.
126 throw new ClientException(_('Unknown profile.'));
129 Subscription::start($profile, $otherProfile);
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.'));
136 function joinGroup($user, $activity)
138 // XXX: check that actor == subject
140 $uri = $activity->objects[0]->id;
142 $group = User_group::getKV('uri', $uri);
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!'));
150 $group = $oprofile->localGroup();
153 assert(!empty($group));
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."));
160 $user->joinGroup($group);
163 // XXX: largely cadged from Ostatus_profile::processNote()
165 function postNote($user, $author, $activity)
167 $note = $activity->objects[0];
169 $sourceUri = $note->id;
171 $notice = Notice::getKV('uri', $sourceUri);
173 if (!empty($notice)) {
175 common_log(LOG_INFO, "Notice {$sourceUri} already exists.");
177 if ($this->trusted) {
179 $profile = $notice->getProfile();
181 $uri = $profile->getUri();
183 if ($uri == $author->id) {
184 common_log(LOG_INFO, "Updating notice author from $author->id to $user->uri");
185 $orig = clone($notice);
186 $notice->profile_id = $user->id;
187 $notice->update($orig);
190 // TRANS: Client exception thrown when trying to import a notice by another user.
191 // TRANS: %1$s is the source URI of the notice, %2$s is the URI of the author.
192 throw new ClientException(sprintf(_('Already know about notice %1$s and '.
193 ' it has a different author %2$s.'),
197 // TRANS: Client exception thrown when trying to overwrite the author information for a non-trusted user during import.
198 throw new ClientException(_('Not overwriting author info for non-trusted user.'));
202 // Use summary as fallback for content
204 if (!empty($note->content)) {
205 $sourceContent = $note->content;
206 } else if (!empty($note->summary)) {
207 $sourceContent = $note->summary;
208 } else if (!empty($note->title)) {
209 $sourceContent = $note->title;
211 // @fixme fetch from $sourceUrl?
212 // TRANS: Client exception thrown when trying to import a notice without content.
213 // TRANS: %s is the notice URI.
214 throw new ClientException(sprintf(_('No content for notice %s.'),$sourceUri));
217 // Get (safe!) HTML and text versions of the content
219 $rendered = $this->purify($sourceContent);
220 $content = html_entity_decode(strip_tags($rendered), ENT_QUOTES, 'UTF-8');
222 $shortened = $user->shortenLinks($content);
224 $options = array('is_local' => Notice::LOCAL_PUBLIC,
226 'rendered' => $rendered,
227 'replies' => array(),
231 'distribute' => false);
233 // Check for optional attributes...
235 if (!empty($activity->time)) {
236 $options['created'] = common_sql_date($activity->time);
239 if ($activity->context) {
240 // Any individual or group attn: targets?
242 list($options['groups'], $options['replies']) = $this->filterAttention($activity->context->attention);
244 // Maintain direct reply associations
245 // @fixme what about conversation ID?
246 if (!empty($activity->context->replyToID)) {
247 $orig = Notice::getKV('uri',
248 $activity->context->replyToID);
250 $options['reply_to'] = $orig->id;
254 $location = $activity->context->location;
257 $options['lat'] = $location->lat;
258 $options['lon'] = $location->lon;
259 if ($location->location_id) {
260 $options['location_ns'] = $location->location_ns;
261 $options['location_id'] = $location->location_id;
266 // Atom categories <-> hashtags
268 foreach ($activity->categories as $cat) {
270 $term = common_canonical_tag($cat->term);
272 $options['tags'][] = $term;
277 // Atom enclosures -> attachment URLs
278 foreach ($activity->enclosures as $href) {
279 // @fixme save these locally or....?
280 $options['urls'][] = $href;
283 common_log(LOG_INFO, "Saving notice {$options['uri']}");
285 $saved = Notice::saveNew($user->id,
287 'restore', // TODO: restore the actual source
293 protected function filterAttention(array $attn)
295 $groups = array(); // TODO: context->attention
296 $replies = array(); // TODO: context->attention
298 foreach ($attn as $recipient=>$type) {
300 // Is the recipient a local user?
302 $user = User::getKV('uri', $recipient);
304 if ($user instanceof User) {
305 // TODO: @fixme sender verification, spam etc?
306 $replies[] = $recipient;
310 // Is the recipient a remote group?
311 $oprofile = Ostatus_profile::ensureProfileURI($recipient);
314 if (!$oprofile->isGroup()) {
315 // may be canonicalized or something
316 $replies[] = $oprofile->uri;
321 // Is the recipient a local group?
322 // TODO: @fixme uri on user_group isn't reliable yet
323 // $group = User_group::getKV('uri', $recipient);
324 $id = OStatusPlugin::localGroupFromUrl($recipient);
327 $group = User_group::getKV('id', $id);
329 // Deliver to all members of this local group if allowed.
330 $profile = $sender->localProfile();
331 if ($profile->isMember($group)) {
332 $groups[] = $group->id;
334 common_log(LOG_INFO, "Skipping reply to local group {$group->nickname} as sender {$profile->id} is not a member");
338 common_log(LOG_INFO, "Skipping reply to bogus group $recipient");
343 return array($groups, $replies);
347 function purify($content)
349 require_once INSTALLDIR.'/extlib/htmLawed/htmLawed.php';
351 $config = array('safe' => 1,
352 'deny_attribute' => 'id,style,on*');
354 return htmLawed($content, $config);