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/daemon.php';
43 * Fetcher for statuses from Twitter
45 * Fetches statuses from Twitter and inserts them as notices in local
50 * @author Zach Copley <zach@status.net>
51 * @author Evan Prodromou <evan@status.net>
52 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
53 * @link http://status.net/
56 // NOTE: an Avatar path MUST be set in config.php for this
57 // script to work: e.g.: $config['avatar']['path'] = '/statusnet/avatar';
59 class TwitterStatusFetcher extends ParallelizingDaemon
64 * @param string $id the name/id of this daemon
65 * @param int $interval sleep this long before doing everything again
66 * @param int $max_children maximum number of child processes at a time
67 * @param boolean $debug debug output flag
72 function __construct($id = null, $interval = 60,
73 $max_children = 2, $debug = null)
75 parent::__construct($id, $interval, $max_children, $debug);
81 * @return string Name of the daemon.
86 return ('twitterstatusfetcher.'.$this->_id);
90 * Find all the Twitter foreign links for users who have requested
91 * importing of their friends' timelines
93 * @return array flinks an array of Foreign_link objects
98 global $_DB_DATAOBJECT;
100 $flink = new Foreign_link();
101 $conn = &$flink->getDatabaseConnection();
103 $flink->service = TWITTER_SERVICE;
104 $flink->orderBy('last_noticesync');
109 while ($flink->fetch()) {
111 if (($flink->noticesync & FOREIGN_NOTICE_RECV) ==
112 FOREIGN_NOTICE_RECV) {
113 $flinks[] = clone($flink);
121 unset($_DB_DATAOBJECT['CONNECTIONS']);
126 function childTask($flink) {
128 // Each child ps needs its own DB connection
130 // Note: DataObject::getDatabaseConnection() creates
131 // a new connection if there isn't one already
133 $conn = &$flink->getDatabaseConnection();
135 $this->getTimeline($flink);
137 $flink->last_friendsync = common_sql_now();
142 // XXX: Couldn't find a less brutal way to blow
143 // away a cached connection
145 global $_DB_DATAOBJECT;
146 unset($_DB_DATAOBJECT['CONNECTIONS']);
149 function getTimeline($flink)
152 common_log(LOG_WARNING, $this->name() .
153 " - Can't retrieve Foreign_link for foreign ID $fid");
157 common_debug($this->name() . ' - Trying to get timeline for Twitter user ' .
160 // XXX: Biggest remaining issue - How do we know at which status
161 // to start importing? How many statuses? Right now I'm going
162 // with the default last 20.
166 if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
167 $token = TwitterOAuthClient::unpackToken($flink->credentials);
168 $client = new TwitterOAuthClient($token->key, $token->secret);
169 common_debug($this->name() . ' - Grabbing friends timeline with OAuth.');
171 $client = new TwitterBasicAuthClient($flink);
172 common_debug($this->name() . ' - Grabbing friends timeline with basic auth.');
178 $timeline = $client->statusesFriendsTimeline();
179 } catch (Exception $e) {
180 common_log(LOG_WARNING, $this->name() .
181 ' - Twitter client unable to get friends timeline for user ' .
182 $flink->user_id . ' - code: ' .
183 $e->getCode() . 'msg: ' . $e->getMessage());
186 if (empty($timeline)) {
187 common_log(LOG_WARNING, $this->name() . " - Empty timeline.");
191 // Reverse to preserve order
193 foreach (array_reverse($timeline) as $status) {
195 // Hacktastic: filter out stuff coming from this StatusNet
197 $source = mb_strtolower(common_config('integration', 'source'));
199 if (preg_match("/$source/", mb_strtolower($status->source))) {
200 common_debug($this->name() . ' - Skipping import of status ' .
201 $status->id . ' with source ' . $source);
205 $this->saveStatus($status, $flink);
208 // Okay, record the time we synced with Twitter for posterity
210 $flink->last_noticesync = common_sql_now();
214 function saveStatus($status, $flink)
216 $id = $this->ensureProfile($status->user);
218 $profile = Profile::staticGet($id);
220 if (empty($profile)) {
221 common_log(LOG_ERR, $this->name() .
222 ' - Problem saving notice. No associated Profile.');
226 // XXX: change of screen name?
228 $uri = 'http://twitter.com/' . $status->user->screen_name .
229 '/status/' . $status->id;
231 $notice = Notice::staticGet('uri', $uri);
233 // check to see if we've already imported the status
235 if (empty($notice)) {
237 $notice = new Notice();
239 $notice->profile_id = $id;
241 $notice->created = strftime('%Y-%m-%d %H:%M:%S',
242 strtotime($status->created_at));
243 $notice->content = common_shorten_links($status->text); // XXX
244 $notice->rendered = common_render_content($notice->content, $notice);
245 $notice->source = 'twitter';
246 $notice->reply_to = null; // XXX: lookup reply
247 $notice->is_local = Notice::GATEWAY;
249 if (Event::handle('StartNoticeSave', array(&$notice))) {
250 $id = $notice->insert();
251 Event::handle('EndNoticeSave', array($notice));
255 if (!Notice_inbox::pkeyGet(array('notice_id' => $notice->id,
256 'user_id' => $flink->user_id))) {
258 $inbox = new Notice_inbox();
260 $inbox->user_id = $flink->user_id;
261 $inbox->notice_id = $notice->id;
262 $inbox->created = $notice->created;
263 $inbox->source = NOTICE_INBOX_SOURCE_GATEWAY; // From a private source
269 function ensureProfile($user)
271 // check to see if there's already a profile for this user
273 $profileurl = 'http://twitter.com/' . $user->screen_name;
274 $profile = Profile::staticGet('profileurl', $profileurl);
276 if (!empty($profile)) {
277 common_debug($this->name() .
278 " - Profile for $profile->nickname found.");
280 // Check to see if the user's Avatar has changed
282 $this->checkAvatar($user, $profile);
286 common_debug($this->name() . ' - Adding profile and remote profile ' .
287 "for Twitter user: $profileurl.");
289 $profile = new Profile();
290 $profile->query("BEGIN");
292 $profile->nickname = $user->screen_name;
293 $profile->fullname = $user->name;
294 $profile->homepage = $user->url;
295 $profile->bio = $user->description;
296 $profile->location = $user->location;
297 $profile->profileurl = $profileurl;
298 $profile->created = common_sql_now();
300 $id = $profile->insert();
303 common_log_db_error($profile, 'INSERT', __FILE__);
304 $profile->query("ROLLBACK");
308 // check for remote profile
310 $remote_pro = Remote_profile::staticGet('uri', $profileurl);
312 if (empty($remote_pro)) {
314 $remote_pro = new Remote_profile();
316 $remote_pro->id = $id;
317 $remote_pro->uri = $profileurl;
318 $remote_pro->created = common_sql_now();
320 $rid = $remote_pro->insert();
323 common_log_db_error($profile, 'INSERT', __FILE__);
324 $profile->query("ROLLBACK");
329 $profile->query("COMMIT");
331 $this->saveAvatars($user, $id);
337 function checkAvatar($twitter_user, $profile)
341 $path_parts = pathinfo($twitter_user->profile_image_url);
343 $newname = 'Twitter_' . $twitter_user->id . '_' .
344 $path_parts['basename'];
346 $oldname = $profile->getAvatar(48)->filename;
348 if ($newname != $oldname) {
349 common_debug($this->name() . ' - Avatar for Twitter user ' .
350 "$profile->nickname has changed.");
351 common_debug($this->name() . " - old: $oldname new: $newname");
353 $this->updateAvatars($twitter_user, $profile);
356 if ($this->missingAvatarFile($profile)) {
357 common_debug($this->name() . ' - Twitter user ' .
359 ' is missing one or more local avatars.');
360 common_debug($this->name() ." - old: $oldname new: $newname");
362 $this->updateAvatars($twitter_user, $profile);
367 function updateAvatars($twitter_user, $profile) {
371 $path_parts = pathinfo($twitter_user->profile_image_url);
373 $img_root = substr($path_parts['basename'], 0, -11);
374 $ext = $path_parts['extension'];
375 $mediatype = $this->getMediatype($ext);
377 foreach (array('mini', 'normal', 'bigger') as $size) {
378 $url = $path_parts['dirname'] . '/' .
379 $img_root . '_' . $size . ".$ext";
380 $filename = 'Twitter_' . $twitter_user->id . '_' .
381 $img_root . "_$size.$ext";
383 $this->updateAvatar($profile->id, $size, $mediatype, $filename);
384 $this->fetchAvatar($url, $filename);
388 function missingAvatarFile($profile) {
390 foreach (array(24, 48, 73) as $size) {
392 $filename = $profile->getAvatar($size)->filename;
393 $avatarpath = Avatar::path($filename);
395 if (file_exists($avatarpath) == FALSE) {
403 function getMediatype($ext)
407 switch (strtolower($ext)) {
409 $mediatype = 'image/jpg';
412 $mediatype = 'image/gif';
415 $mediatype = 'image/png';
421 function saveAvatars($user, $id)
425 $path_parts = pathinfo($user->profile_image_url);
426 $ext = $path_parts['extension'];
427 $end = strlen('_normal' . $ext);
428 $img_root = substr($path_parts['basename'], 0, -($end+1));
429 $mediatype = $this->getMediatype($ext);
431 foreach (array('mini', 'normal', 'bigger') as $size) {
432 $url = $path_parts['dirname'] . '/' .
433 $img_root . '_' . $size . ".$ext";
434 $filename = 'Twitter_' . $user->id . '_' .
435 $img_root . "_$size.$ext";
437 if ($this->fetchAvatar($url, $filename)) {
438 $this->newAvatar($id, $size, $mediatype, $filename);
440 common_log(LOG_WARNING, $this->id() .
441 " - Problem fetching Avatar: $url");
446 function updateAvatar($profile_id, $size, $mediatype, $filename) {
448 common_debug($this->name() . " - Updating avatar: $size");
450 $profile = Profile::staticGet($profile_id);
452 if (empty($profile)) {
453 common_debug($this->name() . " - Couldn't get profile: $profile_id!");
457 $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
458 $avatar = $profile->getAvatar($sizes[$size]);
460 // Delete the avatar, if present
466 $this->newAvatar($profile->id, $size, $mediatype, $filename);
469 function newAvatar($profile_id, $size, $mediatype, $filename)
473 $avatar = new Avatar();
474 $avatar->profile_id = $profile_id;
479 $avatar->height = 24;
483 $avatar->height = 48;
487 // Note: Twitter's big avatars are a different size than
488 // StatusNet's (StatusNet's = 96)
491 $avatar->height = 73;
494 $avatar->original = 0; // we don't have the original
495 $avatar->mediatype = $mediatype;
496 $avatar->filename = $filename;
497 $avatar->url = Avatar::url($filename);
499 common_debug($this->name() . " - New filename: $avatar->url");
501 $avatar->created = common_sql_now();
503 $id = $avatar->insert();
506 common_log_db_error($avatar, 'INSERT', __FILE__);
510 common_debug($this->name() .
511 " - Saved new $size avatar for $profile_id.");
516 function fetchAvatar($url, $filename)
518 $avatar_dir = INSTALLDIR . '/avatar/';
520 $avatarfile = $avatar_dir . $filename;
522 $out = fopen($avatarfile, 'wb');
524 common_log(LOG_WARNING, $this->name() .
525 " - Couldn't open file $filename");
529 common_debug($this->name() . " - Fetching Twitter avatar: $url");
532 curl_setopt($ch, CURLOPT_URL, $url);
533 curl_setopt($ch, CURLOPT_FILE, $out);
534 curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
535 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
536 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 0);
537 $result = curl_exec($ch);
549 if (have_option('i')) {
550 $id = get_option_value('i');
551 } else if (have_option('--id')) {
552 $id = get_option_value('--id');
553 } else if (count($args) > 0) {
559 if (have_option('d') || have_option('debug')) {
563 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);