Initial commit.

EAuth.php

@@ -0,0 +1,160 @@
+<?php
+/**
+ * EAuth class file.
+ *
+ * @author Maxim Zemskov <nodge@yandex.ru>
+ * @link http://code.google.com/p/yii-eauth/
+ * @license http://www.opensource.org/licenses/bsd-license.php
+ */
+
+/**
+ * The EAuth class provides simple authentication via OpenID and OAuth providers.
+ * @package application.extensions.eauth
+ */
+class EAuth extends CApplicationComponent {
+
+	/**
+	 * @var array Authorization services and their settings.
+	 */
+	public $services = array();
+
+	/**
+	 * @var boolean Whether to use popup window for the authorization dialog.
+	 */
+	public $popup = true;
+
+	/**
+	 * Returns services settings declared in the authorization classes.
+	 * For perfomance reasons it uses Yii::app()->cache to store settings array.
+	 * @return array services settings.
+	 */
+	protected function getServices() {
+		if (Yii::app()->hasComponent('cache'))
+			$services = Yii::app()->cache->get('EAuth.services');
+		if (!isset($services) || !is_array($services)) {
+			$services = array();
+			foreach ($this->services as $service => $options) {
+				$class = $this->getIdentity($service);
+				$services[$service] = (object) array(
+					'id' => $class->getServiceName(),
+					'title' => $class->getServiceTitle(),
+					'type' => $class->getServiceType(),
+					'jsArguments' => $class->getJsArguments(),
+				);
+			}
+			if (Yii::app()->hasComponent('cache'))
+				Yii::app()->cache->set('EAuth.services', $services);
+		}
+		return $services;
+	}
+
+	/**
+	 * Returns the settings of the service.
+	 * @param string $service the service name.
+	 * @return array the service settings.
+	 */
+	protected function getService($service) {
+		$service = strtolower($service);
+		$services = $this->getServices();
+		if (!isset($services[$service]))
+			throw new EAuthException(Yii::t('eauth', 'Undefined service name: {service}', array('{service}' => $service)), 500);
+		return $services[$service];
+	}
+
+	/**
+	 * Returns the type of the service.
+	 * @param string $service the service name.
+	 * @return string the service type. 
+	 */
+	public function getServiceType($service) {
+		$service = $this->getService($service);
+		return $service->type;
+	}
+
+	/**
+	 * Returns the service identity class.
+	 * @param string $service the service name.
+	 * @return IAuthService the identity class.
+	 */
+	public function getIdentity($service) {
+		$service = strtolower($service);
+		if (!isset($this->services[$service]))
+			throw new EAuthException(Yii::t('eauth', 'Undefined service name: {service}', array('{service}' => $service)), 500);
+		$service = $this->services[$service];
+
+		$class = $service['class'];
+		$point = strrpos($class, '.');
+		// if it is yii path alias
+		if ($point > 0) {
+			Yii::import($class);
+			$class = substr($class, $point + 1);
+		}
+		unset($service['class']);
+		$identity = new $class();
+		$identity->init($this, $service);
+		return $identity;
+	}
+
+	/**
+	 * Redirects to url. If the authorization dialog opened in the popup window, 
+	 * it will be closed instead of redirect. Set $jsRedirect=true if you want
+	 * to redirect anyway.
+	 * @param mixed $url url to redirect. Can be route or normal url. See {@link CHtml::normalizeUrl}.
+	 * @param boolean $jsRedirect whether to use redirect while popup window is used. Defaults to true.
+	 */
+	public function redirect($url, $jsRedirect = true) {		
+		require_once dirname(__FILE__).DIRECTORY_SEPARATOR.'EAuthRedirectWidget.php';				
+		$widget = Yii::app()->getWidgetFactory()->createWidget($this, 'EAuthRedirectWidget', array(
+			'url' => CHtml::normalizeUrl($url),
+			'redirect' => $jsRedirect,
+		));
+		$widget->init();
+		$widget->run();
+	}
+
+	/**
+	 * Simple wrapper for {@link CController::widget} function for render the {@link EAuthWidget} widget.
+	 * @param array $properties the widget properties.
+	 */
+	public function renderWidget($properties = array()) {
+		require_once dirname(__FILE__).DIRECTORY_SEPARATOR.'EAuthWidget.php';
+
+		$properties = CMap::mergeArray(array(
+			'popup' => $this->popup
+		), $properties);
+
+		if (!isset($properties['services'])) 
+			$properties['services'] = $this->getServices();
+
+		$widget = Yii::app()->getWidgetFactory()->createWidget($this, 'EAuthWidget', $properties);
+		$widget->init();
+		$widget->run();
+	}
+
+	/**
+	 * Serialize the identity class.
+	 * @param EAuthServiceBase $identity the class instance.
+	 * @return string serialized value.
+	 */
+	public function toString($identity) {
+		return serialize($identity);
+	}
+
+	/**
+	 * Serialize the identity class.
+	 * @param string $identity serialized value.
+	 * @return EAuthServiceBase the class instance.
+	 */
+	public function fromString($identity) {
+		return unserialize($identity);
+	}
+}
+
+/**
+ * The EAuthException exception class.
+ * 
+ * @author Maxim Zemskov <nodge@yandex.ru>
+ * @package application.extensions.auth
+ * @version 1.0
+ */
+class EAuthException extends CException {}

EAuthRedirectWidget.php

@@ -0,0 +1,39 @@
+<?php
+/**
+ * EAuthRedirectWidget class file.
+ *
+ * @author Maxim Zemskov <nodge@yandex.ru>
+ * @link http://code.google.com/p/yii-eauth/
+ * @license http://www.opensource.org/licenses/bsd-license.php
+ */
+
+/**
+ * The EAuthRedirectWidget widget displays the redirect page after returning from provider.
+ * @package application.extensions.eauth
+ */
+class EAuthRedirectWidget extends CWidget {
+
+	/**
+	 * @var mixed the widget mode. Default to "login".
+	 */
+	public $url = null;
+
+	/**
+	 * @var boolean whether to use redirect inside the popup window.
+	 */
+	public $redirect = true;
+
+	/**
+	 * Executes the widget.
+	 */
+    public function run() {
+		$assets_path = dirname(__FILE__).DIRECTORY_SEPARATOR.'assets';
+		$this->render('redirect', array(
+			'id' => $this->getId(),
+			'url' => $this->url,
+			'redirect' => $this->redirect,
+			'assets_path' => $assets_path,
+		));
+		Yii::app()->end();
+    }
+}