"yii\authclient\AuthAction" created.

extensions/yii/authclient/AuthAction.php

@@ -0,0 +1,317 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\authclient;
+
+use yii\base\Action;
+use yii\base\Exception;
+use yii\base\NotSupportedException;
+use yii\web\HttpException;
+use yii\web\NotFoundHttpException;
+use Yii;
+
+/**
+ * Class AuthAction
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.0
+ */
+class AuthAction extends Action
+{
+	/**
+	 * @var string name of the auth provider collection application component.
+	 * This component will be used to fetch {@link services} value if it is not set.
+	 */
+	public $providerCollection;
+	/**
+	 * @var string name of the GET param , which should be used to passed auth provider id to URL
+	 * defined by {@link baseAuthUrl}.
+	 */
+	public $providerIdGetParamName = 'provider';
+	/**
+	 * @var callable PHP callback, which should be triggered in case of successful authentication.
+	 */
+	public $successCallback;
+	/**
+	 * @var string the redirect url after successful authorization.
+	 */
+	private $_successUrl = '';
+	/**
+	 * @var string the redirect url after unsuccessful authorization (e.g. user canceled).
+	 */
+	private $_cancelUrl = '';
+
+	/**
+	 * @param string $url successful URL.
+	 */
+	public function setSuccessUrl($url)
+	{
+		$this->_successUrl = $url;
+	}
+
+	/**
+	 * @return string successful URL.
+	 */
+	public function getSuccessUrl()
+	{
+		if (empty($this->_successUrl)) {
+			$this->_successUrl = $this->defaultSuccessUrl();
+		}
+		return $this->_successUrl;
+	}
+
+	/**
+	 * @param string $url cancel URL.
+	 */
+	public function setCancelUrl($url)
+	{
+		$this->_cancelUrl = $url;
+	}
+
+	/**
+	 * @return string cancel URL.
+	 */
+	public function getCancelUrl()
+	{
+		if (empty($this->_cancelUrl)) {
+			$this->_cancelUrl = $this->defaultCancelUrl();
+		}
+		return $this->_cancelUrl;
+	}
+
+	/**
+	 * Creates default {@link successUrl} value.
+	 * @return string success URL value.
+	 */
+	protected function defaultSuccessUrl()
+	{
+		return Yii::$app->getUser()->getReturnUrl();
+	}
+
+	/**
+	 * Creates default {@link cancelUrl} value.
+	 * @return string cancel URL value.
+	 */
+	protected function defaultCancelUrl()
+	{
+		return Yii::$app->getRequest()->getAbsoluteUrl();
+	}
+
+	/**
+	 * Runs the action.
+	 */
+	public function run()
+	{
+		if (!empty($_GET[$this->providerIdGetParamName])) {
+			$providerId = $_GET[$this->providerIdGetParamName];
+			/** @var \yii\authclient\provider\Collection $providerCollection */
+			$providerCollection = Yii::$app->getComponent($this->providerCollection);
+			if (!$providerCollection->hasProvider($providerId)) {
+				throw new NotFoundHttpException("Unknown auth provider '{$providerId}'");
+			}
+			$provider = $providerCollection->getProvider($providerId);
+			return $this->authenticate($provider);
+		} else {
+			throw new NotFoundHttpException();
+		}
+	}
+
+	/**
+	 * @param mixed $provider
+	 * @throws \yii\base\NotSupportedException
+	 */
+	protected function authenticate($provider)
+	{
+		if ($provider instanceof OpenId) {
+			return $this->authenticateOpenId($provider);
+		} elseif ($provider instanceof OAuth2) {
+			return $this->authenticateOAuth2($provider);
+		} elseif ($provider instanceof OAuth1) {
+			return $this->authenticateOAuth1($provider);
+		} else {
+			throw new NotSupportedException('Provider "' . get_class($provider) . '" is not supported.');
+		}
+	}
+
+	/**
+	 * @param mixed $provider
+	 * @return \yii\web\Response
+	 */
+	protected function authenticateSuccess($provider)
+	{
+		call_user_func($this->successCallback, $provider);
+		return $this->redirectSuccess();
+	}
+
+	/**
+	 * Redirect to the given URL or simply close the popup window.
+	 * @param mixed $url URL to redirect, could be a string or array config to generate a valid URL.
+	 * @param boolean $enforceRedirect indicates if redirect should be performed even in case of popup window.
+	 * @return \yii\web\Response response instance.
+	 */
+	public function redirect($url, $enforceRedirect = true)
+	{
+		$viewData = [
+			'url' => $url,
+			'enforceRedirect' => $enforceRedirect,
+		];
+		$viewFile = __DIR__ . DIRECTORY_SEPARATOR . 'provider' . DIRECTORY_SEPARATOR . 'views' . DIRECTORY_SEPARATOR . 'redirect.php';
+
+		$response = Yii::$app->getResponse();
+		$response->content = Yii::$app->getView()->renderFile($viewFile, $viewData);
+		return $response;
+	}
+
+	/**
+	 * Redirect to the URL. If URL is null, {@link successUrl} will be used.
+	 * @param string $url URL to redirect.
+	 * @return \yii\web\Response response instance.
+	 */
+	public function redirectSuccess($url = null)
+	{
+		if ($url === null) {
+			$url = $this->getSuccessUrl();
+		}
+		return $this->redirect($url);
+	}
+
+	/**
+	 * Redirect to the {@link cancelUrl} or simply close the popup window.
+	 * @param string $url URL to redirect.
+	 * @return \yii\web\Response response instance.
+	 */
+	public function redirectCancel($url = null)
+	{
+		if ($url === null) {
+			$url = $this->getCancelUrl();
+		}
+		return $this->redirect($url, false);
+	}
+
+	/**
+	 * @param OpenId $provider provider instance.
+	 * @return \yii\web\Response action response.
+	 * @throws Exception on failure
+	 * @throws \yii\web\HttpException
+	 */
+	protected function authenticateOpenId($provider)
+	{
+		if (!empty($_REQUEST['openid_mode'])) {
+			switch ($_REQUEST['openid_mode']) {
+				case 'id_res':
+					if ($provider->validate()) {
+						$attributes = array(
+							'id' => $provider->identity
+						);
+						$rawAttributes = $provider->getAttributes();
+						foreach ($provider->getRequiredAttributes() as $openIdAttributeName) {
+							if (isset($rawAttributes[$openIdAttributeName])) {
+								$attributes[$openIdAttributeName] = $rawAttributes[$openIdAttributeName];
+							} else {
+								throw new Exception('Unable to complete the authentication because the required data was not received.');
+							}
+						}
+						$provider->setAttributes($attributes);
+						$provider->isAuthenticated = true;
+						return $this->authenticateSuccess($provider);
+					} else {
+						throw new Exception('Unable to complete the authentication because the required data was not received.');
+					}
+					break;
+				case 'cancel':
+					$this->redirectCancel();
+					break;
+				default:
+					throw new HttpException(400);
+					break;
+			}
+		} else {
+			$provider->identity = $provider->authUrl; // Setting identifier
+			$provider->required = []; // Try to get info from openid provider
+			foreach ($provider->getRequiredAttributes() as $openIdAttributeName) {
+				$this->required[] = $openIdAttributeName;
+			}
+			$request = Yii::$app->getRequest();
+			$provider->realm = $request->getHostInfo();
+			$provider->returnUrl = $provider->realm . $request->getUrl(); // getting return URL
+
+			$url = $provider->authUrl();
+			return Yii::$app->getResponse()->redirect($url);
+		}
+		return $this->redirectCancel();
+	}
+
+	/**
+	 * @param OAuth1 $provider
+	 * @return \yii\web\Response
+	 */
+	protected function authenticateOAuth1($provider)
+	{
+		// user denied error
+		if (isset($_GET['denied'])) {
+			return $this->redirectCancel();
+		}
+
+		if (isset($_REQUEST['oauth_token'])) {
+			$oauthToken = $_REQUEST['oauth_token'];
+		}
+
+		if (!isset($oauthToken)) {
+			// Get request token.
+			$requestToken = $provider->fetchRequestToken();
+			// Get authorization URL.
+			$url = $provider->buildAuthUrl($requestToken);
+			// Redirect to authorization URL.
+			return Yii::$app->getResponse()->redirect($url);
+		} else {
+			// Upgrade to access token.
+			$accessToken = $provider->fetchAccessToken();
+			$provider->isAuthenticated = true;
+			return $this->authenticateSuccess($provider);
+		}
+	}
+
+	/**
+	 * @param OAuth2 $provider
+	 * @return \yii\web\Response
+	 * @throws \yii\base\Exception
+	 */
+	protected function authenticateOAuth2($provider)
+	{
+		if (isset($_GET['error'])) {
+			if ($_GET['error'] == 'access_denied') {
+				// user denied error
+				return $this->redirectCancel();
+			} else {
+				// request error
+				if (isset($_GET['error_description'])) {
+					$errorMessage = $_GET['error_description'];
+				} elseif (isset($_GET['error_message'])) {
+					$errorMessage = $_GET['error_message'];
+				} else {
+					$errorMessage = http_build_query($_GET);
+				}
+				throw new Exception('Auth error: ' . $errorMessage);
+			}
+		}
+
+		// Get the access_token and save them to the session.
+		if (isset($_GET['code'])) {
+			$code = $_GET['code'];
+			$token = $provider->fetchAccessToken($code);
+			if (!empty($token)) {
+				$provider->isAuthenticated = true;
+				return $this->authenticateSuccess($provider);
+			} else {
+				return $this->redirectCancel();
+			}
+		} else {
+			$url = $provider->buildAuthUrl();
+			return Yii::$app->getResponse()->redirect($url);
+		}
+	}
+}

