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-2010, 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/twitteroauthclient.php';
  44
  45 /**
  46  * Fetch statuses from Twitter
  47  *
  48  * Fetches statuses from Twitter and inserts them as notices
  49  *
  50  * NOTE: an Avatar path MUST be set in config.php for this
  51  * script to work, e.g.:
  52  *     $config['avatar']['path'] = $config['site']['path'] . '/avatar/';
  53  *
  54  * @todo @fixme @gar Fix the above. For some reason $_path is always empty when
  55  * this script is run, so the default avatar path is always set wrong in
  56  * default.php. Therefore it must be set explicitly in config.php. --Z
  57  *
  58  * @category Twitter
  59  * @package  StatusNet
  60  * @author   Zach Copley <zach@status.net>
  61  * @author   Evan Prodromou <evan@status.net>
  62  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  63  * @link     http://status.net/
  64  */
  65
  66 class TwitterStatusFetcher extends ParallelizingDaemon
  67 {
  68     /**
  69      *  Constructor
  70      *
  71      * @param string  $id           the name/id of this daemon
  72      * @param int     $interval     sleep this long before doing everything again
  73      * @param int     $max_children maximum number of child processes at a time
  74      * @param boolean $debug        debug output flag
  75      *
  76      * @return void
  77      *
  78      **/
  79     function __construct($id = null, $interval = 60,
  80                          $max_children = 2, $debug = null)
  81     {
  82         parent::__construct($id, $interval, $max_children, $debug);
  83     }
  84
  85     /**
  86      * Name of this daemon
  87      *
  88      * @return string Name of the daemon.
  89      */
  90
  91     function name()
  92     {
  93         return ('twitterstatusfetcher.'.$this->_id);
  94     }
  95
  96     /**
  97      * Find all the Twitter foreign links for users who have requested
  98      * importing of their friends' timelines
  99      *
 100      * @return array flinks an array of Foreign_link objects
 101      */
 102
 103     function getObjects()
 104     {
 105         global $_DB_DATAOBJECT;
 106
 107         $flink = new Foreign_link();
 108         $conn = &$flink->getDatabaseConnection();
 109
 110         $flink->service = TWITTER_SERVICE;
 111         $flink->orderBy('last_noticesync');
 112         $flink->find();
 113
 114         $flinks = array();
 115
 116         while ($flink->fetch()) {
 117
 118             if (($flink->noticesync & FOREIGN_NOTICE_RECV) ==
 119                 FOREIGN_NOTICE_RECV) {
 120                 $flinks[] = clone($flink);
 121                 common_log(LOG_INFO, "sync: foreign id $flink->foreign_id");
 122             } else {
 123                 common_log(LOG_INFO, "nothing to sync");
 124             }
 125         }
 126
 127         $flink->free();
 128         unset($flink);
 129
 130         $conn->disconnect();
 131         unset($_DB_DATAOBJECT['CONNECTIONS']);
 132
 133         return $flinks;
 134     }
 135
 136     function childTask($flink) {
 137
 138         // Each child ps needs its own DB connection
 139
 140         // Note: DataObject::getDatabaseConnection() creates
 141         // a new connection if there isn't one already
 142
 143         $conn = &$flink->getDatabaseConnection();
 144
 145         $this->getTimeline($flink);
 146
 147         $flink->last_friendsync = common_sql_now();
 148         $flink->update();
 149
 150         $conn->disconnect();
 151
 152         // XXX: Couldn't find a less brutal way to blow
 153         // away a cached connection
 154
 155         global $_DB_DATAOBJECT;
 156         unset($_DB_DATAOBJECT['CONNECTIONS']);
 157     }
 158
 159     function getTimeline($flink)
 160     {
 161         if (empty($flink)) {
 162             common_log(LOG_WARNING, $this->name() .
 163                        " - Can't retrieve Foreign_link for foreign ID $fid");
 164             return;
 165         }
 166
 167         common_debug($this->name() . ' - Trying to get timeline for Twitter user ' .
 168                      $flink->foreign_id);
 169
 170         // XXX: Biggest remaining issue - How do we know at which status
 171         // to start importing?  How many statuses?  Right now I'm going
 172         // with the default last 20.
 173
 174         $client = null;
 175
 176         if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
 177             $token = TwitterOAuthClient::unpackToken($flink->credentials);
 178             $client = new TwitterOAuthClient($token->key, $token->secret);
 179             common_debug($this->name() . ' - Grabbing friends timeline with OAuth.');
 180         } else {
 181             common_debug("Skipping friends timeline for $flink->foreign_id since not OAuth.");
 182         }
 183
 184         $timeline = null;
 185
 186         try {
 187             $timeline = $client->statusesHomeTimeline();
 188         } catch (Exception $e) {
 189             common_log(LOG_WARNING, $this->name() .
 190                        ' - Twitter client unable to get friends timeline for user ' .
 191                        $flink->user_id . ' - code: ' .
 192                        $e->getCode() . 'msg: ' . $e->getMessage());
 193         }
 194
 195         if (empty($timeline)) {
 196             common_log(LOG_WARNING, $this->name() .  " - Empty timeline.");
 197             return;
 198         }
 199
 200         common_debug(LOG_INFO, $this->name() . ' - Retrieved ' . sizeof($timeline) . ' statuses from Twitter.');
 201
 202         // Reverse to preserve order
 203
 204         foreach (array_reverse($timeline) as $status) {
 205
 206             // Hacktastic: filter out stuff coming from this StatusNet
 207
 208             $source = mb_strtolower(common_config('integration', 'source'));
 209
 210             if (preg_match("/$source/", mb_strtolower($status->source))) {
 211                 common_debug($this->name() . ' - Skipping import of status ' .
 212                              $status->id . ' with source ' . $source);
 213                 continue;
 214             }
 215
 216             // Don't save it if the user is protected
 217             // FIXME: save it but treat it as private
 218
 219             if ($status->user->protected) {
 220                 continue;
 221             }
 222
 223             $notice = $this->saveStatus($status);
 224
 225             if (!empty($notice)) {
 226                 Inbox::insertNotice($flink->user_id, $notice->id);
 227             }
 228         }
 229
 230         // Okay, record the time we synced with Twitter for posterity
 231
 232         $flink->last_noticesync = common_sql_now();
 233         $flink->update();
 234     }
 235
 236     function saveStatus($status)
 237     {
 238         $profile = $this->ensureProfile($status->user);
 239
 240         if (empty($profile)) {
 241             common_log(LOG_ERR, $this->name() .
 242                 ' - Problem saving notice. No associated Profile.');
 243             return null;
 244         }
 245
 246         $statusUri = $this->makeStatusURI($status->user->screen_name, $status->id);
 247
 248         // check to see if we've already imported the status
 249
 250         $dupe = $this->checkDupe($profile, $statusUri);
 251
 252         if (!empty($dupe)) {
 253             common_log(
 254                 LOG_INFO,
 255                 $this->name() .
 256                 " - Ignoring duplicate import: $statusUri"
 257             );
 258             return $dupe;
 259         }
 260
 261         common_debug("Saving status {$status->id} with data " . print_r($status, true));
 262
 263         // If it's a retweet, save it as a repeat!
 264
 265         if (!empty($status->retweeted_status)) {
 266             common_log(LOG_INFO, "Status {$status->id} is a retweet of {$status->retweeted_status->id}.");
 267             $original = $this->saveStatus($status->retweeted_status);
 268             if (empty($original)) {
 269                 return null;
 270             } else {
 271                 $author = $original->getProfile();
 272                 // TRANS: Message used to repeat a notice. RT is the abbreviation of 'retweet'.
 273                 // TRANS: %1$s is the repeated user's name, %2$s is the repeated notice.
 274                 $content = sprintf(_('RT @%1$s %2$s'),
 275                                    $author->nickname,
 276                                    $original->content);
 277                 $repeat = Notice::saveNew($profile->id,
 278                                           $content,
 279                                           'twitter',
 280                                           array('repeat_of' => $original->id,
 281                                                 'uri' => $statusUri));
 282                 common_log(LOG_INFO, "Saved {$repeat->id} as a repeat of {$original->id}");
 283                 Notice_to_status::saveNew($repeat->id, $status->id);
 284                 return $repeat;
 285             }
 286         }
 287
 288         $notice = new Notice();
 289
 290         $notice->profile_id = $profile->id;
 291         $notice->uri        = $statusUri;
 292         $notice->url        = $statusUri;
 293         $notice->created    = strftime(
 294             '%Y-%m-%d %H:%M:%S',
 295             strtotime($status->created_at)
 296         );
 297
 298         $notice->source     = 'twitter';
 299
 300         $notice->reply_to   = null;
 301
 302         if (!empty($status->in_reply_to_status_id)) {
 303             common_log(LOG_INFO, "Status {$status->id} is a reply to status {$status->in_reply_to_status_id}");
 304             $replyUri = $this->makeStatusURI($status->in_reply_to_screen_name, $status->in_reply_to_status_id);
 305             $reply = Notice::staticGet('uri', $replyUri);
 306             if (empty($reply)) {
 307                 common_log(LOG_INFO, "Couldn't find local notice for status {$status->in_reply_to_status_id}");
 308             } else {
 309                 common_log(LOG_INFO, "Found local notice {$reply->id} for status {$status->in_reply_to_status_id}");
 310                 $notice->reply_to     = $reply->id;
 311                 $notice->conversation = $reply->conversation;
 312             }
 313         }
 314
 315         if (empty($notice->conversation)) {
 316             $conv = Conversation::create();
 317             $notice->conversation = $conv->id;
 318             common_log(LOG_INFO, "No known conversation for status {$status->id} so making a new one {$conv->id}.");
 319         }
 320
 321         $notice->is_local   = Notice::GATEWAY;
 322
 323         $notice->content    = common_shorten_links($status->text);
 324         $notice->rendered   = common_render_content(
 325             $notice->content,
 326             $notice
 327         );
 328
 329         if (Event::handle('StartNoticeSave', array(&$notice))) {
 330
 331             $id = $notice->insert();
 332
 333             if (!$id) {
 334                 common_log_db_error($notice, 'INSERT', __FILE__);
 335                 common_log(LOG_ERR, $this->name() .
 336                     ' - Problem saving notice.');
 337             }
 338
 339             Event::handle('EndNoticeSave', array($notice));
 340         }
 341
 342         Notice_to_status::saveNew($notice->id, $status->id);
 343         $notice->blowOnInsert();
 344
 345         return $notice;
 346     }
 347
 348     /**
 349      * Make an URI for a status.
 350      *
 351      * @param object $status status object
 352      *
 353      * @return string URI
 354      */
 355
 356     function makeStatusURI($username, $id)
 357     {
 358         return 'http://twitter.com/'
 359           . $username
 360           . '/status/'
 361           . $id;
 362     }
 363
 364     /**
 365      * Look up a Profile by profileurl field.  Profile::staticGet() was
 366      * not working consistently.
 367      *
 368      * @param string $nickname   local nickname of the Twitter user
 369      * @param string $profileurl the profile url
 370      *
 371      * @return mixed value the first Profile with that url, or null
 372      */
 373
 374     function getProfileByUrl($nickname, $profileurl)
 375     {
 376         $profile = new Profile();
 377         $profile->nickname = $nickname;
 378         $profile->profileurl = $profileurl;
 379         $profile->limit(1);
 380
 381         if ($profile->find()) {
 382             $profile->fetch();
 383             return $profile;
 384         }
 385
 386         return null;
 387     }
 388
 389     /**
 390      * Check to see if this Twitter status has already been imported
 391      *
 392      * @param Profile $profile   Twitter user's local profile
 393      * @param string  $statusUri URI of the status on Twitter
 394      *
 395      * @return mixed value a matching Notice or null
 396      */
 397
 398     function checkDupe($profile, $statusUri)
 399     {
 400         $notice = new Notice();
 401         $notice->uri = $statusUri;
 402         $notice->profile_id = $profile->id;
 403         $notice->limit(1);
 404
 405         if ($notice->find()) {
 406             $notice->fetch();
 407             return $notice;
 408         }
 409
 410         return null;
 411     }
 412
 413     function ensureProfile($user)
 414     {
 415         // check to see if there's already a profile for this user
 416
 417         $profileurl = 'http://twitter.com/' . $user->screen_name;
 418         $profile = $this->getProfileByUrl($user->screen_name, $profileurl);
 419
 420         if (!empty($profile)) {
 421             common_debug($this->name() .
 422                          " - Profile for $profile->nickname found.");
 423
 424             // Check to see if the user's Avatar has changed
 425
 426             $this->checkAvatar($user, $profile);
 427             return $profile;
 428
 429         } else {
 430
 431             common_debug($this->name() . ' - Adding profile and remote profile ' .
 432                          "for Twitter user: $profileurl.");
 433
 434             $profile = new Profile();
 435             $profile->query("BEGIN");
 436
 437             $profile->nickname = $user->screen_name;
 438             $profile->fullname = $user->name;
 439             $profile->homepage = $user->url;
 440             $profile->bio = $user->description;
 441             $profile->location = $user->location;
 442             $profile->profileurl = $profileurl;
 443             $profile->created = common_sql_now();
 444
 445             try {
 446                 $id = $profile->insert();
 447             } catch(Exception $e) {
 448                 common_log(LOG_WARNING, $this->name . ' Couldn\'t insert profile - ' . $e->getMessage());
 449             }
 450
 451             if (empty($id)) {
 452                 common_log_db_error($profile, 'INSERT', __FILE__);
 453                 $profile->query("ROLLBACK");
 454                 return false;
 455             }
 456
 457             // check for remote profile
 458
 459             $remote_pro = Remote_profile::staticGet('uri', $profileurl);
 460
 461             if (empty($remote_pro)) {
 462
 463                 $remote_pro = new Remote_profile();
 464
 465                 $remote_pro->id = $id;
 466                 $remote_pro->uri = $profileurl;
 467                 $remote_pro->created = common_sql_now();
 468
 469                 try {
 470                     $rid = $remote_pro->insert();
 471                 } catch (Exception $e) {
 472                     common_log(LOG_WARNING, $this->name() . ' Couldn\'t save remote profile - ' . $e->getMessage());
 473                 }
 474
 475                 if (empty($rid)) {
 476                     common_log_db_error($profile, 'INSERT', __FILE__);
 477                     $profile->query("ROLLBACK");
 478                     return false;
 479                 }
 480             }
 481
 482             $profile->query("COMMIT");
 483
 484             $this->saveAvatars($user, $id);
 485
 486             return $profile;
 487         }
 488     }
 489
 490     function checkAvatar($twitter_user, $profile)
 491     {
 492         global $config;
 493
 494         $path_parts = pathinfo($twitter_user->profile_image_url);
 495
 496         $newname = 'Twitter_' . $twitter_user->id . '_' .
 497             $path_parts['basename'];
 498
 499         $oldname = $profile->getAvatar(48)->filename;
 500
 501         if ($newname != $oldname) {
 502             common_debug($this->name() . ' - Avatar for Twitter user ' .
 503                          "$profile->nickname has changed.");
 504             common_debug($this->name() . " - old: $oldname new: $newname");
 505
 506             $this->updateAvatars($twitter_user, $profile);
 507         }
 508
 509         if ($this->missingAvatarFile($profile)) {
 510             common_debug($this->name() . ' - Twitter user ' .
 511                          $profile->nickname .
 512                          ' is missing one or more local avatars.');
 513             common_debug($this->name() ." - old: $oldname new: $newname");
 514
 515             $this->updateAvatars($twitter_user, $profile);
 516         }
 517     }
 518
 519     function updateAvatars($twitter_user, $profile) {
 520
 521         global $config;
 522
 523         $path_parts = pathinfo($twitter_user->profile_image_url);
 524
 525         $img_root = substr($path_parts['basename'], 0, -11);
 526         $ext = $path_parts['extension'];
 527         $mediatype = $this->getMediatype($ext);
 528
 529         foreach (array('mini', 'normal', 'bigger') as $size) {
 530             $url = $path_parts['dirname'] . '/' .
 531                 $img_root . '_' . $size . ".$ext";
 532             $filename = 'Twitter_' . $twitter_user->id . '_' .
 533                 $img_root . "_$size.$ext";
 534
 535             $this->updateAvatar($profile->id, $size, $mediatype, $filename);
 536             $this->fetchAvatar($url, $filename);
 537         }
 538     }
 539
 540     function missingAvatarFile($profile) {
 541         foreach (array(24, 48, 73) as $size) {
 542             $filename = $profile->getAvatar($size)->filename;
 543             $avatarpath = Avatar::path($filename);
 544             if (file_exists($avatarpath) == FALSE) {
 545                 return true;
 546             }
 547         }
 548         return false;
 549     }
 550
 551     function getMediatype($ext)
 552     {
 553         $mediatype = null;
 554
 555         switch (strtolower($ext)) {
 556         case 'jpg':
 557             $mediatype = 'image/jpg';
 558             break;
 559         case 'gif':
 560             $mediatype = 'image/gif';
 561             break;
 562         default:
 563             $mediatype = 'image/png';
 564         }
 565
 566         return $mediatype;
 567     }
 568
 569     function saveAvatars($user, $id)
 570     {
 571         global $config;
 572
 573         $path_parts = pathinfo($user->profile_image_url);
 574         $ext = $path_parts['extension'];
 575         $end = strlen('_normal' . $ext);
 576         $img_root = substr($path_parts['basename'], 0, -($end+1));
 577         $mediatype = $this->getMediatype($ext);
 578
 579         foreach (array('mini', 'normal', 'bigger') as $size) {
 580             $url = $path_parts['dirname'] . '/' .
 581                 $img_root . '_' . $size . ".$ext";
 582             $filename = 'Twitter_' . $user->id . '_' .
 583                 $img_root . "_$size.$ext";
 584
 585             if ($this->fetchAvatar($url, $filename)) {
 586                 $this->newAvatar($id, $size, $mediatype, $filename);
 587             } else {
 588                 common_log(LOG_WARNING, $id() .
 589                            " - Problem fetching Avatar: $url");
 590             }
 591         }
 592     }
 593
 594     function updateAvatar($profile_id, $size, $mediatype, $filename) {
 595
 596         common_debug($this->name() . " - Updating avatar: $size");
 597
 598         $profile = Profile::staticGet($profile_id);
 599
 600         if (empty($profile)) {
 601             common_debug($this->name() . " - Couldn't get profile: $profile_id!");
 602             return;
 603         }
 604
 605         $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
 606         $avatar = $profile->getAvatar($sizes[$size]);
 607
 608         // Delete the avatar, if present
 609
 610         if ($avatar) {
 611             $avatar->delete();
 612         }
 613
 614         $this->newAvatar($profile->id, $size, $mediatype, $filename);
 615     }
 616
 617     function newAvatar($profile_id, $size, $mediatype, $filename)
 618     {
 619         global $config;
 620
 621         $avatar = new Avatar();
 622         $avatar->profile_id = $profile_id;
 623
 624         switch($size) {
 625         case 'mini':
 626             $avatar->width  = 24;
 627             $avatar->height = 24;
 628             break;
 629         case 'normal':
 630             $avatar->width  = 48;
 631             $avatar->height = 48;
 632             break;
 633         default:
 634
 635             // Note: Twitter's big avatars are a different size than
 636             // StatusNet's (StatusNet's = 96)
 637
 638             $avatar->width  = 73;
 639             $avatar->height = 73;
 640         }
 641
 642         $avatar->original = 0; // we don't have the original
 643         $avatar->mediatype = $mediatype;
 644         $avatar->filename = $filename;
 645         $avatar->url = Avatar::url($filename);
 646
 647         $avatar->created = common_sql_now();
 648
 649         try {
 650             $id = $avatar->insert();
 651         } catch (Exception $e) {
 652             common_log(LOG_WARNING, $this->name() . ' Couldn\'t insert avatar - ' . $e->getMessage());
 653         }
 654
 655         if (empty($id)) {
 656             common_log_db_error($avatar, 'INSERT', __FILE__);
 657             return null;
 658         }
 659
 660         common_debug($this->name() .
 661                      " - Saved new $size avatar for $profile_id.");
 662
 663         return $id;
 664     }
 665
 666     /**
 667      * Fetch a remote avatar image and save to local storage.
 668      *
 669      * @param string $url avatar source URL
 670      * @param string $filename bare local filename for download
 671      * @return bool true on success, false on failure
 672      */
 673     function fetchAvatar($url, $filename)
 674     {
 675         common_debug($this->name() . " - Fetching Twitter avatar: $url");
 676
 677         $request = HTTPClient::start();
 678         $response = $request->get($url);
 679         if ($response->isOk()) {
 680             $avatarfile = Avatar::path($filename);
 681             $ok = file_put_contents($avatarfile, $response->getBody());
 682             if (!$ok) {
 683                 common_log(LOG_WARNING, $this->name() .
 684                            " - Couldn't open file $filename");
 685                 return false;
 686             }
 687         } else {
 688             return false;
 689         }
 690
 691         return true;
 692     }
 693 }
 694
 695 $id    = null;
 696 $debug = null;
 697
 698 if (have_option('i')) {
 699     $id = get_option_value('i');
 700 } else if (have_option('--id')) {
 701     $id = get_option_value('--id');
 702 } else if (count($args) > 0) {
 703     $id = $args[0];
 704 } else {
 705     $id = null;
 706 }
 707
 708 if (have_option('d') || have_option('debug')) {
 709     $debug = true;
 710 }
 711
 712 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);
 713 $fetcher->runOnce();
 714