зеркало из https://github.com/mozilla/pjs.git
Bug 331985 r=annie.sullivan Don't save favicons when history is disabled.
This commit is contained in:
brettw%gmail.com
Родитель
84874617f6
Коммит
7be423dc81
|
|
@ -1,926 +0,0 @@
|
||||||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
||||||
/* ***** BEGIN LICENSE BLOCK *****
|
|
||||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
||||||
*
|
|
||||||
* The contents of this file are subject to the Mozilla Public License Version
|
|
||||||
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
||||||
* the License. You may obtain a copy of the License at
|
|
||||||
* http://www.mozilla.org/MPL/
|
|
||||||
*
|
|
||||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
||||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
||||||
* for the specific language governing rights and limitations under the
|
|
||||||
* License.
|
|
||||||
*
|
|
||||||
* The Original Code is Places.
|
|
||||||
*
|
|
||||||
* The Initial Developer of the Original Code is
|
|
||||||
* Google Inc.
|
|
||||||
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
||||||
* the Initial Developer. All Rights Reserved.
|
|
||||||
*
|
|
||||||
* Contributor(s):
|
|
||||||
* Brett Wilson <brettw@gmail.com> (original author)
|
|
||||||
*
|
|
||||||
* Alternatively, the contents of this file may be used under the terms of
|
|
||||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
||||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
||||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
||||||
* of those above. If you wish to allow use of your version of this file only
|
|
||||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
||||||
* use your version of this file under the terms of the MPL, indicate your
|
|
||||||
* decision by deleting the provisions above and replace them with the notice
|
|
||||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
||||||
* the provisions above, a recipient may use your version of this file under
|
|
||||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
||||||
*
|
|
||||||
* ***** END LICENSE BLOCK ***** */
|
|
||||||
|
|
||||||
/**
|
|
||||||
* This is the favicon service, which stores favicons for web pages with your
|
|
||||||
* history as you browse. It is also used to save the favicons for bookmarks.
|
|
||||||
*
|
|
||||||
* DANGER: The history query system makes assumptions about the favicon storage
|
|
||||||
* so that icons can be quickly generated for history/bookmark result sets. If
|
|
||||||
* you change the database layout at all, you will have to update both services.
|
|
||||||
*/
|
|
||||||
|
|
||||||
#include "nsFaviconService.h"
|
|
||||||
#include "nsICacheVisitor.h"
|
|
||||||
#include "nsICachingChannel.h"
|
|
||||||
#include "nsICategoryManager.h"
|
|
||||||
#include "nsIChannelEventSink.h"
|
|
||||||
#include "nsIContentSniffer.h"
|
|
||||||
#include "nsIInterfaceRequestor.h"
|
|
||||||
#include "nsIStreamListener.h"
|
|
||||||
#include "nsISupportsPrimitives.h"
|
|
||||||
#include "nsNavBookmarks.h"
|
|
||||||
#include "nsNavHistory.h"
|
|
||||||
#include "nsNetUtil.h"
|
|
||||||
#include "nsReadableUtils.h"
|
|
||||||
#include "nsStreamUtils.h"
|
|
||||||
#include "mozStorageHelper.h"
|
|
||||||
|
|
||||||
// This is the maximum favicon size that we will bother storing. Most icons
|
|
||||||
// are about 4K. Some people add 32x32 versions at different bit depths,
|
|
||||||
// making them much bigger. It would be nice if could extract just the 16x16
|
|
||||||
// version that we need. Instead, we'll just store everything below this
|
|
||||||
// sanity threshold.
|
|
||||||
#define MAX_FAVICON_SIZE 32768
|
|
||||||
|
|
||||||
#define FAVICON_BUFFER_INCREMENT 8192
|
|
||||||
|
|
||||||
#define MAX_FAVICON_CACHE_SIZE 512
|
|
||||||
#define FAVICON_CACHE_REDUCE_COUNT 64
|
|
||||||
|
|
||||||
#define CONTENT_SNIFFING_SERVICES "content-sniffing-services"
|
|
||||||
|
|
||||||
|
|
||||||
class FaviconLoadListener : public nsIStreamListener,
|
|
||||||
public nsIInterfaceRequestor,
|
|
||||||
public nsIChannelEventSink
|
|
||||||
{
|
|
||||||
public:
|
|
||||||
FaviconLoadListener(nsFaviconService* aFaviconService,
|
|
||||||
nsIURI* aPageURI, nsIURI* aFaviconURI,
|
|
||||||
nsIChannel* aChannel);
|
|
||||||
|
|
||||||
NS_DECL_ISUPPORTS
|
|
||||||
NS_DECL_NSIREQUESTOBSERVER
|
|
||||||
NS_DECL_NSISTREAMLISTENER
|
|
||||||
NS_DECL_NSIINTERFACEREQUESTOR
|
|
||||||
NS_DECL_NSICHANNELEVENTSINK
|
|
||||||
|
|
||||||
private:
|
|
||||||
~FaviconLoadListener();
|
|
||||||
|
|
||||||
nsCOMPtr<nsFaviconService> mFaviconService;
|
|
||||||
nsCOMPtr<nsIChannel> mChannel;
|
|
||||||
nsCOMPtr<nsIURI> mPageURI;
|
|
||||||
nsCOMPtr<nsIURI> mFaviconURI;
|
|
||||||
|
|
||||||
nsCString mData;
|
|
||||||
};
|
|
||||||
|
|
||||||
|
|
||||||
nsFaviconService* nsFaviconService::gFaviconService;
|
|
||||||
|
|
||||||
NS_IMPL_ISUPPORTS1(nsFaviconService, nsIFaviconService)
|
|
||||||
|
|
||||||
// nsFaviconService::nsFaviconService
|
|
||||||
|
|
||||||
nsFaviconService::nsFaviconService() : mFailedFaviconSerial(0)
|
|
||||||
{
|
|
||||||
NS_ASSERTION(! gFaviconService, "ATTEMPTING TO CREATE TWO FAVICON SERVICES!");
|
|
||||||
gFaviconService = this;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::~nsFaviconService
|
|
||||||
|
|
||||||
nsFaviconService::~nsFaviconService()
|
|
||||||
{
|
|
||||||
NS_ASSERTION(gFaviconService == this, "Deleting a non-singleton favicon service");
|
|
||||||
if (gFaviconService == this)
|
|
||||||
gFaviconService = nsnull;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::Init
|
|
||||||
//
|
|
||||||
// Called when the service is created.
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::Init()
|
|
||||||
{
|
|
||||||
nsresult rv;
|
|
||||||
|
|
||||||
nsNavHistory* historyService = nsNavHistory::GetHistoryService();
|
|
||||||
NS_ENSURE_TRUE(historyService, NS_ERROR_OUT_OF_MEMORY);
|
|
||||||
mDBConn = historyService->GetStorageConnection();
|
|
||||||
NS_ENSURE_TRUE(mDBConn, NS_ERROR_FAILURE);
|
|
||||||
|
|
||||||
// creation of history service will have called InitTables before now
|
|
||||||
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("SELECT id, length(data), expiration FROM moz_favicon WHERE url = ?1"),
|
|
||||||
getter_AddRefs(mDBGetIconInfo));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("SELECT f.id, f.url, length(f.data), f.expiration FROM moz_history h JOIN moz_favicon f ON h.favicon = f.id WHERE h.url = ?1"),
|
|
||||||
getter_AddRefs(mDBGetURL));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("SELECT f.data, f.mime_type FROM moz_favicon f WHERE url = ?1"),
|
|
||||||
getter_AddRefs(mDBGetData));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("INSERT INTO moz_favicon (url, data, mime_type, expiration) VALUES (?1, ?2, ?3, ?4)"),
|
|
||||||
getter_AddRefs(mDBInsertIcon));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("UPDATE moz_favicon SET data = ?2, mime_type = ?3, expiration = ?4 where id = ?1"),
|
|
||||||
getter_AddRefs(mDBUpdateIcon));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBConn->CreateStatement(NS_LITERAL_CSTRING("UPDATE moz_history SET favicon = ?2 WHERE id = ?1"),
|
|
||||||
getter_AddRefs(mDBSetPageFavicon));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// failed favicon cache
|
|
||||||
if (! mFailedFavicons.Init(256))
|
|
||||||
return NS_ERROR_OUT_OF_MEMORY;
|
|
||||||
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::InitTables
|
|
||||||
//
|
|
||||||
// Called by the history service to create the favicon table. The history
|
|
||||||
// service uses this table in its queries, so it must exist even if
|
|
||||||
// nobody has called the favicon service.
|
|
||||||
|
|
||||||
nsresult // static
|
|
||||||
nsFaviconService::InitTables(mozIStorageConnection* aDBConn)
|
|
||||||
{
|
|
||||||
nsresult rv;
|
|
||||||
PRBool exists = PR_FALSE;
|
|
||||||
aDBConn->TableExists(NS_LITERAL_CSTRING("moz_favicon"), &exists);
|
|
||||||
if (! exists) {
|
|
||||||
rv = aDBConn->ExecuteSimpleSQL(NS_LITERAL_CSTRING("CREATE TABLE moz_favicon (id INTEGER PRIMARY KEY, url LONGVARCHAR UNIQUE, data BLOB, mime_type VARCHAR(32), expiration LONG)"));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = aDBConn->ExecuteSimpleSQL(NS_LITERAL_CSTRING("CREATE INDEX moz_favicon_url ON moz_favicon (url)"));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::SetFaviconUrlForPage
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::SetFaviconUrlForPage(nsIURI* aPage, nsIURI* aFavicon)
|
|
||||||
{
|
|
||||||
// we don't care whether there was data or what the expiration was
|
|
||||||
PRBool hasData;
|
|
||||||
PRTime expiration;
|
|
||||||
nsresult rv = SetFaviconUrlForPageInternal(aPage, aFavicon,
|
|
||||||
&hasData, &expiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// send favicon change notifications if the URL has any data
|
|
||||||
if (hasData)
|
|
||||||
SendFaviconNotifications(aPage, aFavicon);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::SetFaviconUrlForPageInternal
|
|
||||||
//
|
|
||||||
// This creates a new entry in the favicon table if necessary and tells the
|
|
||||||
// history service to associate the given favicon ID with the given URL. We
|
|
||||||
// don't want to update the history table directly since that may involve
|
|
||||||
// creating a new row in the history table, which should only be done by
|
|
||||||
// history.
|
|
||||||
//
|
|
||||||
// This sets aHasData if there was already icon data for this favicon. Used
|
|
||||||
// to know if we should try reloading.
|
|
||||||
//
|
|
||||||
// Expiration will be 0 if the icon has not been set yet.
|
|
||||||
//
|
|
||||||
// Does NOT send out notifications. Caller should send out notifications
|
|
||||||
// if the favicon has data.
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::SetFaviconUrlForPageInternal(nsIURI* aPage, nsIURI* aFavicon,
|
|
||||||
PRBool* aHasData,
|
|
||||||
PRTime* aExpiration)
|
|
||||||
{
|
|
||||||
mozStorageStatementScoper scoper(mDBGetIconInfo);
|
|
||||||
mozStorageTransaction transaction(mDBConn, PR_FALSE);
|
|
||||||
nsresult rv = BindStatementURI(mDBGetIconInfo, 0, aFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasResult;
|
|
||||||
rv = mDBGetIconInfo->ExecuteStep(&hasResult);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRInt64 iconId;
|
|
||||||
if (hasResult) {
|
|
||||||
// have an entry for this icon already, just get the stats
|
|
||||||
rv = mDBGetIconInfo->GetInt64(0, &iconId);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// see if there's data already
|
|
||||||
PRInt32 dataSize;
|
|
||||||
rv = mDBGetIconInfo->GetInt32(1, &dataSize);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (dataSize > 0)
|
|
||||||
*aHasData = PR_TRUE;
|
|
||||||
|
|
||||||
// expiration
|
|
||||||
rv = mDBGetIconInfo->GetInt64(2, aExpiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
mDBGetIconInfo->Reset();
|
|
||||||
scoper.Abandon();
|
|
||||||
} else {
|
|
||||||
// create a new icon entry
|
|
||||||
mDBGetIconInfo->Reset();
|
|
||||||
scoper.Abandon();
|
|
||||||
|
|
||||||
*aHasData = PR_FALSE;
|
|
||||||
*aExpiration = 0;
|
|
||||||
|
|
||||||
// no entry for this icon yet, create it
|
|
||||||
mozStorageStatementScoper scoper2(mDBInsertIcon);
|
|
||||||
rv = BindStatementURI(mDBInsertIcon, 0, aFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
mDBInsertIcon->BindNullParameter(1);
|
|
||||||
mDBInsertIcon->BindNullParameter(2);
|
|
||||||
mDBInsertIcon->BindNullParameter(3);
|
|
||||||
rv = mDBInsertIcon->Execute();
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
rv = mDBConn->GetLastInsertRowID(&iconId);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
|
|
||||||
// now link our entry with the history service
|
|
||||||
nsNavHistory* historyService = nsNavHistory::GetHistoryService();
|
|
||||||
NS_ENSURE_TRUE(historyService, NS_ERROR_NO_INTERFACE);
|
|
||||||
|
|
||||||
PRInt64 pageId;
|
|
||||||
rv = historyService->GetUrlIdFor(aPage, &pageId, PR_TRUE);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
mozStorageStatementScoper scoper2(mDBSetPageFavicon);
|
|
||||||
rv = mDBSetPageFavicon->BindInt64Parameter(0, pageId);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBSetPageFavicon->BindInt64Parameter(1, iconId);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = mDBSetPageFavicon->Execute();
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
transaction.Commit();
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::UpdateBookmarkRedirectFavicon
|
|
||||||
//
|
|
||||||
// It is not uncommon to have a bookmark (usually manually entered or
|
|
||||||
// modified) that redirects to some other page. For example, "mozilla.org"
|
|
||||||
// redirects to "www.mozilla.org". We want that bookmark's favicon to get
|
|
||||||
// updated. So, we see if this URI has a bookmark redirect and set the
|
|
||||||
// favicon there as well.
|
|
||||||
//
|
|
||||||
// This should be called only when we know there is data for the favicon
|
|
||||||
// already loaded. We will always send out notifications for the bookmarked
|
|
||||||
// page.
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::UpdateBookmarkRedirectFavicon(nsIURI* aPage, nsIURI* aFavicon)
|
|
||||||
{
|
|
||||||
NS_ENSURE_TRUE(aPage, NS_ERROR_INVALID_ARG);
|
|
||||||
NS_ENSURE_TRUE(aFavicon, NS_ERROR_INVALID_ARG);
|
|
||||||
|
|
||||||
nsNavBookmarks* bookmarks = nsNavBookmarks::GetBookmarksService();
|
|
||||||
NS_ENSURE_TRUE(bookmarks, NS_ERROR_UNEXPECTED);
|
|
||||||
|
|
||||||
nsCOMPtr<nsIURI> bookmarkURI;
|
|
||||||
nsresult rv = bookmarks->GetBookmarkedURIFor(aPage, getter_AddRefs(bookmarkURI));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (! bookmarkURI)
|
|
||||||
return NS_OK; // no bookmark redirect
|
|
||||||
|
|
||||||
PRBool sameAsBookmark;
|
|
||||||
if (NS_SUCCEEDED(bookmarkURI->Equals(aPage, &sameAsBookmark)) && sameAsBookmark)
|
|
||||||
return NS_OK; // bookmarked directly, not through a redirect
|
|
||||||
|
|
||||||
PRBool hasData = PR_FALSE;
|
|
||||||
PRTime expiration = 0;
|
|
||||||
rv = SetFaviconUrlForPageInternal(bookmarkURI, aFavicon, &hasData, &expiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
if (hasData) {
|
|
||||||
// send notifications
|
|
||||||
SendFaviconNotifications(bookmarkURI, aFavicon);
|
|
||||||
} else {
|
|
||||||
NS_WARNING("Calling UpdateBookmarkRedirectFavicon when you don't have data for the favicon yet.");
|
|
||||||
}
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::SendFaviconNotifications
|
|
||||||
//
|
|
||||||
// Call to send out favicon changed notifications. Shuold only be called
|
|
||||||
// when you know there is data loaded for the favicon.
|
|
||||||
|
|
||||||
void
|
|
||||||
nsFaviconService::SendFaviconNotifications(nsIURI* aPage, nsIURI* aFaviconURI)
|
|
||||||
{
|
|
||||||
nsCAutoString faviconSpec;
|
|
||||||
nsNavHistory* historyService = nsNavHistory::GetHistoryService();
|
|
||||||
if (historyService && NS_SUCCEEDED(aFaviconURI->GetSpec(faviconSpec))) {
|
|
||||||
historyService->SendPageChangedNotification(aPage,
|
|
||||||
nsINavHistoryObserver::ATTRIBUTE_FAVICON,
|
|
||||||
NS_ConvertUTF8toUTF16(faviconSpec));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::SetAndLoadFaviconForPage
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::SetAndLoadFaviconForPage(nsIURI* aPage, nsIURI* aFavicon,
|
|
||||||
PRBool aForceReload)
|
|
||||||
{
|
|
||||||
#ifdef LAZY_ADD
|
|
||||||
nsNavHistory* historyService = nsNavHistory::GetHistoryService();
|
|
||||||
NS_ENSURE_TRUE(historyService, NS_ERROR_OUT_OF_MEMORY);
|
|
||||||
return historyService->AddLazyLoadFaviconMessage(aPage, aFavicon,
|
|
||||||
aForceReload);
|
|
||||||
#else
|
|
||||||
return DoSetAndLoadFaviconForPage(aPage, aFavicon, aForceReload);
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::DoSetAndLoadFaviconForPage
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::DoSetAndLoadFaviconForPage(nsIURI* aPage, nsIURI* aFavicon,
|
|
||||||
PRBool aForceReload)
|
|
||||||
{
|
|
||||||
// check the failed favicon cache
|
|
||||||
PRBool previouslyFailed;
|
|
||||||
nsresult rv = IsFailedFavicon(aFavicon, &previouslyFailed);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (previouslyFailed) {
|
|
||||||
if (aForceReload)
|
|
||||||
RemoveFailedFavicon(aFavicon); // force reload clears from failed cache
|
|
||||||
else
|
|
||||||
return NS_OK; // ignore previously failed favicons
|
|
||||||
}
|
|
||||||
|
|
||||||
// filter out bad URLs
|
|
||||||
nsNavHistory* history = nsNavHistory::GetHistoryService();
|
|
||||||
NS_ENSURE_TRUE(history, NS_ERROR_FAILURE);
|
|
||||||
PRBool canAdd;
|
|
||||||
rv = history->CanAddURI(aPage, &canAdd);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (! canAdd)
|
|
||||||
return NS_OK; // ignore favicons for this url
|
|
||||||
|
|
||||||
// If have an image loaded in the main frame, that image will get set as its
|
|
||||||
// own favicon. It would be nice to store a resampled version of the image,
|
|
||||||
// but that's prohibitive for now. This workaround just refuses to save the
|
|
||||||
// favicon in this case.
|
|
||||||
PRBool pageEqualsFavicon;
|
|
||||||
rv = aPage->Equals(aFavicon, &pageEqualsFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (pageEqualsFavicon)
|
|
||||||
return NS_OK;
|
|
||||||
|
|
||||||
// ignore data URL favicons. The main case here is the error page, which uses
|
|
||||||
// a data URL as the favicon. The result is that we get the data URL in the
|
|
||||||
// favicon table associated with the decoded version of the data URL.
|
|
||||||
PRBool isDataURL;
|
|
||||||
rv = aFavicon->SchemeIs("data", &isDataURL);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (isDataURL)
|
|
||||||
return NS_OK;
|
|
||||||
|
|
||||||
// See if we have data and get the expiration time for this favicon. It might
|
|
||||||
// be nice to say SetFaviconUrlForPageInternal here but we DON'T want to set
|
|
||||||
// the favicon for the page unless we know we have it. For example, if I go
|
|
||||||
// to random site x.com, the browser will still tell us that the favicon is
|
|
||||||
// x.com/favicon.ico even if there is no such file. We don't want to pollute
|
|
||||||
// our tables with this useless data.
|
|
||||||
PRBool hasData = PR_FALSE;
|
|
||||||
PRTime expiration = 0;
|
|
||||||
{ // scope for statement
|
|
||||||
mozStorageStatementScoper scoper(mDBGetIconInfo);
|
|
||||||
rv = BindStatementURI(mDBGetIconInfo, 0, aFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasMatch;
|
|
||||||
rv = mDBGetIconInfo->ExecuteStep(&hasMatch);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (hasMatch) {
|
|
||||||
PRInt32 dataSize;
|
|
||||||
mDBGetIconInfo->GetInt32(1, &dataSize);
|
|
||||||
hasData = dataSize > 0;
|
|
||||||
mDBGetIconInfo->GetInt64(2, &expiration);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// See if this favicon has expired yet. We don't want to waste time reloading
|
|
||||||
// from the web or cache if we have a recent version.
|
|
||||||
PRTime now = PR_Now();
|
|
||||||
if (hasData && now < expiration && ! aForceReload) {
|
|
||||||
// data still valid, no need to reload
|
|
||||||
|
|
||||||
// For page revisits (pretty common) we DON'T want to send out any
|
|
||||||
// notifications if we've already set the favicon. These notifications will
|
|
||||||
// cause parts of the UI to update and will be slow. This also saves us a
|
|
||||||
// database write in these cases.
|
|
||||||
nsCOMPtr<nsIURI> oldFavicon;
|
|
||||||
PRBool faviconsEqual;
|
|
||||||
if (NS_SUCCEEDED(GetFaviconForPage(aPage, getter_AddRefs(oldFavicon))) &&
|
|
||||||
NS_SUCCEEDED(aFavicon->Equals(oldFavicon, &faviconsEqual)) &&
|
|
||||||
faviconsEqual)
|
|
||||||
return NS_OK; // already set
|
|
||||||
|
|
||||||
// This will associate the favicon URL with the page.
|
|
||||||
rv = SetFaviconUrlForPageInternal(aPage, aFavicon, &hasData, &expiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
SendFaviconNotifications(aPage, aFavicon);
|
|
||||||
UpdateBookmarkRedirectFavicon(aPage, aFavicon);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
nsCOMPtr<nsIIOService> ioservice = do_GetIOService(&rv);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCOMPtr<nsIChannel> channel;
|
|
||||||
rv = ioservice->NewChannelFromURI(aFavicon, getter_AddRefs(channel));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCOMPtr<nsIStreamListener> listener =
|
|
||||||
new FaviconLoadListener(this, aPage, aFavicon, channel);
|
|
||||||
NS_ENSURE_TRUE(listener, NS_ERROR_OUT_OF_MEMORY);
|
|
||||||
nsCOMPtr<nsIInterfaceRequestor> listenerRequestor =
|
|
||||||
do_QueryInterface(listener, &rv);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
rv = channel->SetNotificationCallbacks(listenerRequestor);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = channel->AsyncOpen(listener, nsnull);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// DB will be update and observers will be notified when the data has
|
|
||||||
// finished loading
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::SetFaviconData
|
|
||||||
//
|
|
||||||
// See the IDL for this function for lots of info. Note from there: we don't
|
|
||||||
// send out notifications.
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::SetFaviconData(nsIURI* aFavicon, const PRUint8* aData,
|
|
||||||
PRUint32 aDataLen, const nsACString& aMimeType,
|
|
||||||
PRTime aExpiration)
|
|
||||||
{
|
|
||||||
nsresult rv;
|
|
||||||
mozIStorageStatement* statement;
|
|
||||||
{
|
|
||||||
// this block forces the scoper to reset our statement: necessary for the
|
|
||||||
// next statement
|
|
||||||
mozStorageStatementScoper scoper(mDBGetIconInfo);
|
|
||||||
rv = BindStatementURI(mDBGetIconInfo, 0, aFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasResult;
|
|
||||||
rv = mDBGetIconInfo->ExecuteStep(&hasResult);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
if (hasResult) {
|
|
||||||
// update old one (statement parameter 0 = ID)
|
|
||||||
PRInt64 id;
|
|
||||||
rv = mDBGetIconInfo->GetInt64(0, &id);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
statement = mDBUpdateIcon;
|
|
||||||
rv = statement->BindInt64Parameter(0, id);
|
|
||||||
} else {
|
|
||||||
// insert new one (statement parameter 0 = favicon URL)
|
|
||||||
statement = mDBInsertIcon;
|
|
||||||
rv = BindStatementURI(statement, 0, aFavicon);
|
|
||||||
}
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
|
|
||||||
mozStorageStatementScoper scoper(statement);
|
|
||||||
|
|
||||||
// the insert and update statements share all but the 0th parameter
|
|
||||||
rv = statement->BindBlobParameter(1, aData, aDataLen);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = statement->BindUTF8StringParameter(2, aMimeType);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
rv = statement->BindInt64Parameter(3, aExpiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
return statement->Execute();
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconData
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::GetFaviconData(nsIURI* aFavicon, nsACString& aMimeType,
|
|
||||||
PRUint32* aDataLen, PRUint8** aData)
|
|
||||||
{
|
|
||||||
mozStorageStatementScoper scoper(mDBGetData);
|
|
||||||
nsresult rv = BindStatementURI(mDBGetData, 0, aFavicon);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasResult;
|
|
||||||
rv = mDBGetData->ExecuteStep(&hasResult);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (! hasResult)
|
|
||||||
return NS_ERROR_NOT_AVAILABLE;
|
|
||||||
|
|
||||||
rv = mDBGetData->GetUTF8String(1, aMimeType);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
return mDBGetData->GetBlob(0, aDataLen, aData);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconForPage
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::GetFaviconForPage(nsIURI* aPage, nsIURI** _retval)
|
|
||||||
{
|
|
||||||
mozStorageStatementScoper scoper(mDBGetURL);
|
|
||||||
nsresult rv = BindStatementURI(mDBGetURL, 0, aPage);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasResult;
|
|
||||||
rv = mDBGetURL->ExecuteStep(&hasResult);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (! hasResult)
|
|
||||||
return NS_ERROR_NOT_AVAILABLE;
|
|
||||||
|
|
||||||
nsCAutoString url;
|
|
||||||
rv = mDBGetURL->GetUTF8String(1, url);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
return NS_NewURI(_retval, url);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconImageForPage
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::GetFaviconImageForPage(nsIURI* aPage, nsIURI** _retval)
|
|
||||||
{
|
|
||||||
mozStorageStatementScoper scoper(mDBGetURL);
|
|
||||||
nsresult rv = BindStatementURI(mDBGetURL, 0, aPage);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRBool hasResult;
|
|
||||||
rv = mDBGetURL->ExecuteStep(&hasResult);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
nsCOMPtr<nsIURI> faviconURI;
|
|
||||||
if (hasResult)
|
|
||||||
{
|
|
||||||
PRInt32 dataLen;
|
|
||||||
rv = mDBGetURL->GetInt32(2, &dataLen);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
if (dataLen > 0) {
|
|
||||||
// this page has a favicon entry with data
|
|
||||||
nsCAutoString favIconUri;
|
|
||||||
rv = mDBGetURL->GetUTF8String(1, favIconUri);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
return GetFaviconLinkForIconString(favIconUri, _retval);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// not found, use default
|
|
||||||
if (! mDefaultIcon) {
|
|
||||||
nsresult rv = NS_NewURI(getter_AddRefs(mDefaultIcon),
|
|
||||||
NS_LITERAL_CSTRING(FAVICON_DEFAULT_URL));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
return mDefaultIcon->Clone(_retval);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconLinkForIcon
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::GetFaviconLinkForIcon(nsIURI* aIcon, nsIURI** aOutput)
|
|
||||||
{
|
|
||||||
nsCAutoString spec;
|
|
||||||
if (aIcon) {
|
|
||||||
nsresult rv = aIcon->GetSpec(spec);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
return GetFaviconLinkForIconString(spec, aOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::AddFailedFavicon
|
|
||||||
|
|
||||||
PR_STATIC_CALLBACK(PLDHashOperator)
|
|
||||||
ExpireFailedFaviconsCallback(nsCStringHashKey::KeyType aKey,
|
|
||||||
PRUint32& aData,
|
|
||||||
void* userArg)
|
|
||||||
{
|
|
||||||
PRUint32* threshold = NS_REINTERPRET_CAST(PRUint32*, userArg);
|
|
||||||
if (aData < *threshold)
|
|
||||||
return PL_DHASH_REMOVE;
|
|
||||||
return PL_DHASH_NEXT;
|
|
||||||
}
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::AddFailedFavicon(nsIURI* aIcon)
|
|
||||||
{
|
|
||||||
nsCAutoString spec;
|
|
||||||
nsresult rv = aIcon->GetSpec(spec);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
if (! mFailedFavicons.Put(spec, mFailedFaviconSerial))
|
|
||||||
return NS_ERROR_OUT_OF_MEMORY;
|
|
||||||
mFailedFaviconSerial ++;
|
|
||||||
|
|
||||||
if (mFailedFavicons.Count() > MAX_FAVICON_CACHE_SIZE) {
|
|
||||||
// need to expire some entries, delete the FAVICON_CACHE_REDUCE_COUNT number
|
|
||||||
// of items that are the oldest
|
|
||||||
PRUint32 threshold = mFailedFaviconSerial -
|
|
||||||
MAX_FAVICON_CACHE_SIZE + FAVICON_CACHE_REDUCE_COUNT;
|
|
||||||
mFailedFavicons.Enumerate(ExpireFailedFaviconsCallback, &threshold);
|
|
||||||
}
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::RemoveFailedFavicon
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::RemoveFailedFavicon(nsIURI* aIcon)
|
|
||||||
{
|
|
||||||
nsCAutoString spec;
|
|
||||||
nsresult rv = aIcon->GetSpec(spec);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// we silently do nothing and succeed if the icon is not in the cache
|
|
||||||
mFailedFavicons.Remove(spec);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::IsFailedFavicon
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
nsFaviconService::IsFailedFavicon(nsIURI* aIcon, PRBool* _retval)
|
|
||||||
{
|
|
||||||
nsCAutoString spec;
|
|
||||||
nsresult rv = aIcon->GetSpec(spec);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
PRUint32 serial;
|
|
||||||
*_retval = mFailedFavicons.Get(spec, &serial);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconLinkForIconString
|
|
||||||
//
|
|
||||||
// This computes a favicon URL with string input and using the cached
|
|
||||||
// default one to minimize parsing.
|
|
||||||
|
|
||||||
nsresult
|
|
||||||
nsFaviconService::GetFaviconLinkForIconString(const nsCString& aSpec, nsIURI** aOutput)
|
|
||||||
{
|
|
||||||
if (aSpec.IsEmpty()) {
|
|
||||||
// default icon for empty strings
|
|
||||||
if (! mDefaultIcon) {
|
|
||||||
nsresult rv = NS_NewURI(getter_AddRefs(mDefaultIcon),
|
|
||||||
NS_LITERAL_CSTRING(FAVICON_DEFAULT_URL));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
}
|
|
||||||
return mDefaultIcon->Clone(aOutput);
|
|
||||||
}
|
|
||||||
|
|
||||||
if (StringBeginsWith(aSpec, NS_LITERAL_CSTRING("chrome:"))) {
|
|
||||||
// pass through for chrome URLs, since they can be referenced without
|
|
||||||
// this service
|
|
||||||
return NS_NewURI(aOutput, aSpec);
|
|
||||||
}
|
|
||||||
|
|
||||||
nsCAutoString annoUri;
|
|
||||||
annoUri.AssignLiteral("moz-anno:" FAVICON_ANNOTATION_NAME ":");
|
|
||||||
annoUri += aSpec;
|
|
||||||
return NS_NewURI(aOutput, annoUri);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// nsFaviconService::GetFaviconSpecForIconString
|
|
||||||
//
|
|
||||||
// This computes a favicon spec for when you don't want a URI object (as in
|
|
||||||
// the tree view implementation), sparing all parsing and normalization.
|
|
||||||
|
|
||||||
void
|
|
||||||
nsFaviconService::GetFaviconSpecForIconString(const nsCString& aSpec, nsACString& aOutput)
|
|
||||||
{
|
|
||||||
if (aSpec.IsEmpty()) {
|
|
||||||
aOutput.AssignLiteral(FAVICON_DEFAULT_URL);
|
|
||||||
} else if (StringBeginsWith(aSpec, NS_LITERAL_CSTRING("chrome:"))) {
|
|
||||||
aOutput = aSpec;
|
|
||||||
} else {
|
|
||||||
aOutput.AssignLiteral("moz-anno:" FAVICON_ANNOTATION_NAME ":");
|
|
||||||
aOutput += aSpec;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
NS_IMPL_ISUPPORTS3(FaviconLoadListener,
|
|
||||||
nsIStreamListener, // is a nsIRequestObserver
|
|
||||||
nsIInterfaceRequestor,
|
|
||||||
nsIChannelEventSink)
|
|
||||||
|
|
||||||
// FaviconLoadListener::FaviconLoadListener
|
|
||||||
|
|
||||||
FaviconLoadListener::FaviconLoadListener(nsFaviconService* aFaviconService,
|
|
||||||
nsIURI* aPageURI, nsIURI* aFaviconURI,
|
|
||||||
nsIChannel* aChannel) :
|
|
||||||
mFaviconService(aFaviconService),
|
|
||||||
mChannel(aChannel),
|
|
||||||
mPageURI(aPageURI),
|
|
||||||
mFaviconURI(aFaviconURI)
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::~FaviconLoadListener
|
|
||||||
|
|
||||||
FaviconLoadListener::~FaviconLoadListener()
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::OnStartRequest (nsIRequestObserver)
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
FaviconLoadListener::OnStartRequest(nsIRequest *aRequest, nsISupports *aContext)
|
|
||||||
{
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::OnStopRequest (nsIRequestObserver)
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
FaviconLoadListener::OnStopRequest(nsIRequest *aRequest, nsISupports *aContext,
|
|
||||||
nsresult aStatusCode)
|
|
||||||
{
|
|
||||||
if (NS_FAILED(aStatusCode) || mData.Length() == 0) {
|
|
||||||
// load failed, add to failed cache
|
|
||||||
mFaviconService->AddFailedFavicon(mFaviconURI);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
// sniff the MIME type
|
|
||||||
nsresult rv;
|
|
||||||
nsCOMPtr<nsICategoryManager> categoryManager =
|
|
||||||
do_GetService(NS_CATEGORYMANAGER_CONTRACTID, &rv);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
nsCOMPtr<nsISimpleEnumerator> sniffers;
|
|
||||||
rv = categoryManager->EnumerateCategory(CONTENT_SNIFFING_SERVICES,
|
|
||||||
getter_AddRefs(sniffers));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCString mimeType;
|
|
||||||
PRBool hasMore = PR_FALSE;
|
|
||||||
while (mimeType.IsEmpty() && NS_SUCCEEDED(sniffers->HasMoreElements(&hasMore))
|
|
||||||
&& hasMore) {
|
|
||||||
nsCOMPtr<nsISupports> snifferCIDSupports;
|
|
||||||
rv = sniffers->GetNext(getter_AddRefs(snifferCIDSupports));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCOMPtr<nsISupportsCString> snifferCIDSupportsCString =
|
|
||||||
do_QueryInterface(snifferCIDSupports, &rv);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCAutoString snifferCID;
|
|
||||||
rv = snifferCIDSupportsCString->GetData(snifferCID);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
nsCOMPtr<nsIContentSniffer> sniffer = do_GetService(snifferCID.get(), &rv);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
sniffer->GetMIMETypeFromContent(
|
|
||||||
#ifndef MOZILLA_1_8_BRANCH
|
|
||||||
aRequest,
|
|
||||||
#endif
|
|
||||||
NS_REINTERPRET_CAST(PRUint8*, NS_CONST_CAST(char*, mData.get())),
|
|
||||||
mData.Length(), mimeType);
|
|
||||||
// ignore errors: mime type will be left empty and we'll try the next sniffer
|
|
||||||
}
|
|
||||||
|
|
||||||
if (mimeType.IsEmpty()) {
|
|
||||||
// we can not handle favicons that do not have a recognisable MIME type
|
|
||||||
mFaviconService->AddFailedFavicon(mFaviconURI);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Expire this favicon in one day. An old version of this actually extracted
|
|
||||||
// the expiration time from the cache. But what if people (especially web
|
|
||||||
// developers) get a bad favicon or change it? The problem is that we're not
|
|
||||||
// aware when the icon has been reloaded in the cache or cleared. This way
|
|
||||||
// we'll always pick up any changes in the cache after a day. In most cases
|
|
||||||
// re-set favicons will come from the cache anyway and reloading them is not
|
|
||||||
// very expensive.
|
|
||||||
PRTime expiration = PR_Now() +
|
|
||||||
(PRInt64)(24 * 60 * 60) * (PRInt64)PR_USEC_PER_SEC;
|
|
||||||
|
|
||||||
// save the favicon data
|
|
||||||
rv = mFaviconService->SetFaviconData(mFaviconURI,
|
|
||||||
NS_REINTERPRET_CAST(PRUint8*, NS_CONST_CAST(char*, mData.get())),
|
|
||||||
mData.Length(), mimeType, expiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
// set the favicon for the page
|
|
||||||
PRBool hasData;
|
|
||||||
rv = mFaviconService->SetFaviconUrlForPageInternal(mPageURI, mFaviconURI,
|
|
||||||
&hasData, &expiration);
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
|
|
||||||
mFaviconService->SendFaviconNotifications(mPageURI, mFaviconURI);
|
|
||||||
mFaviconService->UpdateBookmarkRedirectFavicon(mPageURI, mFaviconURI);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::OnDataAvailable (nsIStreamListener)
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
FaviconLoadListener::OnDataAvailable(nsIRequest *aRequest, nsISupports *aContext,
|
|
||||||
nsIInputStream *aInputStream,
|
|
||||||
PRUint32 aOffset, PRUint32 aCount)
|
|
||||||
{
|
|
||||||
if (aOffset + aCount > MAX_FAVICON_SIZE)
|
|
||||||
return NS_ERROR_FAILURE; // too big
|
|
||||||
|
|
||||||
nsCString buffer;
|
|
||||||
nsresult rv = NS_ConsumeStream(aInputStream, aCount, buffer);
|
|
||||||
if (rv != NS_BASE_STREAM_WOULD_BLOCK && NS_FAILED(rv))
|
|
||||||
return rv;
|
|
||||||
|
|
||||||
mData.Append(buffer);
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::GetInterface (nsIInterfaceRequestor)
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
FaviconLoadListener::GetInterface(const nsIID& uuid, void** aResult)
|
|
||||||
{
|
|
||||||
return QueryInterface(uuid, aResult);
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
// FaviconLoadListener::OnChannelRedirect (nsIChannelEventSink)
|
|
||||||
|
|
||||||
NS_IMETHODIMP
|
|
||||||
FaviconLoadListener::OnChannelRedirect(nsIChannel* oldChannel,
|
|
||||||
nsIChannel* newChannel, PRUint32 flags)
|
|
||||||
{
|
|
||||||
mChannel = newChannel;
|
|
||||||
return NS_OK;
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -1444,8 +1444,8 @@ nsNavHistory::SetPageUserTitle(nsIURI* aURI, const nsAString& aUserTitle)
|
||||||
NS_IMETHODIMP
|
NS_IMETHODIMP
|
||||||
nsNavHistory::MarkPageAsFollowedBookmark(nsIURI* aURI)
|
nsNavHistory::MarkPageAsFollowedBookmark(nsIURI* aURI)
|
||||||
{
|
{
|
||||||
// if history expiration is set to 0 days it is disabled, so don't add
|
// don't add when history is disabled
|
||||||
if (mExpireDays == 0)
|
if (IsHistoryDisabled())
|
||||||
return NS_OK;
|
return NS_OK;
|
||||||
|
|
||||||
nsCAutoString uriString;
|
nsCAutoString uriString;
|
||||||
|
|
@ -2476,8 +2476,8 @@ nsNavHistory::HidePage(nsIURI *aURI)
|
||||||
NS_IMETHODIMP
|
NS_IMETHODIMP
|
||||||
nsNavHistory::MarkPageAsTyped(nsIURI *aURI)
|
nsNavHistory::MarkPageAsTyped(nsIURI *aURI)
|
||||||
{
|
{
|
||||||
// if history expiration is set to 0 days it is disabled, so don't add
|
// don't add when history is disabled
|
||||||
if (mExpireDays == 0)
|
if (IsHistoryDisabled())
|
||||||
return NS_OK;
|
return NS_OK;
|
||||||
|
|
||||||
nsCAutoString uriString;
|
nsCAutoString uriString;
|
||||||
|
|
@ -2506,8 +2506,8 @@ NS_IMETHODIMP
|
||||||
nsNavHistory::AddURI(nsIURI *aURI, PRBool aRedirect,
|
nsNavHistory::AddURI(nsIURI *aURI, PRBool aRedirect,
|
||||||
PRBool aToplevel, nsIURI *aReferrer)
|
PRBool aToplevel, nsIURI *aReferrer)
|
||||||
{
|
{
|
||||||
// if history expiration is set to 0 days it is disabled, so don't add
|
// don't add when history is disabled
|
||||||
if (mExpireDays == 0)
|
if (IsHistoryDisabled())
|
||||||
return NS_OK;
|
return NS_OK;
|
||||||
|
|
||||||
PRTime now = PR_Now();
|
PRTime now = PR_Now();
|
||||||
|
|
@ -2693,8 +2693,8 @@ nsNavHistory::AddVisitChain(nsIURI* aURI, PRTime aTime,
|
||||||
NS_IMETHODIMP
|
NS_IMETHODIMP
|
||||||
nsNavHistory::IsVisited(nsIURI *aURI, PRBool *_retval)
|
nsNavHistory::IsVisited(nsIURI *aURI, PRBool *_retval)
|
||||||
{
|
{
|
||||||
// if history expiration is set to 0 days it is disabled, we can optimize
|
// if history is disabled, we can optimize
|
||||||
if (mExpireDays == 0) {
|
if (IsHistoryDisabled()) {
|
||||||
*_retval = PR_FALSE;
|
*_retval = PR_FALSE;
|
||||||
return NS_OK;
|
return NS_OK;
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -1,607 +0,0 @@
|
||||||
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
||||||
/* ***** BEGIN LICENSE BLOCK *****
|
|
||||||
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
|
|
||||||
*
|
|
||||||
* The contents of this file are subject to the Mozilla Public License Version
|
|
||||||
* 1.1 (the "License"); you may not use this file except in compliance with
|
|
||||||
* the License. You may obtain a copy of the License at
|
|
||||||
* http://www.mozilla.org/MPL/
|
|
||||||
*
|
|
||||||
* Software distributed under the License is distributed on an "AS IS" basis,
|
|
||||||
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
|
|
||||||
* for the specific language governing rights and limitations under the
|
|
||||||
* License.
|
|
||||||
*
|
|
||||||
* The Original Code is Places code.
|
|
||||||
*
|
|
||||||
* The Initial Developer of the Original Code is
|
|
||||||
* Google Inc.
|
|
||||||
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
||||||
* the Initial Developer. All Rights Reserved.
|
|
||||||
*
|
|
||||||
* Contributor(s):
|
|
||||||
* Brett Wilson <brettw@gmail.com> (original author)
|
|
||||||
*
|
|
||||||
* Alternatively, the contents of this file may be used under the terms of
|
|
||||||
* either the GNU General Public License Version 2 or later (the "GPL"), or
|
|
||||||
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
|
|
||||||
* in which case the provisions of the GPL or the LGPL are applicable instead
|
|
||||||
* of those above. If you wish to allow use of your version of this file only
|
|
||||||
* under the terms of either the GPL or the LGPL, and not to allow others to
|
|
||||||
* use your version of this file under the terms of the MPL, indicate your
|
|
||||||
* decision by deleting the provisions above and replace them with the notice
|
|
||||||
* and other provisions required by the GPL or the LGPL. If you do not delete
|
|
||||||
* the provisions above, a recipient may use your version of this file under
|
|
||||||
* the terms of any one of the MPL, the GPL or the LGPL.
|
|
||||||
*
|
|
||||||
* ***** END LICENSE BLOCK ***** */
|
|
||||||
|
|
||||||
#ifndef nsNavHistory_h_
|
|
||||||
#define nsNavHistory_h_
|
|
||||||
|
|
||||||
#include "mozIStorageService.h"
|
|
||||||
#include "mozIStorageConnection.h"
|
|
||||||
#include "mozIStorageValueArray.h"
|
|
||||||
#include "mozIStorageStatement.h"
|
|
||||||
#include "nsAutoPtr.h"
|
|
||||||
#include "nsCOMArray.h"
|
|
||||||
#include "nsCOMPtr.h"
|
|
||||||
#include "nsDataHashtable.h"
|
|
||||||
#include "nsIAtom.h"
|
|
||||||
#include "nsINavHistoryService.h"
|
|
||||||
#include "nsIAutoCompleteSearch.h"
|
|
||||||
#include "nsIAutoCompleteResult.h"
|
|
||||||
#include "nsIAutoCompleteSimpleResult.h"
|
|
||||||
#include "nsIBrowserHistory.h"
|
|
||||||
#include "nsICollation.h"
|
|
||||||
#include "nsIDateTimeFormat.h"
|
|
||||||
#include "nsIGlobalHistory.h"
|
|
||||||
#include "nsIGlobalHistory3.h"
|
|
||||||
#include "nsIPrefService.h"
|
|
||||||
#include "nsIPrefBranch.h"
|
|
||||||
#include "nsIObserver.h"
|
|
||||||
#include "nsIObserverService.h"
|
|
||||||
#include "nsServiceManagerUtils.h"
|
|
||||||
#include "nsIStringBundle.h"
|
|
||||||
#include "nsITimer.h"
|
|
||||||
#include "nsITreeSelection.h"
|
|
||||||
#include "nsITreeView.h"
|
|
||||||
#include "nsString.h"
|
|
||||||
#include "nsVoidArray.h"
|
|
||||||
#include "nsWeakReference.h"
|
|
||||||
#include "nsTArray.h"
|
|
||||||
#include "nsINavBookmarksService.h"
|
|
||||||
#include "nsMaybeWeakPtr.h"
|
|
||||||
|
|
||||||
#include "nsNavHistoryExpire.h"
|
|
||||||
#include "nsNavHistoryResult.h"
|
|
||||||
#include "nsNavHistoryQuery.h"
|
|
||||||
|
|
||||||
// set to use more optimized (in-memory database) link coloring
|
|
||||||
//#define IN_MEMORY_LINKS
|
|
||||||
|
|
||||||
// define to enable lazy link adding
|
|
||||||
#define LAZY_ADD
|
|
||||||
|
|
||||||
#define QUERYUPDATE_TIME 0
|
|
||||||
#define QUERYUPDATE_SIMPLE 1
|
|
||||||
#define QUERYUPDATE_COMPLEX 2
|
|
||||||
#define QUERYUPDATE_COMPLEX_WITH_BOOKMARKS 3
|
|
||||||
|
|
||||||
class AutoCompleteIntermediateResult;
|
|
||||||
class AutoCompleteResultComparator;
|
|
||||||
class mozIAnnotationService;
|
|
||||||
class nsNavHistory;
|
|
||||||
class nsNavBookmarks;
|
|
||||||
class QueryKeyValuePair;
|
|
||||||
|
|
||||||
// nsNavHistory
|
|
||||||
|
|
||||||
class nsNavHistory : public nsSupportsWeakReference,
|
|
||||||
public nsINavHistoryService,
|
|
||||||
public nsIObserver,
|
|
||||||
public nsIBrowserHistory,
|
|
||||||
public nsIGlobalHistory3,
|
|
||||||
public nsIAutoCompleteSearch
|
|
||||||
{
|
|
||||||
friend class AutoCompleteIntermediateResultSet;
|
|
||||||
friend class AutoCompleteResultComparator;
|
|
||||||
public:
|
|
||||||
nsNavHistory();
|
|
||||||
|
|
||||||
NS_DECL_ISUPPORTS
|
|
||||||
|
|
||||||
NS_DECL_NSINAVHISTORYSERVICE
|
|
||||||
NS_DECL_NSIGLOBALHISTORY2
|
|
||||||
NS_DECL_NSIGLOBALHISTORY3
|
|
||||||
NS_DECL_NSIBROWSERHISTORY
|
|
||||||
NS_DECL_NSIOBSERVER
|
|
||||||
NS_DECL_NSIAUTOCOMPLETESEARCH
|
|
||||||
|
|
||||||
nsresult Init();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Used by other components in the places directory such as the annotation
|
|
||||||
* service to get a reference to this history object. Returns a pointer to
|
|
||||||
* the service if it exists. Otherwise creates one. Returns NULL on error.
|
|
||||||
*/
|
|
||||||
static nsNavHistory* GetHistoryService()
|
|
||||||
{
|
|
||||||
if (! gHistoryService) {
|
|
||||||
nsresult rv;
|
|
||||||
nsCOMPtr<nsINavHistoryService> serv(do_GetService("@mozilla.org/browser/nav-history-service;1", &rv));
|
|
||||||
NS_ENSURE_SUCCESS(rv, nsnull);
|
|
||||||
|
|
||||||
// our constructor should have set the static variable. If it didn't,
|
|
||||||
// something is wrong.
|
|
||||||
NS_ASSERTION(gHistoryService, "History service creation failed");
|
|
||||||
}
|
|
||||||
return gHistoryService;
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Call this function before doing any database reads. It will ensure that
|
|
||||||
* any data not flushed to the DB yet is flushed.
|
|
||||||
*/
|
|
||||||
void SyncDB()
|
|
||||||
{
|
|
||||||
#ifdef LAZY_ADD
|
|
||||||
CommitLazyMessages();
|
|
||||||
#endif
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef LAZY_ADD
|
|
||||||
/**
|
|
||||||
* Adds a lazy message for adding a favicon. Used by the favicon service so
|
|
||||||
* that favicons are handled lazily just like page adds.
|
|
||||||
*/
|
|
||||||
nsresult AddLazyLoadFaviconMessage(nsIURI* aPage, nsIURI* aFavicon,
|
|
||||||
PRBool aForceReload);
|
|
||||||
#endif
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns the database ID for the given URI, or 0 if not found an autoCreate
|
|
||||||
* is false.
|
|
||||||
*/
|
|
||||||
nsresult GetUrlIdFor(nsIURI* aURI, PRInt64* aEntryID,
|
|
||||||
PRBool aAutoCreate);
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Returns a pointer to the storage connection used by history. This
|
|
||||||
* connection object is also used by the annotation service and bookmarks, so
|
|
||||||
* that things can be grouped into transactions across these components.
|
|
||||||
*
|
|
||||||
* NOT ADDREFed.
|
|
||||||
*
|
|
||||||
* This connection can only be used in the thread that created it the
|
|
||||||
* history service!
|
|
||||||
*/
|
|
||||||
mozIStorageConnection* GetStorageConnection()
|
|
||||||
{
|
|
||||||
return mDBConn;
|
|
||||||
}
|
|
||||||
|
|
||||||
#ifdef IN_MEMORY_LINKS
|
|
||||||
mozIStorageConnection* GetMemoryStorageConnection()
|
|
||||||
{
|
|
||||||
return mMemDBConn;
|
|
||||||
}
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// see comment above StartDummyStatement
|
|
||||||
nsresult StartDummyStatement();
|
|
||||||
nsresult StopDummyStatement();
|
|
||||||
|
|
||||||
/**
|
|
||||||
* These functions return non-owning references to the locale-specific
|
|
||||||
* objects for places components. Guaranteed to return non-NULL.
|
|
||||||
*/
|
|
||||||
nsIStringBundle* GetBundle()
|
|
||||||
{ return mBundle; }
|
|
||||||
nsILocale* GetLocale()
|
|
||||||
{ return mLocale; }
|
|
||||||
nsICollation* GetCollation()
|
|
||||||
{ return mCollation; }
|
|
||||||
nsIDateTimeFormat* GetDateFormatter()
|
|
||||||
{ return mDateFormatter; }
|
|
||||||
|
|
||||||
// remember tree state
|
|
||||||
void SaveExpandItem(const nsAString& aTitle);
|
|
||||||
void SaveCollapseItem(const nsAString& aTitle);
|
|
||||||
|
|
||||||
// get the statement for selecting a history row by URL
|
|
||||||
mozIStorageStatement* DBGetURLPageInfo() { return mDBGetURLPageInfo; }
|
|
||||||
|
|
||||||
// Constants for the columns returned by the above statement.
|
|
||||||
static const PRInt32 kGetInfoIndex_PageID;
|
|
||||||
static const PRInt32 kGetInfoIndex_URL;
|
|
||||||
static const PRInt32 kGetInfoIndex_Title;
|
|
||||||
static const PRInt32 kGetInfoIndex_UserTitle;
|
|
||||||
static const PRInt32 kGetInfoIndex_RevHost;
|
|
||||||
static const PRInt32 kGetInfoIndex_VisitCount;
|
|
||||||
|
|
||||||
// select a history row by URL, with visit date info (extra work)
|
|
||||||
mozIStorageStatement* DBGetURLPageInfoFull()
|
|
||||||
{ return mDBGetURLPageInfoFull; }
|
|
||||||
|
|
||||||
// select a history row by id
|
|
||||||
mozIStorageStatement* DBGetIdPageInfo() { return mDBGetIdPageInfo; }
|
|
||||||
|
|
||||||
// select a history row by id, with visit date info (extra work)
|
|
||||||
mozIStorageStatement* DBGetIdPageInfoFull()
|
|
||||||
{ return mDBGetIdPageInfoFull; }
|
|
||||||
|
|
||||||
// Constants for the columns returned by the above statement
|
|
||||||
// (in addition to the ones above).
|
|
||||||
static const PRInt32 kGetInfoIndex_VisitDate;
|
|
||||||
static const PRInt32 kGetInfoIndex_FaviconURL;
|
|
||||||
|
|
||||||
// used in execute queries to get session ID info (only for visits)
|
|
||||||
static const PRInt32 kGetInfoIndex_SessionId;
|
|
||||||
|
|
||||||
static nsIAtom* sMenuRootAtom;
|
|
||||||
static nsIAtom* sToolbarRootAtom;
|
|
||||||
static nsIAtom* sSessionStartAtom;
|
|
||||||
static nsIAtom* sSessionContinueAtom;
|
|
||||||
static nsIAtom* sContainerAtom;
|
|
||||||
|
|
||||||
// this actually executes a query and gives you results, it is used by
|
|
||||||
// nsNavHistoryQueryResultNode
|
|
||||||
nsresult GetQueryResults(const nsCOMArray<nsNavHistoryQuery>& aQueries,
|
|
||||||
nsNavHistoryQueryOptions *aOptions,
|
|
||||||
nsCOMArray<nsNavHistoryResultNode>* aResults);
|
|
||||||
|
|
||||||
// Take a row of kGetInfoIndex_* columns and construct a ResultNode.
|
|
||||||
// The row must contain the full set of columns.
|
|
||||||
nsresult RowToResult(mozIStorageValueArray* aRow,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
nsNavHistoryResultNode** aResult);
|
|
||||||
nsresult QueryRowToResult(const nsACString& aURI, const nsACString& aTitle,
|
|
||||||
PRUint32 aAccessCount, PRTime aTime,
|
|
||||||
const nsACString& aFavicon,
|
|
||||||
nsNavHistoryResultNode** aNode);
|
|
||||||
|
|
||||||
nsresult VisitIdToResultNode(PRInt64 visitId,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
nsNavHistoryResultNode** aResult);
|
|
||||||
nsresult UriToResultNode(nsIURI* aUri,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
nsNavHistoryResultNode** aResult);
|
|
||||||
|
|
||||||
// used by other places components to send history notifications (for example,
|
|
||||||
// when the favicon has changed)
|
|
||||||
void SendPageChangedNotification(nsIURI* aURI, PRUint32 aWhat,
|
|
||||||
const nsAString& aValue)
|
|
||||||
{
|
|
||||||
ENUMERATE_WEAKARRAY(mObservers, nsINavHistoryObserver,
|
|
||||||
OnPageChanged(aURI, aWhat, aValue));
|
|
||||||
}
|
|
||||||
|
|
||||||
// current time optimization
|
|
||||||
PRTime GetNow();
|
|
||||||
|
|
||||||
// well-known annotations used by the history and bookmarks systems
|
|
||||||
static const char kAnnotationPreviousEncoding[];
|
|
||||||
|
|
||||||
// used by query result nodes to update: see comment on body of CanLiveUpdateQuery
|
|
||||||
static PRUint32 GetUpdateRequirements(const nsCOMArray<nsNavHistoryQuery>& aQueries,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
PRBool* aHasSearchTerms);
|
|
||||||
PRBool EvaluateQueryForNode(const nsCOMArray<nsNavHistoryQuery>& aQueries,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
nsNavHistoryResultNode* aNode);
|
|
||||||
|
|
||||||
static nsresult AsciiHostNameFromHostString(const nsACString& aHostName,
|
|
||||||
nsACString& aAscii);
|
|
||||||
static void DomainNameFromHostName(const nsCString& aHostName,
|
|
||||||
nsACString& aDomainName);
|
|
||||||
static PRTime NormalizeTime(PRUint32 aRelative, PRTime aOffset);
|
|
||||||
nsresult RecursiveGroup(const nsCOMArray<nsNavHistoryResultNode>& aSource,
|
|
||||||
const PRUint32* aGroupingMode, PRUint32 aGroupCount,
|
|
||||||
nsCOMArray<nsNavHistoryResultNode>* aDest);
|
|
||||||
|
|
||||||
// better alternative to QueryStringToQueries (in nsNavHistoryQuery.cpp)
|
|
||||||
nsresult QueryStringToQueryArray(const nsACString& aQueryString,
|
|
||||||
nsCOMArray<nsNavHistoryQuery>* aQueries,
|
|
||||||
nsNavHistoryQueryOptions** aOptions);
|
|
||||||
|
|
||||||
// Import-friendly version of SetPageDetails + AddVisit.
|
|
||||||
// This method adds a page to history along with a single last visit.
|
|
||||||
// It is an error to call this method if aURI might already be in history.
|
|
||||||
// The given aVisitCount should include the given last-visit date.
|
|
||||||
// aLastVisitDate can be -1 if there is no last visit date to record.
|
|
||||||
nsresult AddPageWithVisit(nsIURI *aURI,
|
|
||||||
const nsString &aTitle,
|
|
||||||
const nsString &aUserTitle,
|
|
||||||
PRBool aHidden, PRBool aTyped,
|
|
||||||
PRInt32 aVisitCount,
|
|
||||||
PRInt32 aLastVisitTransition,
|
|
||||||
PRTime aLastVisitDate);
|
|
||||||
|
|
||||||
// Checks the database for any duplicate URLs. If any are found,
|
|
||||||
// all but the first are removed. This must be called after using
|
|
||||||
// AddPageWithVisit, to ensure that the database is in a consistent state.
|
|
||||||
nsresult RemoveDuplicateURIs();
|
|
||||||
|
|
||||||
private:
|
|
||||||
~nsNavHistory();
|
|
||||||
|
|
||||||
// used by GetHistoryService
|
|
||||||
static nsNavHistory* gHistoryService;
|
|
||||||
|
|
||||||
protected:
|
|
||||||
|
|
||||||
//
|
|
||||||
// Constants
|
|
||||||
//
|
|
||||||
nsCOMPtr<nsIPrefBranch> mPrefBranch; // MAY BE NULL when we are shutting down
|
|
||||||
nsDataHashtable<nsStringHashKey, int> gExpandedItems;
|
|
||||||
|
|
||||||
//
|
|
||||||
// Database stuff
|
|
||||||
//
|
|
||||||
nsCOMPtr<mozIStorageService> mDBService;
|
|
||||||
nsCOMPtr<mozIStorageConnection> mDBConn;
|
|
||||||
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBGetURLPageInfo; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBGetURLPageInfoFull; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBGetIdPageInfo; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBGetIdPageInfoFull; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBFullAutoComplete; // kAutoCompleteIndex_* results, 1 arg (max # results)
|
|
||||||
static const PRInt32 kAutoCompleteIndex_URL;
|
|
||||||
static const PRInt32 kAutoCompleteIndex_Title;
|
|
||||||
static const PRInt32 kAutoCompleteIndex_UserTitle;
|
|
||||||
static const PRInt32 kAutoCompleteIndex_VisitCount;
|
|
||||||
static const PRInt32 kAutoCompleteIndex_Typed;
|
|
||||||
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBRecentVisitOfURL; // converts URL into most recent visit ID/session ID
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBInsertVisit; // used by AddVisit
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBGetPageVisitStats; // used by AddVisit
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBUpdatePageVisitStats; // used by AddVisit
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBAddNewPage; // used by InternalAddNewPage
|
|
||||||
|
|
||||||
// these are used by VisitIdToResultNode for making new result nodes from IDs
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBVisitToURLResult; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBVisitToVisitResult; // kGetInfoIndex_* results
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBUrlToUrlResult; // kGetInfoIndex_* results
|
|
||||||
|
|
||||||
nsresult InitDB(PRBool *aDoImport);
|
|
||||||
nsresult InitStatements();
|
|
||||||
|
|
||||||
#ifdef IN_MEMORY_LINKS
|
|
||||||
// this is the cache DB in memory used for storing visited URLs
|
|
||||||
nsCOMPtr<mozIStorageConnection> mMemDBConn;
|
|
||||||
nsCOMPtr<mozIStorageStatement> mMemDBAddPage;
|
|
||||||
nsCOMPtr<mozIStorageStatement> mMemDBGetPage;
|
|
||||||
|
|
||||||
nsresult InitMemDB();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
// this statement is kept open to persist the cache, see InitDB
|
|
||||||
nsCOMPtr<mozIStorageConnection> mDummyDBConn;
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBDummyStatement;
|
|
||||||
|
|
||||||
nsresult AddURIInternal(nsIURI* aURI, PRTime aTime, PRBool aRedirect,
|
|
||||||
PRBool aToplevel, nsIURI* aReferrer);
|
|
||||||
|
|
||||||
nsresult AddVisitChain(nsIURI* aURI, PRTime aTime,
|
|
||||||
PRBool aToplevel, PRBool aRedirect,
|
|
||||||
nsIURI* aReferrer, PRInt64* aVisitID,
|
|
||||||
PRInt64* aSessionID, PRInt64* aRedirectBookmark);
|
|
||||||
nsresult InternalAddNewPage(nsIURI* aURI, const nsAString& aTitle,
|
|
||||||
PRBool aHidden, PRBool aTyped,
|
|
||||||
PRInt32 aVisitCount, PRInt64* aPageID);
|
|
||||||
nsresult InternalAddVisit(PRInt64 aPageID, PRInt64 aReferringVisit,
|
|
||||||
PRInt64 aSessionID, PRTime aTime,
|
|
||||||
PRInt32 aTransitionType, PRInt64* aVisitID);
|
|
||||||
PRBool FindLastVisit(nsIURI* aURI, PRInt64* aVisitID,
|
|
||||||
PRInt64* aSessionID);
|
|
||||||
PRBool IsURIStringVisited(const nsACString& url);
|
|
||||||
nsresult LoadPrefs();
|
|
||||||
|
|
||||||
// Current time optimization
|
|
||||||
PRTime mLastNow;
|
|
||||||
PRBool mNowValid;
|
|
||||||
nsCOMPtr<nsITimer> mExpireNowTimer;
|
|
||||||
static void expireNowTimerCallback(nsITimer* aTimer, void* aClosure);
|
|
||||||
|
|
||||||
// expiration
|
|
||||||
friend class nsNavHistoryExpire;
|
|
||||||
nsNavHistoryExpire mExpire;
|
|
||||||
|
|
||||||
#ifdef LAZY_ADD
|
|
||||||
// lazy add committing
|
|
||||||
struct LazyMessage {
|
|
||||||
enum MessageType { Type_Invalid, Type_AddURI, Type_Title, Type_Favicon };
|
|
||||||
LazyMessage()
|
|
||||||
{
|
|
||||||
type = Type_Invalid;
|
|
||||||
isRedirect = PR_FALSE;
|
|
||||||
isToplevel = PR_FALSE;
|
|
||||||
time = 0;
|
|
||||||
alwaysLoadFavicon = PR_FALSE;
|
|
||||||
}
|
|
||||||
|
|
||||||
// call this with common parms to initialize. Caller is responsible for
|
|
||||||
// setting other elements manually depending on type.
|
|
||||||
nsresult Init(MessageType aType, nsIURI* aURI)
|
|
||||||
{
|
|
||||||
type = aType;
|
|
||||||
nsresult rv = aURI->Clone(getter_AddRefs(uri));
|
|
||||||
NS_ENSURE_SUCCESS(rv, rv);
|
|
||||||
return uri->GetSpec(uriSpec);
|
|
||||||
}
|
|
||||||
|
|
||||||
// common elements
|
|
||||||
MessageType type;
|
|
||||||
nsCOMPtr<nsIURI> uri;
|
|
||||||
nsCString uriSpec; // stringified version of URI, for quick isVisited
|
|
||||||
|
|
||||||
// valid when type == Type_AddURI
|
|
||||||
nsCOMPtr<nsIURI> referrer;
|
|
||||||
PRBool isRedirect;
|
|
||||||
PRBool isToplevel;
|
|
||||||
PRTime time;
|
|
||||||
|
|
||||||
// valid when type == Type_Title
|
|
||||||
nsString title;
|
|
||||||
|
|
||||||
// valid when type == LAZY_FAVICON
|
|
||||||
nsCOMPtr<nsIURI> favicon;
|
|
||||||
PRBool alwaysLoadFavicon;
|
|
||||||
};
|
|
||||||
nsTArray<LazyMessage> mLazyMessages;
|
|
||||||
nsCOMPtr<nsITimer> mLazyTimer;
|
|
||||||
PRBool mLazyTimerSet;
|
|
||||||
PRUint32 mLazyTimerDeferments; // see StartLazyTimer
|
|
||||||
nsresult StartLazyTimer();
|
|
||||||
nsresult AddLazyMessage(const LazyMessage& aMessage);
|
|
||||||
static void LazyTimerCallback(nsITimer* aTimer, void* aClosure);
|
|
||||||
void CommitLazyMessages();
|
|
||||||
#endif
|
|
||||||
|
|
||||||
nsresult QueryToSelectClause(nsNavHistoryQuery* aQuery,
|
|
||||||
PRInt32 aStartParameter,
|
|
||||||
nsCString* aClause,
|
|
||||||
PRInt32* aParamCount,
|
|
||||||
const nsACString& aCommonConditions);
|
|
||||||
nsresult BindQueryClauseParameters(mozIStorageStatement* statement,
|
|
||||||
PRInt32 aStartParameter,
|
|
||||||
nsNavHistoryQuery* aQuery,
|
|
||||||
PRInt32* aParamCount);
|
|
||||||
|
|
||||||
nsresult ResultsAsList(mozIStorageStatement* statement,
|
|
||||||
nsNavHistoryQueryOptions* aOptions,
|
|
||||||
nsCOMArray<nsNavHistoryResultNode>* aResults);
|
|
||||||
|
|
||||||
void TitleForDomain(const nsCString& domain, nsACString& aTitle);
|
|
||||||
nsresult SetPageTitleInternal(nsIURI* aURI, PRBool aIsUserTitle,
|
|
||||||
const nsAString& aTitle);
|
|
||||||
|
|
||||||
nsresult GroupByHost(const nsCOMArray<nsNavHistoryResultNode>& aSource,
|
|
||||||
nsCOMArray<nsNavHistoryResultNode>* aDest,
|
|
||||||
PRBool aIsDomain);
|
|
||||||
|
|
||||||
nsresult FilterResultSet(const nsCOMArray<nsNavHistoryResultNode>& aSet,
|
|
||||||
nsCOMArray<nsNavHistoryResultNode>* aFiltered,
|
|
||||||
const nsString& aSearch);
|
|
||||||
|
|
||||||
// observers
|
|
||||||
nsMaybeWeakPtrArray<nsINavHistoryObserver> mObservers;
|
|
||||||
PRInt32 mBatchesInProgress;
|
|
||||||
|
|
||||||
// localization
|
|
||||||
nsCOMPtr<nsIStringBundle> mBundle;
|
|
||||||
nsCOMPtr<nsILocale> mLocale;
|
|
||||||
nsCOMPtr<nsICollation> mCollation;
|
|
||||||
nsCOMPtr<nsIDateTimeFormat> mDateFormatter;
|
|
||||||
|
|
||||||
// annotation service : MAY BE NULL!
|
|
||||||
//nsCOMPtr<mozIAnnotationService> mAnnotationService;
|
|
||||||
|
|
||||||
// recent events
|
|
||||||
typedef nsDataHashtable<nsCStringHashKey, PRInt64> RecentEventHash;
|
|
||||||
RecentEventHash mRecentTyped;
|
|
||||||
RecentEventHash mRecentBookmark;
|
|
||||||
|
|
||||||
PRBool CheckIsRecentEvent(RecentEventHash* hashTable,
|
|
||||||
const nsACString& url);
|
|
||||||
void ExpireNonrecentEvents(RecentEventHash* hashTable);
|
|
||||||
|
|
||||||
// redirect tracking. See GetRedirectFor for a description of how this works.
|
|
||||||
struct RedirectInfo {
|
|
||||||
nsCString mSourceURI;
|
|
||||||
PRTime mTimeCreated;
|
|
||||||
PRUint32 mType; // one of TRANSITION_REDIRECT_[TEMPORARY,PERMANENT]
|
|
||||||
};
|
|
||||||
typedef nsDataHashtable<nsCStringHashKey, RedirectInfo> RedirectHash;
|
|
||||||
RedirectHash mRecentRedirects;
|
|
||||||
PR_STATIC_CALLBACK(PLDHashOperator) ExpireNonrecentRedirects(
|
|
||||||
nsCStringHashKey::KeyType aKey, RedirectInfo& aData, void* aUserArg);
|
|
||||||
PRBool GetRedirectFor(const nsACString& aDestination, nsACString& aSource,
|
|
||||||
PRTime* aTime, PRUint32* aRedirectType);
|
|
||||||
|
|
||||||
// session tracking
|
|
||||||
PRInt64 mLastSessionID;
|
|
||||||
PRInt64 GetNewSessionID() { mLastSessionID ++; return mLastSessionID; }
|
|
||||||
|
|
||||||
//
|
|
||||||
// AutoComplete stuff
|
|
||||||
//
|
|
||||||
struct AutoCompletePrefix
|
|
||||||
{
|
|
||||||
AutoCompletePrefix(const nsAString& aPrefix, PRBool aSecondLevel) :
|
|
||||||
prefix(aPrefix), secondLevel(aSecondLevel) {}
|
|
||||||
|
|
||||||
// The prefix, for example, "http://" or "https://www."
|
|
||||||
nsString prefix;
|
|
||||||
|
|
||||||
// Set when this prefix contains a spec AND a host. For example,
|
|
||||||
// "http://www." is a second level prefix, but "http://" is not. This
|
|
||||||
// flag is used to exclude matches. For example, if I type "http://w"
|
|
||||||
// I probably want it to autocomplete to sites beginning with w and
|
|
||||||
// NOT every "www" site I've ever visited.
|
|
||||||
PRBool secondLevel;
|
|
||||||
};
|
|
||||||
nsTArray<AutoCompletePrefix> mAutoCompletePrefixes;
|
|
||||||
|
|
||||||
nsCOMPtr<mozIStorageStatement> mDBAutoCompleteQuery;
|
|
||||||
nsresult InitAutoComplete();
|
|
||||||
nsresult CreateAutoCompleteQuery();
|
|
||||||
PRInt32 mAutoCompleteMaxCount;
|
|
||||||
PRInt32 mExpireDays;
|
|
||||||
PRBool mAutoCompleteOnlyTyped;
|
|
||||||
|
|
||||||
// Used to describe what prefixes shouldn't be cut from
|
|
||||||
// history urls when doing an autocomplete url comparison.
|
|
||||||
struct AutoCompleteExclude {
|
|
||||||
// these are indices into mIgnoreSchemes and mIgnoreHostnames, or -1
|
|
||||||
PRInt32 schemePrefix;
|
|
||||||
PRInt32 hostnamePrefix;
|
|
||||||
|
|
||||||
// this is the offset of the character immediately after the prefix
|
|
||||||
PRInt32 postPrefixOffset;
|
|
||||||
};
|
|
||||||
|
|
||||||
nsresult AutoCompleteTypedSearch(nsIAutoCompleteSimpleResult* result);
|
|
||||||
nsresult AutoCompleteFullHistorySearch(const nsAString& aSearchString,
|
|
||||||
nsIAutoCompleteSimpleResult* result);
|
|
||||||
nsresult AutoCompleteQueryOnePrefix(const nsString& aSearchString,
|
|
||||||
const nsTArray<PRInt32>& aExcludePrefixes,
|
|
||||||
PRInt32 aPriorityDelta,
|
|
||||||
nsTArray<AutoCompleteIntermediateResult>* aResult);
|
|
||||||
PRInt32 AutoCompleteGetPrefixLength(const nsString& aSpec);
|
|
||||||
|
|
||||||
// in nsNavHistoryQuery.cpp
|
|
||||||
nsresult TokensToQueries(const nsTArray<QueryKeyValuePair>& aTokens,
|
|
||||||
nsCOMArray<nsNavHistoryQuery>* aQueries,
|
|
||||||
nsNavHistoryQueryOptions* aOptions);
|
|
||||||
|
|
||||||
// creates supplemental indexes that we'd like to not bother with
|
|
||||||
// updating during import.
|
|
||||||
nsresult CreateLookupIndexes();
|
|
||||||
};
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Shared between the places components, this function binds the given URI as
|
|
||||||
* UTF8 to the given parameter for the statement.
|
|
||||||
*/
|
|
||||||
nsresult BindStatementURI(mozIStorageStatement* statement, PRInt32 index,
|
|
||||||
nsIURI* aURI);
|
|
||||||
|
|
||||||
#define PLACES_URI_PREFIX "place:"
|
|
||||||
|
|
||||||
/* Returns true if the given URI represents a history query. */
|
|
||||||
inline PRBool IsQueryURI(const nsCString &uri)
|
|
||||||
{
|
|
||||||
return StringBeginsWith(uri, NS_LITERAL_CSTRING(PLACES_URI_PREFIX));
|
|
||||||
}
|
|
||||||
|
|
||||||
/* Extracts the query string from a query URI. */
|
|
||||||
inline const nsDependentCSubstring QueryURIToQuery(const nsCString &uri)
|
|
||||||
{
|
|
||||||
NS_ASSERTION(IsQueryURI(uri), "should only be called for query URIs");
|
|
||||||
return Substring(uri, NS_LITERAL_CSTRING(PLACES_URI_PREFIX).Length());
|
|
||||||
}
|
|
||||||
|
|
||||||
#endif // nsNavHistory_h_
|
|
||||||
Загрузка…
Ссылка в новой задаче