tests/unit/extensions/authclient/AuthActionTest.php

@@ -0,0 +1,68 @@
+<?php
+
+namespace yiiunit\extensions\authclient;
+
+
+use yii\authclient\AuthAction;
+
+class AuthActionTest extends TestCase
+{
+	protected function setUp()
+	{
+		$config = [
+			'components' => [
+				'user' => [
+					'identityClass' => '\yii\web\IdentityInterface'
+				],
+				'request' => [
+					'hostInfo' => 'http://testdomain.com',
+					'scriptUrl' => '/index.php',
+				],
+			]
+		];
+		$this->mockApplication($config, '\yii\web\Application');
+	}
+
+	public function testSetGet()
+	{
+		$action = new AuthAction(null, null);
+
+		$successUrl = 'http://test.success.url';
+		$action->setSuccessUrl($successUrl);
+		$this->assertEquals($successUrl, $action->getSuccessUrl(), 'Unable to setup success URL!');
+
+		$cancelUrl = 'http://test.cancel.url';
+		$action->setCancelUrl($cancelUrl);
+		$this->assertEquals($cancelUrl, $action->getCancelUrl(), 'Unable to setup cancel URL!');
+	}
+
+	/**
+	 * @depends testSetGet
+	 */
+	public function testGetDefaultSuccessUrl()
+	{
+		$action = new AuthAction(null, null);
+
+		$this->assertNotEmpty($action->getSuccessUrl(), 'Unable to get default success URL!');
+	}
+
+	/**
+	 * @depends testSetGet
+	 */
+	public function testGetDefaultCancelUrl()
+	{
+		$action = new AuthAction(null, null);
+
+		$this->assertNotEmpty($action->getSuccessUrl(), 'Unable to get default cancel URL!');
+	}
+
+	public function testRedirect()
+	{
+		$action = new AuthAction(null, null);
+
+		$url = 'http://test.url';
+		$response = $action->redirect($url, true);
+
+		$this->assertContains($url, $response->content);
+	}
+}