lib/omb.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('OAuth.php');
  23 require_once(INSTALLDIR.'/lib/oauthstore.php');
  24
  25 require_once(INSTALLDIR.'/classes/Consumer.php');
  26 require_once(INSTALLDIR.'/classes/Nonce.php');
  27 require_once(INSTALLDIR.'/classes/Token.php');
  28
  29 require_once('Auth/Yadis/Yadis.php');
  30
  31 define('OAUTH_NAMESPACE', 'http://oauth.net/core/1.0/');
  32 define('OMB_NAMESPACE', 'http://openmicroblogging.org/protocol/0.1');
  33 define('OMB_VERSION_01', 'http://openmicroblogging.org/protocol/0.1');
  34 define('OAUTH_DISCOVERY', 'http://oauth.net/discovery/1.0');
  35
  36 define('OMB_ENDPOINT_UPDATEPROFILE', OMB_NAMESPACE.'/updateProfile');
  37 define('OMB_ENDPOINT_POSTNOTICE', OMB_NAMESPACE.'/postNotice');
  38 define('OAUTH_ENDPOINT_REQUEST', OAUTH_NAMESPACE.'endpoint/request');
  39 define('OAUTH_ENDPOINT_AUTHORIZE', OAUTH_NAMESPACE.'endpoint/authorize');
  40 define('OAUTH_ENDPOINT_ACCESS', OAUTH_NAMESPACE.'endpoint/access');
  41 define('OAUTH_ENDPOINT_RESOURCE', OAUTH_NAMESPACE.'endpoint/resource');
  42 define('OAUTH_AUTH_HEADER', OAUTH_NAMESPACE.'parameters/auth-header');
  43 define('OAUTH_POST_BODY', OAUTH_NAMESPACE.'parameters/post-body');
  44 define('OAUTH_HMAC_SHA1', OAUTH_NAMESPACE.'signature/HMAC-SHA1');
  45
  46 function omb_oauth_consumer()
  47 {
  48     static $con = null;
  49     if (!$con) {
  50         $con = new OAuthConsumer(common_root_url(), '');
  51     }
  52     return $con;
  53 }
  54
  55 function omb_oauth_server()
  56 {
  57     static $server = null;
  58     if (!$server) {
  59         $server = new OAuthServer(omb_oauth_datastore());
  60         $server->add_signature_method(omb_hmac_sha1());
  61     }
  62     return $server;
  63 }
  64
  65 function omb_oauth_datastore()
  66 {
  67     static $store = null;
  68     if (!$store) {
  69         $store = new LaconicaOAuthDataStore();
  70     }
  71     return $store;
  72 }
  73
  74 function omb_hmac_sha1()
  75 {
  76     static $hmac_method = null;
  77     if (!$hmac_method) {
  78         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
  79     }
  80     return $hmac_method;
  81 }
  82
  83 function omb_get_services($xrd, $type)
  84 {
  85     return $xrd->services(array(omb_service_filter($type)));
  86 }
  87
  88 function omb_service_filter($type)
  89 {
  90     return create_function('$s',
  91                            'return omb_match_service($s, \''.$type.'\');');
  92 }
  93
  94 function omb_match_service($service, $type)
  95 {
  96     return in_array($type, $service->getTypes());
  97 }
  98
  99 function omb_service_uri($service)
 100 {
 101     if (!$service) {
 102         return null;
 103     }
 104     $uris = $service->getURIs();
 105     if (!$uris) {
 106         return null;
 107     }
 108     return $uris[0];
 109 }
 110
 111 function omb_local_id($service)
 112 {
 113     if (!$service) {
 114         return null;
 115     }
 116     $els = $service->getElements('xrd:LocalID');
 117     if (!$els) {
 118         return null;
 119     }
 120     $el = $els[0];
 121     return $service->parser->content($el);
 122 }
 123
 124 function omb_broadcast_remote_subscribers($notice)
 125 {
 126
 127     # First, get remote users subscribed to this profile
 128     $rp = new Remote_profile();
 129
 130     $rp->query('SELECT postnoticeurl, token, secret ' .
 131                'FROM subscription JOIN remote_profile ' .
 132                'ON subscription.subscriber = remote_profile.id ' .
 133                'WHERE subscription.subscribed = ' . $notice->profile_id . ' ');
 134
 135     $posted = array();
 136
 137     while ($rp->fetch()) {
 138         if (!$posted[$rp->postnoticeurl]) {
 139             common_log(LOG_DEBUG, 'Posting to ' . $rp->postnoticeurl);
 140             if (omb_post_notice_keys($notice, $rp->postnoticeurl, $rp->token, $rp->secret)) {
 141                 common_log(LOG_DEBUG, 'Finished to ' . $rp->postnoticeurl);
 142                 $posted[$rp->postnoticeurl] = true;
 143             } else {
 144                 common_log(LOG_DEBUG, 'Failed posting to ' . $rp->postnoticeurl);
 145             }
 146         }
 147     }
 148
 149     $rp->free();
 150     unset($rp);
 151
 152     return true;
 153 }
 154
 155 function omb_post_notice($notice, $remote_profile, $subscription)
 156 {
 157     return omb_post_notice_keys($notice, $remote_profile->postnoticeurl, $subscription->token, $subscription->secret);
 158 }
 159
 160 function omb_post_notice_keys($notice, $postnoticeurl, $tk, $secret)
 161 {
 162
 163     common_debug('Posting notice ' . $notice->id . ' to ' . $postnoticeurl, __FILE__);
 164
 165     $user = User::staticGet('id', $notice->profile_id);
 166
 167     if (!$user) {
 168         common_debug('Failed to get user for notice ' . $notice->id . ', profile = ' . $notice->profile_id, __FILE__);
 169         return false;
 170     }
 171
 172     $con = omb_oauth_consumer();
 173
 174     $token = new OAuthToken($tk, $secret);
 175
 176     $url = $postnoticeurl;
 177     $parsed = parse_url($url);
 178     $params = array();
 179     parse_str($parsed['query'], $params);
 180
 181     $req = OAuthRequest::from_consumer_and_token($con, $token,
 182                                                  'POST', $url, $params);
 183
 184     $req->set_parameter('omb_version', OMB_VERSION_01);
 185     $req->set_parameter('omb_listenee', $user->uri);
 186     $req->set_parameter('omb_notice', $notice->uri);
 187     $req->set_parameter('omb_notice_content', $notice->content);
 188     $req->set_parameter('omb_notice_url', common_local_url('shownotice',
 189                                                            array('notice' =>
 190                                                                  $notice->id)));
 191     $req->set_parameter('omb_notice_license', common_config('license', 'url'));
 192
 193     $user->free();
 194     unset($user);
 195
 196     $req->sign_request(omb_hmac_sha1(), $con, $token);
 197
 198     # We re-use this tool's fetcher, since it's pretty good
 199
 200     $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 201
 202     if (!$fetcher) {
 203         common_log(LOG_WARNING, 'Failed to initialize Yadis fetcher.', __FILE__);
 204         return false;
 205     }
 206
 207     $result = $fetcher->post($req->get_normalized_http_url(),
 208                              $req->to_postdata(),
 209                              array('User-Agent: Laconica/' . LACONICA_VERSION));
 210
 211     common_debug('Got HTTP result "'.print_r($result,true).'"', __FILE__);
 212
 213     if ($result->status == 403) { # not authorized, don't send again
 214         common_debug('403 result, deleting subscription', __FILE__);
 215         # FIXME: figure out how to delete this
 216         # $subscription->delete();
 217         return false;
 218     } else if ($result->status != 200) {
 219         common_debug('Error status '.$result->status, __FILE__);
 220         return false;
 221     } else { # success!
 222         parse_str($result->body, $return);
 223         if ($return['omb_version'] == OMB_VERSION_01) {
 224             return true;
 225         } else {
 226             return false;
 227         }
 228     }
 229 }
 230
 231 function omb_broadcast_profile($profile)
 232 {
 233     # First, get remote users subscribed to this profile
 234     # XXX: use a join here rather than looping through results
 235     $sub = new Subscription();
 236     $sub->subscribed = $profile->id;
 237     if ($sub->find()) {
 238         $updated = array();
 239         while ($sub->fetch()) {
 240             $rp = Remote_profile::staticGet('id', $sub->subscriber);
 241             if ($rp) {
 242                 if (!array_key_exists($rp->updateprofileurl, $updated)) {
 243                     if (omb_update_profile($profile, $rp, $sub)) {
 244                         $updated[$rp->updateprofileurl] = true;
 245                     }
 246                 }
 247             }
 248         }
 249     }
 250 }
 251
 252 function omb_update_profile($profile, $remote_profile, $subscription)
 253 {
 254     $user = User::staticGet($profile->id);
 255     $con = omb_oauth_consumer();
 256     $token = new OAuthToken($subscription->token, $subscription->secret);
 257     $url = $remote_profile->updateprofileurl;
 258     $parsed = parse_url($url);
 259     $params = array();
 260     parse_str($parsed['query'], $params);
 261     $req = OAuthRequest::from_consumer_and_token($con, $token,
 262                                                  "POST", $url, $params);
 263     $req->set_parameter('omb_version', OMB_VERSION_01);
 264     $req->set_parameter('omb_listenee', $user->uri);
 265     $req->set_parameter('omb_listenee_profile', common_profile_url($profile->nickname));
 266     $req->set_parameter('omb_listenee_nickname', $profile->nickname);
 267
 268     # We use blanks to force emptying any existing values in these optional fields
 269
 270     $req->set_parameter('omb_listenee_fullname',
 271                         ($profile->fullname) ? $profile->fullname : '');
 272     $req->set_parameter('omb_listenee_homepage',
 273                         ($profile->homepage) ? $profile->homepage : '');
 274     $req->set_parameter('omb_listenee_bio',
 275                         ($profile->bio) ? $profile->bio : '');
 276     $req->set_parameter('omb_listenee_location',
 277                         ($profile->location) ? $profile->location : '');
 278
 279     $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 280     $req->set_parameter('omb_listenee_avatar',
 281                         ($avatar) ? $avatar->url : '');
 282
 283     $req->sign_request(omb_hmac_sha1(), $con, $token);
 284
 285     # We re-use this tool's fetcher, since it's pretty good
 286
 287     $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 288
 289     common_debug('request URL = '.$req->get_normalized_http_url(), __FILE__);
 290     common_debug('postdata = '.$req->to_postdata(), __FILE__);
 291     $result = $fetcher->post($req->get_normalized_http_url(),
 292                              $req->to_postdata(),
 293                              array('User-Agent: Laconica/' . LACONICA_VERSION));
 294
 295     common_debug('Got HTTP result "'.print_r($result,true).'"', __FILE__);
 296
 297     if (empty($result) || !$result) {
 298         common_debug("Unable to contact " . $req->get_normalized_http_url());
 299     } else if ($result->status == 403) { # not authorized, don't send again
 300         common_debug('403 result, deleting subscription', __FILE__);
 301         $subscription->delete();
 302         return false;
 303     } else if ($result->status != 200) {
 304         common_debug('Error status '.$result->status, __FILE__);
 305         return false;
 306     } else { # success!
 307         parse_str($result->body, $return);
 308         if (isset($return['omb_version']) && $return['omb_version'] === OMB_VERSION_01) {
 309             return true;
 310         } else {
 311             return false;
 312         }
 313     }
 314 }