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     common_debug('Posting notice ' . $notice->id . ' to ' . $postnoticeurl, __FILE__);
 152
 153     $user = User::staticGet('id', $notice->profile_id);
 154
 155     if (!$user) {
 156         common_debug('Failed to get user for notice ' . $notice->id . ', profile = ' . $notice->profile_id, __FILE__);
 157         return false;
 158     }
 159
 160     $con = omb_oauth_consumer();
 161
 162     $token = new OAuthToken($tk, $secret);
 163
 164     $url = $postnoticeurl;
 165     $parsed = parse_url($url);
 166     $params = array();
 167     parse_str($parsed['query'], $params);
 168
 169     $req = OAuthRequest::from_consumer_and_token($con, $token,
 170                                                  'POST', $url, $params);
 171
 172     $req->set_parameter('omb_version', OMB_VERSION_01);
 173     $req->set_parameter('omb_listenee', $user->uri);
 174     $req->set_parameter('omb_notice', $notice->uri);
 175     $req->set_parameter('omb_notice_content', $notice->content);
 176     $req->set_parameter('omb_notice_url', common_local_url('shownotice',
 177                                                            array('notice' =>
 178                                                                  $notice->id)));
 179     $req->set_parameter('omb_notice_license', common_config('license', 'url'));
 180
 181     $user->free();
 182     unset($user);
 183
 184     $req->sign_request(omb_hmac_sha1(), $con, $token);
 185
 186     # We re-use this tool's fetcher, since it's pretty good
 187
 188     $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 189
 190     if (!$fetcher) {
 191         common_log(LOG_WARNING, 'Failed to initialize Yadis fetcher.', __FILE__);
 192         return false;
 193     }
 194
 195     $result = $fetcher->post($req->get_normalized_http_url(),
 196                              $req->to_postdata(),
 197                              array('User-Agent' => 'Laconica/' . LACONICA_VERSION));
 198
 199     common_debug('Got HTTP result "'.print_r($result,TRUE).'"', __FILE__);
 200
 201     if ($result->status == 403) { # not authorized, don't send again
 202         common_debug('403 result, deleting subscription', __FILE__);
 203         # FIXME: figure out how to delete this
 204         # $subscription->delete();
 205         return false;
 206     } else if ($result->status != 200) {
 207         common_debug('Error status '.$result->status, __FILE__);
 208         return false;
 209     } else { # success!
 210         parse_str($result->body, $return);
 211         if ($return['omb_version'] == OMB_VERSION_01) {
 212             return true;
 213         } else {
 214             return false;
 215         }
 216     }
 217 }
 218
 219 function omb_broadcast_profile($profile) {
 220     # First, get remote users subscribed to this profile
 221     # XXX: use a join here rather than looping through results
 222     $sub = new Subscription();
 223     $sub->subscribed = $profile->id;
 224     if ($sub->find()) {
 225         $updated = array();
 226         while ($sub->fetch()) {
 227             $rp = Remote_profile::staticGet('id', $sub->subscriber);
 228             if ($rp) {
 229                 if (!$updated[$rp->updateprofileurl]) {
 230                     if (omb_update_profile($profile, $rp, $sub)) {
 231                         $updated[$rp->updateprofileurl] = TRUE;
 232                     }
 233                 }
 234             }
 235         }
 236     }
 237 }
 238
 239 function omb_update_profile($profile, $remote_profile, $subscription) {
 240     global $config; # for license URL
 241     $user = User::staticGet($profile->id);
 242     $con = omb_oauth_consumer();
 243     $token = new OAuthToken($subscription->token, $subscription->secret);
 244     $url = $remote_profile->updateprofileurl;
 245     $parsed = parse_url($url);
 246     $params = array();
 247     parse_str($parsed['query'], $params);
 248     $req = OAuthRequest::from_consumer_and_token($con, $token,
 249                                                  "POST", $url, $params);
 250     $req->set_parameter('omb_version', OMB_VERSION_01);
 251     $req->set_parameter('omb_listenee', $user->uri);
 252     $req->set_parameter('omb_listenee_profile', common_profile_url($profile->nickname));
 253     $req->set_parameter('omb_listenee_nickname', $profile->nickname);
 254
 255     # We use blanks to force emptying any existing values in these optional fields
 256
 257     $req->set_parameter('omb_listenee_fullname',
 258                         ($profile->fullname) ? $profile->fullname : '');
 259     $req->set_parameter('omb_listenee_homepage',
 260                         ($profile->homepage) ? $profile->homepage : '');
 261     $req->set_parameter('omb_listenee_bio',
 262                         ($profile->bio) ? $profile->bio : '');
 263     $req->set_parameter('omb_listenee_location',
 264                         ($profile->location) ? $profile->location : '');
 265
 266     $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
 267     $req->set_parameter('omb_listenee_avatar',
 268                         ($avatar) ? $avatar->url : '');
 269
 270     $req->sign_request(omb_hmac_sha1(), $con, $token);
 271
 272     # We re-use this tool's fetcher, since it's pretty good
 273
 274     $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
 275
 276     common_debug('request URL = '.$req->get_normalized_http_url(), __FILE__);
 277     common_debug('postdata = '.$req->to_postdata(), __FILE__);
 278     $result = $fetcher->post($req->get_normalized_http_url(),
 279                              $req->to_postdata(),
 280                              array('User-Agent' => 'Laconica/' . LACONICA_VERSION));
 281
 282     common_debug('Got HTTP result "'.print_r($result,TRUE).'"', __FILE__);
 283
 284     if ($result->status == 403) { # not authorized, don't send again
 285         common_debug('403 result, deleting subscription', __FILE__);
 286         $subscription->delete();
 287         return false;
 288     } else if ($result->status != 200) {
 289         common_debug('Error status '.$result->status, __FILE__);
 290         return false;
 291     } else { # success!
 292         parse_str($result->body, $return);
 293         if ($return['omb_version'] == OMB_VERSION_01) {
 294             return true;
 295         } else {
 296             return false;
 297         }
 298     }
 299 }