/*

* Copyright (c) 1999 - 2001 Nokia Corporation and/or its subsidiary(-ies).

* All rights reserved.

* This component and the accompanying materials are made available

* under the terms of the License "Eclipse Public License v1.0"

* which accompanies this distribution, and is available

* at the URL "http://www.eclipse.org/legal/epl-v10.html".

*

* Initial Contributors:

* Nokia Corporation - initial contribution.

*

* Contributors:

*

* Description: 

*

*/

/*

    $Workfile: wml_url_navigation.c $

    Purpose:

        Class: WmlBrowser

        Browser url navigation logic

*/

#include "nwx_defs.h"

#include "nwx_memseg.h"

#include "nwx_string.h"

#include "nwx_url_utils.h"

#include "wml_elm_attr.h"

#include "wml_task.h"

#include "wml_api.h"

#include "wml_history.h"

#include "wml_url_utils.h"

#include "wml_decoder.h"

#include "nw_hed_documentroot.h"

#include "nw_lmgr_rootbox.h"

#include "nw_wml1x_wml1xcontenthandler.h"

#include "BrsrStatusCodes.h"

static TBrowserStatusCode LoadDeckError(NW_Wml_t* thisObj, NW_DeckDecoder_t *tmp_decoder,

                                  NW_DeckDecoder_t *old_decoder, NW_Ucs2* url);

static TBrowserStatusCode SetTimerKey(NW_Wml_t *wml);

static TBrowserStatusCode GetMethod(NW_Wml_t *thisObj, NW_Wml_Element_t *go_elem, NW_Bool *method_is_post);

static TBrowserStatusCode MakeReqUrl(NW_Wml_t *thisObj, NW_Ucs2 *card_name, NW_Ucs2 **patchedReqUrl);

static TBrowserStatusCode MoveToCard(NW_Wml_t *thisObj, NW_Ucs2 *card_name);

static TBrowserStatusCode ProcessIntraDeckGoTask(NW_Wml_t *thisObj, NW_Ucs2 *reqUrl, NW_Bool updateHistory);

static TBrowserStatusCode ProcessIntraDeckFetchUrlTask(NW_Wml_t *thisObj, NW_Ucs2 *reqUrl, NW_Bool updateHistory);

static TBrowserStatusCode MustReload(NW_Wml_t *thisObj, NW_Wml_Element_t *go_elem, NW_Bool *reload);

static TBrowserStatusCode GetImageUrl(NW_Wml_t *that, NW_Uint16 imgel_id, NW_Wml_Attr_t image_attr,

                                                       NW_Ucs2 **ret_string);

/*------------------------------------------------------------

 * SetTimerKey 

 * If a timer is running, set the TIMER's KEY variable to the

 * remaining time.

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *----------------------------------------------------------*/  

static TBrowserStatusCode SetTimerKey(NW_Wml_t *thisObj)

{

  TBrowserStatusCode status;

  NW_Uint32   timer_value = 0;

  NW_Bool     running = NW_FALSE;

  NW_ASSERT(thisObj != NULL);

  status = (TIMER_API->isRunning)(thisObj->browser_app,&running);

  if (status != KBrsrSuccess || !running)

    return status;

  if ((status = NW_Wml_SetTimerKey(thisObj, WAE_TIMER_FROM_TIMER, &timer_value))

      == KBrsrOutOfMemory)

    return status;

  thisObj->script_state.timer_time = timer_value;

  if ((status = (TIMER_API->stop)(thisObj->browser_app)) != KBrsrSuccess)

    return status;

  (void)(TIMER_API->destroy)(thisObj->browser_app);

  return status;

}

/*---------------------------------------------------------------------------

 * GetMethod 

 *

 * Sets method_is_post true if the method really, truly is 'post'

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *-------------------------------------------------------------------------*/

static TBrowserStatusCode GetMethod(NW_Wml_t *thisObj, 

                             NW_Wml_Element_t *go_elem, 

                             NW_Bool  *method_is_post)

