Search code examples
javaajaxgrailsgsp

Identifying ajax request or browser request in grails controller


I am developing a grails application which uses lot of ajax.If the request is ajax call then it should give response(this part is working), however if I type in the URL in the browser it should take me to the home/index page instead of the requested page.Below is the sample gsp code for ajax call.

<g:remoteFunction action="list" controller="todo" update="todo-ajax">

<div id ="todo-ajax">
//ajax call rendered in this area
</div>

if we type http://localhost:8080/Dash/todo/list in the browser URL bar, the controller should redirect to http://localhost:8080/Dash/auth/index

How to validate this in controller.


Solution

  • It's quite a common practice to add this dynamic method in your BootStrap.init closure:

        HttpServletRequest.metaClass.isXhr = {->
             'XMLHttpRequest' == delegate.getHeader('X-Requested-With')
        }
    

    this allows you to test if the current request is an ajax call by doing:

    if(request.xhr) { ... }
    

    The simplest solution is to add something like this to your todo action:

    if(!request.xhr) { 
        redirect(controller: 'auth', action: 'index')
        return false
    }
    

    You could also use filters/interceptors. I've built a solution where I annotated all actions that are ajax-only with a custom annotation, and then validated this in a filter.

    Full example of grails-app/conf/BootStrap.groovy:

    import javax.servlet.http.HttpServletRequest
    
    class BootStrap {
    
         def init = { servletContext ->
    
            HttpServletRequest.metaClass.isXhr = {->
                'XMLHttpRequest' == delegate.getHeader('X-Requested-With')
            }
    
         }
         def destroy = {
         }
    }