660e2d7722a6cb54664fd1a921fdc06cbf76920f
[WebKit-https.git] / WebCore / xml / XSLTProcessor.cpp
1 /**
2  * This file is part of the XSL implementation.
3  *
4  * Copyright (C) 2004, 2005, 2006, 2007 Apple, Inc.
5  * Copyright (C) 2005, 2006 Alexey Proskuryakov <ap@webkit.org>
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
25 #if ENABLE(XSLT)
26
27 #include "XSLTProcessor.h"
28
29 #include "CString.h"
30 #include "Cache.h"
31 #include "DOMImplementation.h"
32 #include "DocLoader.h"
33 #include "DocumentFragment.h"
34 #include "Frame.h"
35 #include "FrameLoader.h"
36 #include "FrameView.h"
37 #include "HTMLDocument.h"
38 #include "HTMLTokenizer.h"
39 #include "Page.h"
40 #include "ResourceHandle.h"
41 #include "ResourceRequest.h"
42 #include "ResourceResponse.h"
43 #include "Text.h"
44 #include "TextResourceDecoder.h"
45 #include "XMLTokenizer.h"
46 #include "XSLTExtensions.h"
47 #include "XSLTUnicodeSort.h"
48 #include "loader.h"
49 #include "markup.h"
50 #include <libxslt/imports.h>
51 #include <libxslt/variables.h>
52 #include <libxslt/xsltutils.h>
53 #include <wtf/Assertions.h>
54 #include <wtf/Platform.h>
55 #include <wtf/Vector.h>
56 #if PLATFORM(MAC)
57 #include "SoftLinking.h"
58 #endif
59
60 #if PLATFORM(MAC)
61 SOFT_LINK_LIBRARY(libxslt);
62 SOFT_LINK(libxslt, xsltFreeStylesheet, void, (xsltStylesheetPtr sheet), (sheet))
63 SOFT_LINK(libxslt, xsltFreeTransformContext, void, (xsltTransformContextPtr ctxt), (ctxt))
64 SOFT_LINK(libxslt, xsltNewTransformContext, xsltTransformContextPtr, (xsltStylesheetPtr style, xmlDocPtr doc), (style, doc))
65 SOFT_LINK(libxslt, xsltApplyStylesheetUser, xmlDocPtr, (xsltStylesheetPtr style, xmlDocPtr doc, const char** params, const char* output, FILE* profile, xsltTransformContextPtr userCtxt), (style, doc, params, output, profile, userCtxt))
66 SOFT_LINK(libxslt, xsltQuoteUserParams, int, (xsltTransformContextPtr ctxt, const char** params), (ctxt, params))
67 SOFT_LINK(libxslt, xsltSetCtxtSortFunc, void, (xsltTransformContextPtr ctxt, xsltSortFunc handler), (ctxt, handler))
68 SOFT_LINK(libxslt, xsltSetLoaderFunc, void, (xsltDocLoaderFunc f), (f))
69 SOFT_LINK(libxslt, xsltSaveResultTo, int, (xmlOutputBufferPtr buf, xmlDocPtr result, xsltStylesheetPtr style), (buf, result, style))
70 SOFT_LINK(libxslt, xsltNextImport, xsltStylesheetPtr, (xsltStylesheetPtr style), (style))
71 #endif
72
73 namespace WebCore {
74
75 void XSLTProcessor::parseErrorFunc(void* userData, xmlError* error)
76 {
77     Chrome* chrome = static_cast<Chrome*>(userData);
78     if (!chrome)
79         return;
80
81     MessageLevel level;
82     switch (error->level) {
83         case XML_ERR_NONE:
84             level = TipMessageLevel;
85             break;
86         case XML_ERR_WARNING:
87             level = WarningMessageLevel;
88             break;
89         case XML_ERR_ERROR:
90         case XML_ERR_FATAL:
91         default:
92             level = ErrorMessageLevel;
93             break;
94     }
95
96     chrome->addMessageToConsole(XMLMessageSource, level, error->message, error->line, error->file);
97 }
98
99 // FIXME: There seems to be no way to control the ctxt pointer for loading here, thus we have globals.
100 static XSLTProcessor* globalProcessor = 0;
101 static DocLoader* globalDocLoader = 0;
102 static xmlDocPtr docLoaderFunc(const xmlChar* uri,
103                                     xmlDictPtr dict,
104                                     int options,
105                                     void* ctxt,
106                                     xsltLoadType type)
107 {
108     if (!globalProcessor)
109         return 0;
110     
111     switch (type) {
112         case XSLT_LOAD_DOCUMENT: {
113             xsltTransformContextPtr context = (xsltTransformContextPtr)ctxt;
114             xmlChar* base = xmlNodeGetBase(context->document->doc, context->node);
115             KURL url((const char*)base, (const char*)uri);
116             xmlFree(base);
117             ResourceError error;
118             ResourceResponse response;
119
120             Vector<char> data;
121
122             if (globalDocLoader->frame()) 
123                 globalDocLoader->frame()->loader()->loadResourceSynchronously(url, error, response, data);
124
125             Chrome* chrome = 0;
126             if (Page* page = globalProcessor->xslStylesheet()->ownerDocument()->page())
127                 chrome = page->chrome();
128             xmlSetStructuredErrorFunc(chrome, XSLTProcessor::parseErrorFunc);
129
130             // We don't specify an encoding here. Neither Gecko nor WinIE respects
131             // the encoding specified in the HTTP headers.
132             xmlDocPtr doc = xmlReadMemory(data.data(), data.size(), (const char*)uri, 0, options);
133
134             xmlSetStructuredErrorFunc(0, 0);
135
136             return doc;
137         }
138         case XSLT_LOAD_STYLESHEET:
139             return globalProcessor->xslStylesheet()->locateStylesheetSubResource(((xsltStylesheetPtr)ctxt)->doc, uri);
140         default:
141             break;
142     }
143     
144     return 0;
145 }
146
147 static inline void setXSLTLoadCallBack(xsltDocLoaderFunc func, XSLTProcessor* processor, DocLoader* loader)
148 {
149     xsltSetLoaderFunc(func);
150     globalProcessor = processor;
151     globalDocLoader = loader;
152 }
153
154 static int writeToString(void* context, const char* buffer, int len)
155 {
156     String& resultOutput = *static_cast<String*>(context);
157     resultOutput += String::fromUTF8(buffer, len);
158     return len;
159 }
160
161 static bool saveResultToString(xmlDocPtr resultDoc, xsltStylesheetPtr sheet, String& resultString)
162 {
163     xmlOutputBufferPtr outputBuf = xmlAllocOutputBuffer(0);
164     if (!outputBuf)
165         return false;
166     outputBuf->context = &resultString;
167     outputBuf->writecallback = writeToString;
168     
169     int retval = xsltSaveResultTo(outputBuf, resultDoc, sheet);
170     xmlOutputBufferClose(outputBuf);
171     
172     return (retval >= 0);
173 }
174
175 static inline void transformTextStringToXHTMLDocumentString(String& text)
176 {
177     // Modify the output so that it is a well-formed XHTML document with a <pre> tag enclosing the text.
178     text.replace('&', "&amp;");
179     text.replace('<', "&lt;");
180     text = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
181         "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n"
182         "<html xmlns=\"http://www.w3.org/1999/xhtml\">\n"
183         "<head><title/></head>\n"
184         "<body>\n"
185         "<pre>" + text + "</pre>\n"
186         "</body>\n"
187         "</html>\n";
188 }
189
190 static const char** xsltParamArrayFromParameterMap(XSLTProcessor::ParameterMap& parameters)
191 {
192     if (parameters.isEmpty())
193         return 0;
194
195     const char** parameterArray = (const char**)fastMalloc(((parameters.size() * 2) + 1) * sizeof(char*));
196
197     XSLTProcessor::ParameterMap::iterator end = parameters.end();
198     unsigned index = 0;
199     for (XSLTProcessor::ParameterMap::iterator it = parameters.begin(); it != end; ++it) {
200         parameterArray[index++] = strdup(it->first.utf8().data());
201         parameterArray[index++] = strdup(it->second.utf8().data());
202     }
203     parameterArray[index] = 0;
204
205     return parameterArray;
206 }
207
208 static void freeXsltParamArray(const char** params)
209 {
210     const char** temp = params;
211     if (!params)
212         return;
213     
214     while (*temp) {
215         free((void*)*(temp++)); // strdup returns malloc'd blocks, so we have to use free() here
216         free((void*)*(temp++));
217     }
218     fastFree(params);
219 }
220
221
222 RefPtr<Document> XSLTProcessor::createDocumentFromSource(const String& sourceString,
223     const String& sourceEncoding, const String& sourceMIMEType, Node* sourceNode, Frame* frame)
224 {
225     RefPtr<Document> ownerDocument = sourceNode->document();
226     bool sourceIsDocument = (sourceNode == ownerDocument.get());
227     String documentSource = sourceString;
228
229     RefPtr<Document> result;
230     if (sourceMIMEType == "text/plain") {
231         result = ownerDocument->implementation()->createDocument(frame);
232         transformTextStringToXHTMLDocumentString(documentSource);
233     } else
234         result = ownerDocument->implementation()->createDocument(sourceMIMEType, frame, false);
235     
236     // Before parsing, we need to save & detach the old document and get the new document
237     // in place. We have to do this only if we're rendering the result document.
238     if (frame) {
239         if (FrameView* view = frame->view())
240             view->clear();
241         result->setTransformSourceDocument(frame->document());
242         frame->setDocument(result);
243     }
244     
245     result->open();
246     if (sourceIsDocument) {
247         result->setURL(ownerDocument->URL());
248         result->setBaseURL(ownerDocument->baseURL());
249     }
250     result->determineParseMode(documentSource); // Make sure we parse in the correct mode.
251     
252     RefPtr<TextResourceDecoder> decoder = new TextResourceDecoder(sourceMIMEType);
253     decoder->setEncoding(sourceEncoding.isEmpty() ? UTF8Encoding() : TextEncoding(sourceEncoding), TextResourceDecoder::EncodingFromXMLHeader);
254     result->setDecoder(decoder.get());
255     
256     result->write(documentSource);
257     result->finishParsing();
258     result->close();
259
260     return result;
261 }
262
263 static inline RefPtr<DocumentFragment> createFragmentFromSource(String sourceString, String sourceMIMEType, Node* sourceNode, Document* outputDoc)
264 {
265     RefPtr<DocumentFragment> fragment = new DocumentFragment(outputDoc);
266     
267     if (sourceMIMEType == "text/html")
268         parseHTMLDocumentFragment(sourceString, fragment.get());
269     else if (sourceMIMEType == "text/plain")
270         fragment->addChild(new Text(outputDoc, sourceString));
271     else {
272         bool successfulParse = parseXMLDocumentFragment(sourceString, fragment.get(), outputDoc->documentElement());
273         if (!successfulParse)
274             return 0;
275     }
276     
277     // FIXME: Do we need to mess with URLs here?
278         
279     return fragment;
280 }
281
282 static xsltStylesheetPtr xsltStylesheetPointer(RefPtr<XSLStyleSheet>& cachedStylesheet, Node* stylesheetRootNode)
283 {
284     if (!cachedStylesheet && stylesheetRootNode) {
285         cachedStylesheet = new XSLStyleSheet(stylesheetRootNode->parent() ? stylesheetRootNode->parent() : stylesheetRootNode, stylesheetRootNode->document()->URL());
286         cachedStylesheet->parseString(createMarkup(stylesheetRootNode));
287     }
288     
289     if (!cachedStylesheet || !cachedStylesheet->document())
290         return 0;
291     
292     return cachedStylesheet->compileStyleSheet();
293 }
294
295 static inline xmlDocPtr xmlDocPtrFromNode(Node* sourceNode, bool& shouldDelete)
296 {
297     RefPtr<Document> ownerDocument = sourceNode->document();
298     bool sourceIsDocument = (sourceNode == ownerDocument.get());
299     
300     xmlDocPtr sourceDoc = 0;
301     if (sourceIsDocument)
302         sourceDoc = (xmlDocPtr)ownerDocument->transformSource();
303     if (!sourceDoc) {
304         sourceDoc = (xmlDocPtr)xmlDocPtrForString(ownerDocument->docLoader(), createMarkup(sourceNode), sourceIsDocument ? ownerDocument->URL() : DeprecatedString());
305         shouldDelete = (sourceDoc != 0);
306     }
307     return sourceDoc;
308 }
309
310 static inline String resultMIMEType(xmlDocPtr resultDoc, xsltStylesheetPtr sheet)
311 {
312     // There are three types of output we need to be able to deal with:
313     // HTML (create an HTML document), XML (create an XML document),
314     // and text (wrap in a <pre> and create an XML document).
315
316     const xmlChar* resultType = 0;
317     XSLT_GET_IMPORT_PTR(resultType, sheet, method);
318     if (resultType == 0 && resultDoc->type == XML_HTML_DOCUMENT_NODE)
319         resultType = (const xmlChar*)"html";
320     
321     if (xmlStrEqual(resultType, (const xmlChar*)"html"))
322         return "text/html";
323     else if (xmlStrEqual(resultType, (const xmlChar*)"text"))
324         return "text/plain";
325         
326     return "application/xml";
327 }
328
329 bool XSLTProcessor::transformToString(Node* sourceNode, String& mimeType, String& resultString, String& resultEncoding)
330 {
331     RefPtr<Document> ownerDocument = sourceNode->document();
332     
333     setXSLTLoadCallBack(docLoaderFunc, this, ownerDocument->docLoader());
334     xsltStylesheetPtr sheet = xsltStylesheetPointer(m_stylesheet, m_stylesheetRootNode.get());
335     if (!sheet) {
336         setXSLTLoadCallBack(0, 0, 0);
337         return false;
338     }
339     m_stylesheet->clearDocuments();
340
341     xmlChar* origMethod = sheet->method;
342     if (!origMethod && mimeType == "text/html")
343         sheet->method = (xmlChar*)"html";
344
345     bool success = false;
346     bool shouldFreeSourceDoc = false;
347     if (xmlDocPtr sourceDoc = xmlDocPtrFromNode(sourceNode, shouldFreeSourceDoc)) {
348         // The XML declaration would prevent parsing the result as a fragment, and it's not needed even for documents, 
349         // as the result of this function is always immediately parsed.
350         sheet->omitXmlDeclaration = true;
351
352         xsltTransformContextPtr transformContext = xsltNewTransformContext(sheet, sourceDoc);
353         registerXSLTExtensions(transformContext);
354 // FIXME: <rdar://5611712> Remove the PLATFORM(WIN) check once ICU on Windows has collation support.
355 #if USE(ICU_UNICODE) && !PLATFORM(WIN)
356         // <http://bugs.webkit.org/show_bug.cgi?id=16077>: XSLT processor <xsl:sort> algorithm only compares by code point
357         // Only implemented for ICU yet.
358         xsltSetCtxtSortFunc(transformContext, xsltUnicodeSortFunction);
359 #endif
360
361         // This is a workaround for a bug in libxslt. 
362         // The bug has been fixed in version 1.1.13, so once we ship that this can be removed.
363         if (transformContext->globalVars == NULL)
364            transformContext->globalVars = xmlHashCreate(20);
365
366         const char** params = xsltParamArrayFromParameterMap(m_parameters);
367         xsltQuoteUserParams(transformContext, params);
368         xmlDocPtr resultDoc = xsltApplyStylesheetUser(sheet, sourceDoc, 0, 0, 0, transformContext);
369         
370         xsltFreeTransformContext(transformContext);        
371         freeXsltParamArray(params);
372         
373         if (shouldFreeSourceDoc)
374             xmlFreeDoc(sourceDoc);
375         
376         if (success = saveResultToString(resultDoc, sheet, resultString)) {
377             mimeType = resultMIMEType(resultDoc, sheet);
378             resultEncoding = (char*)resultDoc->encoding;
379         }
380         xmlFreeDoc(resultDoc);
381     }
382     
383     sheet->method = origMethod;
384     setXSLTLoadCallBack(0, 0, 0);
385     xsltFreeStylesheet(sheet);
386     m_stylesheet = 0;
387
388     return success;
389 }
390
391 RefPtr<Document> XSLTProcessor::transformToDocument(Node* sourceNode)
392 {
393     String resultMIMEType;
394     String resultString;
395     String resultEncoding;
396     if (!transformToString(sourceNode, resultMIMEType, resultString, resultEncoding))
397         return 0;
398     return createDocumentFromSource(resultString, resultEncoding, resultMIMEType, sourceNode, 0);
399 }
400
401 RefPtr<DocumentFragment> XSLTProcessor::transformToFragment(Node* sourceNode, Document* outputDoc)
402 {
403     String resultMIMEType;
404     String resultString;
405     String resultEncoding;
406
407     // If the output document is HTML, default to HTML method.
408     if (outputDoc->isHTMLDocument())
409         resultMIMEType = "text/html";
410     
411     if (!transformToString(sourceNode, resultMIMEType, resultString, resultEncoding))
412         return 0;
413     return createFragmentFromSource(resultString, resultMIMEType, sourceNode, outputDoc);
414 }
415
416 void XSLTProcessor::setParameter(const String& namespaceURI, const String& localName, const String& value)
417 {
418     // FIXME: namespace support?
419     // should make a QualifiedName here but we'd have to expose the impl
420     m_parameters.set(localName, value);
421 }
422
423 String XSLTProcessor::getParameter(const String& namespaceURI, const String& localName) const
424 {
425     // FIXME: namespace support?
426     // should make a QualifiedName here but we'd have to expose the impl
427     return m_parameters.get(localName);
428 }
429
430 void XSLTProcessor::removeParameter(const String& namespaceURI, const String& localName)
431 {
432     // FIXME: namespace support?
433     m_parameters.remove(localName);
434 }
435
436 } // namespace WebCore
437
438 #endif // ENABLE(XSLT)