Remove pixelSnapped* functions from RenderBoxModelObject/RenderBox.
[WebKit-https.git] / Source / WebCore / html / HTMLImageElement.cpp
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2010 Apple Inc. All rights reserved.
5  * Copyright (C) 2010 Google Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #include "config.h"
24 #include "HTMLImageElement.h"
25
26 #include "CSSPropertyNames.h"
27 #include "CSSValueKeywords.h"
28 #include "CachedImage.h"
29 #include "EventNames.h"
30 #include "FrameView.h"
31 #include "HTMLAnchorElement.h"
32 #include "HTMLDocument.h"
33 #include "HTMLFormElement.h"
34 #include "HTMLParserIdioms.h"
35 #include "HTMLSrcsetParser.h"
36 #include "Page.h"
37 #include "RenderImage.h"
38 #include "Settings.h"
39 #include "ShadowRoot.h"
40 #include "SourceSizeList.h"
41 #include <wtf/text/StringBuilder.h>
42
43 #if ENABLE(SERVICE_CONTROLS)
44 #include "ImageControlsRootElement.h"
45 #endif
46
47 namespace WebCore {
48
49 using namespace HTMLNames;
50
51 HTMLImageElement::HTMLImageElement(const QualifiedName& tagName, Document& document, HTMLFormElement* form)
52     : HTMLElement(tagName, document)
53     , m_imageLoader(*this)
54     , m_form(form)
55     , m_compositeOperator(CompositeSourceOver)
56     , m_imageDevicePixelRatio(1.0f)
57 #if ENABLE(SERVICE_CONTROLS)
58     , m_experimentalImageMenuEnabled(false)
59 #endif
60 {
61     ASSERT(hasTagName(imgTag));
62     setHasCustomStyleResolveCallbacks();
63     if (form)
64         form->registerImgElement(this);
65 }
66
67 Ref<HTMLImageElement> HTMLImageElement::create(Document& document)
68 {
69     return adoptRef(*new HTMLImageElement(imgTag, document));
70 }
71
72 Ref<HTMLImageElement> HTMLImageElement::create(const QualifiedName& tagName, Document& document, HTMLFormElement* form)
73 {
74     return adoptRef(*new HTMLImageElement(tagName, document, form));
75 }
76
77 HTMLImageElement::~HTMLImageElement()
78 {
79     if (m_form)
80         m_form->removeImgElement(this);
81 }
82
83 Ref<HTMLImageElement> HTMLImageElement::createForJSConstructor(Document& document, const int* optionalWidth, const int* optionalHeight)
84 {
85     Ref<HTMLImageElement> image = adoptRef(*new HTMLImageElement(imgTag, document));
86     if (optionalWidth)
87         image->setWidth(*optionalWidth);
88     if (optionalHeight)
89         image->setHeight(*optionalHeight);
90     return image;
91 }
92
93 bool HTMLImageElement::isPresentationAttribute(const QualifiedName& name) const
94 {
95     if (name == widthAttr || name == heightAttr || name == borderAttr || name == vspaceAttr || name == hspaceAttr || name == alignAttr || name == valignAttr)
96         return true;
97     return HTMLElement::isPresentationAttribute(name);
98 }
99
100 void HTMLImageElement::collectStyleForPresentationAttribute(const QualifiedName& name, const AtomicString& value, MutableStyleProperties& style)
101 {
102     if (name == widthAttr)
103         addHTMLLengthToStyle(style, CSSPropertyWidth, value);
104     else if (name == heightAttr)
105         addHTMLLengthToStyle(style, CSSPropertyHeight, value);
106     else if (name == borderAttr)
107         applyBorderAttributeToStyle(value, style);
108     else if (name == vspaceAttr) {
109         addHTMLLengthToStyle(style, CSSPropertyMarginTop, value);
110         addHTMLLengthToStyle(style, CSSPropertyMarginBottom, value);
111     } else if (name == hspaceAttr) {
112         addHTMLLengthToStyle(style, CSSPropertyMarginLeft, value);
113         addHTMLLengthToStyle(style, CSSPropertyMarginRight, value);
114     } else if (name == alignAttr)
115         applyAlignmentAttributeToStyle(value, style);
116     else if (name == valignAttr)
117         addPropertyToPresentationAttributeStyle(style, CSSPropertyVerticalAlign, value);
118     else
119         HTMLElement::collectStyleForPresentationAttribute(name, value, style);
120 }
121
122 const AtomicString& HTMLImageElement::imageSourceURL() const
123 {
124     return m_bestFitImageURL.isEmpty() ? fastGetAttribute(srcAttr) : m_bestFitImageURL;
125 }
126
127 void HTMLImageElement::setBestFitURLAndDPRFromImageCandidate(const ImageCandidate& candidate)
128 {
129     m_bestFitImageURL = candidate.string.toString();
130 #if ENABLE(PICTURE_SIZES)
131     m_currentSrc = AtomicString(document().completeURL(imageSourceURL()).string());
132 #endif
133     if (candidate.density >= 0)
134         m_imageDevicePixelRatio = 1 / candidate.density;
135     if (is<RenderImage>(renderer()))
136         downcast<RenderImage>(*renderer()).setImageDevicePixelRatio(m_imageDevicePixelRatio);
137 }
138
139 void HTMLImageElement::parseAttribute(const QualifiedName& name, const AtomicString& value)
140 {
141     if (name == altAttr) {
142         if (is<RenderImage>(renderer()))
143             downcast<RenderImage>(*renderer()).updateAltText();
144     } else if (name == srcAttr || name == srcsetAttr) {
145         float sourceSize = parseSizesAttribute(fastGetAttribute(sizesAttr).string(), document().renderView(), document().frame());
146         ImageCandidate candidate = bestFitSourceForImageAttributes(document().deviceScaleFactor(), fastGetAttribute(srcAttr), fastGetAttribute(srcsetAttr), sourceSize);
147         setBestFitURLAndDPRFromImageCandidate(candidate);
148         m_imageLoader.updateFromElementIgnoringPreviousError();
149     } else if (name == usemapAttr) {
150         if (inDocument() && !m_lowercasedUsemap.isNull())
151             document().removeImageElementByLowercasedUsemap(*m_lowercasedUsemap.impl(), *this);
152
153         // The HTMLImageElement's useMap() value includes the '#' symbol at the beginning, which has to be stripped off.
154         // FIXME: We should check that the first character is '#'.
155         // FIXME: HTML5 specification says we should strip any leading string before '#'.
156         // FIXME: HTML5 specification says we should ignore usemap attributes without #.
157         if (value.length() > 1)
158             m_lowercasedUsemap = value.string().substring(1).lower();
159         else
160             m_lowercasedUsemap = nullAtom;
161
162         if (inDocument() && !m_lowercasedUsemap.isNull())
163             document().addImageElementByLowercasedUsemap(*m_lowercasedUsemap.impl(), *this);
164     } else if (name == compositeAttr) {
165         // FIXME: images don't support blend modes in their compositing attribute.
166         BlendMode blendOp = BlendModeNormal;
167         if (!parseCompositeAndBlendOperator(value, m_compositeOperator, blendOp))
168             m_compositeOperator = CompositeSourceOver;
169 #if ENABLE(SERVICE_CONTROLS)
170     } else if (name == webkitimagemenuAttr) {
171         m_experimentalImageMenuEnabled = !value.isNull();
172         updateImageControls();
173 #endif
174     } else {
175         if (name == nameAttr) {
176             bool willHaveName = !value.isNull();
177             if (m_hadNameBeforeAttributeChanged != willHaveName && inDocument() && is<HTMLDocument>(document())) {
178                 HTMLDocument& document = downcast<HTMLDocument>(this->document());
179                 const AtomicString& id = getIdAttribute();
180                 if (!id.isEmpty() && id != getNameAttribute()) {
181                     if (willHaveName)
182                         document.addDocumentNamedItem(*id.impl(), *this);
183                     else
184                         document.removeDocumentNamedItem(*id.impl(), *this);
185                 }
186             }
187             m_hadNameBeforeAttributeChanged = willHaveName;
188         }
189         HTMLElement::parseAttribute(name, value);
190     }
191 }
192
193 const AtomicString& HTMLImageElement::altText() const
194 {
195     // lets figure out the alt text.. magic stuff
196     // http://www.w3.org/TR/1998/REC-html40-19980424/appendix/notes.html#altgen
197     // also heavily discussed by Hixie on bugzilla
198     const AtomicString& alt = fastGetAttribute(altAttr);
199     if (!alt.isNull())
200         return alt;
201     // fall back to title attribute
202     return fastGetAttribute(titleAttr);
203 }
204
205 RenderPtr<RenderElement> HTMLImageElement::createElementRenderer(Ref<RenderStyle>&& style, const RenderTreePosition&)
206 {
207     if (style.get().hasContent())
208         return RenderElement::createFor(*this, WTF::move(style));
209
210     return createRenderer<RenderImage>(*this, WTF::move(style), nullptr, m_imageDevicePixelRatio);
211 }
212
213 bool HTMLImageElement::canStartSelection() const
214 {
215     if (shadowRoot())
216         return HTMLElement::canStartSelection();
217
218     return false;
219 }
220
221 void HTMLImageElement::didAttachRenderers()
222 {
223     if (!is<RenderImage>(renderer()))
224         return;
225     if (m_imageLoader.hasPendingBeforeLoadEvent())
226         return;
227
228 #if ENABLE(SERVICE_CONTROLS)
229     updateImageControls();
230 #endif
231
232     auto& renderImage = downcast<RenderImage>(*renderer());
233     RenderImageResource& renderImageResource = renderImage.imageResource();
234     if (renderImageResource.hasImage())
235         return;
236     renderImageResource.setCachedImage(m_imageLoader.image());
237
238     // If we have no image at all because we have no src attribute, set
239     // image height and width for the alt text instead.
240     if (!m_imageLoader.image() && !renderImageResource.cachedImage())
241         renderImage.setImageSizeForAltText();
242 }
243
244 Node::InsertionNotificationRequest HTMLImageElement::insertedInto(ContainerNode& insertionPoint)
245 {
246     if (!m_form) { // m_form can be non-null if it was set in constructor.
247         m_form = HTMLFormElement::findClosestFormAncestor(*this);
248         if (m_form)
249             m_form->registerImgElement(this);
250     }
251
252     // Insert needs to complete first, before we start updating the loader. Loader dispatches events which could result
253     // in callbacks back to this node.
254     Node::InsertionNotificationRequest insertNotificationRequest = HTMLElement::insertedInto(insertionPoint);
255
256     if (insertionPoint.inDocument() && !m_lowercasedUsemap.isNull())
257         document().addImageElementByLowercasedUsemap(*m_lowercasedUsemap.impl(), *this);
258
259     // If we have been inserted from a renderer-less document,
260     // our loader may have not fetched the image, so do it now.
261     if (insertionPoint.inDocument() && !m_imageLoader.image())
262         m_imageLoader.updateFromElement();
263
264     return insertNotificationRequest;
265 }
266
267 void HTMLImageElement::removedFrom(ContainerNode& insertionPoint)
268 {
269     if (m_form)
270         m_form->removeImgElement(this);
271
272     if (insertionPoint.inDocument() && !m_lowercasedUsemap.isNull())
273         document().removeImageElementByLowercasedUsemap(*m_lowercasedUsemap.impl(), *this);
274
275     m_form = 0;
276     HTMLElement::removedFrom(insertionPoint);
277 }
278
279 int HTMLImageElement::width(bool ignorePendingStylesheets)
280 {
281     if (!renderer()) {
282         // check the attribute first for an explicit pixel value
283         bool ok;
284         int width = getAttribute(widthAttr).toInt(&ok);
285         if (ok)
286             return width;
287
288         // if the image is available, use its width
289         if (m_imageLoader.image())
290             return m_imageLoader.image()->imageSizeForRenderer(renderer(), 1.0f).width();
291     }
292
293     if (ignorePendingStylesheets)
294         document().updateLayoutIgnorePendingStylesheets();
295     else
296         document().updateLayout();
297
298     RenderBox* box = renderBox();
299     if (!box)
300         return 0;
301     LayoutRect contentRect = box->contentBoxRect();
302     return adjustForAbsoluteZoom(snappedIntRect(contentRect).width(), *box);
303 }
304
305 int HTMLImageElement::height(bool ignorePendingStylesheets)
306 {
307     if (!renderer()) {
308         // check the attribute first for an explicit pixel value
309         bool ok;
310         int height = getAttribute(heightAttr).toInt(&ok);
311         if (ok)
312             return height;
313
314         // if the image is available, use its height
315         if (m_imageLoader.image())
316             return m_imageLoader.image()->imageSizeForRenderer(renderer(), 1.0f).height();
317     }
318
319     if (ignorePendingStylesheets)
320         document().updateLayoutIgnorePendingStylesheets();
321     else
322         document().updateLayout();
323
324     RenderBox* box = renderBox();
325     if (!box)
326         return 0;
327     LayoutRect contentRect = box->contentBoxRect();
328     return adjustForAbsoluteZoom(snappedIntRect(contentRect).height(), *box);
329 }
330
331 int HTMLImageElement::naturalWidth() const
332 {
333     if (!m_imageLoader.image())
334         return 0;
335
336     return m_imageLoader.image()->imageSizeForRenderer(renderer(), 1.0f).width();
337 }
338
339 int HTMLImageElement::naturalHeight() const
340 {
341     if (!m_imageLoader.image())
342         return 0;
343
344     return m_imageLoader.image()->imageSizeForRenderer(renderer(), 1.0f).height();
345 }
346
347 bool HTMLImageElement::isURLAttribute(const Attribute& attribute) const
348 {
349     return attribute.name() == srcAttr
350         || attribute.name() == lowsrcAttr
351         || attribute.name() == longdescAttr
352         || (attribute.name() == usemapAttr && attribute.value().string()[0] != '#')
353         || HTMLElement::isURLAttribute(attribute);
354 }
355
356 bool HTMLImageElement::attributeContainsURL(const Attribute& attribute) const
357 {
358     return attribute.name() == srcsetAttr
359         || HTMLElement::attributeContainsURL(attribute);
360 }
361
362 String HTMLImageElement::completeURLsInAttributeValue(const URL& base, const Attribute& attribute) const
363 {
364     if (attribute.name() == srcsetAttr) {
365         Vector<ImageCandidate> imageCandidates = parseImageCandidatesFromSrcsetAttribute(StringView(attribute.value()));
366         StringBuilder result;
367         for (const auto& candidate : imageCandidates) {
368             if (&candidate != &imageCandidates[0])
369                 result.appendLiteral(", ");
370             result.append(URL(base, candidate.string.toString()).string());
371             if (candidate.density != UninitializedDescriptor) {
372                 result.append(' ');
373                 result.appendNumber(candidate.density);
374                 result.append('x');
375             }
376             if (candidate.resourceWidth != UninitializedDescriptor) {
377                 result.append(' ');
378                 result.appendNumber(candidate.resourceWidth);
379                 result.append('x');
380             }
381         }
382         return result.toString();
383     }
384     return HTMLElement::completeURLsInAttributeValue(base, attribute);
385 }
386
387 bool HTMLImageElement::matchesLowercasedUsemap(const AtomicStringImpl& name) const
388 {
389     ASSERT(String(&const_cast<AtomicStringImpl&>(name)).lower().impl() == &name);
390     return m_lowercasedUsemap.impl() == &name;
391 }
392
393 const AtomicString& HTMLImageElement::alt() const
394 {
395     return fastGetAttribute(altAttr);
396 }
397
398 bool HTMLImageElement::draggable() const
399 {
400     // Image elements are draggable by default.
401     return !equalIgnoringCase(fastGetAttribute(draggableAttr), "false");
402 }
403
404 void HTMLImageElement::setHeight(int value)
405 {
406     setIntegralAttribute(heightAttr, value);
407 }
408
409 URL HTMLImageElement::src() const
410 {
411     return document().completeURL(fastGetAttribute(srcAttr));
412 }
413
414 void HTMLImageElement::setSrc(const String& value)
415 {
416     setAttribute(srcAttr, value);
417 }
418
419 void HTMLImageElement::setWidth(int value)
420 {
421     setIntegralAttribute(widthAttr, value);
422 }
423
424 int HTMLImageElement::x() const
425 {
426     document().updateLayoutIgnorePendingStylesheets();
427     auto renderer = this->renderer();
428     if (!renderer)
429         return 0;
430
431     // FIXME: This doesn't work correctly with transforms.
432     return renderer->localToAbsolute().x();
433 }
434
435 int HTMLImageElement::y() const
436 {
437     document().updateLayoutIgnorePendingStylesheets();
438     auto renderer = this->renderer();
439     if (!renderer)
440         return 0;
441
442     // FIXME: This doesn't work correctly with transforms.
443     return renderer->localToAbsolute().y();
444 }
445
446 bool HTMLImageElement::complete() const
447 {
448     return m_imageLoader.imageComplete();
449 }
450
451 void HTMLImageElement::addSubresourceAttributeURLs(ListHashSet<URL>& urls) const
452 {
453     HTMLElement::addSubresourceAttributeURLs(urls);
454
455     addSubresourceURL(urls, src());
456     // FIXME: What about when the usemap attribute begins with "#"?
457     addSubresourceURL(urls, document().completeURL(fastGetAttribute(usemapAttr)));
458 }
459
460 void HTMLImageElement::didMoveToNewDocument(Document* oldDocument)
461 {
462     m_imageLoader.elementDidMoveToNewDocument();
463     HTMLElement::didMoveToNewDocument(oldDocument);
464 }
465
466 bool HTMLImageElement::isServerMap() const
467 {
468     if (!fastHasAttribute(ismapAttr))
469         return false;
470
471     const AtomicString& usemap = fastGetAttribute(usemapAttr);
472     
473     // If the usemap attribute starts with '#', it refers to a map element in the document.
474     if (usemap.string()[0] == '#')
475         return false;
476
477     return document().completeURL(stripLeadingAndTrailingHTMLSpaces(usemap)).isEmpty();
478 }
479
480 #if ENABLE(SERVICE_CONTROLS)
481 void HTMLImageElement::updateImageControls()
482 {
483     // If this image element is inside a shadow tree then it is part of an image control.
484     if (isInShadowTree())
485         return;
486
487     Settings* settings = document().settings();
488     if (!settings || !settings->imageControlsEnabled())
489         return;
490
491     bool hasControls = hasImageControls();
492     if (!m_experimentalImageMenuEnabled && hasControls)
493         destroyImageControls();
494     else if (m_experimentalImageMenuEnabled && !hasControls)
495         createImageControls();
496 }
497
498 void HTMLImageElement::createImageControls()
499 {
500     ASSERT(m_experimentalImageMenuEnabled);
501     ASSERT(!hasImageControls());
502
503     RefPtr<ImageControlsRootElement> imageControls = ImageControlsRootElement::maybeCreate(document());
504     if (!imageControls)
505         return;
506
507     ensureUserAgentShadowRoot().appendChild(imageControls);
508
509     auto* renderObject = renderer();
510     if (!renderObject)
511         return;
512
513     downcast<RenderImage>(*renderObject).setHasShadowControls(true);
514 }
515
516 void HTMLImageElement::destroyImageControls()
517 {
518     ShadowRoot* shadowRoot = userAgentShadowRoot();
519     if (!shadowRoot)
520         return;
521
522     if (Node* node = shadowRoot->firstChild()) {
523         ASSERT_WITH_SECURITY_IMPLICATION(node->isImageControlsRootElement());
524         shadowRoot->removeChild(node);
525     }
526
527     auto* renderObject = renderer();
528     if (!renderObject)
529         return;
530
531     downcast<RenderImage>(*renderObject).setHasShadowControls(false);
532 }
533
534 bool HTMLImageElement::hasImageControls() const
535 {
536     if (ShadowRoot* shadowRoot = userAgentShadowRoot()) {
537         Node* node = shadowRoot->firstChild();
538         ASSERT_WITH_SECURITY_IMPLICATION(!node || node->isImageControlsRootElement());
539         return node;
540     }
541
542     return false;
543 }
544
545 bool HTMLImageElement::childShouldCreateRenderer(const Node& child) const
546 {
547     return hasShadowRootParent(child) && HTMLElement::childShouldCreateRenderer(child);
548 }
549 #endif // ENABLE(SERVICE_CONTROLS)
550
551 #if PLATFORM(IOS)
552 // FIXME: This is a workaround for <rdar://problem/7725158>. We should find a better place for the touchCalloutEnabled() logic.
553 bool HTMLImageElement::willRespondToMouseClickEvents()
554 {
555     auto renderer = this->renderer();
556     if (!renderer || renderer->style().touchCalloutEnabled())
557         return true;
558     return HTMLElement::willRespondToMouseClickEvents();
559 }
560 #endif
561
562 }