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                 return $repeat;
 284             }
 285         }
 286
 287         $notice = new Notice();
 288
 289         $notice->profile_id = $profile->id;
 290         $notice->uri        = $statusUri;
 291         $notice->url        = $statusUri;
 292         $notice->created    = strftime(
 293             '%Y-%m-%d %H:%M:%S',
 294             strtotime($status->created_at)
 295         );
 296
 297         $notice->source     = 'twitter';
 298
 299         $notice->reply_to   = null;
 300
 301         if (!empty($status->in_reply_to_status_id)) {
 302             common_log(LOG_INFO, "Status {$status->id} is a reply to status {$status->in_reply_to_status_id}");
 303             $replyUri = $this->makeStatusURI($status->in_reply_to_screen_name, $status->in_reply_to_status_id);
 304             $reply = Notice::staticGet('uri', $replyUri);
 305             if (empty($reply)) {
 306                 common_log(LOG_INFO, "Couldn't find local notice for status {$status->in_reply_to_status_id}");
 307             } else {
 308                 common_log(LOG_INFO, "Found local notice {$reply->id} for status {$status->in_reply_to_status_id}");
 309                 $notice->reply_to     = $reply->id;
 310                 $notice->conversation = $reply->conversation;
 311             }
 312         }
 313
 314         if (empty($notice->conversation)) {
 315             $conv = Conversation::create();
 316             $notice->conversation = $conv->id;
 317             common_log(LOG_INFO, "No known conversation for status {$status->id} so making a new one {$conv->id}.");
 318         }
 319
 320         $notice->is_local   = Notice::GATEWAY;
 321
 322         $notice->content    = common_shorten_links($status->text);
 323         $notice->rendered   = common_render_content(
 324             $notice->content,
 325             $notice
 326         );
 327
 328         if (Event::handle('StartNoticeSave', array(&$notice))) {
 329
 330             $id = $notice->insert();
 331
 332             if (!$id) {
 333                 common_log_db_error($notice, 'INSERT', __FILE__);
 334                 common_log(LOG_ERR, $this->name() .
 335                     ' - Problem saving notice.');
 336             }
 337
 338             Event::handle('EndNoticeSave', array($notice));
 339         }
 340
 341         $notice->blowOnInsert();
 342
 343         return $notice;
 344     }
 345
 346     /**
 347      * Make an URI for a status.
 348      *
 349      * @param object $status status object
 350      *
 351      * @return string URI
 352      */
 353
 354     function makeStatusURI($username, $id)
 355     {
 356         return 'http://twitter.com/'
 357           . $username
 358           . '/status/'
 359           . $id;
 360     }
 361
 362     /**
 363      * Look up a Profile by profileurl field.  Profile::staticGet() was
 364      * not working consistently.
 365      *
 366      * @param string $nickname   local nickname of the Twitter user
 367      * @param string $profileurl the profile url
 368      *
 369      * @return mixed value the first Profile with that url, or null
 370      */
 371
 372     function getProfileByUrl($nickname, $profileurl)
 373     {
 374         $profile = new Profile();
 375         $profile->nickname = $nickname;
 376         $profile->profileurl = $profileurl;
 377         $profile->limit(1);
 378
 379         if ($profile->find()) {
 380             $profile->fetch();
 381             return $profile;
 382         }
 383
 384         return null;
 385     }
 386
 387     /**
 388      * Check to see if this Twitter status has already been imported
 389      *
 390      * @param Profile $profile   Twitter user's local profile
 391      * @param string  $statusUri URI of the status on Twitter
 392      *
 393      * @return mixed value a matching Notice or null
 394      */
 395
 396     function checkDupe($profile, $statusUri)
 397     {
 398         $notice = new Notice();
 399         $notice->uri = $statusUri;
 400         $notice->profile_id = $profile->id;
 401         $notice->limit(1);
 402
 403         if ($notice->find()) {
 404             $notice->fetch();
 405             return $notice;
 406         }
 407
 408         return null;
 409     }
 410
 411     function ensureProfile($user)
 412     {
 413         // check to see if there's already a profile for this user
 414
 415         $profileurl = 'http://twitter.com/' . $user->screen_name;
 416         $profile = $this->getProfileByUrl($user->screen_name, $profileurl);
 417
 418         if (!empty($profile)) {
 419             common_debug($this->name() .
 420                          " - Profile for $profile->nickname found.");
 421
 422             // Check to see if the user's Avatar has changed
 423
 424             $this->checkAvatar($user, $profile);
 425             return $profile;
 426
 427         } else {
 428
 429             common_debug($this->name() . ' - Adding profile and remote profile ' .
 430                          "for Twitter user: $profileurl.");
 431
 432             $profile = new Profile();
 433             $profile->query("BEGIN");
 434
 435             $profile->nickname = $user->screen_name;
 436             $profile->fullname = $user->name;
 437             $profile->homepage = $user->url;
 438             $profile->bio = $user->description;
 439             $profile->location = $user->location;
 440             $profile->profileurl = $profileurl;
 441             $profile->created = common_sql_now();
 442
 443             try {
 444                 $id = $profile->insert();
 445             } catch(Exception $e) {
 446                 common_log(LOG_WARNING, $this->name . ' Couldn\'t insert profile - ' . $e->getMessage());
 447             }
 448
 449             if (empty($id)) {
 450                 common_log_db_error($profile, 'INSERT', __FILE__);
 451                 $profile->query("ROLLBACK");
 452                 return false;
 453             }
 454
 455             // check for remote profile
 456
 457             $remote_pro = Remote_profile::staticGet('uri', $profileurl);
 458
 459             if (empty($remote_pro)) {
 460
 461                 $remote_pro = new Remote_profile();
 462
 463                 $remote_pro->id = $id;
 464                 $remote_pro->uri = $profileurl;
 465                 $remote_pro->created = common_sql_now();
 466
 467                 try {
 468                     $rid = $remote_pro->insert();
 469                 } catch (Exception $e) {
 470                     common_log(LOG_WARNING, $this->name() . ' Couldn\'t save remote profile - ' . $e->getMessage());
 471                 }
 472
 473                 if (empty($rid)) {
 474                     common_log_db_error($profile, 'INSERT', __FILE__);
 475                     $profile->query("ROLLBACK");
 476                     return false;
 477                 }
 478             }
 479
 480             $profile->query("COMMIT");
 481
 482             $this->saveAvatars($user, $id);
 483
 484             return $profile;
 485         }
 486     }
 487
 488     function checkAvatar($twitter_user, $profile)
 489     {
 490         global $config;
 491
 492         $path_parts = pathinfo($twitter_user->profile_image_url);
 493
 494         $newname = 'Twitter_' . $twitter_user->id . '_' .
 495             $path_parts['basename'];
 496
 497         $oldname = $profile->getAvatar(48)->filename;
 498
 499         if ($newname != $oldname) {
 500             common_debug($this->name() . ' - Avatar for Twitter user ' .
 501                          "$profile->nickname has changed.");
 502             common_debug($this->name() . " - old: $oldname new: $newname");
 503
 504             $this->updateAvatars($twitter_user, $profile);
 505         }
 506
 507         if ($this->missingAvatarFile($profile)) {
 508             common_debug($this->name() . ' - Twitter user ' .
 509                          $profile->nickname .
 510                          ' is missing one or more local avatars.');
 511             common_debug($this->name() ." - old: $oldname new: $newname");
 512
 513             $this->updateAvatars($twitter_user, $profile);
 514         }
 515     }
 516
 517     function updateAvatars($twitter_user, $profile) {
 518
 519         global $config;
 520
 521         $path_parts = pathinfo($twitter_user->profile_image_url);
 522
 523         $img_root = substr($path_parts['basename'], 0, -11);
 524         $ext = $path_parts['extension'];
 525         $mediatype = $this->getMediatype($ext);
 526
 527         foreach (array('mini', 'normal', 'bigger') as $size) {
 528             $url = $path_parts['dirname'] . '/' .
 529                 $img_root . '_' . $size . ".$ext";
 530             $filename = 'Twitter_' . $twitter_user->id . '_' .
 531                 $img_root . "_$size.$ext";
 532
 533             $this->updateAvatar($profile->id, $size, $mediatype, $filename);
 534             $this->fetchAvatar($url, $filename);
 535         }
 536     }
 537
 538     function missingAvatarFile($profile) {
 539         foreach (array(24, 48, 73) as $size) {
 540             $filename = $profile->getAvatar($size)->filename;
 541             $avatarpath = Avatar::path($filename);
 542             if (file_exists($avatarpath) == FALSE) {
 543                 return true;
 544             }
 545         }
 546         return false;
 547     }
 548
 549     function getMediatype($ext)
 550     {
 551         $mediatype = null;
 552
 553         switch (strtolower($ext)) {
 554         case 'jpg':
 555             $mediatype = 'image/jpg';
 556             break;
 557         case 'gif':
 558             $mediatype = 'image/gif';
 559             break;
 560         default:
 561             $mediatype = 'image/png';
 562         }
 563
 564         return $mediatype;
 565     }
 566
 567     function saveAvatars($user, $id)
 568     {
 569         global $config;
 570
 571         $path_parts = pathinfo($user->profile_image_url);
 572         $ext = $path_parts['extension'];
 573         $end = strlen('_normal' . $ext);
 574         $img_root = substr($path_parts['basename'], 0, -($end+1));
 575         $mediatype = $this->getMediatype($ext);
 576
 577         foreach (array('mini', 'normal', 'bigger') as $size) {
 578             $url = $path_parts['dirname'] . '/' .
 579                 $img_root . '_' . $size . ".$ext";
 580             $filename = 'Twitter_' . $user->id . '_' .
 581                 $img_root . "_$size.$ext";
 582
 583             if ($this->fetchAvatar($url, $filename)) {
 584                 $this->newAvatar($id, $size, $mediatype, $filename);
 585             } else {
 586                 common_log(LOG_WARNING, $id() .
 587                            " - Problem fetching Avatar: $url");
 588             }
 589         }
 590     }
 591
 592     function updateAvatar($profile_id, $size, $mediatype, $filename) {
 593
 594         common_debug($this->name() . " - Updating avatar: $size");
 595
 596         $profile = Profile::staticGet($profile_id);
 597
 598         if (empty($profile)) {
 599             common_debug($this->name() . " - Couldn't get profile: $profile_id!");
 600             return;
 601         }
 602
 603         $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
 604         $avatar = $profile->getAvatar($sizes[$size]);
 605
 606         // Delete the avatar, if present
 607
 608         if ($avatar) {
 609             $avatar->delete();
 610         }
 611
 612         $this->newAvatar($profile->id, $size, $mediatype, $filename);
 613     }
 614
 615     function newAvatar($profile_id, $size, $mediatype, $filename)
 616     {
 617         global $config;
 618
 619         $avatar = new Avatar();
 620         $avatar->profile_id = $profile_id;
 621
 622         switch($size) {
 623         case 'mini':
 624             $avatar->width  = 24;
 625             $avatar->height = 24;
 626             break;
 627         case 'normal':
 628             $avatar->width  = 48;
 629             $avatar->height = 48;
 630             break;
 631         default:
 632
 633             // Note: Twitter's big avatars are a different size than
 634             // StatusNet's (StatusNet's = 96)
 635
 636             $avatar->width  = 73;
 637             $avatar->height = 73;
 638         }
 639
 640         $avatar->original = 0; // we don't have the original
 641         $avatar->mediatype = $mediatype;
 642         $avatar->filename = $filename;
 643         $avatar->url = Avatar::url($filename);
 644
 645         $avatar->created = common_sql_now();
 646
 647         try {
 648             $id = $avatar->insert();
 649         } catch (Exception $e) {
 650             common_log(LOG_WARNING, $this->name() . ' Couldn\'t insert avatar - ' . $e->getMessage());
 651         }
 652
 653         if (empty($id)) {
 654             common_log_db_error($avatar, 'INSERT', __FILE__);
 655             return null;
 656         }
 657
 658         common_debug($this->name() .
 659                      " - Saved new $size avatar for $profile_id.");
 660
 661         return $id;
 662     }
 663
 664     /**
 665      * Fetch a remote avatar image and save to local storage.
 666      *
 667      * @param string $url avatar source URL
 668      * @param string $filename bare local filename for download
 669      * @return bool true on success, false on failure
 670      */
 671     function fetchAvatar($url, $filename)
 672     {
 673         common_debug($this->name() . " - Fetching Twitter avatar: $url");
 674
 675         $request = HTTPClient::start();
 676         $response = $request->get($url);
 677         if ($response->isOk()) {
 678             $avatarfile = Avatar::path($filename);
 679             $ok = file_put_contents($avatarfile, $response->getBody());
 680             if (!$ok) {
 681                 common_log(LOG_WARNING, $this->name() .
 682                            " - Couldn't open file $filename");
 683                 return false;
 684             }
 685         } else {
 686             return false;
 687         }
 688
 689         return true;
 690     }
 691 }
 692
 693 $id    = null;
 694 $debug = null;
 695
 696 if (have_option('i')) {
 697     $id = get_option_value('i');
 698 } else if (have_option('--id')) {
 699     $id = get_option_value('--id');
 700 } else if (count($args) > 0) {
 701     $id = $args[0];
 702 } else {
 703     $id = null;
 704 }
 705
 706 if (have_option('d') || have_option('debug')) {
 707     $debug = true;
 708 }
 709
 710 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);
 711 $fetcher->runOnce();
 712