b1ee9c4c22ca4f3089ba71c5f0edf935cbf2bf84
[WebKit-https.git] / Source / WebCore / html / HTMLBodyElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Simon Hausmann (hausmann@kde.org)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2004-2017 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  */
23
24 #include "config.h"
25 #include "HTMLBodyElement.h"
26
27 #include "CSSImageValue.h"
28 #include "CSSParser.h"
29 #include "CSSValueKeywords.h"
30 #include "DOMWindow.h"
31 #include "DOMWrapperWorld.h"
32 #include "EventNames.h"
33 #include "Frame.h"
34 #include "FrameView.h"
35 #include "HTMLFrameElement.h"
36 #include "HTMLIFrameElement.h"
37 #include "HTMLNames.h"
38 #include "HTMLParserIdioms.h"
39 #include "StyleProperties.h"
40 #include <wtf/NeverDestroyed.h>
41
42 namespace WebCore {
43
44 using namespace HTMLNames;
45
46 HTMLBodyElement::HTMLBodyElement(const QualifiedName& tagName, Document& document)
47     : HTMLElement(tagName, document)
48 {
49     ASSERT(hasTagName(bodyTag));
50 }
51
52 bool HTMLBodyElement::isFirstBodyElementOfDocument() const
53 {
54     // By spec http://dev.w3.org/csswg/cssom-view/#the-html-body-element
55     // "The HTML body element is the first body HTML element child of the root HTML element html."
56     return document().body() == this;
57 }
58
59 Ref<HTMLBodyElement> HTMLBodyElement::create(Document& document)
60 {
61     return adoptRef(*new HTMLBodyElement(bodyTag, document));
62 }
63
64 Ref<HTMLBodyElement> HTMLBodyElement::create(const QualifiedName& tagName, Document& document)
65 {
66     return adoptRef(*new HTMLBodyElement(tagName, document));
67 }
68
69 HTMLBodyElement::~HTMLBodyElement()
70 {
71 }
72
73 bool HTMLBodyElement::isPresentationAttribute(const QualifiedName& name) const
74 {
75     if (name == backgroundAttr || name == marginwidthAttr || name == leftmarginAttr || name == marginheightAttr || name == topmarginAttr || name == bgcolorAttr || name == textAttr || name == bgpropertiesAttr)
76         return true;
77     return HTMLElement::isPresentationAttribute(name);
78 }
79
80 void HTMLBodyElement::collectStyleForPresentationAttribute(const QualifiedName& name, const AtomicString& value, MutableStyleProperties& style)
81 {
82     if (name == backgroundAttr) {
83         String url = stripLeadingAndTrailingHTMLSpaces(value);
84         if (!url.isEmpty()) {
85             auto imageValue = CSSImageValue::create(document().completeURL(url));
86             imageValue.get().setInitiator(localName());
87             style.setProperty(CSSProperty(CSSPropertyBackgroundImage, WTFMove(imageValue)));
88         }
89     } else if (name == marginwidthAttr || name == leftmarginAttr) {
90         addHTMLLengthToStyle(style, CSSPropertyMarginRight, value);
91         addHTMLLengthToStyle(style, CSSPropertyMarginLeft, value);
92     } else if (name == marginheightAttr || name == topmarginAttr) {
93         addHTMLLengthToStyle(style, CSSPropertyMarginBottom, value);
94         addHTMLLengthToStyle(style, CSSPropertyMarginTop, value);
95     } else if (name == bgcolorAttr) {
96         addHTMLColorToStyle(style, CSSPropertyBackgroundColor, value);
97     } else if (name == textAttr) {
98         addHTMLColorToStyle(style, CSSPropertyColor, value);
99     } else if (name == bgpropertiesAttr) {
100         if (equalLettersIgnoringASCIICase(value, "fixed"))
101            addPropertyToPresentationAttributeStyle(style, CSSPropertyBackgroundAttachment, CSSValueFixed);
102     } else
103         HTMLElement::collectStyleForPresentationAttribute(name, value, style);
104 }
105
106 HTMLElement::EventHandlerNameMap HTMLBodyElement::createWindowEventHandlerNameMap()
107 {
108     static const QualifiedName* const table[] = {
109         &onbeforeunloadAttr,
110         &onblurAttr,
111         &onerrorAttr,
112         &onfocusAttr,
113         &onfocusinAttr,
114         &onfocusoutAttr,
115         &onhashchangeAttr,
116         &onlanguagechangeAttr,
117         &onloadAttr,
118         &onmessageAttr,
119         &onofflineAttr,
120         &ononlineAttr,
121         &onorientationchangeAttr,
122         &onpagehideAttr,
123         &onpageshowAttr,
124         &onpopstateAttr,
125         &onresizeAttr,
126         &onscrollAttr,
127         &onstorageAttr,
128         &onunloadAttr,
129         &onwebkitmouseforcechangedAttr,
130         &onwebkitmouseforcedownAttr,
131         &onwebkitmouseforceupAttr,
132         &onwebkitmouseforcewillbeginAttr,
133         &onwebkitwillrevealbottomAttr,
134         &onwebkitwillrevealleftAttr,
135         &onwebkitwillrevealrightAttr,
136         &onwebkitwillrevealtopAttr,
137     };
138
139     EventHandlerNameMap map;
140     populateEventHandlerNameMap(map, table);
141     return map;
142 }
143
144 const AtomicString& HTMLBodyElement::eventNameForWindowEventHandlerAttribute(const QualifiedName& attributeName)
145 {
146     static NeverDestroyed<EventHandlerNameMap> map = createWindowEventHandlerNameMap();
147     return eventNameForEventHandlerAttribute(attributeName, map.get());
148 }
149
150 void HTMLBodyElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
151 {
152     if (name == vlinkAttr || name == alinkAttr || name == linkAttr) {
153         if (value.isNull()) {
154             if (name == linkAttr)
155                 document().resetLinkColor();
156             else if (name == vlinkAttr)
157                 document().resetVisitedLinkColor();
158             else
159                 document().resetActiveLinkColor();
160         } else {
161             Color color = CSSParser::parseColor(value, !document().inQuirksMode());
162             if (color.isValid()) {
163                 if (name == linkAttr)
164                     document().setLinkColor(color);
165                 else if (name == vlinkAttr)
166                     document().setVisitedLinkColor(color);
167                 else
168                     document().setActiveLinkColor(color);
169             }
170         }
171
172         invalidateStyleForSubtree();
173         return;
174     }
175
176     if (name == onselectionchangeAttr) {
177         document().setAttributeEventListener(eventNames().selectionchangeEvent, name, value, mainThreadNormalWorld());
178         return;
179     }
180
181     auto& eventName = eventNameForWindowEventHandlerAttribute(name);
182     if (!eventName.isNull()) {
183         document().setWindowAttributeEventListener(eventName, name, value, mainThreadNormalWorld());
184         return;
185     }
186
187     HTMLElement::parseAttribute(name, value);
188 }
189
190 Node::InsertionNotificationRequest HTMLBodyElement::insertedInto(ContainerNode& insertionPoint)
191 {
192     HTMLElement::insertedInto(insertionPoint);
193     if (!insertionPoint.isConnected())
194         return InsertionDone;
195
196     // FIXME: It's surprising this is web compatible since it means a marginwidth and marginheight attribute can
197     // magically appear on the <body> of all documents embedded through <iframe> or <frame>.
198     // FIXME: Perhaps this code should be in attach() instead of here.
199     auto* ownerElement = document().ownerElement();
200     if (!is<HTMLFrameElementBase>(ownerElement))
201         return InsertionDone;
202     
203     auto& ownerFrameElement = downcast<HTMLFrameElementBase>(*ownerElement);
204
205     // Read values from the owner before setting any attributes, since setting an attribute can run arbitrary
206     // JavaScript, which might delete the owner element.
207     int marginWidth = ownerFrameElement.marginWidth();
208     int marginHeight = ownerFrameElement.marginHeight();
209
210     if (marginWidth != -1)
211         setIntegralAttribute(marginwidthAttr, marginWidth);
212     if (marginHeight != -1)
213         setIntegralAttribute(marginheightAttr, marginHeight);
214
215     return InsertionDone;
216 }
217
218 bool HTMLBodyElement::isURLAttribute(const Attribute& attribute) const
219 {
220     return attribute.name() == backgroundAttr || HTMLElement::isURLAttribute(attribute);
221 }
222
223 bool HTMLBodyElement::supportsFocus() const
224 {
225     return hasEditableStyle() || HTMLElement::supportsFocus();
226 }
227
228 static int adjustForZoom(int value, const Frame& frame)
229 {
230     double zoomFactor = frame.pageZoomFactor() * frame.frameScaleFactor();
231     if (zoomFactor == 1)
232         return value;
233     // Needed because of truncation (rather than rounding) when scaling up.
234     if (zoomFactor > 1)
235         value++;
236     return static_cast<int>(value / zoomFactor);
237 }
238
239 int HTMLBodyElement::scrollLeft()
240 {
241     if (isFirstBodyElementOfDocument()) {
242         document().updateLayoutIgnorePendingStylesheets();
243         Frame* frame = document().frame();
244         if (!frame)
245             return 0;
246         FrameView* view = frame->view();
247         if (!view)
248             return 0;
249         return adjustForZoom(view->contentsScrollPosition().x(), *frame);
250     }
251     return HTMLElement::scrollLeft();
252 }
253
254 void HTMLBodyElement::setScrollLeft(int scrollLeft)
255 {
256     if (isFirstBodyElementOfDocument()) {
257         document().updateLayoutIgnorePendingStylesheets();
258         Frame* frame = document().frame();
259         if (!frame)
260             return;
261         FrameView* view = frame->view();
262         if (!view)
263             return;
264         view->setScrollPosition(IntPoint(static_cast<int>(scrollLeft * frame->pageZoomFactor() * frame->frameScaleFactor()), view->scrollY()));
265     }
266     HTMLElement::setScrollLeft(scrollLeft);
267 }
268
269 int HTMLBodyElement::scrollTop()
270 {
271     if (isFirstBodyElementOfDocument()) {
272         document().updateLayoutIgnorePendingStylesheets();
273         Frame* frame = document().frame();
274         if (!frame)
275             return 0;
276         FrameView* view = frame->view();
277         if (!view)
278             return 0;
279         return adjustForZoom(view->contentsScrollPosition().y(), *frame);
280     }
281     return HTMLElement::scrollTop();
282 }
283
284 void HTMLBodyElement::setScrollTop(int scrollTop)
285 {
286     if (isFirstBodyElementOfDocument()) {
287         document().updateLayoutIgnorePendingStylesheets();
288         Frame* frame = document().frame();
289         if (!frame)
290             return;
291         FrameView* view = frame->view();
292         if (!view)
293             return;
294         view->setScrollPosition(IntPoint(view->scrollX(), static_cast<int>(scrollTop * frame->pageZoomFactor() * frame->frameScaleFactor())));
295     }
296     return HTMLElement::setScrollTop(scrollTop);
297 }
298
299 void HTMLBodyElement::scrollTo(const ScrollToOptions& options)
300 {
301     if (isFirstBodyElementOfDocument()) {
302         // If the element is the HTML body element, document is in quirks mode, and the element is not potentially scrollable,
303         // invoke scroll() on window with options as the only argument, and terminate these steps.
304         // Note that WebKit always uses quirks mode document scrolling behavior. See Document::scrollingElement().
305         // FIXME: Scrolling an independently scrollable body is broken: webkit.org/b/161612.
306         auto* window = document().domWindow();
307         if (!window)
308             return;
309
310         window->scrollTo(options);
311         return;
312     }
313     return HTMLElement::scrollTo(options);
314 }
315
316 int HTMLBodyElement::scrollHeight()
317 {
318     if (isFirstBodyElementOfDocument()) {
319         // Update the document's layout.
320         document().updateLayoutIgnorePendingStylesheets();
321         Frame* frame = document().frame();
322         if (!frame)
323             return 0;
324         FrameView* view = frame->view();
325         if (!view)
326             return 0;
327         return adjustForZoom(view->contentsHeight(), *frame);
328     }
329     return HTMLElement::scrollHeight();
330 }
331
332 int HTMLBodyElement::scrollWidth()
333 {
334     if (isFirstBodyElementOfDocument()) {
335         // Update the document's layout.
336         document().updateLayoutIgnorePendingStylesheets();
337         Frame* frame = document().frame();
338         if (!frame)
339             return 0;
340         FrameView* view = frame->view();
341         if (!view)
342             return 0;
343         return adjustForZoom(view->contentsWidth(), *frame);
344     }
345     return HTMLElement::scrollWidth();
346 }
347
348 void HTMLBodyElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
349 {
350     HTMLElement::addSubresourceAttributeURLs(urls);
351
352     addSubresourceURL(urls, document().completeURL(attributeWithoutSynchronization(backgroundAttr)));
353 }
354
355 } // namespace WebCore