4 * StatusNet - a 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@controlyourself.ca>
51 * @author Evan Prodromou <evan@controlyourself.ca>
52 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
53 * @link http://laconi.ca/
56 // NOTE: an Avatar path MUST be set in config.php for this
57 // script to work: e.g.: $config['avatar']['path'] = '/laconica/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.
164 $token = TwitterOAuthClient::unpackToken($flink->credentials);
166 $client = new TwitterOAuthClient($token->key, $token->secret);
171 $timeline = $client->statusesFriendsTimeline();
172 } catch (OAuthClientCurlException $e) {
173 common_log(LOG_WARNING, $this->name() .
174 ' - OAuth client unable to get friends timeline for user ' .
175 $flink->user_id . ' - code: ' .
176 $e->getCode() . 'msg: ' . $e->getMessage());
179 if (empty($timeline)) {
180 common_log(LOG_WARNING, $this->name() . " - Empty timeline.");
184 // Reverse to preserve order
186 foreach (array_reverse($timeline) as $status) {
188 // Hacktastic: filter out stuff coming from this StatusNet
190 $source = mb_strtolower(common_config('integration', 'source'));
192 if (preg_match("/$source/", mb_strtolower($status->source))) {
193 common_debug($this->name() . ' - Skipping import of status ' .
194 $status->id . ' with source ' . $source);
198 $this->saveStatus($status, $flink);
201 // Okay, record the time we synced with Twitter for posterity
203 $flink->last_noticesync = common_sql_now();
207 function saveStatus($status, $flink)
209 $id = $this->ensureProfile($status->user);
211 $profile = Profile::staticGet($id);
213 if (empty($profile)) {
214 common_log(LOG_ERR, $this->name() .
215 ' - Problem saving notice. No associated Profile.');
219 // XXX: change of screen name?
221 $uri = 'http://twitter.com/' . $status->user->screen_name .
222 '/status/' . $status->id;
224 $notice = Notice::staticGet('uri', $uri);
226 // check to see if we've already imported the status
228 if (empty($notice)) {
230 $notice = new Notice();
232 $notice->profile_id = $id;
234 $notice->created = strftime('%Y-%m-%d %H:%M:%S',
235 strtotime($status->created_at));
236 $notice->content = common_shorten_links($status->text); // XXX
237 $notice->rendered = common_render_content($notice->content, $notice);
238 $notice->source = 'twitter';
239 $notice->reply_to = null; // XXX: lookup reply
240 $notice->is_local = Notice::GATEWAY;
242 if (Event::handle('StartNoticeSave', array(&$notice))) {
243 $id = $notice->insert();
244 Event::handle('EndNoticeSave', array($notice));
248 if (!Notice_inbox::pkeyGet(array('notice_id' => $notice->id,
249 'user_id' => $flink->user_id))) {
251 $inbox = new Notice_inbox();
253 $inbox->user_id = $flink->user_id;
254 $inbox->notice_id = $notice->id;
255 $inbox->created = $notice->created;
256 $inbox->source = NOTICE_INBOX_SOURCE_GATEWAY; // From a private source
262 function ensureProfile($user)
264 // check to see if there's already a profile for this user
266 $profileurl = 'http://twitter.com/' . $user->screen_name;
267 $profile = Profile::staticGet('profileurl', $profileurl);
269 if (!empty($profile)) {
270 common_debug($this->name() .
271 " - Profile for $profile->nickname found.");
273 // Check to see if the user's Avatar has changed
275 $this->checkAvatar($user, $profile);
279 common_debug($this->name() . ' - Adding profile and remote profile ' .
280 "for Twitter user: $profileurl.");
282 $profile = new Profile();
283 $profile->query("BEGIN");
285 $profile->nickname = $user->screen_name;
286 $profile->fullname = $user->name;
287 $profile->homepage = $user->url;
288 $profile->bio = $user->description;
289 $profile->location = $user->location;
290 $profile->profileurl = $profileurl;
291 $profile->created = common_sql_now();
293 $id = $profile->insert();
296 common_log_db_error($profile, 'INSERT', __FILE__);
297 $profile->query("ROLLBACK");
301 // check for remote profile
303 $remote_pro = Remote_profile::staticGet('uri', $profileurl);
305 if (empty($remote_pro)) {
307 $remote_pro = new Remote_profile();
309 $remote_pro->id = $id;
310 $remote_pro->uri = $profileurl;
311 $remote_pro->created = common_sql_now();
313 $rid = $remote_pro->insert();
316 common_log_db_error($profile, 'INSERT', __FILE__);
317 $profile->query("ROLLBACK");
322 $profile->query("COMMIT");
324 $this->saveAvatars($user, $id);
330 function checkAvatar($twitter_user, $profile)
334 $path_parts = pathinfo($twitter_user->profile_image_url);
336 $newname = 'Twitter_' . $twitter_user->id . '_' .
337 $path_parts['basename'];
339 $oldname = $profile->getAvatar(48)->filename;
341 if ($newname != $oldname) {
342 common_debug($this->name() . ' - Avatar for Twitter user ' .
343 "$profile->nickname has changed.");
344 common_debug($this->name() . " - old: $oldname new: $newname");
346 $this->updateAvatars($twitter_user, $profile);
349 if ($this->missingAvatarFile($profile)) {
350 common_debug($this->name() . ' - Twitter user ' .
352 ' is missing one or more local avatars.');
353 common_debug($this->name() ." - old: $oldname new: $newname");
355 $this->updateAvatars($twitter_user, $profile);
360 function updateAvatars($twitter_user, $profile) {
364 $path_parts = pathinfo($twitter_user->profile_image_url);
366 $img_root = substr($path_parts['basename'], 0, -11);
367 $ext = $path_parts['extension'];
368 $mediatype = $this->getMediatype($ext);
370 foreach (array('mini', 'normal', 'bigger') as $size) {
371 $url = $path_parts['dirname'] . '/' .
372 $img_root . '_' . $size . ".$ext";
373 $filename = 'Twitter_' . $twitter_user->id . '_' .
374 $img_root . "_$size.$ext";
376 $this->updateAvatar($profile->id, $size, $mediatype, $filename);
377 $this->fetchAvatar($url, $filename);
381 function missingAvatarFile($profile) {
383 foreach (array(24, 48, 73) as $size) {
385 $filename = $profile->getAvatar($size)->filename;
386 $avatarpath = Avatar::path($filename);
388 if (file_exists($avatarpath) == FALSE) {
396 function getMediatype($ext)
400 switch (strtolower($ext)) {
402 $mediatype = 'image/jpg';
405 $mediatype = 'image/gif';
408 $mediatype = 'image/png';
414 function saveAvatars($user, $id)
418 $path_parts = pathinfo($user->profile_image_url);
419 $ext = $path_parts['extension'];
420 $end = strlen('_normal' . $ext);
421 $img_root = substr($path_parts['basename'], 0, -($end+1));
422 $mediatype = $this->getMediatype($ext);
424 foreach (array('mini', 'normal', 'bigger') as $size) {
425 $url = $path_parts['dirname'] . '/' .
426 $img_root . '_' . $size . ".$ext";
427 $filename = 'Twitter_' . $user->id . '_' .
428 $img_root . "_$size.$ext";
430 if ($this->fetchAvatar($url, $filename)) {
431 $this->newAvatar($id, $size, $mediatype, $filename);
433 common_log(LOG_WARNING, $this->id() .
434 " - Problem fetching Avatar: $url");
439 function updateAvatar($profile_id, $size, $mediatype, $filename) {
441 common_debug($this->name() . " - Updating avatar: $size");
443 $profile = Profile::staticGet($profile_id);
445 if (empty($profile)) {
446 common_debug($this->name() . " - Couldn't get profile: $profile_id!");
450 $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
451 $avatar = $profile->getAvatar($sizes[$size]);
453 // Delete the avatar, if present
459 $this->newAvatar($profile->id, $size, $mediatype, $filename);
462 function newAvatar($profile_id, $size, $mediatype, $filename)
466 $avatar = new Avatar();
467 $avatar->profile_id = $profile_id;
472 $avatar->height = 24;
476 $avatar->height = 48;
480 // Note: Twitter's big avatars are a different size than
481 // StatusNet's (Laconica's = 96)
484 $avatar->height = 73;
487 $avatar->original = 0; // we don't have the original
488 $avatar->mediatype = $mediatype;
489 $avatar->filename = $filename;
490 $avatar->url = Avatar::url($filename);
492 common_debug($this->name() . " - New filename: $avatar->url");
494 $avatar->created = common_sql_now();
496 $id = $avatar->insert();
499 common_log_db_error($avatar, 'INSERT', __FILE__);
503 common_debug($this->name() .
504 " - Saved new $size avatar for $profile_id.");
509 function fetchAvatar($url, $filename)
511 $avatar_dir = INSTALLDIR . '/avatar/';
513 $avatarfile = $avatar_dir . $filename;
515 $out = fopen($avatarfile, 'wb');
517 common_log(LOG_WARNING, $this->name() .
518 " - Couldn't open file $filename");
522 common_debug($this->name() . " - Fetching Twitter avatar: $url");
525 curl_setopt($ch, CURLOPT_URL, $url);
526 curl_setopt($ch, CURLOPT_FILE, $out);
527 curl_setopt($ch, CURLOPT_BINARYTRANSFER, true);
528 curl_setopt($ch, CURLOPT_FOLLOWLOCATION, true);
529 curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 0);
530 $result = curl_exec($ch);
542 if (have_option('i')) {
543 $id = get_option_value('i');
544 } else if (have_option('--id')) {
545 $id = get_option_value('--id');
546 } else if (count($args) > 0) {
552 if (have_option('d') || have_option('debug')) {
556 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);