]> git.mxchange.org Git - quix0rs-gnu-social.git/blobdiff - lib/omb.php
Fix for cross site OMB posting problem
[quix0rs-gnu-social.git] / lib / omb.php
index 7dca760c6951da3c72e2e71132d7c6c133d12400..17132a594f6ec20ea2e079270d9a791895297f2a 100644 (file)
 
 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
 
-require_once('OAuth.php');
-require_once(INSTALLDIR.'/lib/oauthstore.php');
-
-require_once(INSTALLDIR.'/classes/Consumer.php');
-require_once(INSTALLDIR.'/classes/Nonce.php');
-require_once(INSTALLDIR.'/classes/Token.php');
-
-require_once('Auth/Yadis/Yadis.php');
-
-define('OAUTH_NAMESPACE', 'http://oauth.net/core/1.0/');
-define('OMB_NAMESPACE', 'http://openmicroblogging.org/protocol/0.1');
-define('OMB_VERSION_01', 'http://openmicroblogging.org/protocol/0.1');
-define('OAUTH_DISCOVERY', 'http://oauth.net/discovery/1.0');
-
-define('OMB_ENDPOINT_UPDATEPROFILE', OMB_NAMESPACE.'/updateProfile');
-define('OMB_ENDPOINT_POSTNOTICE', OMB_NAMESPACE.'/postNotice');
-define('OAUTH_ENDPOINT_REQUEST', OAUTH_NAMESPACE.'endpoint/request');
-define('OAUTH_ENDPOINT_AUTHORIZE', OAUTH_NAMESPACE.'endpoint/authorize');
-define('OAUTH_ENDPOINT_ACCESS', OAUTH_NAMESPACE.'endpoint/access');
-define('OAUTH_ENDPOINT_RESOURCE', OAUTH_NAMESPACE.'endpoint/resource');
-define('OAUTH_AUTH_HEADER', OAUTH_NAMESPACE.'parameters/auth-header');
-define('OAUTH_POST_BODY', OAUTH_NAMESPACE.'parameters/post-body');
-define('OAUTH_HMAC_SHA1', OAUTH_NAMESPACE.'signature/HMAC-SHA1');
+require_once INSTALLDIR.'/lib/oauthstore.php';
+require_once 'OAuth.php';
+require_once 'libomb/constants.php';
+require_once 'libomb/service_consumer.php';
+require_once 'libomb/notice.php';
+require_once 'libomb/profile.php';
+require_once 'Auth/Yadis/Yadis.php';
 
 function omb_oauth_consumer()
 {
-    static $con = null;
-    if (!$con) {
-        $con = new OAuthConsumer(common_root_url(), '');
-    }
-    return $con;
+    // Don't try to make this static. Leads to issues in
+    // multi-site setups - Z
+    return new OAuthConsumer(common_root_url(), '');
 }
 
 function omb_oauth_server()
 {
     static $server = null;
-    if (!$server) {
+    if (is_null($server)) {
         $server = new OAuthServer(omb_oauth_datastore());
         $server->add_signature_method(omb_hmac_sha1());
     }
@@ -65,7 +47,7 @@ function omb_oauth_server()
 function omb_oauth_datastore()
 {
     static $store = null;
-    if (!$store) {
+    if (is_null($store)) {
         $store = new StatusNetOAuthDataStore();
     }
     return $store;
@@ -74,57 +56,25 @@ function omb_oauth_datastore()
 function omb_hmac_sha1()
 {
     static $hmac_method = null;
-    if (!$hmac_method) {
+    if (is_null($hmac_method)) {
         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
     }
     return $hmac_method;
 }
 
-function omb_get_services($xrd, $type)
+function omb_broadcast_notice($notice)
 {
-    return $xrd->services(array(omb_service_filter($type)));
-}
-
-function omb_service_filter($type)
-{
-    return create_function('$s',
-                           'return omb_match_service($s, \''.$type.'\');');
-}
 
-function omb_match_service($service, $type)
-{
-    return in_array($type, $service->getTypes());
-}
-
-function omb_service_uri($service)
-{
-    if (!$service) {
-        return null;
-    }
-    $uris = $service->getURIs();
-    if (!$uris) {
-        return null;
-    }
-    return $uris[0];
-}
-
-function omb_local_id($service)
-{
-    if (!$service) {
-        return null;
+    try {
+        $omb_notice = notice_to_omb_notice($notice);
+    } catch (Exception $e) {
+        // @fixme we should clean up or highlight the problem item
+        common_log(LOG_ERR, 'Invalid OMB outgoing notice for notice ' . $notice->id);
+        common_log(LOG_ERR, 'Error status '.$e);
+        return true;
     }
-    $els = $service->getElements('xrd:LocalID');
-    if (!$els) {
-        return null;
-    }
-    $el = $els[0];
-    return $service->parser->content($el);
-}
-
-function omb_broadcast_remote_subscribers($notice)
-{
 
-    # First, get remote users subscribed to this profile
+    /* Get remote users subscribed to this profile. */
     $rp = new Remote_profile();
 
     $rp->query('SELECT postnoticeurl, token, secret ' .
@@ -135,170 +85,149 @@ function omb_broadcast_remote_subscribers($notice)
     $posted = array();
 
     while ($rp->fetch()) {
-        if (!array_key_exists($rp->postnoticeurl, $posted)) {
-            common_log(LOG_DEBUG, 'Posting to ' . $rp->postnoticeurl);
-            if (omb_post_notice_keys($notice, $rp->postnoticeurl, $rp->token, $rp->secret)) {
-                common_log(LOG_DEBUG, 'Finished to ' . $rp->postnoticeurl);
-                $posted[$rp->postnoticeurl] = true;
-            } else {
-                common_log(LOG_DEBUG, 'Failed posting to ' . $rp->postnoticeurl);
-            }
+        if (isset($posted[$rp->postnoticeurl])) {
+            /* We already posted to this url. */
+            continue;
         }
-    }
+        common_debug('Posting to ' . $rp->postnoticeurl, __FILE__);
+
+        /* Post notice. */
+        $service = new StatusNet_OMB_Service_Consumer(
+                     array(OMB_ENDPOINT_POSTNOTICE => $rp->postnoticeurl));
+        try {
+            $service->setToken($rp->token, $rp->secret);
+            $service->postNotice($omb_notice);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, 'Failed posting to ' . $rp->postnoticeurl);
+            common_log(LOG_ERR, 'Error status '.$e);
+            continue;
+        }
+        $posted[$rp->postnoticeurl] = true;
 
-    $rp->free();
-    unset($rp);
+        common_debug('Finished to ' . $rp->postnoticeurl, __FILE__);
+    }
 
     return true;
 }
 
-function omb_post_notice($notice, $remote_profile, $subscription)
-{
-    return omb_post_notice_keys($notice, $remote_profile->postnoticeurl, $subscription->token, $subscription->secret);
-}
-
-function omb_post_notice_keys($notice, $postnoticeurl, $tk, $secret)
+function omb_broadcast_profile($profile)
 {
-    $user = User::staticGet('id', $notice->profile_id);
+    $user = User::staticGet('id', $profile->id);
 
     if (!$user) {
         return false;
     }
 
-    $con = omb_oauth_consumer();
+    $profile = $user->getProfile();
 
-    $token = new OAuthToken($tk, $secret);
-
-    $url = $postnoticeurl;
-    $parsed = parse_url($url);
-    $params = array();
-    parse_str($parsed['query'], $params);
-
-    $req = OAuthRequest::from_consumer_and_token($con, $token,
-                                                 'POST', $url, $params);
-
-    $req->set_parameter('omb_version', OMB_VERSION_01);
-    $req->set_parameter('omb_listenee', $user->uri);
-    $req->set_parameter('omb_notice', $notice->uri);
-    $req->set_parameter('omb_notice_content', $notice->content);
-    $req->set_parameter('omb_notice_url', common_local_url('shownotice',
-                                                           array('notice' =>
-                                                                 $notice->id)));
-    $req->set_parameter('omb_notice_license', common_config('license', 'url'));
+    $omb_profile = profile_to_omb_profile($user->uri, $profile, true);
 
-    $user->free();
-    unset($user);
+    /* Get remote users subscribed to this profile. */
+    $rp = new Remote_profile();
 
-    $req->sign_request(omb_hmac_sha1(), $con, $token);
+    $rp->query('SELECT updateprofileurl, token, secret ' .
+               'FROM subscription JOIN remote_profile ' .
+               'ON subscription.subscriber = remote_profile.id ' .
+               'WHERE subscription.subscribed = ' . $profile->id . ' ');
 
-    # We re-use this tool's fetcher, since it's pretty good
+    $posted = array();
 
-    $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+    while ($rp->fetch()) {
+        if (isset($posted[$rp->updateprofileurl])) {
+            /* We already posted to this url. */
+            continue;
+        }
+        common_debug('Posting to ' . $rp->updateprofileurl, __FILE__);
+
+        /* Update profile. */
+        $service = new StatusNet_OMB_Service_Consumer(
+                     array(OMB_ENDPOINT_UPDATEPROFILE => $rp->updateprofileurl));
+        try {
+            $service->setToken($rp->token, $rp->secret);
+            $service->updateProfile($omb_profile);
+        } catch (Exception $e) {
+            common_log(LOG_ERR, 'Failed posting to ' . $rp->updateprofileurl);
+            common_log(LOG_ERR, 'Error status '.$e);
+            continue;
+        }
+        $posted[$rp->updateprofileurl] = true;
 
-    if (!$fetcher) {
-        common_log(LOG_WARNING, 'Failed to initialize Yadis fetcher.', __FILE__);
-        return false;
+        common_debug('Finished to ' . $rp->updateprofileurl, __FILE__);
     }
 
-    $result = $fetcher->post($req->get_normalized_http_url(),
-                             $req->to_postdata(),
-                             array('User-Agent: StatusNet/' . STATUSNET_VERSION));
-
-    if ($result->status == 403) { # not authorized, don't send again
-        common_debug('403 result, deleting subscription', __FILE__);
-        # FIXME: figure out how to delete this
-        # $subscription->delete();
-        return false;
-    } else if ($result->status != 200) {
-        common_debug('Error status '.$result->status, __FILE__);
-        return false;
-    } else { # success!
-        parse_str($result->body, $return);
-        if ($return['omb_version'] == OMB_VERSION_01) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+    return;
 }
 
-function omb_broadcast_profile($profile)
-{
-    # First, get remote users subscribed to this profile
-    # XXX: use a join here rather than looping through results
-    $sub = new Subscription();
-    $sub->subscribed = $profile->id;
-    if ($sub->find()) {
-        $updated = array();
-        while ($sub->fetch()) {
-            $rp = Remote_profile::staticGet('id', $sub->subscriber);
-            if ($rp) {
-                if (!array_key_exists($rp->updateprofileurl, $updated)) {
-                    if (omb_update_profile($profile, $rp, $sub)) {
-                        $updated[$rp->updateprofileurl] = true;
-                    }
-                }
-            }
-        }
+class StatusNet_OMB_Service_Consumer extends OMB_Service_Consumer {
+    public function __construct($urls)
+    {
+        $this->services       = $urls;
+        $this->datastore      = omb_oauth_datastore();
+        $this->oauth_consumer = omb_oauth_consumer();
+        $this->fetcher        = Auth_Yadis_Yadis::getHTTPFetcher();
+        $this->fetcher->timeout = intval(common_config('omb', 'timeout'));
     }
+
 }
 
-function omb_update_profile($profile, $remote_profile, $subscription)
+function profile_to_omb_profile($uri, $profile, $force = false)
 {
-    $user = User::staticGet($profile->id);
-    $con = omb_oauth_consumer();
-    $token = new OAuthToken($subscription->token, $subscription->secret);
-    $url = $remote_profile->updateprofileurl;
-    $parsed = parse_url($url);
-    $params = array();
-    parse_str($parsed['query'], $params);
-    $req = OAuthRequest::from_consumer_and_token($con, $token,
-                                                 "POST", $url, $params);
-    $req->set_parameter('omb_version', OMB_VERSION_01);
-    $req->set_parameter('omb_listenee', $user->uri);
-    $req->set_parameter('omb_listenee_profile', common_profile_url($profile->nickname));
-    $req->set_parameter('omb_listenee_nickname', $profile->nickname);
-
-    # We use blanks to force emptying any existing values in these optional fields
-
-    $req->set_parameter('omb_listenee_fullname',
-                        ($profile->fullname) ? $profile->fullname : '');
-    $req->set_parameter('omb_listenee_homepage',
-                        ($profile->homepage) ? $profile->homepage : '');
-    $req->set_parameter('omb_listenee_bio',
-                        ($profile->bio) ? $profile->bio : '');
-    $req->set_parameter('omb_listenee_location',
-                        ($profile->location) ? $profile->location : '');
+    $omb_profile = new OMB_Profile($uri);
+    $omb_profile->setNickname($profile->nickname);
+    $omb_profile->setLicenseURL(common_config('license', 'url'));
+    if (!is_null($profile->fullname)) {
+        $omb_profile->setFullname($profile->fullname);
+    } elseif ($force) {
+        $omb_profile->setFullname('');
+    }
+    if (!is_null($profile->homepage)) {
+        $omb_profile->setHomepage($profile->homepage);
+    } elseif ($force) {
+        $omb_profile->setHomepage('');
+    }
+    if (!is_null($profile->bio)) {
+        $omb_profile->setBio($profile->bio);
+    } elseif ($force) {
+        $omb_profile->setBio('');
+    }
+    if (!is_null($profile->location)) {
+        $omb_profile->setLocation($profile->location);
+    } elseif ($force) {
+        $omb_profile->setLocation('');
+    }
+    if (!is_null($profile->profileurl)) {
+        $omb_profile->setProfileURL($profile->profileurl);
+    } elseif ($force) {
+        $omb_profile->setProfileURL('');
+    }
 
     $avatar = $profile->getAvatar(AVATAR_PROFILE_SIZE);
-    $req->set_parameter('omb_listenee_avatar',
-                        ($avatar) ? $avatar->url : '');
+    if ($avatar) {
+        $omb_profile->setAvatarURL($avatar->url);
+    } elseif ($force) {
+        $omb_profile->setAvatarURL('');
+    }
+    return $omb_profile;
+}
 
-    $req->sign_request(omb_hmac_sha1(), $con, $token);
+function notice_to_omb_notice($notice)
+{
+    /* Create an OMB_Notice for $notice. */
+    $user = User::staticGet('id', $notice->profile_id);
 
-    # We re-use this tool's fetcher, since it's pretty good
+    if (!$user) {
+        return null;
+    }
 
-    $fetcher = Auth_Yadis_Yadis::getHTTPFetcher();
+    $profile = $user->getProfile();
 
-    $result = $fetcher->post($req->get_normalized_http_url(),
-                             $req->to_postdata(),
-                             array('User-Agent: StatusNet/' . STATUSNET_VERSION));
+    $omb_notice = new OMB_Notice(profile_to_omb_profile($user->uri, $profile),
+                                 $notice->uri,
+                                 $notice->content);
+    $omb_notice->setURL(common_local_url('shownotice', array('notice' =>
+                                                                 $notice->id)));
+    $omb_notice->setLicenseURL(common_config('license', 'url'));
 
-    if (empty($result) || !$result) {
-        common_debug("Unable to contact " . $req->get_normalized_http_url());
-    } else if ($result->status == 403) { # not authorized, don't send again
-        common_debug('403 result, deleting subscription', __FILE__);
-        $subscription->delete();
-        return false;
-    } else if ($result->status != 200) {
-        common_debug('Error status '.$result->status, __FILE__);
-        return false;
-    } else { # success!
-        parse_str($result->body, $return);
-        if (isset($return['omb_version']) && $return['omb_version'] === OMB_VERSION_01) {
-            return true;
-        } else {
-            return false;
-        }
-    }
+    return $omb_notice;
 }
+?>