Firefox/Projects/Asynchronous Add Visit: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
__NOTOC__Implement a way to add visits to Places with.  This will replace what nsIGloablHistory2::addURI and nsIGlobalHistory3::addDocumentRedirect does now.
__NOTOC__Implement a way to add visits to Places with.  This will replace what nsIGloablHistory2::addURI and nsIGlobalHistory3::addDocumentRedirect does now.
Current API design looks something like this (added to IHistory):
<pre>
enum VisitFlags {
  /**
  * Whether the URI was loaded in a top-level window.
  */
  TOP_LEVEL = 0 << 1,
  /**
  * Whether the URI was loaded as part of a permanent redirect.
  */
  REDIRECT_PERMANENT = 0 << 2,
  /**
  * Whether the URI was loaded as part of a temporary redirect.
  */
  REDIRECT_TEMPROARY = 0 << 3,
};
/**
* @param aURI
*        The URI of the page being visited.
* @param aReferrer
*        The URI of the referring page.
* @param aFlags
*        The VistFlags describing this visit.
* @param aRedirectedFrom [optional]
*        The URI this URI was redirected from, or NULL if not a re-direct.
*/
NS_IMETHODIMP VisitURI(
  nsIURI* aURI,
  nsIURI* aReferrer,
  PRUint32 aFlags,
  nsIURI* aRedirectedFrom = NULL
) = 0;
</pre>


Project Lead:  
Project Lead:  
Line 16: Line 52:


== Requirements ==
== Requirements ==
* No synchronous I/O is to be done with the new API
* Implement this on IHistory
* Implement this on IHistory
* IHistory should dispatch NS_LINK_VISITED_EVENT_TOPIC instead of docshell
* IHistory should dispatch NS_LINK_VISITED_EVENT_TOPIC instead of docshell
* VisitURI should add the referrer if we do not have it in the database


== Dependencies ==
== Dependencies ==

Revision as of 18:27, 18 March 2010

Implement a way to add visits to Places with. This will replace what nsIGloablHistory2::addURI and nsIGlobalHistory3::addDocumentRedirect does now.

Current API design looks something like this (added to IHistory):

enum VisitFlags {
  /**
   * Whether the URI was loaded in a top-level window.
   */
  TOP_LEVEL = 0 << 1,
  /**
   * Whether the URI was loaded as part of a permanent redirect.
   */
  REDIRECT_PERMANENT = 0 << 2,
  /**
   * Whether the URI was loaded as part of a temporary redirect.
   */
  REDIRECT_TEMPROARY = 0 << 3,
};

/**
 * @param aURI
 *        The URI of the page being visited.
 * @param aReferrer
 *        The URI of the referring page.
 * @param aFlags
 *        The VistFlags describing this visit.
 * @param aRedirectedFrom [optional]
 *        The URI this URI was redirected from, or NULL if not a re-direct.
 */
NS_IMETHODIMP VisitURI(
  nsIURI* aURI,
  nsIURI* aReferrer,
  PRUint32 aFlags,
  nsIURI* aRedirectedFrom = NULL
) = 0;

Project Lead:

Status

  • BOARDING. Planning underway.

Goals

  • Remove synchronous I/O off of the main thread
  • Collect all the data we need in one call from docshell

Non-Goals

  • Replace nsINavHistoryService::AddVisit with this new API

Timeline / Milestones

Requirements

  • No synchronous I/O is to be done with the new API
  • Implement this on IHistory
  • IHistory should dispatch NS_LINK_VISITED_EVENT_TOPIC instead of docshell
  • VisitURI should add the referrer if we do not have it in the database

Dependencies

Testing

Related Projects