{

  NW_ASSERT(thisObj != NULL);

  *method_is_post = NW_FALSE;

  if (go_elem == NULL)

    return KBrsrSuccess;

  *method_is_post = NW_DeckDecoder_HasAttributeWithValue(thisObj->decoder, go_elem, METHOD_ATTR, 

      WAE_ASC_POST_STR, thisObj->var_list);

  return KBrsrSuccess;

}

/*---------------------------------------------------------------------------

 * GetCacheControl 

 *

 * Sets noCache true if the cache-control attrib. value is 'no-cache'

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *-------------------------------------------------------------------------*/

static TBrowserStatusCode GetCacheControl(NW_Wml_t         *thisObj, 

                                          NW_Wml_Element_t *go_elem, 

                                          NW_Bool          *noCache)

{

  NW_ASSERT(thisObj != NULL);

  *noCache = NW_FALSE;

  if (go_elem == NULL)

    return KBrsrSuccess;

  *noCache = NW_DeckDecoder_HasAttributeWithValue(thisObj->decoder, go_elem, CACHECONTROL_ATTR, 

      WAE_ASC_NOCACHE_STR, thisObj->var_list);

  return KBrsrSuccess;

}

/*---------------------------------------------------------------------------

 * GetPostfields 

 *

 * Sets postfields to true if a postfields elmement is within the go tag

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *-------------------------------------------------------------------------*/

static TBrowserStatusCode GetPostfields(NW_Wml_t         *thisObj, 

                                        NW_Wml_Element_t *go_elem, 

                                        NW_Bool          *isPostField)

{

  TBrowserStatusCode status = KBrsrFailure;

  NW_NVPair_t *postfields     = NULL;

  NW_ASSERT(thisObj != NULL);

  *isPostField = NW_FALSE;

  if (go_elem == NULL)

  {

    return KBrsrSuccess;

  }

  status = NW_DeckDecoder_GetPostfieldData(thisObj->decoder,

              thisObj->var_list, go_elem, &postfields);

  if (postfields != NULL) 

    {

      *isPostField = NW_TRUE;

      NW_NVPair_Delete( postfields );

      postfields = NULL;

   }

  return status;

}

/*---------------------------------------------------------------------

 * MustReload

 *

 * We must reload if there are any postfields, or the method of the

 * go element is 'post'.

 *

 * returns:

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *---------------------------------------------------------------------*/ 

static TBrowserStatusCode MustReload(NW_Wml_t *thisObj, 

                                     NW_Wml_Element_t *go_elem, 

                                     NW_Bool  *reload)

{

  NW_Bool     isPost;

  NW_Bool     noCache;

  NW_Bool     isPostField;

  NW_ASSERT(thisObj != NULL);

  NW_ASSERT(reload != NULL);

  *reload = NW_FALSE;

  GetPostfields(thisObj, go_elem, &isPostField);

  GetMethod(thisObj, go_elem, &isPost);

  GetCacheControl(thisObj, go_elem, &noCache);

  *reload = (NW_Bool) (noCache || isPost || isPostField);

  return KBrsrSuccess;

}

/*----------------------------------------------------------------------------------

 * MakeReqUrl

 *

 * Workaround for PDC Gateway issue -- we remanufacture the full destination from 

 * the history request url, not from the response url, for an intradeck 'go'

 *

 * returns KBrsrOutOfMemory

 *         KBrsrMalformedUrl

 *         KBrsrSuccess

 *---------------------------------------------------------------------------------*/

static TBrowserStatusCode MakeReqUrl(NW_Wml_t *thisObj, 

                              NW_Ucs2  *card_name,

                              NW_Ucs2 **patchedUrlReq)

