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
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
|
// Copyright 2016 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.
cr.exportPath('settings');
/**
* A data structure used by callers to combine the results of multiple search
* requests.
*
* @typedef {{
* canceled: Boolean,
* didFindMatches: Boolean,
* wasClearSearch: Boolean,
* }}
*/
settings.SearchResult;
cr.define('settings', function() {
/** @const {string} */
var WRAPPER_CSS_CLASS = 'search-highlight-wrapper';
/** @const {string} */
var ORIGINAL_CONTENT_CSS_CLASS = 'search-highlight-original-content';
/** @const {string} */
var HIT_CSS_CLASS = 'search-highlight-hit';
/** @const {string} */
var SEARCH_BUBBLE_CSS_CLASS = 'search-bubble';
/**
* A CSS attribute indicating that a node should be ignored during searching.
* @const {string}
*/
var SKIP_SEARCH_CSS_ATTRIBUTE = 'no-search';
/**
* List of elements types that should not be searched at all.
* The only DOM-MODULE node is in <body> which is not searched, therefore
* DOM-MODULE is not needed in this set.
* @const {!Set<string>}
*/
var IGNORED_ELEMENTS = new Set([
'CONTENT',
'CR-EVENTS',
'DIALOG',
'IMG',
'IRON-ICON',
'IRON-LIST',
'PAPER-ICON-BUTTON',
'PAPER-RIPPLE',
'PAPER-SLIDER',
'PAPER-SPINNER',
'STYLE',
'TEMPLATE',
]);
/**
* Finds all previous highlighted nodes under |node| (both within self and
* children's Shadow DOM) and replaces the highlights (yellow rectangle and
* search bubbles) with the original text node.
* TODO(dpapad): Consider making this a private method of TopLevelSearchTask.
* @param {!Node} node
* @private
*/
function findAndRemoveHighlights_(node) {
var wrappers = node.querySelectorAll('* /deep/ .' + WRAPPER_CSS_CLASS);
for (var i = 0; i < wrappers.length; i++) {
var wrapper = wrappers[i];
var originalNode =
wrapper.querySelector('.' + ORIGINAL_CONTENT_CSS_CLASS);
wrapper.parentElement.replaceChild(originalNode.firstChild, wrapper);
}
var searchBubbles =
node.querySelectorAll('* /deep/ .' + SEARCH_BUBBLE_CSS_CLASS);
for (var j = 0; j < searchBubbles.length; j++)
searchBubbles[j].remove();
}
/**
* Applies the highlight UI (yellow rectangle) around all matches in |node|.
* @param {!Node} node The text node to be highlighted. |node| ends up
* being removed from the DOM tree.
* @param {!Array<string>} tokens The string tokens after splitting on the
* relevant regExp. Even indices hold text that doesn't need highlighting,
* odd indices hold the text to be highlighted. For example:
* var r = new RegExp('(foo)', 'i');
* 'barfoobar foo bar'.split(r) => ['bar', 'foo', 'bar ', 'foo', ' bar']
* @private
*/
function highlight_(node, tokens) {
var wrapper = document.createElement('span');
wrapper.classList.add(WRAPPER_CSS_CLASS);
// Use existing node as placeholder to determine where to insert the
// replacement content.
node.parentNode.replaceChild(wrapper, node);
// Keep the existing node around for when the highlights are removed. The
// existing text node might be involved in data-binding and therefore should
// not be discarded.
var span = document.createElement('span');
span.classList.add(ORIGINAL_CONTENT_CSS_CLASS);
span.style.display = 'none';
span.appendChild(node);
wrapper.appendChild(span);
for (var i = 0; i < tokens.length; ++i) {
if (i % 2 == 0) {
wrapper.appendChild(document.createTextNode(tokens[i]));
} else {
var span = document.createElement('span');
span.classList.add(HIT_CSS_CLASS);
span.style.backgroundColor = '#ffeb3b'; // --var(--paper-yellow-500)
span.textContent = tokens[i];
wrapper.appendChild(span);
}
}
}
/**
* Traverses the entire DOM (including Shadow DOM), finds text nodes that
* match the given regular expression and applies the highlight UI. It also
* ensures that <settings-section> instances become visible if any matches
* occurred under their subtree.
*
* @param {!settings.SearchRequest} request
* @param {!Node} root The root of the sub-tree to be searched
* @private
*/
function findAndHighlightMatches_(request, root) {
var foundMatches = false;
function doSearch(node) {
if (node.nodeName == 'TEMPLATE' && node.hasAttribute('route-path') &&
!node.if && !node.hasAttribute(SKIP_SEARCH_CSS_ATTRIBUTE)) {
request.queue_.addRenderTask(new RenderTask(request, node));
return;
}
if (IGNORED_ELEMENTS.has(node.nodeName))
return;
if (node instanceof HTMLElement) {
var element = /** @type {HTMLElement} */ (node);
if (element.hasAttribute(SKIP_SEARCH_CSS_ATTRIBUTE) ||
element.hasAttribute('hidden') || element.style.display == 'none') {
return;
}
}
if (node.nodeType == Node.TEXT_NODE) {
var textContent = node.nodeValue.trim();
if (textContent.length == 0)
return;
if (request.regExp.test(textContent)) {
foundMatches = true;
revealParentSection_(node, request.rawQuery_);
// Don't highlight <select> nodes, yellow rectangles can't be
// displayed within an <option>.
// TODO(dpapad): highlight <select> controls with a search bubble
// instead.
if (node.parentNode.nodeName != 'OPTION')
highlight_(node, textContent.split(request.regExp));
}
// Returning early since TEXT_NODE nodes never have children.
return;
}
var child = node.firstChild;
while (child !== null) {
// Getting a reference to the |nextSibling| before calling doSearch()
// because |child| could be removed from the DOM within doSearch().
var nextSibling = child.nextSibling;
doSearch(child);
child = nextSibling;
}
var shadowRoot = node.shadowRoot;
if (shadowRoot)
doSearch(shadowRoot);
}
doSearch(root);
return foundMatches;
}
/**
* Highlights the HTML control that triggers a subpage, by displaying a search
* bubble.
* @param {!HTMLElement} element The element to be highlighted.
* @param {string} rawQuery The search query.
* @private
*/
function highlightAssociatedControl_(element, rawQuery) {
var searchBubble = element.querySelector('.' + SEARCH_BUBBLE_CSS_CLASS);
// If the associated control has already been highlighted due to another
// match on the same subpage, there is no need to do anything.
if (searchBubble)
return;
searchBubble = document.createElement('div');
searchBubble.classList.add(SEARCH_BUBBLE_CSS_CLASS);
var innards = document.createElement('div');
innards.classList.add('search-bubble-innards', 'text-elide');
innards.textContent = rawQuery;
searchBubble.appendChild(innards);
element.appendChild(searchBubble);
// Dynamically position the bubble at the edge the associated control
// element.
var updatePosition = function() {
if (innards.classList.contains('above')) {
searchBubble.style.top =
element.offsetTop - searchBubble.offsetHeight + 'px';
} else {
searchBubble.style.top =
element.offsetTop + element.offsetHeight + 'px';
}
};
updatePosition();
searchBubble.addEventListener('mouseover', function() {
innards.classList.toggle('above');
updatePosition();
});
}
/**
* Finds and makes visible the <settings-section> parent of |node|.
* @param {!Node} node
* @param {string} rawQuery
* @private
*/
function revealParentSection_(node, rawQuery) {
var associatedControl = null;
// Find corresponding SETTINGS-SECTION parent and make it visible.
var parent = node;
while (parent && parent.nodeName !== 'SETTINGS-SECTION') {
parent = parent.nodeType == Node.DOCUMENT_FRAGMENT_NODE ?
parent.host :
parent.parentNode;
if (parent.nodeName == 'SETTINGS-SUBPAGE') {
// TODO(dpapad): Cast to SettingsSubpageElement here.
associatedControl = assert(
parent.associatedControl,
'An associated control was expected for SETTINGS-SUBPAGE ' +
parent.pageTitle + ', but was not found.');
}
}
if (parent)
parent.hiddenBySearch = false;
// Need to add the search bubble after the parent SETTINGS-SECTION has
// become visible, otherwise |offsetWidth| returns zero.
if (associatedControl)
highlightAssociatedControl_(associatedControl, rawQuery);
}
/** @abstract */
class Task {
/**
* @param {!settings.SearchRequest} request
* @param {!Node} node
*/
constructor(request, node) {
/** @protected {!settings.SearchRequest} */
this.request = request;
/** @protected {!Node} */
this.node = node;
}
/**
* @abstract
* @return {!Promise}
*/
exec() {}
}
class RenderTask extends Task {
/**
* A task that takes a <template is="dom-if">...</template> node
* corresponding to a setting subpage and renders it. A
* SearchAndHighlightTask is posted for the newly rendered subtree, once
* rendering is done.
*
* @param {!settings.SearchRequest} request
* @param {!Node} node
*/
constructor(request, node) {
super(request, node);
}
/** @override */
exec() {
var routePath = this.node.getAttribute('route-path');
var subpageTemplate =
this.node['_content'].querySelector('settings-subpage');
subpageTemplate.setAttribute('route-path', routePath);
assert(!this.node.if);
this.node.if = true;
return new Promise((resolve, reject) => {
var parent = this.node.parentNode;
parent.async(() => {
var renderedNode =
parent.querySelector('[route-path="' + routePath + '"]');
// Register a SearchAndHighlightTask for the part of the DOM that was
// just rendered.
this.request.queue_.addSearchAndHighlightTask(
new SearchAndHighlightTask(this.request, assert(renderedNode)));
resolve();
});
});
}
}
class SearchAndHighlightTask extends Task {
/**
* @param {!settings.SearchRequest} request
* @param {!Node} node
*/
constructor(request, node) {
super(request, node);
}
/** @override */
exec() {
var foundMatches = findAndHighlightMatches_(this.request, this.node);
this.request.updateMatches(foundMatches);
return Promise.resolve();
}
}
class TopLevelSearchTask extends Task {
/**
* @param {!settings.SearchRequest} request
* @param {!Node} page
*/
constructor(request, page) {
super(request, page);
}
/** @override */
exec() {
findAndRemoveHighlights_(this.node);
var shouldSearch = this.request.regExp !== null;
this.setSectionsVisibility_(!shouldSearch);
if (shouldSearch) {
var foundMatches = findAndHighlightMatches_(this.request, this.node);
this.request.updateMatches(foundMatches);
}
return Promise.resolve();
}
/**
* @param {boolean} visible
* @private
*/
setSectionsVisibility_(visible) {
var sections = this.node.querySelectorAll('settings-section');
for (var i = 0; i < sections.length; i++)
sections[i].hiddenBySearch = !visible;
}
}
class TaskQueue {
/** @param {!settings.SearchRequest} request */
constructor(request) {
/** @private {!settings.SearchRequest} */
this.request_ = request;
/**
* @private {{
* high: !Array<!Task>,
* middle: !Array<!Task>,
* low: !Array<!Task>
* }}
*/
this.queues_;
this.reset();
/** @private {?Function} */
this.onEmptyCallback_ = null;
/**
* Whether a task is currently running.
* @private {boolean}
*/
this.running_ = false;
}
/** Drops all tasks. */
reset() {
this.queues_ = {high: [], middle: [], low: []};
}
/** @param {!TopLevelSearchTask} task */
addTopLevelSearchTask(task) {
this.queues_.high.push(task);
this.consumePending_();
}
/** @param {!SearchAndHighlightTask} task */
addSearchAndHighlightTask(task) {
this.queues_.middle.push(task);
this.consumePending_();
}
/** @param {!RenderTask} task */
addRenderTask(task) {
this.queues_.low.push(task);
this.consumePending_();
}
/**
* Registers a callback to be called every time the queue becomes empty.
* @param {function():void} onEmptyCallback
*/
onEmpty(onEmptyCallback) {
this.onEmptyCallback_ = onEmptyCallback;
}
/**
* @return {!Task|undefined}
* @private
*/
popNextTask_() {
return this.queues_.high.shift() || this.queues_.middle.shift() ||
this.queues_.low.shift();
}
/** @private */
consumePending_() {
if (this.running_)
return;
while (1) {
var task = this.popNextTask_();
if (!task) {
this.running_ = false;
if (this.onEmptyCallback_)
this.onEmptyCallback_();
return;
}
this.running_ = true;
window.requestIdleCallback(() => {
if (!this.request_.canceled) {
task.exec().then(() => {
this.running_ = false;
this.consumePending_();
});
}
// Nothing to do otherwise. Since the request corresponding to this
// queue was canceled, the queue is disposed along with the request.
});
return;
}
}
}
class SearchRequest {
/**
* @param {string} rawQuery
* @param {!HTMLElement} root
*/
constructor(rawQuery, root) {
/** @private {string} */
this.rawQuery_ = rawQuery;
/** @private {!HTMLElement} */
this.root_ = root;
/** @type {?RegExp} */
this.regExp = this.generateRegExp_();
/**
* Whether this request was canceled before completing.
* @type {boolean}
*/
this.canceled = false;
/** @private {boolean} */
this.foundMatches_ = false;
/** @type {!PromiseResolver} */
this.resolver = new PromiseResolver();
/** @private {!TaskQueue} */
this.queue_ = new TaskQueue(this);
this.queue_.onEmpty(() => {
this.resolver.resolve(this);
});
}
/**
* Fires this search request.
*/
start() {
this.queue_.addTopLevelSearchTask(
new TopLevelSearchTask(this, this.root_));
}
/**
* @return {?RegExp}
* @private
*/
generateRegExp_() {
var regExp = null;
// Generate search text by escaping any characters that would be
// problematic for regular expressions.
var searchText = this.rawQuery_.trim().replace(SANITIZE_REGEX, '\\$&');
if (searchText.length > 0)
regExp = new RegExp('(' + searchText + ')', 'i');
return regExp;
}
/**
* @param {string} rawQuery
* @return {boolean} Whether this SearchRequest refers to an identical
* query.
*/
isSame(rawQuery) {
return this.rawQuery_ == rawQuery;
}
/**
* Updates the result for this search request.
* @param {boolean} found
*/
updateMatches(found) {
this.foundMatches_ = this.foundMatches_ || found;
}
/** @return {boolean} Whether any matches were found. */
didFindMatches() {
return this.foundMatches_;
}
}
/** @const {!RegExp} */
var SANITIZE_REGEX = /[-[\]{}()*+?.,\\^$|#\s]/g;
/** @interface */
class SearchManager {
/**
* @param {string} text The text to search for.
* @param {!Node} page
* @return {!Promise<!settings.SearchRequest>} A signal indicating that
* searching finished.
*/
search(text, page) {}
}
/** @implements {SearchManager} */
class SearchManagerImpl {
constructor() {
/** @private {!Set<!settings.SearchRequest>} */
this.activeRequests_ = new Set();
/** @private {?string} */
this.lastSearchedText_ = null;
}
/** @override */
search(text, page) {
// Cancel any pending requests if a request with different text is
// submitted.
if (text != this.lastSearchedText_) {
this.activeRequests_.forEach(function(request) {
request.canceled = true;
request.resolver.resolve(request);
});
this.activeRequests_.clear();
}
this.lastSearchedText_ = text;
var request = new SearchRequest(text, page);
this.activeRequests_.add(request);
request.start();
return request.resolver.promise.then(() => {
// Stop tracking requests that finished.
this.activeRequests_.delete(request);
return request;
});
}
}
cr.addSingletonGetter(SearchManagerImpl);
/** @return {!SearchManager} */
function getSearchManager() {
return SearchManagerImpl.getInstance();
}
/**
* Sets the SearchManager singleton instance, useful for testing.
* @param {!SearchManager} searchManager
*/
function setSearchManagerForTesting(searchManager) {
SearchManagerImpl.instance_ = searchManager;
}
return {
getSearchManager: getSearchManager,
setSearchManagerForTesting: setSearchManagerForTesting,
SearchRequest: SearchRequest,
};
});
|
