Add AtomPub, Twitter-compat. API documentation to doc-src/

[quix0rs-gnu-social.git] / actions / apioauthaccesstoken.php

diff --git a/actions/apioauthaccesstoken.php b/actions/apioauthaccesstoken.php
index 67359d765d6871a3c4f10c6c5d46f471716f4c71..a1a70a9b9e2be36aa949c163b1a142cca48863a9 100644 (file)
--- a/actions/apioauthaccesstoken.php
+++ b/actions/apioauthaccesstoken.php
@@ -2,7 +2,8 @@
 /**
  * StatusNet, the distributed open-source microblogging tool
  *
- * Exchange an authorized OAuth request token for an access token
+ * Action for getting OAuth token credentials (exchange an authorized
+ * request token for an access token)
  *
  * PHP version 5
  *
@@ -27,14 +28,11 @@
  * @link      http://status.net/
  */
 
-if (!defined('STATUSNET')) {
-    exit(1);
-}
-
-require_once INSTALLDIR . '/lib/apioauthstore.php';
+if (!defined('GNUSOCIAL')) { exit(1); }
 
 /**
- * Exchange an authorized OAuth request token for an access token
+ * Action for getting OAuth token credentials (exchange an authorized
+ * request token for an access token)
  *
  * @category API
  * @package  StatusNet
@@ -42,19 +40,10 @@ require_once INSTALLDIR . '/lib/apioauthstore.php';
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
-class ApiOauthAccessTokenAction extends Action
+class ApiOAuthAccessTokenAction extends ApiOAuthAction
 {
-
-    /**
-     * Is read only?
-     *
-     * @return boolean false
-     */
-    function isReadOnly()
-    {
-        return false;
-    }
+    protected $reqToken = null;
+    protected $verifier = null;
 
     /**
      * Class handler.
@@ -67,38 +56,67 @@ class ApiOauthAccessTokenAction extends Action
     {
         parent::handle($args);
 
-        $datastore   = new ApiStatusNetOAuthDataStore();
+        $datastore   = new ApiGNUsocialOAuthDataStore();
         $server      = new OAuthServer($datastore);
         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 
         $server->add_signature_method($hmac_method);
 
-       $atok = null;
+        $atok = $app = null;
+
+        // XXX: Insist that oauth_token and oauth_verifier be populated?
+        // Spec doesn't say they MUST be.
 
         try {
             $req  = OAuthRequest::from_request();
-            $atok = $server->fetch_access_token($req);
 
-        } catch (OAuthException $e) {
-            common_log(LOG_WARN, 'API OAuthException - ' . $e->getMessage());
-           common_debug(var_export($req, true));
-           $this->outputError($e->getMessage());
-           return;
+            $this->reqToken = $req->get_parameter('oauth_token');
+            $this->verifier = $req->get_parameter('oauth_verifier');
+
+            $app  = $datastore->getAppByRequestToken($this->reqToken);
+            $atok = $server->fetch_access_token($req);
+        } catch (Exception $e) {
+            common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
+            common_debug(var_export($req, true));
+            $code = $e->getCode();
+            $this->clientError($e->getMessage(), empty($code) ? 401 : $code, 'text');
         }
 
-       if (empty($atok)) {
-           common_debug('couldn\'t get access token.');
-           print "Token exchange failed. Has the request token been authorized?\n";
-       } else {
-           print $atok;
-       }
+        if (empty($atok)) {
+            // Token exchange failed -- log it
+
+            $msg = sprintf(
+                'API OAuth - Failure exchanging OAuth request token for access token, '
+                    . 'request token = %s, verifier = %s',
+                $this->reqToken,
+                $this->verifier
+            );
+
+            common_log(LOG_WARNING, $msg);
+            // TRANS: Client error given from the OAuth API when the request token or verifier is invalid.
+            $this->clientError(_('Invalid request token or verifier.'), 400, 'text');
+        } else {
+            common_log(
+                LOG_INFO,
+                sprintf(
+                    "Issued access token '%s' for application %d (%s).",
+                    $atok->key,
+                    $app->id,
+                    $app->name
+                )
+            );
+            $this->showAccessToken($atok);
+        }
     }
 
-    function outputError($msg)
+    /*
+     * Display OAuth token credentials
+     *
+     * @param OAuthToken token the access token
+     */
+    function showAccessToken($token)
     {
-       header('HTTP/1.1 401 Unauthorized');
-       header('Content-Type: text/html; charset=utf-8');
-       print $msg . "\n";
+        header('Content-Type: application/x-www-form-urlencoded');
+        print $token;
     }
 }
-