3 * StatusNet, the distributed open-source microblogging tool
7 * LICENCE: This program is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU Affero General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU Affero General Public License for more details.
17 * You should have received a copy of the GNU Affero General Public License
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
22 * @author Zach Copley <zach@status.net>
23 * @author Julien C <chaumond@gmail.com>
24 * @author Brion Vibber <brion@status.net>
25 * @copyright 2009-2010 StatusNet, Inc.
26 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
27 * @link http://status.net/
30 if (!defined('STATUSNET')) {
34 require_once dirname(__DIR__) . '/twitter.php';
37 * Encapsulation of the Twitter status -> notice incoming bridge import.
38 * Is used by both the polling twitterstatusfetcher.php daemon, and the
39 * in-progress streaming import.
43 * @author Zach Copley <zach@status.net>
44 * @author Julien C <chaumond@gmail.com>
45 * @author Brion Vibber <brion@status.net>
46 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
47 * @link http://status.net/
48 * @link http://twitter.com/
52 public $avatarsizename = 'reasonably_small'; // a Twitter size name for 128x128 px
53 public $avatarsize = 128; // they're square...
55 public function importStatus($status)
57 // Hacktastic: filter out stuff coming from this StatusNet
58 $source = mb_strtolower(common_config('integration', 'source'));
60 if (preg_match("/$source/", mb_strtolower($status->source))) {
61 common_debug(__METHOD__ . ' - Skipping import of status ' .
62 twitter_id($status) . " with source {$source}");
66 // Don't save it if the user is protected
67 // FIXME: save it but treat it as private
68 if ($status->user->protected) {
72 $notice = $this->saveStatus($status);
79 return get_class($this);
82 function saveStatus($status)
84 $profile = $this->ensureProfile($status->user);
86 if (empty($profile)) {
87 common_log(LOG_ERR, __METHOD__ . ' - Problem saving notice. No associated Profile.');
91 $statusId = twitter_id($status);
92 $statusUri = $this->makeStatusURI($status->user->screen_name, $statusId);
94 // check to see if we've already imported the status
95 $n2s = Notice_to_status::getKV('status_id', $statusId);
100 __METHOD__ . " - Ignoring duplicate import: {$statusId}"
102 return Notice::getKV('id', $n2s->notice_id);
105 $dupe = Notice::getKV('uri', $statusUri);
106 if($dupe instanceof Notice) {
107 // Add it to our record
108 Notice_to_status::saveNew($dupe->id, $statusId);
111 __METHOD__ . " - Ignoring duplicate import: {$statusId}"
116 // If it's a retweet, save it as a repeat!
117 if (!empty($status->retweeted_status)) {
118 common_log(LOG_INFO, "Status {$statusId} is a retweet of " . twitter_id($status->retweeted_status) . ".");
119 $original = $this->saveStatus($status->retweeted_status);
120 if (empty($original)) {
123 $author = $original->getProfile();
124 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
125 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
126 $content = sprintf(_m('RT @%1$s %2$s'),
130 if (Notice::contentTooLong($content)) {
131 $contentlimit = Notice::maxContent();
132 $content = mb_substr($content, 0, $contentlimit - 4) . ' ...';
135 $repeat = Notice::saveNew($profile->id,
138 array('repeat_of' => $original->id,
140 'is_local' => Notice::GATEWAY,
141 'object_type' => ActivityObject::NOTE,
142 'verb' => ActivityVerb::POST
144 common_log(LOG_INFO, "Saved {$repeat->id} as a repeat of {$original->id}");
145 Notice_to_status::saveNew($repeat->id, $statusId);
150 $notice = new Notice();
152 $notice->profile_id = $profile->id;
153 $notice->uri = $statusUri;
154 $notice->url = $statusUri;
155 $notice->verb = ActivityVerb::POST;
156 $notice->object_type = ActivityObject::NOTE;
157 $notice->created = strftime(
159 strtotime($status->created_at)
162 $notice->source = 'twitter';
164 $notice->reply_to = null;
166 $replyTo = twitter_id($status, 'in_reply_to_status_id');
167 if (!empty($replyTo)) {
168 common_log(LOG_INFO, "Status {$statusId} is a reply to status {$replyTo}");
169 $n2s = Notice_to_status::getKV('status_id', $replyTo);
171 common_log(LOG_INFO, "Couldn't find local notice for status {$replyTo}");
173 $reply = Notice::getKV('id', $n2s->notice_id);
175 common_log(LOG_INFO, "Couldn't find local notice for status {$replyTo}");
177 common_log(LOG_INFO, "Found local notice {$reply->id} for status {$replyTo}");
178 $notice->reply_to = $reply->id;
179 $notice->conversation = $reply->conversation;
184 $notice->is_local = Notice::GATEWAY;
186 $notice->content = html_entity_decode($this->linkify($status, FALSE), ENT_QUOTES, 'UTF-8');
187 $notice->rendered = $this->linkify($status, TRUE);
189 if (Event::handle('StartNoticeSave', array(&$notice))) {
191 if (empty($notice->conversation)) {
192 $conv = Conversation::create();
193 common_log(LOG_INFO, "No known conversation for status {$statusId} so a new one ({$conv->getID()}) was created.");
194 $notice->conversation = $conv->getID();
197 $id = $notice->insert();
200 common_log_db_error($notice, 'INSERT', __FILE__);
201 common_log(LOG_ERR, __METHOD__ . ' - Problem saving notice.');
204 Event::handle('EndNoticeSave', array($notice));
207 Notice_to_status::saveNew($notice->id, $statusId);
209 $this->saveStatusMentions($notice, $status);
210 $this->saveStatusAttachments($notice, $status);
212 $notice->blowOnInsert();
218 * Make an URI for a status.
220 * @param object $status status object
224 function makeStatusURI($username, $id)
226 return 'https://twitter.com/'
234 * Look up a Profile by profileurl field. Profile::getKV() was
235 * not working consistently.
237 * @param string $nickname local nickname of the Twitter user
238 * @param string $profileurl the profile url
240 * @return mixed value the first Profile with that url, or null
242 protected function getProfileByUrl($nickname, $profileurl)
244 $profile = new Profile();
245 $profile->nickname = $nickname;
246 $profile->profileurl = $profileurl;
249 if (!$profile->find(true)) {
250 $profile->profileurl = str_replace('https://', 'http://', $profileurl);
251 if (!$profile->find(true)) {
252 throw new NoResultException($profile);
258 protected function ensureProfile($twuser)
260 // check to see if there's already a profile for this user
261 $profileurl = 'https://twitter.com/' . $twuser->screen_name;
263 $profile = $this->getProfileByUrl($twuser->screen_name, $profileurl);
264 $this->updateAvatar($twuser, $profile);
266 } catch (NoResultException $e) {
267 common_debug(__METHOD__ . ' - Adding profile and remote profile ' .
268 "for Twitter user: $profileurl.");
271 $profile = new Profile();
272 $profile->query("BEGIN");
273 $profile->nickname = $twuser->screen_name;
274 $profile->fullname = $twuser->name;
275 $profile->homepage = $twuser->url;
276 $profile->bio = $twuser->description;
277 $profile->location = $twuser->location;
278 $profile->profileurl = $profileurl;
279 $profile->created = common_sql_now();
282 $id = $profile->insert(); // insert _should_ throw exception on failure
284 throw new Exception('Failed insert');
286 } catch(Exception $e) {
287 common_log(LOG_WARNING, __METHOD__ . " Couldn't insert profile: " . $e->getMessage());
288 common_log_db_error($profile, 'INSERT', __FILE__);
289 $profile->query("ROLLBACK");
293 $profile->query("COMMIT");
294 $this->updateAvatar($twuser, $profile);
299 * Checks whether we have to update the profile's avatar
301 * @return true when updated, false on failure, null when no action taken
303 protected function updateAvatar($twuser, Profile $profile)
305 $path_parts = pathinfo($twuser->profile_image_url);
306 $ext = isset($path_parts['extension'])
307 ? '.'.$path_parts['extension']
308 : ''; // some lack extension
309 $img_root = basename($path_parts['basename'], '_normal'.$ext); // cut off extension
310 $filename = "Twitter_{$twuser->id}_{$img_root}_{$this->avatarsizename}{$ext}";
313 $avatar = Avatar::getUploaded($profile);
314 if ($avatar->filename === $filename) {
317 common_debug(__METHOD__ . " - Updating profile avatar (profile_id={$profile->id}) " .
318 "from {$avatar->filename} to {$filename}");
319 // else we continue with creating a new avatar
320 } catch (NoAvatarException $e) {
321 // Avatar was not found. We can catch NoAvatarException or FileNotFoundException
322 // but generally we just want to continue creating a new avatar.
323 common_debug(__METHOD__ . " - No avatar found for (profile_id={$profile->id})");
326 $url = "{$path_parts['dirname']}/{$img_root}_{$this->avatarsizename}{$ext}";
327 $mediatype = $this->getMediatype(mb_substr($ext, 1));
330 $this->newAvatar($profile, $url, $filename, $mediatype);
331 } catch (Exception $e) {
332 if (file_exists(Avatar::path($filename))) {
333 unlink(Avatar::path($filename));
341 protected function getMediatype($ext)
345 switch (strtolower($ext)) {
348 $mediatype = 'image/jpeg';
351 $mediatype = 'image/gif';
354 $mediatype = 'image/png';
360 protected function newAvatar(Profile $profile, $url, $filename, $mediatype)
362 // Clear out old avatars, won't do anything if there are none
363 Avatar::deleteFromProfile($profile);
365 // throws exception if unable to fetch
366 $this->fetchRemoteUrl($url, Avatar::path($filename));
368 $avatar = new Avatar();
369 $avatar->profile_id = $profile->id;
370 $avatar->original = 1; // this is an original/"uploaded" avatar
371 $avatar->mediatype = $mediatype;
372 $avatar->filename = $filename;
373 $avatar->width = $this->avatarsize;
374 $avatar->height = $this->avatarsize;
376 $avatar->created = common_sql_now();
378 $id = $avatar->insert();
381 common_log(LOG_WARNING, __METHOD__ . " Couldn't insert avatar - " . $e->getMessage());
382 common_log_db_error($avatar, 'INSERT', __FILE__);
383 throw new ServerException('Could not insert avatar');
386 common_debug(__METHOD__ . " - Saved new avatar for {$profile->id}.");
392 * Fetch a remote avatar image and save to local storage.
394 * @param string $url avatar source URL
395 * @param string $filename bare local filename for download
396 * @return bool true on success, false on failure
398 protected function fetchRemoteUrl($url, $filename)
400 common_debug(__METHOD__ . " - Fetching Twitter avatar: {$url} to {$filename}");
401 $request = HTTPClient::start();
402 $request->setConfig('connect_timeout', 3); // I had problems with throttling
403 $request->setConfig('timeout', 6); // and locking the process sucks.
404 $response = $request->get($url);
405 if ($response->isOk()) {
406 if (!file_put_contents($filename, $response->getBody())) {
407 throw new ServerException('Failed saving fetched file');
410 throw new Exception('Unexpected HTTP status code');
419 function linkify($status, $html = FALSE)
421 $text = $status->text;
423 if (empty($status->entities)) {
424 $statusId = twitter_id($status);
425 common_log(LOG_WARNING, "No entities data for {$statusId}; trying to fake up links ourselves.");
426 $text = common_replace_urls_callback($text, 'common_linkify');
427 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/',
428 function ($m) { return $m[1].'#'.TwitterStatusFetcher::tagLink($m[2]); }, $text);
429 $text = preg_replace_callback('/(^|\s+)@([a-z0-9A-Z_]{1,64})/',
430 function ($m) { return $m[1].'@'.TwitterStatusFetcher::atLink($m[2]); }, $text);
434 // Move all the entities into order so we can
435 // replace them and escape surrounding plaintext
438 $toReplace = array();
440 if (!empty($status->entities->urls)) {
441 foreach ($status->entities->urls as $url) {
442 $toReplace[$url->indices[0]] = array(self::URL, $url);
446 if (!empty($status->entities->hashtags)) {
447 foreach ($status->entities->hashtags as $hashtag) {
448 $toReplace[$hashtag->indices[0]] = array(self::HASHTAG, $hashtag);
452 if (!empty($status->entities->user_mentions)) {
453 foreach ($status->entities->user_mentions as $mention) {
454 $toReplace[$mention->indices[0]] = array(self::MENTION, $mention);
458 // sort in forward order by key
465 foreach ($toReplace as $part) {
466 list($type, $object) = $part;
467 $start = $object->indices[0];
468 $end = $object->indices[1];
469 if ($cursor < $start) {
470 // Copy in the preceding plaintext
471 $result .= $this->twitEscape(mb_substr($text, $cursor, $start - $cursor));
474 $orig = $this->twitEscape(mb_substr($text, $start, $end - $start));
477 $linkText = $this->makeUrlLink($object, $orig, $html);
481 $linkText = $this->makeHashtagLink($object, $orig);
488 $linkText = $this->makeMentionLink($object, $orig);
497 $result .= $linkText;
500 $last = $this->twitEscape(mb_substr($text, $cursor));
506 function twitEscape($str)
508 // Twitter seems to preemptive turn < and > into < and >
509 // but doesn't for &, so while you may have some magic protection
510 // against XSS by not bothing to escape manually, you still get
511 // invalid XHTML. Thanks!
513 // Looks like their web interface pretty much sends anything
514 // through intact, so.... to do equivalent, decode all entities
515 // and then re-encode the special ones.
516 return htmlspecialchars(html_entity_decode($str, ENT_COMPAT, 'UTF-8'));
519 function makeUrlLink($object, $orig, $html)
522 return '<a href="'.htmlspecialchars($object->expanded_url).'" class="extlink">'.htmlspecialchars($object->display_url).'</a>';
524 return htmlspecialchars($object->expanded_url);
528 function makeHashtagLink($object, $orig)
530 return "#" . self::tagLink($object->text, substr($orig, 1));
533 function makeMentionLink($object, $orig)
535 return "@".self::atLink($object->screen_name, $object->name, substr($orig, 1));
538 static function tagLink($tag, $orig)
540 return "<a href='https://twitter.com/search?q=%23{$tag}' class='hashtag'>{$orig}</a>";
543 static function atLink($screenName, $fullName, $orig)
545 if (!empty($fullName)) {
546 return "<a href='https://twitter.com/{$screenName}' title='{$fullName}'>{$orig}</a>";
548 return "<a href='https://twitter.com/{$screenName}'>{$orig}</a>";
552 function saveStatusMentions($notice, $status)
556 if (empty($status->entities) || empty($status->entities->user_mentions)) {
560 foreach ($status->entities->user_mentions as $mention) {
562 $flink = Foreign_link::getByForeignID($mention->id, TWITTER_SERVICE);
563 $user = $flink->getUser();
564 $reply = new Reply();
565 $reply->notice_id = $notice->id;
566 $reply->profile_id = $user->id;
567 $reply->modified = $notice->created;
568 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice {$notice->id} to profile {$user->id}");
569 $id = $reply->insert();
570 } catch (NoSuchUserException $e) {
571 common_log(LOG_WARNING, 'No local user found for Foreign_link with id: '.$mention->id);
572 } catch (NoResultException $e) {
573 common_log(LOG_WARNING, 'No foreign link or profile found for Foreign_link with id: '.$mention->id);
579 * Record URL links from the notice. Needed to get thumbnail records
580 * for referenced photo and video posts, etc.
582 * @param Notice $notice
583 * @param object $status
585 function saveStatusAttachments(Notice $notice, $status)
587 if (common_config('attachments', 'process_links')) {
588 if (!empty($status->entities) && !empty($status->entities->urls)) {
589 foreach ($status->entities->urls as $url) {
591 File::processNew($url->url, $notice);
592 } catch (ServerException $e) {
593 // Could not process attached URL