Fixed jaliss#431: Added SecureSocial.currentUser to support Websockets

Author: jaliss

ChangeLog

@@ -1,4 +1,5 @@
 master  -
+		- Added SecureSocial.currentUser to support Websockets
 		- Fixed #429: null pointer exception in UserAware Java API (thanks @mangecoeur)
 		- Pull request #159: Weibo support (thanks @qiuzhanghua and @wuhaixing)
 		- Pull request #398: Dropbox support (thanks @deterdw)

module-code/app/securesocial/core/SecureSocial.scala

@@ -213,4 +213,21 @@ object SecureSocial {
     import play.api.Play
     Play.current.configuration.getBoolean("securesocial.enableRefererAsOriginalUrl").getOrElse(false)
   }
+
+  /**
+   * Returns the current user. Invoke this only if you are executing code
+   * without a SecuredRequest or UserAwareRequest available. For most cases what SecuredAction or UserAwareAction
+   * gives you will be enough.
+   *
+   * @param request the current request
+   * @param env the current environment
+   * @tparam U the user type
+   * @return a future with an option user
+   */
+  def currentUser[U](implicit request: RequestHeader, env: RuntimeEnvironment[U], ec: ExecutionContext): Future[Option[U]] = {
+    env.authenticatorService.fromRequest.map {
+      case Some(authenticator) if authenticator.isValid => Some(authenticator.user)
+      case _ => None
+    }
+  }
 }

module-code/app/securesocial/core/java/SecureSocial.java

@@ -16,8 +16,14 @@
 */
 package securesocial.core.java;
 
+import play.api.mvc.RequestHeader;
+import play.libs.F;
+import play.libs.HttpExecution;
 import play.mvc.Http;
+import scala.Option;
+import scala.concurrent.ExecutionContext;
 import securesocial.core.RuntimeEnvironment;
+import securesocial.core.SecureSocial$;
 
 /**
 *
@@ -39,4 +45,42 @@ public class SecureSocial {
     public static RuntimeEnvironment env() {
         return (RuntimeEnvironment) Http.Context.current().args.get("securesocial-env");
     }
+
+    /**
+     * Returns the current user. Invoke this only if you are executing code
+     * without a SecuredAction or UserAware action available (eg: using WebSockets). For other cases this
+     * should not be needed.
+     *
+     * @param env the environment
+     * @return the current user object or null if there isn't one available
+     */
+    public static F.Promise<Object> currentUser(RuntimeEnvironment env) {
+        return currentUser(env, HttpExecution.defaultContext());
+    }
+
+    /**
+     * Returns the current user. Invoke this only if you are executing code
+     * without a SecuredAction or UserAware action available (eg: using WebSockets). For other cases this
+     * should not be needed.
+     *
+     * @param env the environment
+     * @param executor an ExecutionContext
+     * @return the current user object or null if there isn't one available
+     */
+    public static F.Promise<Object> currentUser(RuntimeEnvironment env, ExecutionContext executor) {
+        RequestHeader requestHeader = Http.Context.current()._requestHeader();
+        if (requestHeader == null || env == null) {
+            return F.Promise.promise(null);
+        } else {
+            scala.concurrent.Future scalaFuture = SecureSocial$.MODULE$.currentUser(requestHeader, env, executor);
+            F.Function<Option<Object>, Object> mapFunction = new F.Function<Option<Object>, Object>() {
+
+                @Override
+                public Object apply(Option<Object> objectOption) throws Throwable {
+                    return objectOption.isDefined() ? objectOption.get() : null;
+                }
+            };
+            return F.Promise.wrap(scalaFuture).map(mapFunction);
+        }
+    }
 }

samples/java/demo/app/controllers/Application.java

@@ -17,9 +17,11 @@
 package controllers;
 
 import play.Logger;
+import play.libs.F;
 import play.mvc.Controller;
 import play.mvc.Result;
 import securesocial.core.BasicProfile;
