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         Inbox::insertNotice($flink->user_id, $notice->id);
 272
 273         $notice->blowCaches();
 274
 275         return $notice;
 276     }
 277
 278     function ensureProfile($user)
 279     {
 280         // check to see if there's already a profile for this user
 281
 282         $profileurl = 'http://twitter.com/' . $user->screen_name;
 283         $profile = Profile::staticGet('profileurl', $profileurl);
 284
 285         if (!empty($profile)) {
 286             common_debug($this->name() .
 287                          " - Profile for $profile->nickname found.");
 288
 289             // Check to see if the user's Avatar has changed
 290
 291             $this->checkAvatar($user, $profile);
 292             return $profile->id;
 293
 294         } else {
 295             common_debug($this->name() . ' - Adding profile and remote profile ' .
 296                          "for Twitter user: $profileurl.");
 297
 298             $profile = new Profile();
 299             $profile->query("BEGIN");
 300
 301             $profile->nickname = $user->screen_name;
 302             $profile->fullname = $user->name;
 303             $profile->homepage = $user->url;
 304             $profile->bio = $user->description;
 305             $profile->location = $user->location;
 306             $profile->profileurl = $profileurl;
 307             $profile->created = common_sql_now();
 308
 309             $id = $profile->insert();
 310
 311             if (empty($id)) {
 312                 common_log_db_error($profile, 'INSERT', __FILE__);
 313                 $profile->query("ROLLBACK");
 314                 return false;
 315             }
 316
 317             // check for remote profile
 318
 319             $remote_pro = Remote_profile::staticGet('uri', $profileurl);
 320
 321             if (empty($remote_pro)) {
 322
 323                 $remote_pro = new Remote_profile();
 324
 325                 $remote_pro->id = $id;
 326                 $remote_pro->uri = $profileurl;
 327                 $remote_pro->created = common_sql_now();
 328
 329                 $rid = $remote_pro->insert();
 330
 331                 if (empty($rid)) {
 332                     common_log_db_error($profile, 'INSERT', __FILE__);
 333                     $profile->query("ROLLBACK");
 334                     return false;
 335                 }
 336             }
 337
 338             $profile->query("COMMIT");
 339
 340             $this->saveAvatars($user, $id);
 341
 342             return $id;
 343         }
 344     }
 345
 346     function checkAvatar($twitter_user, $profile)
 347     {
 348         global $config;
 349
 350         $path_parts = pathinfo($twitter_user->profile_image_url);
 351
 352         $newname = 'Twitter_' . $twitter_user->id . '_' .
 353             $path_parts['basename'];
 354
 355         $oldname = $profile->getAvatar(48)->filename;
 356
 357         if ($newname != $oldname) {
 358             common_debug($this->name() . ' - Avatar for Twitter user ' .
 359                          "$profile->nickname has changed.");
 360             common_debug($this->name() . " - old: $oldname new: $newname");
 361
 362             $this->updateAvatars($twitter_user, $profile);
 363         }
 364
 365         if ($this->missingAvatarFile($profile)) {
 366             common_debug($this->name() . ' - Twitter user ' .
 367                          $profile->nickname .
 368                          ' is missing one or more local avatars.');
 369             common_debug($this->name() ." - old: $oldname new: $newname");
 370
 371             $this->updateAvatars($twitter_user, $profile);
 372         }
 373
 374     }
 375
 376     function updateAvatars($twitter_user, $profile) {
 377
 378         global $config;
 379
 380         $path_parts = pathinfo($twitter_user->profile_image_url);
 381
 382         $img_root = substr($path_parts['basename'], 0, -11);
 383         $ext = $path_parts['extension'];
 384         $mediatype = $this->getMediatype($ext);
 385
 386         foreach (array('mini', 'normal', 'bigger') as $size) {
 387             $url = $path_parts['dirname'] . '/' .
 388                 $img_root . '_' . $size . ".$ext";
 389             $filename = 'Twitter_' . $twitter_user->id . '_' .
 390                 $img_root . "_$size.$ext";
 391
 392             $this->updateAvatar($profile->id, $size, $mediatype, $filename);
 393             $this->fetchAvatar($url, $filename);
 394         }
 395     }
 396
 397     function missingAvatarFile($profile) {
 398
 399         foreach (array(24, 48, 73) as $size) {
 400
 401             $filename = $profile->getAvatar($size)->filename;
 402             $avatarpath = Avatar::path($filename);
 403
 404             if (file_exists($avatarpath) == FALSE) {
 405                 return true;
 406             }
 407         }
 408
 409         return false;
 410     }
 411
 412     function getMediatype($ext)
 413     {
 414         $mediatype = null;
 415
 416         switch (strtolower($ext)) {
 417         case 'jpg':
 418             $mediatype = 'image/jpg';
 419             break;
 420         case 'gif':
 421             $mediatype = 'image/gif';
 422             break;
 423         default:
 424             $mediatype = 'image/png';
 425         }
 426
 427         return $mediatype;
 428     }
 429
 430     function saveAvatars($user, $id)
 431     {
 432         global $config;
 433
 434         $path_parts = pathinfo($user->profile_image_url);
 435         $ext = $path_parts['extension'];
 436         $end = strlen('_normal' . $ext);
 437         $img_root = substr($path_parts['basename'], 0, -($end+1));
 438         $mediatype = $this->getMediatype($ext);
 439
 440         foreach (array('mini', 'normal', 'bigger') as $size) {
 441             $url = $path_parts['dirname'] . '/' .
 442                 $img_root . '_' . $size . ".$ext";
 443             $filename = 'Twitter_' . $user->id . '_' .
 444                 $img_root . "_$size.$ext";
 445
 446             if ($this->fetchAvatar($url, $filename)) {
 447                 $this->newAvatar($id, $size, $mediatype, $filename);
 448             } else {
 449                 common_log(LOG_WARNING, $this->id() .
 450                            " - Problem fetching Avatar: $url");
 451             }
 452         }
 453     }
 454
 455     function updateAvatar($profile_id, $size, $mediatype, $filename) {
 456
 457         common_debug($this->name() . " - Updating avatar: $size");
 458
 459         $profile = Profile::staticGet($profile_id);
 460
 461         if (empty($profile)) {
 462             common_debug($this->name() . " - Couldn't get profile: $profile_id!");
 463             return;
 464         }
 465
 466         $sizes = array('mini' => 24, 'normal' => 48, 'bigger' => 73);
 467         $avatar = $profile->getAvatar($sizes[$size]);
 468
 469         // Delete the avatar, if present
 470
 471         if ($avatar) {
 472             $avatar->delete();
 473         }
 474
 475         $this->newAvatar($profile->id, $size, $mediatype, $filename);
 476     }
 477
 478     function newAvatar($profile_id, $size, $mediatype, $filename)
 479     {
 480         global $config;
 481
 482         $avatar = new Avatar();
 483         $avatar->profile_id = $profile_id;
 484
 485         switch($size) {
 486         case 'mini':
 487             $avatar->width  = 24;
 488             $avatar->height = 24;
 489             break;
 490         case 'normal':
 491             $avatar->width  = 48;
 492             $avatar->height = 48;
 493             break;
 494         default:
 495
 496             // Note: Twitter's big avatars are a different size than
 497             // StatusNet's (StatusNet's = 96)
 498
 499             $avatar->width  = 73;
 500             $avatar->height = 73;
 501         }
 502
 503         $avatar->original = 0; // we don't have the original
 504         $avatar->mediatype = $mediatype;
 505         $avatar->filename = $filename;
 506         $avatar->url = Avatar::url($filename);
 507
 508         $avatar->created = common_sql_now();
 509
 510         $id = $avatar->insert();
 511
 512         if (empty($id)) {
 513             common_log_db_error($avatar, 'INSERT', __FILE__);
 514             return null;
 515         }
 516
 517         common_debug($this->name() .
 518                      " - Saved new $size avatar for $profile_id.");
 519
 520         return $id;
 521     }
 522
 523     /**
 524      * Fetch a remote avatar image and save to local storage.
 525      *
 526      * @param string $url avatar source URL
 527      * @param string $filename bare local filename for download
 528      * @return bool true on success, false on failure
 529      */
 530     function fetchAvatar($url, $filename)
 531     {
 532         common_debug($this->name() . " - Fetching Twitter avatar: $url");
 533
 534         $request = HTTPClient::start();
 535         $response = $request->get($url);
 536         if ($response->isOk()) {
 537             $avatarfile = Avatar::path($filename);
 538             $ok = file_put_contents($avatarfile, $response->getBody());
 539             if (!$ok) {
 540                 common_log(LOG_WARNING, $this->name() .
 541                            " - Couldn't open file $filename");
 542                 return false;
 543             }
 544         } else {
 545             return false;
 546         }
 547
 548         return true;
 549     }
 550 }
 551
 552 $id    = null;
 553 $debug = null;
 554
 555 if (have_option('i')) {
 556     $id = get_option_value('i');
 557 } else if (have_option('--id')) {
 558     $id = get_option_value('--id');
 559 } else if (count($args) > 0) {
 560     $id = $args[0];
 561 } else {
 562     $id = null;
 563 }
 564
 565 if (have_option('d') || have_option('debug')) {
 566     $debug = true;
 567 }
 568
 569 $fetcher = new TwitterStatusFetcher($id, 60, 2, $debug);
 570 $fetcher->runOnce();
 571