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 INSTALLDIR . '/plugins/TwitterBridge/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 // If it's a retweet, save it as a repeat!
106 if (!empty($status->retweeted_status)) {
107 common_log(LOG_INFO, "Status {$statusId} is a retweet of " . twitter_id($status->retweeted_status) . ".");
108 $original = $this->saveStatus($status->retweeted_status);
109 if (empty($original)) {
112 $author = $original->getProfile();
113 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
114 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
115 $content = sprintf(_m('RT @%1$s %2$s'),
119 if (Notice::contentTooLong($content)) {
120 $contentlimit = Notice::maxContent();
121 $content = mb_substr($content, 0, $contentlimit - 4) . ' ...';
124 $repeat = Notice::saveNew($profile->id,
127 array('repeat_of' => $original->id,
129 'is_local' => Notice::GATEWAY));
130 common_log(LOG_INFO, "Saved {$repeat->id} as a repeat of {$original->id}");
131 Notice_to_status::saveNew($repeat->id, $statusId);
136 $notice = new Notice();
138 $notice->profile_id = $profile->id;
139 $notice->uri = $statusUri;
140 $notice->url = $statusUri;
141 $notice->created = strftime(
143 strtotime($status->created_at)
146 $notice->source = 'twitter';
148 $notice->reply_to = null;
150 $replyTo = twitter_id($status, 'in_reply_to_status_id');
151 if (!empty($replyTo)) {
152 common_log(LOG_INFO, "Status {$statusId} is a reply to status {$replyTo}");
153 $n2s = Notice_to_status::getKV('status_id', $replyTo);
155 common_log(LOG_INFO, "Couldn't find local notice for status {$replyTo}");
157 $reply = Notice::getKV('id', $n2s->notice_id);
159 common_log(LOG_INFO, "Couldn't find local notice for status {$replyTo}");
161 common_log(LOG_INFO, "Found local notice {$reply->id} for status {$replyTo}");
162 $notice->reply_to = $reply->id;
163 $notice->conversation = $reply->conversation;
168 if (empty($notice->conversation)) {
169 $conv = Conversation::create();
170 $notice->conversation = $conv->id;
171 common_log(LOG_INFO, "No known conversation for status {$statusId} so making a new one {$conv->id}.");
174 $notice->is_local = Notice::GATEWAY;
176 $notice->content = html_entity_decode($this->linkify($status, FALSE), ENT_QUOTES, 'UTF-8');
177 $notice->rendered = $this->linkify($status, TRUE);
179 if (Event::handle('StartNoticeSave', array(&$notice))) {
181 $id = $notice->insert();
184 common_log_db_error($notice, 'INSERT', __FILE__);
185 common_log(LOG_ERR, __METHOD__ . ' - Problem saving notice.');
188 Event::handle('EndNoticeSave', array($notice));
191 Notice_to_status::saveNew($notice->id, $statusId);
193 $this->saveStatusMentions($notice, $status);
194 $this->saveStatusAttachments($notice, $status);
196 $notice->blowOnInsert();
202 * Make an URI for a status.
204 * @param object $status status object
208 function makeStatusURI($username, $id)
210 return 'http://twitter.com/#!/'
218 * Look up a Profile by profileurl field. Profile::getKV() was
219 * not working consistently.
221 * @param string $nickname local nickname of the Twitter user
222 * @param string $profileurl the profile url
224 * @return mixed value the first Profile with that url, or null
226 protected function getProfileByUrl($nickname, $profileurl)
228 $profile = new Profile();
229 $profile->nickname = $nickname;
230 $profile->profileurl = $profileurl;
233 if (!$profile->find(true)) {
234 throw new NoResultException($profile);
239 protected function ensureProfile($twuser)
241 // check to see if there's already a profile for this user
242 $profileurl = 'http://twitter.com/' . $twuser->screen_name;
244 $profile = $this->getProfileByUrl($twuser->screen_name, $profileurl);
245 $this->updateAvatar($twuser, $profile);
247 } catch (NoResultException $e) {
248 common_debug(__METHOD__ . ' - Adding profile and remote profile ' .
249 "for Twitter user: $profileurl.");
252 $profile = new Profile();
253 $profile->query("BEGIN");
254 $profile->nickname = $twuser->screen_name;
255 $profile->fullname = $twuser->name;
256 $profile->homepage = $twuser->url;
257 $profile->bio = $twuser->description;
258 $profile->location = $twuser->location;
259 $profile->profileurl = $profileurl;
260 $profile->created = common_sql_now();
263 $id = $profile->insert(); // insert _should_ throw exception on failure
265 throw new Exception('Failed insert');
267 } catch(Exception $e) {
268 common_log(LOG_WARNING, __METHOD__ . " Couldn't insert profile: " . $e->getMessage());
269 common_log_db_error($profile, 'INSERT', __FILE__);
270 $profile->query("ROLLBACK");
274 // check for remote profile
275 $remote_pro = Remote_profile::getKV('uri', $profileurl);
277 if (!($remote_pro instanceof Remote_profile)) {
278 $remote_pro = new Remote_profile();
279 $remote_pro->id = $id;
280 $remote_pro->uri = $profileurl;
281 $remote_pro->created = common_sql_now();
284 $rid = $remote_pro->insert();
286 throw new Exception('Failed insert');
288 } catch (Exception $e) {
289 common_log(LOG_WARNING, __METHOD__ . " Couldn't save remote profile: " . $e->getMessage());
290 common_log_db_error($profile, 'INSERT', __FILE__);
291 $profile->query("ROLLBACK");
296 $profile->query("COMMIT");
297 $this->updateAvatar($twuser, $profile);
302 * Checks whether we have to update the profile's avatar
304 * @return true when updated, false on failure, null when no action taken
306 protected function updateAvatar($twuser, Profile $profile)
308 $path_parts = pathinfo($twuser->profile_image_url);
309 $ext = isset($path_parts['extension'])
310 ? '.'.$path_parts['extension']
311 : ''; // some lack extension
312 $img_root = basename($path_parts['basename'], '_normal'.$ext); // cut off extension
313 $filename = "Twitter_{$twuser->id}_{$img_root}_{$this->avatarsizename}{$ext}";
316 $avatar = Avatar::getUploaded($profile);
317 if ($avatar->filename === $filename) {
320 common_debug(__METHOD__ . " - Updating profile avatar (profile_id={$profile->id}) " .
321 "from {$avatar->filename} to {$filename}");
322 // else we continue with creating a new avatar
323 } catch (NoAvatarException $e) {
324 // Avatar was not found. We can catch NoAvatarException or FileNotFoundException
325 // but generally we just want to continue creating a new avatar.
326 common_debug(__METHOD__ . " - No avatar found for (profile_id={$profile->id})");
329 $url = "{$path_parts['dirname']}/{$img_root}_{$this->avatarsizename}{$ext}";
330 $mediatype = $this->getMediatype(mb_substr($ext, 1));
333 $this->newAvatar($profile, $url, $filename, $mediatype);
334 } catch (Exception $e) {
335 if (file_exists(Avatar::path($filename))) {
336 unlink(Avatar::path($filename));
344 protected function getMediatype($ext)
348 switch (strtolower($ext)) {
351 $mediatype = 'image/jpeg';
354 $mediatype = 'image/gif';
357 $mediatype = 'image/png';
363 protected function newAvatar(Profile $profile, $url, $filename, $mediatype)
365 // Clear out old avatars, won't do anything if there are none
366 Avatar::deleteFromProfile($profile);
368 // throws exception if unable to fetch
369 $this->fetchRemoteUrl($url, Avatar::path($filename));
371 $avatar = new Avatar();
372 $avatar->profile_id = $profile->id;
373 $avatar->original = 1; // this is an original/"uploaded" avatar
374 $avatar->mediatype = $mediatype;
375 $avatar->filename = $filename;
376 $avatar->url = Avatar::url($filename);
377 $avatar->width = $this->avatarsize;
378 $avatar->height = $this->avatarsize;
380 $avatar->created = common_sql_now();
382 $id = $avatar->insert();
385 common_log(LOG_WARNING, __METHOD__ . " Couldn't insert avatar - " . $e->getMessage());
386 common_log_db_error($avatar, 'INSERT', __FILE__);
387 throw new ServerException('Could not insert avatar');
390 common_debug(__METHOD__ . " - Saved new avatar for {$profile->id}.");
396 * Fetch a remote avatar image and save to local storage.
398 * @param string $url avatar source URL
399 * @param string $filename bare local filename for download
400 * @return bool true on success, false on failure
402 protected function fetchRemoteUrl($url, $filename)
404 common_debug(__METHOD__ . " - Fetching Twitter avatar: {$url} to {$filename}");
405 $request = HTTPClient::start();
406 $request->setConfig('connect_timeout', 3); // I had problems with throttling
407 $request->setConfig('timeout', 6); // and locking the process sucks.
408 $response = $request->get($url);
409 if ($response->isOk()) {
410 if (!file_put_contents($filename, $response->getBody())) {
411 throw new ServerException('Failed saving fetched file');
414 throw new Exception('Unexpected HTTP status code');
423 function linkify($status, $html = FALSE)
425 $text = $status->text;
427 if (empty($status->entities)) {
428 $statusId = twitter_id($status);
429 common_log(LOG_WARNING, "No entities data for {$statusId}; trying to fake up links ourselves.");
430 $text = common_replace_urls_callback($text, 'common_linkify');
431 $text = preg_replace_callback('/(^|\"\;|\'|\(|\[|\{|\s+)#([\pL\pN_\-\.]{1,64})/',
432 function ($m) { return $m[1].'#'.TwitterStatusFetcher::tagLink($m[2]); }, $text);
433 $text = preg_replace_callback('/(^|\s+)@([a-z0-9A-Z_]{1,64})/',
434 function ($m) { return $m[1].'@'.TwitterStatusFetcher::atLink($m[2]); }, $text);
438 // Move all the entities into order so we can
439 // replace them and escape surrounding plaintext
442 $toReplace = array();
444 if (!empty($status->entities->urls)) {
445 foreach ($status->entities->urls as $url) {
446 $toReplace[$url->indices[0]] = array(self::URL, $url);
450 if (!empty($status->entities->hashtags)) {
451 foreach ($status->entities->hashtags as $hashtag) {
452 $toReplace[$hashtag->indices[0]] = array(self::HASHTAG, $hashtag);
456 if (!empty($status->entities->user_mentions)) {
457 foreach ($status->entities->user_mentions as $mention) {
458 $toReplace[$mention->indices[0]] = array(self::MENTION, $mention);
462 // sort in forward order by key
469 foreach ($toReplace as $part) {
470 list($type, $object) = $part;
471 $start = $object->indices[0];
472 $end = $object->indices[1];
473 if ($cursor < $start) {
474 // Copy in the preceding plaintext
475 $result .= $this->twitEscape(mb_substr($text, $cursor, $start - $cursor));
478 $orig = $this->twitEscape(mb_substr($text, $start, $end - $start));
481 $linkText = $this->makeUrlLink($object, $orig, $html);
485 $linkText = $this->makeHashtagLink($object, $orig);
492 $linkText = $this->makeMentionLink($object, $orig);
501 $result .= $linkText;
504 $last = $this->twitEscape(mb_substr($text, $cursor));
510 function twitEscape($str)
512 // Twitter seems to preemptive turn < and > into < and >
513 // but doesn't for &, so while you may have some magic protection
514 // against XSS by not bothing to escape manually, you still get
515 // invalid XHTML. Thanks!
517 // Looks like their web interface pretty much sends anything
518 // through intact, so.... to do equivalent, decode all entities
519 // and then re-encode the special ones.
520 return htmlspecialchars(html_entity_decode($str, ENT_COMPAT, 'UTF-8'));
523 function makeUrlLink($object, $orig, $html)
526 return '<a href="'.htmlspecialchars($object->expanded_url).'" class="extlink">'.htmlspecialchars($object->display_url).'</a>';
528 return htmlspecialchars($object->expanded_url);
532 function makeHashtagLink($object, $orig)
534 return "#" . self::tagLink($object->text, substr($orig, 1));
537 function makeMentionLink($object, $orig)
539 return "@".self::atLink($object->screen_name, $object->name, substr($orig, 1));
542 static function tagLink($tag, $orig)
544 return "<a href='https://search.twitter.com/search?q=%23{$tag}' class='hashtag'>{$orig}</a>";
547 static function atLink($screenName, $fullName, $orig)
549 if (!empty($fullName)) {
550 return "<a href='http://twitter.com/#!/{$screenName}' title='{$fullName}'>{$orig}</a>";
552 return "<a href='http://twitter.com/#!/{$screenName}'>{$orig}</a>";
556 function saveStatusMentions($notice, $status)
560 if (empty($status->entities) || empty($status->entities->user_mentions)) {
564 foreach ($status->entities->user_mentions as $mention) {
565 $flink = Foreign_link::getByForeignID($mention->id, TWITTER_SERVICE);
566 if (!empty($flink)) {
567 $user = User::getKV('id', $flink->user_id);
569 $reply = new Reply();
570 $reply->notice_id = $notice->id;
571 $reply->profile_id = $user->id;
572 $reply->modified = $notice->created;
573 common_log(LOG_INFO, __METHOD__ . ": saving reply: notice {$notice->id} to profile {$user->id}");
574 $id = $reply->insert();
581 * Record URL links from the notice. Needed to get thumbnail records
582 * for referenced photo and video posts, etc.
584 * @param Notice $notice
585 * @param object $status
587 function saveStatusAttachments($notice, $status)
589 if (common_config('attachments', 'process_links')) {
590 if (!empty($status->entities) && !empty($status->entities->urls)) {
591 foreach ($status->entities->urls as $url) {
592 File::processNew($url->url, $notice->id);