[Attachment Support] Provide the `src` of an attachment to the UI delegate when an...
[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 ENABLE(ATTACHMENT_ELEMENT)
288     if (m_doc) {
289         for (auto& attachment : m_doc->attachmentElementsByIdentifier().values())
290             editor().didRemoveAttachmentElement(attachment);
291     }
292 #endif
293
294     if (m_doc && m_doc->pageCacheState() != Document::InPageCache)
295         m_doc->prepareForDestruction();
296
297     m_doc = newDocument.copyRef();
298     ASSERT(!m_doc || m_doc->domWindow());
299     ASSERT(!m_doc || m_doc->domWindow()->frame() == this);
300
301     // Don't use m_doc because it can be overwritten and we want to guarantee
302     // that the document is not destroyed during this function call.
303     if (newDocument)
304         newDocument->didBecomeCurrentDocumentInFrame();
305
306 #if ENABLE(ATTACHMENT_ELEMENT)
307     if (m_doc) {
308         for (auto& attachment : m_doc->attachmentElementsByIdentifier().values())
309             editor().didInsertAttachmentElement(attachment);
310     }
311 #endif
312
313     InspectorInstrumentation::frameDocumentUpdated(*this);
314
315     m_documentIsBeingReplaced = false;
316 }
317
318 #if ENABLE(ORIENTATION_EVENTS)
319 void Frame::orientationChanged()
320 {
321     Vector<Ref<Frame>> frames;
322     for (Frame* frame = this; frame; frame = frame->tree().traverseNext())
323         frames.append(*frame);
324
325     auto newOrientation = orientation();
326     for (auto& frame : frames) {
327         if (Document* document = frame->document())
328             document->orientationChanged(newOrientation);
329     }
330 }
331
332 int Frame::orientation() const
333 {
334     if (m_page)
335         return m_page->chrome().client().deviceOrientation();
336     return 0;
337 }
338 #endif // ENABLE(ORIENTATION_EVENTS)
339
340 static JSC::Yarr::RegularExpression createRegExpForLabels(const Vector<String>& labels)
341 {
342     // REVIEW- version of this call in FrameMac.mm caches based on the NSArray ptrs being
343     // the same across calls.  We can't do that.
344
345     static NeverDestroyed<JSC::Yarr::RegularExpression> wordRegExp("\\w");
346     StringBuilder pattern;
347     pattern.append('(');
348     unsigned int numLabels = labels.size();
349     unsigned int i;
350     for (i = 0; i < numLabels; i++) {
351         String label = labels[i];
352
353         bool startsWithWordChar = false;
354         bool endsWithWordChar = false;
355         if (label.length()) {
356             startsWithWordChar = wordRegExp.get().match(label.substring(0, 1)) >= 0;
357             endsWithWordChar = wordRegExp.get().match(label.substring(label.length() - 1, 1)) >= 0;
358         }
359
360         if (i)
361             pattern.append('|');
362         // Search for word boundaries only if label starts/ends with "word characters".
363         // If we always searched for word boundaries, this wouldn't work for languages
364         // such as Japanese.
365         if (startsWithWordChar)
366             pattern.appendLiteral("\\b");
367         pattern.append(label);
368         if (endsWithWordChar)
369             pattern.appendLiteral("\\b");
370     }
371     pattern.append(')');
372     return JSC::Yarr::RegularExpression(pattern.toString(), JSC::Yarr::TextCaseInsensitive);
373 }
374
375 String Frame::searchForLabelsAboveCell(const JSC::Yarr::RegularExpression& regExp, HTMLTableCellElement* cell, size_t* resultDistanceFromStartOfCell)
376 {
377     HTMLTableCellElement* aboveCell = cell->cellAbove();
378     if (aboveCell) {
379         // search within the above cell we found for a match
380         size_t lengthSearched = 0;    
381         for (Text* textNode = TextNodeTraversal::firstWithin(*aboveCell); textNode; textNode = TextNodeTraversal::next(*textNode, aboveCell)) {
382             if (!textNode->renderer() || textNode->renderer()->style().visibility() != VISIBLE)
383                 continue;
384             // For each text chunk, run the regexp
385             String nodeString = textNode->data();
386             int pos = regExp.searchRev(nodeString);
387             if (pos >= 0) {
388                 if (resultDistanceFromStartOfCell)
389                     *resultDistanceFromStartOfCell = lengthSearched;
390                 return nodeString.substring(pos, regExp.matchedLength());
391             }
392             lengthSearched += nodeString.length();
393         }
394     }
395
396     // Any reason in practice to search all cells in that are above cell?
397     if (resultDistanceFromStartOfCell)
398         *resultDistanceFromStartOfCell = notFound;
399     return String();
400 }
401
402 // FIXME: This should take an Element&.
403 String Frame::searchForLabelsBeforeElement(const Vector<String>& labels, Element* element, size_t* resultDistance, bool* resultIsInCellAbove)
404 {
405     ASSERT(element);
406     JSC::Yarr::RegularExpression regExp = createRegExpForLabels(labels);
407     // We stop searching after we've seen this many chars
408     const unsigned int charsSearchedThreshold = 500;
409     // This is the absolute max we search.  We allow a little more slop than
410     // charsSearchedThreshold, to make it more likely that we'll search whole nodes.
411     const unsigned int maxCharsSearched = 600;
412     // If the starting element is within a table, the cell that contains it
413     HTMLTableCellElement* startingTableCell = nullptr;
414     bool searchedCellAbove = false;
415
416     if (resultDistance)
417         *resultDistance = notFound;
418     if (resultIsInCellAbove)
419         *resultIsInCellAbove = false;
420     
421     // walk backwards in the node tree, until another element, or form, or end of tree
422     int unsigned lengthSearched = 0;
423     Node* n;
424     for (n = NodeTraversal::previous(*element); n && lengthSearched < charsSearchedThreshold; n = NodeTraversal::previous(*n)) {
425         // We hit another form element or the start of the form - bail out
426         if (is<HTMLFormElement>(*n) || is<HTMLFormControlElement>(*n))
427             break;
428
429         if (n->hasTagName(tdTag) && !startingTableCell)
430             startingTableCell = downcast<HTMLTableCellElement>(n);
431         else if (is<HTMLTableRowElement>(*n) && startingTableCell) {
432             String result = searchForLabelsAboveCell(regExp, startingTableCell, resultDistance);
433             if (!result.isEmpty()) {
434                 if (resultIsInCellAbove)
435                     *resultIsInCellAbove = true;
436                 return result;
437             }
438             searchedCellAbove = true;
439         } else if (n->isTextNode() && n->renderer() && n->renderer()->style().visibility() == VISIBLE) {
440             // For each text chunk, run the regexp
441             String nodeString = n->nodeValue();
442             // add 100 for slop, to make it more likely that we'll search whole nodes
443             if (lengthSearched + nodeString.length() > maxCharsSearched)
444                 nodeString = nodeString.right(charsSearchedThreshold - lengthSearched);
445             int pos = regExp.searchRev(nodeString);
446             if (pos >= 0) {
447                 if (resultDistance)
448                     *resultDistance = lengthSearched;
449                 return nodeString.substring(pos, regExp.matchedLength());
450             }
451             lengthSearched += nodeString.length();
452         }
453     }
454
455     // If we started in a cell, but bailed because we found the start of the form or the
456     // previous element, we still might need to search the row above us for a label.
457     if (startingTableCell && !searchedCellAbove) {
458         String result = searchForLabelsAboveCell(regExp, startingTableCell, resultDistance);
459         if (!result.isEmpty()) {
460             if (resultIsInCellAbove)
461                 *resultIsInCellAbove = true;
462             return result;
463         }
464     }
465     return String();
466 }
467
468 static String matchLabelsAgainstString(const Vector<String>& labels, const String& stringToMatch)
469 {
470     if (stringToMatch.isEmpty())
471         return String();
472
473     String mutableStringToMatch = stringToMatch;
474
475     // Make numbers and _'s in field names behave like word boundaries, e.g., "address2"
476     replace(mutableStringToMatch, JSC::Yarr::RegularExpression("\\d"), " ");
477     mutableStringToMatch.replace('_', ' ');
478     
479     JSC::Yarr::RegularExpression regExp = createRegExpForLabels(labels);
480     // Use the largest match we can find in the whole string
481     int pos;
482     int length;
483     int bestPos = -1;
484     int bestLength = -1;
485     int start = 0;
486     do {
487         pos = regExp.match(mutableStringToMatch, start);
488         if (pos != -1) {
489             length = regExp.matchedLength();
490             if (length >= bestLength) {
491                 bestPos = pos;
492                 bestLength = length;
493             }
494             start = pos + 1;
495         }
496     } while (pos != -1);
497     
498     if (bestPos != -1)
499         return mutableStringToMatch.substring(bestPos, bestLength);
500     return String();
501 }
502     
503 String Frame::matchLabelsAgainstElement(const Vector<String>& labels, Element* element)
504 {
505     // Match against the name element, then against the id element if no match is found for the name element.
506     // See 7538330 for one popular site that benefits from the id element check.
507     // FIXME: This code is mirrored in FrameMac.mm. It would be nice to make the Mac code call the platform-agnostic
508     // code, which would require converting the NSArray of NSStrings to a Vector of Strings somewhere along the way.
509     String resultFromNameAttribute = matchLabelsAgainstString(labels, element->getNameAttribute());
510     if (!resultFromNameAttribute.isEmpty())
511         return resultFromNameAttribute;
512     
513     return matchLabelsAgainstString(labels, element->attributeWithoutSynchronization(idAttr));
514 }
515
516 #if PLATFORM(IOS)
517 void Frame::scrollOverflowLayer(RenderLayer* layer, const IntRect& visibleRect, const IntRect& exposeRect)
518 {
519     if (!layer)
520         return;
521
522     RenderBox* box = layer->renderBox();
523     if (!box)
524         return;
525
526     if (visibleRect.intersects(exposeRect))
527         return;
528
529     // FIXME: Why isn't this just calling RenderLayer::scrollRectToVisible()?
530     ScrollOffset scrollOffset = layer->scrollOffset();
531     int exposeLeft = exposeRect.x();
532     int exposeRight = exposeLeft + exposeRect.width();
533     int clientWidth = roundToInt(box->clientWidth());
534     if (exposeLeft <= 0)
535         scrollOffset.setX(std::max(0, scrollOffset.x() + exposeLeft - clientWidth / 2));
536     else if (exposeRight >= clientWidth)
537         scrollOffset.setX(std::min(box->scrollWidth() - clientWidth, scrollOffset.x() + clientWidth / 2));
538
539     int exposeTop = exposeRect.y();
540     int exposeBottom = exposeTop + exposeRect.height();
541     int clientHeight = roundToInt(box->clientHeight());
542     if (exposeTop <= 0)
543         scrollOffset.setY(std::max(0, scrollOffset.y() + exposeTop - clientHeight / 2));
544     else if (exposeBottom >= clientHeight)
545         scrollOffset.setY(std::min(box->scrollHeight() - clientHeight, scrollOffset.y() + clientHeight / 2));
546
547     layer->scrollToOffset(scrollOffset, ScrollClamping::Unclamped);
548     selection().setCaretRectNeedsUpdate();
549     selection().updateAppearance();
550 }
551
552 void Frame::overflowAutoScrollTimerFired()
553 {
554     if (!eventHandler().mousePressed() || checkOverflowScroll(PerformOverflowScroll) == OverflowScrollNone) {
555         if (m_overflowAutoScrollTimer.isActive())
556             m_overflowAutoScrollTimer.stop();
557     }
558 }
559
560 void Frame::startOverflowAutoScroll(const IntPoint& mousePosition)
561 {
562     m_overflowAutoScrollPos = mousePosition;
563
564     if (m_overflowAutoScrollTimer.isActive())
565         return;
566
567     if (checkOverflowScroll(DoNotPerformOverflowScroll) == OverflowScrollNone)
568         return;
569
570     m_overflowAutoScrollTimer.startRepeating(scrollFrequency);
571     m_overflowAutoScrollDelta = 3;
572 }
573
574 int Frame::checkOverflowScroll(OverflowScrollAction action)
575 {
576     Position extent = selection().selection().extent();
577     if (extent.isNull())
578         return OverflowScrollNone;
579
580     RenderObject* renderer = extent.deprecatedNode()->renderer();
581     if (!renderer)
582         return OverflowScrollNone;
583
584     FrameView* view = this->view();
585     if (!view)
586         return OverflowScrollNone;
587
588     RenderBlock* containingBlock = renderer->containingBlock();
589     if (!containingBlock || !containingBlock->hasOverflowClip())
590         return OverflowScrollNone;
591     RenderLayer* layer = containingBlock->layer();
592     ASSERT(layer);
593
594     IntRect visibleRect = IntRect(view->scrollX(), view->scrollY(), view->visibleWidth(), view->visibleHeight());
595     IntPoint position = m_overflowAutoScrollPos;
596     if (visibleRect.contains(position.x(), position.y()))
597         return OverflowScrollNone;
598
599     int scrollType = 0;
600     int deltaX = 0;
601     int deltaY = 0;
602     IntPoint selectionPosition;
603
604     // This constant will make the selection draw a little bit beyond the edge of the visible area.
605     // This prevents a visual glitch, in that you can fail to select a portion of a character that
606     // is being rendered right at the edge of the visible rectangle.
607     // FIXME: This probably needs improvement, and may need to take the font size into account.
608     static const int scrollBoundsAdjustment = 3;
609
610     // FIXME: Make a small buffer at the end of a visible rectangle so that autoscrolling works 
611     // even if the visible extends to the limits of the screen.
612     if (position.x() < visibleRect.x()) {
613         scrollType |= OverflowScrollLeft;
614         if (action == PerformOverflowScroll) {
615             deltaX -= static_cast<int>(m_overflowAutoScrollDelta);
616             selectionPosition.setX(view->scrollX() - scrollBoundsAdjustment);
617         }
618     } else if (position.x() > visibleRect.maxX()) {
619         scrollType |= OverflowScrollRight;
620         if (action == PerformOverflowScroll) {
621             deltaX += static_cast<int>(m_overflowAutoScrollDelta);
622             selectionPosition.setX(view->scrollX() + view->visibleWidth() + scrollBoundsAdjustment);
623         }
624     }
625
626     if (position.y() < visibleRect.y()) {
627         scrollType |= OverflowScrollUp;
628         if (action == PerformOverflowScroll) {
629             deltaY -= static_cast<int>(m_overflowAutoScrollDelta);
630             selectionPosition.setY(view->scrollY() - scrollBoundsAdjustment);
631         }
632     } else if (position.y() > visibleRect.maxY()) {
633         scrollType |= OverflowScrollDown;
634         if (action == PerformOverflowScroll) {
635             deltaY += static_cast<int>(m_overflowAutoScrollDelta);
636             selectionPosition.setY(view->scrollY() + view->visibleHeight() + scrollBoundsAdjustment);
637         }
638     }
639
640     Ref<Frame> protectedThis(*this);
641
642     if (action == PerformOverflowScroll && (deltaX || deltaY)) {
643         layer->scrollToOffset(layer->scrollOffset() + IntSize(deltaX, deltaY), ScrollClamping::Unclamped);
644
645         // Handle making selection.
646         VisiblePosition visiblePosition(renderer->positionForPoint(selectionPosition, nullptr));
647         if (visiblePosition.isNotNull()) {
648             VisibleSelection visibleSelection = selection().selection();
649             visibleSelection.setExtent(visiblePosition);
650             if (selection().granularity() != CharacterGranularity)
651                 visibleSelection.expandUsingGranularity(selection().granularity());
652             if (selection().shouldChangeSelection(visibleSelection))
653                 selection().setSelection(visibleSelection);
654         }
655
656         m_overflowAutoScrollDelta *= 1.02f; // Accelerate the scroll
657     }
658     return scrollType;
659 }
660
661 void Frame::setSelectionChangeCallbacksDisabled(bool selectionChangeCallbacksDisabled)
662 {
663     m_selectionChangeCallbacksDisabled = selectionChangeCallbacksDisabled;
664 }
665
666 bool Frame::selectionChangeCallbacksDisabled() const
667 {
668     return m_selectionChangeCallbacksDisabled;
669 }
670 #endif // PLATFORM(IOS)
671
672 void Frame::setPrinting(bool printing, const FloatSize& pageSize, const FloatSize& originalPageSize, float maximumShrinkRatio, AdjustViewSizeOrNot shouldAdjustViewSize)
673 {
674     // In setting printing, we should not validate resources already cached for the document.
675     // See https://bugs.webkit.org/show_bug.cgi?id=43704
676     ResourceCacheValidationSuppressor validationSuppressor(m_doc->cachedResourceLoader());
677
678     m_doc->setPrinting(printing);
679     if (auto* frameView = view()) {
680         frameView->adjustMediaTypeForPrinting(printing);
681
682         m_doc->styleScope().didChangeStyleSheetEnvironment();
683         if (shouldUsePrintingLayout())
684             frameView->forceLayoutForPagination(pageSize, originalPageSize, maximumShrinkRatio, shouldAdjustViewSize);
685         else {
686             frameView->forceLayout();
687             if (shouldAdjustViewSize == AdjustViewSize)
688                 frameView->adjustViewSize();
689         }
690     }
691
692     // Subframes of the one we're printing don't lay out to the page size.
693     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
694         child->setPrinting(printing, FloatSize(), FloatSize(), 0, shouldAdjustViewSize);
695 }
696
697 bool Frame::shouldUsePrintingLayout() const
698 {
699     // Only top frame being printed should be fit to page size.
700     // Subframes should be constrained by parents only.
701     return m_doc->printing() && (!tree().parent() || !tree().parent()->m_doc->printing());
702 }
703
704 FloatSize Frame::resizePageRectsKeepingRatio(const FloatSize& originalSize, const FloatSize& expectedSize)
705 {
706     FloatSize resultSize;
707     if (!contentRenderer())
708         return FloatSize();
709
710     if (contentRenderer()->style().isHorizontalWritingMode()) {
711         ASSERT(fabs(originalSize.width()) > std::numeric_limits<float>::epsilon());
712         float ratio = originalSize.height() / originalSize.width();
713         resultSize.setWidth(floorf(expectedSize.width()));
714         resultSize.setHeight(floorf(resultSize.width() * ratio));
715     } else {
716         ASSERT(fabs(originalSize.height()) > std::numeric_limits<float>::epsilon());
717         float ratio = originalSize.width() / originalSize.height();
718         resultSize.setHeight(floorf(expectedSize.height()));
719         resultSize.setWidth(floorf(resultSize.height() * ratio));
720     }
721     return resultSize;
722 }
723
724 void Frame::injectUserScripts(UserScriptInjectionTime injectionTime)
725 {
726     if (!m_page)
727         return;
728
729     if (loader().stateMachine().creatingInitialEmptyDocument() && !settings().shouldInjectUserScriptsInInitialEmptyDocument())
730         return;
731
732     m_page->userContentProvider().forEachUserScript([this, protectedThis = makeRef(*this), injectionTime](DOMWrapperWorld& world, const UserScript& script) {
733         auto* document = this->document();
734         if (!document)
735             return;
736         if (script.injectedFrames() == InjectInTopFrameOnly && ownerElement())
737             return;
738
739         if (script.injectionTime() == injectionTime && UserContentURLPattern::matchesPatterns(document->url(), script.whitelist(), script.blacklist())) {
740             if (m_page)
741                 m_page->setAsRunningUserScripts();
742             m_script->evaluateInWorld(ScriptSourceCode(script.source(), script.url()), world);
743         }
744     });
745 }
746
747 RenderView* Frame::contentRenderer() const
748 {
749     return document() ? document()->renderView() : nullptr;
750 }
751
752 RenderWidget* Frame::ownerRenderer() const
753 {
754     auto* ownerElement = m_ownerElement;
755     if (!ownerElement)
756         return nullptr;
757     auto* object = ownerElement->renderer();
758     // FIXME: If <object> is ever fixed to disassociate itself from frames
759     // that it has started but canceled, then this can turn into an ASSERT
760     // since m_ownerElement would be nullptr when the load is canceled.
761     // https://bugs.webkit.org/show_bug.cgi?id=18585
762     if (!is<RenderWidget>(object))
763         return nullptr;
764     return downcast<RenderWidget>(object);
765 }
766
767 Frame* Frame::frameForWidget(const Widget& widget)
768 {
769     if (auto* renderer = RenderWidget::find(widget))
770         return renderer->frameOwnerElement().document().frame();
771
772     // Assume all widgets are either a FrameView or owned by a RenderWidget.
773     // FIXME: That assumption is not right for scroll bars!
774     return &downcast<FrameView>(widget).frame();
775 }
776
777 void Frame::clearTimers(FrameView *view, Document *document)
778 {
779     if (view) {
780         view->layoutContext().unscheduleLayout();
781         view->frame().animation().suspendAnimationsForDocument(document);
782         view->frame().eventHandler().stopAutoscrollTimer();
783     }
784 }
785
786 void Frame::clearTimers()
787 {
788     clearTimers(m_view.get(), document());
789 }
790
791 void Frame::willDetachPage()
792 {
793     if (Frame* parent = tree().parent())
794         parent->loader().checkLoadComplete();
795
796     for (auto& observer : m_destructionObservers)
797         observer->willDetachPage();
798
799     // FIXME: It's unclear as to why this is called more than once, but it is,
800     // so page() could be NULL.
801     if (page() && page()->focusController().focusedFrame() == this)
802         page()->focusController().setFocusedFrame(nullptr);
803
804     if (page() && page()->scrollingCoordinator() && m_view)
805         page()->scrollingCoordinator()->willDestroyScrollableArea(*m_view);
806
807 #if PLATFORM(IOS)
808     if (WebThreadCountOfObservedContentModifiers() > 0 && m_page)
809         m_page->chrome().client().clearContentChangeObservers(*this);
810 #endif
811
812     script().clearScriptObjects();
813     script().updatePlatformScriptObjects();
814
815     // We promise that the Frame is always connected to a Page while the render tree is live.
816     //
817     // The render tree can be torn down in a few different ways, but the two important ones are:
818     //
819     // - When calling Frame::setView() with a null FrameView*. This is always done before calling
820     //   Frame::willDetachPage (this function.) Hence the assertion below.
821     //
822     // - When adding a document to the page cache, the tree is torn down before instantiating
823     //   the CachedPage+CachedFrame object tree.
824     ASSERT(!document() || !document()->renderView());
825 }
826
827 void Frame::disconnectOwnerElement()
828 {
829     if (m_ownerElement) {
830         m_ownerElement->clearContentFrame();
831         if (m_page)
832             m_page->decrementSubframeCount();
833     }
834     m_ownerElement = nullptr;
835 }
836
837 String Frame::displayStringModifiedByEncoding(const String& str) const
838 {
839     return document() ? document()->displayStringModifiedByEncoding(str) : str;
840 }
841
842 VisiblePosition Frame::visiblePositionForPoint(const IntPoint& framePoint) const
843 {
844     HitTestResult result = eventHandler().hitTestResultAtPoint(framePoint, HitTestRequest::ReadOnly | HitTestRequest::Active);
845     Node* node = result.innerNonSharedNode();
846     if (!node)
847         return VisiblePosition();
848     auto renderer = node->renderer();
849     if (!renderer)
850         return VisiblePosition();
851     VisiblePosition visiblePos = renderer->positionForPoint(result.localPoint(), nullptr);
852     if (visiblePos.isNull())
853         visiblePos = firstPositionInOrBeforeNode(node);
854     return visiblePos;
855 }
856
857 Document* Frame::documentAtPoint(const IntPoint& point)
858 {
859     if (!view())
860         return nullptr;
861
862     IntPoint pt = view()->windowToContents(point);
863     HitTestResult result = HitTestResult(pt);
864
865     if (contentRenderer())
866         result = eventHandler().hitTestResultAtPoint(pt);
867     return result.innerNode() ? &result.innerNode()->document() : 0;
868 }
869
870 RefPtr<Range> Frame::rangeForPoint(const IntPoint& framePoint)
871 {
872     VisiblePosition position = visiblePositionForPoint(framePoint);
873     if (position.isNull())
874         return nullptr;
875
876     Position deepPosition = position.deepEquivalent();
877     Text* containerText = deepPosition.containerText();
878     if (!containerText || !containerText->renderer() || containerText->renderer()->style().userSelect() == SELECT_NONE)
879         return nullptr;
880
881     VisiblePosition previous = position.previous();
882     if (previous.isNotNull()) {
883         RefPtr<Range> previousCharacterRange = makeRange(previous, position);
884         LayoutRect rect = editor().firstRectForRange(previousCharacterRange.get());
885         if (rect.contains(framePoint))
886             return previousCharacterRange;
887     }
888
889     VisiblePosition next = position.next();
890     if (RefPtr<Range> nextCharacterRange = makeRange(position, next)) {
891         LayoutRect rect = editor().firstRectForRange(nextCharacterRange.get());
892         if (rect.contains(framePoint))
893             return nextCharacterRange;
894     }
895
896     return nullptr;
897 }
898
899 void Frame::createView(const IntSize& viewportSize, const Color& backgroundColor, bool transparent,
900     const IntSize& fixedLayoutSize, const IntRect& fixedVisibleContentRect,
901     bool useFixedLayout, ScrollbarMode horizontalScrollbarMode, bool horizontalLock,
902     ScrollbarMode verticalScrollbarMode, bool verticalLock)
903 {
904     ASSERT(m_page);
905
906     bool isMainFrame = this->isMainFrame();
907
908     if (isMainFrame && view())
909         view()->setParentVisible(false);
910
911     setView(nullptr);
912
913     RefPtr<FrameView> frameView;
914     if (isMainFrame) {
915         frameView = FrameView::create(*this, viewportSize);
916         frameView->setFixedLayoutSize(fixedLayoutSize);
917 #if USE(COORDINATED_GRAPHICS)
918         frameView->setFixedVisibleContentRect(fixedVisibleContentRect);
919 #else
920         UNUSED_PARAM(fixedVisibleContentRect);
921 #endif
922         frameView->setUseFixedLayout(useFixedLayout);
923     } else
924         frameView = FrameView::create(*this);
925
926     frameView->setScrollbarModes(horizontalScrollbarMode, verticalScrollbarMode, horizontalLock, verticalLock);
927
928     setView(frameView.copyRef());
929
930     if (backgroundColor.isValid())
931         frameView->updateBackgroundRecursively(backgroundColor, transparent);
932
933     if (isMainFrame)
934         frameView->setParentVisible(true);
935
936     if (ownerRenderer())
937         ownerRenderer()->setWidget(frameView);
938
939     if (HTMLFrameOwnerElement* owner = ownerElement())
940         view()->setCanHaveScrollbars(owner->scrollingMode() != ScrollbarAlwaysOff);
941 }
942
943 String Frame::layerTreeAsText(LayerTreeFlags flags) const
944 {
945     document()->updateLayout();
946
947     if (!contentRenderer())
948         return String();
949
950     return contentRenderer()->compositor().layerTreeAsText(flags);
951 }
952
953 String Frame::trackedRepaintRectsAsText() const
954 {
955     if (!m_view)
956         return String();
957     return m_view->trackedRepaintRectsAsText();
958 }
959
960 void Frame::setPageZoomFactor(float factor)
961 {
962     setPageAndTextZoomFactors(factor, m_textZoomFactor);
963 }
964
965 void Frame::setTextZoomFactor(float factor)
966 {
967     setPageAndTextZoomFactors(m_pageZoomFactor, factor);
968 }
969
970 void Frame::setPageAndTextZoomFactors(float pageZoomFactor, float textZoomFactor)
971 {
972     if (m_pageZoomFactor == pageZoomFactor && m_textZoomFactor == textZoomFactor)
973         return;
974
975     Page* page = this->page();
976     if (!page)
977         return;
978
979     Document* document = this->document();
980     if (!document)
981         return;
982
983     m_editor->dismissCorrectionPanelAsIgnored();
984
985     // Respect SVGs zoomAndPan="disabled" property in standalone SVG documents.
986     // FIXME: How to handle compound documents + zoomAndPan="disabled"? Needs SVG WG clarification.
987     if (is<SVGDocument>(*document) && !downcast<SVGDocument>(*document).zoomAndPanEnabled())
988         return;
989
990     if (m_pageZoomFactor != pageZoomFactor) {
991         if (FrameView* view = this->view()) {
992             // Update the scroll position when doing a full page zoom, so the content stays in relatively the same position.
993             LayoutPoint scrollPosition = view->scrollPosition();
994             float percentDifference = (pageZoomFactor / m_pageZoomFactor);
995             view->setScrollPosition(IntPoint(scrollPosition.x() * percentDifference, scrollPosition.y() * percentDifference));
996         }
997     }
998
999     m_pageZoomFactor = pageZoomFactor;
1000     m_textZoomFactor = textZoomFactor;
1001
1002     document->resolveStyle(Document::ResolveStyleType::Rebuild);
1003
1004     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
1005         child->setPageAndTextZoomFactors(m_pageZoomFactor, m_textZoomFactor);
1006
1007     if (FrameView* view = this->view()) {
1008         if (document->renderView() && document->renderView()->needsLayout() && view->didFirstLayout())
1009             view->layoutContext().layout();
1010     }
1011 }
1012
1013 float Frame::frameScaleFactor() const
1014 {
1015     Page* page = this->page();
1016
1017     // Main frame is scaled with respect to he container but inner frames are not scaled with respect to the main frame.
1018     if (!page || &page->mainFrame() != this || settings().delegatesPageScaling())
1019         return 1;
1020
1021     return page->pageScaleFactor();
1022 }
1023
1024 void Frame::suspendActiveDOMObjectsAndAnimations()
1025 {
1026     bool wasSuspended = activeDOMObjectsAndAnimationsSuspended();
1027
1028     m_activeDOMObjectsAndAnimationsSuspendedCount++;
1029
1030     if (wasSuspended)
1031         return;
1032
1033     // FIXME: Suspend/resume calls will not match if the frame is navigated, and gets a new document.
1034     clearTimers(); // Suspends animations and pending relayouts.
1035     if (m_doc)
1036         m_doc->suspendScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
1037 }
1038
1039 void Frame::resumeActiveDOMObjectsAndAnimations()
1040 {
1041     if (!activeDOMObjectsAndAnimationsSuspended())
1042         return;
1043
1044     m_activeDOMObjectsAndAnimationsSuspendedCount--;
1045
1046     if (activeDOMObjectsAndAnimationsSuspended())
1047         return;
1048
1049     if (!m_doc)
1050         return;
1051
1052     // FIXME: Suspend/resume calls will not match if the frame is navigated, and gets a new document.
1053     m_doc->resumeScheduledTasks(ActiveDOMObject::PageWillBeSuspended);
1054
1055     // Frame::clearTimers() suspended animations and pending relayouts.
1056     animation().resumeAnimationsForDocument(m_doc.get());
1057     if (m_view)
1058         m_view->layoutContext().scheduleLayout();
1059 }
1060
1061 void Frame::deviceOrPageScaleFactorChanged()
1062 {
1063     for (RefPtr<Frame> child = tree().firstChild(); child; child = child->tree().nextSibling())
1064         child->deviceOrPageScaleFactorChanged();
1065
1066     if (RenderView* root = contentRenderer())
1067         root->compositor().deviceOrPageScaleFactorChanged();
1068 }
1069
1070 bool Frame::isURLAllowed(const URL& url) const
1071 {
1072     // We allow one level of self-reference because some sites depend on that,
1073     // but we don't allow more than one.
1074     if (m_page->subframeCount() >= Page::maxNumberOfFrames)
1075         return false;
1076     bool foundSelfReference = false;
1077     for (const Frame* frame = this; frame; frame = frame->tree().parent()) {
1078         if (equalIgnoringFragmentIdentifier(frame->document()->url(), url)) {
1079             if (foundSelfReference)
1080                 return false;
1081             foundSelfReference = true;
1082         }
1083     }
1084     return true;
1085 }
1086
1087 bool Frame::isAlwaysOnLoggingAllowed() const
1088 {
1089     return page() && page()->isAlwaysOnLoggingAllowed();
1090 }
1091
1092 } // namespace WebCore