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