4 * StatusNet - the distributed open-source microblogging tool
5 * Copyright (C) 2008, 2009, StatusNet, Inc.
7 * 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/>.
21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..'));
23 // Tune number of processes and how often to poll Twitter
24 // XXX: Should these things be in config.php?
25 define('MAXCHILDREN', 2);
26 define('POLL_INTERVAL', 60); // in seconds
28 $shortoptions = 'di::';
29 $longoptions = array('id::', 'debug');
31 $helptext = <<<END_OF_TRIM_HELP
32 Batch script for retrieving Twitter messages from foreign service.
34 -i --id Identity (default 'generic')
35 -d --debug Debug (lots of log output)
39 require_once INSTALLDIR . '/scripts/commandline.inc';
40 require_once INSTALLDIR . '/lib/common.php';
41 require_once INSTALLDIR . '/lib/daemon.php';
42 require_once INSTALLDIR . '/plugins/TwitterBridge/twitter.php';
43 require_once INSTALLDIR . '/plugins/TwitterBridge/twitterbasicauthclient.php';
44 require_once INSTALLDIR . '/plugins/TwitterBridge/twitteroauthclient.php';
47 * Fetcher for statuses from Twitter
49 * Fetches statuses from Twitter and inserts them as notices in local
54 * @author Zach Copley <zach@status.net>
55 * @author Evan Prodromou <evan@status.net>
56 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
57 * @link http://status.net/
60 // NOTE: an Avatar path MUST be set in config.php for this
61 // script to work: e.g.: $config['avatar']['path'] = '/statusnet/avatar';
63 class TwitterStatusFetcher extends ParallelizingDaemon
68 * @param string $id the name/id of this daemon
69 * @param int $interval sleep this long before doing everything again
70 * @param int $max_children maximum number of child processes at a time
71 * @param boolean $debug debug output flag
76 function __construct($id = null, $interval = 60,
77 $max_children = 2, $debug = null)
79 parent::__construct($id, $interval, $max_children, $debug);
85 * @return string Name of the daemon.
90 return ('twitterstatusfetcher.'.$this->_id);
94 * Find all the Twitter foreign links for users who have requested
95 * importing of their friends' timelines
97 * @return array flinks an array of Foreign_link objects
100 function getObjects()
102 global $_DB_DATAOBJECT;
104 $flink = new Foreign_link();
105 $conn = &$flink->getDatabaseConnection();
107 $flink->service = TWITTER_SERVICE;
108 $flink->orderBy('last_noticesync');
112 common_log(LOG_INFO, "hello");
114 while ($flink->fetch()) {
116 if (($flink->noticesync & FOREIGN_NOTICE_RECV) ==
117 FOREIGN_NOTICE_RECV) {
118 $flinks[] = clone($flink);
119 common_log(LOG_INFO, "sync: foreign id $flink->foreign_id");
121 common_log(LOG_INFO, "nothing to sync");
129 unset($_DB_DATAOBJECT['CONNECTIONS']);
134 function childTask($flink) {
136 // Each child ps needs its own DB connection
138 // Note: DataObject::getDatabaseConnection() creates
139 // a new connection if there isn't one already
141 $conn = &$flink->getDatabaseConnection();
143 $this->getTimeline($flink);
145 $flink->last_friendsync = common_sql_now();
150 // XXX: Couldn't find a less brutal way to blow
151 // away a cached connection
153 global $_DB_DATAOBJECT;
154 unset($_DB_DATAOBJECT['CONNECTIONS']);
157 function getTimeline($flink)
160 common_log(LOG_WARNING, $this->name() .
161 " - Can't retrieve Foreign_link for foreign ID $fid");
165 common_debug($this->name() . ' - Trying to get timeline for Twitter user ' .
168 // XXX: Biggest remaining issue - How do we know at which status
169 // to start importing? How many statuses? Right now I'm going
170 // with the default last 20.
174 if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
175 $token = TwitterOAuthClient::unpackToken($flink->credentials);
176 $client = new TwitterOAuthClient($token->key, $token->secret);
177 common_debug($this->name() . ' - Grabbing friends timeline with OAuth.');
179 $client = new TwitterBasicAuthClient($flink);
180 common_debug($this->name() . ' - Grabbing friends timeline with basic auth.');
186 $timeline = $client->statusesFriendsTimeline();
187 } catch (Exception $e) {
188 common_log(LOG_WARNING, $this->name() .
189 ' - Twitter client unable to get friends timeline for user ' .
190 $flink->user_id . ' - code: ' .
191 $e->getCode() . 'msg: ' . $e->getMessage());
194 if (empty($timeline)) {
195 common_log(LOG_WARNING, $this->name() . " - Empty timeline.");
199 // Reverse to preserve order
201 foreach (array_reverse($timeline) as $status) {
203 // Hacktastic: filter out stuff coming from this StatusNet
205 $source = mb_strtolower(common_config('integration', 'source'));
207 if (preg_match("/$source/", mb_strtolower($status->source))) {
208 common_debug($this->name() . ' - Skipping import of status ' .
209 $status->id . ' with source ' . $source);
213 $this->saveStatus($status, $flink);
216 // Okay, record the time we synced with Twitter for posterity
218 $flink->last_noticesync = common_sql_now();
222 function saveStatus($status, $flink)
224 $id = $this->ensureProfile($status->user);
226 $profile = Profile::staticGet($id);
228 if (empty($profile)) {
229 common_log(LOG_ERR, $this->name() .
230 ' - Problem saving notice. No associated Profile.');
234 // XXX: change of screen name?
236 $uri = 'http://twitter.com/' . $status->user->screen_name .
237 '/status/' . $status->id;
239 $notice = Notice::staticGet('uri', $uri);
241 // check to see if we've already imported the status
243 if (empty($notice)) {
245 $notice = new Notice();
247 $notice->profile_id = $id;
249 $notice->created = strftime('%Y-%m-%d %H:%M:%S',
250 strtotime($status->created_at));
251 $notice->content = common_shorten_links($status->text); // XXX
252 $notice->rendered = common_render_content($notice->content, $notice);
253 $notice->source = 'twitter';
254 $notice->reply_to = null; // XXX: lookup reply
255 $notice->is_local = Notice::GATEWAY;
257 if (Event::handle('StartNoticeSave', array(&$notice))) {
258 $id = $notice->insert();
259 Event::handle('EndNoticeSave', array($notice));
263 if (!Notice_inbox::pkeyGet(array('notice_id' => $notice->id,
264 'user_id' => $flink->user_id))) {
266 $inbox = new Notice_inbox();
268 $inbox->user_id = $flink->user_id;
269 $inbox->notice_id = $notice->id;
270 $inbox->created = $notice->created;
271 $inbox->source = NOTICE_INBOX_SOURCE_GATEWAY; // From a private source
277 function ensureProfile($user)
279 // check to see if there's already a profile for this user
281 $profileurl = 'http://twitter.com/' . $user->screen_name;
282 $profile = Profile::staticGet('profileurl', $profileurl);
284 if (!empty($profile)) {
285 common_debug($this->name() .
286 " - Profile for $profile->nickname found.");
288 // Check to see if the user's Avatar has changed
290 $this->checkAvatar($user, $profile);
294 common_debug($this->name() . ' - Adding profile and remote profile ' .
295 "for Twitter user: $profileurl.");
297 $profile = new Profile();
298 $profile->query("BEGIN");
300 $profile->nickname = $user->screen_name;
301 $profile->fullname = $user->name;
302 $profile->homepage = $user->url;
303 $profile->bio = $user->description;
304 $profile->location = $user->location;
305 $profile->profileurl = $profileurl;
306 $profile->created = common_sql_now();
308 $id = $profile->insert();
311 common_log_db_error($profile, 'INSERT', __FILE__);
312 $profile->query("ROLLBACK");
316 // check for remote profile
318 $remote_pro = Remote_profile::staticGet('uri', $profileurl);
320 if (empty($remote_pro)) {
322 $remote_pro = new Remote_profile();
324 $remote_pro->id = $id;
325 $remote_pro->uri = $profileurl;
326 $remote_pro->created = common_sql_now();
328 $rid = $remote_pro->insert();
331 common_log_db_error($profile, 'INSERT', __FILE__);
332 $profile->query("ROLLBACK");
337 $profile->query("COMMIT");
339 $this->saveAvatars($user, $id);
345 function checkAvatar($twitter_user, $profile)
349 $path_parts = pathinfo($twitter_user->profile_image_url);
351 $newname = 'Twitter_' . $twitter_user->id . '_' .
352 $path_parts['basename'];
354 $oldname = $profile->getAvatar(48)->filename;
356 if ($newname != $oldname) {
357 common_debug($this->name() . ' - Avatar for Twitter user ' .
358 "$profile->nickname has changed.");
359 common_debug($this->name() . " - old: $oldname new: $newname");
361 $this->updateAvatars($twitter_user, $profile);
364 if ($this->missingAvatarFile($profile)) {
365 common_debug($this->name() . ' - Twitter user ' .
367 ' is missing one or more local avatars.');
368 common_debug($this->name() ." - old: $oldname new: $newname");
370 $this->updateAvatars($twitter_user, $profile);
375 function updateAvatars($twitter_user, $profile) {
379 $path_parts = pathinfo($twitter_user->profile_image_url);
381 $img_root = substr($path_parts['basename'], 0, -11);
382 $ext = $path_parts['extension'];
383 $mediatype = $this->getMediatype($ext);
385 foreach (array('mini', 'normal', 'bigger') as $size) {
386 $url = $path_parts['dirname'] . '/' .
387 $img_root . '_' . $size . ".$ext";
388 $filename = 'Twitter_' . $twitter_user->id . '_' .
389 $img_root . "_$size.$ext";
391 $this->updateAvatar($profile->id, $size, $mediatype, $filename);
392 $this->fetchAvatar($url, $filename);
396 function missingAvatarFile($profile) {
398 foreach (array(24, 48, 73) as $size) {
400 $filename = $profile->getAvatar($size)->filename;
401 $avatarpath = Avatar::path($filename);
403 if (file_exists($avatarpath) == FALSE) {
411 function getMediatype($ext)
415 switch (strtolower($ext)) {
417 $mediatype = 'image/jpg';
420 $mediatype = 'image/gif';
423 $mediatype = 'image/png';
429 function saveAvatars($user, $id)
433 $path_parts = pathinfo($user->profile_image_url);
434 $ext = $path_parts['extension'];
435 $end = strlen('_normal' . $ext);
436 $img_root = substr($path_parts['basename'], 0, -($end+1));
437 $mediatype = $this->getMediatype($ext);
439 foreach (array('mini', 'normal', 'bigger') as $size) {
440 $url = $path_parts['dirname'] . '/' .
441 $img_root . '_' . $size . ".$ext";
442 $filename = 'Twitter_' . $user->id . '_' .
443 $img_root . "_$size.$ext";
445 if ($this->fetchAvatar($url, $filename)) {
446 $this->newAvatar($id, $size, $mediatype, $filename);
448 common_log(LOG_WARNING, $this->id() .
449 " - Problem fetching Avatar: $url");
454 function updateAvatar($profile_id, $size, $mediatype, $filename) {
456 common_debug($this->name() . " - Updating avatar: $size");
458 $profile = Profile::staticGet($profile_id);
460 if (empty($profile)) {
461 common_debug($this->name() . " - Couldn't get profile: $profile_id!");
465 $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
466 $avatar = $profile->getAvatar($sizes[$size]);
468 // Delete the avatar, if present
474 $this->newAvatar($profile->id, $size, $mediatype, $filename);
477 function newAvatar($profile_id, $size, $mediatype, $filename)
481 $avatar = new Avatar();
482 $avatar->profile_id = $profile_id;
487 $avatar->height = 24;
491 $avatar->height = 48;
495 // Note: Twitter's big avatars are a different size than
496 // StatusNet's (StatusNet's = 96)
499 $avatar->height = 73;
502 $avatar->original = 0; // we don't have the original
503 $avatar->mediatype = $mediatype;
504 $avatar->filename = $filename;
505 $avatar->url = Avatar::url($filename);
507 $avatar->created = common_sql_now();
509 $id = $avatar->insert();
512 common_log_db_error($avatar, 'INSERT', __FILE__);
516 common_debug($this->name() .
517 " - Saved new $size avatar for $profile_id.");
523 * Fetch a remote avatar image and save to local storage.
525 * @param string $url avatar source URL
526 * @param string $filename bare local filename for download
527 * @return bool true on success, false on failure
529 function fetchAvatar($url, $filename)
531 common_debug($this->name() . " - Fetching Twitter avatar: $url");
533 $request = new HTTPClient($url, 'GET', array(
534 'follow_redirects' => true,
536 $data = $request->get();
538 $avatarfile = Avatar::path($filename);
539 $ok = file_put_contents($avatarfile, $data);
541 common_log(LOG_WARNING, $this->name() .
542 " - Couldn't open file $filename");
556 if (have_option('i')) {
557 $id = get_option_value('i');
558 } else if (have_option('--id')) {
559 $id = get_option_value('--id');
560 } else if (count($args) > 0) {
566 if (have_option('d') || have_option('debug')) {
570 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);