{

  TBrowserStatusCode status;

  NW_Ucs2     *url;

  NW_ASSERT(thisObj != NULL);

  NW_ASSERT(patchedUrlReq != NULL);

  status = NW_Wml_HistoryGetRequestUrl(thisObj, &url);

  if (status == KBrsrOutOfMemory)

    return status;

  status = NW_Url_BuildAbsUrl(url, card_name, patchedUrlReq);

  NW_Str_Delete(url);

  return status;

}

/*----------------------------------------------------------------------

 * MoveToCard

 *

 * Positions the deck decoder to the given card, if possible. If not,

 * then the decoder is positioned to the first card in the deck,

 * per WML 1.2, section 12.5.1#4c.

 *

 * Note -- this works ok even if the card_name parameter is NULL.

 *

 * returns

 *    KBrsrSuccess

 *    KBrsrOutOfMemory

 *---------------------------------------------------------------------*/   

static TBrowserStatusCode MoveToCard(NW_Wml_t *thisObj, NW_Ucs2 *card_name)

{

  TBrowserStatusCode status = KBrsrSuccess; 

  NW_ASSERT(thisObj != NULL);

  if(thisObj->decoder != NULL)

    status = NW_DeckDecoder_SetCardByName(thisObj->decoder, card_name);

  if (status == KBrsrOutOfMemory)

      return status;  

  /* wrong card_name */

  if (status == KBrsrWmlbrowserCardNotInDeck) {

    /* Try using a NULL card_name to enforce WML 12.5.1#4c */

    status = NW_DeckDecoder_SetCardByName(thisObj->decoder, NULL);

  }

  return status;

}

/*--------------------------------------------------------------------------

 * ProcessIntraDeckGoTask

 *

 * NOTE -- the 'GO_TASK' case contains a workaround for a PDC gateway

 * issue.  Specifically the problem is this -- the PDC gateway sometimes

 * sends back a ContentLocation header indicating that the gateway (e.g.,

 * 'krell.uplanet.com') is the location of the redirected content.

 * Since we derive the 'response_url' from the ContentLocation header,

 * and we resolve relative references with respect to the response url,

 * we have a problem.

 *

 * So, in the case of an intradeck 'go', we need to manufacture a 

 * request URL that contains the real (originally requested)

 * deck URL, plus the _requested_ card name (which is part of reqUrl).

 * Then we need to manufacture a response URL that consists of the

 * request URL plus the _actual_ card that we are going to display (this

 * may or may not be the requested card, and it may or may not have a name).

 *

 * Suppose, for example, the current deck was requested as 

 * "http://foo/deck.wml#card1", and the response_url (derived from

 * the ContentLocation header) from the PDC gateway is 

 * "http://foo/krell.uplanet.com#card1".  Suppose further that the next

 * request from that card is to go to "#card2", but there isn't a 

 * 'card2', and that 'main' is the id of the first card in the deck.

 *

 * Then we need to manufacture a request url of "http://foo/deck.wml#card2"

 * and a response url of "http://foo/krell.uplanet.com#main".

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *-------------------------------------------------------------------------*/

static TBrowserStatusCode ProcessIntraDeckGoTask(NW_Wml_t *thisObj, 

                                          NW_Ucs2 *url, 

                                          NW_Bool updateHistory)

{

  NW_Ucs2     *cardName    = NULL;

  NW_Ucs2     *responseUrl = NULL;

  NW_Ucs2     *requestUrl  = NULL;

  TBrowserStatusCode status;

  NW_ASSERT(thisObj != NULL);

  NW_ASSERT(url != NULL);

  status = NW_DeckDecoder_GetCardName(thisObj->decoder, &cardName);

  if (status != KBrsrSuccess && status != KBrsrFailure)

    goto Exit;

  status = NW_Url_BuildAbsUrl(url,cardName,&responseUrl);

  if (status != KBrsrSuccess)

    goto Exit;

  status = MakeReqUrl(thisObj,NW_Url_Fragment(url),&requestUrl);

  if (status != KBrsrSuccess)

    goto Exit;

  /* now create and push a new History entry */

  if (updateHistory == NW_TRUE) {

    status = NW_Wml_HistoryPushIntraDeckLoad(thisObj, requestUrl, responseUrl);

    if (status != KBrsrSuccess && status != KBrsrFailure)

      goto Exit;

  }

  status = NW_Wml_ProcessGo(thisObj,responseUrl);

  if (status != KBrsrSuccess && status != KBrsrFailure)

    goto Exit;      /* FAILURE does not imply a fatal error */

  status = KBrsrSuccess;

Exit:

  NW_Str_Delete(cardName);

  NW_Str_Delete(requestUrl);

  NW_Str_Delete(responseUrl);

  return status;

}

