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
|
/* 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/. */
/*
* Provides functions to handle remote tabs (ie, tabs known by Sync) in
* the awesomebar.
*/
"use strict";
var EXPORTED_SYMBOLS = ["PlacesRemoteTabsAutocompleteProvider"];
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
ChromeUtils.defineModuleGetter(
this,
"SyncedTabs",
"resource://services-sync/SyncedTabs.jsm"
);
XPCOMUtils.defineLazyGetter(this, "weaveXPCService", function() {
try {
return Cc["@mozilla.org/weave/service;1"].getService(
Ci.nsISupports
).wrappedJSObject;
} catch (ex) {
// The app didn't build Sync.
}
return null;
});
// from MDN...
function escapeRegExp(string) {
return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
}
// Build the in-memory structure we use.
async function buildItems() {
// This is sorted by most recent client, most recent tab.
let tabsData = [];
// If Sync isn't initialized (either due to lag at startup or due to no user
// being signed in), don't reach in to Weave.Service as that may initialize
// Sync unnecessarily - we'll get an observer notification later when it
// becomes ready and has synced a list of tabs.
if (weaveXPCService.ready) {
let clients = await SyncedTabs.getTabClients();
SyncedTabs.sortTabClientsByLastUsed(clients);
for (let client of clients) {
for (let tab of client.tabs) {
tabsData.push({ tab, client });
}
}
}
return tabsData;
}
// Manage the cache of the items we use.
// The cache itself.
let _items = null;
// Ensure the cache is good.
async function ensureItems() {
if (!_items) {
_items = await buildItems();
}
return _items;
}
// A preference used to disable the showing of icons in remote tab records.
const PREF_SHOW_REMOTE_ICONS = "services.sync.syncedTabs.showRemoteIcons";
let showRemoteIcons;
// A preference used to disable the synced tabs from showing in awesomebar
// matches.
const PREF_SHOW_REMOTE_TABS = "services.sync.syncedTabs.showRemoteTabs";
let showRemoteTabs;
// An observer to invalidate _items and watch for changed prefs.
function observe(subject, topic, data) {
switch (topic) {
case "weave:engine:sync:finish":
if (data == "tabs") {
// The tabs engine just finished syncing, so may have a different list
// of tabs then we previously cached.
_items = null;
}
break;
case "weave:service:start-over":
// Sync is being reset due to the user disconnecting - we must invalidate
// the cache so we don't supply tabs from a different user.
_items = null;
break;
case "nsPref:changed":
if (data == PREF_SHOW_REMOTE_ICONS) {
showRemoteIcons = Services.prefs.getBoolPref(
PREF_SHOW_REMOTE_ICONS,
true
);
} else if (data == PREF_SHOW_REMOTE_TABS) {
showRemoteTabs = Services.prefs.getBoolPref(
PREF_SHOW_REMOTE_TABS,
true
);
}
break;
default:
break;
}
}
Services.obs.addObserver(observe, "weave:engine:sync:finish");
Services.obs.addObserver(observe, "weave:service:start-over");
// Observe the prefs for showing remote icons and tabs and prime
// our bools that reflect their values.
Services.prefs.addObserver(PREF_SHOW_REMOTE_ICONS, observe);
Services.prefs.addObserver(PREF_SHOW_REMOTE_TABS, observe);
observe(null, "nsPref:changed", PREF_SHOW_REMOTE_ICONS);
observe(null, "nsPref:changed", PREF_SHOW_REMOTE_TABS);
// This public object is a static singleton.
var PlacesRemoteTabsAutocompleteProvider = {
/**
* Fetches Remote Tab results and returns them as matches.
* @param {string} searchString
* The search string entered by the user. If left blank, the first
* `maxMatches` results will be returned.
* @param {number} maxMatches
* The maximum number of remote tabs we want returned.
* @returns {array} matches
*/
async getMatches(searchString, maxMatches) {
// If Sync isn't configured we bail early.
if (
!weaveXPCService ||
!weaveXPCService.ready ||
!weaveXPCService.enabled
) {
return [];
}
if (!showRemoteTabs || !maxMatches) {
return [];
}
let re = new RegExp(escapeRegExp(searchString), "i");
let matches = [];
let tabsData = await ensureItems();
for (let { tab, client } of tabsData) {
if (
!searchString ||
re.test(tab.url) ||
(tab.title && re.test(tab.title))
) {
matches.push({
url: tab.url,
title: tab.title,
icon: showRemoteIcons ? tab.icon : null,
deviceName: client.name,
lastUsed: tab.lastUsed * 1000,
});
if (matches.length == maxMatches) {
break;
}
}
}
return matches;
},
};
|
