2 * This file is part of the XSL implementation.
4 * Copyright (C) 2004, 2005, 2006, 2008 Apple Inc. All rights reserved.
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
16 * You should have received a copy of the GNU Library General Public License
17 * along with this library; see the file COPYING.LIB. If not, write to
18 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 * Boston, MA 02110-1301, USA.
23 #include "XSLStyleSheet.h"
28 #include "DOMWindow.h"
29 #include "CachedResourceLoader.h"
33 #include "TransformSource.h"
34 #include "XMLDocumentParser.h"
35 #include "XMLDocumentParserScope.h"
36 #include "XSLImportRule.h"
37 #include "XSLTProcessor.h"
38 #include <wtf/text/CString.h>
40 #include <libxml/uri.h>
41 #include <libxslt/xsltutils.h>
44 #include "SoftLinking.h"
48 SOFT_LINK_LIBRARY(libxslt)
49 SOFT_LINK(libxslt, xsltIsBlank, int, (xmlChar *str), (str))
50 SOFT_LINK(libxslt, xsltGetNsProp, xmlChar *, (xmlNodePtr node, const xmlChar *name, const xmlChar *nameSpace), (node, name, nameSpace))
51 SOFT_LINK(libxslt, xsltParseStylesheetDoc, xsltStylesheetPtr, (xmlDocPtr doc), (doc))
52 SOFT_LINK(libxslt, xsltLoadStylesheetPI, xsltStylesheetPtr, (xmlDocPtr doc), (doc))
57 XSLStyleSheet::XSLStyleSheet(XSLImportRule* parentRule, const String& originalURL, const KURL& finalURL)
58 : StyleSheet(parentRule, originalURL, finalURL)
60 , m_processed(false) // Child sheets get marked as processed when the libxslt engine has finally seen them.
62 , m_stylesheetDocTaken(false)
63 , m_parentStyleSheet(0)
67 XSLStyleSheet::XSLStyleSheet(Node* parentNode, const String& originalURL, const KURL& finalURL, bool embedded)
68 : StyleSheet(parentNode, originalURL, finalURL)
69 , m_embedded(embedded)
70 , m_processed(true) // The root sheet starts off processed.
72 , m_stylesheetDocTaken(false)
73 , m_parentStyleSheet(0)
77 XSLStyleSheet::~XSLStyleSheet()
79 if (!m_stylesheetDocTaken)
80 xmlFreeDoc(m_stylesheetDoc);
83 bool XSLStyleSheet::isLoading()
85 unsigned len = length();
86 for (unsigned i = 0; i < len; ++i) {
87 StyleBase* rule = item(i);
88 if (rule->isImportRule()) {
89 XSLImportRule* import = static_cast<XSLImportRule*>(rule);
90 if (import->isLoading())
97 void XSLStyleSheet::checkLoaded()
102 parent()->checkLoaded();
104 ownerNode()->sheetLoaded();
107 xmlDocPtr XSLStyleSheet::document()
109 if (m_embedded && ownerDocument() && ownerDocument()->transformSource())
110 return (xmlDocPtr)ownerDocument()->transformSource()->platformSource();
111 return m_stylesheetDoc;
114 void XSLStyleSheet::clearDocuments()
117 unsigned len = length();
118 for (unsigned i = 0; i < len; ++i) {
119 StyleBase* rule = item(i);
120 if (rule->isImportRule()) {
121 XSLImportRule* import = static_cast<XSLImportRule*>(rule);
122 if (import->styleSheet())
123 import->styleSheet()->clearDocuments();
128 CachedResourceLoader* XSLStyleSheet::cachedResourceLoader()
130 Document* document = ownerDocument();
133 return document->cachedResourceLoader();
136 bool XSLStyleSheet::parseString(const String& string, bool)
138 // Parse in a single chunk into an xmlDocPtr
139 const UChar BOM = 0xFEFF;
140 const unsigned char BOMHighByte = *reinterpret_cast<const unsigned char*>(&BOM);
141 if (!m_stylesheetDocTaken)
142 xmlFreeDoc(m_stylesheetDoc);
143 m_stylesheetDocTaken = false;
145 Console* console = 0;
146 if (Frame* frame = ownerDocument()->frame())
147 console = frame->domWindow()->console();
149 XMLDocumentParserScope scope(cachedResourceLoader(), XSLTProcessor::genericErrorFunc, XSLTProcessor::parseErrorFunc, console);
151 const char* buffer = reinterpret_cast<const char*>(string.characters());
152 int size = string.length() * sizeof(UChar);
154 xmlParserCtxtPtr ctxt = xmlCreateMemoryParserCtxt(buffer, size);
158 if (m_parentStyleSheet) {
159 // The XSL transform may leave the newly-transformed document
160 // with references to the symbol dictionaries of the style sheet
161 // and any of its children. XML document disposal can corrupt memory
162 // if a document uses more than one symbol dictionary, so we
163 // ensure that all child stylesheets use the same dictionaries as their
165 xmlDictFree(ctxt->dict);
166 ctxt->dict = m_parentStyleSheet->m_stylesheetDoc->dict;
167 xmlDictReference(ctxt->dict);
170 m_stylesheetDoc = xmlCtxtReadMemory(ctxt, buffer, size,
171 finalURL().string().utf8().data(),
172 BOMHighByte == 0xFF ? "UTF-16LE" : "UTF-16BE",
173 XML_PARSE_NOENT | XML_PARSE_DTDATTR | XML_PARSE_NOWARNING | XML_PARSE_NOCDATA);
174 xmlFreeParserCtxt(ctxt);
178 return m_stylesheetDoc;
181 void XSLStyleSheet::loadChildSheets()
186 xmlNodePtr stylesheetRoot = document()->children;
188 // Top level children may include other things such as DTD nodes, we ignore those.
189 while (stylesheetRoot && stylesheetRoot->type != XML_ELEMENT_NODE)
190 stylesheetRoot = stylesheetRoot->next;
193 // We have to locate (by ID) the appropriate embedded stylesheet element, so that we can walk the
194 // import/include list.
195 xmlAttrPtr idNode = xmlGetID(document(), (const xmlChar*)(finalURL().string().utf8().data()));
198 stylesheetRoot = idNode->parent;
200 // FIXME: Need to handle an external URI with a # in it. This is a pretty minor edge case, so we'll deal
204 if (stylesheetRoot) {
205 // Walk the children of the root element and look for import/include elements.
206 // Imports must occur first.
207 xmlNodePtr curr = stylesheetRoot->children;
209 if (curr->type != XML_ELEMENT_NODE) {
213 if (IS_XSLT_ELEM(curr) && IS_XSLT_NAME(curr, "import")) {
214 xmlChar* uriRef = xsltGetNsProp(curr, (const xmlChar*)"href", XSLT_NAMESPACE);
215 loadChildSheet(String::fromUTF8((const char*)uriRef));
222 // Now handle includes.
224 if (curr->type == XML_ELEMENT_NODE && IS_XSLT_ELEM(curr) && IS_XSLT_NAME(curr, "include")) {
225 xmlChar* uriRef = xsltGetNsProp(curr, (const xmlChar*)"href", XSLT_NAMESPACE);
226 loadChildSheet(String::fromUTF8((const char*)uriRef));
234 void XSLStyleSheet::loadChildSheet(const String& href)
236 RefPtr<XSLImportRule> childRule = XSLImportRule::create(this, href);
238 childRule->loadSheet();
241 xsltStylesheetPtr XSLStyleSheet::compileStyleSheet()
243 // FIXME: Hook up error reporting for the stylesheet compilation process.
245 return xsltLoadStylesheetPI(document());
247 // xsltParseStylesheetDoc makes the document part of the stylesheet
248 // so we have to release our pointer to it.
249 ASSERT(!m_stylesheetDocTaken);
250 xsltStylesheetPtr result = xsltParseStylesheetDoc(m_stylesheetDoc);
252 m_stylesheetDocTaken = true;
256 void XSLStyleSheet::setParentStyleSheet(XSLStyleSheet* parent)
258 m_parentStyleSheet = parent;
261 Document* XSLStyleSheet::ownerDocument()
263 for (XSLStyleSheet* styleSheet = this; styleSheet; styleSheet = styleSheet->parentStyleSheet()) {
264 Node* node = styleSheet->ownerNode();
266 return node->document();
271 xmlDocPtr XSLStyleSheet::locateStylesheetSubResource(xmlDocPtr parentDoc, const xmlChar* uri)
273 bool matchedParent = (parentDoc == document());
274 unsigned len = length();
275 for (unsigned i = 0; i < len; ++i) {
276 StyleBase* rule = item(i);
277 if (rule->isImportRule()) {
278 XSLImportRule* import = static_cast<XSLImportRule*>(rule);
279 XSLStyleSheet* child = import->styleSheet();
283 if (child->processed())
284 continue; // libxslt has been given this sheet already.
286 // Check the URI of the child stylesheet against the doc URI.
287 // In order to ensure that libxml canonicalized both URLs, we get the original href
288 // string from the import rule and canonicalize it using libxml before comparing it
289 // with the URI argument.
290 CString importHref = import->href().utf8();
291 xmlChar* base = xmlNodeGetBase(parentDoc, (xmlNodePtr)parentDoc);
292 xmlChar* childURI = xmlBuildURI((const xmlChar*)importHref.data(), base);
293 bool equalURIs = xmlStrEqual(uri, childURI);
297 child->markAsProcessed();
298 return child->document();
301 xmlDocPtr result = import->styleSheet()->locateStylesheetSubResource(parentDoc, uri);
311 void XSLStyleSheet::markAsProcessed()
313 ASSERT(!m_processed);
314 ASSERT(!m_stylesheetDocTaken);
316 m_stylesheetDocTaken = true;
319 } // namespace WebCore
321 #endif // ENABLE(XSLT)