ItsNat Java Web Application Framework

  Copyright (C) 2007-2011 Jose Maria Arranz Santamaria, Spanish citizen

  This software is free software; you can redistribute it and/or modify it

  under the terms of the GNU Lesser General Public License as

  published by the Free Software Foundation; either version 3 of

  the License, or (at your option) any later version.

  This software is distributed in the hope that it will be useful,

  but WITHOUT ANY WARRANTY; without even the implied warranty of

  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU

  Lesser General Public License for more details. You should have received

  a copy of the GNU Lesser General Public License along with this program.

  If not, see <http://www.gnu.org/licenses/>.

*/

*

* @author jmarranz

*/

    // El document.itsNatDoc.disabledEvents sirve para evitar que m�s listeners asociados a un evento se env�en y provoquen cargar "reloads" mientras se procesa el primer reload

    // Es el caso de navegadores con back/fordward cacheado pero que ejecutan los scripts y por tanto ejecutan el script de inicio.

    // Recarga usando window.location:

    // La m�s segura es: window.location.reload(true);

    // Hay otras maneras tal y como:

    //   window.location = window.location;

    //   window.location.href = window.location.href;

    //   window.history.go(0);

    // El problema es que si hay una referencia en URL (o hash) al final

    // tal y como #hola las tres formas anteriores no recargan, no hacen nada

    // (depende del navegador) por lo que hay que tender a usar:

    // window.location.reload(true);

    private static final String DISABLE_EVENTS = "if (document.itsNatDoc) document.itsNatDoc.disabledEvents=true;";

    private static final String RELOAD_CODE_NORMAL = DISABLE_EVENTS + "window.location.reload(true);\n";

    // El caso de Opera Mobile 9.5 beta es que "window.location.reload(true);" no hace nada en ciertas situaciones:

    // como parte de un evento "load" y como parte de un script ejecutado como respuesta de un request AJAX

    // (as�ncrono es el testeado). Sin embargo otras opciones "window.location = window.location" o "window.location.href = window.location.href"

    // s� funcionan excepto cuando hay un #ref al final y window.history.go(0) recarga incondicionalmente.

    // Otra alternativa (peor) ser�a a�adir un onmousedown al BODY el cual ser� pulsado

    // compulsivamente por el usuario y har� el reload.

    // private static final String RELOAD_CODE_OperaMobile = RELOAD_CODE_NORMAL + " window.history.go(0); window.location = window.location; \n"; // Tres oportunidades para recargar

    // En el caso de Adobe SVG Viewer el window.location.reload(true) es como

    // si hici�ramos un reload manual y no se recarga (se borra la pantalla)

    // sin embargo window.location.href = window.location.href; s� recarga

    // si no hay una referencia en el URL (#prueba) esto ser� raro en SVG.

    // Evitamos el c�digo de desactivaci�n de eventos por si acaso falla.

    private static final String RELOAD_CODE_AdobeSVG = "window.location.href = window.location.href;";

   

    protected boolean loaded = false;

    /**

     * Creates a new instance of OnLoadBackForwardListenerImpl

     */

    public OnLoadBackForwardListenerImpl()

    {

    }

    public static String getReloadCode(Browser browser)

    {

        /*if (browser instanceof BrowserOperaMobile)

            return RELOAD_CODE_OperaMobile;

        else*/ if (browser instanceof BrowserAdobeSVG)

            return RELOAD_CODE_AdobeSVG;

        else

            return RELOAD_CODE_NORMAL;

    }

    public static ParamTransport[] createExtraParams()

    {

        return new ParamTransport[] { new CustomParamTransport("itsnat_check_reload","true") };

    }

    public static boolean isLoadBackForwardEvent(RequestNormalEventImpl request)

    {

        return request.isLoadEvent() && (request.getAttrOrParam("itsnat_check_reload") != null);

    }

    public void handleEvent(Event evt)

    {

        // En Opera 9 este listener tiene la finalidad

        // de detectar que la p�gina del navegador no ha sido

        // cargada desde el servidor sino de la cache normalmente

        // ante un back/forward unido a que Opera no siempre genera unload

        // por lo que la p�gina puede seguir "viva" en el servidor al volver via back/forward.

        // En Opera 9 gracias a window.history.navigationMode = "compatible" (y la otra forma)

        // el evento load y DOMContentLoaded se env�an aunque la p�gina

        // se lea de la cache.

        // Si ya pas� por aqu� significa que se han enviado dos eventos

        // load o DOMContentLoaded, esto es posible si el evento unload

        // no se emiti� y en el servidor la p�gina sigue vida.

        // El caso es que cuando el navegador al rescatar la p�gina de la cache

        // env�a el evento load/DOMContentLoaded detectamos que realmente

        // se cerr� sin enviar el unload (ocurre cuando se sale de la p�gina con

        // back/forward) y hemos vuelto a ella via back/forward.

        // Para ItsNat salir de la p�gina supone que dicha p�gina "ha de morir"

        // pues las siguientes p�ginas han podido cambiar el estado del servidor

        // por lo que el estado de la p�gina en cliente y servidor pueden no corresponderse

        // con el estado de la base de datos por poner un ejemplo, por ello

        // nuestro objetivo es recargarla.

        // Por otra parte si la p�gina se elimin� con unload y hemos vuelto

        // a ella via back/forward, no pasaremos por aqu� obviamente (el documento ya no existe)

        // ser� el caso de recarga que procesar� ResponseNormalFixCacheImpl

        if (loaded)

        {

            // Se est� ejecutando dos veces por lo que es el caso de vuelta por back/forward

            ItsNatEvent itsNatEvt = (ItsNatEvent)evt;

            itsNatEvt.getItsNatDocument().setInvalid();

            ClientDocumentImpl clientDoc = (ClientDocumentImpl)itsNatEvt.getClientDocument();

            itsNatEvt.getItsNatServletResponse().addCodeToSend(getReloadCode(clientDoc.getBrowser()));

        }

        else this.loaded = true;

    }

}