actions/remotesubscribe.php

   1 <?php
   2 /*
   3  * Laconica - a distributed open-source microblogging tool
   4  * Copyright (C) 2008, Controlez-Vous, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('LACONICA')) { exit(1); }
  21
  22 require_once(INSTALLDIR.'/lib/omb.php');
  23 require_once('Auth/Yadis/Yadis.php');
  24
  25 class RemotesubscribeAction extends Action {
  26
  27         function handle($args) {
  28
  29                 parent::handle($args);
  30
  31                 if (common_logged_in()) {
  32                         common_user_error(_t('You can use the local subscription!'));
  33                     return;
  34                 }
  35
  36                 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
  37                         $this->remote_subscription();
  38                 } else {
  39                         $this->show_form();
  40                 }
  41         }
  42
  43         function show_form($err=NULL) {
  44                 $nickname = $this->trimmed('nickname');
  45                 common_show_header(_t('Remote subscribe'));
  46                 if ($err) {
  47                         common_element('div', 'error', $err);
  48                 }
  49                 common_element_start('form', array('id' => 'remotesubscribe', 'method' => 'POST',
  50                                                                                    'action' => common_local_url('remotesubscribe')));
  51                 common_input('nickname', _t('User nickname'), $nickname);
  52                 common_input('profile', _t('Profile URL'));
  53                 common_submit('submit', _t('Subscribe'));
  54                 common_element_end('form');
  55                 common_show_footer();
  56         }
  57
  58         function remote_subscription() {
  59                 $user = $this->get_user();
  60
  61                 if (!$user) {
  62                         $this->show_form(_t('No such user!'));
  63                         return;
  64                 }
  65
  66                 $profile = $this->trimmed('profile');
  67
  68                 if (!$profile) {
  69                         $this->show_form(_t('No such user!'));
  70                         return;
  71                 }
  72
  73                 if (!Validate::uri($profile, array('allowed_schemes' => array('http', 'https')))) {
  74                         $this->show_form(_t('Invalid profile URL (bad format)'));
  75                         return;
  76                 }
  77
  78                 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
  79                 $yadis = Auth_Yadis_Yadis::discover($profile, $fetcher);
  80
  81                 common_debug('remotesubscribe.php: XRDS discovery failure? "'.$yadis->failed.'"');
  82
  83                 if (!$yadis || $yadis->failed) {
  84                         $this->show_form(_t('Not a valid profile URL (no YADIS document).'));
  85                         return;
  86                 }
  87
  88         $xrds =& Auth_Yadis_XRDS::parseXRDS($yadis->response_text);
  89
  90                 if (!$xrds) {
  91                         $this->show_form(_t('Not a valid profile URL (no XRDS defined).'));
  92                         return;
  93                 }
  94
  95                 common_debug('remotesubscribe.php: XRDS is "'.print_r($xrds,TRUE).'"');
  96
  97                 $omb = $this->getOmb($xrds);
  98
  99                 if (!$omb) {
 100                         $this->show_form(_t('Not a valid profile URL (incorrect services).'));
 101                         return;
 102                 }
 103
 104                 list($token, $secret) = $this->request_token($omb);
 105
 106                 if (!$token || !$secret) {
 107                         $this->show_form(_t('Couldn\'t get a request token.'));
 108                         return;
 109                 }
 110
 111                 $this->request_authorization($user, $omb, $token, $secret);
 112         }
 113
 114         function get_user() {
 115                 $user = NULL;
 116                 $nickname = $this->trimmed('nickname');
 117                 if ($nickname) {
 118                         $user = User::staticGet('nickname', $nickname);
 119                 }
 120                 return $user;
 121         }
 122
 123         function getOmb($xrds) {
 124
 125             static $omb_endpoints = array(OMB_ENDPOINT_UPDATEPROFILE, OMB_ENDPOINT_POSTNOTICE);
 126                 static $oauth_endpoints = array(OAUTH_ENDPOINT_REQUEST, OAUTH_ENDPOINT_AUTHORIZE,
 127                                                                                 OAUTH_ENDPOINT_ACCESS);
 128                 $omb = array();
 129
 130                 # XXX: the following code could probably be refactored to eliminate dupes
 131
 132                 common_debug('remotesubscribe.php - looking for oauth discovery service');
 133
 134                 $oauth_services = $xrds->services(omb_service_filter(OAUTH_DISCOVERY));
 135
 136                 if (!$oauth_services) {
 137                         common_debug('remotesubscribe.php - failed to find oauth discovery service');
 138                         return NULL;
 139                 }
 140
 141                 $oauth_service = $oauth_services[0];
 142
 143                 common_debug('remotesubscribe.php - looking for oauth discovery XRD');
 144
 145                 $xrd = $this->getXRD($oauth_service, $xrds);
 146
 147                 if (!$xrd) {
 148                         common_debug('remotesubscribe.php - failed to find oauth discovery XRD');
 149                         return NULL;
 150                 }
 151
 152                 common_debug('remotesubscribe.php - adding OAuth services from XRD');
 153
 154                 if (!$this->addServices($xrd, $oauth_endpoints, $omb)) {
 155                         common_debug('remotesubscribe.php - failed to add OAuth services');
 156                         return NULL;
 157                 }
 158
 159                 common_debug('remotesubscribe.php - looking for OMB discovery service');
 160
 161                 $omb_services = $xrds->services(omb_service_filter(OMB_NAMESPACE));
 162
 163                 if (!$omb_services) {
 164                         common_debug('remotesubscribe.php - failed to find OMB discovery service');
 165                         return NULL;
 166                 }
 167
 168                 $omb_service = $omb_services[0];
 169
 170                 common_debug('remotesubscribe.php - looking for OMB discovery XRD');
 171
 172                 $xrd = $this->getXRD($omb_service, $xrds);
 173
 174                 if (!$xrd) {
 175                         common_debug('remotesubscribe.php - failed to find OMB discovery XRD');
 176                         return NULL;
 177                 }
 178
 179                 common_debug('remotesubscribe.php - adding OMB services from XRD');
 180
 181                 if (!$this->addServices($xrd, $omb_endpoints, $omb)) {
 182                         common_debug('remotesubscribe.php - failed to add OMB services');
 183                         return NULL;
 184                 }
 185
 186                 # XXX: check that we got all the services we needed
 187
 188                 foreach (array_merge($omb_endpoints, $oauth_endpoints) as $type) {
 189                         if (!array_key_exists($type, $omb) || !$omb[$type]) {
 190                                 common_debug('remotesubscribe.php - could not find type "'.$type.'"');
 191                                 return NULL;
 192                         }
 193                 }
 194
 195                 if (!omb_local_id($omb[OAUTH_ENDPOINT_REQUEST])) {
 196                         common_debug('remotesubscribe.php - request token service has no LocalID.');
 197                         return NULL;
 198                 }
 199
 200                 return $omb;
 201         }
 202
 203         function getXRD($main_service, $main_xrds) {
 204                 $uri = omb_service_uri($main_service);
 205                 if (strpos($uri, "#") !== 0) {
 206                         # FIXME: more rigorous handling of external service definitions
 207                         return NULL;
 208                 }
 209                 $id = substr($uri, 1);
 210                 $nodes = $main_xrds->allXrdNodes;
 211                 $parser = $main_xrds->parser;
 212                 foreach ($nodes as $node) {
 213                         $attrs = $parser->attributes($node);
 214                         if (array_key_exists('xml:id', $attrs) &&
 215                                 $attrs['xml:id'] == $id) {
 216                                 # XXX: trick the constructor into thinking this is the only node
 217                                 $bogus_nodes = array($node);
 218                                 return new Auth_Yadis_XRDS($parser, $bogus_nodes);
 219                         }
 220                 }
 221                 return NULL;
 222         }
 223
 224         function addServices($xrd, $types, &$omb) {
 225                 foreach ($types as $type) {
 226                         $matches = $xrd->services(omb_service_filter($type));
 227                         if ($matches) {
 228                                 $omb[$type] = $matches[0];
 229                         } else {
 230                                 # no match for type
 231                                 return false;
 232                         }
 233                 }
 234                 return true;
 235         }
 236
 237         function request_token($omb) {
 238                 $con = omb_oauth_consumer();
 239
 240                 $url = omb_service_uri($omb[OAUTH_ENDPOINT_REQUEST]);
 241
 242                 # XXX: Is this the right thing to do? Strip off GET params and make them
 243                 # POST params? Seems wrong to me.
 244
 245                 $parsed = parse_url($url);
 246                 $params = array();
 247                 parse_str($parsed['query'], $params);
 248
 249                 common_debug('remotesubscribe.php - building a POST message for request token call');
 250
 251                 $req = OAuthRequest::from_consumer_and_token($con, NULL, "POST", $url, $params);
 252
 253                 $listener = omb_local_id($omb[OAUTH_ENDPOINT_REQUEST]);
 254
 255                 if (!$listener) {
 256                         return NULL;
 257                 }
 258
 259                 common_debug('remotesubscribe.php - request token listener = "' . $listener . '"');
 260
 261                 $req->set_parameter('omb_listener', $listener);
 262                 $req->set_parameter('omb_version', OMB_VERSION_01);
 263
 264                 # XXX: test to see if endpoint accepts this signature method
 265
 266                 $req->sign_request(omb_hmac_sha1(), $con, NULL);
 267
 268                 # We re-use this tool's fetcher, since it's pretty good
 269
 270                 $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 271
 272                 common_debug('remotesubscribe.php - request token URL = "'.$req->get_normalized_http_url().'"');
 273                 common_debug('remotesubscribe.php - request token data = "'.$req->to_postdata().'"');
 274
 275                 $result = $fetcher->post($req->get_normalized_http_url(),
 276                                                                  $req->to_postdata());
 277
 278                 if ($result->status != 200) {
 279                         common_debug('remotesubscribe.php - request token status = "' . $result->status . '"');
 280                         common_debug('remotesubscribe.php - request token body = "' . $result->body . '"');
 281                         return NULL;
 282                 }
 283
 284                 common_debug('remotesubscribe.php - request token body = "' . $result->body . '"');
 285
 286                 parse_str($result->body, $return);
 287
 288                 common_debug('remotesubscribe.php - request token token = "' . $return['oauth_token'] . '"');
 289                 common_debug('remotesubscribe.php - request token secret = "' . $return['oauth_token_secret'] . '"');
 290
 291                 return array($return['oauth_token'], $return['oauth_token_secret']);
 292         }
 293
 294         function request_authorization($user, $omb, $token, $secret) {
 295                 global $config; # for license URL
 296
 297                 $con = omb_oauth_consumer();
 298                 $tok = new OAuthToken($token, $secret);
 299
 300                 $url = omb_service_uri($omb[OAUTH_ENDPOINT_AUTHORIZE]);
 301
 302                 # XXX: Is this the right thing to do? Strip off GET params and make them
 303                 # POST params? Seems wrong to me.
 304
 305                 $parsed = parse_url($url);
 306                 $params = array();
 307                 parse_str($parsed['query'], $params);
 308
 309                 $req = OAuthRequest::from_consumer_and_token($con, $tok, 'GET', $url, $params);
 310
 311                 # We send over a ton of information. This lets the other
 312                 # server store info about our user, and it lets the current
 313                 # user decide if they really want to authorize the subscription.
 314
 315                 $req->set_parameter('omb_version', OMB_VERSION_01);
 316                 $req->set_parameter('omb_listener', omb_local_id($omb[OAUTH_ENDPOINT_REQUEST]));
 317                 $req->set_parameter('omb_listenee', $user->uri);
 318                 $req->set_parameter('omb_listenee_profile', common_profile_url($user->nickname));
 319                 $req->set_parameter('omb_listenee_nickname', $user->nickname);
 320                 $req->set_parameter('omb_listenee_license', $config['license']['url']);
 321                 $profile = $user->getProfile();
 322                 if ($profile->fullname) {
 323                         $req->set_parameter('omb_listenee_fullname', $profile->fullname);
 324                 }
 325                 if ($profile->homepage) {
 326                         $req->set_parameter('omb_listenee_homepage', $profile->homepage);
 327                 }
 328                 if ($profile->bio) {
 329                         $req->set_parameter('omb_listenee_bio', $profile->bio);
 330                 }
 331                 if ($profile->location) {
 332                         $req->set_parameter('omb_listenee_location', $profile->location);
 333                 }
 334                 $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 335                 if ($avatar) {
 336                         $req->set_parameter('omb_listenee_avatar', $avatar->url);
 337                 }
 338
 339                 $nonce = $this->make_nonce();
 340
 341                 $req->set_parameter('oauth_callback', common_local_url('finishremotesubscribe',
 342                                                                                                                            array('nonce' => $nonce)));
 343
 344                 # XXX: test to see if endpoint accepts this signature method
 345
 346                 $req->sign_request(omb_hmac_sha1(), $con, $tok);
 347
 348                 # store all our info here
 349
 350                 $omb['listenee'] = $user->nickname;
 351                 $omb['token'] = $token;
 352                 $omb['secret'] = $secret;
 353
 354                 $_SESSION[$nonce] = $omb;
 355
 356                 # Redirect to authorization service
 357
 358                 common_redirect($req->to_url());
 359                 return;
 360         }
 361
 362         function make_nonce() {
 363                 return common_good_rand(16);
 364         }
 365 }