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         static $con = NULL;
  48         if (!$con) {
  49                 $con = new OAuthConsumer(common_root_url(), '');
  50         }
  51         return $con;
  52 }
  53
  54 function omb_oauth_server() {
  55         static $server = null;
  56         if (!$server) {
  57                 $server = new OAuthServer(omb_oauth_datastore());
  58                 $server->add_signature_method(omb_hmac_sha1());
  59         }
  60         return $server;
  61 }
  62
  63 function omb_oauth_datastore() {
  64         static $store = NULL;
  65         if (!$store) {
  66                 $store = new LaconicaOAuthDataStore();
  67         }
  68         return $store;
  69 }
  70
  71 function omb_hmac_sha1() {
  72         static $hmac_method = NULL;
  73         if (!$hmac_method) {
  74                 $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
  75         }
  76         return $hmac_method;
  77 }
  78
  79 function omb_get_services($xrd, $type) {
  80         return $xrd->services(array(omb_service_filter($type)));
  81 }
  82
  83 function omb_service_filter($type) {
  84         return create_function('$s',
  85                                                    'return omb_match_service($s, \''.$type.'\');');
  86 }
  87
  88 function omb_match_service($service, $type) {
  89         return in_array($type, $service->getTypes());
  90 }
  91
  92 function omb_service_uri($service) {
  93         if (!$service) {
  94                 return NULL;
  95         }
  96         $uris = $service->getURIs();
  97         if (!$uris) {
  98                 return NULL;
  99         }
 100         return $uris[0];
 101 }
 102
 103 function omb_local_id($service) {
 104         if (!$service) {
 105                 return NULL;
 106         }
 107         $els = $service->getElements('xrd:LocalID');
 108         if (!$els) {
 109                 return NULL;
 110         }
 111         $el = $els[0];
 112         return $service->parser->content($el);
 113 }
 114
 115 function omb_broadcast_remote_subscribers($notice) {
 116
 117         # First, get remote users subscribed to this profile
 118         $rp = new Remote_profile();
 119
 120         $rp->query('SELECT postnoticeurl, token, secret ' .
 121                            'FROM subscription JOIN remote_profile ' .
 122                            'ON subscription.subscriber = remote_profile.id ' .
 123                            'WHERE subscription.subscribed = ' . $notice->profile_id . ' ');
 124
 125         $posted = array();
 126
 127         while ($rp->fetch()) {
 128                 if (!$posted[$rp->postnoticeurl]) {
 129                         common_log(LOG_DEBUG, 'Posting to ' . $rp->postnoticeurl);
 130                         if (omb_post_notice_keys($notice, $rp->postnoticeurl, $rp->token, $rp->secret)) {
 131                                 common_log(LOG_DEBUG, 'Finished to ' . $rp->postnoticeurl);
 132                                 $posted[$rp->postnoticeurl] = TRUE;
 133                         } else {
 134                                 common_log(LOG_DEBUG, 'Failed posting to ' . $rp->postnoticeurl);
 135                         }
 136                 }
 137         }
 138
 139         $rp->free();
 140         unset($rp);
 141
 142         return true;
 143 }
 144
 145 function omb_post_notice($notice, $remote_profile, $subscription) {
 146         return omb_post_notice_keys($notice, $remote_profile->postnoticeurl, $subscription->token, $subscription->secret);
 147 }
 148
 149 function omb_post_notice_keys($notice, $postnoticeurl, $tk, $secret) {
 150
 151         $user = User::staticGet('id', $notice->profile_id);
 152
 153         $con = omb_oauth_consumer();
 154         $token = new OAuthToken($tk, $secret);
 155         $url = $postnoticeurl;
 156         $parsed = parse_url($url);
 157         $params = array();
 158         parse_str($parsed['query'], $params);
 159         $req = OAuthRequest::from_consumer_and_token($con, $token,
 160                                                                                                  "POST", $url, $params);
 161         $req->set_parameter('omb_version', OMB_VERSION_01);
 162         $req->set_parameter('omb_listenee', $user->uri);
 163         $req->set_parameter('omb_notice', $notice->uri);
 164         $req->set_parameter('omb_notice_content', $notice->content);
 165         $req->set_parameter('omb_notice_url', common_local_url('shownotice',
 166                                                                                                                    array('notice' =>
 167                                                                                                                                  $notice->id)));
 168         $req->set_parameter('omb_notice_license', common_config('license', 'url'));
 169
 170         $user->free();
 171         unset($user);
 172
 173         $req->sign_request(omb_hmac_sha1(), $con, $token);
 174
 175         # We re-use this tool's fetcher, since it's pretty good
 176
 177         $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 178
 179         $result = $fetcher->post($req->get_normalized_http_url(),
 180                                                          $req->to_postdata());
 181
 182         common_debug('Got HTTP result "'.print_r($result,TRUE).'"', __FILE__);
 183
 184         if ($result->status == 403) { # not authorized, don't send again
 185                 common_debug('403 result, deleting subscription', __FILE__);
 186                 # FIXME: figure out how to delete this
 187                 # $subscription->delete();
 188                 return false;
 189         } else if ($result->status != 200) {
 190                 common_debug('Error status '.$result->status, __FILE__);
 191                 return false;
 192         } else { # success!
 193                 parse_str($result->body, $return);
 194                 if ($return['omb_version'] == OMB_VERSION_01) {
 195                         return true;
 196                 } else {
 197                         return false;
 198                 }
 199         }
 200 }
 201
 202 function omb_broadcast_profile($profile) {
 203         # First, get remote users subscribed to this profile
 204         # XXX: use a join here rather than looping through results
 205         $sub = new Subscription();
 206         $sub->subscribed = $profile->id;
 207         if ($sub->find()) {
 208                 $updated = array();
 209                 while ($sub->fetch()) {
 210                         $rp = Remote_profile::staticGet('id', $sub->subscriber);
 211                         if ($rp) {
 212                                 if (!$updated[$rp->updateprofileurl]) {
 213                                         if (omb_update_profile($profile, $rp, $sub)) {
 214                                                 $updated[$rp->updateprofileurl] = TRUE;
 215                                         }
 216                                 }
 217                         }
 218                 }
 219         }
 220 }
 221
 222 function omb_update_profile($profile, $remote_profile, $subscription) {
 223         global $config; # for license URL
 224         $user = User::staticGet($profile->id);
 225         $con = omb_oauth_consumer();
 226         $token = new OAuthToken($subscription->token, $subscription->secret);
 227         $url = $remote_profile->updateprofileurl;
 228         $parsed = parse_url($url);
 229         $params = array();
 230         parse_str($parsed['query'], $params);
 231         $req = OAuthRequest::from_consumer_and_token($con, $token,
 232                                                                                                  "POST", $url, $params);
 233         $req->set_parameter('omb_version', OMB_VERSION_01);
 234         $req->set_parameter('omb_listenee', $user->uri);
 235         $req->set_parameter('omb_listenee_profile', common_profile_url($profile->nickname));
 236         $req->set_parameter('omb_listenee_nickname', $profile->nickname);
 237
 238         # We use blanks to force emptying any existing values in these optional fields
 239
 240         $req->set_parameter('omb_listenee_fullname',
 241                                                 ($profile->fullname) ? $profile->fullname : '');
 242         $req->set_parameter('omb_listenee_homepage',
 243                                                 ($profile->homepage) ? $profile->homepage : '');
 244         $req->set_parameter('omb_listenee_bio',
 245                                                 ($profile->bio) ? $profile->bio : '');
 246         $req->set_parameter('omb_listenee_location',
 247                                                 ($profile->location) ? $profile->location : '');
 248
 249         $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 250         $req->set_parameter('omb_listenee_avatar',
 251                                                 ($avatar) ? $avatar->url : '');
 252
 253         $req->sign_request(omb_hmac_sha1(), $con, $token);
 254
 255         # We re-use this tool's fetcher, since it's pretty good
 256
 257         $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 258
 259         common_debug('request URL = '.$req->get_normalized_http_url(), __FILE__);
 260         common_debug('postdata = '.$req->to_postdata(), __FILE__);
 261         $result = $fetcher->post($req->get_normalized_http_url(),
 262                                                          $req->to_postdata());
 263
 264         common_debug('Got HTTP result "'.print_r($result,TRUE).'"', __FILE__);
 265
 266         if ($result->status == 403) { # not authorized, don't send again
 267                 common_debug('403 result, deleting subscription', __FILE__);
 268                 $subscription->delete();
 269                 return false;
 270         } else if ($result->status != 200) {
 271                 common_debug('Error status '.$result->status, __FILE__);
 272                 return false;
 273         } else { # success!
 274                 parse_str($result->body, $return);
 275                 if ($return['omb_version'] == OMB_VERSION_01) {
 276                         return true;
 277                 } else {
 278                         return false;
 279                 }
 280         }
 281 }