michael@0: /* This Source Code Form is subject to the terms of the Mozilla Public
michael@0:  * License, v. 2.0. If a copy of the MPL was not distributed with this
michael@0:  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
michael@0: 
michael@0: #include "nsThreadUtils.h"
michael@0: #include "nsAndroidHistory.h"
michael@0: #include "AndroidBridge.h"
michael@0: #include "Link.h"
michael@0: #include "nsIURI.h"
michael@0: #include "mozilla/Services.h"
michael@0: #include "nsIObserverService.h"
michael@0: 
michael@0: #define NS_LINK_VISITED_EVENT_TOPIC "link-visited"
michael@0: 
michael@0: using namespace mozilla;
michael@0: using mozilla::dom::Link;
michael@0: 
michael@0: NS_IMPL_ISUPPORTS(nsAndroidHistory, IHistory, nsIRunnable)
michael@0: 
michael@0: nsAndroidHistory* nsAndroidHistory::sHistory = nullptr;
michael@0: 
michael@0: /*static*/
michael@0: nsAndroidHistory*
michael@0: nsAndroidHistory::GetSingleton()
michael@0: {
michael@0:   if (!sHistory) {
michael@0:     sHistory = new nsAndroidHistory();
michael@0:     NS_ENSURE_TRUE(sHistory, nullptr);
michael@0:   }
michael@0: 
michael@0:   NS_ADDREF(sHistory);
michael@0:   return sHistory;
michael@0: }
michael@0: 
michael@0: nsAndroidHistory::nsAndroidHistory()
michael@0: {
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::RegisterVisitedCallback(nsIURI *aURI, Link *aContent)
michael@0: {
michael@0:   if (!aContent || !aURI)
michael@0:     return NS_OK;
michael@0: 
michael@0:   // Silently return if URI is something we would never add to DB.
michael@0:   bool canAdd;
michael@0:   nsresult rv = CanAddURI(aURI, &canAdd);
michael@0:   NS_ENSURE_SUCCESS(rv, rv);
michael@0:   if (!canAdd) {
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   nsAutoCString uri;
michael@0:   rv = aURI->GetSpec(uri);
michael@0:   if (NS_FAILED(rv)) return rv;
michael@0:   NS_ConvertUTF8toUTF16 uriString(uri);
michael@0: 
michael@0:   nsTArray<Link*>* list = mListeners.Get(uriString);
michael@0:   if (! list) {
michael@0:     list = new nsTArray<Link*>();
michael@0:     mListeners.Put(uriString, list);
michael@0:   }
michael@0:   list->AppendElement(aContent);
michael@0: 
michael@0:   if (AndroidBridge::HasEnv()) {
michael@0:     mozilla::widget::android::GeckoAppShell::CheckURIVisited(uriString);
michael@0:   }
michael@0: 
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::UnregisterVisitedCallback(nsIURI *aURI, Link *aContent)
michael@0: {
michael@0:   if (!aContent || !aURI)
michael@0:     return NS_OK;
michael@0: 
michael@0:   nsAutoCString uri;
michael@0:   nsresult rv = aURI->GetSpec(uri);
michael@0:   if (NS_FAILED(rv)) return rv;
michael@0:   NS_ConvertUTF8toUTF16 uriString(uri);
michael@0: 
michael@0:   nsTArray<Link*>* list = mListeners.Get(uriString);
michael@0:   if (! list)
michael@0:     return NS_OK;
michael@0: 
michael@0:   list->RemoveElement(aContent);
michael@0:   if (list->IsEmpty()) {
michael@0:     mListeners.Remove(uriString);
michael@0:     delete list;
michael@0:   }
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: void
michael@0: nsAndroidHistory::AppendToRecentlyVisitedURIs(nsIURI* aURI) {
michael@0:   if (mRecentlyVisitedURIs.Length() < RECENTLY_VISITED_URI_SIZE) {
michael@0:     // Append a new element while the array is not full.
michael@0:     mRecentlyVisitedURIs.AppendElement(aURI);
michael@0:   } else {
michael@0:     // Otherwise, replace the oldest member.
michael@0:     mRecentlyVisitedURIsNextIndex %= RECENTLY_VISITED_URI_SIZE;
michael@0:     mRecentlyVisitedURIs.ElementAt(mRecentlyVisitedURIsNextIndex) = aURI;
michael@0:     mRecentlyVisitedURIsNextIndex++;
michael@0:   }
michael@0: }
michael@0: 
michael@0: inline bool
michael@0: nsAndroidHistory::IsRecentlyVisitedURI(nsIURI* aURI) {
michael@0:   bool equals = false;
michael@0:   RecentlyVisitedArray::index_type i;
michael@0:   RecentlyVisitedArray::size_type length = mRecentlyVisitedURIs.Length();
michael@0:   for (i = 0; i < length && !equals; ++i) {
michael@0:     aURI->Equals(mRecentlyVisitedURIs.ElementAt(i), &equals);
michael@0:   }
michael@0:   return equals;
michael@0: }
michael@0: 
michael@0: void
michael@0: nsAndroidHistory::AppendToEmbedURIs(nsIURI* aURI) {
michael@0:   if (mEmbedURIs.Length() < EMBED_URI_SIZE) {
michael@0:     // Append a new element while the array is not full.
michael@0:     mEmbedURIs.AppendElement(aURI);
michael@0:   } else {
michael@0:     // Otherwise, replace the oldest member.
michael@0:     mEmbedURIsNextIndex %= EMBED_URI_SIZE;
michael@0:     mEmbedURIs.ElementAt(mEmbedURIsNextIndex) = aURI;
michael@0:     mEmbedURIsNextIndex++;
michael@0:   }
michael@0: }
michael@0: 
michael@0: inline bool
michael@0: nsAndroidHistory::IsEmbedURI(nsIURI* aURI) {
michael@0:   bool equals = false;
michael@0:   EmbedArray::index_type i;
michael@0:   EmbedArray::size_type length = mEmbedURIs.Length();
michael@0:   for (i = 0; i < length && !equals; ++i) {
michael@0:     aURI->Equals(mEmbedURIs.ElementAt(i), &equals);
michael@0:   }
michael@0:   return equals;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::VisitURI(nsIURI *aURI, nsIURI *aLastVisitedURI, uint32_t aFlags)
michael@0: {
michael@0:   if (!aURI)
michael@0:     return NS_OK;
michael@0: 
michael@0:   // Silently return if URI is something we shouldn't add to DB.
michael@0:   bool canAdd;
michael@0:   nsresult rv = CanAddURI(aURI, &canAdd);
michael@0:   NS_ENSURE_SUCCESS(rv, rv);
michael@0:   if (!canAdd) {
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   if (aLastVisitedURI) {
michael@0:     bool same;
michael@0:     rv = aURI->Equals(aLastVisitedURI, &same);
michael@0:     NS_ENSURE_SUCCESS(rv, rv);
michael@0:     if (same && IsRecentlyVisitedURI(aURI)) {
michael@0:       // Do not save refresh visits if we have visited this URI recently.
michael@0:       return NS_OK;
michael@0:     }
michael@0:   }
michael@0: 
michael@0:   if (!(aFlags & VisitFlags::TOP_LEVEL)) {
michael@0:     AppendToEmbedURIs(aURI);
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   if (aFlags & VisitFlags::REDIRECT_SOURCE)
michael@0:     return NS_OK;
michael@0: 
michael@0:   if (aFlags & VisitFlags::UNRECOVERABLE_ERROR)
michael@0:     return NS_OK;
michael@0: 
michael@0:   if (AndroidBridge::HasEnv()) {
michael@0:     nsAutoCString uri;
michael@0:     rv = aURI->GetSpec(uri);
michael@0:     if (NS_FAILED(rv)) return rv;
michael@0:     NS_ConvertUTF8toUTF16 uriString(uri);
michael@0:     mozilla::widget::android::GeckoAppShell::MarkURIVisited(uriString);
michael@0:   }
michael@0: 
michael@0:   AppendToRecentlyVisitedURIs(aURI);
michael@0: 
michael@0:   // Finally, notify that we've been visited.
michael@0:   nsCOMPtr<nsIObserverService> obsService =
michael@0:     mozilla::services::GetObserverService();
michael@0:   if (obsService) {
michael@0:     obsService->NotifyObservers(aURI, NS_LINK_VISITED_EVENT_TOPIC, nullptr);
michael@0:   }
michael@0: 
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::SetURITitle(nsIURI *aURI, const nsAString& aTitle)
michael@0: {
michael@0:   // Silently return if URI is something we shouldn't add to DB.
michael@0:   bool canAdd;
michael@0:   nsresult rv = CanAddURI(aURI, &canAdd);
michael@0:   NS_ENSURE_SUCCESS(rv, rv);
michael@0:   if (!canAdd) {
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   if (IsEmbedURI(aURI)) {
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   if (AndroidBridge::HasEnv()) {
michael@0:     nsAutoCString uri;
michael@0:     nsresult rv = aURI->GetSpec(uri);
michael@0:     if (NS_FAILED(rv)) return rv;
michael@0:     NS_ConvertUTF8toUTF16 uriString(uri);
michael@0:     mozilla::widget::android::GeckoAppShell::SetURITitle(uriString, aTitle);
michael@0:   }
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::NotifyVisited(nsIURI *aURI)
michael@0: {
michael@0:   if (aURI && sHistory) {
michael@0:     nsAutoCString spec;
michael@0:     (void)aURI->GetSpec(spec);
michael@0:     sHistory->mPendingURIs.Push(NS_ConvertUTF8toUTF16(spec));
michael@0:     NS_DispatchToMainThread(sHistory);
michael@0:   }
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::Run()
michael@0: {
michael@0:   while (! mPendingURIs.IsEmpty()) {
michael@0:     nsString uriString = mPendingURIs.Pop();
michael@0:     nsTArray<Link*>* list = sHistory->mListeners.Get(uriString);
michael@0:     if (list) {
michael@0:       for (unsigned int i = 0; i < list->Length(); i++) {
michael@0:         list->ElementAt(i)->SetLinkState(eLinkState_Visited);
michael@0:       }
michael@0:       // as per the IHistory interface contract, remove the
michael@0:       // Link pointers once they have been notified
michael@0:       mListeners.Remove(uriString);
michael@0:       delete list;
michael@0:     }
michael@0:   }
michael@0:   return NS_OK;
michael@0: }
michael@0: 
michael@0: // Filter out unwanted URIs such as "chrome:", "mailbox:", etc.
michael@0: //
michael@0: // The model is if we don't know differently then add which basically means
michael@0: // we are suppose to try all the things we know not to allow in and then if
michael@0: // we don't bail go on and allow it in.
michael@0: //
michael@0: // Logic ported from nsNavHistory::CanAddURI.
michael@0: 
michael@0: NS_IMETHODIMP
michael@0: nsAndroidHistory::CanAddURI(nsIURI* aURI, bool* canAdd)
michael@0: {
michael@0:   NS_ASSERTION(NS_IsMainThread(), "This can only be called on the main thread");
michael@0:   NS_ENSURE_ARG(aURI);
michael@0:   NS_ENSURE_ARG_POINTER(canAdd);
michael@0: 
michael@0:   nsAutoCString scheme;
michael@0:   nsresult rv = aURI->GetScheme(scheme);
michael@0:   NS_ENSURE_SUCCESS(rv, rv);
michael@0: 
michael@0:   // first check the most common cases (HTTP, HTTPS) to allow in to avoid most
michael@0:   // of the work
michael@0:   if (scheme.EqualsLiteral("http")) {
michael@0:     *canAdd = true;
michael@0:     return NS_OK;
michael@0:   }
michael@0:   if (scheme.EqualsLiteral("https")) {
michael@0:     *canAdd = true;
michael@0:     return NS_OK;
michael@0:   }
michael@0: 
michael@0:   // now check for all bad things
michael@0:   if (scheme.EqualsLiteral("about") ||
michael@0:       scheme.EqualsLiteral("imap") ||
michael@0:       scheme.EqualsLiteral("news") ||
michael@0:       scheme.EqualsLiteral("mailbox") ||
michael@0:       scheme.EqualsLiteral("moz-anno") ||
michael@0:       scheme.EqualsLiteral("view-source") ||
michael@0:       scheme.EqualsLiteral("chrome") ||
michael@0:       scheme.EqualsLiteral("resource") ||
michael@0:       scheme.EqualsLiteral("data") ||
michael@0:       scheme.EqualsLiteral("wyciwyg") ||
michael@0:       scheme.EqualsLiteral("javascript") ||
michael@0:       scheme.EqualsLiteral("blob")) {
michael@0:     *canAdd = false;
michael@0:     return NS_OK;
michael@0:   }
michael@0:   *canAdd = true;
michael@0:   return NS_OK;
michael@0: }