diff options
Diffstat (limited to 'mobile/android/components/build/nsAndroidHistory.cpp')
| -rw-r--r-- | mobile/android/components/build/nsAndroidHistory.cpp | 395 |
1 files changed, 395 insertions, 0 deletions
diff --git a/mobile/android/components/build/nsAndroidHistory.cpp b/mobile/android/components/build/nsAndroidHistory.cpp new file mode 100644 index 0000000000..2610781c07 --- /dev/null +++ b/mobile/android/components/build/nsAndroidHistory.cpp @@ -0,0 +1,395 @@ +/* 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 "nsThreadUtils.h" +#include "nsAndroidHistory.h" +#include "nsComponentManagerUtils.h" +#include "nsIURI.h" +#include "nsIObserverService.h" +#include "GeneratedJNIWrappers.h" +#include "Link.h" + +#include "mozilla/Services.h" +#include "mozilla/Preferences.h" + +#define NS_LINK_VISITED_EVENT_TOPIC "link-visited" + +// We copy Places here. +// Note that we don't yet observe this pref at runtime. +#define PREF_HISTORY_ENABLED "places.history.enabled" + +// Time we wait to see if a pending visit is really a redirect +#define PENDING_REDIRECT_TIMEOUT 3000 + +using namespace mozilla; +using mozilla::dom::Link; + +NS_IMPL_ISUPPORTS(nsAndroidHistory, IHistory, nsIRunnable, nsITimerCallback) + +nsAndroidHistory* nsAndroidHistory::sHistory = nullptr; + +/*static*/ +nsAndroidHistory* +nsAndroidHistory::GetSingleton() +{ + if (!sHistory) { + sHistory = new nsAndroidHistory(); + NS_ENSURE_TRUE(sHistory, nullptr); + } + + NS_ADDREF(sHistory); + return sHistory; +} + +nsAndroidHistory::nsAndroidHistory() + : mHistoryEnabled(true) +{ + LoadPrefs(); + + mTimer = do_CreateInstance(NS_TIMER_CONTRACTID); +} + +NS_IMETHODIMP +nsAndroidHistory::RegisterVisitedCallback(nsIURI *aURI, Link *aContent) +{ + if (!aContent || !aURI) + return NS_OK; + + // Silently return if URI is something we would never add to DB. + bool canAdd; + nsresult rv = CanAddURI(aURI, &canAdd); + NS_ENSURE_SUCCESS(rv, rv); + if (!canAdd) { + return NS_OK; + } + + nsAutoCString uri; + rv = aURI->GetSpec(uri); + if (NS_FAILED(rv)) return rv; + NS_ConvertUTF8toUTF16 uriString(uri); + + nsTArray<Link*>* list = mListeners.Get(uriString); + if (! list) { + list = new nsTArray<Link*>(); + mListeners.Put(uriString, list); + } + list->AppendElement(aContent); + + if (jni::IsAvailable()) { + java::GeckoAppShell::CheckURIVisited(uriString); + } + + return NS_OK; +} + +NS_IMETHODIMP +nsAndroidHistory::UnregisterVisitedCallback(nsIURI *aURI, Link *aContent) +{ + if (!aContent || !aURI) + return NS_OK; + + nsAutoCString uri; + nsresult rv = aURI->GetSpec(uri); + if (NS_FAILED(rv)) return rv; + NS_ConvertUTF8toUTF16 uriString(uri); + + nsTArray<Link*>* list = mListeners.Get(uriString); + if (! list) + return NS_OK; + + list->RemoveElement(aContent); + if (list->IsEmpty()) { + mListeners.Remove(uriString); + delete list; + } + return NS_OK; +} + +void +nsAndroidHistory::AppendToRecentlyVisitedURIs(nsIURI* aURI) { + if (mRecentlyVisitedURIs.Length() < RECENTLY_VISITED_URI_SIZE) { + // Append a new element while the array is not full. + mRecentlyVisitedURIs.AppendElement(aURI); + } else { + // Otherwise, replace the oldest member. + mRecentlyVisitedURIsNextIndex %= RECENTLY_VISITED_URI_SIZE; + mRecentlyVisitedURIs.ElementAt(mRecentlyVisitedURIsNextIndex) = aURI; + mRecentlyVisitedURIsNextIndex++; + } +} + +bool +nsAndroidHistory::ShouldRecordHistory() { + return mHistoryEnabled; +} + +void +nsAndroidHistory::LoadPrefs() { + mHistoryEnabled = Preferences::GetBool(PREF_HISTORY_ENABLED, true); +} + +inline bool +nsAndroidHistory::IsRecentlyVisitedURI(nsIURI* aURI) { + bool equals = false; + RecentlyVisitedArray::index_type i; + RecentlyVisitedArray::size_type length = mRecentlyVisitedURIs.Length(); + for (i = 0; i < length && !equals; ++i) { + aURI->Equals(mRecentlyVisitedURIs.ElementAt(i), &equals); + } + return equals; +} + +void +nsAndroidHistory::AppendToEmbedURIs(nsIURI* aURI) { + if (mEmbedURIs.Length() < EMBED_URI_SIZE) { + // Append a new element while the array is not full. + mEmbedURIs.AppendElement(aURI); + } else { + // Otherwise, replace the oldest member. + mEmbedURIsNextIndex %= EMBED_URI_SIZE; + mEmbedURIs.ElementAt(mEmbedURIsNextIndex) = aURI; + mEmbedURIsNextIndex++; + } +} + +inline bool +nsAndroidHistory::IsEmbedURI(nsIURI* aURI) { + bool equals = false; + EmbedArray::index_type i; + EmbedArray::size_type length = mEmbedURIs.Length(); + for (i = 0; i < length && !equals; ++i) { + aURI->Equals(mEmbedURIs.ElementAt(i), &equals); + } + return equals; +} + +inline bool +nsAndroidHistory::RemovePendingVisitURI(nsIURI* aURI) { + // Remove the first pending URI that matches. Return a boolean to + // let the caller know if we removed a URI or not. + bool equals = false; + PendingVisitArray::index_type i; + for (i = 0; i < mPendingVisitURIs.Length(); ++i) { + aURI->Equals(mPendingVisitURIs.ElementAt(i), &equals); + if (equals) { + mPendingVisitURIs.RemoveElementAt(i); + return true; + } + } + return false; +} + +NS_IMETHODIMP +nsAndroidHistory::Notify(nsITimer *timer) +{ + // Any pending visits left in the queue have exceeded our threshold for + // redirects, so save them + PendingVisitArray::index_type i; + for (i = 0; i < mPendingVisitURIs.Length(); ++i) { + SaveVisitURI(mPendingVisitURIs.ElementAt(i)); + } + mPendingVisitURIs.Clear(); + + return NS_OK; +} + +void +nsAndroidHistory::SaveVisitURI(nsIURI* aURI) { + // Add the URI to our cache so we can take a fast path later + AppendToRecentlyVisitedURIs(aURI); + + if (jni::IsAvailable()) { + // Save this URI in our history + nsAutoCString spec; + (void)aURI->GetSpec(spec); + java::GeckoAppShell::MarkURIVisited(NS_ConvertUTF8toUTF16(spec)); + } + + // Finally, notify that we've been visited. + nsCOMPtr<nsIObserverService> obsService = mozilla::services::GetObserverService(); + if (obsService) { + obsService->NotifyObservers(aURI, NS_LINK_VISITED_EVENT_TOPIC, nullptr); + } +} + +NS_IMETHODIMP +nsAndroidHistory::VisitURI(nsIURI *aURI, nsIURI *aLastVisitedURI, uint32_t aFlags) +{ + if (!aURI) { + return NS_OK; + } + + if (!(aFlags & VisitFlags::TOP_LEVEL)) { + return NS_OK; + } + + if (aFlags & VisitFlags::UNRECOVERABLE_ERROR) { + return NS_OK; + } + + // Silently return if URI is something we shouldn't add to DB. + bool canAdd; + nsresult rv = CanAddURI(aURI, &canAdd); + NS_ENSURE_SUCCESS(rv, rv); + if (!canAdd) { + return NS_OK; + } + + if (aLastVisitedURI) { + if (aFlags & VisitFlags::REDIRECT_SOURCE || + aFlags & VisitFlags::REDIRECT_PERMANENT || + aFlags & VisitFlags::REDIRECT_TEMPORARY) { + // aLastVisitedURI redirected to aURI. We want to ignore aLastVisitedURI, + // so remove the pending visit. We want to give aURI a chance to be saved, + // so don't return early. + RemovePendingVisitURI(aLastVisitedURI); + } + + bool same; + rv = aURI->Equals(aLastVisitedURI, &same); + NS_ENSURE_SUCCESS(rv, rv); + if (same && IsRecentlyVisitedURI(aURI)) { + // Do not save refresh visits if we have visited this URI recently. + return NS_OK; + } + + // Since we have a last visited URI and we were not redirected, it is + // safe to save the visit if it's still pending. + if (RemovePendingVisitURI(aLastVisitedURI)) { + SaveVisitURI(aLastVisitedURI); + } + } + + // Let's wait and see if this visit is not a redirect. + mPendingVisitURIs.AppendElement(aURI); + mTimer->InitWithCallback(this, PENDING_REDIRECT_TIMEOUT, nsITimer::TYPE_ONE_SHOT); + + return NS_OK; +} + +NS_IMETHODIMP +nsAndroidHistory::SetURITitle(nsIURI *aURI, const nsAString& aTitle) +{ + // Silently return if URI is something we shouldn't add to DB. + bool canAdd; + nsresult rv = CanAddURI(aURI, &canAdd); + NS_ENSURE_SUCCESS(rv, rv); + if (!canAdd) { + return NS_OK; + } + + if (IsEmbedURI(aURI)) { + return NS_OK; + } + + if (jni::IsAvailable()) { + nsAutoCString uri; + nsresult rv = aURI->GetSpec(uri); + if (NS_FAILED(rv)) return rv; + if (RemovePendingVisitURI(aURI)) { + // We have a title, so aURI isn't a redirect, so save the visit now before setting the title. + SaveVisitURI(aURI); + } + NS_ConvertUTF8toUTF16 uriString(uri); + java::GeckoAppShell::SetURITitle(uriString, aTitle); + } + return NS_OK; +} + +NS_IMETHODIMP +nsAndroidHistory::NotifyVisited(nsIURI *aURI) +{ + if (aURI && sHistory) { + nsAutoCString spec; + (void)aURI->GetSpec(spec); + sHistory->mPendingLinkURIs.Push(NS_ConvertUTF8toUTF16(spec)); + NS_DispatchToMainThread(sHistory); + } + return NS_OK; +} + +NS_IMETHODIMP +nsAndroidHistory::Run() +{ + while (! mPendingLinkURIs.IsEmpty()) { + nsString uriString = mPendingLinkURIs.Pop(); + nsTArray<Link*>* list = sHistory->mListeners.Get(uriString); + if (list) { + for (unsigned int i = 0; i < list->Length(); i++) { + list->ElementAt(i)->SetLinkState(eLinkState_Visited); + } + // as per the IHistory interface contract, remove the + // Link pointers once they have been notified + mListeners.Remove(uriString); + delete list; + } + } + return NS_OK; +} + +// 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. +// +// Logic ported from nsNavHistory::CanAddURI. + +NS_IMETHODIMP +nsAndroidHistory::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); + + // See if we're disabled. + if (!ShouldRecordHistory()) { + *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; + } + if (scheme.EqualsLiteral("about")) { + nsAutoCString path; + rv = aURI->GetPath(path); + NS_ENSURE_SUCCESS(rv, rv); + + if (StringBeginsWith(path, NS_LITERAL_CSTRING("reader"))) { + *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; +} |