Rename BaseApi->logErrorAndJsonExit to logAndJsonError to better match the functionality

[friendica.git] / src / Module / OAuth / Authorize.php

diff --git a/src/Module/OAuth/Authorize.php b/src/Module/OAuth/Authorize.php
index d5dc68932a000a4a0542efc5bd34f05b1998f6f1..31db02b01713958737ea2e2183699a23bf99ce30 100644 (file)
--- a/src/Module/OAuth/Authorize.php
+++ b/src/Module/OAuth/Authorize.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2010-2021, the Friendica project
+ * @copyright Copyright (C) 2010-2023, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -24,6 +24,7 @@ namespace Friendica\Module\OAuth;
 use Friendica\Core\Logger;
 use Friendica\DI;
 use Friendica\Module\BaseApi;
+use Friendica\Security\OAuth;
 
 /**
  * @see https://docs.joinmastodon.org/spec/oauth/
@@ -31,43 +32,45 @@ use Friendica\Module\BaseApi;
  */
 class Authorize extends BaseApi
 {
+       private static $oauth_code = '';
+
        /**
-        * @param array $parameters
         * @throws \Friendica\Network\HTTPException\InternalServerErrorException
         */
-       public static function rawContent(array $parameters = [])
+       protected function rawContent(array $request = [])
        {
-               $request = self::getRequest([
-                       'response_type' => '',
-                       'client_id'     => '',
+               $request = $this->getRequest([
+                       'force_login'   => '', // Forces the user to re-login, which is necessary for authorizing with multiple accounts from the same instance.
+                       'response_type' => '', // Should be set equal to "code".
+                       'client_id'     => '', // Client ID, obtained during app registration.
                        'client_secret' => '', // Isn't normally provided. We will use it if present.
-                       'redirect_uri'  => '',
-                       'scope'         => 'read',
+                       'redirect_uri'  => '', // Set a URI to redirect the user to. If this parameter is set to "urn:ietf:wg:oauth:2.0:oob" then the authorization code will be shown instead. Must match one of the redirect URIs declared during app registration.
+                       'scope'         => 'read', // List of requested OAuth scopes, separated by spaces (or by pluses, if using query parameters). Must be a subset of scopes declared during app registration. If not provided, defaults to "read".
                        'state'         => '',
-               ]);
+               ], $request);
 
                if ($request['response_type'] != 'code') {
                        Logger::warning('Unsupported or missing response type', ['request' => $_REQUEST]);
-                       DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Unsupported or missing response type'));
+                       $this->logAndJsonError(422, $this->errorFactory->UnprocessableEntity($this->t('Unsupported or missing response type')));
                }
 
                if (empty($request['client_id']) || empty($request['redirect_uri'])) {
                        Logger::warning('Incomplete request data', ['request' => $_REQUEST]);
-                       DI::mstdnError()->UnprocessableEntity(DI::l10n()->t('Incomplete request data'));
+                       $this->logAndJsonError(422, $this->errorFactory->UnprocessableEntity($this->t('Incomplete request data')));
                }
 
-               $application = self::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
+               $application = OAuth::getApplication($request['client_id'], $request['client_secret'], $request['redirect_uri']);
                if (empty($application)) {
-                       DI::mstdnError()->UnprocessableEntity();
+                       $this->logAndJsonError(422, $this->errorFactory->UnprocessableEntity());
                }
 
                // @todo Compare the application scope and requested scope
 
-               $request = $_REQUEST;
-               unset($request['pagename']);
-               $redirect = 'oauth/authorize?' . http_build_query($request);
+               $redirect_request = $_REQUEST;
+               unset($redirect_request['pagename']);
+               $redirect = 'oauth/authorize?' . http_build_query($redirect_request);
 
-               $uid = local_user();
+               $uid = DI::userSession()->getLocalUserId();
                if (empty($uid)) {
                        Logger::info('Redirect to login');
                        DI::app()->redirect('login?return_path=' . urlencode($redirect));
@@ -75,18 +78,31 @@ class Authorize extends BaseApi
                        Logger::info('Already logged in user', ['uid' => $uid]);
                }
 
-               if (!self::existsTokenForUser($application, $uid) && !DI::session()->get('oauth_acknowledge')) {
+               if (!OAuth::existsTokenForUser($application, $uid) && !DI::session()->get('oauth_acknowledge')) {
                        Logger::info('Redirect to acknowledge');
                        DI::app()->redirect('oauth/acknowledge?' . http_build_query(['return_path' => $redirect, 'application' => $application['name']]));
                }
 
                DI::session()->remove('oauth_acknowledge');
 
-               $token = self::createTokenForUser($application, $uid, $request['scope']);
+               $token = OAuth::createTokenForUser($application, $uid, $request['scope']);
                if (!$token) {
-                       DI::mstdnError()->UnprocessableEntity();
+                       $this->logAndJsonError(422, $this->errorFactory->UnprocessableEntity());
+               }
+
+               if ($application['redirect_uri'] != 'urn:ietf:wg:oauth:2.0:oob') {
+                       DI::app()->redirect($request['redirect_uri'] . (strpos($request['redirect_uri'], '?') ? '&' : '?') . http_build_query(['code' => $token['code'], 'state' => $request['state']]));
+               }
+
+               self::$oauth_code = $token['code'];
+       }
+
+       protected function content(array $request = []): string
+       {
+               if (empty(self::$oauth_code)) {
+                       return '';
                }
 
-               DI::app()->redirect($application['redirect_uri'] . (strpos($application['redirect_uri'], '?') ? '&' : '?') . http_build_query(['code' => $token['code'], 'state' => $request['state']]));
+               return DI::l10n()->t('Please copy the following authentication code into your application and close this window: %s', self::$oauth_code);
        }
 }