/*-----------------------------------------------------------------------

 * ProcessIntraDeckFetchUrlTask

 *

 * Handles intradeck navigation tasks as indicated by the the 'curr_task'

 * member of the NW_Wml_t object.

 *

 * returns

 *  KBrsrSuccess

 *  anything else is an unrecoverable error

 *---------------------------------------------------------------------*/

static TBrowserStatusCode ProcessIntraDeckFetchUrlTask(NW_Wml_t *thisObj,

                                                NW_Ucs2  *reqUrl, 

                                                NW_Bool updateHistory)

{

  TBrowserStatusCode status;

  NW_Wml1x_ContentHandler_t* thisHandlerObj;

  NW_ASSERT(thisObj != NULL);

  status = NW_Wml_CancelAllLoads(thisObj);

	thisHandlerObj = NW_Wml1x_ContentHandlerOf(thisObj->browser_app);

  switch (thisObj->curr_task)

  {

    case GO_TASK:

      NW_ASSERT(reqUrl != NULL);

      status = ProcessIntraDeckGoTask(thisObj, reqUrl, updateHistory);

      break;

    case PREV_TASK:

      NW_ASSERT(reqUrl != NULL);

      status = NW_Wml_ProcessPrev(thisObj, reqUrl);

      if (status != KBrsrSuccess && status != KBrsrFailure)

        break;    /* FAILURE does not imply a fatal error */

      status = KBrsrSuccess;

      break;

    case REFRESH_TASK:

      status = NW_Wml_ProcessRefresh(thisObj);

      if (status != KBrsrSuccess && status != KBrsrFailure)

        break;   /* FAILURE does not imply a fatal error */

      status = KBrsrSuccess;

      break;

    case RESTORE_TASK:

      /* TODO do we need to do more to restore/restart a card */

			if(thisHandlerObj->contextSuspended)

			{

				/* apply the global variables to the wml interpreter */

				NW_DeckDecoder_ContextToVarList (thisHandlerObj->contextSuspended, thisHandlerObj->wmlInterpreter.var_list,

						thisHandlerObj->wmlInterpreter.mem_segment_general);

				/* clear the global variable context */

				NW_Object_Delete (thisHandlerObj->contextSuspended);

				thisHandlerObj->contextSuspended = NULL;

			}

      NW_Wml_DisplayCard(thisObj, NW_FALSE);

      status = NW_Wml_HandleTimer(thisObj);

      status = KBrsrSuccess;

      break;

    case INVALID_TASK:

    case NOOP_TASK:

    default:

      status = KBrsrFailure;

  }

  return status;

}

static TBrowserStatusCode NW_Wml_HandleIntraPageNavigationStarted (NW_Wml_t *thisObj)

{

  NW_HED_DocumentRoot_t* docRoot;

  docRoot = (NW_HED_DocumentRoot_t*) NW_HED_DocumentNode_GetRootNode (thisObj->browser_app);

  thisObj->outstandingLoadCount = 0;

  NW_LMgr_RootBox_t* rootBox = NW_HED_DocumentRoot_GetRootBox(docRoot);

  (void) NW_ADT_DynamicVector_Clear(rootBox->iOutOfViewListeners);

  return NW_HED_DocumentRoot_HandleIntraPageNavigationStarted (docRoot);

}

