9398230fb079ef2dab9a7cc09112123a3b8442fa
[WebKit-https.git] / Source / WebCore / page / mac / ServicesOverlayController.mm
1 /*
2  * Copyright (C) 2014 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #import "config.h"
27 #import "ServicesOverlayController.h"
28
29 #if (ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)) && PLATFORM(MAC)
30
31 #import "Chrome.h"
32 #import "ChromeClient.h"
33 #import "DataDetectorsSPI.h"
34 #import "Document.h"
35 #import "Editor.h"
36 #import "EventHandler.h"
37 #import "FloatQuad.h"
38 #import "FocusController.h"
39 #import "FrameSelection.h"
40 #import "FrameView.h"
41 #import "GapRects.h"
42 #import "GraphicsContext.h"
43 #import "GraphicsLayer.h"
44 #import "GraphicsLayerCA.h"
45 #import "Logging.h"
46 #import "MainFrame.h"
47 #import "Page.h"
48 #import "PageOverlayController.h"
49 #import "PlatformCAAnimationMac.h"
50 #import "Settings.h"
51 #import "SoftLinking.h"
52 #import <QuartzCore/QuartzCore.h>
53
54 const float highlightFadeAnimationDuration = 0.3;
55
56 namespace WebCore {
57
58 Ref<ServicesOverlayController::Highlight> ServicesOverlayController::Highlight::createForSelection(ServicesOverlayController& controller, RetainPtr<DDHighlightRef> ddHighlight, PassRefPtr<Range> range)
59 {
60     return adoptRef(*new Highlight(controller, Type::Selection, ddHighlight, range));
61 }
62
63 Ref<ServicesOverlayController::Highlight> ServicesOverlayController::Highlight::createForTelephoneNumber(ServicesOverlayController& controller, RetainPtr<DDHighlightRef> ddHighlight, PassRefPtr<Range> range)
64 {
65     return adoptRef(*new Highlight(controller, Type::TelephoneNumber, ddHighlight, range));
66 }
67
68 ServicesOverlayController::Highlight::Highlight(ServicesOverlayController& controller, Type type, RetainPtr<DDHighlightRef> ddHighlight, PassRefPtr<WebCore::Range> range)
69     : m_range(range)
70     , m_type(type)
71     , m_controller(&controller)
72 {
73     ASSERT(ddHighlight);
74     ASSERT(m_range);
75
76     Page* page = controller.mainFrame().page();
77     m_graphicsLayer = GraphicsLayer::create(page ? page->chrome().client().graphicsLayerFactory() : nullptr, *this);
78     m_graphicsLayer->setDrawsContent(true);
79
80     setDDHighlight(ddHighlight.get());
81
82     // Set directly on the PlatformCALayer so that when we leave the 'from' value implicit
83     // in our animations, we get the right initial value regardless of flush timing.
84     downcast<GraphicsLayerCA>(*layer()).platformCALayer()->setOpacity(0);
85
86     controller.didCreateHighlight(this);
87 }
88
89 ServicesOverlayController::Highlight::~Highlight()
90 {
91     if (m_controller)
92         m_controller->willDestroyHighlight(this);
93 }
94
95 void ServicesOverlayController::Highlight::setDDHighlight(DDHighlightRef highlight)
96 {
97     if (!m_controller)
98         return;
99
100     m_ddHighlight = highlight;
101
102     if (!m_ddHighlight)
103         return;
104
105     CGRect highlightBoundingRect = DDHighlightGetBoundingRect(m_ddHighlight.get());
106     m_graphicsLayer->setPosition(FloatPoint(highlightBoundingRect.origin));
107     m_graphicsLayer->setSize(FloatSize(highlightBoundingRect.size));
108
109     m_graphicsLayer->setNeedsDisplay();
110 }
111
112 void ServicesOverlayController::Highlight::invalidate()
113 {
114     layer()->removeFromParent();
115     m_controller = nullptr;
116 }
117
118 void ServicesOverlayController::Highlight::notifyFlushRequired(const GraphicsLayer*)
119 {
120     if (!m_controller)
121         return;
122
123     Page* page = m_controller->mainFrame().page();
124     if (!page)
125         return;
126
127     page->chrome().client().scheduleCompositingLayerFlush();
128 }
129
130 void ServicesOverlayController::Highlight::paintContents(const GraphicsLayer*, GraphicsContext& graphicsContext, GraphicsLayerPaintingPhase, const FloatRect&)
131 {
132     CGContextRef cgContext = graphicsContext.platformContext();
133
134     CGLayerRef highlightLayer = DDHighlightGetLayerWithContext(ddHighlight(), cgContext);
135     CGRect highlightBoundingRect = DDHighlightGetBoundingRect(ddHighlight());
136     highlightBoundingRect.origin = CGPointZero;
137
138     CGContextDrawLayerInRect(cgContext, highlightBoundingRect, highlightLayer);
139 }
140
141 float ServicesOverlayController::Highlight::deviceScaleFactor() const
142 {
143     if (!m_controller)
144         return 1;
145
146     Page* page = m_controller->mainFrame().page();
147     if (!page)
148         return 1;
149
150     return page->deviceScaleFactor();
151 }
152
153 void ServicesOverlayController::Highlight::fadeIn()
154 {
155     RetainPtr<CABasicAnimation> animation = [CABasicAnimation animationWithKeyPath:@"opacity"];
156     [animation setDuration:highlightFadeAnimationDuration];
157     [animation setFillMode:kCAFillModeForwards];
158     [animation setRemovedOnCompletion:false];
159     [animation setToValue:@1];
160
161     RefPtr<PlatformCAAnimation> platformAnimation = PlatformCAAnimationMac::create(animation.get());
162     downcast<GraphicsLayerCA>(*layer()).platformCALayer()->addAnimationForKey("FadeHighlightIn", *platformAnimation);
163 }
164
165 void ServicesOverlayController::Highlight::fadeOut()
166 {
167     RetainPtr<CABasicAnimation> animation = [CABasicAnimation animationWithKeyPath:@"opacity"];
168     [animation setDuration:highlightFadeAnimationDuration];
169     [animation setFillMode:kCAFillModeForwards];
170     [animation setRemovedOnCompletion:false];
171     [animation setToValue:@0];
172
173     RefPtr<Highlight> retainedSelf = this;
174     [CATransaction begin];
175     [CATransaction setCompletionBlock:[retainedSelf] () {
176         retainedSelf->didFinishFadeOutAnimation();
177     }];
178
179     RefPtr<PlatformCAAnimation> platformAnimation = PlatformCAAnimationMac::create(animation.get());
180     downcast<GraphicsLayerCA>(*layer()).platformCALayer()->addAnimationForKey("FadeHighlightOut", *platformAnimation);
181     [CATransaction commit];
182 }
183
184 void ServicesOverlayController::Highlight::didFinishFadeOutAnimation()
185 {
186     if (!m_controller)
187         return;
188
189     if (m_controller->activeHighlight() == this)
190         return;
191
192     layer()->removeFromParent();
193 }
194
195 static IntRect textQuadsToBoundingRectForRange(Range& range)
196 {
197     Vector<FloatQuad> textQuads;
198     range.textQuads(textQuads);
199     FloatRect boundingRect;
200     for (auto& quad : textQuads)
201         boundingRect.unite(quad.boundingBox());
202     return enclosingIntRect(boundingRect);
203 }
204
205 ServicesOverlayController::ServicesOverlayController(MainFrame& mainFrame)
206     : m_mainFrame(mainFrame)
207     , m_servicesOverlay(nullptr)
208     , m_isTextOnly(false)
209     , m_determineActiveHighlightTimer(*this, &ServicesOverlayController::determineActiveHighlightTimerFired)
210 {
211 }
212
213 ServicesOverlayController::~ServicesOverlayController()
214 {
215     for (auto& highlight : m_highlights)
216         highlight->invalidate();
217 }
218
219 void ServicesOverlayController::pageOverlayDestroyed(PageOverlay&)
220 {
221     // Before the overlay is destroyed, it should have moved out of the Page,
222     // at which point we already cleared our back pointer.
223     ASSERT(!m_servicesOverlay);
224 }
225
226 void ServicesOverlayController::willMoveToPage(PageOverlay&, Page* page)
227 {
228     if (page)
229         return;
230
231     ASSERT(m_servicesOverlay);
232     m_servicesOverlay = nullptr;
233 }
234
235 void ServicesOverlayController::didMoveToPage(PageOverlay&, Page*)
236 {
237 }
238
239 static const uint8_t AlignmentNone = 0;
240 static const uint8_t AlignmentLeft = 1 << 0;
241 static const uint8_t AlignmentRight = 1 << 1;
242
243 static void expandForGap(Vector<LayoutRect>& rects, uint8_t* alignments, const GapRects& gap)
244 {
245     if (!gap.left().isEmpty()) {
246         LayoutUnit leftEdge = gap.left().x();
247         for (unsigned i = 0; i < rects.size(); ++i) {
248             if (alignments[i] & AlignmentLeft)
249                 rects[i].shiftXEdgeTo(leftEdge);
250         }
251     }
252
253     if (!gap.right().isEmpty()) {
254         LayoutUnit rightEdge = gap.right().maxX();
255         for (unsigned i = 0; i < rects.size(); ++i) {
256             if (alignments[i] & AlignmentRight)
257                 rects[i].shiftMaxXEdgeTo(rightEdge);
258         }
259     }
260 }
261
262 static inline void stitchRects(Vector<LayoutRect>& rects)
263 {
264     if (rects.size() <= 1)
265         return;
266     
267     Vector<LayoutRect> newRects;
268     
269     // FIXME: Need to support vertical layout.
270     // First stitch together all the rects on the first line of the selection.
271     size_t indexFromStart = 0;
272     LayoutUnit firstTop = rects[indexFromStart].y();
273     LayoutRect& currentRect = rects[indexFromStart];
274     while (indexFromStart < rects.size() && rects[indexFromStart].y() == firstTop)
275         currentRect.unite(rects[indexFromStart++]);
276     
277     newRects.append(currentRect);
278     if (indexFromStart == rects.size()) {
279         // All the rects are on one line. There is nothing else to do.
280         rects.swap(newRects);
281         return;
282     }
283     
284     // Next stitch together all the rects on the last line of the selection.
285     size_t indexFromEnd = rects.size() - 1;
286     LayoutUnit lastTop = rects[indexFromEnd].y();
287     LayoutRect lastRect = rects[indexFromEnd];
288     while (indexFromEnd >= indexFromStart && rects[indexFromEnd].y() == lastTop)
289         lastRect.unite(rects[indexFromEnd--]);
290     
291     // indexFromStart is the index of the first rectangle on the second line.
292     // indexFromEnd is the index of the last rectangle on the second to the last line.
293     // if they are equal, there is one additional rectangle for the line in the middle.
294     if (indexFromEnd == indexFromStart)
295         newRects.append(rects[indexFromStart]);
296     
297     if (indexFromEnd <= indexFromStart) {
298         // There are no more rects to stitch. Just append the last line.
299         newRects.append(lastRect);
300         rects.swap(newRects);
301         return;
302     }
303     
304     // Stitch together all the rects after the first line until the second to the last included.
305     currentRect = rects[indexFromStart];
306     while (indexFromStart != indexFromEnd)
307         currentRect.unite(rects[++indexFromStart]);
308     
309     newRects.append(currentRect);
310     newRects.append(lastRect);
311
312     rects.swap(newRects);
313 }
314
315 static void compactRectsWithGapRects(Vector<LayoutRect>& rects, const Vector<GapRects>& gapRects)
316 {
317     stitchRects(rects);
318     
319     // FIXME: The following alignments are correct for LTR text.
320     // We should also account for RTL.
321     uint8_t alignments[3];
322     if (rects.size() == 1) {
323         alignments[0] = AlignmentLeft | AlignmentRight;
324         alignments[1] = AlignmentNone;
325         alignments[2] = AlignmentNone;
326     } else if (rects.size() == 2) {
327         alignments[0] = AlignmentRight;
328         alignments[1] = AlignmentLeft;
329         alignments[2] = AlignmentNone;
330     } else {
331         alignments[0] = AlignmentRight;
332         alignments[1] = AlignmentLeft | AlignmentRight;
333         alignments[2] = AlignmentLeft;
334     }
335
336     // Account for each GapRects by extending the edge of certain LayoutRects to meet the gap.
337     for (auto& gap : gapRects)
338         expandForGap(rects, alignments, gap);
339
340     // If we have 3 rects we might need one final GapRects to align the edges.
341     if (rects.size() == 3) {
342         LayoutRect left;
343         LayoutRect right;
344         for (unsigned i = 0; i < 3; ++i) {
345             if (alignments[i] & AlignmentLeft) {
346                 if (left.isEmpty())
347                     left = rects[i];
348                 else if (rects[i].x() < left.x())
349                     left = rects[i];
350             }
351             if (alignments[i] & AlignmentRight) {
352                 if (right.isEmpty())
353                     right = rects[i];
354                 else if ((rects[i].x() + rects[i].width()) > (right.x() + right.width()))
355                     right = rects[i];
356             }
357         }
358
359         if (!left.isEmpty() || !right.isEmpty()) {
360             GapRects gap;
361             gap.uniteLeft(left);
362             gap.uniteRight(right);
363             expandForGap(rects, alignments, gap);
364         }
365     }
366 }
367
368 void ServicesOverlayController::selectionRectsDidChange(const Vector<LayoutRect>& rects, const Vector<GapRects>& gapRects, bool isTextOnly)
369 {
370 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED > 1090
371     m_currentSelectionRects = rects;
372     m_isTextOnly = isTextOnly;
373
374     m_lastSelectionChangeTime = std::chrono::steady_clock::now();
375
376     compactRectsWithGapRects(m_currentSelectionRects, gapRects);
377
378     // DataDetectors needs these reversed in order to place the arrow in the right location.
379     m_currentSelectionRects.reverse();
380
381     LOG(Services, "ServicesOverlayController - Selection rects changed - Now have %lu\n", rects.size());
382
383     buildSelectionHighlight();
384 #else
385     UNUSED_PARAM(rects);
386     UNUSED_PARAM(gapRects);
387     UNUSED_PARAM(isTextOnly);
388 #endif
389 }
390
391 void ServicesOverlayController::selectedTelephoneNumberRangesChanged()
392 {
393 #if PLATFORM(MAC) && __MAC_OS_X_VERSION_MIN_REQUIRED > 1090
394     LOG(Services, "ServicesOverlayController - Telephone number ranges changed\n");
395     buildPhoneNumberHighlights();
396 #endif
397 }
398
399 bool ServicesOverlayController::mouseIsOverHighlight(Highlight& highlight, bool& mouseIsOverButton) const
400 {
401     Boolean onButton;
402     bool hovered = DDHighlightPointIsOnHighlight(highlight.ddHighlight(), (CGPoint)m_mousePosition, &onButton);
403     mouseIsOverButton = onButton;
404     return hovered;
405 }
406
407 std::chrono::milliseconds ServicesOverlayController::remainingTimeUntilHighlightShouldBeShown(Highlight* highlight) const
408 {
409     if (!highlight)
410         return std::chrono::milliseconds::zero();
411
412     auto minimumTimeUntilHighlightShouldBeShown = 200_ms;
413     Page* page = m_mainFrame.page();
414     if (page && page->focusController().focusedOrMainFrame().selection().selection().isContentEditable())
415         minimumTimeUntilHighlightShouldBeShown = 1000_ms;
416
417     bool mousePressed = m_mainFrame.eventHandler().mousePressed();
418
419     // Highlight hysteresis is only for selection services, because telephone number highlights are already much more stable
420     // by virtue of being expanded to include the entire telephone number. However, we will still avoid highlighting
421     // telephone numbers while the mouse is down.
422     if (highlight->type() == Highlight::Type::TelephoneNumber)
423         return mousePressed ? minimumTimeUntilHighlightShouldBeShown : 0_ms;
424
425     auto now = std::chrono::steady_clock::now();
426     auto timeSinceLastSelectionChange = now - m_lastSelectionChangeTime;
427     auto timeSinceHighlightBecameActive = now - m_nextActiveHighlightChangeTime;
428     auto timeSinceLastMouseUp = mousePressed ? 0_ms : now - m_lastMouseUpTime;
429
430     auto remainingDelay = minimumTimeUntilHighlightShouldBeShown - std::min(std::min(timeSinceLastSelectionChange, timeSinceHighlightBecameActive), timeSinceLastMouseUp);
431     return std::chrono::duration_cast<std::chrono::milliseconds>(remainingDelay);
432 }
433
434 void ServicesOverlayController::determineActiveHighlightTimerFired()
435 {
436     bool mouseIsOverButton;
437     determineActiveHighlight(mouseIsOverButton);
438 }
439
440 void ServicesOverlayController::drawRect(PageOverlay&, GraphicsContext&, const IntRect&)
441 {
442 }
443
444 void ServicesOverlayController::clearActiveHighlight()
445 {
446     if (!m_activeHighlight)
447         return;
448
449     if (m_currentMouseDownOnButtonHighlight == m_activeHighlight)
450         m_currentMouseDownOnButtonHighlight = nullptr;
451     m_activeHighlight = nullptr;
452 }
453
454 void ServicesOverlayController::removeAllPotentialHighlightsOfType(Highlight::Type type)
455 {
456     Vector<RefPtr<Highlight>> highlightsToRemove;
457     for (auto& highlight : m_potentialHighlights) {
458         if (highlight->type() == type)
459             highlightsToRemove.append(highlight);
460     }
461
462     while (!highlightsToRemove.isEmpty())
463         m_potentialHighlights.remove(highlightsToRemove.takeLast());
464 }
465
466 void ServicesOverlayController::buildPhoneNumberHighlights()
467 {
468     if (!m_mainFrame.settings().serviceControlsEnabled())
469         return;
470
471     Vector<RefPtr<Range>> phoneNumberRanges;
472     for (Frame* frame = &m_mainFrame; frame; frame = frame->tree().traverseNext())
473         phoneNumberRanges.appendVector(frame->editor().detectedTelephoneNumberRanges());
474
475     if (phoneNumberRanges.isEmpty()) {
476         removeAllPotentialHighlightsOfType(Highlight::Type::TelephoneNumber);
477         didRebuildPotentialHighlights();
478         return;
479     }
480
481     if (!DataDetectorsLibrary())
482         return;
483
484     HashSet<RefPtr<Highlight>> newPotentialHighlights;
485
486     FrameView& mainFrameView = *m_mainFrame.view();
487
488     for (auto& range : phoneNumberRanges) {
489         // FIXME: This will choke if the range wraps around the edge of the view.
490         // What should we do in that case?
491         IntRect rect = textQuadsToBoundingRectForRange(*range);
492
493         // Convert to the main document's coordinate space.
494         // FIXME: It's a little crazy to call contentsToWindow and then windowToContents in order to get the right coordinate space.
495         // We should consider adding conversion functions to ScrollView for contentsToDocument(). Right now, contentsToRootView() is
496         // not equivalent to what we need when you have a topContentInset or a header banner.
497         FrameView* viewForRange = range->ownerDocument().view();
498         if (!viewForRange)
499             continue;
500         rect.setLocation(mainFrameView.windowToContents(viewForRange->contentsToWindow(rect.location())));
501
502         CGRect cgRect = rect;
503         RetainPtr<DDHighlightRef> ddHighlight = adoptCF(DDHighlightCreateWithRectsInVisibleRectWithStyleAndDirection(nullptr, &cgRect, 1, mainFrameView.visibleContentRect(), DDHighlightStyleBubbleStandard | DDHighlightStyleStandardIconArrow, YES, NSWritingDirectionNatural, NO, YES));
504
505         newPotentialHighlights.add(Highlight::createForTelephoneNumber(*this, ddHighlight, range));
506     }
507
508     replaceHighlightsOfTypePreservingEquivalentHighlights(newPotentialHighlights, Highlight::Type::TelephoneNumber);
509
510     didRebuildPotentialHighlights();
511 }
512
513 void ServicesOverlayController::buildSelectionHighlight()
514 {
515     if (!m_mainFrame.settings().serviceControlsEnabled())
516         return;
517
518     if (m_currentSelectionRects.isEmpty()) {
519         removeAllPotentialHighlightsOfType(Highlight::Type::Selection);
520         didRebuildPotentialHighlights();
521         return;
522     }
523
524     Page* page = m_mainFrame.page();
525     if (!page)
526         return;
527
528     if (!DataDetectorsLibrary())
529         return;
530
531     HashSet<RefPtr<Highlight>> newPotentialHighlights;
532
533     Vector<CGRect> cgRects;
534     cgRects.reserveCapacity(m_currentSelectionRects.size());
535
536     RefPtr<Range> selectionRange = page->selection().firstRange();
537     if (selectionRange) {
538         FrameView* mainFrameView = m_mainFrame.view();
539         if (!mainFrameView)
540             return;
541
542         FrameView* viewForRange = selectionRange->ownerDocument().view();
543
544         for (auto& rect : m_currentSelectionRects) {
545             IntRect currentRect = snappedIntRect(rect);
546             currentRect.setLocation(mainFrameView->windowToContents(viewForRange->contentsToWindow(currentRect.location())));
547             cgRects.append((CGRect)currentRect);
548         }
549
550         if (!cgRects.isEmpty()) {
551             CGRect visibleRect = mainFrameView->visibleContentRect();
552             RetainPtr<DDHighlightRef> ddHighlight = adoptCF(DDHighlightCreateWithRectsInVisibleRectWithStyleAndDirection(nullptr, cgRects.begin(), cgRects.size(), visibleRect, DDHighlightStyleBubbleNone | DDHighlightStyleStandardIconArrow | DDHighlightStyleButtonShowAlways, YES, NSWritingDirectionNatural, NO, YES));
553             
554             newPotentialHighlights.add(Highlight::createForSelection(*this, ddHighlight, selectionRange));
555         }
556     }
557
558     replaceHighlightsOfTypePreservingEquivalentHighlights(newPotentialHighlights, Highlight::Type::Selection);
559
560     didRebuildPotentialHighlights();
561 }
562
563 void ServicesOverlayController::replaceHighlightsOfTypePreservingEquivalentHighlights(HashSet<RefPtr<Highlight>>& newPotentialHighlights, Highlight::Type type)
564 {
565     // If any old Highlights are equivalent (by Range) to a new Highlight, reuse the old
566     // one so that any metadata is retained.
567     HashSet<RefPtr<Highlight>> reusedPotentialHighlights;
568
569     for (auto& oldHighlight : m_potentialHighlights) {
570         if (oldHighlight->type() != type)
571             continue;
572
573         for (auto& newHighlight : newPotentialHighlights) {
574             if (highlightsAreEquivalent(oldHighlight.get(), newHighlight.get())) {
575                 oldHighlight->setDDHighlight(newHighlight->ddHighlight());
576
577                 reusedPotentialHighlights.add(oldHighlight);
578                 newPotentialHighlights.remove(newHighlight);
579
580                 break;
581             }
582         }
583     }
584
585     removeAllPotentialHighlightsOfType(type);
586
587     m_potentialHighlights.add(newPotentialHighlights.begin(), newPotentialHighlights.end());
588     m_potentialHighlights.add(reusedPotentialHighlights.begin(), reusedPotentialHighlights.end());
589 }
590
591 bool ServicesOverlayController::hasRelevantSelectionServices()
592 {
593     if (Page* page = m_mainFrame.page())
594         return page->chrome().client().hasRelevantSelectionServices(m_isTextOnly);
595     return false;
596 }
597
598 void ServicesOverlayController::didRebuildPotentialHighlights()
599 {
600     if (m_potentialHighlights.isEmpty()) {
601         if (m_servicesOverlay)
602             m_mainFrame.pageOverlayController().uninstallPageOverlay(m_servicesOverlay, PageOverlay::FadeMode::DoNotFade);
603         return;
604     }
605
606     if (telephoneNumberRangesForFocusedFrame().isEmpty() && !hasRelevantSelectionServices())
607         return;
608
609     createOverlayIfNeeded();
610
611     bool mouseIsOverButton;
612     determineActiveHighlight(mouseIsOverButton);
613 }
614
615 void ServicesOverlayController::createOverlayIfNeeded()
616 {
617     if (m_servicesOverlay)
618         return;
619
620     if (!m_mainFrame.settings().serviceControlsEnabled())
621         return;
622
623     RefPtr<PageOverlay> overlay = PageOverlay::create(*this, PageOverlay::OverlayType::Document);
624     m_servicesOverlay = overlay.get();
625     m_mainFrame.pageOverlayController().installPageOverlay(overlay.release(), PageOverlay::FadeMode::DoNotFade);
626 }
627
628 Vector<RefPtr<Range>> ServicesOverlayController::telephoneNumberRangesForFocusedFrame()
629 {
630     Page* page = m_mainFrame.page();
631     if (!page)
632         return { };
633
634     return page->focusController().focusedOrMainFrame().editor().detectedTelephoneNumberRanges();
635 }
636
637 bool ServicesOverlayController::highlightsAreEquivalent(const Highlight* a, const Highlight* b)
638 {
639     if (a == b)
640         return true;
641
642     if (!a || !b)
643         return false;
644
645     if (a->type() == b->type() && areRangesEqual(a->range(), b->range()))
646         return true;
647
648     return false;
649 }
650
651 ServicesOverlayController::Highlight* ServicesOverlayController::findTelephoneNumberHighlightContainingSelectionHighlight(Highlight& selectionHighlight)
652 {
653     if (selectionHighlight.type() != Highlight::Type::Selection)
654         return nullptr;
655
656     Page* page = m_mainFrame.page();
657     if (!page)
658         return nullptr;
659
660     const VisibleSelection& selection = page->selection();
661     if (!selection.isRange())
662         return nullptr;
663
664     RefPtr<Range> activeSelectionRange = selection.toNormalizedRange();
665     if (!activeSelectionRange)
666         return nullptr;
667
668     for (auto& highlight : m_potentialHighlights) {
669         if (highlight->type() != Highlight::Type::TelephoneNumber)
670             continue;
671
672         if (highlight->range()->contains(*activeSelectionRange))
673             return highlight.get();
674     }
675
676     return nullptr;
677 }
678
679 void ServicesOverlayController::determineActiveHighlight(bool& mouseIsOverActiveHighlightButton)
680 {
681     mouseIsOverActiveHighlightButton = false;
682
683     RefPtr<Highlight> newActiveHighlight;
684
685     for (auto& highlight : m_potentialHighlights) {
686         if (highlight->type() == Highlight::Type::Selection) {
687             // If we've already found a new active highlight, and it's
688             // a telephone number highlight, prefer that over this selection highlight.
689             if (newActiveHighlight && newActiveHighlight->type() == Highlight::Type::TelephoneNumber)
690                 continue;
691
692             // If this highlight has no compatible services, it can't be active.
693             if (!hasRelevantSelectionServices())
694                 continue;
695         }
696
697         // If this highlight isn't hovered, it can't be active.
698         bool mouseIsOverButton;
699         if (!mouseIsOverHighlight(*highlight, mouseIsOverButton))
700             continue;
701
702         newActiveHighlight = highlight;
703         mouseIsOverActiveHighlightButton = mouseIsOverButton;
704     }
705
706     // If our new active highlight is a selection highlight that is completely contained
707     // by one of the phone number highlights, we'll make the phone number highlight active even if it's not hovered.
708     if (newActiveHighlight && newActiveHighlight->type() == Highlight::Type::Selection) {
709         if (Highlight* containedTelephoneNumberHighlight = findTelephoneNumberHighlightContainingSelectionHighlight(*newActiveHighlight)) {
710             newActiveHighlight = containedTelephoneNumberHighlight;
711
712             // We will always initially choose the telephone number highlight over the selection highlight if the
713             // mouse is over the telephone number highlight's button, so we know that it's not hovered if we got here.
714             mouseIsOverActiveHighlightButton = false;
715         }
716     }
717
718     if (!this->highlightsAreEquivalent(m_activeHighlight.get(), newActiveHighlight.get())) {
719         // When transitioning to a new highlight, we might end up in determineActiveHighlight multiple times
720         // before the new highlight actually becomes active. Keep track of the last next-but-not-yet-active
721         // highlight, and only reset the active highlight hysteresis when that changes.
722         if (m_nextActiveHighlight != newActiveHighlight) {
723             m_nextActiveHighlight = newActiveHighlight;
724             m_nextActiveHighlightChangeTime = std::chrono::steady_clock::now();
725         }
726
727         m_currentMouseDownOnButtonHighlight = nullptr;
728
729         if (m_activeHighlight) {
730             m_activeHighlight->fadeOut();
731             m_activeHighlight = nullptr;
732         }
733
734         auto remainingTimeUntilHighlightShouldBeShown = this->remainingTimeUntilHighlightShouldBeShown(newActiveHighlight.get());
735         if (remainingTimeUntilHighlightShouldBeShown > std::chrono::steady_clock::duration::zero()) {
736             m_determineActiveHighlightTimer.startOneShot(remainingTimeUntilHighlightShouldBeShown);
737             return;
738         }
739
740         m_activeHighlight = m_nextActiveHighlight.release();
741
742         if (m_activeHighlight) {
743             m_servicesOverlay->layer().addChild(m_activeHighlight->layer());
744             m_activeHighlight->fadeIn();
745         }
746     }
747 }
748
749 bool ServicesOverlayController::mouseEvent(PageOverlay&, const PlatformMouseEvent& event)
750 {
751     m_mousePosition = m_mainFrame.view()->windowToContents(event.position());
752
753     bool mouseIsOverActiveHighlightButton = false;
754     determineActiveHighlight(mouseIsOverActiveHighlightButton);
755
756     // Cancel the potential click if any button other than the left button changes state, and ignore the event.
757     if (event.button() != MouseButton::LeftButton) {
758         m_currentMouseDownOnButtonHighlight = nullptr;
759         return false;
760     }
761
762     // If the mouse lifted while still over the highlight button that it went down on, then that is a click.
763     if (event.type() == PlatformEvent::MouseReleased) {
764         RefPtr<Highlight> mouseDownHighlight = m_currentMouseDownOnButtonHighlight;
765         m_currentMouseDownOnButtonHighlight = nullptr;
766
767         m_lastMouseUpTime = std::chrono::steady_clock::now();
768
769         if (mouseIsOverActiveHighlightButton && mouseDownHighlight) {
770             handleClick(m_mousePosition, *mouseDownHighlight);
771             return true;
772         }
773         
774         return false;
775     }
776
777     // If the mouse moved outside of the button tracking a potential click, stop tracking the click.
778     if (event.type() == PlatformEvent::MouseMoved) {
779         if (m_currentMouseDownOnButtonHighlight && mouseIsOverActiveHighlightButton)
780             return true;
781
782         m_currentMouseDownOnButtonHighlight = nullptr;
783         return false;
784     }
785
786     // If the mouse went down over the active highlight's button, track this as a potential click.
787     if (event.type() == PlatformEvent::MousePressed) {
788         if (m_activeHighlight && mouseIsOverActiveHighlightButton) {
789             m_currentMouseDownOnButtonHighlight = m_activeHighlight;
790             return true;
791         }
792
793         return false;
794     }
795
796     return false;
797 }
798
799 void ServicesOverlayController::didScrollFrame(PageOverlay&, Frame& frame)
800 {
801     if (frame.isMainFrame())
802         return;
803
804     buildPhoneNumberHighlights();
805     buildSelectionHighlight();
806
807     bool mouseIsOverActiveHighlightButton;
808     determineActiveHighlight(mouseIsOverActiveHighlightButton);
809 }
810
811 void ServicesOverlayController::handleClick(const IntPoint& clickPoint, Highlight& highlight)
812 {
813     FrameView* frameView = m_mainFrame.view();
814     if (!frameView)
815         return;
816
817     Page* page = m_mainFrame.page();
818     if (!page)
819         return;
820
821     IntPoint windowPoint = frameView->contentsToWindow(clickPoint);
822
823     if (highlight.type() == Highlight::Type::Selection) {
824         auto telephoneNumberRanges = telephoneNumberRangesForFocusedFrame();
825         Vector<String> selectedTelephoneNumbers;
826         selectedTelephoneNumbers.reserveCapacity(telephoneNumberRanges.size());
827         for (auto& range : telephoneNumberRanges)
828             selectedTelephoneNumbers.append(range->text());
829
830         page->chrome().client().handleSelectionServiceClick(page->focusController().focusedOrMainFrame().selection(), selectedTelephoneNumbers, windowPoint);
831     } else if (highlight.type() == Highlight::Type::TelephoneNumber)
832         page->chrome().client().handleTelephoneNumberClick(highlight.range()->text(), windowPoint);
833 }
834
835 void ServicesOverlayController::didCreateHighlight(Highlight* highlight)
836 {
837     ASSERT(!m_highlights.contains(highlight));
838     m_highlights.add(highlight);
839 }
840
841 void ServicesOverlayController::willDestroyHighlight(Highlight* highlight)
842 {
843     ASSERT(m_highlights.contains(highlight));
844     m_highlights.remove(highlight);
845 }
846
847 } // namespace WebKit
848
849 #endif // (ENABLE(SERVICE_CONTROLS) || ENABLE(TELEPHONE_NUMBER_DETECTION)) && PLATFORM(MAC)