Dactyloidae iOS initial commit

mobile/ios/Storage/History.swift

@@ -0,0 +1,108 @@
+/* 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/. */
+
+import Shared
+import Deferred
+
+open class IgnoredSiteError: MaybeErrorType {
+    open var description: String {
+        return "Ignored site."
+    }
+}
+
+/**
+ * The base history protocol for front-end code.
+ *
+ * Note that the implementation of these methods might be complicated if
+ * the implementing class also implements SyncableHistory -- for example,
+ * `clear` might or might not need to set a bunch of flags to upload deletions.
+ */
+public protocol BrowserHistory {
+    @discardableResult func addLocalVisit(_ visit: SiteVisit) -> Success
+    func clearHistory() -> Success
+    @discardableResult func removeHistoryForURL(_ url: String) -> Success
+    func removeSiteFromTopSites(_ site: Site) -> Success
+    func removeHostFromTopSites(_ host: String) -> Success
+    func getFrecentHistory() -> FrecentHistory
+    func getSitesByLastVisit(_ limit: Int) -> Deferred<Maybe<Cursor<Site>>>
+    func getTopSitesWithLimit(_ limit: Int) -> Deferred<Maybe<Cursor<Site>>>
+    func setTopSitesNeedsInvalidation()
+    func setTopSitesCacheSize(_ size: Int32)
+    func clearTopSitesCache() -> Success
+
+    // Pinning top sites
+    func removeFromPinnedTopSites(_ site: Site) -> Success
+    func addPinnedTopSite(_ site: Site) -> Success
+    func getPinnedTopSites() -> Deferred<Maybe<Cursor<Site>>>
+}
+
+/**
+ * An interface for fast repeated frecency queries.
+ */
+public protocol FrecentHistory {
+    func getSites(whereURLContains filter: String?, historyLimit limit: Int, bookmarksLimit: Int) -> Deferred<Maybe<Cursor<Site>>>
+    func updateTopSitesCacheQuery() -> (String, Args?)
+}
+
+/**
+ * An interface for accessing recommendation content from Storage
+ */
+public protocol HistoryRecommendations {
+    func getHighlights() -> Deferred<Maybe<Cursor<Site>>>
+    func getRecentBookmarks(_ limit: Int) -> Deferred<Maybe<Cursor<Site>>>
+
+    func removeHighlightForURL(_ url: String) -> Success
+    func repopulate(invalidateTopSites shouldInvalidateTopSites: Bool, invalidateHighlights shouldInvalidateHighlights: Bool) -> Success
+}
+
+/**
+ * The interface that history storage needs to provide in order to be
+ * synced by a `HistorySynchronizer`.
+ */
+public protocol SyncableHistory: AccountRemovalDelegate {
+    /**
+     * Make sure that the local place with the provided URL has the provided GUID.
+     * Succeeds if no place exists with that URL.
+     */
+    func ensurePlaceWithURL(_ url: String, hasGUID guid: GUID) -> Success
+
+    /**
+     * Delete the place with the provided GUID, and all of its visits. Succeeds if the GUID is unknown.
+     */
+    func deleteByGUID(_ guid: GUID, deletedAt: Timestamp) -> Success
+
+    func storeRemoteVisits(_ visits: [Visit], forGUID guid: GUID) -> Success
+    func insertOrUpdatePlace(_ place: Place, modified: Timestamp) -> Deferred<Maybe<GUID>>
+
+    func getModifiedHistoryToUpload() -> Deferred<Maybe<[(Place, [Visit])]>>
+    func getDeletedHistoryToUpload() -> Deferred<Maybe<[GUID]>>
+
+    /**
+     * Chains through the provided timestamp.
+     */
+    func markAsSynchronized(_: [GUID], modified: Timestamp) -> Deferred<Maybe<Timestamp>>
+    func markAsDeleted(_ guids: [GUID]) -> Success
+
+    func doneApplyingRecordsAfterDownload() -> Success
+    func doneUpdatingMetadataAfterUpload() -> Success
+
+    /**
+     * For inspecting whether we're an active participant in history sync.
+     */
+    func hasSyncedHistory() -> Deferred<Maybe<Bool>>
+}
+
+// TODO: integrate Site with this.
+
+open class Place {
+    open let guid: GUID
+    open let url: String
+    open let title: String
+
+    public init(guid: GUID, url: String, title: String) {
+        self.guid = guid
+        self.url = url
+        self.title = title
+    }
+}