static TBrowserStatusCode NW_Wml_HandleIntraPageNavigationCompleted (NW_Wml_t *thisObj)

{

  NW_HED_DocumentRoot_t* docRoot;

  docRoot = (NW_HED_DocumentRoot_t*) NW_HED_DocumentNode_GetRootNode (thisObj->browser_app);

  if (thisObj->IntraDeck_OefCounter > MAX_NUMBER_INTRA_OEF) {

    /* we have exceeded the maximunm # of OnEnterForwards allowable for the deck 

       The error will be handled after we process the deck - Vishy05/14/2002

    */

    docRoot->isIntraPageNav--;

    return KBrsrSuccess;

  }

  else {

    return NW_HED_DocumentRoot_HandleIntraPageNavigationCompleted (docRoot);

  }

}

TBrowserStatusCode NW_Wml_HandleIntraDocRequest (NW_Wml_t *thisObj, 

                                          NW_Wml_Task_e task,

                                          NW_Bool historicRequest,

                                          const NW_Ucs2 *url)

{

  TBrowserStatusCode status = KBrsrWmlbrowserCardNotInDeck;

  NW_Bool mustCallCompleted = NW_FALSE;

  NW_Bool cardNotFound = NW_FALSE;

  NW_Wml1x_ContentHandler_t* wmlCH;

  /* set the wml-task */

  thisObj->curr_task = task;

  if(task != RESTORE_TASK)

  {

    wmlCH = NW_Wml1x_ContentHandlerOf(thisObj->browser_app);

	NW_Object_Delete (wmlCH->contextSuspended);

	/* copy the suspended context */

	wmlCH->contextSuspended = NW_DeckDecoder_VarListToContext(wmlCH->wmlInterpreter.var_list);

  }

  /* notify the docRoot that we are performing an intra-document navigation */

  NW_Wml_HandleIntraPageNavigationStarted (thisObj);

  mustCallCompleted = NW_TRUE;

  /* set the card.  The url will be NULL when we are "restoring" a card */

  if (url != NULL) {

    NW_String_t cardName;

    /* if the intra-nav dest card is not found, it is not a fatal error */

    /* see WML-191, section 12.5.1.4 */

    NW_String_initialize (&cardName, NW_Url_Fragment((NW_Ucs2 *) url), HTTP_iso_10646_ucs_2);

    if (cardName.storage != NULL) {

      if (!NW_Wml_Deck_GetCardByName (thisObj->decoder->domDeck, &cardName))

      {

        cardNotFound = NW_TRUE;

      }

    }

    /* set the current card */

    NW_THROWIF_ERROR (status = MoveToCard(thisObj, NW_Url_Fragment((NW_Ucs2 *) url)));

  }

  /* show the intra-deck card */

  NW_THROWIF_ERROR (status = ProcessIntraDeckFetchUrlTask(thisObj, (NW_Ucs2 *) url, 

      (NW_Bool) (historicRequest == NW_FALSE)));

  /* notify the docRoot that we are done navigating */

  NW_Wml_HandleIntraPageNavigationCompleted (thisObj);

  if (cardNotFound == NW_TRUE) /* if the requested card was not found - WML-191, 12.5.1.4 is followed, */

  {                            /* and notify user that a nav exception has occured, to let them know. */

    NW_Wml_HandleError (thisObj, BRSR_STAT_CLASS_GENERAL, (NW_Int16) KBrsrWmlbrowserCardNotInDeck);

  }

  /* When we restore a previous document we do not want to start the timers again! - Vishy 07/02/2002 */

  if(task == RESTORE_TASK) {    

    wmlCH = NW_Wml1x_ContentHandlerOf(thisObj->browser_app);

    (void) (wmlCH->wmlInterpreter).wml_api->timer->destroy(wmlCH);

    wmlCH->allowTimer = NW_FALSE;

  }