XML error document creation should not fire mutation events
[WebKit-https.git] / Source / WebCore / xml / XMLErrors.cpp
1 /*
2  * Copyright (C) 2011 Google Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions are
6  * met:
7  *
8  * 1. Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above
12  * copyright notice, this list of conditions and the following disclaimer
13  * in the documentation and/or other materials provided with the
14  * distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY GOOGLE INC. AND ITS CONTRIBUTORS
17  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
18  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
19  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL GOOGLE INC.
20  * OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
21  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
22  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
26  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "XMLErrors.h"
31
32 #include "Document.h"
33 #include "Element.h"
34 #include "Frame.h"
35 #include "HTMLNames.h"
36 #include "Text.h"
37 #include <wtf/text/WTFString.h>
38
39 #if ENABLE(SVG)
40 #include "SVGNames.h"
41 #endif
42
43 namespace WebCore {
44
45 using namespace HTMLNames;
46
47 const int maxErrors = 25;
48
49 XMLErrors::XMLErrors(Document* document)
50     : m_document(document)
51     , m_errorCount(0)
52     , m_lastErrorPosition(TextPosition::belowRangePosition())
53 {
54 }
55
56 void XMLErrors::handleError(ErrorType type, const char* message, int lineNumber, int columnNumber)
57 {
58     handleError(type, message, TextPosition(OrdinalNumber::fromOneBasedInt(lineNumber), OrdinalNumber::fromOneBasedInt(columnNumber)));
59 }
60
61 void XMLErrors::handleError(ErrorType type, const char* message, TextPosition position)
62 {
63     if (type == fatal || (m_errorCount < maxErrors && m_lastErrorPosition.m_line != position.m_line && m_lastErrorPosition.m_column != position.m_column)) {
64         switch (type) {
65         case warning:
66             appendErrorMessage("warning", position, message);
67             break;
68         case fatal:
69         case nonFatal:
70             appendErrorMessage("error", position, message);
71         }
72
73         m_lastErrorPosition = position;
74         ++m_errorCount;
75     }
76 }
77
78 void XMLErrors::appendErrorMessage(const String& typeString, TextPosition position, const char* message)
79 {
80     // <typeString> on line <lineNumber> at column <columnNumber>: <message>
81     m_errorMessages.append(typeString);
82     m_errorMessages.append(" on line ");
83     m_errorMessages.append(String::number(position.m_line.oneBasedInt()));
84     m_errorMessages.append(" at column ");
85     m_errorMessages.append(String::number(position.m_column.oneBasedInt()));
86     m_errorMessages.append(": ");
87     m_errorMessages.append(message);
88 }
89
90 static inline PassRefPtr<Element> createXHTMLParserErrorHeader(Document* doc, const String& errorMessages)
91 {
92     RefPtr<Element> reportElement = doc->createElement(QualifiedName(nullAtom, "parsererror", xhtmlNamespaceURI), true);
93
94     OwnPtr<AttributeVector> reportAttributes = AttributeVector::create();
95     reportAttributes->append(Attribute::create(styleAttr, "display: block; white-space: pre; border: 2px solid #c77; padding: 0 1em 0 1em; margin: 1em; background-color: #fdd; color: black"));
96     reportElement->parserSetAttributes(reportAttributes.release(), FragmentScriptingNotAllowed);
97
98     RefPtr<Element> h3 = doc->createElement(h3Tag, true);
99     reportElement->parserAddChild(h3.get());
100     h3->parserAddChild(doc->createTextNode("This page contains the following errors:"));
101
102     RefPtr<Element> fixed = doc->createElement(divTag, true);
103     OwnPtr<AttributeVector> fixedAttributes = AttributeVector::create();
104     fixedAttributes->append(Attribute::create(styleAttr, "font-family:monospace;font-size:12px"));
105     fixed->parserSetAttributes(fixedAttributes.release(), FragmentScriptingNotAllowed);
106     reportElement->parserAddChild(fixed.get());
107
108     fixed->parserAddChild(doc->createTextNode(errorMessages));
109
110     h3 = doc->createElement(h3Tag, true);
111     reportElement->parserAddChild(h3.get());
112     h3->parserAddChild(doc->createTextNode("Below is a rendering of the page up to the first error."));
113
114     return reportElement.release();
115 }
116
117 void XMLErrors::insertErrorMessageBlock()
118 {
119     // One or more errors occurred during parsing of the code. Display an error block to the user above
120     // the normal content (the DOM tree is created manually and includes line/col info regarding
121     // where the errors are located)
122
123     // Create elements for display
124     RefPtr<Element> documentElement = m_document->documentElement();
125     if (!documentElement) {
126         RefPtr<Element> rootElement = m_document->createElement(htmlTag, true);
127         RefPtr<Element> body = m_document->createElement(bodyTag, true);
128         rootElement->parserAddChild(body);
129         m_document->parserAddChild(rootElement);
130         if (m_document->attached() && !rootElement->attached())
131             rootElement->attach();
132         documentElement = body.get();
133     }
134 #if ENABLE(SVG)
135     else if (documentElement->namespaceURI() == SVGNames::svgNamespaceURI) {
136         RefPtr<Element> rootElement = m_document->createElement(htmlTag, true);
137         RefPtr<Element> body = m_document->createElement(bodyTag, true);
138         rootElement->parserAddChild(body);
139
140         documentElement->parentNode()->parserRemoveChild(documentElement.get());
141         if (documentElement->attached())
142             documentElement->detach();
143
144         body->parserAddChild(documentElement);
145         m_document->parserAddChild(rootElement.get());
146
147         if (m_document->attached()) {
148             // rootElement shouldn't be attached right now, but in some cases might be.
149             // See https://bugs.webkit.org/show_bug.cgi?id=81985
150             rootElement->reattach();
151         }
152
153         documentElement = body.get();
154     }
155 #endif
156
157     String errorMessages = m_errorMessages.toString();
158     RefPtr<Element> reportElement = createXHTMLParserErrorHeader(m_document, errorMessages);
159
160 #if ENABLE(XSLT)
161     if (m_document->transformSourceDocument()) {
162         OwnPtr<AttributeVector> attributes = AttributeVector::create();
163         attributes->append(Attribute::create(styleAttr, "white-space: normal"));
164         RefPtr<Element> paragraph = m_document->createElement(pTag, true);
165         paragraph->parserSetAttributes(attributes.release(), FragmentScriptingNotAllowed);
166         paragraph->parserAddChild(m_document->createTextNode("This document was created as the result of an XSL transformation. The line and column numbers given are from the transformed result."));
167         reportElement->parserAddChild(paragraph.release());
168     }
169 #endif
170
171     Node* firstChild = documentElement->firstChild();
172     if (firstChild)
173         documentElement->parserInsertBefore(reportElement, documentElement->firstChild());
174     else
175         documentElement->parserAddChild(reportElement);
176
177     if (documentElement->attached() && !reportElement->attached())
178         reportElement->attach();
179
180     m_document->updateStyleIfNeeded();
181 }
182
183 } // namespace WebCore