diff --git a/README b/README index f5a0e27cc5..6a0633144b 100644 --- a/README +++ b/README @@ -226,7 +226,6 @@ and the URLs are listed here for your convenience. - Facebook library. Used for the Facebook application. - PEAR Validate is used for URL and email validation. - Console_GetOpt for parsing command-line options. -- libomb. a library for implementing OpenMicroBlogging 0.1, the predecessor to OStatus. - HTTP_Request2, a library for making HTTP requests. - PEAR Net_URL2 is an HTTP_Request2 dependency. @@ -484,7 +483,7 @@ On a default installation, your site can broadcast messages using XMPP. Users won't be able to post messages using XMPP unless you've got the XMPP daemon running. See 'Queues and daemons' below for how to set that up. Also, once you have a sizable number of users, sending -a lot of SMS, OMB, and XMPP messages whenever someone posts a message +a lot of SMS, OStatus, and XMPP messages whenever someone posts a message can really slow down your site; it may cause posting to timeout. NOTE: stream_select(), a crucial function for network programming, is @@ -1111,7 +1110,7 @@ public For configuring the public stream. localonly: If set to true, only messages posted by users of this - service (rather than other services, filtered through OMB) + service (rather than other services, filtered through OStatus) are shown in the public stream. Default true. blacklist: An array of IDs of users to hide from the public stream. Useful if you have someone making excessive Twitterfeed posts diff --git a/actions/addpeopletag.php b/actions/addpeopletag.php index 1e130e27e8..a661104d5c 100644 --- a/actions/addpeopletag.php +++ b/actions/addpeopletag.php @@ -111,18 +111,6 @@ class AddpeopletagAction extends Action return false; } - // OMB 0.1 doesn't have a mechanism for local-server- - // originated tag. - - $omb01 = Remote_profile::staticGet('id', $tagged_id); - - if (!empty($omb01)) { - // TRANS: Client error displayed when trying to add an OMB 0.1 remote profile to a list. - $this->clientError(_('You cannot list an OMB 0.1 '. - 'remote profile with this action.')); - return false; - } - return true; } diff --git a/actions/apioauthauthorize.php b/actions/apioauthauthorize.php index 3a83fd27fc..1755c36be3 100644 --- a/actions/apioauthauthorize.php +++ b/actions/apioauthauthorize.php @@ -22,7 +22,7 @@ * @category API * @package StatusNet * @author Zach Copley - * @copyright 2010 StatusNet, Inc. + * @copyright 2010-2011 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ @@ -35,7 +35,7 @@ require_once INSTALLDIR . '/lib/apioauth.php'; require_once INSTALLDIR . '/lib/info.php'; /** - * Authorize an Oputh request token + * Authorize an OAuth request token * * @category API * @package StatusNet diff --git a/actions/oauthconnectionssettings.php b/actions/oauthconnectionssettings.php index 5c66730931..80fac0d509 100644 --- a/actions/oauthconnectionssettings.php +++ b/actions/oauthconnectionssettings.php @@ -32,7 +32,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { } require_once INSTALLDIR . '/lib/applicationlist.php'; -require_once INSTALLDIR . '/lib/apioauthstore.php'; +require_once INSTALLDIR . '/lib/statusnetoauthstore.php'; /** * Show connected OAuth applications diff --git a/actions/removepeopletag.php b/actions/removepeopletag.php index 6943f35ed1..d27175f566 100644 --- a/actions/removepeopletag.php +++ b/actions/removepeopletag.php @@ -112,18 +112,6 @@ class RemovepeopletagAction extends Action return false; } - // OMB 0.1 doesn't have a mechanism for local-server- - // originated tag. - - $omb01 = Remote_profile::staticGet('id', $tagged_id); - - if (!empty($omb01)) { - // TRANS: Client error displayed when trying to (un)list an OMB 0.1 remote profile. - $this->clientError(_('You cannot (un)list an OMB 0.1 '. - 'remote profile with this action.')); - return false; - } - return true; } diff --git a/actions/shownotice.php b/actions/shownotice.php index 5501a0af42..6055184fcd 100644 --- a/actions/shownotice.php +++ b/actions/shownotice.php @@ -214,7 +214,7 @@ class ShownoticeAction extends Action if ($this->boolean('ajax')) { $this->showAjax(); } else { - if ($this->notice->is_local == Notice::REMOTE_OMB) { + if ($this->notice->is_local == Notice::REMOTE) { if (!empty($this->notice->url)) { $target = $this->notice->url; } else if (!empty($this->notice->uri) && preg_match('/^https?:/', $this->notice->uri)) { diff --git a/actions/subscribe.php b/actions/subscribe.php index b8c1cdd8f7..ce1d367cf8 100644 --- a/actions/subscribe.php +++ b/actions/subscribe.php @@ -1,7 +1,7 @@ clientError(_('You cannot subscribe to an OMB 0.1'. - ' remote profile with this action.')); - return false; - } - return true; } diff --git a/classes/Notice.php b/classes/Notice.php index 29824ab700..6eb4d9001e 100644 --- a/classes/Notice.php +++ b/classes/Notice.php @@ -1,7 +1,7 @@ uri; - } else { - // return OMB profile if any - $remote = Remote_profile::staticGet('id', $this->id); - if (!empty($remote)) { - $uri = $remote->uri; - } } + Event::handle('EndGetProfileUri', array($this, &$uri)); } @@ -1291,11 +1286,6 @@ class Profile extends Memcached_DataObject $user = User::staticGet('uri', $uri); if (!empty($user)) { $profile = $user->getProfile(); - } else { - $remote_profile = Remote_profile::staticGet('uri', $uri); - if (!empty($remote_profile)) { - $profile = Profile::staticGet('id', $remote_profile->profile_id); - } } Event::handle('EndGetProfileFromURI', array($uri, $profile)); } diff --git a/classes/Subscription.php b/classes/Subscription.php index 8af414b3a7..e83621eb86 100644 --- a/classes/Subscription.php +++ b/classes/Subscription.php @@ -198,29 +198,6 @@ class Subscription extends Memcached_DataObject assert(!empty($sub)); - // @todo: move this block to EndSubscribe handler for - // OMB plugin when it exists. - - if (!empty($sub->token)) { - - $token = new Token(); - - $token->tok = $sub->token; - - if ($token->find(true)) { - - $result = $token->delete(); - - if (!$result) { - common_log_db_error($token, 'DELETE', __FILE__); - // TRANS: Exception thrown when the OMB token for a subscription could not deleted on the server. - throw new Exception(_('Could not delete subscription OMB token.')); - } - } else { - common_log(LOG_ERR, "Couldn't find credentials with token {$token->tok}"); - } - } - $result = $sub->delete(); if (!$result) { diff --git a/lib/apioauth.php b/lib/apioauth.php index 54cecf92a8..a93811cc0f 100644 --- a/lib/apioauth.php +++ b/lib/apioauth.php @@ -31,7 +31,7 @@ if (!defined('STATUSNET')) { exit(1); } require_once INSTALLDIR . '/lib/apiaction.php'; -require_once INSTALLDIR . '/lib/apioauthstore.php'; +require_once INSTALLDIR . '/lib/statusnetoauthstore.php'; /** * Base action for API OAuth enpoints. Clean up the diff --git a/lib/microappplugin.php b/lib/microappplugin.php index 1dfb90036e..0ef2d50141 100644 --- a/lib/microappplugin.php +++ b/lib/microappplugin.php @@ -360,7 +360,7 @@ abstract class MicroAppPlugin extends Plugin $options = array('uri' => $object->id, 'url' => $object->link, - 'is_local' => Notice::REMOTE_OMB, + 'is_local' => Notice::REMOTE, 'source' => 'ostatus'); // $actor is an ostatus_profile @@ -418,7 +418,7 @@ abstract class MicroAppPlugin extends Plugin $options = array('uri' => $object->id, 'url' => $object->link, - 'is_local' => Notice::REMOTE_OMB, + 'is_local' => Notice::REMOTE, 'source' => 'ostatus'); // $actor is an ostatus_profile diff --git a/lib/profilelist.php b/lib/profilelist.php index 397ea19848..90e1c743a5 100644 --- a/lib/profilelist.php +++ b/lib/profilelist.php @@ -289,11 +289,10 @@ class ProfileListItem extends Widget $usf = new UnsubscribeForm($this->out, $this->profile); $usf->show(); } else { - // We can't initiate sub for a remote OMB profile. - $remote = Remote_profile::staticGet('id', $this->profile->id); - if (empty($remote)) { + if (Event::handle('StartShowProfileListSubscribeButton', array($this))) { $sf = new SubscribeForm($this->out, $this->profile); $sf->show(); + Event::handle('EndShowProfileListSubscribeButton', array($this)); } } $this->out->elementEnd('li'); diff --git a/lib/queuemanager.php b/lib/queuemanager.php index 1fa3417829..72eff6e463 100644 --- a/lib/queuemanager.php +++ b/lib/queuemanager.php @@ -233,7 +233,6 @@ abstract class QueueManager extends IoManager if (Event::handle('StartInitializeQueueManager', array($this))) { $this->connect('distrib', 'DistribQueueHandler'); - $this->connect('omb', 'OmbQueueHandler'); $this->connect('ping', 'PingQueueHandler'); if (common_config('sms', 'enabled')) { $this->connect('sms', 'SmsQueueHandler'); @@ -246,9 +245,6 @@ abstract class QueueManager extends IoManager $this->connect('acctmove', 'AccountMover'); $this->connect('actmove', 'ActivityMover'); - // Broadcasting profile updates to OMB remote subscribers - $this->connect('profile', 'ProfileQueueHandler'); - // For compat with old plugins not registering their own handlers. $this->connect('plugin', 'PluginQueueHandler'); } diff --git a/lib/router.php b/lib/router.php index dbf3aaeb97..536797dce1 100644 --- a/lib/router.php +++ b/lib/router.php @@ -113,8 +113,6 @@ class Router { var $m = null; static $inst = null; - static $bare = array('requesttoken', 'accesstoken', 'userauthorization', - 'postnotice', 'updateprofile', 'finishremotesubscribe'); const REGEX_TAG = '[^\/]+'; // [\pL\pN_\-\.]{1,64} better if we can do unicode regexes @@ -257,15 +255,6 @@ class Router $m->connect('main/'.$c.'/:code', array('action' => $c)); } - // exceptional - - $m->connect('main/remote', array('action' => 'remotesubscribe')); - $m->connect('main/remote?nickname=:nickname', array('action' => 'remotesubscribe'), array('nickname' => '[A-Za-z0-9_-]+')); - - foreach (Router::$bare as $action) { - $m->connect('index.php?action=' . $action, array('action' => $action)); - } - // settings foreach (array('profile', 'avatar', 'password', 'im', 'oauthconnections', @@ -896,8 +885,8 @@ class Router $nickname = User::singleUserNickname(); foreach (array('subscriptions', 'subscribers', - 'all', 'foaf', 'xrds', - 'replies', 'microsummary', 'hcard') as $a) { + 'all', 'foaf', 'replies', + 'microsummary', 'hcard') as $a) { $m->connect($a, array('action' => $a, 'nickname' => $nickname)); @@ -964,8 +953,8 @@ class Router $m->connect('rsd.xml', array('action' => 'rsd')); foreach (array('subscriptions', 'subscribers', - 'nudge', 'all', 'foaf', 'xrds', - 'replies', 'inbox', 'outbox', 'microsummary', 'hcard') as $a) { + 'nudge', 'all', 'foaf', 'replies', + 'inbox', 'outbox', 'microsummary', 'hcard') as $a) { $m->connect(':nickname/'.$a, array('action' => $a), array('nickname' => Nickname::DISPLAY_FMT)); diff --git a/lib/apioauthstore.php b/lib/statusnetoauthstore.php similarity index 84% rename from lib/apioauthstore.php rename to lib/statusnetoauthstore.php index ac53ec210c..341e32d857 100644 --- a/lib/apioauthstore.php +++ b/lib/statusnetoauthstore.php @@ -1,7 +1,7 @@ tok, $t->secret); } } + + /** + * Authorize specified OAuth token + * + * Authorizes the authorization token specified by $token_key. + * Throws exceptions in case of error. + * + * @param string $token_key The token to be authorized + * + * @access public + **/ + public function authorize_token($token_key) { + $rt = new Token(); + $rt->tok = $token_key; + $rt->type = 0; + $rt->state = 0; + if (!$rt->find(true)) { + throw new Exception('Tried to authorize unknown token'); + } + $orig_rt = clone($rt); + $rt->state = 1; # Authorized but not used + if (!$rt->update($orig_rt)) { + throw new Exception('Failed to authorize token'); + } + } + + /** + * + * http://oauth.net/core/1.0/#nonce + * "The Consumer SHALL then generate a Nonce value that is unique for + * all requests with that timestamp." + * XXX: It's not clear why the token is here + * + * @param type $consumer + * @param type $token + * @param type $nonce + * @param type $timestamp + * @return type + */ + function lookup_nonce($consumer, $token, $nonce, $timestamp) + { + $n = new Nonce(); + $n->consumer_key = $consumer->key; + $n->ts = common_sql_date($timestamp); + $n->nonce = $nonce; + if ($n->find(true)) { + return true; + } else { + $n->created = DB_DataObject_Cast::dateTime(); + $n->insert(); + return false; + } + } + + /** + * + * @param type $consumer + * @param type $token_type + * @param type $token_key + * @return OAuthToken + */ + function lookup_token($consumer, $token_type, $token_key) + { + $t = new Token(); + if (!is_null($consumer)) { + $t->consumer_key = $consumer->key; + } + $t->tok = $token_key; + $t->type = ($token_type == 'access') ? 1 : 0; + if ($t->find(true)) { + return new OAuthToken($t->tok, $t->secret); + } else { + return null; + } + } + + /** + * + * @param type $token_key + * @return Token + */ + function getTokenByKey($token_key) + { + $t = new Token(); + $t->tok = $token_key; + if ($t->find(true)) { + return $t; + } else { + return null; + } + } } diff --git a/lib/util.php b/lib/util.php index 3535cfb08a..d358338519 100644 --- a/lib/util.php +++ b/lib/util.php @@ -1,7 +1,7 @@ id); - if ($user) { - return $user->uri; + $uri = null; + + if (!empty($profile)) { + if (Event::handle('StartCommonProfileURI', array($profile, &$uri))) { + $user = User::staticGet($profile->id); + if (!empty($user)) { + $uri = $user->uri; + } + Event::handle('EndCommonProfileURI', array($profile, &$uri)); + } } - $remote = Remote_profile::staticGet($profile->id); - if ($remote) { - return $remote->uri; - } // XXX: this is a very bad profile! - return null; + return $uri; } function common_canonical_sms($sms) diff --git a/plugins/Bookmark/BookmarkPlugin.php b/plugins/Bookmark/BookmarkPlugin.php index f8db77e2b7..e383f80560 100644 --- a/plugins/Bookmark/BookmarkPlugin.php +++ b/plugins/Bookmark/BookmarkPlugin.php @@ -322,7 +322,7 @@ class BookmarkPlugin extends MicroAppPlugin $options = array('uri' => $bookmark->id, 'url' => $bookmark->link, - 'is_local' => Notice::REMOTE_OMB, + 'is_local' => Notice::REMOTE, 'source' => 'ostatus'); return self::_postBookmark($author->localProfile(), $activity, $options); diff --git a/plugins/OMB/OMBPlugin.php b/plugins/OMB/OMBPlugin.php new file mode 100644 index 0000000000..f5fed60079 --- /dev/null +++ b/plugins/OMB/OMBPlugin.php @@ -0,0 +1,393 @@ +. + * + * @category Sample + * @package StatusNet + * @author Zach Copley + * @copyright 2011 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ + +set_include_path(get_include_path() . PATH_SEPARATOR . dirname(__FILE__) . '/extlib/'); + +if (!defined('STATUSNET')) { + // This check helps protect against security problems; + // your code file can't be executed directly from the web. + exit(1); +} + +/** + * OMB plugin main class + * + * @category Integration + * @package StatusNet + * @author Zach Copley + * @copyright 2011 StatusNet, Inc. + * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPL 3.0 + * @link http://status.net/ + */ +class OMBPlugin extends Plugin +{ + /** + * Load related modules when needed + * + * @param string $cls Name of the class to be loaded + * + * @return boolean hook value; true means continue processing, false means stop. + */ + function onAutoload($cls) + { + $dir = dirname(__FILE__); + + switch ($cls) + { + case 'Requesttokenaction': + case 'Accesstokenaction': + case 'Userauthorizationaction': + case 'Postnoticeaction': + case 'Updateprofileaction': + case 'Finishremotesubscribeaction': + case 'Remotesubscribeaction': + case 'XrdsAction': + include_once $dir . '/action/' . strtolower(mb_substr($cls, 0, -6)) . '.php'; + return false; + break; + case 'OmbQueueHandler': + case 'ProfileQueueHandler': + include_once $dir . '/lib/' . strtolower($cls) . '.php'; + return false; + case 'OMBOAuthDataStore': + include_once $dir . '/lib/omboauthstore.php'; + default: + return true; + } + } + + /** + * Map URLs to actions + * + * @param Net_URL_Mapper $m path-to-action mapper + * + * @return boolean hook value; true means continue processing, false means stop. + */ + function onRouterInitialized($m) + { + $bare = array( + 'requesttoken', + 'accesstoken', + 'userauthorization', + 'postnotice', + 'updateprofile', + 'finishremotesubscribe' + ); + + foreach ($bare as $action) { + $m->connect( + 'index.php?action=' . $action, array('action' => $action) + ); + } + + // exceptional + + $m->connect('main/remote', array('action' => 'remotesubscribe')); + $m->connect( + 'main/remote?nickname=:nickname', + array('action' => 'remotesubscribe'), + array('nickname' => '[A-Za-z0-9_-]+') + ); + + $m->connect( + 'xrds', + array('action' => 'xrds', 'nickname' => $nickname) + ); + + return true; + } + + /** + * Put saved notices into the queue for OMB distribution + * + * @param Notice $notice the notice to broadcast + * @param array $transports queuehandler's list of transports + * @return boolean true if queing was successful + */ + function onStartEnqueueNotice($notice, &$transports) + { + if ($notice->isLocal()) { + if ($notice->inScope(null)) { + array_unshift($transports, 'omb'); + common_log( + LOG_INFO, "Notice {$notice->id} queued for OMB processing" + ); + } else { + // Note: We don't do privacy-controlled OMB updates. + common_log( + LOG_NOTICE, + "Not queueing notice {$notice->id} for OMB because of " + . "privacy; scope = {$notice->scope}", + __FILE__ + ); + } + } else { + common_log( + LOG_NOTICE, + "Not queueing notice {$notice->id} for OMB because it's not " + . "local.", + __FILE__ + ); + } + + return true; + } + + /** + * Set up queue handlers for outgoing OMB pushes + * + * @param QueueManager $qm + * @return boolean hook return + */ + function onEndInitializeQueueManager(QueueManager $qm) + { + // Prepare outgoing distributions after notice save. + $qm->connect('omb', 'OmbQueueHandler'); + $qm->connect('profile', 'ProfileQueueHandler'); + + return true; + } + + /** + * Return OMB remote profile, if any + * + * @param Profile $profile + * @param string $uri + * @return boolen false if there's a remote profile + */ + function onStartGetProfileUri($profile, &$uri) + { + $remote = Remote_profile::staticGet('id', $this->id); + if (!empty($remote)) { + $uri = $remote->uri; + return false; + } + return true; + } + + /** + * We can't initiate subscriptions for a remote OMB profile; don't show + * subscribe button + * + * @param type $action + */ + function onStartShowProfileListSubscribeButton($action) + { + $remote = Remote_profile::staticGet('id', $action->profile->id); + if (empty($remote)) { + false; + } + return true; + } + + /** + * Check for illegal subscription attempts + * + * @param User $user subscriber + * @param Profile $other subscribee + * @return hook return value + */ + function onStartSubscribe($profile, $other) + { + // OMB 0.1 doesn't have a mechanism for local-server- + // originated subscription. + + $omb01 = Remote_profile::staticGet('id', $other_id); + + if (!empty($omb01)) { + // TRANS: Client error displayed trying to subscribe to an OMB 0.1 remote profile. + throw new ClientException( + _m( + 'You cannot subscribe to an OMB 0.1 ' + . 'remote profile with this action.' + ) + ); + return false; + } + + } + + /** + * Throw an error if someone tries to tag a remote profile + * + * @param Profile $tagger_profile profile of the tagger + * @param Profile $tagged_profile profile of the taggee + * @param string $tag + * + * @return true + */ + function onStartTagProfile($tagger_profile, $tagged_profile, $tag) + { + // OMB 0.1 doesn't have a mechanism for local-server- + // originated tag. + + $omb01 = Remote_profile::staticGet('id', $tagged_profile->id); + + if (!empty($omb01)) { + // TRANS: Client error displayed when trying to add an OMB 0.1 remote profile to a list. + $this->clientError( + _m( + 'You cannot list an OMB 0.1 ' + .'remote profile with this action.') + ); + } + return false; + } + + /** + * Check to make sure we're not tryng to untag an OMB profile + * + * // XXX: Should this ever happen? + * + * @param Profile_tag $ptag the profile tag + */ + function onUntagProfile($ptag) + { + // OMB 0.1 doesn't have a mechanism for local-server- + // originated tag. + + $omb01 = Remote_profile::staticGet('id', $ptag->tagged); + + if (!empty($omb01)) { + // TRANS: Client error displayed when trying to (un)list an OMB 0.1 remote profile. + $this->clientError( + _m( + 'You cannot (un)list an OMB 0.1 ' + . 'remote profile with this action.') + ); + return false; + } + } + + /** + * Remove old OMB subscription tokens + * + * @param User $user subscriber + * @param Profile $other subscribee + * @return hook return value + */ + function onEndUnsubscribe($profile, $other) + { + $sub = Subscription::pkeyGet( + array('subscriber' => $subscriber->id, 'subscribed' => $other->id) + ); + + if (!empty($sub->token)) { + + $token = new Token(); + + $token->tok = $sub->token; + + if ($token->find(true)) { + + $result = $token->delete(); + + if (!$result) { + common_log_db_error($token, 'DELETE', __FILE__); + // TRANS: Exception thrown when the OMB token for a subscription could not deleted on the server. + throw new Exception( + _m('Could not delete subscription OMB token.') + ); + } + } else { + common_log( + LOG_ERR, + "Couldn't find credentials with token {$token->tok}", + __FILE__ + ); + } + } + + return true; + } + + /** + * Search for an OMB remote profile by URI + * + * @param string $uri remote profile URI + * @param Profile $profile the profile to set + * @return boolean hook value + */ + function onStartGetProfileFromURI($uri, &$profile) + { + $remote_profile = Remote_profile::staticGet('uri', $uri); + if (!empty($remote_profile)) { + $profile = Profile::staticGet('id', $remote_profile->profile_id); + return false; + } + + return true; + } + + /** + * Return OMB remote profiles as well as regular profiles + * in helper + * + * @param type $profile + * @param type $uri + */ + function onStartCommonProfileURI($profile, &$uri) + { + $remote = Remote_profile::staticGet($profile->id); + if ($remote) { + $uri = $remote->uri; + return false; + } + return true; + } + + /** + * Plugin version info + * + * @param array $versions + * @return boolean hook value + */ + function onPluginVersion(&$versions) + { + $versions[] = array( + 'name' => 'OpenMicroBlogging', + 'version' => STATUSNET_VERSION, + 'author' => 'Zach Copley', + 'homepage' => 'http://status.net/wiki/Plugin:Sample', + 'rawdescription' => + // TRANS: Plugin description. + _m('A sample plugin to show basics of development for new hackers.') + ); + + return true; + } +} + diff --git a/plugins/OMB/README b/plugins/OMB/README new file mode 100644 index 0000000000..839eb4e33a --- /dev/null +++ b/plugins/OMB/README @@ -0,0 +1,31 @@ +OMB (OpenMicroBlogging) plugin +============================== + +This plugin encapsulates OpenMicroBlogging 0.1 functionality. OMB was the +original federation protocol for StatusNet, but has been deprecated +in favor of OStatus (see the OStatus plugin). This plugin is provided for +backward-compatibility with older sites, and for posterity. + +External libraries +------------------ + +This is provided with the plugin, but you may wish to use a newer version of +the library, if and when it becomes available. + +- libomb. a library for implementing OpenMicroBlogging 0.1 + http://gitorious.org/libomb + + +Installation +------------ + +[TODO] + +Offline Processing +------------------ + +Note: once you have a sizable number of users, sending OMB messages whenever +someone posts a message can really slow down your site; it may cause posting +to timeout. You may wish to enable queuing and handle OMB communication +offline. See the "queues and daemons" section of the main StatusNet README. + diff --git a/actions/accesstoken.php b/plugins/OMB/actions/accesstoken.php similarity index 91% rename from actions/accesstoken.php rename to plugins/OMB/actions/accesstoken.php index bfb771b0b3..cd7a2f4588 100644 --- a/actions/accesstoken.php +++ b/plugins/OMB/actions/accesstoken.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -32,8 +32,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; -require_once INSTALLDIR.'/lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; /** * Access token class diff --git a/actions/finishremotesubscribe.php b/plugins/OMB/actions/finishremotesubscribe.php similarity index 97% rename from actions/finishremotesubscribe.php rename to plugins/OMB/actions/finishremotesubscribe.php index 59725af27f..fb98dbda6d 100644 --- a/actions/finishremotesubscribe.php +++ b/plugins/OMB/actions/finishremotesubscribe.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -30,8 +30,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/extlib/libomb/service_consumer.php'; -require_once INSTALLDIR.'/lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_consumer.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; /** * Handler for remote subscription finish callback diff --git a/actions/postnotice.php b/plugins/OMB/actions/postnotice.php similarity index 95% rename from actions/postnotice.php rename to plugins/OMB/actions/postnotice.php index 43c764aa63..c2128f7172 100644 --- a/actions/postnotice.php +++ b/plugins/OMB/actions/postnotice.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -30,8 +30,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; /** * Handler for postnotice action diff --git a/actions/remotesubscribe.php b/plugins/OMB/actions/remotesubscribe.php similarity index 97% rename from actions/remotesubscribe.php rename to plugins/OMB/actions/remotesubscribe.php index 16945122f4..aafbaf5216 100644 --- a/actions/remotesubscribe.php +++ b/plugins/OMB/actions/remotesubscribe.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011 StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -30,9 +30,9 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_consumer.php'; -require_once INSTALLDIR.'/extlib/libomb/profile.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_consumer.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/profile.php'; /** * Handler for remote subscription diff --git a/actions/requesttoken.php b/plugins/OMB/actions/requesttoken.php similarity index 92% rename from actions/requesttoken.php rename to plugins/OMB/actions/requesttoken.php index 3c8cea03c0..57e8118456 100644 --- a/actions/requesttoken.php +++ b/plugins/OMB/actions/requesttoken.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -32,8 +32,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; /** * Request token action class. diff --git a/actions/updateprofile.php b/plugins/OMB/actions/updateprofile.php similarity index 94% rename from actions/updateprofile.php rename to plugins/OMB/actions/updateprofile.php index e5c0803495..29d334b302 100644 --- a/actions/updateprofile.php +++ b/plugins/OMB/actions/updateprofile.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -30,8 +30,8 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; /** * Handle an updateprofile action diff --git a/actions/userauthorization.php b/plugins/OMB/actions/userauthorization.php similarity index 98% rename from actions/userauthorization.php rename to plugins/OMB/actions/userauthorization.php index 0cb55715f9..642a8dc326 100644 --- a/actions/userauthorization.php +++ b/plugins/OMB/actions/userauthorization.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -30,9 +30,9 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; -require_once INSTALLDIR.'/extlib/libomb/profile.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/profile.php'; define('TIMESTAMP_THRESHOLD', 300); // @todo FIXME: Missing documentation. diff --git a/actions/xrds.php b/plugins/OMB/actions/xrds.php similarity index 94% rename from actions/xrds.php rename to plugins/OMB/actions/xrds.php index 818cd1032c..5e6758eded 100644 --- a/actions/xrds.php +++ b/plugins/OMB/actions/xrds.php @@ -12,7 +12,7 @@ * @link http://status.net/ * * StatusNet - the distributed open-source microblogging tool - * Copyright (C) 2008, 2009, StatusNet, Inc. + * Copyright (C) 2008-2011, StatusNet, Inc. * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published by @@ -32,10 +32,10 @@ if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); } -require_once INSTALLDIR.'/lib/omb.php'; -require_once INSTALLDIR.'/extlib/libomb/service_provider.php'; -require_once INSTALLDIR.'/extlib/libomb/xrds_mapper.php'; -require_once INSTALLDIR.'/lib/xrdsoutputter.php'; +require_once dirname(__FILE__) . '/../lib/omb.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/service_provider.php'; +require_once dirname(__FILE__) . '/../extlib/libomb/xrds_mapper.php'; +require_once dirname(__FILE__) . '/../lib/xrdsoutputter.php'; /** * XRDS for OpenMicroBlogging diff --git a/extlib/libomb/base_url_xrds_mapper.php b/plugins/OMB/extlib/libomb/base_url_xrds_mapper.php similarity index 100% rename from extlib/libomb/base_url_xrds_mapper.php rename to plugins/OMB/extlib/libomb/base_url_xrds_mapper.php diff --git a/extlib/libomb/constants.php b/plugins/OMB/extlib/libomb/constants.php similarity index 100% rename from extlib/libomb/constants.php rename to plugins/OMB/extlib/libomb/constants.php diff --git a/extlib/libomb/datastore.php b/plugins/OMB/extlib/libomb/datastore.php similarity index 100% rename from extlib/libomb/datastore.php rename to plugins/OMB/extlib/libomb/datastore.php diff --git a/extlib/libomb/helper.php b/plugins/OMB/extlib/libomb/helper.php similarity index 100% rename from extlib/libomb/helper.php rename to plugins/OMB/extlib/libomb/helper.php diff --git a/extlib/libomb/invalidparameterexception.php b/plugins/OMB/extlib/libomb/invalidparameterexception.php similarity index 100% rename from extlib/libomb/invalidparameterexception.php rename to plugins/OMB/extlib/libomb/invalidparameterexception.php diff --git a/extlib/libomb/invalidyadisexception.php b/plugins/OMB/extlib/libomb/invalidyadisexception.php similarity index 100% rename from extlib/libomb/invalidyadisexception.php rename to plugins/OMB/extlib/libomb/invalidyadisexception.php diff --git a/extlib/libomb/notice.php b/plugins/OMB/extlib/libomb/notice.php similarity index 100% rename from extlib/libomb/notice.php rename to plugins/OMB/extlib/libomb/notice.php diff --git a/extlib/libomb/omb_yadis_xrds.php b/plugins/OMB/extlib/libomb/omb_yadis_xrds.php similarity index 100% rename from extlib/libomb/omb_yadis_xrds.php rename to plugins/OMB/extlib/libomb/omb_yadis_xrds.php diff --git a/extlib/libomb/plain_xrds_writer.php b/plugins/OMB/extlib/libomb/plain_xrds_writer.php similarity index 100% rename from extlib/libomb/plain_xrds_writer.php rename to plugins/OMB/extlib/libomb/plain_xrds_writer.php diff --git a/extlib/libomb/profile.php b/plugins/OMB/extlib/libomb/profile.php similarity index 100% rename from extlib/libomb/profile.php rename to plugins/OMB/extlib/libomb/profile.php diff --git a/extlib/libomb/remoteserviceexception.php b/plugins/OMB/extlib/libomb/remoteserviceexception.php similarity index 100% rename from extlib/libomb/remoteserviceexception.php rename to plugins/OMB/extlib/libomb/remoteserviceexception.php diff --git a/extlib/libomb/service_consumer.php b/plugins/OMB/extlib/libomb/service_consumer.php similarity index 100% rename from extlib/libomb/service_consumer.php rename to plugins/OMB/extlib/libomb/service_consumer.php diff --git a/extlib/libomb/service_provider.php b/plugins/OMB/extlib/libomb/service_provider.php similarity index 100% rename from extlib/libomb/service_provider.php rename to plugins/OMB/extlib/libomb/service_provider.php diff --git a/extlib/libomb/unsupportedserviceexception.php b/plugins/OMB/extlib/libomb/unsupportedserviceexception.php similarity index 100% rename from extlib/libomb/unsupportedserviceexception.php rename to plugins/OMB/extlib/libomb/unsupportedserviceexception.php diff --git a/extlib/libomb/xrds_mapper.php b/plugins/OMB/extlib/libomb/xrds_mapper.php similarity index 100% rename from extlib/libomb/xrds_mapper.php rename to plugins/OMB/extlib/libomb/xrds_mapper.php diff --git a/extlib/libomb/xrds_writer.php b/plugins/OMB/extlib/libomb/xrds_writer.php similarity index 100% rename from extlib/libomb/xrds_writer.php rename to plugins/OMB/extlib/libomb/xrds_writer.php diff --git a/lib/omb.php b/plugins/OMB/lib/omb.php similarity index 94% rename from lib/omb.php rename to plugins/OMB/lib/omb.php index db60fa0ef2..0804b65c36 100644 --- a/lib/omb.php +++ b/plugins/OMB/lib/omb.php @@ -1,7 +1,7 @@ + diff --git a/lib/oauthstore.php b/plugins/OMB/lib/omboauthstore.php similarity index 97% rename from lib/oauthstore.php rename to plugins/OMB/lib/omboauthstore.php index 570343b82d..c29eeb7696 100644 --- a/lib/oauthstore.php +++ b/plugins/OMB/lib/omboauthstore.php @@ -1,7 +1,7 @@ tok = $token_key; - if ($t->find(true)) { - return $t; - } else { - return null; - } - } - // http://oauth.net/core/1.0/#nonce // "The Consumer SHALL then generate a Nonce value that is unique for // all requests with that timestamp." @@ -234,7 +223,7 @@ class StatusNetOAuthDataStore extends OAuthDataStore $profile = Profile::staticGet('id', $remote->id); if (!$profile) throw new Exception('No profile for remote user'); - require_once INSTALLDIR.'/lib/omb.php'; + require_once dirname(__FILE__) . '/omb.php'; return profile_to_omb_profile($identifier_uri, $profile); } @@ -376,7 +365,7 @@ class StatusNetOAuthDataStore extends OAuthDataStore $notice = Notice::saveNew($author->id, $omb_notice->getContent(), 'omb', - array('is_local' => Notice::REMOTE_OMB, + array('is_local' => Notice::REMOTE, 'uri' => $omb_notice->getIdentifierURI())); } diff --git a/lib/ombqueuehandler.php b/plugins/OMB/lib/ombqueuehandler.php similarity index 93% rename from lib/ombqueuehandler.php rename to plugins/OMB/lib/ombqueuehandler.php index 1921c2bacd..bc70edb095 100644 --- a/lib/ombqueuehandler.php +++ b/plugins/OMB/lib/ombqueuehandler.php @@ -1,7 +1,7 @@ id); return true; } else { - require_once(INSTALLDIR.'/lib/omb.php'); + require_once(dirname(__FILE__) . '/omb.php'); omb_broadcast_notice($notice); return true; } diff --git a/lib/profilequeuehandler.php b/plugins/OMB/lib/profilequeuehandler.php similarity index 93% rename from lib/profilequeuehandler.php rename to plugins/OMB/lib/profilequeuehandler.php index 6ce93229b2..5c67b0bfbe 100644 --- a/lib/profilequeuehandler.php +++ b/plugins/OMB/lib/profilequeuehandler.php @@ -1,7 +1,7 @@ Notice::REMOTE_OMB, + $options = array('is_local' => Notice::REMOTE, 'url' => $sourceUrl, 'uri' => $sourceUri, 'rendered' => $rendered,