+import securesocial.core.RuntimeEnvironment;
 import securesocial.core.java.SecureSocial;
 import securesocial.core.java.SecuredAction;
 import securesocial.core.java.UserAwareAction;
@@ -33,6 +35,17 @@
  */
 public class Application extends Controller {
     public static Logger.ALogger logger = Logger.of("application.controllers.Application");
+    private RuntimeEnvironment env;
+
+    /**
+     * A constructor needed to get a hold of the environment instance.
+     * This could be injected using a DI framework instead too.
+     *
+     * @param env
+     */
+    public Application(RuntimeEnvironment env) {
+        this.env = env;
+    }
     /**
      * This action only gets called if the user is logged in.
      *
@@ -77,4 +90,24 @@ public Result linkResult() {
         DemoUser current = (DemoUser) ctx().args.get(SecureSocial.USER_KEY);
         return ok(linkResult.render(current, current.identities));
     }
+
+    /**
+     * Sample use of SecureSocial.currentUser. Access the /current-user to test it
+     */
+    public F.Promise<Result> currentUser() {
+        return SecureSocial.currentUser(env).map( new F.Function<Object, Result>() {
+            @Override
+            public Result apply(Object maybeUser) throws Throwable {
+                String id;
+
+                if ( maybeUser != null ) {
+                    DemoUser user = (DemoUser) maybeUser;
+                    id = user.main.userId();
+                } else {
+                    id = "not available. Please log in.";
+                }
+                return ok("your id is " + id);
+            }
+        });
+    }
 }

samples/java/demo/conf/routes

@@ -3,11 +3,12 @@
 # ~~~~
 
 # Home page
-GET     /                           @controllers.Application.index
-GET     /userAware                  @controllers.Application.userAware
-GET     /only-twitter               @controllers.Application.onlyTwitter
-GET     /link-result                @controllers.Application.linkResult
+GET        /                    @controllers.Application.index
+GET        /userAware           @controllers.Application.userAware
+GET        /only-twitter        @controllers.Application.onlyTwitter
+GET        /link-result         @controllers.Application.linkResult
+GET        /current-user        @controllers.Application.currentUser
 
 # Map static resources from the /public folder to the /assets URL path
-GET     /assets/*file               controllers.Assets.at(path="/public", file)
-->      /auth                securesocial.Routes
+GET        /assets/*file        controllers.Assets.at(path="/public", file)
+->         /auth                securesocial.Routes

samples/scala/demo/app/controllers/Application.scala

@@ -18,7 +18,7 @@ package controllers
 
 import securesocial.core._
 import service.DemoUser
-import play.api.mvc.RequestHeader
+import play.api.mvc.{Action, RequestHeader}
 
 class Application(override implicit val env: RuntimeEnvironment[DemoUser]) extends securesocial.core.SecureSocial[DemoUser] {
   def index = SecuredAction { implicit request =>
@@ -33,6 +33,17 @@ class Application(override implicit val env: RuntimeEnvironment[DemoUser]) exten
   def linkResult = SecuredAction { implicit request =>
     Ok(views.html.linkResult(request.user))
   }
+
+  /**
+   * Sample use of SecureSocial.currentUser. Access the /current-user to test it
+   */
+  def currentUser = Action.async { implicit request =>
+    import play.api.libs.concurrent.Execution.Implicits._
+    SecureSocial.currentUser[DemoUser].map { maybeUser =>
+      val userId = maybeUser.map(_.main.userId).getOrElse("unknown")
+      Ok(s"Your id is $userId")
+    }
+  }
 }
 
 // An Authorization implementation that only authorizes uses that logged in using twitter

samples/scala/demo/conf/routes

@@ -6,7 +6,7 @@
 GET        /                    @controllers.Application.index
 GET        /only-twitter        @controllers.Application.onlyTwitter
 GET        /link-result         @controllers.Application.linkResult
-
+GET        /current-user        @controllers.Application.currentUser
 GET        /custom/login        @controllers.CustomLoginController.login
 GET        /custom/logout       @controllers.CustomLoginController.logout