scripts/synctwitterfriends.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 $shortoptions = 'di::';
  24 $longoptions = array('id::', 'debug');
  25
  26 $helptext = <<<END_OF_TRIM_HELP
  27 Batch script for synching local friends with Twitter friends.
  28   -i --id              Identity (default 'generic')
  29   -d --debug           Debug (lots of log output)
  30
  31 END_OF_TRIM_HELP;
  32
  33 require_once INSTALLDIR . '/scripts/commandline.inc';
  34 require_once INSTALLDIR . '/lib/parallelizingdaemon.php';
  35
  36 /**
  37  * Daemon to sync local friends with Twitter friends
  38  *
  39  * @category Twitter
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @author   Evan Prodromou <evan@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46
  47 $helptext = <<<END_OF_TWITTER_HELP
  48 Batch script for synching local friends with Twitter friends.
  49
  50 END_OF_TWITTER_HELP;
  51
  52 require_once INSTALLDIR . '/scripts/commandline.inc';
  53 require_once INSTALLDIR . '/lib/parallelizingdaemon.php';
  54
  55 class SyncTwitterFriendsDaemon extends ParallelizingDaemon
  56 {
  57     /**
  58      *  Constructor
  59      *
  60      * @param string  $id           the name/id of this daemon
  61      * @param int     $interval     sleep this long before doing everything again
  62      * @param int     $max_children maximum number of child processes at a time
  63      * @param boolean $debug        debug output flag
  64      *
  65      * @return void
  66      *
  67      **/
  68
  69     function __construct($id = null, $interval = 60,
  70                          $max_children = 2, $debug = null)
  71     {
  72         parent::__construct($id, $interval, $max_children, $debug);
  73     }
  74
  75     /**
  76      * Name of this daemon
  77      *
  78      * @return string Name of the daemon.
  79      */
  80
  81     function name()
  82     {
  83         return ('synctwitterfriends.' . $this->_id);
  84     }
  85
  86     /**
  87      * Find all the Twitter foreign links for users who have requested
  88      * automatically subscribing to their Twitter friends locally.
  89      *
  90      * @return array flinks an array of Foreign_link objects
  91      */
  92     function getObjects()
  93     {
  94         $flinks = array();
  95         $flink = new Foreign_link();
  96
  97         $conn = &$flink->getDatabaseConnection();
  98
  99         $flink->service = TWITTER_SERVICE;
 100         $flink->orderBy('last_friendsync');
 101         $flink->limit(25);  // sync this many users during this run
 102         $flink->find();
 103
 104         while ($flink->fetch()) {
 105             if (($flink->friendsync & FOREIGN_FRIEND_RECV) == FOREIGN_FRIEND_RECV) {
 106                 $flinks[] = clone($flink);
 107             }
 108         }
 109
 110         $conn->disconnect();
 111
 112         global $_DB_DATAOBJECT;
 113         unset($_DB_DATAOBJECT['CONNECTIONS']);
 114
 115         return $flinks;
 116     }
 117
 118     function childTask($flink) {
 119
 120         // Each child ps needs its own DB connection
 121
 122         // Note: DataObject::getDatabaseConnection() creates
 123         // a new connection if there isn't one already
 124
 125         $conn = &$flink->getDatabaseConnection();
 126
 127         $this->subscribeTwitterFriends($flink);
 128
 129         $flink->last_friendsync = common_sql_now();
 130         $flink->update();
 131
 132         $conn->disconnect();
 133
 134         // XXX: Couldn't find a less brutal way to blow
 135         // away a cached connection
 136
 137         global $_DB_DATAOBJECT;
 138         unset($_DB_DATAOBJECT['CONNECTIONS']);
 139     }
 140
 141     function fetchTwitterFriends($flink)
 142     {
 143         $friends = array();
 144
 145         $client = null;
 146
 147         if (TwitterOAuthClient::isPackedToken($flink->credentials)) {
 148             $token = TwitterOAuthClient::unpackToken($flink->credentials);
 149             $client = new TwitterOAuthClient($token->key, $token->secret);
 150             common_debug($this->name() . '- Grabbing friends IDs with OAuth.');
 151         } else {
 152             $client = new TwitterBasicAuthClient($flink);
 153             common_debug($this->name() . '- Grabbing friends IDs with basic auth.');
 154         }
 155
 156         try {
 157             $friends_ids = $client->friendsIds();
 158         } catch (Exception $e) {
 159             common_log(LOG_WARNING, $this->name() .
 160                        ' - cURL error getting friend ids ' .
 161                        $e->getCode() . ' - ' . $e->getMessage());
 162             return $friends;
 163         }
 164
 165         if (empty($friends_ids)) {
 166             common_debug($this->name() .
 167                          " - Twitter user $flink->foreign_id " .
 168                          'doesn\'t have any friends!');
 169             return $friends;
 170         }
 171
 172         common_debug($this->name() . ' - Twitter\'s API says Twitter user id ' .
 173                      "$flink->foreign_id has " .
 174                      count($friends_ids) . ' friends.');
 175
 176         // Calculate how many pages to get...
 177         $pages = ceil(count($friends_ids) / 100);
 178
 179         if ($pages == 0) {
 180             common_debug($this->name() . " - $user seems to have no friends.");
 181         }
 182
 183         for ($i = 1; $i <= $pages; $i++) {
 184
 185         try {
 186             $more_friends = $client->statusesFriends(null, null, null, $i);
 187         } catch (Exception $e) {
 188             common_log(LOG_WARNING, $this->name() .
 189                        ' - cURL error getting Twitter statuses/friends ' .
 190                        "page $i - " . $e->getCode() . ' - ' .
 191                        $e->getMessage());
 192         }
 193
 194             if (empty($more_friends)) {
 195                 common_log(LOG_WARNING, $this->name() .
 196                            " - Couldn't retrieve page $i " .
 197                            "of Twitter user $flink->foreign_id friends.");
 198                 continue;
 199             } else {
 200                 $friends = array_merge($friends, $more_friends);
 201             }
 202         }
 203
 204         return $friends;
 205     }
 206
 207     function subscribeTwitterFriends($flink)
 208     {
 209         $friends = $this->fetchTwitterFriends($flink);
 210
 211         if (empty($friends)) {
 212             common_debug($this->name() .
 213                          ' - Couldn\'t get friends from Twitter for ' .
 214                          "Twitter user $flink->foreign_id.");
 215             return false;
 216         }
 217
 218         $user = $flink->getUser();
 219
 220         foreach ($friends as $friend) {
 221
 222             $friend_name = $friend->screen_name;
 223             $friend_id = (int) $friend->id;
 224
 225             // Update or create the Foreign_user record for each
 226             // Twitter friend
 227
 228             if (!save_twitter_user($friend_id, $friend_name)) {
 229                 common_log(LOG_WARNING, $this-name() .
 230                            " - Couldn't save $screen_name's friend, $friend_name.");
 231                 continue;
 232             }
 233
 234             // Check to see if there's a related local user
 235
 236             $friend_flink = Foreign_link::getByForeignID($friend_id,
 237                                                          TWITTER_SERVICE);
 238
 239             if (!empty($friend_flink)) {
 240
 241                 // Get associated user and subscribe her
 242
 243                 $friend_user = User::staticGet('id', $friend_flink->user_id);
 244
 245                 if (!empty($friend_user)) {
 246                     $result = subs_subscribe_to($user, $friend_user);
 247
 248                     if ($result === true) {
 249                         common_log(LOG_INFO,
 250                                    $this->name() . ' - Subscribed ' .
 251                                    "$friend_user->nickname to $user->nickname.");
 252                     } else {
 253                         common_debug($this->name() .
 254                                      ' - Tried subscribing ' .
 255                                      "$friend_user->nickname to $user->nickname - " .
 256                                      $result);
 257                     }
 258                 }
 259             }
 260         }
 261
 262         return true;
 263     }
 264
 265 }
 266
 267 $id    = null;
 268 $debug = null;
 269
 270 if (have_option('i')) {
 271     $id = get_option_value('i');
 272 } else if (have_option('--id')) {
 273     $id = get_option_value('--id');
 274 } else if (count($args) > 0) {
 275     $id = $args[0];
 276 } else {
 277     $id = null;
 278 }
 279
 280 if (have_option('d') || have_option('debug')) {
 281     $debug = true;
 282 }
 283
 284 $syncer = new SyncTwitterFriendsDaemon($id, 60, 2, $debug);
 285 $syncer->runOnce();
 286