-
Notifications
You must be signed in to change notification settings - Fork 215
/
SearchEngineWrapper.java
210 lines (174 loc) · 8.29 KB
/
SearchEngineWrapper.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
package org.mozilla.vrbrowser.search;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.SharedPreferences;
import android.net.Uri;
import android.preference.PreferenceManager;
import android.util.Log;
import androidx.annotation.NonNull;
import org.mozilla.vrbrowser.R;
import org.mozilla.vrbrowser.VRBrowserApplication;
import org.mozilla.vrbrowser.browser.SettingsStore;
import org.mozilla.vrbrowser.browser.engine.EngineProvider;
import org.mozilla.vrbrowser.geolocation.GeolocationData;
import org.mozilla.vrbrowser.search.suggestions.SuggestionsClient;
import org.mozilla.vrbrowser.utils.SystemUtils;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Executor;
import kotlinx.coroutines.Dispatchers;
import mozilla.components.browser.search.SearchEngine;
import mozilla.components.browser.search.SearchEngineManager;
import mozilla.components.browser.search.provider.AssetsSearchEngineProvider;
import mozilla.components.browser.search.provider.filter.SearchEngineFilter;
import mozilla.components.browser.search.provider.localization.LocaleSearchLocalizationProvider;
import mozilla.components.browser.search.provider.localization.SearchLocalizationProvider;
import mozilla.components.browser.search.suggestions.SearchSuggestionClient;
public class SearchEngineWrapper implements SharedPreferences.OnSharedPreferenceChangeListener {
private static final String LOGTAG = SystemUtils.createLogtag(SearchEngineWrapper.class);
// Specific FxR engine overrides. US is already overridden by browser-search component
// https://github.com/MozillaReality/FirefoxReality/issues/248#issuecomment-412278211
private static final Map<String , String> REGION_ENGINE_OVERRIDE = new HashMap<String, String>() {{
put("CN", "baidu");
put("RU", "yandex-ru");
put("BY", "yandex.by");
put("TR", "yandex-tr");
put("KZ", "yandex-kz");
}};
private static String EMPTY = "";
private static SearchEngineWrapper mSearchEngineWrapperInstance;
public static synchronized @NonNull
SearchEngineWrapper get(final @NonNull Context aContext) {
if (mSearchEngineWrapperInstance == null) {
mSearchEngineWrapperInstance = new SearchEngineWrapper(aContext);
}
return mSearchEngineWrapperInstance;
}
public interface SuggestionsDelegate {
void OnSuggestions(List<String> aSuggestionsList);
}
private Context mContext;
private SearchEngine mSearchEngine;
private SearchLocalizationProvider mLocalizationProvider;
private SearchEngineManager mSearchEngineManager;
private SearchSuggestionClient mSuggestionsClient;
private SharedPreferences mPrefs;
private Executor mUIThreadExecutor;
private SearchEngineWrapper(@NonNull Context aContext) {
mContext = aContext;
mPrefs = PreferenceManager.getDefaultSharedPreferences(mContext);
mUIThreadExecutor = ((VRBrowserApplication)aContext.getApplicationContext()).getExecutors().mainThread();
setupSearchEngine(aContext, EMPTY);
}
public void registerForUpdates() {
if (mContext != null) {
mContext.registerReceiver(
mLocaleChangedReceiver,
new IntentFilter(Intent.ACTION_LOCALE_CHANGED));
if (mPrefs != null) {
mPrefs.registerOnSharedPreferenceChangeListener(this);
}
}
}
public void unregisterForUpdates() {
if (mContext != null) {
try {
mContext.unregisterReceiver(mLocaleChangedReceiver);
} catch(IllegalArgumentException ignored) {}
if (mPrefs != null) {
mPrefs.unregisterOnSharedPreferenceChangeListener(this);
}
}
}
public String getSearchURL(String aQuery) {
return mSearchEngine.buildSearchUrl(aQuery);
}
private String getSuggestionURL(String aQuery) {
return mSearchEngine.buildSuggestionsURL(aQuery);
}
public CompletableFuture<List<String>> getSuggestions(String aQuery) {
CompletableFuture<List<String>> future = new CompletableFuture<>();
// TODO: Use mSuggestionsClient.getSuggestions when fixed in browser-search.
String query = getSuggestionURL(aQuery);
mUIThreadExecutor.execute(() ->
SuggestionsClient.getSuggestions(
EngineProvider.INSTANCE.getDefaultGeckoWebExecutor(mContext),
mSearchEngine,
query).thenAcceptAsync(future::complete));
return future;
}
public String getResourceURL() {
Uri uri = Uri.parse(mSearchEngine.buildSearchUrl("")) ;
return uri.getScheme() + "://" + uri.getHost();
}
public String getIdentifier() {
return mSearchEngine.getIdentifier();
}
// Receiver for locale updates
private BroadcastReceiver mLocaleChangedReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
if (intent.getAction().equals(Intent.ACTION_LOCALE_CHANGED)) {
setupSearchEngine(context, EMPTY);
}
}
};
/**
* We cannot send system ACTION_LOCALE_CHANGED so the component refreshes the engines
* with the updated SearchLocalizationProvider information so we have to update the whole manager.
* @param aContext Activity context
* @param userPref User preferred engine (among the available ones)
*/
private void setupSearchEngine(@NonNull Context aContext, String userPref) {
List<SearchEngineFilter> engineFilterList = new ArrayList<>();
GeolocationData data = GeolocationData.parse(SettingsStore.getInstance(aContext).getGeolocationData());
if (data == null) {
Log.d(LOGTAG, "Using Locale based search localization provider");
// If we don't have geolocation data we default to the Locale search localization provider
mLocalizationProvider = new LocaleSearchLocalizationProvider();
} else {
Log.d(LOGTAG, "Using Geolocation based search localization provider: " + data.toString());
// If we have geolocation data we initialize the provider with the received data
// and setup a filter to filter the engines that we need to override for FxR.
mLocalizationProvider = new GeolocationLocalizationProvider(data);
if (getEngine(data.getCountryCode()) != null) {
SearchEngineFilter engineFilter = (ctx, searchEngine) ->
searchEngine.getIdentifier().equalsIgnoreCase(getEngine(data.getCountryCode()));
engineFilterList.add(engineFilter);
}
}
// Configure the assets search with the localization provider and the engines that we want
// to filter.
AssetsSearchEngineProvider engineProvider = new AssetsSearchEngineProvider(
mLocalizationProvider,
engineFilterList,
Collections.emptyList());
mSearchEngineManager = new SearchEngineManager(Arrays.asList(engineProvider), Dispatchers.getDefault());
// If we don't get any result we use the default configuration.
if (mSearchEngineManager.getSearchEngines(aContext).size() == 0) {
mSearchEngineManager = new SearchEngineManager();
}
// A name can be used if the user get's to choose among the available engines
mSearchEngine = mSearchEngineManager.getDefaultSearchEngine(aContext, userPref);
mSuggestionsClient = new SearchSuggestionClient(mSearchEngine, (s, continuation) -> null);
}
private String getEngine(String aCountryCode) {
return REGION_ENGINE_OVERRIDE.get(aCountryCode);
}
// SharedPreferences.OnSharedPreferenceChangeListener
@Override
public void onSharedPreferenceChanged(SharedPreferences sharedPreferences, String key) {
if (mContext != null) {
if (key.equals(mContext.getString(R.string.settings_key_geolocation_data))) {
setupSearchEngine(mContext, EMPTY);
}
}
}
}