Move website settings fetching from WebsitePreferences to new WebsitePermissionFetcher.

chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePermissionsFetcher.java

Index: chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePermissionsFetcher.java
diff --git a/chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePermissionsFetcher.java b/chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePermissionsFetcher.java
new file mode 100644
index 0000000000000000000000000000000000000000..5abd3611bdca21c0ca8cbf3f4326e4c75e51ef28
--- /dev/null
+++ b/chrome/android/java/src/org/chromium/chrome/browser/preferences/website/WebsitePermissionsFetcher.java
@@ -0,0 +1,312 @@
+// Copyright 2015 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package org.chromium.chrome.browser.preferences.website;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.LinkedList;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Utility class that asynchronously fetches any Websites and the permissions
+ * that the user has set for them.
+ */
+public class WebsitePermissionsFetcher {
+    /**
+     * A callback to pass to WebsitePermissionsFetcher. This is run when the
+     * website permissions have been fetched.
+     */
+    public interface WebsitePermissionsCallback {
+        void onWebsitePermissionsAvailable(
+                Map<String, Set<Website>> sitesByOrigin, Map<String, Set<Website>> sitesByHost);
+    }
+
+    // This is a 1 <--> 1..N mapping between origin and Website.
+    // TODO(mvanouwerkerk): The Website class has no equals or hashCode methods so storing them in
+    // a HashSet is really confusing to readers of this code. There is no deduplication at all.
+    private final Map<String, Set<Website>> mSitesByOrigin = new HashMap<>();
+
+    // This is a 1 <--> 1..N mapping between host and Website.
+    // TODO(mvanouwerkerk): The Website class has no equals or hashCode methods so storing them in
+    // a HashSet is really confusing to readers of this code. There is no deduplication at all.
+    private final Map<String, Set<Website>> mSitesByHost = new HashMap<>();
+
+    // The callback to run when the permissions have been fetched.
+    private final WebsitePermissionsCallback mCallback;
+
+    /**
+     * @param callback The callback to run when the fetch is complete.
+     */
+    public WebsitePermissionsFetcher(WebsitePermissionsCallback callback) {
+        mCallback = callback;
+    }
+
+    /**
+     * Fetches preferences for all sites that have them.
+     * TODO(mvanouwerkerk): Add an argument |url| to only fetch permissions for
+     * sites from the same origin as that of |url| - https://crbug.com/459222.
+     */
+    public void fetchAllPreferences() {
+        TaskQueue queue = new TaskQueue();
+        // Populate features from more specific to less specific.
+        // Geolocation lookup permission is per-origin and per-embedder.
+        queue.add(new GeolocationInfoFetcher());
+        // Midi sysex access permission is per-origin and per-embedder.
+        queue.add(new MidiInfoFetcher());
+        // Cookies are stored per-origin.
+        queue.add(new CookieInfoFetcher());
+        // Local storage info is per-origin.
+        queue.add(new LocalStorageInfoFetcher());
+        // Website storage is per-host.
+        queue.add(new WebStorageInfoFetcher());
+        // Popup exceptions are host-based patterns (unless we start
+        // synchronizing popup exceptions with desktop Chrome.)
+        queue.add(new PopupExceptionInfoFetcher());
+        // Protected media identifier permission is per-origin and per-embedder.
+        queue.add(new ProtectedMediaIdentifierInfoFetcher());
+        // Push notification permission is per-origin and per-embedder.
+        queue.add(new PushNotificationInfoFetcher());
+        // Voice and Video capture permission is per-origin and per-embedder.
+        queue.add(new VoiceAndVideoCaptureInfoFetcher());
+        queue.add(new PermissionsAvailableCallbackRunner());
+        queue.next();
+    }
+
+    /**
+     * Fetches preferences for all sites that have them that apply to the given
+     * filter.
+     *
+     * @param filter A filter to apply to sites to fetch. See
+     *               WebsiteSettingsCategoryFilter for a list of valid filters.
+     */
+    public void fetchPreferencesWithFilter(String filter) {
+        WebsiteSettingsCategoryFilter filterHelper = new WebsiteSettingsCategoryFilter();
+        if (filterHelper.showAllSites(filter)) {
+            fetchAllPreferences();
+            return;
+        }
+
+        TaskQueue queue = new TaskQueue();
+        // Populate features from more specific to less specific.
+        if (filterHelper.showGeolocationSites(filter)) {
+            // Geolocation lookup permission is per-origin and per-embedder.
+            queue.add(new GeolocationInfoFetcher());
+        } else if (filterHelper.showCookiesSites(filter)) {
+            // Cookies are stored per-origin.
+            queue.add(new CookieInfoFetcher());
+        } else if (filterHelper.showStorageSites(filter)) {
+            // Local storage info is per-origin.
+            queue.add(new LocalStorageInfoFetcher());
+        } else if (filterHelper.showCameraMicSites(filter)) {
+            // Voice and Video capture permission is per-origin and per-embedder.
+            queue.add(new VoiceAndVideoCaptureInfoFetcher());
+        } else if (filterHelper.showPopupSites(filter)) {
+            // Popup exceptions are host-based patterns (unless we start
+            // synchronizing popup exceptions with desktop Chrome.)
+            queue.add(new PopupExceptionInfoFetcher());
+        } else if (filterHelper.showPushNotificationsSites(filter)) {
+            // Push notification permission is per-origin and per-embedder.
+            queue.add(new PushNotificationInfoFetcher());
+        }
+        queue.add(new PermissionsAvailableCallbackRunner());
+        queue.next();
+    }
+
+    private Website createSiteByOriginAndHost(WebsiteAddress address) {
+        String origin = address.getOrigin();
+        String host = address.getHost();
+        Website site = new Website(address);
+        if (!mSitesByOrigin.containsKey(origin)) mSitesByOrigin.put(origin, new HashSet<Website>());
+        mSitesByOrigin.get(origin).add(site);
+        if (!mSitesByHost.containsKey(host)) mSitesByHost.put(host, new HashSet<Website>());
+        mSitesByHost.get(host).add(site);
+        return site;
+    }
+
+    private Set<Website> findOrCreateSitesByOrigin(WebsiteAddress address) {
+        String origin = address.getOrigin();
+        if (!mSitesByOrigin.containsKey(origin)) createSiteByOriginAndHost(address);
+        return mSitesByOrigin.get(origin);
+    }
+
+    private Set<Website> findOrCreateSitesByHost(WebsiteAddress address) {
+        String host = address.getHost();
+        if (!mSitesByHost.containsKey(host)) {
+            mSitesByHost.put(host, new HashSet<Website>());
+            mSitesByHost.get(host).add(new Website(address));
+        }
+        return mSitesByHost.get(host);
+    }
+
+    /**
+     * A single task in the WebsitePermissionsFetcher task queue. We need
+     * fetching of features to be serialized, as we need to have all the origins
+     * in place prior to populating the hosts.
+     */
+    private interface Task {
+        void run(TaskQueue queue);
+    }
+
+    /**
+     * A queue used to store the sequence of tasks to run to fetch the website
+     * preferences. Each task is run sequentially (although the queue as a whole
+     * is run asynchronously). Each task should call queue.next() at the end to
+     * run the next task in the queue.
+     */
+    private static class TaskQueue extends LinkedList<Task> {
+        void next() {
+            if (!isEmpty()) removeFirst().run(this);
+        }
+    }
+
+    private class GeolocationInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (GeolocationInfo info : WebsitePreferenceBridge.getGeolocationInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setGeolocationInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class MidiInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (MidiInfo info : WebsitePreferenceBridge.getMidiInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setMidiInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class PopupExceptionInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (PopupExceptionInfo info : WebsitePreferenceBridge.getPopupExceptionInfo()) {
+                // The pattern "*" represents the default setting, not a
+                // specific website.
+                if (info.getPattern().equals("*")) continue;
+                WebsiteAddress address = WebsiteAddress.create(info.getPattern());
+                if (address == null) continue;
+                Set<Website> sites = findOrCreateSitesByHost(address);
+                for (Website site : sites) {
+                    site.setPopupExceptionInfo(info);
+                }
+            }
+            queue.next();
+        }
+    }
+
+    private class CookieInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (CookieInfo info : WebsitePreferenceBridge.getCookieInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setCookieInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class LocalStorageInfoFetcher implements Task {
+        @Override
+        public void run(final TaskQueue queue) {
+            WebsitePreferenceBridge.fetchLocalStorageInfo(
+                    new WebsitePreferenceBridge.LocalStorageInfoReadyCallback() {
+                        @SuppressWarnings("unchecked")
+                        @Override
+                        public void onLocalStorageInfoReady(HashMap map) {
+                            for (Object o : map.entrySet()) {
+                                Map.Entry<String, LocalStorageInfo> entry =
+                                        (Map.Entry<String, LocalStorageInfo>) o;
+                                WebsiteAddress address = WebsiteAddress.create(entry.getKey());
+                                if (address == null) continue;
+                                Set<Website> sites = findOrCreateSitesByOrigin(address);
+                                for (Website site : sites) {
+                                    site.setLocalStorageInfo(entry.getValue());
+                                }
+                            }
+                            queue.next();
+                        }
+                    });
+        }
+    }
+
+    private class WebStorageInfoFetcher implements Task {
+        @Override
+        public void run(final TaskQueue queue) {
+            WebsitePreferenceBridge.fetchStorageInfo(
+                    new WebsitePreferenceBridge.StorageInfoReadyCallback() {
+                        @SuppressWarnings("unchecked")
+                        @Override
+                        public void onStorageInfoReady(ArrayList array) {
+                            ArrayList<StorageInfo> infoArray = array;
+                            for (StorageInfo info : infoArray) {
+                                WebsiteAddress address = WebsiteAddress.create(info.getHost());
+                                if (address == null) continue;
+                                Set<Website> sites = findOrCreateSitesByHost(address);
+                                for (Website site : sites) {
+                                    site.addStorageInfo(info);
+                                }
+                            }
+                            queue.next();
+                        }
+                    });
+        }
+    }
+
+    private class ProtectedMediaIdentifierInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (ProtectedMediaIdentifierInfo info :
+                    WebsitePreferenceBridge.getProtectedMediaIdentifierInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setProtectedMediaIdentifierInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class PushNotificationInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (PushNotificationInfo info : WebsitePreferenceBridge.getPushNotificationInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setPushNotificationInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class VoiceAndVideoCaptureInfoFetcher implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            for (VoiceAndVideoCaptureInfo info :
+                    WebsitePreferenceBridge.getVoiceAndVideoCaptureInfo()) {
+                WebsiteAddress address = WebsiteAddress.create(info.getOrigin());
+                if (address == null) continue;
+                createSiteByOriginAndHost(address).setVoiceAndVideoCaptureInfo(info);
+            }
+            queue.next();
+        }
+    }
+
+    private class PermissionsAvailableCallbackRunner implements Task {
+        @Override
+        public void run(TaskQueue queue) {
+            mCallback.onWebsitePermissionsAvailable(mSitesByOrigin, mSitesByHost);
+            queue.next();
+        }
+    }
+}