Remove unnecessary log level checks

The play.api.Logger API uses call by name parameters for the message arguments. They will be evaluated at each point they are used not at the point they are called. More information is available in http://eed3si9n.com/scala-and-evaluation-strategy and in http://www.scala-lang.org/docu/files/ScalaReference.pdf section 4.6.1 By-Name Parameters ( this document is for scala 2.9 but the call by name mechanism has not been changed significantly between the 2 versions)

Author: jeantil

module-code/app/securesocial/controllers/LoginPage.scala

@@ -44,9 +44,7 @@ object LoginPage extends Controller
     val to = ProviderController.landingUrl
     if ( SecureSocial.currentUser.isDefined ) {
       // if the user is already logged in just redirect to the app
-      if ( logger.isDebugEnabled ) {
-        logger.debug("User already logged in, skipping login page. Redirecting to %s".format(to))
-      }
+      logger.debug("User already logged in, skipping login page. Redirecting to %s".format(to))
       Redirect( to )
     } else {
       import com.typesafe.plugin._

module-code/app/securesocial/controllers/ProviderController.scala

@@ -117,9 +117,7 @@ object ProviderController extends Controller with SecureSocial
               request.user match {
                 case Some(currentUser) =>
                   UserService.link(currentUser, user)
-                  if ( logger.isDebugEnabled ) {
-                    logger.debug(s"[securesocial] linked $currentUser to $user")
-                  }
+                  logger.debug(s"[securesocial] linked $currentUser to $user")
                   // improve this, I'm duplicating part of the code in completeAuthentication
                   Redirect(toUrl(modifiedSession)).withSession(modifiedSession-
                     SecureSocial.OriginalUrlKey -

module-code/app/securesocial/controllers/Registration.scala

@@ -191,9 +191,7 @@ object Registration extends Controller {
    */
   def signUp(token: String) = Action { implicit request =>
     if (registrationEnabled) {
-      if ( logger.isDebugEnabled ) {
-        logger.debug("[securesocial] trying sign up with token %s".format(token))
-      }
+      logger.debug("[securesocial] trying sign up with token %s".format(token))
       executeForToken(token, true, { _ =>
         Ok(use[TemplatesPlugin].getSignUpPage(form, token))
       })
@@ -221,9 +219,7 @@ object Registration extends Controller {
       executeForToken(token, true, { t =>
         form.bindFromRequest.fold (
           errors => {
-            if ( logger.isDebugEnabled ) {
-              logger.debug("[securesocial] errors " + errors)
-            }
+            logger.debug("[securesocial] errors " + errors)
             BadRequest(use[TemplatesPlugin].getSignUpPage(errors, t.uuid))
           },
           info => {

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

@@ -88,9 +88,7 @@ abstract class OAuth1Provider(application: Application) extends IdentityProvider
       // the oauth_verifier field is not in the request, this is the 1st step in the auth flow.
       // we need to get the request tokens
       val callbackUrl = RoutesHelper.authenticate(id).absoluteURL(IdentityProvider.sslEnabled)
-      if ( logger.isDebugEnabled ) {
-        logger.debug("[securesocial] callback url = " + callbackUrl)
-      }
+      logger.debug("[securesocial] callback url = " + callbackUrl)
       service.retrieveRequestToken(callbackUrl) match {
         case Right(accessToken) =>
           val cacheKey = UUID.randomUUID().toString

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

@@ -83,9 +83,7 @@ abstract class OAuth2Provider(application: Application, jsonResponse: Boolean =
 
   protected def buildInfo(response: Response): OAuth2Info = {
       val json = response.json
-      if ( logger.isDebugEnabled ) {
-        logger.debug("[securesocial] got json back [" + json + "]")
-      }
+      logger.debug("[securesocial] got json back [" + json + "]")
       OAuth2Info(
         (json \ OAuth2Constants.AccessToken).as[String],
         (json \ OAuth2Constants.TokenType).asOpt[String],
@@ -121,9 +119,7 @@ abstract class OAuth2Provider(application: Application, jsonResponse: Boolean =
           )
           SocialUser(IdentityId("", id), "", "", "", None, None, authMethod, oAuth2Info = oauth2Info)
         }
-        if ( logger.isDebugEnabled ) {
-          logger.debug("[securesocial] user = " + user)
-        }
+        logger.debug("[securesocial] user = " + user)
         user match  {
           case Some(u) => Right(u)
           case _ => throw new AuthenticationException()
@@ -142,10 +138,9 @@ abstract class OAuth2Provider(application: Application, jsonResponse: Boolean =
         settings.authorizationUrlParams.foreach( e => { params = e :: params })
         val url = settings.authorizationUrl +
           params.map( p => URLEncoder.encode(p._1, "UTF-8") + "=" + URLEncoder.encode(p._2, "UTF-8")).mkString("?", "&", "")
-        if ( logger.isDebugEnabled ) {
-          logger.debug("[securesocial] authorizationUrl = %s".format(settings.authorizationUrl))
-          logger.debug("[securesocial] redirecting to: [%s]".format(url))
-        }
+        logger.debug("[securesocial] authorizationUrl = %s".format(settings.authorizationUrl))
+        logger.debug("[securesocial] redirecting to: [%s]".format(url))
+
         Left(Results.Redirect( url ).withSession(request.session + (IdentityProvider.SessionId, sessionId)))
     }
   }

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

@@ -128,9 +128,7 @@ trait SecureSocial extends Controller {
       }
 
       result.getOrElse({
-        if ( logger.isDebugEnabled ) {
-          logger.debug("[securesocial] anonymous user trying to access : '%s'".format(request.uri))
-        }
+        logger.debug("[securesocial] anonymous user trying to access : '%s'".format(request.uri))
         val response = if ( ajaxCall ) {
           ajaxCallNotAuthenticated(request)
         } else {

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

@@ -137,9 +137,7 @@ abstract class UserServicePlugin(application: Application) extends Plugin with U
     cancellable = if ( UsernamePasswordProvider.enableTokenJob ) {
       Some(
         Akka.system.scheduler.schedule(0.seconds, i.minutes) {
-          if ( logger.isDebugEnabled ) {
-            logger.debug("[securesocial] calling deleteExpiredTokens()")
-          }
+          logger.debug("[securesocial] calling deleteExpiredTokens()")
           deleteExpiredTokens()
         }
       )

module-code/app/securesocial/core/providers/utils/Mailer.scala

@@ -78,10 +78,9 @@ object Mailer {
     import scala.concurrent.duration._
     import play.api.libs.concurrent.Execution.Implicits._
 
-    if ( Logger.isDebugEnabled ) {
-      logger.debug("[securesocial] sending email to %s".format(recipient))
-      logger.debug("[securesocial] mail = [%s]".format(body))
-    }
+    logger.debug("[securesocial] sending email to %s".format(recipient))
+    logger.debug("[securesocial] mail = [%s]".format(body))
+
 
     Akka.system.scheduler.scheduleOnce(1.seconds) {
       val mail = use[MailerPlugin].email

module-code/app/securesocial/core/providers/utils/RoutesHelper.scala

@@ -85,9 +85,7 @@ object RoutesHelper {
 
   lazy val assets = {
     val clazz = conf.getString("securesocial.assetsController").getOrElse("controllers.ReverseAssets")
-    if ( logger.isDebugEnabled ) {
-      logger.debug("[securesocial] assets controller = %s".format(clazz))
-    }
+    logger.debug("[securesocial] assets controller = %s".format(clazz))
     Play.application().classloader().loadClass(clazz)
   }
 
@@ -118,9 +116,7 @@ object RoutesHelper {
    */
   val bootstrapCssPath = {
     val bsPath = conf.getString("securesocial.bootstrapCssPath").getOrElse(defaultBootstrapCssPath)
-    if ( logger.isDebugEnabled ) {
-      logger.debug("[securesocial] bootstrap path = %s".format(bsPath))
-    }
+    logger.debug("[securesocial] bootstrap path = %s".format(bsPath))
     at(bsPath)
   }
 
@@ -131,9 +127,7 @@ object RoutesHelper {
    */
   val faviconPath = {
     val favPath = conf.getString("securesocial.faviconPath").getOrElse(defaultFaviconPath)
-    if ( logger.isDebugEnabled ) {
-      logger.debug("[securesocial] favicon path = %s".format(favPath))
-    }
+    logger.debug("[securesocial] favicon path = %s".format(favPath))
     at(favPath)
   }
 
@@ -144,9 +138,7 @@ object RoutesHelper {
    */
   val jqueryPath = {
     val jqueryPath = conf.getString("securesocial.jqueryPath").getOrElse(defaultJqueryPath)
-    if ( logger.isDebugEnabled ) {
-      logger.debug("[securesocial] Jquery path = %s".format(jqueryPath))
-    }
+    logger.debug("[securesocial] Jquery path = %s".format(jqueryPath))
     at(jqueryPath)
   }