e2e131075c45645bdad0f1c2eecd68158b551291
[WebKit-https.git] / Source / WebCore / page / Frame.cpp
1 /*
2  * Copyright (C) 1998, 1999 Torben Weis <weis@kde.org>
3  *                     1999 Lars Knoll <knoll@kde.org>
4  *                     1999 Antti Koivisto <koivisto@kde.org>
5  *                     2000 Simon Hausmann <hausmann@kde.org>
6  *                     2000 Stefan Schimanski <1Stein@gmx.de>
7  *                     2001 George Staikos <staikos@kde.org>
8  * Copyright (C) 2004-2016 Apple Inc. All rights reserved.
9  * Copyright (C) 2005 Alexey Proskuryakov <ap@nypop.com>
10  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
11  * Copyright (C) 2008 Eric Seidel <eric@webkit.org>
12  * Copyright (C) 2008 Google Inc.
13  *
14  * This library is free software; you can redistribute it and/or
15  * modify it under the terms of the GNU Library General Public
16  * License as published by the Free Software Foundation; either
17  * version 2 of the License, or (at your option) any later version.
18  *
19  * This library is distributed in the hope that it will be useful,
20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
22  * Library General Public License for more details.
23  *
24  * You should have received a copy of the GNU Library General Public License
25  * along with this library; see the file COPYING.LIB.  If not, write to
26  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27  * Boston, MA 02110-1301, USA.
28  */
29
30 #include "config.h"
31 #include "Frame.h"
32
33 #include "ApplyStyleCommand.h"
34 #include "BackForwardController.h"
35 #include "CSSAnimationController.h"
36 #include "CSSComputedStyleDeclaration.h"
37 #include "CSSPropertyNames.h"
38 #include "CachedCSSStyleSheet.h"
39 #include "CachedResourceLoader.h"
40 #include "Chrome.h"
41 #include "ChromeClient.h"
42 #include "DOMWindow.h"
43 #include "DocumentType.h"
44 #include "Editing.h"
45 #include "Editor.h"
46 #include "EditorClient.h"
47 #include "Event.h"
48 #include "EventHandler.h"
49 #include "EventNames.h"
50 #include "FloatQuad.h"
51 #include "FocusController.h"
52 #include "FrameDestructionObserver.h"
53 #include "FrameLoader.h"
54 #include "FrameLoaderClient.h"
55 #include "FrameSelection.h"
56 #include "FrameView.h"
57 #include "GraphicsContext.h"
58 #include "GraphicsLayer.h"
59 #include "HTMLDocument.h"
60 #include "HTMLFormControlElement.h"
61 #include "HTMLFormElement.h"
62 #include "HTMLFrameElementBase.h"
63 #include "HTMLNames.h"
64 #include "HTMLTableCellElement.h"
65 #include "HTMLTableRowElement.h"
66 #include "HitTestResult.h"
67 #include "ImageBuffer.h"
68 #include "InspectorInstrumentation.h"
69 #include "JSDOMWindowProxy.h"
70 #include "Logging.h"
71 #include "MainFrame.h"
72 #include "MathMLNames.h"
73 #include "MediaFeatureNames.h"
74 #include "NavigationScheduler.h"
75 #include "Navigator.h"
76 #include "NodeList.h"
77 #include "NodeTraversal.h"
78 #include "Page.h"
79 #include "PageCache.h"
80 #include "RenderLayerCompositor.h"
81 #include "RenderTableCell.h"
82 #include "RenderText.h"
83 #include "RenderTextControl.h"
84 #include "RenderTheme.h"
85 #include "RenderView.h"
86 #include "RenderWidget.h"
87 #include "RuntimeEnabledFeatures.h"
88 #include "SVGDocument.h"
89 #include "SVGDocumentExtensions.h"
90 #include "SVGNames.h"
91 #include "ScriptController.h"
92 #include "ScriptSourceCode.h"
93 #include "ScrollingCoordinator.h"
94 #include "Settings.h"
95 #include "StyleProperties.h"
96 #include "StyleScope.h"
97 #include "TextNodeTraversal.h"
98 #include "TextResourceDecoder.h"
99 #include "UserContentController.h"
100 #include "UserContentURLPattern.h"
101 #include "UserScript.h"
102 #include "UserTypingGestureIndicator.h"
103 #include "VisibleUnits.h"
104 #include "WebKitFontFamilyNames.h"
105 #include "XLinkNames.h"
106 #include "XMLNSNames.h"
107 #include "XMLNames.h"
108 #include "markup.h"
109 #include "npruntime_impl.h"
110 #include "runtime_root.h"
111 #include <wtf/RefCountedLeakCounter.h>
112 #include <wtf/StdLibExtras.h>
113 #include <wtf/text/StringBuilder.h>
114 #include <yarr/RegularExpression.h>
115
116 #if PLATFORM(IOS)
117 #include "WKContentObservation.h"
118 #endif
119
120 namespace WebCore {
121
122 using namespace HTMLNames;
123
124 #if PLATFORM(IOS)
125 static const Seconds scrollFrequency { 1000_s / 60. };
126 #endif
127
128 DEFINE_DEBUG_ONLY_GLOBAL(WTF::RefCountedLeakCounter, frameCounter, ("Frame"));
129
130 static inline Frame* parentFromOwnerElement(HTMLFrameOwnerElement* ownerElement)
131 {
132     if (!ownerElement)
133         return 0;
134     return ownerElement->document().frame();
135 }
136
137 static inline float parentPageZoomFactor(Frame* frame)
138 {
139     Frame* parent = frame->tree().parent();
140     if (!parent)
141         return 1;
142     return parent->pageZoomFactor();
143 }
144
145 static inline float parentTextZoomFactor(Frame* frame)
146 {
147     Frame* parent = frame->tree().parent();
148     if (!parent)
149         return 1;
150     return parent->textZoomFactor();
151 }
152
153 Frame::Frame(Page& page, HTMLFrameOwnerElement* ownerElement, FrameLoaderClient& frameLoaderClient)
154     : m_mainFrame(ownerElement ? page.mainFrame() : static_cast<MainFrame&>(*this))
155     , m_page(&page)
156     , m_settings(&page.settings())
157     , m_treeNode(*this, parentFromOwnerElement(ownerElement))
158     , m_loader(makeUniqueRef<FrameLoader>(*this, frameLoaderClient))
159     , m_navigationScheduler(makeUniqueRef<NavigationScheduler>(*this))
160     , m_ownerElement(ownerElement)
161     , m_script(makeUniqueRef<ScriptController>(*this))
162     , m_editor(makeUniqueRef<Editor>(*this))
163     , m_selection(makeUniqueRef<FrameSelection>(this))
164     , m_animationController(makeUniqueRef<CSSAnimationController>(*this))
165 #if PLATFORM(IOS)
166     , m_overflowAutoScrollTimer(*this, &Frame::overflowAutoScrollTimerFired)
167     , m_selectionChangeCallbacksDisabled(false)
168 #endif
169     , m_pageZoomFactor(parentPageZoomFactor(this))
170     , m_textZoomFactor(parentTextZoomFactor(this))
171     , m_activeDOMObjectsAndAnimationsSuspendedCount(0)
172     , m_eventHandler(makeUniqueRef<EventHandler>(*this))
173 {
174     AtomicString::init();
175     HTMLNames::init();
176     QualifiedName::init();
177     MediaFeatureNames::init();
178     SVGNames::init();
179     XLinkNames::init();
180     MathMLNames::init();
181     XMLNSNames::init();
182     XMLNames::init();
183     WebKitFontFamilyNames::init();
184
185     if (ownerElement) {
186         m_mainFrame.selfOnlyRef();
187         page.incrementSubframeCount();
188         ownerElement->setContentFrame(this);
189     }
190
191 #ifndef NDEBUG
192     frameCounter.increment();
193 #endif
194
195     // Pause future ActiveDOMObjects if this frame is being created while the page is in a paused state.
196     Frame* parent = parentFromOwnerElement(ownerElement);
197     if (parent && parent->activeDOMObjectsAndAnimationsSuspended())
198         suspendActiveDOMObjectsAndAnimations();
199 }
200
201 void Frame::init()
202 {
203     m_loader->init();
204 }
205
206 Ref<Frame> Frame::create(Page* page, HTMLFrameOwnerElement* ownerElement, FrameLoaderClient* client)
207 {
208     ASSERT(page);
209     ASSERT(client);
210     return adoptRef(*new Frame(*page, ownerElement, *client));
211 }
212
213 Frame::~Frame()
214 {
215     setView(nullptr);
216     loader().cancelAndClear();
217
218     // FIXME: We should not be doing all this work inside the destructor
219
220 #ifndef NDEBUG
221     frameCounter.decrement();
222 #endif
223
224     disconnectOwnerElement();
225
226     while (auto* destructionObserver = m_destructionObservers.takeAny())
227         destructionObserver->frameDestroyed();
228
229     if (!isMainFrame())
230         m_mainFrame.selfOnlyDeref();
231 }
232
233 void Frame::addDestructionObserver(FrameDestructionObserver* observer)
234 {
235     m_destructionObservers.add(observer);
236 }
237
238 void Frame::removeDestructionObserver(FrameDestructionObserver* observer)
239 {
240     m_destructionObservers.remove(observer);
241 }
242
243 void Frame::setView(RefPtr<FrameView>&& view)
244 {
245     // We the custom scroll bars as early as possible to prevent m_doc->detach()
246     // from messing with the view such that its scroll bars won't be torn down.
247     // FIXME: We should revisit this.
248     if (m_view)
249         m_view->prepareForDetach();
250
251     // Prepare for destruction now, so any unload event handlers get run and the DOMWindow is
252     // notified. If we wait until the view is destroyed, then things won't be hooked up enough for
253     // these calls to work.
254     if (!view && m_doc && m_doc->pageCacheState() != Document::InPageCache)
255         m_doc->prepareForDestruction();
256     
257     if (m_view)
258         m_view->layoutContext().unscheduleLayout();
259     
260     m_eventHandler->clear();
261
262     RELEASE_ASSERT(!m_doc || !m_doc->hasLivingRenderTree());
263
264     m_view = WTFMove(view);
265     
266     // Only one form submission is allowed per view of a part.
267     // Since this part may be getting reused as a result of being
268     // pulled from the back/forward cache, reset this flag.
269     loader().resetMultipleFormSubmissionProtection();
270 }
271
272 void Frame::setDocument(RefPtr<Document>&& newDocument)
273 {
274     ASSERT(!newDocument || newDocument->frame() == this);
275
276     if (m_documentIsBeingReplaced)
277         return;
278
279     m_documentIsBeingReplaced = true;
280
281     if (isMainFrame()) {
282         if (m_page)
283             m_page->didChangeMainDocument();
284         m_loader->client().dispatchDidChangeMainDocument();
285     }
286
287     if (m_doc && m_doc->pageCacheState() != Document::InPageCache)
288         m_doc->prepareForDestruction();
289
290     m_doc = newDocument.copyRef();
291     ASSERT(!m_doc || m_doc->domWindow());
292     ASSERT(!m_doc || m_doc->domWindow()->frame() == this);
293
294     // Don't use m_doc because it can be overwritten and we want to guarantee
295     // that the document is not destroyed during this function call.
296     if (newDocument)
297         newDocument->didBecomeCurrentDocumentInFrame();
298
299     InspectorInstrumentation::frameDocumentUpdated(*this);
300
301     m_documentIsBeingReplaced = false;
302 }
303
304 #if ENABLE(ORIENTATION_EVENTS)
305 void Frame::orientationChanged()
306 {
307     Vector<Ref<Frame>> frames;
308     for (Frame* frame = this; frame; frame = frame->tree().traverseNext())
309         frames.append(*frame);
310
311     auto newOrientation = orientation();
312     for (auto& frame : frames) {
313         if (Document* document = frame->document())
314             document->orientationChanged(newOrientation);
315     }
316 }
317
318 int Frame::orientation() const
319 {
320     if (m_page)
321         return m_page->chrome().client().deviceOrientation();
322     return 0;
323 }
324 #endif // ENABLE(ORIENTATION_EVENTS)
325
326 static JSC::Yarr::RegularExpression createRegExpForLabels(const Vector<String>& labels)
327 {
328     // REVIEW- version of this call in FrameMac.mm caches based on the NSArray ptrs being
329     // the same across calls.  We can't do that.
330
331     static NeverDestroyed<JSC::Yarr::RegularExpression> wordRegExp("\\w");
332     StringBuilder pattern;
333     pattern.append('(');
334     unsigned int numLabels = labels.size();
335     unsigned int i;
336     for (i = 0; i < numLabels; i++) {
337         String label = labels[i];
338
339         bool startsWithWordChar = false;
340         bool endsWithWordChar = false;
341         if (label.length()) {
342             startsWithWordChar = wordRegExp.get().match(label.substring(0, 1)) >= 0;
343             endsWithWordChar = wordRegExp.get().match(label.substring(label.length() - 1, 1)) >= 0;
344         }
345
346         if (i)
347             pattern.append('|');
348         // Search for word boundaries only if label starts/ends with "word characters".
349         // If we always searched for word boundaries, this wouldn't work for languages
350         // such as Japanese.
351         if (startsWithWordChar)
352             pattern.appendLiteral("\\b");
353         pattern.append(label);
354         if (endsWithWordChar)
355             pattern.appendLiteral("\\b");
356     }
357     pattern.append(')');
358     return JSC::Yarr::RegularExpression(pattern.toString(), JSC::Yarr::TextCaseInsensitive);
359 }
360
361 String Frame::searchForLabelsAboveCell(const JSC::Yarr::RegularExpression& regExp, HTMLTableCellElement* cell, size_t* resultDistanceFromStartOfCell)
362 {
363     HTMLTableCellElement* aboveCell = cell->cellAbove();
364     if (aboveCell) {
365         // search within the above cell we found for a match
366         size_t lengthSearched = 0;    
367         for (Text* textNode = TextNodeTraversal::firstWithin(*aboveCell); textNode; textNode = TextNodeTraversal::next(*textNode, aboveCell)) {
368             if (!textNode->renderer() || textNode->renderer()->style().visibility() != VISIBLE)
369                 continue;
370             // For each text chunk, run the regexp
371             String nodeString = textNode->data();
372             int pos = regExp.searchRev(nodeString);
373             if (pos >= 0) {
374                 if (resultDistanceFromStartOfCell)
375                     *resultDistanceFromStartOfCell = lengthSearched;
376                 return nodeString.substring(pos, regExp.matchedLength());
377             }
378             lengthSearched += nodeString.length();
379         }
380     }
381
382     // Any reason in practice to search all cells in that are above cell?
383     if (resultDistanceFromStartOfCell)
384         *resultDistanceFromStartOfCell = notFound;
385     return String();
386 }
387
388 // FIXME: This should take an Element&.
389 String Frame::searchForLabelsBeforeElement(const Vector<String>& labels, Element* element, size_t* resultDistance, bool* resultIsInCellAbove)
390 {
391     ASSERT(element);
392     JSC::Yarr::RegularExpression regExp = createRegExpForLabels(labels);
393     // We stop searching after we've seen this many chars
394     const unsigned int charsSearchedThreshold = 500;
395     // This is the absolute max we search.  We allow a little more slop than
396     // charsSearchedThreshold, to make it more likely that we'll search whole nodes.
397     const unsigned int maxCharsSearched = 600;
398     // If the starting element is within a table, the cell that contains it
399     HTMLTableCellElement* startingTableCell = nullptr;
400     bool searchedCellAbove = false;
401
402     if (resultDistance)
403         *resultDistance = notFound;
404     if (resultIsInCellAbove)
405         *resultIsInCellAbove = false;
406     
407     // walk backwards in the node tree, until another element, or form, or end of tree
408     int unsigned lengthSearched = 0;
409     Node* n;
410     for (n = NodeTraversal::previous(*element); n && lengthSearched < charsSearchedThreshold; n = NodeTraversal::previous(*n)) {
411         // We hit another form element or the start of the form - bail out
412         if (is<HTMLFormElement>(*n) || is<HTMLFormControlElement>(*n))
413             break;
414
415         if (n->hasTagName(tdTag) && !startingTableCell)
416             startingTableCell = downcast<HTMLTableCellElement>(n);
417         else if (is<HTMLTableRowElement>(*n) && startingTableCell) {
418             String result = searchForLabelsAboveCell(regExp, startingTableCell, resultDistance);
419             if (!result.isEmpty()) {
420                 if (resultIsInCellAbove)
421                     *resultIsInCellAbove = true;
422                 return result;
423             }
424             searchedCellAbove = true;
425         } else if (n->isTextNode() && n->renderer() && n->renderer()->style().visibility() == VISIBLE) {
426             // For each text chunk, run the regexp
427             String nodeString = n->nodeValue();
428             // add 100 for slop, to make it more likely that we'll search whole nodes
429             if (lengthSearched + nodeString.length() > maxCharsSearched)
430                 nodeString = nodeString.right(charsSearchedThreshold - lengthSearched);
431             int pos = regExp.searchRev(nodeString);
432             if (pos >= 0) {
433                 if (resultDistance)
434                     *resultDistance = lengthSearched;
435                 return nodeString.substring(pos, regExp.matchedLength());
436             }
437             lengthSearched += nodeString.length();
438         }
439     }
440
441     // If we started in a cell, but bailed because we found the start of the form or the
442     // previous element, we still might need to search the row above us for a label.
443     if (startingTableCell && !searchedCellAbove) {
444         String result = searchForLabelsAboveCell(regExp, startingTableCell, resultDistance);
445         if (!result.isEmpty()) {
446             if (resultIsInCellAbove)
447                 *resultIsInCellAbove = true;
448             return result;
449         }
450     }
451     return String();
452 }
453
454 static String matchLabelsAgainstString(const Vector<String>& labels, const String& stringToMatch)
455 {
456     if (stringToMatch.isEmpty())
457         return String();
458
459     String mutableStringToMatch = stringToMatch;
460
461     // Make numbers and _'s in field names behave like word boundaries, e.g., "address2"
462     replace(mutableStringToMatch, JSC::Yarr::RegularExpression("\\d"), " ");
463     mutableStringToMatch.replace('_', ' ');
464     
465     JSC::Yarr::RegularExpression regExp = createRegExpForLabels(labels);
466     // Use the largest match we can find in the whole string
467     int pos;
468     int length;
469     int bestPos = -1;
470     int bestLength = -1;
471     int start = 0;
472     do {
473         pos = regExp.match(mutableStringToMatch, start);
474         if (pos != -1) {
475             length = regExp.matchedLength();
476             if (length >= bestLength) {
477                 bestPos = pos;
478                 bestLength = length;
479             }
480             start = pos + 1;
481         }
482     } while (pos != -1);
483     
484     if (bestPos != -1)
485         return mutableStringToMatch.substring(bestPos, bestLength);
486     return String();
487 }
488     
489 String Frame::matchLabelsAgainstElement(const Vector<String>& labels, Element* element)
490 {
491     // Match against the name element, then against the id element if no match is found for the name element.
492     // See 7538330 for one popular site that benefits from the id element check.
493     // FIXME: This code is mirrored in FrameMac.mm. It would be nice to make the Mac code call the platform-agnostic
494     // code, which would require converting the NSArray of NSStrings to a Vector of Strings somewhere along the way.
495     String resultFromNameAttribute = matchLabelsAgainstString(labels, element->getNameAttribute());
496     if (!resultFromNameAttribute.isEmpty())
497         return resultFromNameAttribute;
498     
499     return matchLabelsAgainstString(labels, element->attributeWithoutSynchronization(idAttr));
500 }
501
502 #if PLATFORM(IOS)
503 void Frame::scrollOverflowLayer(RenderLayer* layer, const IntRect& visibleRect, const IntRect& exposeRect)
504 {
505     if (!layer)
506         return;
507
508     RenderBox* box = layer->renderBox();
509     if (!box)
510         return;
511
512     if (visibleRect.intersects(exposeRect))
513         return;
514
515     // FIXME: Why isn't this just calling RenderLayer::scrollRectToVisible()?
516     ScrollOffset scrollOffset = layer->scrollOffset();
517     int exposeLeft = exposeRect.x();
518     int exposeRight = exposeLeft + exposeRect.width();
519     int clientWidth = roundToInt(box->clientWidth());
520     if (exposeLeft <= 0)
521         scrollOffset.setX(std::max(0, scrollOffset.x() + exposeLeft - clientWidth / 2));
522     else if (exposeRight >= clientWidth)
523         scrollOffset.setX(std::min(box->scrollWidth() - clientWidth, scrollOffset.x() + clientWidth / 2));
524
525     int exposeTop = exposeRect.y();
526     int exposeBottom = exposeTop + exposeRect.height();
527     int clientHeight = roundToInt(box->clientHeight());
528     if (exposeTop <= 0)
529         scrollOffset.setY(std::max(0, scrollOffset.y() + exposeTop - clientHeight / 2));
530     else if (exposeBottom >= clientHeight)
531         scrollOffset.setY(std::min(box->scrollHeight() - clientHeight, scrollOffset.y() + clientHeight / 2));
532
533     layer->scrollToOffset(scrollOffset, ScrollClamping::Unclamped);
534     selection().setCaretRectNeedsUpdate();
535     selection().updateAppearance();
536 }
537
538 void Frame::overflowAutoScrollTimerFired()
539 {
540     if (!eventHandler().mousePressed() || checkOverflowScroll(PerformOverflowScroll) == OverflowScrollNone) {
541         if (m_overflowAutoScrollTimer.isActive())
542             m_overflowAutoScrollTimer.stop();
543     }
544 }
545
546 void Frame::startOverflowAutoScroll(const IntPoint& mousePosition)
547 {
548     m_overflowAutoScrollPos = mousePosition;
549
550     if (m_overflowAutoScrollTimer.isActive())
551         return;
552
553     if (checkOverflowScroll(DoNotPerformOverflowScroll) == OverflowScrollNone)
554         return;
555
556     m_overflowAutoScrollTimer.startRepeating(scrollFrequency);
557     m_overflowAutoScrollDelta = 3;
558 }
559
560 int Frame::checkOverflowScroll(OverflowScrollAction action)
561 {
562     Position extent = selection().selection().extent();
563     if (extent.isNull())
564         return OverflowScrollNone;
565
566     RenderObject* renderer = extent.deprecatedNode()->renderer();
567     if (!renderer)
568         return OverflowScrollNone;
569
570     FrameView* view = this->view();
571     if (!view)
572         return OverflowScrollNone;
573
574     RenderBlock* containingBlock = renderer->containingBlock();
575     if (!containingBlock || !containingBlock->hasOverflowClip())
576         return OverflowScrollNone;
577     RenderLayer* layer = containingBlock->layer();
578     ASSERT(layer);
579
580     IntRect visibleRect = IntRect(view->scrollX(), view->scrollY(), view->visibleWidth(), view->visibleHeight());
581     IntPoint position = m_overflowAutoScrollPos;
582     if (visibleRect.contains(position.x(), position.y()))
583         return OverflowScrollNone;
584
585     int scrollType = 0;
586     int deltaX = 0;
587     int deltaY = 0;
588     IntPoint selectionPosition;
589
590     // This constant will make the selection draw a little bit beyond the edge of the visible area.
591     // This prevents a visual glitch, in that you can fail to select a portion of a character that
592     // is being rendered right at the edge of the visible rectangle.
593     // FIXME: This probably needs improvement, and may need to take the font size into account.
594     static const int scrollBoundsAdjustment = 3;
595
596     // FIXME: Make a small buffer at the end of a visible rectangle so that autoscrolling works 
597     // even if the visible extends to the limits of the screen.
598     if (position.x() < visibleRect.x()) {
599         scrollType |= OverflowScrollLeft;
600         if (action == PerformOverflowScroll) {
601             deltaX -= static_cast<int>(m_overflowAutoScrollDelta);
602             selectionPosition.setX(view->scrollX() - scrollBoundsAdjustment);
603         }
604     } else if (position.x() > visibleRect.maxX()) {
605         scrollType |= OverflowScrollRight;
606         if (action == PerformOverflowScroll) {
607             deltaX += static_cast<int>(m_overflowAutoScrollDelta);
608             selectionPosition.setX(view->scrollX() + view->visibleWidth() + scrollBoundsAdjustment);
609         }
610     }
611
612     if (position.y() < visibleRect.y()) {
613         scrollType |= OverflowScrollUp;
614         if (action == PerformOverflowScroll) {
615             deltaY -= static_cast<int>(m_overflowAutoScrollDelta);
616             selectionPosition.setY(view->scrollY() - scrollBoundsAdjustment);
617         }
618     } else if (position.y() > visibleRect.maxY()) {
619         scrollType |= OverflowScrollDown;
620         if (action == PerformOverflowScroll) {
621             deltaY += static_cast<int>(m_overflowAutoScrollDelta);
622             selectionPosition.setY(view->scrollY() + view->visibleHeight() + scrollBoundsAdjustment);
623         }
624     }
625
626     Ref<Frame> protectedThis(*this);
627
628     if (action == PerformOverflowScroll && (deltaX || deltaY)) {
629         layer->scrollToOffset(layer->scrollOffset() + IntSize(deltaX, deltaY), ScrollClamping::Unclamped);
630
631         // Handle making selection.
632         VisiblePosition visiblePosition(renderer->positionForPoint(selectionPosition, nullptr));
633         if (visiblePosition.isNotNull()) {
634             VisibleSelection visibleSelection = selection().selection();
635             visibleSelection.setExtent(visiblePosition);
636             if (selection().granularity() != CharacterGranularity)
637                 visibleSelection.expandUsingGranularity(selection().granularity());
638             if (selection().shouldChangeSelection(visibleSelection))
639                 selection().setSelection(visibleSelection);
640         }
641
642         m_overflowAutoScrollDelta *= 1.02f; // Accelerate the scroll
643     }
644     return scrollType;
645 }
646
647 void Frame::setSelectionChangeCallbacksDisabled(bool selectionChangeCallbacksDisabled)
648 {
649     m_selectionChangeCallbacksDisabled = selectionChangeCallbacksDisabled;
650 }
651
652 bool Frame::selectionChangeCallbacksDisabled() const
653 {
654     return m_selectionChangeCallbacksDisabled;
655 }
656 #endif // PLATFORM(IOS)
657
658 void Frame::setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot shouldAdjustViewSize)
659 {
660     // In setting printing, we should not validate resources already cached for the document.
661     // See https://bugs.webkit.org/show_bug.cgi?id=43704
662     ResourceCacheValidationSuppressor validationSuppressor(m_doc->cachedResourceLoader());
663
664     m_doc->setPrinting(printing);
665     if (auto* frameView = view()) {
666         frameView->adjustMediaTypeForPrinting(printing);
667
668         m_doc->styleScope().didChangeStyleSheetEnvironment();
669         if (shouldUsePrintingLayout())
670             frameView->forceLayoutForPagination(pageSize, originalPageSize, maximumShrinkRatio, shouldAdjustViewSize);
671         else {
672             frameView->forceLayout();
673             if (shouldAdjustViewSize == AdjustViewSize)
674                 frameView->adjustViewSize();
675         }
676     }
677
678     // Subframes of the one we're printing don't lay out to the page size.
679     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
680         child->setPrinting(printing, FloatSize(), FloatSize(), 0, shouldAdjustViewSize);
681 }
682
683 bool Frame::shouldUsePrintingLayout() const
684 {
685     // Only top frame being printed should be fit to page size.
686     // Subframes should be constrained by parents only.
687     return m_doc->printing() && (!tree().parent() || !tree().parent()->m_doc->printing());
688 }
689
690 FloatSize Frame::resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize)
691 {
692     FloatSize resultSize;
693     if (!contentRenderer())
694         return FloatSize();
695
696     if (contentRenderer()->style().isHorizontalWritingMode()) {
697         ASSERT(fabs(originalSize.width()) > std::numeric_limits<float>::epsilon());
698         float ratio = originalSize.height() / originalSize.width();
699         resultSize.setWidth(floorf(expectedSize.width()));
700         resultSize.setHeight(floorf(resultSize.width() * ratio));
701     } else {
702         ASSERT(fabs(originalSize.height()) > std::numeric_limits<float>::epsilon());
703         float ratio = originalSize.width() / originalSize.height();
704         resultSize.setHeight(floorf(expectedSize.height()));
705         resultSize.setWidth(floorf(resultSize.height() * ratio));
706     }
707     return resultSize;
708 }
709
710 void Frame::injectUserScripts(UserScriptInjectionTime injectionTime)
711 {
712     if (!m_page)
713         return;
714
715     if (loader().stateMachine().creatingInitialEmptyDocument() && !settings().shouldInjectUserScriptsInInitialEmptyDocument())
716         return;
717
718     m_page->userContentProvider().forEachUserScript([this, protectedThis = makeRef(*this), injectionTime](DOMWrapperWorld& world, const UserScript& script) {
719         auto* document = this->document();
720         if (!document)
721             return;
722         if (script.injectedFrames() == InjectInTopFrameOnly && ownerElement())
723             return;
724
725         if (script.injectionTime() == injectionTime && UserContentURLPattern::matchesPatterns(document->url(), script.whitelist(), script.blacklist())) {
726             if (m_page)
727                 m_page->setAsRunningUserScripts();
728             m_script->evaluateInWorld(ScriptSourceCode(script.source(), script.url()), world);
729         }
730     });
731 }
732
733 RenderView* Frame::contentRenderer() const
734 {
735     return document() ? document()->renderView() : nullptr;
736 }
737
738 RenderWidget* Frame::ownerRenderer() const
739 {
740     auto* ownerElement = m_ownerElement;
741     if (!ownerElement)
742         return nullptr;
743     auto* object = ownerElement->renderer();
744     // FIXME: If <object> is ever fixed to disassociate itself from frames
745     // that it has started but canceled, then this can turn into an ASSERT
746     // since m_ownerElement would be nullptr when the load is canceled.
747     // https://bugs.webkit.org/show_bug.cgi?id=18585
748     if (!is<RenderWidget>(object))
749         return nullptr;
750     return downcast<RenderWidget>(object);
751 }
752
753 Frame* Frame::frameForWidget(const Widget& widget)
754 {
755     if (auto* renderer = RenderWidget::find(widget))
756         return renderer->frameOwnerElement().document().frame();
757
758     // Assume all widgets are either a FrameView or owned by a RenderWidget.
759     // FIXME: That assumption is not right for scroll bars!
760     return &downcast<FrameView>(widget).frame();
761 }
762
763 void Frame::clearTimers(FrameView *view, Document *document)
764 {
765     if (view) {
766         view->layoutContext().unscheduleLayout();
767         view->frame().animation().suspendAnimationsForDocument(document);
768         view->frame().eventHandler().stopAutoscrollTimer();
769     }
770 }
771
772 void Frame::clearTimers()
773 {
774     clearTimers(m_view.get(), document());
775 }
776
777 void Frame::willDetachPage()
778 {
779     if (Frame* parent = tree().parent())
780         parent->loader().checkLoadComplete();
781
782     for (auto& observer : m_destructionObservers)
783         observer->willDetachPage();
784
785     // FIXME: It's unclear as to why this is called more than once, but it is,
786     // so page() could be NULL.
787     if (page() && page()->focusController().focusedFrame() == this)
788         page()->focusController().setFocusedFrame(nullptr);
789
790     if (page() && page()->scrollingCoordinator() && m_view)
791         page()->scrollingCoordinator()->willDestroyScrollableArea(*m_view);
792
793 #if PLATFORM(IOS)
794     if (WebThreadCountOfObservedContentModifiers() > 0 && m_page)
795         m_page->chrome().client().clearContentChangeObservers(*this);
796 #endif
797
798     script().clearScriptObjects();
799     script().updatePlatformScriptObjects();
800
801     // We promise that the Frame is always connected to a Page while the render tree is live.
802     //
803     // The render tree can be torn down in a few different ways, but the two important ones are:
804     //
805     // - When calling Frame::setView() with a null FrameView*. This is always done before calling
806     //   Frame::willDetachPage (this function.) Hence the assertion below.
807     //
808     // - When adding a document to the page cache, the tree is torn down before instantiating
809     //   the CachedPage+CachedFrame object tree.
810     ASSERT(!document() || !document()->renderView());
811 }
812
813 void Frame::disconnectOwnerElement()
814 {
815     if (m_ownerElement) {
816         m_ownerElement->clearContentFrame();
817         if (m_page)
818             m_page->decrementSubframeCount();
819     }
820     m_ownerElement = nullptr;
821 }
822
823 String Frame::displayStringModifiedByEncoding(const String& str) const
824 {
825     return document() ? document()->displayStringModifiedByEncoding(str) : str;
826 }
827
828 VisiblePosition Frame::visiblePositionForPoint(const IntPoint& framePoint) const
829 {
830     HitTestResult result = eventHandler().hitTestResultAtPoint(framePoint, HitTestRequest::ReadOnly | HitTestRequest::Active);
831     Node* node = result.innerNonSharedNode();
832     if (!node)
833         return VisiblePosition();
834     auto renderer = node->renderer();
835     if (!renderer)
836         return VisiblePosition();
837     VisiblePosition visiblePos = renderer->positionForPoint(result.localPoint(), nullptr);
838     if (visiblePos.isNull())
839         visiblePos = firstPositionInOrBeforeNode(node);
840     return visiblePos;
841 }
842
843 Document* Frame::documentAtPoint(const IntPoint& point)
844 {
845     if (!view())
846         return nullptr;
847
848     IntPoint pt = view()->windowToContents(point);
849     HitTestResult result = HitTestResult(pt);
850
851     if (contentRenderer())
852         result = eventHandler().hitTestResultAtPoint(pt);
853     return result.innerNode() ? &result.innerNode()->document() : 0;
854 }
855
856 RefPtr<Range> Frame::rangeForPoint(const IntPoint& framePoint)
857 {
858     VisiblePosition position = visiblePositionForPoint(framePoint);
859     if (position.isNull())
860         return nullptr;
861
862     Position deepPosition = position.deepEquivalent();
863     Text* containerText = deepPosition.containerText();
864     if (!containerText || !containerText->renderer() || containerText->renderer()->style().userSelect() == SELECT_NONE)
865         return nullptr;
866
867     VisiblePosition previous = position.previous();
868     if (previous.isNotNull()) {
869         RefPtr<Range> previousCharacterRange = makeRange(previous, position);
870         LayoutRect rect = editor().firstRectForRange(previousCharacterRange.get());
871         if (rect.contains(framePoint))
872             return previousCharacterRange;
873     }
874
875     VisiblePosition next = position.next();
876     if (RefPtr<Range> nextCharacterRange = makeRange(position, next)) {
877         LayoutRect rect = editor().firstRectForRange(nextCharacterRange.get());
878         if (rect.contains(framePoint))
879             return nextCharacterRange;
880     }
881
882     return nullptr;
883 }
884
885 void Frame::createView(const IntSize& viewportSize, const Color& backgroundColor, bool transparent,
886     const IntSize& fixedLayoutSize, const IntRect& fixedVisibleContentRect,
887     bool useFixedLayout, ScrollbarMode horizontalScrollbarMode, bool horizontalLock,
888     ScrollbarMode verticalScrollbarMode, bool verticalLock)
889 {
890     ASSERT(m_page);
891
892     bool isMainFrame = this->isMainFrame();
893
894     if (isMainFrame && view())
895         view()->setParentVisible(false);
896
897     setView(nullptr);
898
899     RefPtr<FrameView> frameView;
900     if (isMainFrame) {
901         frameView = FrameView::create(*this, viewportSize);
902         frameView->setFixedLayoutSize(fixedLayoutSize);
903 #if USE(COORDINATED_GRAPHICS)
904         frameView->setFixedVisibleContentRect(fixedVisibleContentRect);
905 #else
906         UNUSED_PARAM(fixedVisibleContentRect);
907 #endif
908         frameView->setUseFixedLayout(useFixedLayout);
909     } else
910         frameView = FrameView::create(*this);
911
912     frameView->setScrollbarModes(horizontalScrollbarMode, verticalScrollbarMode, horizontalLock, verticalLock);
913
914     setView(frameView.copyRef());
915
916     if (backgroundColor.isValid())
917         frameView->updateBackgroundRecursively(backgroundColor, transparent);
918
919     if (isMainFrame)
920         frameView->setParentVisible(true);
921
922     if (ownerRenderer())
923         ownerRenderer()->setWidget(frameView);
924
925     if (HTMLFrameOwnerElement* owner = ownerElement())
926         view()->setCanHaveScrollbars(owner->scrollingMode() != ScrollbarAlwaysOff);
927 }
928
929 String Frame::layerTreeAsText(LayerTreeFlags flags) const
930 {
931     document()->updateLayout();
932
933     if (!contentRenderer())
934         return String();
935
936     return contentRenderer()->compositor().layerTreeAsText(flags);
937 }
938
939 String Frame::trackedRepaintRectsAsText() const
940 {
941     if (!m_view)
942         return String();
943     return m_view->trackedRepaintRectsAsText();
944 }
945
946 void Frame::setPageZoomFactor(float factor)
947 {
948     setPageAndTextZoomFactors(factor, m_textZoomFactor);
949 }
950
951 void Frame::setTextZoomFactor(float factor)
952 {
953     setPageAndTextZoomFactors(m_pageZoomFactor, factor);
954 }
955
956 void Frame::setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor)
957 {
958     if (m_pageZoomFactor == pageZoomFactor && m_textZoomFactor == textZoomFactor)
959         return;
960
961     Page* page = this->page();
962     if (!page)
963         return;
964
965     Document* document = this->document();
966     if (!document)
967         return;
968
969     m_editor->dismissCorrectionPanelAsIgnored();
970
971     // Respect SVGs zoomAndPan="disabled" property in standalone SVG documents.
972     // FIXME: How to handle compound documents + zoomAndPan="disabled"? Needs SVG WG clarification.
973     if (is<SVGDocument>(*document) && !downcast<SVGDocument>(*document).zoomAndPanEnabled())
974         return;
975
976     if (m_pageZoomFactor != pageZoomFactor) {
977         if (FrameView* view = this->view()) {
978             // Update the scroll position when doing a full page zoom, so the content stays in relatively the same position.
979             LayoutPoint scrollPosition = view->scrollPosition();
980             float percentDifference = (pageZoomFactor / m_pageZoomFactor);
981             view->setScrollPosition(IntPoint(scrollPosition.x() * percentDifference, scrollPosition.y() * percentDifference));
982         }
983     }
984
985     m_pageZoomFactor = pageZoomFactor;
986     m_textZoomFactor = textZoomFactor;
987
988     document->resolveStyle(Document::ResolveStyleType::Rebuild);
989
990     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
991         child->setPageAndTextZoomFactors(m_pageZoomFactor, m_textZoomFactor);
992
993     if (FrameView* view = this->view()) {
994         if (document->renderView() && document->renderView()->needsLayout() && view->didFirstLayout())
995             view->layoutContext().layout();
996     }
997 }
998
999 float Frame::frameScaleFactor() const
1000 {
1001     Page* page = this->page();
1002
1003     // Main frame is scaled with respect to he container but inner frames are not scaled with respect to the main frame.
1004     if (!page || &page->mainFrame() != this || settings().delegatesPageScaling())
1005         return 1;
1006
1007     return page->pageScaleFactor();
1008 }
1009
1010 void Frame::suspendActiveDOMObjectsAndAnimations()
1011 {
1012     bool wasSuspended = activeDOMObjectsAndAnimationsSuspended();
1013
1014     m_activeDOMObjectsAndAnimationsSuspendedCount++;
1015
1016     if (wasSuspended)
1017         return;
1018
1019     // FIXME: Suspend/resume calls will not match if the frame is navigated, and gets a new document.
1020     clearTimers(); // Suspends animations and pending relayouts.
1021     if (m_doc)
1022         m_doc->suspendScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
1023 }
1024
1025 void Frame::resumeActiveDOMObjectsAndAnimations()
1026 {
1027     if (!activeDOMObjectsAndAnimationsSuspended())
1028         return;
1029
1030     m_activeDOMObjectsAndAnimationsSuspendedCount--;
1031
1032     if (activeDOMObjectsAndAnimationsSuspended())
1033         return;
1034
1035     if (!m_doc)
1036         return;
1037
1038     // FIXME: Suspend/resume calls will not match if the frame is navigated, and gets a new document.
1039     m_doc->resumeScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
1040
1041     // Frame::clearTimers() suspended animations and pending relayouts.
1042     animation().resumeAnimationsForDocument(m_doc.get());
1043     if (m_view)
1044         m_view->layoutContext().scheduleLayout();
1045 }
1046
1047 void Frame::deviceOrPageScaleFactorChanged()
1048 {
1049     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
1050         child->deviceOrPageScaleFactorChanged();
1051
1052     if (RenderView* root = contentRenderer())
1053         root->compositor().deviceOrPageScaleFactorChanged();
1054 }
1055
1056 bool Frame::isURLAllowed(const URL& url) const
1057 {
1058     // We allow one level of self-reference because some sites depend on that,
1059     // but we don't allow more than one.
1060     if (m_page->subframeCount() >= Page::maxNumberOfFrames)
1061         return false;
1062     bool foundSelfReference = false;
1063     for (const Frame* frame = this; frame; frame = frame->tree().parent()) {
1064         if (equalIgnoringFragmentIdentifier(frame->document()->url(), url)) {
1065             if (foundSelfReference)
1066                 return false;
1067             foundSelfReference = true;
1068         }
1069     }
1070     return true;
1071 }
1072
1073 bool Frame::isAlwaysOnLoggingAllowed() const
1074 {
1075     return page() && page()->isAlwaysOnLoggingAllowed();
1076 }
1077
1078 } // namespace WebCore