plugins/TwitterBridge/daemons/twitterstatusfetcher.php

   1 #!/usr/bin/env php
   2 <?php
   3 /**
   4  * StatusNet - the distributed open-source microblogging tool
   5  * Copyright (C) 2008, 2009, StatusNet, Inc.
   6  *
   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.
  11  *
  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.
  16  *
  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/>.
  19  */
  20
  21 define('INSTALLDIR', realpath(dirname(__FILE__) . '/../../..'));
  22
  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
  27
  28 $shortoptions = 'di::';
  29 $longoptions = array('id::', 'debug');
  30
  31 $helptext = <<<END_OF_TRIM_HELP
  32 Batch script for retrieving Twitter messages from foreign service.
  33
  34   -i --id              Identity (default 'generic')
  35   -d --debug           Debug (lots of log output)
  36
  37 END_OF_TRIM_HELP;
  38
  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';
  45
  46 /**
  47  * Fetcher for statuses from Twitter
  48  *
  49  * Fetches statuses from Twitter and inserts them as notices in local
  50  * system.
  51  *
  52  * @category Twitter
  53  * @package  StatusNet
  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/
  58  */
  59
  60 // NOTE: an Avatar path MUST be set in config.php for this
  61 // script to work: e.g.: $config['avatar']['path'] = '/statusnet/avatar';
  62
  63 class TwitterStatusFetcher extends ParallelizingDaemon
  64 {
  65     /**
  66      *  Constructor
  67      *
  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
  72      *
  73      * @return void
  74      *
  75      **/
  76     function __construct($id = null, $interval = 60,
  77                          $max_children = 2, $debug = null)
  78     {
  79         parent::__construct($id, $interval, $max_children, $debug);
  80     }
  81
  82     /**
  83      * Name of this daemon
  84      *
  85      * @return string Name of the daemon.
  86      */
  87
  88     function name()
  89     {
  90         return ('twitterstatusfetcher.'.$this->_id);
  91     }
  92
  93     /**
  94      * Find all the Twitter foreign links for users who have requested
  95      * importing of their friends' timelines
  96      *
  97      * @return array flinks an array of Foreign_link objects
  98      */
  99
 100     function getObjects()
 101     {
 102         global $_DB_DATAOBJECT;
 103
 104         $flink = new Foreign_link();
 105         $conn = &$flink->getDatabaseConnection();
 106
 107         $flink->service = TWITTER_SERVICE;
 108         $flink->orderBy('last_noticesync');
 109         $flink->find();
 110
 111         $flinks = array();
 112
 113         while ($flink->fetch()) {
 114
 115             if (($flink->noticesync & FOREIGN_NOTICE_RECV) ==
 116                 FOREIGN_NOTICE_RECV) {
 117                 $flinks[] = clone($flink);
 118                 common_log(LOG_INFO, "sync: foreign id $flink->foreign_id");
 119             } else {
 120                 common_log(LOG_INFO, "nothing to sync");
 121             }
 122         }
 123
 124         $flink->free();
 125         unset($flink);
 126
 127         $conn->disconnect();
 128         unset($_DB_DATAOBJECT['CONNECTIONS']);
 129
 130         return $flinks;
 131     }
 132
 133     function childTask($flink) {
 134
 135         // Each child ps needs its own DB connection
 136
 137         // Note: DataObject::getDatabaseConnection() creates
 138         // a new connection if there isn't one already
 139
 140         $conn = &$flink->getDatabaseConnection();
 141
 142         $this->getTimeline($flink);
 143
 144         $flink->last_friendsync = common_sql_now();
 145         $flink->update();
 146
 147         $conn->disconnect();
 148
 149         // XXX: Couldn't find a less brutal way to blow
 150         // away a cached connection
 151
 152         global $_DB_DATAOBJECT;
 153         unset($_DB_DATAOBJECT['CONNECTIONS']);
 154     }
 155
 156     function getTimeline($flink)
 157     {
 158         if (empty($flink)) {
 159             common_log(LOG_WARNING, $this->name() .
 160                        " - Can't retrieve Foreign_link for foreign ID $fid");
 161             return;
 162         }
 163
 164         common_debug($this->name() . ' - Trying to get timeline for Twitter user ' .
 165                      $flink->foreign_id);
 166
 167         // XXX: Biggest remaining issue - How do we know at which status
 168         // to start importing?  How many statuses?  Right now I'm going
 169         // with the default last 20.
 170
 171         $client = null;
 172
 173         if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
 174             $token = TwitterOAuthClient::unpackToken($flink->credentials);
 175             $client = new TwitterOAuthClient($token->key, $token->secret);
 176             common_debug($this->name() . ' - Grabbing friends timeline with OAuth.');
 177         } else {
 178             $client = new TwitterBasicAuthClient($flink);
 179             common_debug($this->name() . ' - Grabbing friends timeline with basic auth.');
 180         }
 181
 182         $timeline = null;
 183
 184         try {
 185             $timeline = $client->statusesFriendsTimeline();
 186         } catch (Exception $e) {
 187             common_log(LOG_WARNING, $this->name() .
 188                        ' - Twitter client unable to get friends timeline for user ' .
 189                        $flink->user_id . ' - code: ' .
 190                        $e->getCode() . 'msg: ' . $e->getMessage());
 191         }
 192
 193         if (empty($timeline)) {
 194             common_log(LOG_WARNING, $this->name() .  " - Empty timeline.");
 195             return;
 196         }
 197
 198         // Reverse to preserve order
 199
 200         foreach (array_reverse($timeline) as $status) {
 201
 202             // Hacktastic: filter out stuff coming from this StatusNet
 203
 204             $source = mb_strtolower(common_config('integration', 'source'));
 205
 206             if (preg_match("/$source/", mb_strtolower($status->source))) {
 207                 common_debug($this->name() . ' - Skipping import of status ' .
 208                              $status->id . ' with source ' . $source);
 209                 continue;
 210             }
 211
 212             $notice = null;
 213
 214             $notice = $this->saveStatus($status, $flink);
 215
 216             if (!empty($notice)) {
 217                 common_broadcast_notice($notice);
 218             }
 219         }
 220
 221         // Okay, record the time we synced with Twitter for posterity
 222
 223         $flink->last_noticesync = common_sql_now();
 224         $flink->update();
 225     }
 226
 227     function saveStatus($status, $flink)
 228     {
 229         $id = $this->ensureProfile($status->user);
 230
 231         $profile = Profile::staticGet($id);
 232
 233         if (empty($profile)) {
 234             common_log(LOG_ERR, $this->name() .
 235                 ' - Problem saving notice. No associated Profile.');
 236             return null;
 237         }
 238
 239         // XXX: change of screen name?
 240
 241         $uri = 'http://twitter.com/' . $status->user->screen_name .
 242             '/status/' . $status->id;
 243
 244         // check to see if we've already imported the status
 245
 246         $notice = Notice::staticGet('uri', $uri);
 247
 248         if (empty($notice)) {
 249
 250             // XXX: transaction here?
 251
 252             $notice = new Notice();
 253
 254             $notice->profile_id = $id;
 255             $notice->uri        = $uri;
 256             $notice->created    = strftime('%Y-%m-%d %H:%M:%S',
 257                                            strtotime($status->created_at));
 258             $notice->content    = common_shorten_links($status->text); // XXX
 259             $notice->rendered   = common_render_content($notice->content, $notice);
 260             $notice->source     = 'twitter';
 261             $notice->reply_to   = null; // XXX: lookup reply
 262             $notice->is_local   = Notice::GATEWAY;
 263
 264             if (Event::handle('StartNoticeSave', array(&$notice))) {
 265                 $id = $notice->insert();
 266                 Event::handle('EndNoticeSave', array($notice));
 267             }
 268
 269         }
 270
 271         if (!Notice_inbox::pkeyGet(array('notice_id' => $notice->id,
 272                                          'user_id' => $flink->user_id))) {
 273             // Add to inbox
 274             $inbox = new Notice_inbox();
 275
 276             $inbox->user_id   = $flink->user_id;
 277             $inbox->notice_id = $notice->id;
 278             $inbox->created   = $notice->created;
 279             $inbox->source    = NOTICE_INBOX_SOURCE_GATEWAY; // From a private source
 280
 281             $inbox->insert();
 282
 283         }
 284
 285         $notice->blowCaches();
 286
 287         return $notice;
 288     }
 289
 290     function ensureProfile($user)
 291     {
 292         // check to see if there's already a profile for this user
 293
 294         $profileurl = 'http://twitter.com/' . $user->screen_name;
 295         $profile = Profile::staticGet('profileurl', $profileurl);
 296
 297         if (!empty($profile)) {
 298             common_debug($this->name() .
 299                          " - Profile for $profile->nickname found.");
 300
 301             // Check to see if the user's Avatar has changed
 302
 303             $this->checkAvatar($user, $profile);
 304             return $profile->id;
 305
 306         } else {
 307             common_debug($this->name() . ' - Adding profile and remote profile ' .
 308                          "for Twitter user: $profileurl.");
 309
 310             $profile = new Profile();
 311             $profile->query("BEGIN");
 312
 313             $profile->nickname = $user->screen_name;
 314             $profile->fullname = $user->name;
 315             $profile->homepage = $user->url;
 316             $profile->bio = $user->description;
 317             $profile->location = $user->location;
 318             $profile->profileurl = $profileurl;
 319             $profile->created = common_sql_now();
 320
 321             $id = $profile->insert();
 322
 323             if (empty($id)) {
 324                 common_log_db_error($profile, 'INSERT', __FILE__);
 325                 $profile->query("ROLLBACK");
 326                 return false;
 327             }
 328
 329             // check for remote profile
 330
 331             $remote_pro = Remote_profile::staticGet('uri', $profileurl);
 332
 333             if (empty($remote_pro)) {
 334
 335                 $remote_pro = new Remote_profile();
 336
 337                 $remote_pro->id = $id;
 338                 $remote_pro->uri = $profileurl;
 339                 $remote_pro->created = common_sql_now();
 340
 341                 $rid = $remote_pro->insert();
 342
 343                 if (empty($rid)) {
 344                     common_log_db_error($profile, 'INSERT', __FILE__);
 345                     $profile->query("ROLLBACK");
 346                     return false;
 347                 }
 348             }
 349
 350             $profile->query("COMMIT");
 351
 352             $this->saveAvatars($user, $id);
 353
 354             return $id;
 355         }
 356     }
 357
 358     function checkAvatar($twitter_user, $profile)
 359     {
 360         global $config;
 361
 362         $path_parts = pathinfo($twitter_user->profile_image_url);
 363
 364         $newname = 'Twitter_' . $twitter_user->id . '_' .
 365             $path_parts['basename'];
 366
 367         $oldname = $profile->getAvatar(48)->filename;
 368
 369         if ($newname != $oldname) {
 370             common_debug($this->name() . ' - Avatar for Twitter user ' .
 371                          "$profile->nickname has changed.");
 372             common_debug($this->name() . " - old: $oldname new: $newname");
 373
 374             $this->updateAvatars($twitter_user, $profile);
 375         }
 376
 377         if ($this->missingAvatarFile($profile)) {
 378             common_debug($this->name() . ' - Twitter user ' .
 379                          $profile->nickname .
 380                          ' is missing one or more local avatars.');
 381             common_debug($this->name() ." - old: $oldname new: $newname");
 382
 383             $this->updateAvatars($twitter_user, $profile);
 384         }
 385
 386     }
 387
 388     function updateAvatars($twitter_user, $profile) {
 389
 390         global $config;
 391
 392         $path_parts = pathinfo($twitter_user->profile_image_url);
 393
 394         $img_root = substr($path_parts['basename'], 0, -11);
 395         $ext = $path_parts['extension'];
 396         $mediatype = $this->getMediatype($ext);
 397
 398         foreach (array('mini', 'normal', 'bigger') as $size) {
 399             $url = $path_parts['dirname'] . '/' .
 400                 $img_root . '_' . $size . ".$ext";
 401             $filename = 'Twitter_' . $twitter_user->id . '_' .
 402                 $img_root . "_$size.$ext";
 403
 404             $this->updateAvatar($profile->id, $size, $mediatype, $filename);
 405             $this->fetchAvatar($url, $filename);
 406         }
 407     }
 408
 409     function missingAvatarFile($profile) {
 410
 411         foreach (array(24, 48, 73) as $size) {
 412
 413             $filename = $profile->getAvatar($size)->filename;
 414             $avatarpath = Avatar::path($filename);
 415
 416             if (file_exists($avatarpath) == FALSE) {
 417                 return true;
 418             }
 419         }
 420
 421         return false;
 422     }
 423
 424     function getMediatype($ext)
 425     {
 426         $mediatype = null;
 427
 428         switch (strtolower($ext)) {
 429         case 'jpg':
 430             $mediatype = 'image/jpg';
 431             break;
 432         case 'gif':
 433             $mediatype = 'image/gif';
 434             break;
 435         default:
 436             $mediatype = 'image/png';
 437         }
 438
 439         return $mediatype;
 440     }
 441
 442     function saveAvatars($user, $id)
 443     {
 444         global $config;
 445
 446         $path_parts = pathinfo($user->profile_image_url);
 447         $ext = $path_parts['extension'];
 448         $end = strlen('_normal' . $ext);
 449         $img_root = substr($path_parts['basename'], 0, -($end+1));
 450         $mediatype = $this->getMediatype($ext);
 451
 452         foreach (array('mini', 'normal', 'bigger') as $size) {
 453             $url = $path_parts['dirname'] . '/' .
 454                 $img_root . '_' . $size . ".$ext";
 455             $filename = 'Twitter_' . $user->id . '_' .
 456                 $img_root . "_$size.$ext";
 457
 458             if ($this->fetchAvatar($url, $filename)) {
 459                 $this->newAvatar($id, $size, $mediatype, $filename);
 460             } else {
 461                 common_log(LOG_WARNING, $this->id() .
 462                            " - Problem fetching Avatar: $url");
 463             }
 464         }
 465     }
 466
 467     function updateAvatar($profile_id, $size, $mediatype, $filename) {
 468
 469         common_debug($this->name() . " - Updating avatar: $size");
 470
 471         $profile = Profile::staticGet($profile_id);
 472
 473         if (empty($profile)) {
 474             common_debug($this->name() . " - Couldn't get profile: $profile_id!");
 475             return;
 476         }
 477
 478         $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
 479         $avatar = $profile->getAvatar($sizes[$size]);
 480
 481         // Delete the avatar, if present
 482
 483         if ($avatar) {
 484             $avatar->delete();
 485         }
 486
 487         $this->newAvatar($profile->id, $size, $mediatype, $filename);
 488     }
 489
 490     function newAvatar($profile_id, $size, $mediatype, $filename)
 491     {
 492         global $config;
 493
 494         $avatar = new Avatar();
 495         $avatar->profile_id = $profile_id;
 496
 497         switch($size) {
 498         case 'mini':
 499             $avatar->width  = 24;
 500             $avatar->height = 24;
 501             break;
 502         case 'normal':
 503             $avatar->width  = 48;
 504             $avatar->height = 48;
 505             break;
 506         default:
 507
 508             // Note: Twitter's big avatars are a different size than
 509             // StatusNet's (StatusNet's = 96)
 510
 511             $avatar->width  = 73;
 512             $avatar->height = 73;
 513         }
 514
 515         $avatar->original = 0; // we don't have the original
 516         $avatar->mediatype = $mediatype;
 517         $avatar->filename = $filename;
 518         $avatar->url = Avatar::url($filename);
 519
 520         $avatar->created = common_sql_now();
 521
 522         $id = $avatar->insert();
 523
 524         if (empty($id)) {
 525             common_log_db_error($avatar, 'INSERT', __FILE__);
 526             return null;
 527         }
 528
 529         common_debug($this->name() .
 530                      " - Saved new $size avatar for $profile_id.");
 531
 532         return $id;
 533     }
 534
 535     /**
 536      * Fetch a remote avatar image and save to local storage.
 537      *
 538      * @param string $url avatar source URL
 539      * @param string $filename bare local filename for download
 540      * @return bool true on success, false on failure
 541      */
 542     function fetchAvatar($url, $filename)
 543     {
 544         common_debug($this->name() . " - Fetching Twitter avatar: $url");
 545
 546         $request = HTTPClient::start();
 547         $response = $request->get($url);
 548         if ($response->isOk()) {
 549             $avatarfile = Avatar::path($filename);
 550             $ok = file_put_contents($avatarfile, $response->getBody());
 551             if (!$ok) {
 552                 common_log(LOG_WARNING, $this->name() .
 553                            " - Couldn't open file $filename");
 554                 return false;
 555             }
 556         } else {
 557             return false;
 558         }
 559
 560         return true;
 561     }
 562 }
 563
 564 $id    = null;
 565 $debug = null;
 566
 567 if (have_option('i')) {
 568     $id = get_option_value('i');
 569 } else if (have_option('--id')) {
 570     $id = get_option_value('--id');
 571 } else if (count($args) > 0) {
 572     $id = $args[0];
 573 } else {
 574     $id = null;
 575 }
 576
 577 if (have_option('d') || have_option('debug')) {
 578     $debug = true;
 579 }
 580
 581 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);
 582 $fetcher->runOnce();
 583