The Tor Browser: comparison toolkit/components/places/nsNavHistory.cpp

--1:000000000000
+:184b9a0b9087
+//* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+* License, v. 2.0. If a copy of the MPL was not distributed with this
+* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
+#include <stdio.h>
+#include "mozilla/DebugOnly.h"
+#include "nsNavHistory.h"
+#include "mozIPlacesAutoComplete.h"
+#include "nsNavBookmarks.h"
+#include "nsAnnotationService.h"
+#include "nsFaviconService.h"
+#include "nsPlacesMacros.h"
+#include "History.h"
+#include "Helpers.h"
+#include "nsTArray.h"
+#include "nsCollationCID.h"
+#include "nsILocaleService.h"
+#include "nsNetUtil.h"
+#include "nsPrintfCString.h"
+#include "nsPromiseFlatString.h"
+#include "nsString.h"
+#include "nsUnicharUtils.h"
+#include "prsystem.h"
+#include "prtime.h"
+#include "nsEscape.h"
+#include "nsIEffectiveTLDService.h"
+#include "nsIClassInfoImpl.h"
+#include "nsThreadUtils.h"
+#include "nsAppDirectoryServiceDefs.h"
+#include "nsMathUtils.h"
+#include "mozilla/storage.h"
+#include "mozilla/Preferences.h"
+#include <algorithm>
+#ifdef MOZ_XUL
+#include "nsIAutoCompleteInput.h"
+#include "nsIAutoCompletePopup.h"
+#endif
+using namespace mozilla;
+using namespace mozilla::places;
+// The maximum number of things that we will store in the recent events list
+// before calling ExpireNonrecentEvents. This number should be big enough so it
+// is very difficult to get that many unconsumed events (for example, typed but
+// never visited) in the RECENT_EVENT_THRESHOLD. Otherwise, we'll start
+// checking each one for every page visit, which will be somewhat slower.
+#define RECENT_EVENT_QUEUE_MAX_LENGTH 128
+// preference ID strings
+#define PREF_HISTORY_ENABLED                    "places.history.enabled"
+#define PREF_FREC_NUM_VISITS                    "places.frecency.numVisits"
+#define PREF_FREC_NUM_VISITS_DEF                10
+#define PREF_FREC_FIRST_BUCKET_CUTOFF           "places.frecency.firstBucketCutoff"
+#define PREF_FREC_FIRST_BUCKET_CUTOFF_DEF       4
+#define PREF_FREC_SECOND_BUCKET_CUTOFF          "places.frecency.secondBucketCutoff"
+#define PREF_FREC_SECOND_BUCKET_CUTOFF_DEF      14
+#define PREF_FREC_THIRD_BUCKET_CUTOFF           "places.frecency.thirdBucketCutoff"
+#define PREF_FREC_THIRD_BUCKET_CUTOFF_DEF       31
+#define PREF_FREC_FOURTH_BUCKET_CUTOFF          "places.frecency.fourthBucketCutoff"
+#define PREF_FREC_FOURTH_BUCKET_CUTOFF_DEF      90
+#define PREF_FREC_FIRST_BUCKET_WEIGHT           "places.frecency.firstBucketWeight"
+#define PREF_FREC_FIRST_BUCKET_WEIGHT_DEF       100
+#define PREF_FREC_SECOND_BUCKET_WEIGHT          "places.frecency.secondBucketWeight"
+#define PREF_FREC_SECOND_BUCKET_WEIGHT_DEF      70
+#define PREF_FREC_THIRD_BUCKET_WEIGHT           "places.frecency.thirdBucketWeight"
+#define PREF_FREC_THIRD_BUCKET_WEIGHT_DEF       50
+#define PREF_FREC_FOURTH_BUCKET_WEIGHT          "places.frecency.fourthBucketWeight"
+#define PREF_FREC_FOURTH_BUCKET_WEIGHT_DEF      30
+#define PREF_FREC_DEFAULT_BUCKET_WEIGHT         "places.frecency.defaultBucketWeight"
+#define PREF_FREC_DEFAULT_BUCKET_WEIGHT_DEF     10
+#define PREF_FREC_EMBED_VISIT_BONUS             "places.frecency.embedVisitBonus"
+#define PREF_FREC_EMBED_VISIT_BONUS_DEF         0
+#define PREF_FREC_FRAMED_LINK_VISIT_BONUS       "places.frecency.framedLinkVisitBonus"
+#define PREF_FREC_FRAMED_LINK_VISIT_BONUS_DEF   0
+#define PREF_FREC_LINK_VISIT_BONUS              "places.frecency.linkVisitBonus"
+#define PREF_FREC_LINK_VISIT_BONUS_DEF          100
+#define PREF_FREC_TYPED_VISIT_BONUS             "places.frecency.typedVisitBonus"
+#define PREF_FREC_TYPED_VISIT_BONUS_DEF         2000
+#define PREF_FREC_BOOKMARK_VISIT_BONUS          "places.frecency.bookmarkVisitBonus"
+#define PREF_FREC_BOOKMARK_VISIT_BONUS_DEF      75
+#define PREF_FREC_DOWNLOAD_VISIT_BONUS          "places.frecency.downloadVisitBonus"
+#define PREF_FREC_DOWNLOAD_VISIT_BONUS_DEF      0
+#define PREF_FREC_PERM_REDIRECT_VISIT_BONUS     "places.frecency.permRedirectVisitBonus"
+#define PREF_FREC_PERM_REDIRECT_VISIT_BONUS_DEF 0
+#define PREF_FREC_TEMP_REDIRECT_VISIT_BONUS     "places.frecency.tempRedirectVisitBonus"
+#define PREF_FREC_TEMP_REDIRECT_VISIT_BONUS_DEF 0
+#define PREF_FREC_DEFAULT_VISIT_BONUS           "places.frecency.defaultVisitBonus"
+#define PREF_FREC_DEFAULT_VISIT_BONUS_DEF       0
+#define PREF_FREC_UNVISITED_BOOKMARK_BONUS      "places.frecency.unvisitedBookmarkBonus"
+#define PREF_FREC_UNVISITED_BOOKMARK_BONUS_DEF  140
+#define PREF_FREC_UNVISITED_TYPED_BONUS         "places.frecency.unvisitedTypedBonus"
+#define PREF_FREC_UNVISITED_TYPED_BONUS_DEF     200
+// In order to avoid calling PR_now() too often we use a cached "now" value
+// for repeating stuff.  These are milliseconds between "now" cache refreshes.
+#define RENEW_CACHED_NOW_TIMEOUT ((int32_t)3 * PR_MSEC_PER_SEC)
+static const int64_t USECS_PER_DAY = (int64_t)PR_USEC_PER_SEC * 60 * 60 * 24;
+// character-set annotation
+#define CHARSET_ANNO NS_LITERAL_CSTRING("URIProperties/characterSet")
+// These macros are used when splitting history by date.
+// These are the day containers and catch-all final container.
+#define HISTORY_ADDITIONAL_DATE_CONT_NUM 3
+// We use a guess of the number of months considering all of them 30 days
+// long, but we split only the last 6 months.
+#define HISTORY_DATE_CONT_NUM(_daysFromOldestVisit) \
+(HISTORY_ADDITIONAL_DATE_CONT_NUM + \
+std::min(6, (int32_t)ceilf((float)_daysFromOldestVisit/30)))
+// Max number of containers, used to initialize the params hash.
+#define HISTORY_DATE_CONT_MAX 10
+// Initial size of the embed visits cache.
+#define EMBED_VISITS_INITIAL_CACHE_SIZE 128
+// Initial size of the recent events caches.
+#define RECENT_EVENTS_INITIAL_CACHE_SIZE 128
+// Observed topics.
+#ifdef MOZ_XUL
+#define TOPIC_AUTOCOMPLETE_FEEDBACK_INCOMING "autocomplete-will-enter-text"
+#endif
+#define TOPIC_IDLE_DAILY "idle-daily"
+#define TOPIC_PREF_CHANGED "nsPref:changed"
+#define TOPIC_PROFILE_TEARDOWN "profile-change-teardown"
+#define TOPIC_PROFILE_CHANGE "profile-before-change"
+static const char* kObservedPrefs[] = {
+PREF_HISTORY_ENABLED
+, PREF_FREC_NUM_VISITS
+, PREF_FREC_FIRST_BUCKET_CUTOFF
+, PREF_FREC_SECOND_BUCKET_CUTOFF
+, PREF_FREC_THIRD_BUCKET_CUTOFF
+, PREF_FREC_FOURTH_BUCKET_CUTOFF
+, PREF_FREC_FIRST_BUCKET_WEIGHT
+, PREF_FREC_SECOND_BUCKET_WEIGHT
+, PREF_FREC_THIRD_BUCKET_WEIGHT
+, PREF_FREC_FOURTH_BUCKET_WEIGHT
+, PREF_FREC_DEFAULT_BUCKET_WEIGHT
+, PREF_FREC_EMBED_VISIT_BONUS
+, PREF_FREC_FRAMED_LINK_VISIT_BONUS
+, PREF_FREC_LINK_VISIT_BONUS
+, PREF_FREC_TYPED_VISIT_BONUS
+, PREF_FREC_BOOKMARK_VISIT_BONUS
+, PREF_FREC_DOWNLOAD_VISIT_BONUS
+, PREF_FREC_PERM_REDIRECT_VISIT_BONUS
+, PREF_FREC_TEMP_REDIRECT_VISIT_BONUS
+, PREF_FREC_DEFAULT_VISIT_BONUS
+, PREF_FREC_UNVISITED_BOOKMARK_BONUS
+, PREF_FREC_UNVISITED_TYPED_BONUS
+, nullptr
+};
+NS_IMPL_ADDREF(nsNavHistory)
+NS_IMPL_RELEASE(nsNavHistory)
+NS_IMPL_CLASSINFO(nsNavHistory, nullptr, nsIClassInfo::SINGLETON,
+NS_NAVHISTORYSERVICE_CID)
+NS_INTERFACE_MAP_BEGIN(nsNavHistory)
+NS_INTERFACE_MAP_ENTRY(nsINavHistoryService)
+NS_INTERFACE_MAP_ENTRY(nsIBrowserHistory)
+NS_INTERFACE_MAP_ENTRY(nsIObserver)
+NS_INTERFACE_MAP_ENTRY(nsISupportsWeakReference)
+NS_INTERFACE_MAP_ENTRY(nsPIPlacesDatabase)
+NS_INTERFACE_MAP_ENTRY(nsPIPlacesHistoryListenersNotifier)
+NS_INTERFACE_MAP_ENTRY(mozIStorageVacuumParticipant)
+NS_INTERFACE_MAP_ENTRY_AMBIGUOUS(nsISupports, nsINavHistoryService)
+NS_IMPL_QUERY_CLASSINFO(nsNavHistory)
+NS_INTERFACE_MAP_END
+// We don't care about flattening everything
+NS_IMPL_CI_INTERFACE_GETTER(nsNavHistory,
+nsINavHistoryService,
+nsIBrowserHistory)
+namespace {
+static int64_t GetSimpleBookmarksQueryFolder(
+const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions* aOptions);
+static void ParseSearchTermsFromQueries(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsTArray<nsTArray<nsString>*>* aTerms);
+void GetTagsSqlFragment(int64_t aTagsFolder,
+const nsACString& aRelation,
+bool aHasSearchTerms,
+nsACString& _sqlFragment) {
+if (!aHasSearchTerms)
+_sqlFragment.AssignLiteral("null");
+else {
+// This subquery DOES NOT order tags for performance reasons.
+_sqlFragment.Assign(NS_LITERAL_CSTRING(
+"(SELECT GROUP_CONCAT(t_t.title, ',') "
+"FROM moz_bookmarks b_t "
+"JOIN moz_bookmarks t_t ON t_t.id = +b_t.parent  "
+"WHERE b_t.fk = ") + aRelation + NS_LITERAL_CSTRING(" "
+"AND t_t.parent = ") +
+nsPrintfCString("%lld", aTagsFolder) + NS_LITERAL_CSTRING(" "
+")"));
+}
+_sqlFragment.AppendLiteral(" AS tags ");
+}
+/**
+* This class sets begin/end of batch updates to correspond to C++ scopes so
+* we can be sure end always gets called.
+*/
+class UpdateBatchScoper
+{
+public:
+UpdateBatchScoper(nsNavHistory& aNavHistory) : mNavHistory(aNavHistory)
+{
+mNavHistory.BeginUpdateBatch();
+}
+~UpdateBatchScoper()
+{
+mNavHistory.EndUpdateBatch();
+}
+protected:
+nsNavHistory& mNavHistory;
+};
+} // anonymouse namespace
+// Queries rows indexes to bind or get values, if adding a new one, be sure to
+// update nsNavBookmarks statements and its kGetChildrenIndex_* constants
+const int32_t nsNavHistory::kGetInfoIndex_PageID = 0;
+const int32_t nsNavHistory::kGetInfoIndex_URL = 1;
+const int32_t nsNavHistory::kGetInfoIndex_Title = 2;
+const int32_t nsNavHistory::kGetInfoIndex_RevHost = 3;
+const int32_t nsNavHistory::kGetInfoIndex_VisitCount = 4;
+const int32_t nsNavHistory::kGetInfoIndex_VisitDate = 5;
+const int32_t nsNavHistory::kGetInfoIndex_FaviconURL = 6;
+const int32_t nsNavHistory::kGetInfoIndex_ItemId = 7;
+const int32_t nsNavHistory::kGetInfoIndex_ItemDateAdded = 8;
+const int32_t nsNavHistory::kGetInfoIndex_ItemLastModified = 9;
+const int32_t nsNavHistory::kGetInfoIndex_ItemParentId = 10;
+const int32_t nsNavHistory::kGetInfoIndex_ItemTags = 11;
+const int32_t nsNavHistory::kGetInfoIndex_Frecency = 12;
+const int32_t nsNavHistory::kGetInfoIndex_Hidden = 13;
+const int32_t nsNavHistory::kGetInfoIndex_Guid = 14;
+PLACES_FACTORY_SINGLETON_IMPLEMENTATION(nsNavHistory, gHistoryService)
+nsNavHistory::nsNavHistory()
+: mBatchLevel(0)
+, mBatchDBTransaction(nullptr)
+, mCachedNow(0)
+, mRecentTyped(RECENT_EVENTS_INITIAL_CACHE_SIZE)
+, mRecentLink(RECENT_EVENTS_INITIAL_CACHE_SIZE)
+, mRecentBookmark(RECENT_EVENTS_INITIAL_CACHE_SIZE)
+, mEmbedVisits(EMBED_VISITS_INITIAL_CACHE_SIZE)
+, mHistoryEnabled(true)
+, mNumVisitsForFrecency(10)
+, mTagsFolder(-1)
+, mDaysOfHistory(-1)
+, mLastCachedStartOfDay(INT64_MAX)
+, mLastCachedEndOfDay(0)
+, mCanNotify(true)
+, mCacheObservers("history-observers")
+{
+NS_ASSERTION(!gHistoryService,
+"Attempting to create two instances of the service!");
+gHistoryService = this;
+}
+nsNavHistory::~nsNavHistory()
+{
+// remove the static reference to the service. Check to make sure its us
+// in case somebody creates an extra instance of the service.
+NS_ASSERTION(gHistoryService == this,
+"Deleting a non-singleton instance of the service");
+if (gHistoryService == this)
+gHistoryService = nullptr;
+}
+nsresult
+nsNavHistory::Init()
+{
+LoadPrefs();
+mDB = Database::GetDatabase();
+NS_ENSURE_STATE(mDB);
+/*****************************************************************************
+*** IMPORTANT NOTICE!
+***
+*** Nothing after these add observer calls should return anything but NS_OK.
+*** If a failure code is returned, this nsNavHistory object will be held onto
+*** by the observer service and the preference service.
+****************************************************************************/
+// Observe preferences changes.
+Preferences::AddWeakObservers(this, kObservedPrefs);
+nsCOMPtr<nsIObserverService> obsSvc = services::GetObserverService();
+if (obsSvc) {
+(void)obsSvc->AddObserver(this, TOPIC_PLACES_CONNECTION_CLOSED, true);
+(void)obsSvc->AddObserver(this, TOPIC_IDLE_DAILY, true);
+#ifdef MOZ_XUL
+(void)obsSvc->AddObserver(this, TOPIC_AUTOCOMPLETE_FEEDBACK_INCOMING, true);
+#endif
+}
+// Don't add code that can fail here! Do it up above, before we add our
+// observers.
+return NS_OK;
+}
+NS_IMETHODIMP
+nsNavHistory::GetDatabaseStatus(uint16_t *aDatabaseStatus)
+{
+NS_ENSURE_ARG_POINTER(aDatabaseStatus);
+*aDatabaseStatus = mDB->GetDatabaseStatus();
+return NS_OK;
+}
+uint32_t
+nsNavHistory::GetRecentFlags(nsIURI *aURI)
+{
+uint32_t result = 0;
+nsAutoCString spec;
+nsresult rv = aURI->GetSpec(spec);
+NS_WARN_IF_FALSE(NS_SUCCEEDED(rv), "Unable to get aURI's spec");
+if (NS_SUCCEEDED(rv)) {
+if (CheckIsRecentEvent(&mRecentTyped, spec))
+result |= RECENT_TYPED;
+if (CheckIsRecentEvent(&mRecentLink, spec))
+result |= RECENT_ACTIVATED;
+if (CheckIsRecentEvent(&mRecentBookmark, spec))
+result |= RECENT_BOOKMARKED;
+}
+return result;
+}
+nsresult
+nsNavHistory::GetIdForPage(nsIURI* aURI,
+int64_t* _pageId,
+nsCString& _GUID)
+{
+*_pageId = 0;
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(
+"SELECT id, url, title, rev_host, visit_count, guid "
+"FROM moz_places "
+"WHERE url = :page_url "
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+nsresult rv = URIBinder::Bind(stmt, NS_LITERAL_CSTRING("page_url"), aURI);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasEntry = false;
+rv = stmt->ExecuteStep(&hasEntry);
+NS_ENSURE_SUCCESS(rv, rv);
+if (hasEntry) {
+rv = stmt->GetInt64(0, _pageId);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = stmt->GetUTF8String(5, _GUID);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+return NS_OK;
+}
+nsresult
+nsNavHistory::GetOrCreateIdForPage(nsIURI* aURI,
+int64_t* _pageId,
+nsCString& _GUID)
+{
+nsresult rv = GetIdForPage(aURI, _pageId, _GUID);
+NS_ENSURE_SUCCESS(rv, rv);
+if (*_pageId != 0) {
+return NS_OK;
+}
+// Create a new hidden, untyped and unvisited entry.
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(
+"INSERT OR IGNORE INTO moz_places (url, rev_host, hidden, frecency, guid) "
+"VALUES (:page_url, :rev_host, :hidden, :frecency, GENERATE_GUID()) "
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+rv = URIBinder::Bind(stmt, NS_LITERAL_CSTRING("page_url"), aURI);
+NS_ENSURE_SUCCESS(rv, rv);
+// host (reversed with trailing period)
+nsAutoString revHost;
+rv = GetReversedHostname(aURI, revHost);
+// Not all URI types have hostnames, so this is optional.
+if (NS_SUCCEEDED(rv)) {
+rv = stmt->BindStringByName(NS_LITERAL_CSTRING("rev_host"), revHost);
+} else {
+rv = stmt->BindNullByName(NS_LITERAL_CSTRING("rev_host"));
+}
+NS_ENSURE_SUCCESS(rv, rv);
+rv = stmt->BindInt32ByName(NS_LITERAL_CSTRING("hidden"), 1);
+NS_ENSURE_SUCCESS(rv, rv);
+nsAutoCString spec;
+rv = aURI->GetSpec(spec);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = stmt->BindInt32ByName(NS_LITERAL_CSTRING("frecency"),
+IsQueryURI(spec) ? 0 : -1);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = stmt->Execute();
+NS_ENSURE_SUCCESS(rv, rv);
+{
+nsCOMPtr<mozIStorageStatement> getIdStmt = mDB->GetStatement(
+"SELECT id, guid FROM moz_places WHERE url = :page_url "
+);
+NS_ENSURE_STATE(getIdStmt);
+mozStorageStatementScoper getIdScoper(getIdStmt);
+rv = URIBinder::Bind(getIdStmt, NS_LITERAL_CSTRING("page_url"), aURI);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasResult = false;
+rv = getIdStmt->ExecuteStep(&hasResult);
+NS_ENSURE_SUCCESS(rv, rv);
+NS_ASSERTION(hasResult, "hasResult is false but the call succeeded?");
+*_pageId = getIdStmt->AsInt64(0);
+rv = getIdStmt->GetUTF8String(1, _GUID);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+return NS_OK;
+}
+void
+nsNavHistory::LoadPrefs()
+{
+// History preferences.
+mHistoryEnabled = Preferences::GetBool(PREF_HISTORY_ENABLED, true);
+// Frecency preferences.
+#define FRECENCY_PREF(_prop, _pref) \
+_prop = Preferences::GetInt(_pref, _pref##_DEF)
+FRECENCY_PREF(mNumVisitsForFrecency,     PREF_FREC_NUM_VISITS);
+FRECENCY_PREF(mFirstBucketCutoffInDays,  PREF_FREC_FIRST_BUCKET_CUTOFF);
+FRECENCY_PREF(mSecondBucketCutoffInDays, PREF_FREC_SECOND_BUCKET_CUTOFF);
+FRECENCY_PREF(mThirdBucketCutoffInDays,  PREF_FREC_THIRD_BUCKET_CUTOFF);
+FRECENCY_PREF(mFourthBucketCutoffInDays, PREF_FREC_FOURTH_BUCKET_CUTOFF);
+FRECENCY_PREF(mEmbedVisitBonus,          PREF_FREC_EMBED_VISIT_BONUS);
+FRECENCY_PREF(mFramedLinkVisitBonus,     PREF_FREC_FRAMED_LINK_VISIT_BONUS);
+FRECENCY_PREF(mLinkVisitBonus,           PREF_FREC_LINK_VISIT_BONUS);
+FRECENCY_PREF(mTypedVisitBonus,          PREF_FREC_TYPED_VISIT_BONUS);
+FRECENCY_PREF(mBookmarkVisitBonus,       PREF_FREC_BOOKMARK_VISIT_BONUS);
+FRECENCY_PREF(mDownloadVisitBonus,       PREF_FREC_DOWNLOAD_VISIT_BONUS);
+FRECENCY_PREF(mPermRedirectVisitBonus,   PREF_FREC_PERM_REDIRECT_VISIT_BONUS);
+FRECENCY_PREF(mTempRedirectVisitBonus,   PREF_FREC_TEMP_REDIRECT_VISIT_BONUS);
+FRECENCY_PREF(mDefaultVisitBonus,        PREF_FREC_DEFAULT_VISIT_BONUS);
+FRECENCY_PREF(mUnvisitedBookmarkBonus,   PREF_FREC_UNVISITED_BOOKMARK_BONUS);
+FRECENCY_PREF(mUnvisitedTypedBonus,      PREF_FREC_UNVISITED_TYPED_BONUS);
+FRECENCY_PREF(mFirstBucketWeight,        PREF_FREC_FIRST_BUCKET_WEIGHT);
+FRECENCY_PREF(mSecondBucketWeight,       PREF_FREC_SECOND_BUCKET_WEIGHT);
+FRECENCY_PREF(mThirdBucketWeight,        PREF_FREC_THIRD_BUCKET_WEIGHT);
+FRECENCY_PREF(mFourthBucketWeight,       PREF_FREC_FOURTH_BUCKET_WEIGHT);
+FRECENCY_PREF(mDefaultWeight,            PREF_FREC_DEFAULT_BUCKET_WEIGHT);
+#undef FRECENCY_PREF
+}
+void
+nsNavHistory::NotifyOnVisit(nsIURI* aURI,
+int64_t aVisitID,
+PRTime aTime,
+int64_t referringVisitID,
+int32_t aTransitionType,
+const nsACString& aGUID,
+bool aHidden)
+{
+MOZ_ASSERT(!aGUID.IsEmpty());
+// If there's no history, this visit will surely add a day.  If the visit is
+// added before or after the last cached day, the day count may have changed.
+// Otherwise adding multiple visits in the same day should not invalidate
+// the cache.
+if (mDaysOfHistory == 0) {
+mDaysOfHistory = 1;
+} else if (aTime > mLastCachedEndOfDay || aTime < mLastCachedStartOfDay) {
+mDaysOfHistory = -1;
+}
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnVisit(aURI, aVisitID, aTime, 0,
+referringVisitID, aTransitionType, aGUID, aHidden));
+}
+void
+nsNavHistory::NotifyTitleChange(nsIURI* aURI,
+const nsString& aTitle,
+const nsACString& aGUID)
+{
+MOZ_ASSERT(!aGUID.IsEmpty());
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver, OnTitleChanged(aURI, aTitle, aGUID));
+}
+void
+nsNavHistory::NotifyFrecencyChanged(nsIURI* aURI,
+int32_t aNewFrecency,
+const nsACString& aGUID,
+bool aHidden,
+PRTime aLastVisitDate)
+{
+MOZ_ASSERT(!aGUID.IsEmpty());
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnFrecencyChanged(aURI, aNewFrecency, aGUID, aHidden,
+aLastVisitDate));
+}
+void
+nsNavHistory::NotifyManyFrecenciesChanged()
+{
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnManyFrecenciesChanged());
+}
+namespace {
+class FrecencyNotification : public nsRunnable
+{
+public:
+FrecencyNotification(const nsACString& aSpec,
+int32_t aNewFrecency,
+const nsACString& aGUID,
+bool aHidden,
+PRTime aLastVisitDate)
+: mSpec(aSpec)
+, mNewFrecency(aNewFrecency)
+, mGUID(aGUID)
+, mHidden(aHidden)
+, mLastVisitDate(aLastVisitDate)
+{
+}
+NS_IMETHOD Run()
+{
+MOZ_ASSERT(NS_IsMainThread(), "Must be called on the main thread");
+nsNavHistory* navHistory = nsNavHistory::GetHistoryService();
+if (navHistory) {
+nsCOMPtr<nsIURI> uri;
+(void)NS_NewURI(getter_AddRefs(uri), mSpec);
+navHistory->NotifyFrecencyChanged(uri, mNewFrecency, mGUID, mHidden,
+mLastVisitDate);
+}
+return NS_OK;
+}
+private:
+nsCString mSpec;
+int32_t mNewFrecency;
+nsCString mGUID;
+bool mHidden;
+PRTime mLastVisitDate;
+};
+} // anonymous namespace
+void
+nsNavHistory::DispatchFrecencyChangedNotification(const nsACString& aSpec,
+int32_t aNewFrecency,
+const nsACString& aGUID,
+bool aHidden,
+PRTime aLastVisitDate) const
+{
+nsCOMPtr<nsIRunnable> notif = new FrecencyNotification(aSpec, aNewFrecency,
+aGUID, aHidden,
+aLastVisitDate);
+(void)NS_DispatchToMainThread(notif);
+}
+int32_t
+nsNavHistory::GetDaysOfHistory() {
+MOZ_ASSERT(NS_IsMainThread(), "This can only be called on the main thread");
+if (mDaysOfHistory != -1)
+return mDaysOfHistory;
+// SQLite doesn't have a CEIL() function, so we must do that later.
+// We should also take into account timers resolution, that may be as bad as
+// 16ms on Windows, so in some cases the difference may be 0, if the
+// check is done near the visit.  Thus remember to check for NULL separately.
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(
+"SELECT CAST(( "
+"strftime('%s','now','localtime','utc') - "
+"(SELECT MIN(visit_date)/1000000 FROM moz_historyvisits) "
+") AS DOUBLE) "
+"/86400, "
+"strftime('%s','now','localtime','+1 day','start of day','utc') * 1000000"
+);
+NS_ENSURE_TRUE(stmt, 0);
+mozStorageStatementScoper scoper(stmt);
+bool hasResult;
+if (NS_SUCCEEDED(stmt->ExecuteStep(&hasResult)) && hasResult) {
+// If we get NULL, then there are no visits, otherwise there must always be
+// at least 1 day of history.
+bool hasNoVisits;
+(void)stmt->GetIsNull(0, &hasNoVisits);
+mDaysOfHistory = hasNoVisits ?
+0 : std::max(1, static_cast<int32_t>(ceil(stmt->AsDouble(0))));
+mLastCachedStartOfDay =
+NormalizeTime(nsINavHistoryQuery::TIME_RELATIVE_TODAY, 0);
+mLastCachedEndOfDay = stmt->AsInt64(1) - 1; // Start of tomorrow - 1.
+}
+return mDaysOfHistory;
+}
+PRTime
+nsNavHistory::GetNow()
+{
+if (!mCachedNow) {
+mCachedNow = PR_Now();
+if (!mExpireNowTimer)
+mExpireNowTimer = do_CreateInstance("@mozilla.org/timer;1");
+if (mExpireNowTimer)
+mExpireNowTimer->InitWithFuncCallback(expireNowTimerCallback, this,
+RENEW_CACHED_NOW_TIMEOUT,
+nsITimer::TYPE_ONE_SHOT);
+}
+return mCachedNow;
+}
+void nsNavHistory::expireNowTimerCallback(nsITimer* aTimer, void* aClosure)
+{
+nsNavHistory *history = static_cast<nsNavHistory *>(aClosure);
+if (history) {
+history->mCachedNow = 0;
+history->mExpireNowTimer = 0;
+}
+}
+/**
+* Code borrowed from mozilla/xpfe/components/history/src/nsGlobalHistory.cpp
+* Pass in a pre-normalized now and a date, and we'll find the difference since
+* midnight on each of the days.
+*/
+static PRTime
+NormalizeTimeRelativeToday(PRTime aTime)
+{
+// round to midnight this morning
+PRExplodedTime explodedTime;
+PR_ExplodeTime(aTime, PR_LocalTimeParameters, &explodedTime);
+// set to midnight (0:00)
+explodedTime.tm_min =
+explodedTime.tm_hour =
+explodedTime.tm_sec =
+explodedTime.tm_usec = 0;
+return PR_ImplodeTime(&explodedTime);
+}
+// nsNavHistory::NormalizeTime
+//
+//    Converts a nsINavHistoryQuery reference+offset time into a PRTime
+//    relative to the epoch.
+//
+//    It is important that this function NOT use the current time optimization.
+//    It is called to update queries, and we really need to know what right
+//    now is because those incoming values will also have current times that
+//    we will have to compare against.
+PRTime // static
+nsNavHistory::NormalizeTime(uint32_t aRelative, PRTime aOffset)
+{
+PRTime ref;
+switch (aRelative)
+{
+case nsINavHistoryQuery::TIME_RELATIVE_EPOCH:
+return aOffset;
+case nsINavHistoryQuery::TIME_RELATIVE_TODAY:
+ref = NormalizeTimeRelativeToday(PR_Now());
+break;
+case nsINavHistoryQuery::TIME_RELATIVE_NOW:
+ref = PR_Now();
+break;
+default:
+NS_NOTREACHED("Invalid relative time");
+return 0;
+}
+return ref + aOffset;
+}
+// nsNavHistory::GetUpdateRequirements
+//
+//    Returns conditions for query update.
+//
+//    QUERYUPDATE_TIME:
+//      This query is only limited by an inclusive time range on the first
+//      query object. The caller can quickly evaluate the time itself if it
+//      chooses. This is even simpler than "simple" below.
+//    QUERYUPDATE_SIMPLE:
+//      This query is evaluatable using EvaluateQueryForNode to do live
+//      updating.
+//    QUERYUPDATE_COMPLEX:
+//      This query is not evaluatable using EvaluateQueryForNode. When something
+//      happens that this query updates, you will need to re-run the query.
+//    QUERYUPDATE_COMPLEX_WITH_BOOKMARKS:
+//      A complex query that additionally has dependence on bookmarks. All
+//      bookmark-dependent queries fall under this category.
+//
+//    aHasSearchTerms will be set to true if the query has any dependence on
+//    keywords. When there is no dependence on keywords, we can handle title
+//    change operations as simple instead of complex.
+uint32_t
+nsNavHistory::GetUpdateRequirements(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions* aOptions,
+bool* aHasSearchTerms)
+{
+NS_ASSERTION(aQueries.Count() > 0, "Must have at least one query");
+// first check if there are search terms
+*aHasSearchTerms = false;
+int32_t i;
+for (i = 0; i < aQueries.Count(); i ++) {
+aQueries[i]->GetHasSearchTerms(aHasSearchTerms);
+if (*aHasSearchTerms)
+break;
+}
+bool nonTimeBasedItems = false;
+bool domainBasedItems = false;
+for (i = 0; i < aQueries.Count(); i ++) {
+nsNavHistoryQuery* query = aQueries[i];
+if (query->Folders().Length() > 0 ||
+query->OnlyBookmarked() ||
+query->Tags().Length() > 0) {
+return QUERYUPDATE_COMPLEX_WITH_BOOKMARKS;
+}
+// Note: we don't currently have any complex non-bookmarked items, but these
+// are expected to be added. Put detection of these items here.
+if (!query->SearchTerms().IsEmpty() ||
+!query->Domain().IsVoid() ||
+query->Uri() != nullptr)
+nonTimeBasedItems = true;
+if (! query->Domain().IsVoid())
+domainBasedItems = true;
+}
+if (aOptions->ResultType() ==
+nsINavHistoryQueryOptions::RESULTS_AS_TAG_QUERY)
+return QUERYUPDATE_COMPLEX_WITH_BOOKMARKS;
+// Whenever there is a maximum number of results,
+// and we are not a bookmark query we must requery. This
+// is because we can't generally know if any given addition/change causes
+// the item to be in the top N items in the database.
+if (aOptions->MaxResults() > 0)
+return QUERYUPDATE_COMPLEX;
+if (aQueries.Count() == 1 && domainBasedItems)
+return QUERYUPDATE_HOST;
+if (aQueries.Count() == 1 && !nonTimeBasedItems)
+return QUERYUPDATE_TIME;
+return QUERYUPDATE_SIMPLE;
+}
+// nsNavHistory::EvaluateQueryForNode
+//
+//    This runs the node through the given queries to see if satisfies the
+//    query conditions. Not every query parameters are handled by this code,
+//    but we handle the most common ones so that performance is better.
+//
+//    We assume that the time on the node is the time that we want to compare.
+//    This is not necessarily true because URL nodes have the last access time,
+//    which is not necessarily the same. However, since this is being called
+//    to update the list, we assume that the last access time is the current
+//    access time that we are being asked to compare so it works out.
+//
+//    Returns true if node matches the query, false if not.
+bool
+nsNavHistory::EvaluateQueryForNode(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions* aOptions,
+nsNavHistoryResultNode* aNode)
+{
+// lazily created from the node's string when we need to match URIs
+nsCOMPtr<nsIURI> nodeUri;
+// --- hidden ---
+if (aNode->mHidden && !aOptions->IncludeHidden())
+return false;
+for (int32_t i = 0; i < aQueries.Count(); i ++) {
+bool hasIt;
+nsCOMPtr<nsNavHistoryQuery> query = aQueries[i];
+// --- begin time ---
+query->GetHasBeginTime(&hasIt);
+if (hasIt) {
+PRTime beginTime = NormalizeTime(query->BeginTimeReference(),
+query->BeginTime());
+if (aNode->mTime < beginTime)
+continue; // before our time range
+}
+// --- end time ---
+query->GetHasEndTime(&hasIt);
+if (hasIt) {
+PRTime endTime = NormalizeTime(query->EndTimeReference(),
+query->EndTime());
+if (aNode->mTime > endTime)
+continue; // after our time range
+}
+// --- search terms ---
+if (! query->SearchTerms().IsEmpty()) {
+// we can use the existing filtering code, just give it our one object in
+// an array.
+nsCOMArray<nsNavHistoryResultNode> inputSet;
+inputSet.AppendObject(aNode);
+nsCOMArray<nsNavHistoryQuery> queries;
+queries.AppendObject(query);
+nsCOMArray<nsNavHistoryResultNode> filteredSet;
+nsresult rv = FilterResultSet(nullptr, inputSet, &filteredSet, queries, aOptions);
+if (NS_FAILED(rv))
+continue;
+if (! filteredSet.Count())
+continue; // did not make it through the filter, doesn't match
+}
+// --- domain/host matching ---
+query->GetHasDomain(&hasIt);
+if (hasIt) {
+if (! nodeUri) {
+// lazy creation of nodeUri, which might be checked for multiple queries
+if (NS_FAILED(NS_NewURI(getter_AddRefs(nodeUri), aNode->mURI)))
+continue;
+}
+nsAutoCString asciiRequest;
+if (NS_FAILED(AsciiHostNameFromHostString(query->Domain(), asciiRequest)))
+continue;
+if (query->DomainIsHost()) {
+nsAutoCString host;
+if (NS_FAILED(nodeUri->GetAsciiHost(host)))
+continue;
+if (! asciiRequest.Equals(host))
+continue; // host names don't match
+}
+// check domain names
+nsAutoCString domain;
+DomainNameFromURI(nodeUri, domain);
+if (! asciiRequest.Equals(domain))
+continue; // domain names don't match
+}
+// --- URI matching ---
+if (query->Uri()) {
+if (! nodeUri) { // lazy creation of nodeUri
+if (NS_FAILED(NS_NewURI(getter_AddRefs(nodeUri), aNode->mURI)))
+continue;
+}
+if (! query->UriIsPrefix()) {
+// easy case: the URI is an exact match
+bool equals;
+nsresult rv = query->Uri()->Equals(nodeUri, &equals);
+NS_ENSURE_SUCCESS(rv, false);
+if (! equals)
+continue;
+} else {
+// harder case: match prefix, note that we need to get the ASCII string
+// from the node's parsed URI instead of using the node's mUrl string,
+// because that might not be normalized
+nsAutoCString nodeUriString;
+nodeUri->GetAsciiSpec(nodeUriString);
+nsAutoCString queryUriString;
+query->Uri()->GetAsciiSpec(queryUriString);
+if (queryUriString.Length() > nodeUriString.Length())
+continue; // not long enough to match as prefix
+nodeUriString.SetLength(queryUriString.Length());
+if (! nodeUriString.Equals(queryUriString))
+continue; // prefixes don't match
+}
+}
+// Transitions matching.
+const nsTArray<uint32_t>& transitions = query->Transitions();
+if (aNode->mTransitionType > 0 &&
+transitions.Length() &&
+!transitions.Contains(aNode->mTransitionType)) {
+continue; // transition doesn't match.
+}
+// If we ever make it to the bottom of this loop, that means it passed all
+// tests for the given query. Since queries are ORed together, that means
+// it passed everything and we are done.
+return true;
+}
+// didn't match any query
+return false;
+}
+// nsNavHistory::AsciiHostNameFromHostString
+//
+//    We might have interesting encodings and different case in the host name.
+//    This will convert that host name into an ASCII host name by sending it
+//    through the URI canonicalization. The result can be used for comparison
+//    with other ASCII host name strings.
+nsresult // static
+nsNavHistory::AsciiHostNameFromHostString(const nsACString& aHostName,
+nsACString& aAscii)
+{
+// To properly generate a uri we must provide a protocol.
+nsAutoCString fakeURL("http://");
+fakeURL.Append(aHostName);
+nsCOMPtr<nsIURI> uri;
+nsresult rv = NS_NewURI(getter_AddRefs(uri), fakeURL);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = uri->GetAsciiHost(aAscii);
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+// nsNavHistory::DomainNameFromURI
+//
+//    This does the www.mozilla.org -> mozilla.org and
+//    foo.theregister.co.uk -> theregister.co.uk conversion
+void
+nsNavHistory::DomainNameFromURI(nsIURI *aURI,
+nsACString& aDomainName)
+{
+// lazily get the effective tld service
+if (!mTLDService)
+mTLDService = do_GetService(NS_EFFECTIVETLDSERVICE_CONTRACTID);
+if (mTLDService) {
+// get the base domain for a given hostname.
+// e.g. for "images.bbc.co.uk", this would be "bbc.co.uk".
+nsresult rv = mTLDService->GetBaseDomain(aURI, 0, aDomainName);
+if (NS_SUCCEEDED(rv))
+return;
+}
+// just return the original hostname
+// (it's also possible the host is an IP address)
+aURI->GetAsciiHost(aDomainName);
+}
+NS_IMETHODIMP
+nsNavHistory::GetHasHistoryEntries(bool* aHasEntries)
+{
+NS_ENSURE_ARG_POINTER(aHasEntries);
+*aHasEntries = GetDaysOfHistory() > 0;
+return NS_OK;
+}
+namespace {
+class InvalidateAllFrecenciesCallback : public AsyncStatementCallback
+{
+public:
+InvalidateAllFrecenciesCallback()
+{
+}
+NS_IMETHOD HandleCompletion(uint16_t aReason)
+{
+if (aReason == REASON_FINISHED) {
+nsNavHistory *navHistory = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(navHistory);
+navHistory->NotifyManyFrecenciesChanged();
+}
+return NS_OK;
+}
+};
+} // anonymous namespace
+nsresult
+nsNavHistory::invalidateFrecencies(const nsCString& aPlaceIdsQueryString)
+{
+// Exclude place: queries by setting their frecency to zero.
+nsCString invalidFrecenciesSQLFragment(
+"UPDATE moz_places SET frecency = "
+);
+if (!aPlaceIdsQueryString.IsEmpty())
+invalidFrecenciesSQLFragment.AppendLiteral("NOTIFY_FRECENCY(");
+invalidFrecenciesSQLFragment.AppendLiteral(
+"(CASE "
+"WHEN url BETWEEN 'place:' AND 'place;' "
+"THEN 0 "
+"ELSE -1 "
+"END) "
+);
+if (!aPlaceIdsQueryString.IsEmpty()) {
+invalidFrecenciesSQLFragment.AppendLiteral(
+", url, guid, hidden, last_visit_date) "
+);
+}
+invalidFrecenciesSQLFragment.AppendLiteral(
+"WHERE frecency > 0 "
+);
+if (!aPlaceIdsQueryString.IsEmpty()) {
+invalidFrecenciesSQLFragment.AppendLiteral("AND id IN(");
+invalidFrecenciesSQLFragment.Append(aPlaceIdsQueryString);
+invalidFrecenciesSQLFragment.AppendLiteral(")");
+}
+nsRefPtr<InvalidateAllFrecenciesCallback> cb =
+aPlaceIdsQueryString.IsEmpty() ? new InvalidateAllFrecenciesCallback()
+: nullptr;
+nsCOMPtr<mozIStorageAsyncStatement> stmt = mDB->GetAsyncStatement(
+invalidFrecenciesSQLFragment
+);
+NS_ENSURE_STATE(stmt);
+nsCOMPtr<mozIStoragePendingStatement> ps;
+nsresult rv = stmt->ExecuteAsync(cb, getter_AddRefs(ps));
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+// Call this method before visiting a URL in order to help determine the
+// transition type of the visit.
+//
+// @see MarkPageAsTyped
+NS_IMETHODIMP
+nsNavHistory::MarkPageAsFollowedBookmark(nsIURI* aURI)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+// don't add when history is disabled
+if (IsHistoryDisabled())
+return NS_OK;
+nsAutoCString uriString;
+nsresult rv = aURI->GetSpec(uriString);
+NS_ENSURE_SUCCESS(rv, rv);
+// if URL is already in the bookmark queue, then we need to remove the old one
+int64_t unusedEventTime;
+if (mRecentBookmark.Get(uriString, &unusedEventTime))
+mRecentBookmark.Remove(uriString);
+if (mRecentBookmark.Count() > RECENT_EVENT_QUEUE_MAX_LENGTH)
+ExpireNonrecentEvents(&mRecentBookmark);
+mRecentBookmark.Put(uriString, GetNow());
+return NS_OK;
+}
+// nsNavHistory::CanAddURI
+//
+//    Filter out unwanted URIs such as "chrome:", "mailbox:", etc.
+//
+//    The model is if we don't know differently then add which basically means
+//    we are suppose to try all the things we know not to allow in and then if
+//    we don't bail go on and allow it in.
+NS_IMETHODIMP
+nsNavHistory::CanAddURI(nsIURI* aURI, bool* canAdd)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+NS_ENSURE_ARG_POINTER(canAdd);
+// If history is disabled, don't add any entry.
+if (IsHistoryDisabled()) {
+*canAdd = false;
+return NS_OK;
+}
+nsAutoCString scheme;
+nsresult rv = aURI->GetScheme(scheme);
+NS_ENSURE_SUCCESS(rv, rv);
+// first check the most common cases (HTTP, HTTPS) to allow in to avoid most
+// of the work
+if (scheme.EqualsLiteral("http")) {
+*canAdd = true;
+return NS_OK;
+}
+if (scheme.EqualsLiteral("https")) {
+*canAdd = true;
+return NS_OK;
+}
+// now check for all bad things
+if (scheme.EqualsLiteral("about") ||
+scheme.EqualsLiteral("imap") ||
+scheme.EqualsLiteral("news") ||
+scheme.EqualsLiteral("mailbox") ||
+scheme.EqualsLiteral("moz-anno") ||
+scheme.EqualsLiteral("view-source") ||
+scheme.EqualsLiteral("chrome") ||
+scheme.EqualsLiteral("resource") ||
+scheme.EqualsLiteral("data") ||
+scheme.EqualsLiteral("wyciwyg") ||
+scheme.EqualsLiteral("javascript") ||
+scheme.EqualsLiteral("blob")) {
+*canAdd = false;
+return NS_OK;
+}
+*canAdd = true;
+return NS_OK;
+}
+// nsNavHistory::GetNewQuery
+NS_IMETHODIMP
+nsNavHistory::GetNewQuery(nsINavHistoryQuery **_retval)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG_POINTER(_retval);
+nsRefPtr<nsNavHistoryQuery> query = new nsNavHistoryQuery();
+query.forget(_retval);
+return NS_OK;
+}
+// nsNavHistory::GetNewQueryOptions
+NS_IMETHODIMP
+nsNavHistory::GetNewQueryOptions(nsINavHistoryQueryOptions **_retval)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG_POINTER(_retval);
+nsRefPtr<nsNavHistoryQueryOptions> queryOptions = new nsNavHistoryQueryOptions();
+queryOptions.forget(_retval);
+return NS_OK;
+}
+// nsNavHistory::ExecuteQuery
+//
+NS_IMETHODIMP
+nsNavHistory::ExecuteQuery(nsINavHistoryQuery *aQuery, nsINavHistoryQueryOptions *aOptions,
+nsINavHistoryResult** _retval)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aQuery);
+NS_ENSURE_ARG(aOptions);
+NS_ENSURE_ARG_POINTER(_retval);
+return ExecuteQueries(&aQuery, 1, aOptions, _retval);
+}
+// nsNavHistory::ExecuteQueries
+//
+//    This function is actually very simple, we just create the proper root node (either
+//    a bookmark folder or a complex query node) and assign it to the result. The node
+//    will then populate itself accordingly.
+//
+//    Quick overview of query operation: When you call this function, we will construct
+//    the correct container node and set the options you give it. This node will then
+//    fill itself. Folder nodes will call nsNavBookmarks::QueryFolderChildren, and
+//    all other queries will call GetQueryResults. If these results contain other
+//    queries, those will be populated when the container is opened.
+NS_IMETHODIMP
+nsNavHistory::ExecuteQueries(nsINavHistoryQuery** aQueries, uint32_t aQueryCount,
+nsINavHistoryQueryOptions *aOptions,
+nsINavHistoryResult** _retval)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aQueries);
+NS_ENSURE_ARG(aOptions);
+NS_ENSURE_ARG(aQueryCount);
+NS_ENSURE_ARG_POINTER(_retval);
+nsresult rv;
+// concrete options
+nsCOMPtr<nsNavHistoryQueryOptions> options = do_QueryInterface(aOptions);
+NS_ENSURE_TRUE(options, NS_ERROR_INVALID_ARG);
+// concrete queries array
+nsCOMArray<nsNavHistoryQuery> queries;
+for (uint32_t i = 0; i < aQueryCount; i ++) {
+nsCOMPtr<nsNavHistoryQuery> query = do_QueryInterface(aQueries[i], &rv);
+NS_ENSURE_SUCCESS(rv, rv);
+queries.AppendObject(query);
+}
+// Create the root node.
+nsRefPtr<nsNavHistoryContainerResultNode> rootNode;
+int64_t folderId = GetSimpleBookmarksQueryFolder(queries, options);
+if (folderId) {
+// In the simple case where we're just querying children of a single
+// bookmark folder, we can more efficiently generate results.
+nsNavBookmarks* bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_TRUE(bookmarks, NS_ERROR_OUT_OF_MEMORY);
+nsRefPtr<nsNavHistoryResultNode> tempRootNode;
+rv = bookmarks->ResultNodeForContainer(folderId, options,
+getter_AddRefs(tempRootNode));
+if (NS_SUCCEEDED(rv)) {
+rootNode = tempRootNode->GetAsContainer();
+}
+else {
+NS_WARNING("Generating a generic empty node for a broken query!");
+// This is a perf hack to generate an empty query that skips filtering.
+options->SetExcludeItems(true);
+}
+}
+if (!rootNode) {
+// Either this is not a folder shortcut, or is a broken one.  In both cases
+// just generate a query node.
+rootNode = new nsNavHistoryQueryResultNode(EmptyCString(), EmptyCString(),
+queries, options);
+}
+// Create the result that will hold nodes.  Inject batching status into it.
+nsRefPtr<nsNavHistoryResult> result;
+rv = nsNavHistoryResult::NewHistoryResult(aQueries, aQueryCount, options,
+rootNode, isBatching(),
+getter_AddRefs(result));
+NS_ENSURE_SUCCESS(rv, rv);
+result.forget(_retval);
+return NS_OK;
+}
+// determine from our nsNavHistoryQuery array and nsNavHistoryQueryOptions
+// if this is the place query from the history menu.
+// from browser-menubar.inc, our history menu query is:
+// place:sort=4&maxResults=10
+// note, any maxResult > 0 will still be considered a history menu query
+// or if this is the place query from the "Most Visited" item in the
+// "Smart Bookmarks" folder: place:sort=8&maxResults=10
+// note, any maxResult > 0 will still be considered a Most Visited menu query
+static
+bool IsOptimizableHistoryQuery(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions *aOptions,
+uint16_t aSortMode)
+{
+if (aQueries.Count() != 1)
+return false;
+nsNavHistoryQuery *aQuery = aQueries[0];
+if (aOptions->QueryType() != nsINavHistoryQueryOptions::QUERY_TYPE_HISTORY)
+return false;
+if (aOptions->ResultType() != nsINavHistoryQueryOptions::RESULTS_AS_URI)
+return false;
+if (aOptions->SortingMode() != aSortMode)
+return false;
+if (aOptions->MaxResults() <= 0)
+return false;
+if (aOptions->ExcludeItems())
+return false;
+if (aOptions->IncludeHidden())
+return false;
+if (aQuery->MinVisits() != -1 || aQuery->MaxVisits() != -1)
+return false;
+if (aQuery->BeginTime() || aQuery->BeginTimeReference())
+return false;
+if (aQuery->EndTime() || aQuery->EndTimeReference())
+return false;
+if (!aQuery->SearchTerms().IsEmpty())
+return false;
+if (aQuery->OnlyBookmarked())
+return false;
+if (aQuery->DomainIsHost() || !aQuery->Domain().IsEmpty())
+return false;
+if (aQuery->AnnotationIsNot() || !aQuery->Annotation().IsEmpty())
+return false;
+if (aQuery->UriIsPrefix() || aQuery->Uri())
+return false;
+if (aQuery->Folders().Length() > 0)
+return false;
+if (aQuery->Tags().Length() > 0)
+return false;
+if (aQuery->Transitions().Length() > 0)
+return false;
+return true;
+}
+static
+bool NeedToFilterResultSet(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions *aOptions)
+{
+uint16_t resultType = aOptions->ResultType();
+return resultType == nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS;
+}
+// ** Helper class for ConstructQueryString **/
+class PlacesSQLQueryBuilder
+{
+public:
+PlacesSQLQueryBuilder(const nsCString& aConditions,
+nsNavHistoryQueryOptions* aOptions,
+bool aUseLimit,
+nsNavHistory::StringHash& aAddParams,
+bool aHasSearchTerms);
+nsresult GetQueryString(nsCString& aQueryString);
+private:
+nsresult Select();
+nsresult SelectAsURI();
+nsresult SelectAsVisit();
+nsresult SelectAsDay();
+nsresult SelectAsSite();
+nsresult SelectAsTag();
+nsresult Where();
+nsresult GroupBy();
+nsresult OrderBy();
+nsresult Limit();
+void OrderByColumnIndexAsc(int32_t aIndex);
+void OrderByColumnIndexDesc(int32_t aIndex);
+// Use these if you want a case insensitive sorting.
+void OrderByTextColumnIndexAsc(int32_t aIndex);
+void OrderByTextColumnIndexDesc(int32_t aIndex);
+const nsCString& mConditions;
+bool mUseLimit;
+bool mHasSearchTerms;
+uint16_t mResultType;
+uint16_t mQueryType;
+bool mIncludeHidden;
+uint16_t mSortingMode;
+uint32_t mMaxResults;
+nsCString mQueryString;
+nsCString mGroupBy;
+bool mHasDateColumns;
+bool mSkipOrderBy;
+nsNavHistory::StringHash& mAddParams;
+};
+PlacesSQLQueryBuilder::PlacesSQLQueryBuilder(
+const nsCString& aConditions,
+nsNavHistoryQueryOptions* aOptions,
+bool aUseLimit,
+nsNavHistory::StringHash& aAddParams,
+bool aHasSearchTerms)
+: mConditions(aConditions)
+, mUseLimit(aUseLimit)
+, mHasSearchTerms(aHasSearchTerms)
+, mResultType(aOptions->ResultType())
+, mQueryType(aOptions->QueryType())
+, mIncludeHidden(aOptions->IncludeHidden())
+, mSortingMode(aOptions->SortingMode())
+, mMaxResults(aOptions->MaxResults())
+, mSkipOrderBy(false)
+, mAddParams(aAddParams)
+{
+mHasDateColumns = (mQueryType == nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS);
+}
+nsresult
+PlacesSQLQueryBuilder::GetQueryString(nsCString& aQueryString)
+{
+nsresult rv = Select();
+NS_ENSURE_SUCCESS(rv, rv);
+rv = Where();
+NS_ENSURE_SUCCESS(rv, rv);
+rv = GroupBy();
+NS_ENSURE_SUCCESS(rv, rv);
+rv = OrderBy();
+NS_ENSURE_SUCCESS(rv, rv);
+rv = Limit();
+NS_ENSURE_SUCCESS(rv, rv);
+aQueryString = mQueryString;
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::Select()
+{
+nsresult rv;
+switch (mResultType)
+{
+case nsINavHistoryQueryOptions::RESULTS_AS_URI:
+case nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS:
+rv = SelectAsURI();
+NS_ENSURE_SUCCESS(rv, rv);
+break;
+case nsINavHistoryQueryOptions::RESULTS_AS_VISIT:
+case nsINavHistoryQueryOptions::RESULTS_AS_FULL_VISIT:
+rv = SelectAsVisit();
+NS_ENSURE_SUCCESS(rv, rv);
+break;
+case nsINavHistoryQueryOptions::RESULTS_AS_DATE_QUERY:
+case nsINavHistoryQueryOptions::RESULTS_AS_DATE_SITE_QUERY:
+rv = SelectAsDay();
+NS_ENSURE_SUCCESS(rv, rv);
+break;
+case nsINavHistoryQueryOptions::RESULTS_AS_SITE_QUERY:
+rv = SelectAsSite();
+NS_ENSURE_SUCCESS(rv, rv);
+break;
+case nsINavHistoryQueryOptions::RESULTS_AS_TAG_QUERY:
+rv = SelectAsTag();
+NS_ENSURE_SUCCESS(rv, rv);
+break;
+default:
+NS_NOTREACHED("Invalid result type");
+}
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::SelectAsURI()
+{
+nsNavHistory *history = nsNavHistory::GetHistoryService();
+NS_ENSURE_TRUE(history, NS_ERROR_OUT_OF_MEMORY);
+nsAutoCString tagsSqlFragment;
+switch (mQueryType) {
+case nsINavHistoryQueryOptions::QUERY_TYPE_HISTORY:
+GetTagsSqlFragment(history->GetTagsFolder(),
+NS_LITERAL_CSTRING("h.id"),
+mHasSearchTerms,
+tagsSqlFragment);
+mQueryString = NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.title AS page_title, h.rev_host, h.visit_count, "
+"h.last_visit_date, f.url, null, null, null, null, ") +
+tagsSqlFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+// WHERE 1 is a no-op since additonal conditions will start with AND.
+"WHERE 1 "
+"{QUERY_OPTIONS_VISITS} {QUERY_OPTIONS_PLACES} "
+"{ADDITIONAL_CONDITIONS} ");
+break;
+case nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS:
+if (mResultType == nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS) {
+// Order-by clause is hardcoded because we need to discard duplicates
+// in FilterResultSet. We will retain only the last modified item,
+// so we are ordering by place id and last modified to do a faster
+// filtering.
+mSkipOrderBy = true;
+GetTagsSqlFragment(history->GetTagsFolder(),
+NS_LITERAL_CSTRING("b2.fk"),
+mHasSearchTerms,
+tagsSqlFragment);
+mQueryString = NS_LITERAL_CSTRING(
+"SELECT b2.fk, h.url, COALESCE(b2.title, h.title) AS page_title, "
+"h.rev_host, h.visit_count, h.last_visit_date, f.url, b2.id, "
+"b2.dateAdded, b2.lastModified, b2.parent, ") +
+tagsSqlFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_bookmarks b2 "
+"JOIN (SELECT b.fk "
+"FROM moz_bookmarks b "
+// ADDITIONAL_CONDITIONS will filter on parent.
+"WHERE b.type = 1 {ADDITIONAL_CONDITIONS} "
+") AS seed ON b2.fk = seed.fk "
+"JOIN moz_places h ON h.id = b2.fk "
+"LEFT OUTER JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE NOT EXISTS ( "
+"SELECT id FROM moz_bookmarks WHERE id = b2.parent AND parent = ") +
+nsPrintfCString("%lld", history->GetTagsFolder()) +
+NS_LITERAL_CSTRING(") "
+"ORDER BY b2.fk DESC, b2.lastModified DESC");
+}
+else {
+GetTagsSqlFragment(history->GetTagsFolder(),
+NS_LITERAL_CSTRING("b.fk"),
+mHasSearchTerms,
+tagsSqlFragment);
+mQueryString = NS_LITERAL_CSTRING(
+"SELECT b.fk, h.url, COALESCE(b.title, h.title) AS page_title, "
+"h.rev_host, h.visit_count, h.last_visit_date, f.url, b.id, "
+"b.dateAdded, b.lastModified, b.parent, ") +
+tagsSqlFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_bookmarks b "
+"JOIN moz_places h ON b.fk = h.id "
+"LEFT OUTER JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE NOT EXISTS "
+"(SELECT id FROM moz_bookmarks "
+"WHERE id = b.parent AND parent = ") +
+nsPrintfCString("%lld", history->GetTagsFolder()) +
+NS_LITERAL_CSTRING(") "
+"{ADDITIONAL_CONDITIONS}");
+}
+break;
+default:
+return NS_ERROR_NOT_IMPLEMENTED;
+}
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::SelectAsVisit()
+{
+nsNavHistory *history = nsNavHistory::GetHistoryService();
+NS_ENSURE_TRUE(history, NS_ERROR_OUT_OF_MEMORY);
+nsAutoCString tagsSqlFragment;
+GetTagsSqlFragment(history->GetTagsFolder(),
+NS_LITERAL_CSTRING("h.id"),
+mHasSearchTerms,
+tagsSqlFragment);
+mQueryString = NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.title AS page_title, h.rev_host, h.visit_count, "
+"v.visit_date, f.url, null, null, null, null, ") +
+tagsSqlFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"JOIN moz_historyvisits v ON h.id = v.place_id "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+// WHERE 1 is a no-op since additonal conditions will start with AND.
+"WHERE 1 "
+"{QUERY_OPTIONS_VISITS} {QUERY_OPTIONS_PLACES} "
+"{ADDITIONAL_CONDITIONS} ");
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::SelectAsDay()
+{
+mSkipOrderBy = true;
+// Sort child queries based on sorting mode if it's provided, otherwise
+// fallback to default sort by title ascending.
+uint16_t sortingMode = nsINavHistoryQueryOptions::SORT_BY_TITLE_ASCENDING;
+if (mSortingMode != nsINavHistoryQueryOptions::SORT_BY_NONE &&
+mResultType == nsINavHistoryQueryOptions::RESULTS_AS_DATE_QUERY)
+sortingMode = mSortingMode;
+uint16_t resultType =
+mResultType == nsINavHistoryQueryOptions::RESULTS_AS_DATE_QUERY ?
+(uint16_t)nsINavHistoryQueryOptions::RESULTS_AS_URI :
+(uint16_t)nsINavHistoryQueryOptions::RESULTS_AS_SITE_QUERY;
+// beginTime will become the node's time property, we don't use endTime
+// because it could overlap, and we use time to sort containers and find
+// insert position in a result.
+mQueryString = nsPrintfCString(
+"SELECT null, "
+"'place:type=%ld&sort=%ld&beginTime='||beginTime||'&endTime='||endTime, "
+"dayTitle, null, null, beginTime, null, null, null, null, null, null "
+"FROM (", // TOUTER BEGIN
+resultType,
+sortingMode);
+nsNavHistory *history = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(history);
+int32_t daysOfHistory = history->GetDaysOfHistory();
+for (int32_t i = 0; i <= HISTORY_DATE_CONT_NUM(daysOfHistory); i++) {
+nsAutoCString dateName;
+// Timeframes are calculated as BeginTime <= container < EndTime.
+// Notice times can't be relative to now, since to recognize a query we
+// must ensure it won't change based on the time it is built.
+// So, to select till now, we really select till start of tomorrow, that is
+// a fixed timestamp.
+// These are used as limits for the inside containers.
+nsAutoCString sqlFragmentContainerBeginTime, sqlFragmentContainerEndTime;
+// These are used to query if the container should be visible.
+nsAutoCString sqlFragmentSearchBeginTime, sqlFragmentSearchEndTime;
+switch(i) {
+case 0:
+// Today
+history->GetStringFromName(
+MOZ_UTF16("finduri-AgeInDays-is-0"), dateName);
+// From start of today
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','utc')*1000000)");
+// To now (tomorrow)
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','+1 day','utc')*1000000)");
+// Search for the same timeframe.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = sqlFragmentContainerEndTime;
+break;
+case 1:
+// Yesterday
+history->GetStringFromName(
+MOZ_UTF16("finduri-AgeInDays-is-1"), dateName);
+// From start of yesterday
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','-1 day','utc')*1000000)");
+// To start of today
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','utc')*1000000)");
+// Search for the same timeframe.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = sqlFragmentContainerEndTime;
+break;
+case 2:
+// Last 7 days
+history->GetAgeInDaysString(7,
+MOZ_UTF16("finduri-AgeInDays-last-is"), dateName);
+// From start of 7 days ago
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','-7 days','utc')*1000000)");
+// To now (tomorrow)
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','+1 day','utc')*1000000)");
+// This is an overlapped container, but we show it only if there are
+// visits older than yesterday.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','-2 days','utc')*1000000)");
+break;
+case 3:
+// This month
+history->GetStringFromName(
+MOZ_UTF16("finduri-AgeInMonths-is-0"), dateName);
+// From start of this month
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of month','utc')*1000000)");
+// To now (tomorrow)
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','+1 day','utc')*1000000)");
+// This is an overlapped container, but we show it only if there are
+// visits older than 7 days ago.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of day','-7 days','utc')*1000000)");
+break;
+default:
+if (i == HISTORY_ADDITIONAL_DATE_CONT_NUM + 6) {
+// Older than 6 months
+history->GetAgeInDaysString(6,
+MOZ_UTF16("finduri-AgeInMonths-isgreater"), dateName);
+// From start of epoch
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(datetime(0, 'unixepoch')*1000000)");
+// To start of 6 months ago ( 5 months + this month).
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of month','-5 months','utc')*1000000)");
+// Search for the same timeframe.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = sqlFragmentContainerEndTime;
+break;
+}
+int32_t MonthIndex = i - HISTORY_ADDITIONAL_DATE_CONT_NUM;
+// Previous months' titles are month's name if inside this year,
+// month's name and year for previous years.
+PRExplodedTime tm;
+PR_ExplodeTime(PR_Now(), PR_LocalTimeParameters, &tm);
+uint16_t currentYear = tm.tm_year;
+// Set day before month, setting month without day could cause issues.
+// For example setting month to February when today is 30, since
+// February has not 30 days, will return March instead.
+// Also, we use day 2 instead of day 1, so that the GMT month is always
+// the same as the local month. (Bug 603002)
+tm.tm_mday = 2;
+tm.tm_month -= MonthIndex;
+// Notice we use GMTParameters because we just want to get the first
+// day of each month.  Using LocalTimeParameters would instead force us
+// to apply a DST correction that we don't really need here.
+PR_NormalizeTime(&tm, PR_GMTParameters);
+// If the container is for a past year, add the year to its title,
+// otherwise just show the month name.
+// Note that tm_month starts from 0, while we need a 1-based index.
+if (tm.tm_year < currentYear) {
+history->GetMonthYear(tm.tm_month + 1, tm.tm_year, dateName);
+}
+else {
+history->GetMonthName(tm.tm_month + 1, dateName);
+}
+// From start of MonthIndex + 1 months ago
+sqlFragmentContainerBeginTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of month','-");
+sqlFragmentContainerBeginTime.AppendInt(MonthIndex);
+sqlFragmentContainerBeginTime.Append(NS_LITERAL_CSTRING(
+" months','utc')*1000000)"));
+// To start of MonthIndex months ago
+sqlFragmentContainerEndTime = NS_LITERAL_CSTRING(
+"(strftime('%s','now','localtime','start of month','-");
+sqlFragmentContainerEndTime.AppendInt(MonthIndex - 1);
+sqlFragmentContainerEndTime.Append(NS_LITERAL_CSTRING(
+" months','utc')*1000000)"));
+// Search for the same timeframe.
+sqlFragmentSearchBeginTime = sqlFragmentContainerBeginTime;
+sqlFragmentSearchEndTime = sqlFragmentContainerEndTime;
+break;
+}
+nsPrintfCString dateParam("dayTitle%d", i);
+mAddParams.Put(dateParam, dateName);
+nsPrintfCString dayRange(
+"SELECT :%s AS dayTitle, "
+"%s AS beginTime, "
+"%s AS endTime "
+"WHERE EXISTS ( "
+"SELECT id FROM moz_historyvisits "
+"WHERE visit_date >= %s "
+"AND visit_date < %s "
+"AND visit_type NOT IN (0,%d,%d) "
+"{QUERY_OPTIONS_VISITS} "
+"LIMIT 1 "
+") ",
+dateParam.get(),
+sqlFragmentContainerBeginTime.get(),
+sqlFragmentContainerEndTime.get(),
+sqlFragmentSearchBeginTime.get(),
+sqlFragmentSearchEndTime.get(),
+nsINavHistoryService::TRANSITION_EMBED,
+nsINavHistoryService::TRANSITION_FRAMED_LINK
+);
+mQueryString.Append(dayRange);
+if (i < HISTORY_DATE_CONT_NUM(daysOfHistory))
+mQueryString.Append(NS_LITERAL_CSTRING(" UNION ALL "));
+}
+mQueryString.Append(NS_LITERAL_CSTRING(") ")); // TOUTER END
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::SelectAsSite()
+{
+nsAutoCString localFiles;
+nsNavHistory *history = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(history);
+history->GetStringFromName(MOZ_UTF16("localhost"), localFiles);
+mAddParams.Put(NS_LITERAL_CSTRING("localhost"), localFiles);
+// If there are additional conditions the query has to join on visits too.
+nsAutoCString visitsJoin;
+nsAutoCString additionalConditions;
+nsAutoCString timeConstraints;
+if (!mConditions.IsEmpty()) {
+visitsJoin.AssignLiteral("JOIN moz_historyvisits v ON v.place_id = h.id ");
+additionalConditions.AssignLiteral("{QUERY_OPTIONS_VISITS} "
+"{QUERY_OPTIONS_PLACES} "
+"{ADDITIONAL_CONDITIONS} ");
+timeConstraints.AssignLiteral("||'&beginTime='||:begin_time||"
+"'&endTime='||:end_time");
+}
+mQueryString = nsPrintfCString(
+"SELECT null, 'place:type=%ld&sort=%ld&domain=&domainIsHost=true'%s, "
+":localhost, :localhost, null, null, null, null, null, null, null "
+"WHERE EXISTS ( "
+"SELECT h.id FROM moz_places h "
+"%s "
+"WHERE h.hidden = 0 "
+"AND h.visit_count > 0 "
+"AND h.url BETWEEN 'file://' AND 'file:/~' "
+"%s "
+"LIMIT 1 "
+") "
+"UNION ALL "
+"SELECT null, "
+"'place:type=%ld&sort=%ld&domain='||host||'&domainIsHost=true'%s, "
+"host, host, null, null, null, null, null, null, null "
+"FROM ( "
+"SELECT get_unreversed_host(h.rev_host) AS host "
+"FROM moz_places h "
+"%s "
+"WHERE h.hidden = 0 "
+"AND h.rev_host <> '.' "
+"AND h.visit_count > 0 "
+"%s "
+"GROUP BY h.rev_host "
+"ORDER BY host ASC "
+") ",
+nsINavHistoryQueryOptions::RESULTS_AS_URI,
+mSortingMode,
+timeConstraints.get(),
+visitsJoin.get(),
+additionalConditions.get(),
+nsINavHistoryQueryOptions::RESULTS_AS_URI,
+mSortingMode,
+timeConstraints.get(),
+visitsJoin.get(),
+additionalConditions.get()
+);
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::SelectAsTag()
+{
+nsNavHistory *history = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(history);
+// This allows sorting by date fields what is not possible with
+// other history queries.
+mHasDateColumns = true;
+mQueryString = nsPrintfCString(
+"SELECT null, 'place:folder=' || id || '&queryType=%d&type=%ld', "
+"title, null, null, null, null, null, dateAdded, "
+"lastModified, null, null, null "
+"FROM moz_bookmarks "
+"WHERE parent = %lld",
+nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS,
+nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS,
+history->GetTagsFolder()
+);
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::Where()
+{
+// Set query options
+nsAutoCString additionalVisitsConditions;
+nsAutoCString additionalPlacesConditions;
+if (!mIncludeHidden) {
+additionalPlacesConditions += NS_LITERAL_CSTRING("AND hidden = 0 ");
+}
+if (mQueryType == nsINavHistoryQueryOptions::QUERY_TYPE_HISTORY) {
+// last_visit_date is updated for any kind of visit, so it's a good
+// indicator whether the page has visits.
+additionalPlacesConditions += NS_LITERAL_CSTRING(
+"AND last_visit_date NOTNULL "
+);
+}
+if (mResultType == nsINavHistoryQueryOptions::RESULTS_AS_URI &&
+!additionalVisitsConditions.IsEmpty()) {
+// URI results don't join on visits.
+nsAutoCString tmp = additionalVisitsConditions;
+additionalVisitsConditions = "AND EXISTS (SELECT 1 FROM moz_historyvisits WHERE place_id = h.id ";
+additionalVisitsConditions.Append(tmp);
+additionalVisitsConditions.Append("LIMIT 1)");
+}
+mQueryString.ReplaceSubstring("{QUERY_OPTIONS_VISITS}",
+additionalVisitsConditions.get());
+mQueryString.ReplaceSubstring("{QUERY_OPTIONS_PLACES}",
+additionalPlacesConditions.get());
+// If we used WHERE already, we inject the conditions
+// in place of {ADDITIONAL_CONDITIONS}
+if (mQueryString.Find("{ADDITIONAL_CONDITIONS}", 0) != kNotFound) {
+nsAutoCString innerCondition;
+// If we have condition AND it
+if (!mConditions.IsEmpty()) {
+innerCondition = " AND (";
+innerCondition += mConditions;
+innerCondition += ")";
+}
+mQueryString.ReplaceSubstring("{ADDITIONAL_CONDITIONS}",
+innerCondition.get());
+} else if (!mConditions.IsEmpty()) {
+mQueryString += "WHERE ";
+mQueryString += mConditions;
+}
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::GroupBy()
+{
+mQueryString += mGroupBy;
+return NS_OK;
+}
+nsresult
+PlacesSQLQueryBuilder::OrderBy()
+{
+if (mSkipOrderBy)
+return NS_OK;
+// Sort clause: we will sort later, but if it comes out of the DB sorted,
+// our later sort will be basically free. The DB can sort these for free
+// most of the time anyway, because it has indices over these items.
+switch(mSortingMode)
+{
+case nsINavHistoryQueryOptions::SORT_BY_NONE:
+// Ensure sorting does not change based on tables status.
+if (mResultType == nsINavHistoryQueryOptions::RESULTS_AS_URI) {
+if (mQueryType == nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS)
+mQueryString += NS_LITERAL_CSTRING(" ORDER BY b.id ASC ");
+else if (mQueryType == nsINavHistoryQueryOptions::QUERY_TYPE_HISTORY)
+mQueryString += NS_LITERAL_CSTRING(" ORDER BY h.id ASC ");
+}
+break;
+case nsINavHistoryQueryOptions::SORT_BY_TITLE_ASCENDING:
+case nsINavHistoryQueryOptions::SORT_BY_TITLE_DESCENDING:
+// If the user wants few results, we limit them by date, necessitating
+// a sort by date here (see the IDL definition for maxResults).
+// Otherwise we will do actual sorting by title, but since we could need
+// to special sort for some locale we will repeat a second sorting at the
+// end in nsNavHistoryResult, that should be faster since the list will be
+// almost ordered.
+if (mMaxResults > 0)
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_VisitDate);
+else if (mSortingMode == nsINavHistoryQueryOptions::SORT_BY_TITLE_ASCENDING)
+OrderByTextColumnIndexAsc(nsNavHistory::kGetInfoIndex_Title);
+else
+OrderByTextColumnIndexDesc(nsNavHistory::kGetInfoIndex_Title);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_DATE_ASCENDING:
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_VisitDate);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_DATE_DESCENDING:
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_VisitDate);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_URI_ASCENDING:
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_URL);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_URI_DESCENDING:
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_URL);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_VISITCOUNT_ASCENDING:
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_VisitCount);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_VISITCOUNT_DESCENDING:
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_VisitCount);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_DATEADDED_ASCENDING:
+if (mHasDateColumns)
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_ItemDateAdded);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_DATEADDED_DESCENDING:
+if (mHasDateColumns)
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_ItemDateAdded);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_LASTMODIFIED_ASCENDING:
+if (mHasDateColumns)
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_ItemLastModified);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_LASTMODIFIED_DESCENDING:
+if (mHasDateColumns)
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_ItemLastModified);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_TAGS_ASCENDING:
+case nsINavHistoryQueryOptions::SORT_BY_TAGS_DESCENDING:
+case nsINavHistoryQueryOptions::SORT_BY_ANNOTATION_ASCENDING:
+case nsINavHistoryQueryOptions::SORT_BY_ANNOTATION_DESCENDING:
+break; // Sort later in nsNavHistoryQueryResultNode::FillChildren()
+case nsINavHistoryQueryOptions::SORT_BY_FRECENCY_ASCENDING:
+OrderByColumnIndexAsc(nsNavHistory::kGetInfoIndex_Frecency);
+break;
+case nsINavHistoryQueryOptions::SORT_BY_FRECENCY_DESCENDING:
+OrderByColumnIndexDesc(nsNavHistory::kGetInfoIndex_Frecency);
+break;
+default:
+NS_NOTREACHED("Invalid sorting mode");
+}
+return NS_OK;
+}
+void PlacesSQLQueryBuilder::OrderByColumnIndexAsc(int32_t aIndex)
+{
+mQueryString += nsPrintfCString(" ORDER BY %d ASC", aIndex+1);
+}
+void PlacesSQLQueryBuilder::OrderByColumnIndexDesc(int32_t aIndex)
+{
+mQueryString += nsPrintfCString(" ORDER BY %d DESC", aIndex+1);
+}
+void PlacesSQLQueryBuilder::OrderByTextColumnIndexAsc(int32_t aIndex)
+{
+mQueryString += nsPrintfCString(" ORDER BY %d COLLATE NOCASE ASC",
+aIndex+1);
+}
+void PlacesSQLQueryBuilder::OrderByTextColumnIndexDesc(int32_t aIndex)
+{
+mQueryString += nsPrintfCString(" ORDER BY %d COLLATE NOCASE DESC",
+aIndex+1);
+}
+nsresult
+PlacesSQLQueryBuilder::Limit()
+{
+if (mUseLimit && mMaxResults > 0) {
+mQueryString += NS_LITERAL_CSTRING(" LIMIT ");
+mQueryString.AppendInt(mMaxResults);
+mQueryString.AppendLiteral(" ");
+}
+return NS_OK;
+}
+nsresult
+nsNavHistory::ConstructQueryString(
+const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions* aOptions,
+nsCString& queryString,
+bool& aParamsPresent,
+nsNavHistory::StringHash& aAddParams)
+{
+// For information about visit_type see nsINavHistoryService.idl.
+// visitType == 0 is undefined (see bug #375777 for details).
+// Some sites, especially Javascript-heavy ones, load things in frames to
+// display them, resulting in a lot of these entries. This is the reason
+// why such visits are filtered out.
+nsresult rv;
+aParamsPresent = false;
+int32_t sortingMode = aOptions->SortingMode();
+NS_ASSERTION(sortingMode >= nsINavHistoryQueryOptions::SORT_BY_NONE &&
+sortingMode <= nsINavHistoryQueryOptions::SORT_BY_FRECENCY_DESCENDING,
+"Invalid sortingMode found while building query!");
+bool hasSearchTerms = false;
+for (int32_t i = 0; i < aQueries.Count() && !hasSearchTerms; i++) {
+aQueries[i]->GetHasSearchTerms(&hasSearchTerms);
+}
+nsAutoCString tagsSqlFragment;
+GetTagsSqlFragment(GetTagsFolder(),
+NS_LITERAL_CSTRING("h.id"),
+hasSearchTerms,
+tagsSqlFragment);
+if (IsOptimizableHistoryQuery(aQueries, aOptions,
+nsINavHistoryQueryOptions::SORT_BY_DATE_DESCENDING) ||
+IsOptimizableHistoryQuery(aQueries, aOptions,
+nsINavHistoryQueryOptions::SORT_BY_VISITCOUNT_DESCENDING)) {
+// Generate an optimized query for the history menu and most visited
+// smart bookmark.
+queryString = NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.title AS page_title, h.rev_host, h.visit_count, h.last_visit_date, "
+"f.url, null, null, null, null, ") +
+tagsSqlFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"LEFT OUTER JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE h.hidden = 0 "
+"AND EXISTS (SELECT id FROM moz_historyvisits WHERE place_id = h.id "
+"AND visit_type NOT IN ") +
+nsPrintfCString("(0,%d,%d) ",
+nsINavHistoryService::TRANSITION_EMBED,
+nsINavHistoryService::TRANSITION_FRAMED_LINK) +
+NS_LITERAL_CSTRING("LIMIT 1) "
+"{QUERY_OPTIONS} "
+);
+queryString.Append(NS_LITERAL_CSTRING("ORDER BY "));
+if (sortingMode == nsINavHistoryQueryOptions::SORT_BY_DATE_DESCENDING)
+queryString.Append(NS_LITERAL_CSTRING("last_visit_date DESC "));
+else
+queryString.Append(NS_LITERAL_CSTRING("visit_count DESC "));
+queryString.Append(NS_LITERAL_CSTRING("LIMIT "));
+queryString.AppendInt(aOptions->MaxResults());
+nsAutoCString additionalQueryOptions;
+queryString.ReplaceSubstring("{QUERY_OPTIONS}",
+additionalQueryOptions.get());
+return NS_OK;
+}
+nsAutoCString conditions;
+for (int32_t i = 0; i < aQueries.Count(); i++) {
+nsCString queryClause;
+rv = QueryToSelectClause(aQueries[i], aOptions, i, &queryClause);
+NS_ENSURE_SUCCESS(rv, rv);
+if (! queryClause.IsEmpty()) {
+aParamsPresent = true;
+if (! conditions.IsEmpty()) // exists previous clause: multiple ones are ORed
+conditions += NS_LITERAL_CSTRING(" OR ");
+conditions += NS_LITERAL_CSTRING("(") + queryClause +
+NS_LITERAL_CSTRING(")");
+}
+}
+// Determine whether we can push maxResults constraints into the queries
+// as LIMIT, or if we need to do result count clamping later
+// using FilterResultSet()
+bool useLimitClause = !NeedToFilterResultSet(aQueries, aOptions);
+PlacesSQLQueryBuilder queryStringBuilder(conditions, aOptions,
+useLimitClause, aAddParams,
+hasSearchTerms);
+rv = queryStringBuilder.GetQueryString(queryString);
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+PLDHashOperator BindAdditionalParameter(nsNavHistory::StringHash::KeyType aParamName,
+nsCString aParamValue,
+void* aStatement)
+{
+mozIStorageStatement* stmt = static_cast<mozIStorageStatement*>(aStatement);
+nsresult rv = stmt->BindUTF8StringByName(aParamName, aParamValue);
+if (NS_FAILED(rv))
+return PL_DHASH_STOP;
+return PL_DHASH_NEXT;
+}
+// nsNavHistory::GetQueryResults
+//
+//    Call this to get the results from a complex query. This is used by
+//    nsNavHistoryQueryResultNode to populate its children. For simple bookmark
+//    queries, use nsNavBookmarks::QueryFolderChildren.
+//
+//    THIS DOES NOT DO SORTING. You will need to sort the container yourself
+//    when you get the results. This is because sorting depends on tree
+//    statistics that will be built from the perspective of the tree. See
+//    nsNavHistoryQueryResultNode::FillChildren
+//
+//    FIXME: This only does keyword searching for the first query, and does
+//    it ANDed with the all the rest of the queries.
+nsresult
+nsNavHistory::GetQueryResults(nsNavHistoryQueryResultNode *aResultNode,
+const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions *aOptions,
+nsCOMArray<nsNavHistoryResultNode>* aResults)
+{
+NS_ENSURE_ARG_POINTER(aOptions);
+NS_ASSERTION(aResults->Count() == 0, "Initial result array must be empty");
+if (! aQueries.Count())
+return NS_ERROR_INVALID_ARG;
+nsCString queryString;
+bool paramsPresent = false;
+nsNavHistory::StringHash addParams(HISTORY_DATE_CONT_MAX);
+nsresult rv = ConstructQueryString(aQueries, aOptions, queryString,
+paramsPresent, addParams);
+NS_ENSURE_SUCCESS(rv,rv);
+// create statement
+nsCOMPtr<mozIStorageStatement> statement = mDB->GetStatement(queryString);
+#ifdef DEBUG
+if (!statement) {
+nsAutoCString lastErrorString;
+(void)mDB->MainConn()->GetLastErrorString(lastErrorString);
+int32_t lastError = 0;
+(void)mDB->MainConn()->GetLastError(&lastError);
+printf("Places failed to create a statement from this query:\n%s\nStorage error (%d): %s\n",
+queryString.get(), lastError, lastErrorString.get());
+}
+#endif
+NS_ENSURE_STATE(statement);
+mozStorageStatementScoper scoper(statement);
+if (paramsPresent) {
+// bind parameters
+int32_t i;
+for (i = 0; i < aQueries.Count(); i++) {
+rv = BindQueryClauseParameters(statement, i, aQueries[i], aOptions);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+addParams.EnumerateRead(BindAdditionalParameter, statement.get());
+// Optimize the case where there is no need for any post-query filtering.
+if (NeedToFilterResultSet(aQueries, aOptions)) {
+// Generate the top-level results.
+nsCOMArray<nsNavHistoryResultNode> toplevel;
+rv = ResultsAsList(statement, aOptions, &toplevel);
+NS_ENSURE_SUCCESS(rv, rv);
+FilterResultSet(aResultNode, toplevel, aResults, aQueries, aOptions);
+} else {
+rv = ResultsAsList(statement, aOptions, aResults);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+return NS_OK;
+}
+// nsNavHistory::AddObserver
+NS_IMETHODIMP
+nsNavHistory::AddObserver(nsINavHistoryObserver* aObserver, bool aOwnsWeak)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aObserver);
+return mObservers.AppendWeakElement(aObserver, aOwnsWeak);
+}
+// nsNavHistory::RemoveObserver
+NS_IMETHODIMP
+nsNavHistory::RemoveObserver(nsINavHistoryObserver* aObserver)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aObserver);
+return mObservers.RemoveWeakElement(aObserver);
+}
+// nsNavHistory::BeginUpdateBatch
+// See RunInBatchMode
+nsresult
+nsNavHistory::BeginUpdateBatch()
+{
+if (mBatchLevel++ == 0) {
+mBatchDBTransaction = new mozStorageTransaction(mDB->MainConn(), false);
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver, OnBeginUpdateBatch());
+}
+return NS_OK;
+}
+// nsNavHistory::EndUpdateBatch
+nsresult
+nsNavHistory::EndUpdateBatch()
+{
+if (--mBatchLevel == 0) {
+if (mBatchDBTransaction) {
+DebugOnly<nsresult> rv = mBatchDBTransaction->Commit();
+NS_WARN_IF_FALSE(NS_SUCCEEDED(rv), "Batch failed to commit transaction");
+delete mBatchDBTransaction;
+mBatchDBTransaction = nullptr;
+}
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver, OnEndUpdateBatch());
+}
+return NS_OK;
+}
+NS_IMETHODIMP
+nsNavHistory::RunInBatchMode(nsINavHistoryBatchCallback* aCallback,
+nsISupports* aUserData)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aCallback);
+UpdateBatchScoper batch(*this);
+return aCallback->RunBatched(aUserData);
+}
+NS_IMETHODIMP
+nsNavHistory::GetHistoryDisabled(bool *_retval)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG_POINTER(_retval);
+*_retval = IsHistoryDisabled();
+return NS_OK;
+}
+// Browser history *************************************************************
+// nsNavHistory::RemovePagesInternal
+//
+//    Deletes a list of placeIds from history.
+//    This is an internal method used by RemovePages, RemovePagesFromHost and
+//    RemovePagesByTimeframe.
+//    Takes a comma separated list of place ids.
+//    This method does not do any observer notification.
+nsresult
+nsNavHistory::RemovePagesInternal(const nsCString& aPlaceIdsQueryString)
+{
+// Return early if there is nothing to delete.
+if (aPlaceIdsQueryString.IsEmpty())
+return NS_OK;
+mozStorageTransaction transaction(mDB->MainConn(), false);
+// Delete all visits for the specified place ids.
+nsresult rv = mDB->MainConn()->ExecuteSimpleSQL(
+NS_LITERAL_CSTRING(
+"DELETE FROM moz_historyvisits WHERE place_id IN (") +
+aPlaceIdsQueryString +
+NS_LITERAL_CSTRING(")")
+);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = CleanupPlacesOnVisitsDelete(aPlaceIdsQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+// Invalidate the cached value for whether there's history or not.
+mDaysOfHistory = -1;
+return transaction.Commit();
+}
+/**
+* Performs cleanup on places that just had all their visits removed, including
+* deletion of those places.  This is an internal method used by
+* RemovePagesInternal and RemoveVisitsByTimeframe.  This method does not
+* execute in a transaction, so callers should make sure they begin one if
+* needed.
+*
+* @param aPlaceIdsQueryString
+*        A comma-separated list of place IDs, each of which just had all its
+*        visits removed
+*/
+nsresult
+nsNavHistory::CleanupPlacesOnVisitsDelete(const nsCString& aPlaceIdsQueryString)
+{
+// Return early if there is nothing to delete.
+if (aPlaceIdsQueryString.IsEmpty())
+return NS_OK;
+// Collect about-to-be-deleted URIs to notify onDeleteURI.
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.guid, "
+"(SUBSTR(h.url, 1, 6) <> 'place:' "
+" AND NOT EXISTS (SELECT b.id FROM moz_bookmarks b "
+"WHERE b.fk = h.id LIMIT 1)) as whole_entry "
+"FROM moz_places h "
+"WHERE h.id IN ( ") + aPlaceIdsQueryString + NS_LITERAL_CSTRING(")")
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+nsCString filteredPlaceIds;
+nsCOMArray<nsIURI> URIs;
+nsTArray<nsCString> GUIDs;
+bool hasMore;
+while (NS_SUCCEEDED(stmt->ExecuteStep(&hasMore)) && hasMore) {
+int64_t placeId;
+nsresult rv = stmt->GetInt64(0, &placeId);
+NS_ENSURE_SUCCESS(rv, rv);
+nsAutoCString URLString;
+rv = stmt->GetUTF8String(1, URLString);
+nsCString guid;
+rv = stmt->GetUTF8String(2, guid);
+int32_t wholeEntry;
+rv = stmt->GetInt32(3, &wholeEntry);
+nsCOMPtr<nsIURI> uri;
+rv = NS_NewURI(getter_AddRefs(uri), URLString);
+NS_ENSURE_SUCCESS(rv, rv);
+if (wholeEntry) {
+if (!filteredPlaceIds.IsEmpty()) {
+filteredPlaceIds.AppendLiteral(",");
+}
+filteredPlaceIds.AppendInt(placeId);
+URIs.AppendObject(uri);
+GUIDs.AppendElement(guid);
+}
+else {
+// Notify that we will delete all visits for this page, but not the page
+// itself, since it's bookmarked or a place: query.
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnDeleteVisits(uri, 0, guid, nsINavHistoryObserver::REASON_DELETED, 0));
+}
+}
+// if the entry is not bookmarked and is not a place: uri
+// then we can remove it from moz_places.
+// Note that we do NOT delete favicons. Any unreferenced favicons will be
+// deleted next time the browser is shut down.
+nsresult rv = mDB->MainConn()->ExecuteSimpleSQL(
+NS_LITERAL_CSTRING(
+"DELETE FROM moz_places WHERE id IN ( "
+) + filteredPlaceIds + NS_LITERAL_CSTRING(
+") "
+)
+);
+NS_ENSURE_SUCCESS(rv, rv);
+// Invalidate frecencies of touched places, since they need recalculation.
+rv = invalidateFrecencies(aPlaceIdsQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+// Finally notify about the removed URIs.
+for (int32_t i = 0; i < URIs.Count(); ++i) {
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnDeleteURI(URIs[i], GUIDs[i], nsINavHistoryObserver::REASON_DELETED));
+}
+return NS_OK;
+}
+// nsNavHistory::RemovePages
+//
+//    Removes a bunch of uris from history.
+//    Has better performance than RemovePage when deleting a lot of history.
+//    We don't do duplicates removal, URIs array should be cleaned-up before.
+NS_IMETHODIMP
+nsNavHistory::RemovePages(nsIURI **aURIs, uint32_t aLength)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURIs);
+nsresult rv;
+// build a list of place ids to delete
+nsCString deletePlaceIdsQueryString;
+for (uint32_t i = 0; i < aLength; i++) {
+int64_t placeId;
+nsAutoCString guid;
+rv = GetIdForPage(aURIs[i], &placeId, guid);
+NS_ENSURE_SUCCESS(rv, rv);
+if (placeId != 0) {
+if (!deletePlaceIdsQueryString.IsEmpty())
+deletePlaceIdsQueryString.AppendLiteral(",");
+deletePlaceIdsQueryString.AppendInt(placeId);
+}
+}
+UpdateBatchScoper batch(*this); // sends Begin/EndUpdateBatch to observers
+rv = RemovePagesInternal(deletePlaceIdsQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+return NS_OK;
+}
+// nsNavHistory::RemovePage
+//
+//    Removes all visits and the main history entry for the given URI.
+//    Silently fails if we have no knowledge of the page.
+NS_IMETHODIMP
+nsNavHistory::RemovePage(nsIURI *aURI)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+// Build a list of place ids to delete.
+int64_t placeId;
+nsAutoCString guid;
+nsresult rv = GetIdForPage(aURI, &placeId, guid);
+NS_ENSURE_SUCCESS(rv, rv);
+if (placeId == 0) {
+return NS_OK;
+}
+nsAutoCString deletePlaceIdQueryString;
+deletePlaceIdQueryString.AppendInt(placeId);
+rv = RemovePagesInternal(deletePlaceIdQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+return NS_OK;
+}
+// nsNavHistory::RemovePagesFromHost
+//
+//    This function will delete all history information about pages from a
+//    given host. If aEntireDomain is set, we will also delete pages from
+//    sub hosts (so if we are passed in "microsoft.com" we delete
+//    "www.microsoft.com", "msdn.microsoft.com", etc.). An empty host name
+//    means local files and anything else with no host name. You can also pass
+//    in the localized "(local files)" title given to you from a history query.
+//
+//    Silently fails if we have no knowledge of the host.
+//
+//    This sends onBeginUpdateBatch/onEndUpdateBatch to observers
+NS_IMETHODIMP
+nsNavHistory::RemovePagesFromHost(const nsACString& aHost, bool aEntireDomain)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+nsresult rv;
+// Local files don't have any host name. We don't want to delete all files in
+// history when we get passed an empty string, so force to exact match
+if (aHost.IsEmpty())
+aEntireDomain = false;
+// translate "(local files)" to an empty host name
+// be sure to use the TitleForDomain to get the localized name
+nsCString localFiles;
+TitleForDomain(EmptyCString(), localFiles);
+nsAutoString host16;
+if (!aHost.Equals(localFiles))
+CopyUTF8toUTF16(aHost, host16);
+// nsISupports version of the host string for passing to observers
+nsCOMPtr<nsISupportsString> hostSupports(do_CreateInstance(NS_SUPPORTS_STRING_CONTRACTID, &rv));
+NS_ENSURE_SUCCESS(rv, rv);
+rv = hostSupports->SetData(host16);
+NS_ENSURE_SUCCESS(rv, rv);
+// see BindQueryClauseParameters for how this host selection works
+nsAutoString revHostDot;
+GetReversedHostname(host16, revHostDot);
+NS_ASSERTION(revHostDot[revHostDot.Length() - 1] == '.', "Invalid rev. host");
+nsAutoString revHostSlash(revHostDot);
+revHostSlash.Truncate(revHostSlash.Length() - 1);
+revHostSlash.Append(NS_LITERAL_STRING("/"));
+// build condition string based on host selection type
+nsAutoCString conditionString;
+if (aEntireDomain)
+conditionString.AssignLiteral("rev_host >= ?1 AND rev_host < ?2 ");
+else
+conditionString.AssignLiteral("rev_host = ?1 ");
+// create statement depending on delete type
+nsCOMPtr<mozIStorageStatement> statement = mDB->GetStatement(
+NS_LITERAL_CSTRING("SELECT id FROM moz_places WHERE ") + conditionString
+);
+NS_ENSURE_STATE(statement);
+mozStorageStatementScoper scoper(statement);
+rv = statement->BindStringByIndex(0, revHostDot);
+NS_ENSURE_SUCCESS(rv, rv);
+if (aEntireDomain) {
+rv = statement->BindStringByIndex(1, revHostSlash);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+nsCString hostPlaceIds;
+bool hasMore = false;
+while (NS_SUCCEEDED(statement->ExecuteStep(&hasMore)) && hasMore) {
+if (!hostPlaceIds.IsEmpty())
+hostPlaceIds.AppendLiteral(",");
+int64_t placeId;
+rv = statement->GetInt64(0, &placeId);
+NS_ENSURE_SUCCESS(rv, rv);
+hostPlaceIds.AppendInt(placeId);
+}
+// force a full refresh calling onEndUpdateBatch (will call Refresh())
+UpdateBatchScoper batch(*this); // sends Begin/EndUpdateBatch to observers
+rv = RemovePagesInternal(hostPlaceIds);
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+return NS_OK;
+}
+// nsNavHistory::RemovePagesByTimeframe
+//
+//    This function will delete all history information about
+//    pages for a given timeframe.
+//    Limits are included: aBeginTime <= timeframe <= aEndTime
+//
+//    This method sends onBeginUpdateBatch/onEndUpdateBatch to observers
+NS_IMETHODIMP
+nsNavHistory::RemovePagesByTimeframe(PRTime aBeginTime, PRTime aEndTime)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+nsresult rv;
+// build a list of place ids to delete
+nsCString deletePlaceIdsQueryString;
+// we only need to know if a place has a visit into the given timeframe
+// this query is faster than actually selecting in moz_historyvisits
+nsCOMPtr<mozIStorageStatement> selectByTime = mDB->GetStatement(
+"SELECT h.id FROM moz_places h WHERE "
+"EXISTS "
+"(SELECT id FROM moz_historyvisits v WHERE v.place_id = h.id "
+"AND v.visit_date >= :from_date AND v.visit_date <= :to_date LIMIT 1)"
+);
+NS_ENSURE_STATE(selectByTime);
+mozStorageStatementScoper selectByTimeScoper(selectByTime);
+rv = selectByTime->BindInt64ByName(NS_LITERAL_CSTRING("from_date"), aBeginTime);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = selectByTime->BindInt64ByName(NS_LITERAL_CSTRING("to_date"), aEndTime);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+while (NS_SUCCEEDED(selectByTime->ExecuteStep(&hasMore)) && hasMore) {
+int64_t placeId;
+rv = selectByTime->GetInt64(0, &placeId);
+NS_ENSURE_SUCCESS(rv, rv);
+if (placeId != 0) {
+if (!deletePlaceIdsQueryString.IsEmpty())
+deletePlaceIdsQueryString.AppendLiteral(",");
+deletePlaceIdsQueryString.AppendInt(placeId);
+}
+}
+// force a full refresh calling onEndUpdateBatch (will call Refresh())
+UpdateBatchScoper batch(*this); // sends Begin/EndUpdateBatch to observers
+rv = RemovePagesInternal(deletePlaceIdsQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+return NS_OK;
+}
+/**
+* Removes all visits in a given timeframe.  Limits are included:
+* aBeginTime <= timeframe <= aEndTime.  Any place that becomes unvisited
+* as a result will also be deleted.
+*
+* Note that removal is performed in batch, so observers will not be
+* notified of individual places that are deleted.  Instead they will be
+* notified onBeginUpdateBatch and onEndUpdateBatch.
+*
+* @param aBeginTime
+*        The start of the timeframe, inclusive
+* @param aEndTime
+*        The end of the timeframe, inclusive
+*/
+NS_IMETHODIMP
+nsNavHistory::RemoveVisitsByTimeframe(PRTime aBeginTime, PRTime aEndTime)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+nsresult rv;
+// Build a list of place IDs whose visits fall entirely within the timespan.
+// These places will be deleted by the call to CleanupPlacesOnVisitsDelete
+// below.
+nsCString deletePlaceIdsQueryString;
+{
+nsCOMPtr<mozIStorageStatement> selectByTime = mDB->GetStatement(
+"SELECT place_id "
+"FROM moz_historyvisits "
+"WHERE :from_date <= visit_date AND visit_date <= :to_date "
+"EXCEPT "
+"SELECT place_id "
+"FROM moz_historyvisits "
+"WHERE visit_date < :from_date OR :to_date < visit_date"
+);
+NS_ENSURE_STATE(selectByTime);
+mozStorageStatementScoper selectByTimeScoper(selectByTime);
+rv = selectByTime->BindInt64ByName(NS_LITERAL_CSTRING("from_date"), aBeginTime);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = selectByTime->BindInt64ByName(NS_LITERAL_CSTRING("to_date"), aEndTime);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+while (NS_SUCCEEDED(selectByTime->ExecuteStep(&hasMore)) && hasMore) {
+int64_t placeId;
+rv = selectByTime->GetInt64(0, &placeId);
+NS_ENSURE_SUCCESS(rv, rv);
+// placeId should not be <= 0, but be defensive.
+if (placeId > 0) {
+if (!deletePlaceIdsQueryString.IsEmpty())
+deletePlaceIdsQueryString.AppendLiteral(",");
+deletePlaceIdsQueryString.AppendInt(placeId);
+}
+}
+}
+// force a full refresh calling onEndUpdateBatch (will call Refresh())
+UpdateBatchScoper batch(*this); // sends Begin/EndUpdateBatch to observers
+mozStorageTransaction transaction(mDB->MainConn(), false);
+// Delete all visits within the timeframe.
+nsCOMPtr<mozIStorageStatement> deleteVisitsStmt = mDB->GetStatement(
+"DELETE FROM moz_historyvisits "
+"WHERE :from_date <= visit_date AND visit_date <= :to_date"
+);
+NS_ENSURE_STATE(deleteVisitsStmt);
+mozStorageStatementScoper deletevisitsScoper(deleteVisitsStmt);
+rv = deleteVisitsStmt->BindInt64ByName(NS_LITERAL_CSTRING("from_date"), aBeginTime);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = deleteVisitsStmt->BindInt64ByName(NS_LITERAL_CSTRING("to_date"), aEndTime);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = deleteVisitsStmt->Execute();
+NS_ENSURE_SUCCESS(rv, rv);
+rv = CleanupPlacesOnVisitsDelete(deletePlaceIdsQueryString);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = transaction.Commit();
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+// Invalidate the cached value for whether there's history or not.
+mDaysOfHistory = -1;
+return NS_OK;
+}
+// nsNavHistory::RemoveAllPages
+//
+//    This function is used to clear history.
+NS_IMETHODIMP
+nsNavHistory::RemoveAllPages()
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+nsresult rv = mDB->MainConn()->ExecuteSimpleSQL(NS_LITERAL_CSTRING(
+"DELETE FROM moz_historyvisits"
+));
+NS_ENSURE_SUCCESS(rv, rv);
+// Clear the registered embed visits.
+clearEmbedVisits();
+// Update the cached value for whether there's history or not.
+mDaysOfHistory = 0;
+// Expiration will take care of orphans.
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver, OnClearHistory());
+// Invalidate frecencies for the remaining places.  This must happen
+// after the notification to ensure it runs enqueued to expiration.
+rv = invalidateFrecencies(EmptyCString());
+NS_WARN_IF_FALSE(NS_SUCCEEDED(rv), "failed to fix invalid frecencies");
+return NS_OK;
+}
+// Call this method before visiting a URL in order to help determine the
+// transition type of the visit.
+//
+// @see MarkPageAsFollowedBookmark
+NS_IMETHODIMP
+nsNavHistory::MarkPageAsTyped(nsIURI *aURI)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+// don't add when history is disabled
+if (IsHistoryDisabled())
+return NS_OK;
+nsAutoCString uriString;
+nsresult rv = aURI->GetSpec(uriString);
+NS_ENSURE_SUCCESS(rv, rv);
+// if URL is already in the typed queue, then we need to remove the old one
+int64_t unusedEventTime;
+if (mRecentTyped.Get(uriString, &unusedEventTime))
+mRecentTyped.Remove(uriString);
+if (mRecentTyped.Count() > RECENT_EVENT_QUEUE_MAX_LENGTH)
+ExpireNonrecentEvents(&mRecentTyped);
+mRecentTyped.Put(uriString, GetNow());
+return NS_OK;
+}
+// Call this method before visiting a URL in order to help determine the
+// transition type of the visit.
+//
+// @see MarkPageAsTyped
+NS_IMETHODIMP
+nsNavHistory::MarkPageAsFollowedLink(nsIURI *aURI)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+// don't add when history is disabled
+if (IsHistoryDisabled())
+return NS_OK;
+nsAutoCString uriString;
+nsresult rv = aURI->GetSpec(uriString);
+NS_ENSURE_SUCCESS(rv, rv);
+// if URL is already in the links queue, then we need to remove the old one
+int64_t unusedEventTime;
+if (mRecentLink.Get(uriString, &unusedEventTime))
+mRecentLink.Remove(uriString);
+if (mRecentLink.Count() > RECENT_EVENT_QUEUE_MAX_LENGTH)
+ExpireNonrecentEvents(&mRecentLink);
+mRecentLink.Put(uriString, GetNow());
+return NS_OK;
+}
+// nsNavHistory::SetCharsetForURI
+//
+// Sets the character-set for a URI.
+// If aCharset is empty remove character-set annotation for aURI.
+NS_IMETHODIMP
+nsNavHistory::SetCharsetForURI(nsIURI* aURI,
+const nsAString& aCharset)
+{
+PLACES_WARN_DEPRECATED();
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+nsAnnotationService* annosvc = nsAnnotationService::GetAnnotationService();
+NS_ENSURE_TRUE(annosvc, NS_ERROR_OUT_OF_MEMORY);
+if (aCharset.IsEmpty()) {
+// remove the current page character-set annotation
+nsresult rv = annosvc->RemovePageAnnotation(aURI, CHARSET_ANNO);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+else {
+// Set page character-set annotation, silently overwrite if already exists
+nsresult rv = annosvc->SetPageAnnotationString(aURI, CHARSET_ANNO,
+aCharset, 0,
+nsAnnotationService::EXPIRE_NEVER);
+if (rv == NS_ERROR_INVALID_ARG) {
+// We don't have this page.  Silently fail.
+return NS_OK;
+}
+else if (NS_FAILED(rv))
+return rv;
+}
+return NS_OK;
+}
+// nsNavHistory::GetCharsetForURI
+//
+// Get the last saved character-set for a URI.
+NS_IMETHODIMP
+nsNavHistory::GetCharsetForURI(nsIURI* aURI,
+nsAString& aCharset)
+{
+PLACES_WARN_DEPRECATED();
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+nsAnnotationService* annosvc = nsAnnotationService::GetAnnotationService();
+NS_ENSURE_TRUE(annosvc, NS_ERROR_OUT_OF_MEMORY);
+nsAutoString charset;
+nsresult rv = annosvc->GetPageAnnotationString(aURI, CHARSET_ANNO, aCharset);
+if (NS_FAILED(rv)) {
+// be sure to return an empty string if character-set is not found
+aCharset.Truncate();
+}
+return NS_OK;
+}
+NS_IMETHODIMP
+nsNavHistory::GetPageTitle(nsIURI* aURI, nsAString& aTitle)
+{
+PLACES_WARN_DEPRECATED();
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aURI);
+aTitle.Truncate(0);
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(
+"SELECT id, url, title, rev_host, visit_count, guid "
+"FROM moz_places "
+"WHERE url = :page_url "
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+nsresult rv = URIBinder::Bind(stmt, NS_LITERAL_CSTRING("page_url"), aURI);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasResults = false;
+rv = stmt->ExecuteStep(&hasResults);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!hasResults) {
+aTitle.SetIsVoid(true);
+return NS_OK; // Not found, return a void string.
+}
+rv = stmt->GetString(2, aTitle);
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+////////////////////////////////////////////////////////////////////////////////
+//// mozIStorageVacuumParticipant
+NS_IMETHODIMP
+nsNavHistory::GetDatabaseConnection(mozIStorageConnection** _DBConnection)
+{
+return GetDBConnection(_DBConnection);
+}
+NS_IMETHODIMP
+nsNavHistory::GetExpectedDatabasePageSize(int32_t* _expectedPageSize)
+{
+NS_ENSURE_STATE(mDB);
+NS_ENSURE_STATE(mDB->MainConn());
+return mDB->MainConn()->GetDefaultPageSize(_expectedPageSize);
+}
+NS_IMETHODIMP
+nsNavHistory::OnBeginVacuum(bool* _vacuumGranted)
+{
+// TODO: Check if we have to deny the vacuum in some heavy-load case.
+// We could maybe want to do that during batches?
+*_vacuumGranted = true;
+return NS_OK;
+}
+NS_IMETHODIMP
+nsNavHistory::OnEndVacuum(bool aSucceeded)
+{
+NS_WARN_IF_FALSE(aSucceeded, "Places.sqlite vacuum failed.");
+return NS_OK;
+}
+////////////////////////////////////////////////////////////////////////////////
+//// nsPIPlacesDatabase
+NS_IMETHODIMP
+nsNavHistory::GetDBConnection(mozIStorageConnection **_DBConnection)
+{
+NS_ENSURE_ARG_POINTER(_DBConnection);
+nsRefPtr<mozIStorageConnection> connection = mDB->MainConn();
+connection.forget(_DBConnection);
+return NS_OK;
+}
+NS_IMETHODIMP
+nsNavHistory::AsyncExecuteLegacyQueries(nsINavHistoryQuery** aQueries,
+uint32_t aQueryCount,
+nsINavHistoryQueryOptions* aOptions,
+mozIStorageStatementCallback* aCallback,
+mozIStoragePendingStatement** _stmt)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+NS_ENSURE_ARG(aQueries);
+NS_ENSURE_ARG(aOptions);
+NS_ENSURE_ARG(aCallback);
+NS_ENSURE_ARG_POINTER(_stmt);
+nsCOMArray<nsNavHistoryQuery> queries;
+for (uint32_t i = 0; i < aQueryCount; i ++) {
+nsCOMPtr<nsNavHistoryQuery> query = do_QueryInterface(aQueries[i]);
+NS_ENSURE_STATE(query);
+queries.AppendObject(query);
+}
+NS_ENSURE_ARG_MIN(queries.Count(), 1);
+nsCOMPtr<nsNavHistoryQueryOptions> options = do_QueryInterface(aOptions);
+NS_ENSURE_ARG(options);
+nsCString queryString;
+bool paramsPresent = false;
+nsNavHistory::StringHash addParams(HISTORY_DATE_CONT_MAX);
+nsresult rv = ConstructQueryString(queries, options, queryString,
+paramsPresent, addParams);
+NS_ENSURE_SUCCESS(rv,rv);
+nsCOMPtr<mozIStorageAsyncStatement> statement =
+mDB->GetAsyncStatement(queryString);
+NS_ENSURE_STATE(statement);
+#ifdef DEBUG
+if (NS_FAILED(rv)) {
+nsAutoCString lastErrorString;
+(void)mDB->MainConn()->GetLastErrorString(lastErrorString);
+int32_t lastError = 0;
+(void)mDB->MainConn()->GetLastError(&lastError);
+printf("Places failed to create a statement from this query:\n%s\nStorage error (%d): %s\n",
+queryString.get(), lastError, lastErrorString.get());
+}
+#endif
+NS_ENSURE_SUCCESS(rv, rv);
+if (paramsPresent) {
+// bind parameters
+int32_t i;
+for (i = 0; i < queries.Count(); i++) {
+rv = BindQueryClauseParameters(statement, i, queries[i], options);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+addParams.EnumerateRead(BindAdditionalParameter, statement.get());
+rv = statement->ExecuteAsync(aCallback, _stmt);
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+// nsPIPlacesHistoryListenersNotifier ******************************************
+NS_IMETHODIMP
+nsNavHistory::NotifyOnPageExpired(nsIURI *aURI, PRTime aVisitTime,
+bool aWholeEntry, const nsACString& aGUID,
+uint16_t aReason, uint32_t aTransitionType)
+{
+// Invalidate the cached value for whether there's history or not.
+mDaysOfHistory = -1;
+MOZ_ASSERT(!aGUID.IsEmpty());
+if (aWholeEntry) {
+// Notify our observers that the page has been removed.
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver, OnDeleteURI(aURI, aGUID, aReason));
+}
+else {
+// Notify our observers that some visits for the page have been removed.
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnDeleteVisits(aURI, aVisitTime, aGUID, aReason,
+aTransitionType));
+}
+return NS_OK;
+}
+////////////////////////////////////////////////////////////////////////////////
+//// nsIObserver
+NS_IMETHODIMP
+nsNavHistory::Observe(nsISupports *aSubject, const char *aTopic,
+const char16_t *aData)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+if (strcmp(aTopic, TOPIC_PROFILE_TEARDOWN) == 0 ||
+strcmp(aTopic, TOPIC_PROFILE_CHANGE) == 0) {
+// These notifications are used by tests to simulate a Places shutdown.
+// They should just be forwarded to the Database handle.
+mDB->Observe(aSubject, aTopic, aData);
+}
+else if (strcmp(aTopic, TOPIC_PLACES_CONNECTION_CLOSED) == 0) {
+// Don't even try to notify observers from this point on, the category
+// cache would init services that could try to use our APIs.
+mCanNotify = false;
+}
+#ifdef MOZ_XUL
+else if (strcmp(aTopic, TOPIC_AUTOCOMPLETE_FEEDBACK_INCOMING) == 0) {
+nsCOMPtr<nsIAutoCompleteInput> input = do_QueryInterface(aSubject);
+if (!input)
+return NS_OK;
+// If the source is a private window, don't add any input history.
+bool isPrivate;
+nsresult rv = input->GetInPrivateContext(&isPrivate);
+NS_ENSURE_SUCCESS(rv, rv);
+if (isPrivate)
+return NS_OK;
+nsCOMPtr<nsIAutoCompletePopup> popup;
+input->GetPopup(getter_AddRefs(popup));
+if (!popup)
+return NS_OK;
+nsCOMPtr<nsIAutoCompleteController> controller;
+input->GetController(getter_AddRefs(controller));
+if (!controller)
+return NS_OK;
+// Don't bother if the popup is closed
+bool open;
+rv = popup->GetPopupOpen(&open);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!open)
+return NS_OK;
+// Ignore if nothing selected from the popup
+int32_t selectedIndex;
+rv = popup->GetSelectedIndex(&selectedIndex);
+NS_ENSURE_SUCCESS(rv, rv);
+if (selectedIndex == -1)
+return NS_OK;
+rv = AutoCompleteFeedback(selectedIndex, controller);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+#endif
+else if (strcmp(aTopic, TOPIC_PREF_CHANGED) == 0) {
+LoadPrefs();
+}
+else if (strcmp(aTopic, TOPIC_IDLE_DAILY) == 0) {
+(void)DecayFrecency();
+}
+return NS_OK;
+}
+namespace {
+class DecayFrecencyCallback : public AsyncStatementTelemetryTimer
+{
+public:
+DecayFrecencyCallback()
+: AsyncStatementTelemetryTimer(Telemetry::PLACES_IDLE_FRECENCY_DECAY_TIME_MS)
+{
+}
+NS_IMETHOD HandleCompletion(uint16_t aReason)
+{
+(void)AsyncStatementTelemetryTimer::HandleCompletion(aReason);
+if (aReason == REASON_FINISHED) {
+nsNavHistory *navHistory = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(navHistory);
+navHistory->NotifyManyFrecenciesChanged();
+}
+return NS_OK;
+}
+};
+} // anonymous namespace
+nsresult
+nsNavHistory::DecayFrecency()
+{
+nsresult rv = FixInvalidFrecencies();
+NS_ENSURE_SUCCESS(rv, rv);
+// Globally decay places frecency rankings to estimate reduced frecency
+// values of pages that haven't been visited for a while, i.e., they do
+// not get an updated frecency.  A scaling factor of .975 results in .5 the
+// original value after 28 days.
+// When changing the scaling factor, ensure that the barrier in
+// moz_places_afterupdate_frecency_trigger still ignores these changes.
+nsCOMPtr<mozIStorageAsyncStatement> decayFrecency = mDB->GetAsyncStatement(
+"UPDATE moz_places SET frecency = ROUND(frecency * .975) "
+"WHERE frecency > 0"
+);
+NS_ENSURE_STATE(decayFrecency);
+// Decay potentially unused adaptive entries (e.g. those that are at 1)
+// to allow better chances for new entries that will start at 1.
+nsCOMPtr<mozIStorageAsyncStatement> decayAdaptive = mDB->GetAsyncStatement(
+"UPDATE moz_inputhistory SET use_count = use_count * .975"
+);
+NS_ENSURE_STATE(decayAdaptive);
+// Delete any adaptive entries that won't help in ordering anymore.
+nsCOMPtr<mozIStorageAsyncStatement> deleteAdaptive = mDB->GetAsyncStatement(
+"DELETE FROM moz_inputhistory WHERE use_count < .01"
+);
+NS_ENSURE_STATE(deleteAdaptive);
+mozIStorageBaseStatement *stmts[] = {
+decayFrecency.get(),
+decayAdaptive.get(),
+deleteAdaptive.get()
+};
+nsCOMPtr<mozIStoragePendingStatement> ps;
+nsRefPtr<DecayFrecencyCallback> cb = new DecayFrecencyCallback();
+rv = mDB->MainConn()->ExecuteAsync(stmts, ArrayLength(stmts), cb,
+getter_AddRefs(ps));
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+// Query stuff *****************************************************************
+// Helper class for QueryToSelectClause
+//
+// This class helps to build part of the WHERE clause. It supports
+// multiple queries by appending the query index to the parameter name.
+// For the query with index 0 the parameter name is not altered what
+// allows using this parameter in other situations (see SelectAsSite).
+class ConditionBuilder
+{
+public:
+ConditionBuilder(int32_t aQueryIndex): mQueryIndex(aQueryIndex)
+{ }
+ConditionBuilder& Condition(const char* aStr)
+{
+if (!mClause.IsEmpty())
+mClause.AppendLiteral(" AND ");
+Str(aStr);
+return *this;
+}
+ConditionBuilder& Str(const char* aStr)
+{
+mClause.Append(' ');
+mClause.Append(aStr);
+mClause.Append(' ');
+return *this;
+}
+ConditionBuilder& Param(const char* aParam)
+{
+mClause.Append(' ');
+if (!mQueryIndex)
+mClause.Append(aParam);
+else
+mClause += nsPrintfCString("%s%d", aParam, mQueryIndex);
+mClause.Append(' ');
+return *this;
+}
+void GetClauseString(nsCString& aResult)
+{
+aResult = mClause;
+}
+private:
+int32_t mQueryIndex;
+nsCString mClause;
+};
+// nsNavHistory::QueryToSelectClause
+//
+//    THE BEHAVIOR SHOULD BE IN SYNC WITH BindQueryClauseParameters
+//
+//    I don't check return values from the query object getters because there's
+//    no way for those to fail.
+nsresult
+nsNavHistory::QueryToSelectClause(nsNavHistoryQuery* aQuery, // const
+nsNavHistoryQueryOptions* aOptions,
+int32_t aQueryIndex,
+nsCString* aClause)
+{
+bool hasIt;
+bool excludeQueries = aOptions->ExcludeQueries();
+ConditionBuilder clause(aQueryIndex);
+if ((NS_SUCCEEDED(aQuery->GetHasBeginTime(&hasIt)) && hasIt) ||
+(NS_SUCCEEDED(aQuery->GetHasEndTime(&hasIt)) && hasIt)) {
+clause.Condition("EXISTS (SELECT 1 FROM moz_historyvisits "
+"WHERE place_id = h.id");
+// begin time
+if (NS_SUCCEEDED(aQuery->GetHasBeginTime(&hasIt)) && hasIt)
+clause.Condition("visit_date >=").Param(":begin_time");
+// end time
+if (NS_SUCCEEDED(aQuery->GetHasEndTime(&hasIt)) && hasIt)
+clause.Condition("visit_date <=").Param(":end_time");
+clause.Str(" LIMIT 1)");
+}
+// search terms
+bool hasSearchTerms;
+if (NS_SUCCEEDED(aQuery->GetHasSearchTerms(&hasSearchTerms)) && hasSearchTerms) {
+// Re-use the autocomplete_match function.  Setting the behavior to 0
+// it can match everything and work as a nice case insensitive comparator.
+clause.Condition("AUTOCOMPLETE_MATCH(").Param(":search_string")
+.Str(", h.url, page_title, tags, ")
+.Str(nsPrintfCString("0, 0, 0, 0, %d, 0)",
+mozIPlacesAutoComplete::MATCH_ANYWHERE_UNMODIFIED).get());
+// Serching by terms implicitly exclude queries.
+excludeQueries = true;
+}
+// min and max visit count
+if (aQuery->MinVisits() >= 0)
+clause.Condition("h.visit_count >=").Param(":min_visits");
+if (aQuery->MaxVisits() >= 0)
+clause.Condition("h.visit_count <=").Param(":max_visits");
+// only bookmarked, has no affect on bookmarks-only queries
+if (aOptions->QueryType() != nsINavHistoryQueryOptions::QUERY_TYPE_BOOKMARKS &&
+aQuery->OnlyBookmarked())
+clause.Condition("EXISTS (SELECT b.fk FROM moz_bookmarks b WHERE b.type = ")
+.Str(nsPrintfCString("%d", nsNavBookmarks::TYPE_BOOKMARK).get())
+.Str("AND b.fk = h.id)");
+// domain
+if (NS_SUCCEEDED(aQuery->GetHasDomain(&hasIt)) && hasIt) {
+bool domainIsHost = false;
+aQuery->GetDomainIsHost(&domainIsHost);
+if (domainIsHost)
+clause.Condition("h.rev_host =").Param(":domain_lower");
+else
+// see domain setting in BindQueryClauseParameters for why we do this
+clause.Condition("h.rev_host >=").Param(":domain_lower")
+.Condition("h.rev_host <").Param(":domain_upper");
+}
+// URI
+if (NS_SUCCEEDED(aQuery->GetHasUri(&hasIt)) && hasIt) {
+if (aQuery->UriIsPrefix()) {
+clause.Condition("h.url >= ").Param(":uri")
+.Condition("h.url <= ").Param(":uri_upper");
+}
+else
+clause.Condition("h.url =").Param(":uri");
+}
+// annotation
+aQuery->GetHasAnnotation(&hasIt);
+if (hasIt) {
+clause.Condition("");
+if (aQuery->AnnotationIsNot())
+clause.Str("NOT");
+clause.Str(
+"EXISTS "
+"(SELECT h.id "
+"FROM moz_annos anno "
+"JOIN moz_anno_attributes annoname "
+"ON anno.anno_attribute_id = annoname.id "
+"WHERE anno.place_id = h.id "
+"AND annoname.name = ").Param(":anno").Str(")");
+// annotation-based queries don't get the common conditions, so you get
+// all URLs with that annotation
+}
+// tags
+const nsTArray<nsString> &tags = aQuery->Tags();
+if (tags.Length() > 0) {
+clause.Condition("h.id");
+if (aQuery->TagsAreNot())
+clause.Str("NOT");
+clause.Str(
+"IN "
+"(SELECT bms.fk "
+"FROM moz_bookmarks bms "
+"JOIN moz_bookmarks tags ON bms.parent = tags.id "
+"WHERE tags.parent =").
+Param(":tags_folder").
+Str("AND tags.title IN (");
+for (uint32_t i = 0; i < tags.Length(); ++i) {
+nsPrintfCString param(":tag%d_", i);
+clause.Param(param.get());
+if (i < tags.Length() - 1)
+clause.Str(",");
+}
+clause.Str(")");
+if (!aQuery->TagsAreNot())
+clause.Str("GROUP BY bms.fk HAVING count(*) >=").Param(":tag_count");
+clause.Str(")");
+}
+// transitions
+const nsTArray<uint32_t>& transitions = aQuery->Transitions();
+for (uint32_t i = 0; i < transitions.Length(); ++i) {
+nsPrintfCString param(":transition%d_", i);
+clause.Condition("h.id IN (SELECT place_id FROM moz_historyvisits "
+"WHERE visit_type = ")
+.Param(param.get())
+.Str(")");
+}
+// folders
+const nsTArray<int64_t>& folders = aQuery->Folders();
+if (folders.Length() > 0) {
+nsTArray<int64_t> includeFolders;
+includeFolders.AppendElements(folders);
+nsNavBookmarks* bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_STATE(bookmarks);
+for (nsTArray<int64_t>::size_type i = 0; i < folders.Length(); ++i) {
+nsTArray<int64_t> subFolders;
+if (NS_FAILED(bookmarks->GetDescendantFolders(folders[i], subFolders)))
+continue;
+includeFolders.AppendElements(subFolders);
+}
+clause.Condition("b.parent IN(");
+for (nsTArray<int64_t>::size_type i = 0; i < includeFolders.Length(); ++i) {
+clause.Str(nsPrintfCString("%lld", includeFolders[i]).get());
+if (i < includeFolders.Length() - 1) {
+clause.Str(",");
+}
+}
+clause.Str(")");
+}
+if (excludeQueries) {
+// Serching by terms implicitly exclude queries.
+clause.Condition("NOT h.url BETWEEN 'place:' AND 'place;'");
+}
+clause.GetClauseString(*aClause);
+return NS_OK;
+}
+// nsNavHistory::BindQueryClauseParameters
+//
+//    THE BEHAVIOR SHOULD BE IN SYNC WITH QueryToSelectClause
+nsresult
+nsNavHistory::BindQueryClauseParameters(mozIStorageBaseStatement* statement,
+int32_t aQueryIndex,
+nsNavHistoryQuery* aQuery, // const
+nsNavHistoryQueryOptions* aOptions)
+{
+nsresult rv;
+bool hasIt;
+// Append numbered index to param names, to replace them correctly in
+// case of multiple queries.  If we have just one query we don't change the
+// param name though.
+nsAutoCString qIndex;
+if (aQueryIndex > 0)
+qIndex.AppendInt(aQueryIndex);
+// begin time
+if (NS_SUCCEEDED(aQuery->GetHasBeginTime(&hasIt)) && hasIt) {
+PRTime time = NormalizeTime(aQuery->BeginTimeReference(),
+aQuery->BeginTime());
+rv = statement->BindInt64ByName(
+NS_LITERAL_CSTRING("begin_time") + qIndex, time);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+// end time
+if (NS_SUCCEEDED(aQuery->GetHasEndTime(&hasIt)) && hasIt) {
+PRTime time = NormalizeTime(aQuery->EndTimeReference(),
+aQuery->EndTime());
+rv = statement->BindInt64ByName(
+NS_LITERAL_CSTRING("end_time") + qIndex, time
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+// search terms
+if (NS_SUCCEEDED(aQuery->GetHasSearchTerms(&hasIt)) && hasIt) {
+rv = statement->BindStringByName(
+NS_LITERAL_CSTRING("search_string") + qIndex,
+aQuery->SearchTerms()
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+// min and max visit count
+int32_t visits = aQuery->MinVisits();
+if (visits >= 0) {
+rv = statement->BindInt32ByName(
+NS_LITERAL_CSTRING("min_visits") + qIndex, visits
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+visits = aQuery->MaxVisits();
+if (visits >= 0) {
+rv = statement->BindInt32ByName(
+NS_LITERAL_CSTRING("max_visits") + qIndex, visits
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+// domain (see GetReversedHostname for more info on reversed host names)
+if (NS_SUCCEEDED(aQuery->GetHasDomain(&hasIt)) && hasIt) {
+nsString revDomain;
+GetReversedHostname(NS_ConvertUTF8toUTF16(aQuery->Domain()), revDomain);
+if (aQuery->DomainIsHost()) {
+rv = statement->BindStringByName(
+NS_LITERAL_CSTRING("domain_lower") + qIndex, revDomain
+);
+NS_ENSURE_SUCCESS(rv, rv);
+} else {
+// for "mozilla.org" do query >= "gro.allizom." AND < "gro.allizom/"
+// which will get everything starting with "gro.allizom." while using the
+// index (using SUBSTRING() causes indexes to be discarded).
+NS_ASSERTION(revDomain[revDomain.Length() - 1] == '.', "Invalid rev. host");
+rv = statement->BindStringByName(
+NS_LITERAL_CSTRING("domain_lower") + qIndex, revDomain
+);
+NS_ENSURE_SUCCESS(rv, rv);
+revDomain.Truncate(revDomain.Length() - 1);
+revDomain.Append(char16_t('/'));
+rv = statement->BindStringByName(
+NS_LITERAL_CSTRING("domain_upper") + qIndex, revDomain
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+// URI
+if (aQuery->Uri()) {
+rv = URIBinder::Bind(
+statement, NS_LITERAL_CSTRING("uri") + qIndex, aQuery->Uri()
+);
+NS_ENSURE_SUCCESS(rv, rv);
+if (aQuery->UriIsPrefix()) {
+nsAutoCString uriString;
+aQuery->Uri()->GetSpec(uriString);
+uriString.Append(char(0x7F)); // MAX_UTF8
+rv = URIBinder::Bind(
+statement, NS_LITERAL_CSTRING("uri_upper") + qIndex, uriString
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+// annotation
+if (!aQuery->Annotation().IsEmpty()) {
+rv = statement->BindUTF8StringByName(
+NS_LITERAL_CSTRING("anno") + qIndex, aQuery->Annotation()
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+// tags
+const nsTArray<nsString> &tags = aQuery->Tags();
+if (tags.Length() > 0) {
+for (uint32_t i = 0; i < tags.Length(); ++i) {
+nsPrintfCString paramName("tag%d_", i);
+NS_ConvertUTF16toUTF8 tag(tags[i]);
+rv = statement->BindUTF8StringByName(paramName + qIndex, tag);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+int64_t tagsFolder = GetTagsFolder();
+rv = statement->BindInt64ByName(
+NS_LITERAL_CSTRING("tags_folder") + qIndex, tagsFolder
+);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!aQuery->TagsAreNot()) {
+rv = statement->BindInt32ByName(
+NS_LITERAL_CSTRING("tag_count") + qIndex, tags.Length()
+);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+// transitions
+const nsTArray<uint32_t>& transitions = aQuery->Transitions();
+if (transitions.Length() > 0) {
+for (uint32_t i = 0; i < transitions.Length(); ++i) {
+nsPrintfCString paramName("transition%d_", i);
+rv = statement->BindInt64ByName(paramName + qIndex, transitions[i]);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+}
+return NS_OK;
+}
+// nsNavHistory::ResultsAsList
+//
+nsresult
+nsNavHistory::ResultsAsList(mozIStorageStatement* statement,
+nsNavHistoryQueryOptions* aOptions,
+nsCOMArray<nsNavHistoryResultNode>* aResults)
+{
+nsresult rv;
+nsCOMPtr<mozIStorageValueArray> row = do_QueryInterface(statement, &rv);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+while (NS_SUCCEEDED(statement->ExecuteStep(&hasMore)) && hasMore) {
+nsRefPtr<nsNavHistoryResultNode> result;
+rv = RowToResult(row, aOptions, getter_AddRefs(result));
+NS_ENSURE_SUCCESS(rv, rv);
+aResults->AppendObject(result);
+}
+return NS_OK;
+}
+const int64_t UNDEFINED_URN_VALUE = -1;
+// Create a urn (like
+// urn:places-persist:place:group=0&group=1&sort=1&type=1,,%28local%20files%29)
+// to be used to persist the open state of this container in localstore.rdf
+nsresult
+CreatePlacesPersistURN(nsNavHistoryQueryResultNode *aResultNode,
+int64_t aValue, const nsCString& aTitle, nsCString& aURN)
+{
+nsAutoCString uri;
+nsresult rv = aResultNode->GetUri(uri);
+NS_ENSURE_SUCCESS(rv, rv);
+aURN.Assign(NS_LITERAL_CSTRING("urn:places-persist:"));
+aURN.Append(uri);
+aURN.Append(NS_LITERAL_CSTRING(","));
+if (aValue != UNDEFINED_URN_VALUE)
+aURN.AppendInt(aValue);
+aURN.Append(NS_LITERAL_CSTRING(","));
+if (!aTitle.IsEmpty()) {
+nsAutoCString escapedTitle;
+bool success = NS_Escape(aTitle, escapedTitle, url_XAlphas);
+NS_ENSURE_TRUE(success, NS_ERROR_OUT_OF_MEMORY);
+aURN.Append(escapedTitle);
+}
+return NS_OK;
+}
+int64_t
+nsNavHistory::GetTagsFolder()
+{
+// cache our tags folder
+// note, we can't do this in nsNavHistory::Init(),
+// as getting the bookmarks service would initialize it.
+if (mTagsFolder == -1) {
+nsNavBookmarks *bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_TRUE(bookmarks, -1);
+nsresult rv = bookmarks->GetTagsFolder(&mTagsFolder);
+NS_ENSURE_SUCCESS(rv, -1);
+}
+return mTagsFolder;
+}
+// nsNavHistory::FilterResultSet
+//
+// This does some post-query-execution filtering:
+//   - searching on title, url and tags
+//   - limit count
+//
+// Note:  changes to filtering in FilterResultSet()
+// may require changes to NeedToFilterResultSet()
+nsresult
+nsNavHistory::FilterResultSet(nsNavHistoryQueryResultNode* aQueryNode,
+const nsCOMArray<nsNavHistoryResultNode>& aSet,
+nsCOMArray<nsNavHistoryResultNode>* aFiltered,
+const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions *aOptions)
+{
+// get the bookmarks service
+nsNavBookmarks *bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_TRUE(bookmarks, NS_ERROR_OUT_OF_MEMORY);
+// parse the search terms
+nsTArray<nsTArray<nsString>*> terms;
+ParseSearchTermsFromQueries(aQueries, &terms);
+uint16_t resultType = aOptions->ResultType();
+for (int32_t nodeIndex = 0; nodeIndex < aSet.Count(); nodeIndex++) {
+// exclude-queries is implicit when searching, we're only looking at
+// plan URI nodes
+if (!aSet[nodeIndex]->IsURI())
+continue;
+// RESULTS_AS_TAG_CONTENTS returns a set ordered by place_id and
+// lastModified. So, to remove duplicates, we can retain the first result
+// for each uri.
+if (resultType == nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS &&
+nodeIndex > 0 && aSet[nodeIndex]->mURI == aSet[nodeIndex-1]->mURI)
+continue;
+if (aSet[nodeIndex]->mItemId != -1 && aQueryNode &&
+aQueryNode->mItemId == aSet[nodeIndex]->mItemId) {
+continue;
+}
+// Append the node only if it matches one of the queries.
+bool appendNode = false;
+for (int32_t queryIndex = 0;
+queryIndex < aQueries.Count() && !appendNode; queryIndex++) {
+if (terms[queryIndex]->Length()) {
+// Filter based on search terms.
+// Convert title and url for the current node to UTF16 strings.
+NS_ConvertUTF8toUTF16 nodeTitle(aSet[nodeIndex]->mTitle);
+// Unescape the URL for search terms matching.
+nsAutoCString cNodeURL(aSet[nodeIndex]->mURI);
+NS_ConvertUTF8toUTF16 nodeURL(NS_UnescapeURL(cNodeURL));
+// Determine if every search term matches anywhere in the title, url or
+// tag.
+bool matchAll = true;
+for (int32_t termIndex = terms[queryIndex]->Length() - 1;
+termIndex >= 0 && matchAll;
+termIndex--) {
+nsString& term = terms[queryIndex]->ElementAt(termIndex);
+// True if any of them match; false makes us quit the loop
+matchAll = CaseInsensitiveFindInReadable(term, nodeTitle) ||
+CaseInsensitiveFindInReadable(term, nodeURL) ||
+CaseInsensitiveFindInReadable(term, aSet[nodeIndex]->mTags);
+}
+// Skip the node if we don't match all terms in the title, url or tag
+if (!matchAll)
+continue;
+}
+// We passed all filters, so we can append the node to filtered results.
+appendNode = true;
+}
+if (appendNode)
+aFiltered->AppendObject(aSet[nodeIndex]);
+// Stop once we have reached max results.
+if (aOptions->MaxResults() > 0 &&
+(uint32_t)aFiltered->Count() >= aOptions->MaxResults())
+break;
+}
+// De-allocate the temporary matrixes.
+for (int32_t i = 0; i < aQueries.Count(); i++) {
+delete terms[i];
+}
+return NS_OK;
+}
+void
+nsNavHistory::registerEmbedVisit(nsIURI* aURI,
+int64_t aTime)
+{
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+VisitHashKey* visit = mEmbedVisits.PutEntry(aURI);
+if (!visit) {
+NS_WARNING("Unable to register a EMBED visit.");
+return;
+}
+visit->visitTime = aTime;
+}
+bool
+nsNavHistory::hasEmbedVisit(nsIURI* aURI) {
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+return !!mEmbedVisits.GetEntry(aURI);
+}
+void
+nsNavHistory::clearEmbedVisits() {
+NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
+mEmbedVisits.Clear();
+}
+// nsNavHistory::CheckIsRecentEvent
+//
+//    Sees if this URL happened "recently."
+//
+//    It is always removed from our recent list no matter what. It only counts
+//    as "recent" if the event happened more recently than our event
+//    threshold ago.
+bool
+nsNavHistory::CheckIsRecentEvent(RecentEventHash* hashTable,
+const nsACString& url)
+{
+PRTime eventTime;
+if (hashTable->Get(url, reinterpret_cast<int64_t*>(&eventTime))) {
+hashTable->Remove(url);
+if (eventTime > GetNow() - RECENT_EVENT_THRESHOLD)
+return true;
+return false;
+}
+return false;
+}
+// nsNavHistory::ExpireNonrecentEvents
+//
+//    This goes through our
+static PLDHashOperator
+ExpireNonrecentEventsCallback(nsCStringHashKey::KeyType aKey,
+int64_t& aData,
+void* userArg)
+{
+int64_t* threshold = reinterpret_cast<int64_t*>(userArg);
+if (aData < *threshold)
+return PL_DHASH_REMOVE;
+return PL_DHASH_NEXT;
+}
+void
+nsNavHistory::ExpireNonrecentEvents(RecentEventHash* hashTable)
+{
+int64_t threshold = GetNow() - RECENT_EVENT_THRESHOLD;
+hashTable->Enumerate(ExpireNonrecentEventsCallback,
+reinterpret_cast<void*>(&threshold));
+}
+// nsNavHistory::RowToResult
+//
+//    Here, we just have a generic row. It could be a query, URL, visit,
+//    or full visit.
+nsresult
+nsNavHistory::RowToResult(mozIStorageValueArray* aRow,
+nsNavHistoryQueryOptions* aOptions,
+nsNavHistoryResultNode** aResult)
+{
+NS_ASSERTION(aRow && aOptions && aResult, "Null pointer in RowToResult");
+// URL
+nsAutoCString url;
+nsresult rv = aRow->GetUTF8String(kGetInfoIndex_URL, url);
+NS_ENSURE_SUCCESS(rv, rv);
+// title
+nsAutoCString title;
+rv = aRow->GetUTF8String(kGetInfoIndex_Title, title);
+NS_ENSURE_SUCCESS(rv, rv);
+uint32_t accessCount = aRow->AsInt32(kGetInfoIndex_VisitCount);
+PRTime time = aRow->AsInt64(kGetInfoIndex_VisitDate);
+// favicon
+nsAutoCString favicon;
+rv = aRow->GetUTF8String(kGetInfoIndex_FaviconURL, favicon);
+NS_ENSURE_SUCCESS(rv, rv);
+// itemId
+int64_t itemId = aRow->AsInt64(kGetInfoIndex_ItemId);
+int64_t parentId = -1;
+if (itemId == 0) {
+// This is not a bookmark.  For non-bookmarks we use a -1 itemId value.
+// Notice ids in sqlite tables start from 1, so itemId cannot ever be 0.
+itemId = -1;
+}
+else {
+// This is a bookmark, so it has a parent.
+int64_t itemParentId = aRow->AsInt64(kGetInfoIndex_ItemParentId);
+if (itemParentId > 0) {
+// The Places root has parent == 0, but that item id does not really
+// exist. We want to set the parent only if it's a real one.
+parentId = itemParentId;
+}
+}
+if (IsQueryURI(url)) {
+// special case "place:" URIs: turn them into containers
+// We should never expose the history title for query nodes if the
+// bookmark-item's title is set to null (the history title may be the
+// query string without the place: prefix). Thus we call getItemTitle
+// explicitly. Doing this in the SQL query would be less performant since
+// it should be done for all results rather than only for queries.
+if (itemId != -1) {
+nsNavBookmarks *bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_TRUE(bookmarks, NS_ERROR_OUT_OF_MEMORY);
+rv = bookmarks->GetItemTitle(itemId, title);
+NS_ENSURE_SUCCESS(rv, rv);
+}
+nsRefPtr<nsNavHistoryResultNode> resultNode;
+rv = QueryRowToResult(itemId, url, title, accessCount, time, favicon,
+getter_AddRefs(resultNode));
+NS_ENSURE_SUCCESS(rv,rv);
+if (aOptions->ResultType() == nsNavHistoryQueryOptions::RESULTS_AS_TAG_QUERY) {
+// RESULTS_AS_TAG_QUERY has date columns
+resultNode->mDateAdded = aRow->AsInt64(kGetInfoIndex_ItemDateAdded);
+resultNode->mLastModified = aRow->AsInt64(kGetInfoIndex_ItemLastModified);
+}
+else if (resultNode->IsFolder()) {
+// If it's a simple folder node (i.e. a shortcut to another folder), apply
+// our options for it. However, if the parent type was tag query, we do not
+// apply them, because it would not yield any results.
+resultNode->GetAsContainer()->mOptions = aOptions;
+}
+resultNode.forget(aResult);
+return rv;
+} else if (aOptions->ResultType() == nsNavHistoryQueryOptions::RESULTS_AS_URI ||
+aOptions->ResultType() == nsNavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS) {
+nsRefPtr<nsNavHistoryResultNode> resultNode =
+new nsNavHistoryResultNode(url, title, accessCount, time, favicon);
+if (itemId != -1) {
+resultNode->mItemId = itemId;
+resultNode->mFolderId = parentId;
+resultNode->mDateAdded = aRow->AsInt64(kGetInfoIndex_ItemDateAdded);
+resultNode->mLastModified = aRow->AsInt64(kGetInfoIndex_ItemLastModified);
+}
+resultNode->mFrecency = aRow->AsInt32(kGetInfoIndex_Frecency);
+resultNode->mHidden = !!aRow->AsInt32(kGetInfoIndex_Hidden);
+nsAutoString tags;
+rv = aRow->GetString(kGetInfoIndex_ItemTags, tags);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!tags.IsVoid()) {
+resultNode->mTags.Assign(tags);
+}
+rv = aRow->GetUTF8String(kGetInfoIndex_Guid, resultNode->mPageGuid);
+NS_ENSURE_SUCCESS(rv, rv);
+resultNode.forget(aResult);
+return NS_OK;
+}
+if (aOptions->ResultType() == nsNavHistoryQueryOptions::RESULTS_AS_VISIT) {
+nsRefPtr<nsNavHistoryResultNode> resultNode =
+new nsNavHistoryResultNode(url, title, accessCount, time, favicon);
+nsAutoString tags;
+rv = aRow->GetString(kGetInfoIndex_ItemTags, tags);
+if (!tags.IsVoid())
+resultNode->mTags.Assign(tags);
+rv = aRow->GetUTF8String(kGetInfoIndex_Guid, resultNode->mPageGuid);
+NS_ENSURE_SUCCESS(rv, rv);
+resultNode.forget(aResult);
+return NS_OK;
+}
+return NS_ERROR_FAILURE;
+}
+// nsNavHistory::QueryRowToResult
+//
+//    Called by RowToResult when the URI is a place: URI to generate the proper
+//    folder or query node.
+nsresult
+nsNavHistory::QueryRowToResult(int64_t itemId, const nsACString& aURI,
+const nsACString& aTitle,
+uint32_t aAccessCount, PRTime aTime,
+const nsACString& aFavicon,
+nsNavHistoryResultNode** aNode)
+{
+nsCOMArray<nsNavHistoryQuery> queries;
+nsCOMPtr<nsNavHistoryQueryOptions> options;
+nsresult rv = QueryStringToQueryArray(aURI, &queries,
+getter_AddRefs(options));
+nsRefPtr<nsNavHistoryResultNode> resultNode;
+// If this failed the query does not parse correctly, let the error pass and
+// handle it later.
+if (NS_SUCCEEDED(rv)) {
+// Check if this is a folder shortcut, so we can take a faster path.
+int64_t folderId = GetSimpleBookmarksQueryFolder(queries, options);
+if (folderId) {
+nsNavBookmarks *bookmarks = nsNavBookmarks::GetBookmarksService();
+NS_ENSURE_TRUE(bookmarks, NS_ERROR_OUT_OF_MEMORY);
+rv = bookmarks->ResultNodeForContainer(folderId, options,
+getter_AddRefs(resultNode));
+// If this failed the shortcut is pointing to nowhere, let the error pass
+// and handle it later.
+if (NS_SUCCEEDED(rv)) {
+// This is the query itemId, and is what is exposed by node.itemId.
+resultNode->GetAsFolder()->mQueryItemId = itemId;
+// Use the query item title, unless it's void (in that case use the
+// concrete folder title).
+if (!aTitle.IsVoid()) {
+resultNode->mTitle = aTitle;
+}
+}
+}
+else {
+// This is a regular query.
+resultNode = new nsNavHistoryQueryResultNode(aTitle, EmptyCString(),
+aTime, queries, options);
+resultNode->mItemId = itemId;
+}
+}
+if (NS_FAILED(rv)) {
+NS_WARNING("Generating a generic empty node for a broken query!");
+// This is a broken query, that either did not parse or points to not
+// existing data.  We don't want to return failure since that will kill the
+// whole result.  Instead make a generic empty query node.
+resultNode = new nsNavHistoryQueryResultNode(aTitle, aFavicon, aURI);
+resultNode->mItemId = itemId;
+// This is a perf hack to generate an empty query that skips filtering.
+resultNode->GetAsQuery()->Options()->SetExcludeItems(true);
+}
+resultNode.forget(aNode);
+return NS_OK;
+}
+// nsNavHistory::VisitIdToResultNode
+//
+//    Used by the query results to create new nodes on the fly when
+//    notifications come in. This just creates a node for the given visit ID.
+nsresult
+nsNavHistory::VisitIdToResultNode(int64_t visitId,
+nsNavHistoryQueryOptions* aOptions,
+nsNavHistoryResultNode** aResult)
+{
+nsAutoCString tagsFragment;
+GetTagsSqlFragment(GetTagsFolder(), NS_LITERAL_CSTRING("h.id"),
+true, tagsFragment);
+nsCOMPtr<mozIStorageStatement> statement;
+switch (aOptions->ResultType())
+{
+case nsNavHistoryQueryOptions::RESULTS_AS_VISIT:
+case nsNavHistoryQueryOptions::RESULTS_AS_FULL_VISIT:
+// visit query - want exact visit time
+// Should match kGetInfoIndex_* (see GetQueryResults)
+statement = mDB->GetStatement(NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.title, h.rev_host, h.visit_count, "
+"v.visit_date, f.url, null, null, null, null, "
+) + tagsFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"JOIN moz_historyvisits v ON h.id = v.place_id "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE v.id = :visit_id ")
+);
+break;
+case nsNavHistoryQueryOptions::RESULTS_AS_URI:
+// URL results - want last visit time
+// Should match kGetInfoIndex_* (see GetQueryResults)
+statement = mDB->GetStatement(NS_LITERAL_CSTRING(
+"SELECT h.id, h.url, h.title, h.rev_host, h.visit_count, "
+"h.last_visit_date, f.url, null, null, null, null, "
+) + tagsFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"JOIN moz_historyvisits v ON h.id = v.place_id "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE v.id = :visit_id ")
+);
+break;
+default:
+// Query base types like RESULTS_AS_*_QUERY handle additions
+// by registering their own observers when they are expanded.
+return NS_OK;
+}
+NS_ENSURE_STATE(statement);
+mozStorageStatementScoper scoper(statement);
+nsresult rv = statement->BindInt64ByName(NS_LITERAL_CSTRING("visit_id"),
+visitId);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+rv = statement->ExecuteStep(&hasMore);
+NS_ENSURE_SUCCESS(rv, rv);
+if (! hasMore) {
+NS_NOTREACHED("Trying to get a result node for an invalid visit");
+return NS_ERROR_INVALID_ARG;
+}
+nsCOMPtr<mozIStorageValueArray> row = do_QueryInterface(statement, &rv);
+NS_ENSURE_SUCCESS(rv, rv);
+return RowToResult(row, aOptions, aResult);
+}
+nsresult
+nsNavHistory::BookmarkIdToResultNode(int64_t aBookmarkId, nsNavHistoryQueryOptions* aOptions,
+nsNavHistoryResultNode** aResult)
+{
+nsAutoCString tagsFragment;
+GetTagsSqlFragment(GetTagsFolder(), NS_LITERAL_CSTRING("h.id"),
+true, tagsFragment);
+// Should match kGetInfoIndex_*
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(NS_LITERAL_CSTRING(
+"SELECT b.fk, h.url, COALESCE(b.title, h.title), "
+"h.rev_host, h.visit_count, h.last_visit_date, f.url, b.id, "
+"b.dateAdded, b.lastModified, b.parent, "
+) + tagsFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_bookmarks b "
+"JOIN moz_places h ON b.fk = h.id "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE b.id = :item_id ")
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+nsresult rv = stmt->BindInt64ByName(NS_LITERAL_CSTRING("item_id"),
+aBookmarkId);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+rv = stmt->ExecuteStep(&hasMore);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!hasMore) {
+NS_NOTREACHED("Trying to get a result node for an invalid bookmark identifier");
+return NS_ERROR_INVALID_ARG;
+}
+nsCOMPtr<mozIStorageValueArray> row = do_QueryInterface(stmt, &rv);
+NS_ENSURE_SUCCESS(rv, rv);
+return RowToResult(row, aOptions, aResult);
+}
+nsresult
+nsNavHistory::URIToResultNode(nsIURI* aURI,
+nsNavHistoryQueryOptions* aOptions,
+nsNavHistoryResultNode** aResult)
+{
+nsAutoCString tagsFragment;
+GetTagsSqlFragment(GetTagsFolder(), NS_LITERAL_CSTRING("h.id"),
+true, tagsFragment);
+// Should match kGetInfoIndex_*
+nsCOMPtr<mozIStorageStatement> stmt = mDB->GetStatement(NS_LITERAL_CSTRING(
+"SELECT h.id, :page_url, h.title, h.rev_host, h.visit_count, "
+"h.last_visit_date, f.url, null, null, null, null, "
+) + tagsFragment + NS_LITERAL_CSTRING(", h.frecency, h.hidden, h.guid "
+"FROM moz_places h "
+"LEFT JOIN moz_favicons f ON h.favicon_id = f.id "
+"WHERE h.url = :page_url ")
+);
+NS_ENSURE_STATE(stmt);
+mozStorageStatementScoper scoper(stmt);
+nsresult rv = URIBinder::Bind(stmt, NS_LITERAL_CSTRING("page_url"), aURI);
+NS_ENSURE_SUCCESS(rv, rv);
+bool hasMore = false;
+rv = stmt->ExecuteStep(&hasMore);
+NS_ENSURE_SUCCESS(rv, rv);
+if (!hasMore) {
+NS_NOTREACHED("Trying to get a result node for an invalid url");
+return NS_ERROR_INVALID_ARG;
+}
+nsCOMPtr<mozIStorageValueArray> row = do_QueryInterface(stmt, &rv);
+NS_ENSURE_SUCCESS(rv, rv);
+return RowToResult(row, aOptions, aResult);
+}
+void
+nsNavHistory::SendPageChangedNotification(nsIURI* aURI,
+uint32_t aChangedAttribute,
+const nsAString& aNewValue,
+const nsACString& aGUID)
+{
+MOZ_ASSERT(!aGUID.IsEmpty());
+NOTIFY_OBSERVERS(mCanNotify, mCacheObservers, mObservers,
+nsINavHistoryObserver,
+OnPageChanged(aURI, aChangedAttribute, aNewValue, aGUID));
+}
+// nsNavHistory::TitleForDomain
+//
+//    This computes the title for a given domain. Normally, this is just the
+//    domain name, but we specially handle empty cases to give you a nice
+//    localized string.
+void
+nsNavHistory::TitleForDomain(const nsCString& domain, nsACString& aTitle)
+{
+if (! domain.IsEmpty()) {
+aTitle = domain;
+return;
+}
+// use the localized one instead
+GetStringFromName(MOZ_UTF16("localhost"), aTitle);
+}
+void
+nsNavHistory::GetAgeInDaysString(int32_t aInt, const char16_t *aName,
+nsACString& aResult)
+{
+nsIStringBundle *bundle = GetBundle();
+if (bundle) {
+nsAutoString intString;
+intString.AppendInt(aInt);
+const char16_t* strings[1] = { intString.get() };
+nsXPIDLString value;
+nsresult rv = bundle->FormatStringFromName(aName, strings,
+1, getter_Copies(value));
+if (NS_SUCCEEDED(rv)) {
+CopyUTF16toUTF8(value, aResult);
+return;
+}
+}
+CopyUTF16toUTF8(nsDependentString(aName), aResult);
+}
+void
+nsNavHistory::GetStringFromName(const char16_t *aName, nsACString& aResult)
+{
+nsIStringBundle *bundle = GetBundle();
+if (bundle) {
+nsXPIDLString value;
+nsresult rv = bundle->GetStringFromName(aName, getter_Copies(value));
+if (NS_SUCCEEDED(rv)) {
+CopyUTF16toUTF8(value, aResult);
+return;
+}
+}
+CopyUTF16toUTF8(nsDependentString(aName), aResult);
+}
+void
+nsNavHistory::GetMonthName(int32_t aIndex, nsACString& aResult)
+{
+nsIStringBundle *bundle = GetDateFormatBundle();
+if (bundle) {
+nsCString name = nsPrintfCString("month.%d.name", aIndex);
+nsXPIDLString value;
+nsresult rv = bundle->GetStringFromName(NS_ConvertUTF8toUTF16(name).get(),
+getter_Copies(value));
+if (NS_SUCCEEDED(rv)) {
+CopyUTF16toUTF8(value, aResult);
+return;
+}
+}
+aResult = nsPrintfCString("[%d]", aIndex);
+}
+void
+nsNavHistory::GetMonthYear(int32_t aMonth, int32_t aYear, nsACString& aResult)
+{
+nsIStringBundle *bundle = GetBundle();
+if (bundle) {
+nsAutoCString monthName;
+GetMonthName(aMonth, monthName);
+nsAutoString yearString;
+yearString.AppendInt(aYear);
+const char16_t* strings[2] = {
+NS_ConvertUTF8toUTF16(monthName).get()
+, yearString.get()
+};
+nsXPIDLString value;
+if (NS_SUCCEEDED(bundle->FormatStringFromName(
+MOZ_UTF16("finduri-MonthYear"), strings, 2,
+getter_Copies(value)
+))) {
+CopyUTF16toUTF8(value, aResult);
+return;
+}
+}
+aResult.AppendLiteral("finduri-MonthYear");
+}
+namespace {
+// GetSimpleBookmarksQueryFolder
+//
+//    Determines if this set of queries is a simple bookmarks query for a
+//    folder with no other constraints. In these common cases, we can more
+//    efficiently compute the results.
+//
+//    A simple bookmarks query will result in a hierarchical tree of
+//    bookmark items, folders and separators.
+//
+//    Returns the folder ID if it is a simple folder query, 0 if not.
+static int64_t
+GetSimpleBookmarksQueryFolder(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsNavHistoryQueryOptions* aOptions)
+{
+if (aQueries.Count() != 1)
+return 0;
+nsNavHistoryQuery* query = aQueries[0];
+if (query->Folders().Length() != 1)
+return 0;
+bool hasIt;
+query->GetHasBeginTime(&hasIt);
+if (hasIt)
+return 0;
+query->GetHasEndTime(&hasIt);
+if (hasIt)
+return 0;
+query->GetHasDomain(&hasIt);
+if (hasIt)
+return 0;
+query->GetHasUri(&hasIt);
+if (hasIt)
+return 0;
+(void)query->GetHasSearchTerms(&hasIt);
+if (hasIt)
+return 0;
+if (query->Tags().Length() > 0)
+return 0;
+if (aOptions->MaxResults() > 0)
+return 0;
+// RESULTS_AS_TAG_CONTENTS is quite similar to a folder shortcut, but it must
+// not be treated like that, since it needs all query options.
+if(aOptions->ResultType() == nsINavHistoryQueryOptions::RESULTS_AS_TAG_CONTENTS)
+return 0;
+// Don't care about onlyBookmarked flag, since specifying a bookmark
+// folder is inferring onlyBookmarked.
+return query->Folders()[0];
+}
+// ParseSearchTermsFromQueries
+//
+//    Construct a matrix of search terms from the given queries array.
+//    All of the query objects are ORed together. Within a query, all the terms
+//    are ANDed together. See nsINavHistoryService.idl.
+//
+//    This just breaks the query up into words. We don't do anything fancy,
+//    not even quoting. We do, however, strip quotes, because people might
+//    try to input quotes expecting them to do something and get no results
+//    back.
+inline bool isQueryWhitespace(char16_t ch)
+{
+return ch == ' ';
+}
+void ParseSearchTermsFromQueries(const nsCOMArray<nsNavHistoryQuery>& aQueries,
+nsTArray<nsTArray<nsString>*>* aTerms)
+{
+int32_t lastBegin = -1;
+for (int32_t i = 0; i < aQueries.Count(); i++) {
+nsTArray<nsString> *queryTerms = new nsTArray<nsString>();
+bool hasSearchTerms;
+if (NS_SUCCEEDED(aQueries[i]->GetHasSearchTerms(&hasSearchTerms)) &&
+hasSearchTerms) {
+const nsString& searchTerms = aQueries[i]->SearchTerms();
+for (uint32_t j = 0; j < searchTerms.Length(); j++) {
+if (isQueryWhitespace(searchTerms[j]) ||
+searchTerms[j] == '"') {
+if (lastBegin >= 0) {
+// found the end of a word
+queryTerms->AppendElement(Substring(searchTerms, lastBegin,
+j - lastBegin));
+lastBegin = -1;
+}
+} else {
+if (lastBegin < 0) {
+// found the beginning of a word
+lastBegin = j;
+}
+}
+}
+// last word
+if (lastBegin >= 0)
+queryTerms->AppendElement(Substring(searchTerms, lastBegin));
+}
+aTerms->AppendElement(queryTerms);
+}
+}
+} // anonymous namespace
+nsresult
+nsNavHistory::UpdateFrecency(int64_t aPlaceId)
+{
+nsCOMPtr<mozIStorageAsyncStatement> updateFrecencyStmt = mDB->GetAsyncStatement(
+"UPDATE moz_places "
+"SET frecency = NOTIFY_FRECENCY("
+"CALCULATE_FRECENCY(:page_id), url, guid, hidden, last_visit_date"
+") "
+"WHERE id = :page_id"
+);
+NS_ENSURE_STATE(updateFrecencyStmt);
+nsresult rv = updateFrecencyStmt->BindInt64ByName(NS_LITERAL_CSTRING("page_id"),
+aPlaceId);
+NS_ENSURE_SUCCESS(rv, rv);
+nsCOMPtr<mozIStorageAsyncStatement> updateHiddenStmt = mDB->GetAsyncStatement(
+"UPDATE moz_places "
+"SET hidden = 0 "
+"WHERE id = :page_id AND frecency <> 0"
+);
+NS_ENSURE_STATE(updateHiddenStmt);
+rv = updateHiddenStmt->BindInt64ByName(NS_LITERAL_CSTRING("page_id"),
+aPlaceId);
+NS_ENSURE_SUCCESS(rv, rv);
+mozIStorageBaseStatement *stmts[] = {
+updateFrecencyStmt.get()
+, updateHiddenStmt.get()
+};
+nsRefPtr<AsyncStatementCallbackNotifier> cb =
+new AsyncStatementCallbackNotifier(TOPIC_FRECENCY_UPDATED);
+nsCOMPtr<mozIStoragePendingStatement> ps;
+rv = mDB->MainConn()->ExecuteAsync(stmts, ArrayLength(stmts), cb,
+getter_AddRefs(ps));
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+namespace {
+class FixInvalidFrecenciesCallback : public AsyncStatementCallbackNotifier
+{
+public:
+FixInvalidFrecenciesCallback()
+: AsyncStatementCallbackNotifier(TOPIC_FRECENCY_UPDATED)
+{
+}
+NS_IMETHOD HandleCompletion(uint16_t aReason)
+{
+nsresult rv = AsyncStatementCallbackNotifier::HandleCompletion(aReason);
+NS_ENSURE_SUCCESS(rv, rv);
+if (aReason == REASON_FINISHED) {
+nsNavHistory *navHistory = nsNavHistory::GetHistoryService();
+NS_ENSURE_STATE(navHistory);
+navHistory->NotifyManyFrecenciesChanged();
+}
+return NS_OK;
+}
+};
+} // anonymous namespace
+nsresult
+nsNavHistory::FixInvalidFrecencies()
+{
+nsCOMPtr<mozIStorageAsyncStatement> stmt = mDB->GetAsyncStatement(
+"UPDATE moz_places "
+"SET frecency = CALCULATE_FRECENCY(id) "
+"WHERE frecency < 0"
+);
+NS_ENSURE_STATE(stmt);
+nsRefPtr<FixInvalidFrecenciesCallback> callback =
+new FixInvalidFrecenciesCallback();
+nsCOMPtr<mozIStoragePendingStatement> ps;
+(void)stmt->ExecuteAsync(callback, getter_AddRefs(ps));
+return NS_OK;
+}
+#ifdef MOZ_XUL
+nsresult
+nsNavHistory::AutoCompleteFeedback(int32_t aIndex,
+nsIAutoCompleteController *aController)
+{
+nsCOMPtr<mozIStorageAsyncStatement> stmt = mDB->GetAsyncStatement(
+"INSERT OR REPLACE INTO moz_inputhistory "
+// use_count will asymptotically approach the max of 10.
+"SELECT h.id, IFNULL(i.input, :input_text), IFNULL(i.use_count, 0) * .9 + 1 "
+"FROM moz_places h "
+"LEFT JOIN moz_inputhistory i ON i.place_id = h.id AND i.input = :input_text "
+"WHERE url = :page_url "
+);
+NS_ENSURE_STATE(stmt);
+nsAutoString input;
+nsresult rv = aController->GetSearchString(input);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = stmt->BindStringByName(NS_LITERAL_CSTRING("input_text"), input);
+NS_ENSURE_SUCCESS(rv, rv);
+nsAutoString url;
+rv = aController->GetValueAt(aIndex, url);
+NS_ENSURE_SUCCESS(rv, rv);
+rv = URIBinder::Bind(stmt, NS_LITERAL_CSTRING("page_url"),
+NS_ConvertUTF16toUTF8(url));
+NS_ENSURE_SUCCESS(rv, rv);
+// We do the update asynchronously and we do not care about failures.
+nsRefPtr<AsyncStatementCallbackNotifier> callback =
+new AsyncStatementCallbackNotifier(TOPIC_AUTOCOMPLETE_FEEDBACK_UPDATED);
+nsCOMPtr<mozIStoragePendingStatement> canceler;
+rv = stmt->ExecuteAsync(callback, getter_AddRefs(canceler));
+NS_ENSURE_SUCCESS(rv, rv);
+return NS_OK;
+}
+#endif
+nsICollation *
+nsNavHistory::GetCollation()
+{
+if (mCollation)
+return mCollation;
+// locale
+nsCOMPtr<nsILocale> locale;
+nsCOMPtr<nsILocaleService> ls(do_GetService(NS_LOCALESERVICE_CONTRACTID));
+NS_ENSURE_TRUE(ls, nullptr);
+nsresult rv = ls->GetApplicationLocale(getter_AddRefs(locale));
+NS_ENSURE_SUCCESS(rv, nullptr);
+// collation
+nsCOMPtr<nsICollationFactory> cfact =
+do_CreateInstance(NS_COLLATIONFACTORY_CONTRACTID);
+NS_ENSURE_TRUE(cfact, nullptr);
+rv = cfact->CreateCollation(locale, getter_AddRefs(mCollation));
+NS_ENSURE_SUCCESS(rv, nullptr);
+return mCollation;
+}
+nsIStringBundle *
+nsNavHistory::GetBundle()
+{
+if (!mBundle) {
+nsCOMPtr<nsIStringBundleService> bundleService =
+services::GetStringBundleService();
+NS_ENSURE_TRUE(bundleService, nullptr);
+nsresult rv = bundleService->CreateBundle(
+"chrome://places/locale/places.properties",
+getter_AddRefs(mBundle));
+NS_ENSURE_SUCCESS(rv, nullptr);
+}
+return mBundle;
+}
+nsIStringBundle *
+nsNavHistory::GetDateFormatBundle()
+{
+if (!mDateFormatBundle) {
+nsCOMPtr<nsIStringBundleService> bundleService =
+services::GetStringBundleService();
+NS_ENSURE_TRUE(bundleService, nullptr);
+nsresult rv = bundleService->CreateBundle(
+"chrome://global/locale/dateFormat.properties",
+getter_AddRefs(mDateFormatBundle));
+NS_ENSURE_SUCCESS(rv, nullptr);
+}
+return mDateFormatBundle;
+}

The Tor Browser / file comparison

comparison: toolkit/components/places/nsNavHistory.cpp

toolkit/components/places/nsNavHistory.cpp