Always enable ENABLE(XPATH)
[WebKit.git] / Source / WebCore / xml / XSLTProcessorLibxslt.cpp
1 /*
2  * This file is part of the XSL implementation.
3  *
4  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple, Inc. All rights reserved.
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 "CachedResourceLoader.h"
30 #include "Console.h"
31 #include "DOMWindow.h"
32 #include "Document.h"
33 #include "Frame.h"
34 #include "ResourceError.h"
35 #include "ResourceHandle.h"
36 #include "ResourceRequest.h"
37 #include "ResourceResponse.h"
38 #include "SecurityOrigin.h"
39 #include "TransformSource.h"
40 #include "XMLDocumentParser.h"
41 #include "XSLStyleSheet.h"
42 #include "XSLTExtensions.h"
43 #include "XSLTUnicodeSort.h"
44 #include "markup.h"
45 #include <libxslt/imports.h>
46 #include <libxslt/security.h>
47 #include <libxslt/variables.h>
48 #include <libxslt/xsltutils.h>
49 #include <wtf/Assertions.h>
50 #include <wtf/Vector.h>
51 #include <wtf/text/CString.h>
52 #include <wtf/text/StringBuffer.h>
53 #include <wtf/unicode/UTF8.h>
54
55 #if PLATFORM(MAC)
56 #include "SoftLinking.h"
57
58 SOFT_LINK_LIBRARY(libxslt);
59 SOFT_LINK(libxslt, xsltFreeStylesheet, void, (xsltStylesheetPtr sheet), (sheet))
60 SOFT_LINK(libxslt, xsltFreeTransformContext, void, (xsltTransformContextPtr ctxt), (ctxt))
61 SOFT_LINK(libxslt, xsltNewTransformContext, xsltTransformContextPtr, (xsltStylesheetPtr style, xmlDocPtr doc), (style, doc))
62 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))
63 SOFT_LINK(libxslt, xsltQuoteUserParams, int, (xsltTransformContextPtr ctxt, const char** params), (ctxt, params))
64 SOFT_LINK(libxslt, xsltSetCtxtSortFunc, void, (xsltTransformContextPtr ctxt, xsltSortFunc handler), (ctxt, handler))
65 SOFT_LINK(libxslt, xsltSetLoaderFunc, void, (xsltDocLoaderFunc f), (f))
66 SOFT_LINK(libxslt, xsltSaveResultTo, int, (xmlOutputBufferPtr buf, xmlDocPtr result, xsltStylesheetPtr style), (buf, result, style))
67 SOFT_LINK(libxslt, xsltNextImport, xsltStylesheetPtr, (xsltStylesheetPtr style), (style))
68 SOFT_LINK(libxslt, xsltNewSecurityPrefs, xsltSecurityPrefsPtr, (), ())
69 SOFT_LINK(libxslt, xsltFreeSecurityPrefs, void, (xsltSecurityPrefsPtr sec), (sec))
70 SOFT_LINK(libxslt, xsltSetSecurityPrefs, int, (xsltSecurityPrefsPtr sec, xsltSecurityOption option, xsltSecurityCheck func), (sec, option, func))
71 SOFT_LINK(libxslt, xsltSetCtxtSecurityPrefs, int, (xsltSecurityPrefsPtr sec, xsltTransformContextPtr ctxt), (sec, ctxt))
72 SOFT_LINK(libxslt, xsltSecurityForbid, int, (xsltSecurityPrefsPtr sec, xsltTransformContextPtr ctxt, const char* value), (sec, ctxt, value))
73
74 #endif
75
76 namespace WebCore {
77
78 void XSLTProcessor::genericErrorFunc(void*, const char*, ...)
79 {
80     // It would be nice to do something with this error message.
81 }
82
83 void XSLTProcessor::parseErrorFunc(void* userData, xmlError* error)
84 {
85     Console* console = static_cast<Console*>(userData);
86     if (!console)
87         return;
88
89     MessageLevel level;
90     switch (error->level) {
91     case XML_ERR_NONE:
92         level = TipMessageLevel;
93         break;
94     case XML_ERR_WARNING:
95         level = WarningMessageLevel;
96         break;
97     case XML_ERR_ERROR:
98     case XML_ERR_FATAL:
99     default:
100         level = ErrorMessageLevel;
101         break;
102     }
103
104     console->addMessage(XMLMessageSource, LogMessageType, level, error->message, error->line, error->file);
105 }
106
107 // FIXME: There seems to be no way to control the ctxt pointer for loading here, thus we have globals.
108 static XSLTProcessor* globalProcessor = 0;
109 static CachedResourceLoader* globalCachedResourceLoader = 0;
110 static xmlDocPtr docLoaderFunc(const xmlChar* uri,
111                                xmlDictPtr,
112                                int options,
113                                void* ctxt,
114                                xsltLoadType type)
115 {
116     if (!globalProcessor)
117         return 0;
118
119     switch (type) {
120     case XSLT_LOAD_DOCUMENT: {
121         xsltTransformContextPtr context = (xsltTransformContextPtr)ctxt;
122         xmlChar* base = xmlNodeGetBase(context->document->doc, context->node);
123         KURL url(KURL(ParsedURLString, reinterpret_cast<const char*>(base)), reinterpret_cast<const char*>(uri));
124         xmlFree(base);
125         ResourceError error;
126         ResourceResponse response;
127
128         Vector<char> data;
129
130         bool requestAllowed = globalCachedResourceLoader->frame() && globalCachedResourceLoader->document()->securityOrigin()->canRequest(url);
131         if (requestAllowed) {
132             globalCachedResourceLoader->frame()->loader()->loadResourceSynchronously(url, AllowStoredCredentials, error, response, data);
133             requestAllowed = globalCachedResourceLoader->document()->securityOrigin()->canRequest(response.url());
134         }
135         if (!requestAllowed) {
136             data.clear();
137             globalCachedResourceLoader->printAccessDeniedMessage(url);
138         }
139
140         Console* console = 0;
141         if (Frame* frame = globalProcessor->xslStylesheet()->ownerDocument()->frame())
142             console = frame->domWindow()->console();
143         xmlSetStructuredErrorFunc(console, XSLTProcessor::parseErrorFunc);
144         xmlSetGenericErrorFunc(console, XSLTProcessor::genericErrorFunc);
145
146         // We don't specify an encoding here. Neither Gecko nor WinIE respects
147         // the encoding specified in the HTTP headers.
148         xmlDocPtr doc = xmlReadMemory(data.data(), data.size(), (const char*)uri, 0, options);
149
150         xmlSetStructuredErrorFunc(0, 0);
151         xmlSetGenericErrorFunc(0, 0);
152
153         return doc;
154     }
155     case XSLT_LOAD_STYLESHEET:
156         return globalProcessor->xslStylesheet()->locateStylesheetSubResource(((xsltStylesheetPtr)ctxt)->doc, uri);
157     default:
158         break;
159     }
160
161     return 0;
162 }
163
164 static inline void setXSLTLoadCallBack(xsltDocLoaderFunc func, XSLTProcessor* processor, CachedResourceLoader* cachedResourceLoader)
165 {
166     xsltSetLoaderFunc(func);
167     globalProcessor = processor;
168     globalCachedResourceLoader = cachedResourceLoader;
169 }
170
171 static int writeToStringBuilder(void* context, const char* buffer, int len)
172 {
173     StringBuilder& resultOutput = *static_cast<StringBuilder*>(context);
174
175     if (!len)
176         return 0;
177
178     StringBuffer stringBuffer(len);
179     UChar* bufferUChar = stringBuffer.characters();
180     UChar* bufferUCharEnd = bufferUChar + len;
181
182     const char* stringCurrent = buffer;
183     WTF::Unicode::ConversionResult result = WTF::Unicode::convertUTF8ToUTF16(&stringCurrent, buffer + len, &bufferUChar, bufferUCharEnd);
184     if (result != WTF::Unicode::conversionOK && result != WTF::Unicode::sourceExhausted) {
185         ASSERT_NOT_REACHED();
186         return -1;
187     }
188
189     int utf16Length = bufferUChar - stringBuffer.characters();
190     resultOutput.append(stringBuffer.characters(), utf16Length);
191     return stringCurrent - buffer;
192 }
193
194 static bool saveResultToString(xmlDocPtr resultDoc, xsltStylesheetPtr sheet, String& resultString)
195 {
196     xmlOutputBufferPtr outputBuf = xmlAllocOutputBuffer(0);
197     if (!outputBuf)
198         return false;
199
200     StringBuilder resultBuilder;
201     outputBuf->context = &resultBuilder;
202     outputBuf->writecallback = writeToStringBuilder;
203
204     int retval = xsltSaveResultTo(outputBuf, resultDoc, sheet);
205     xmlOutputBufferClose(outputBuf);
206     if (retval < 0)
207         return false;
208
209     // Workaround for <http://bugzilla.gnome.org/show_bug.cgi?id=495668>: libxslt appends an extra line feed to the result.
210     if (resultBuilder.length() > 0 && resultBuilder[resultBuilder.length() - 1] == '\n')
211         resultBuilder.resize(resultBuilder.length() - 1);
212
213     resultString = resultBuilder.toString();
214
215     return true;
216 }
217
218 static const char** xsltParamArrayFromParameterMap(XSLTProcessor::ParameterMap& parameters)
219 {
220     if (parameters.isEmpty())
221         return 0;
222
223     const char** parameterArray = (const char**)fastMalloc(((parameters.size() * 2) + 1) * sizeof(char*));
224
225     XSLTProcessor::ParameterMap::iterator end = parameters.end();
226     unsigned index = 0;
227     for (XSLTProcessor::ParameterMap::iterator it = parameters.begin(); it != end; ++it) {
228         parameterArray[index++] = fastStrDup(it->first.utf8().data());
229         parameterArray[index++] = fastStrDup(it->second.utf8().data());
230     }
231     parameterArray[index] = 0;
232
233     return parameterArray;
234 }
235
236 static void freeXsltParamArray(const char** params)
237 {
238     const char** temp = params;
239     if (!params)
240         return;
241
242     while (*temp) {
243         fastFree((void*)*(temp++));
244         fastFree((void*)*(temp++));
245     }
246     fastFree(params);
247 }
248
249 static xsltStylesheetPtr xsltStylesheetPointer(RefPtr<XSLStyleSheet>& cachedStylesheet, Node* stylesheetRootNode)
250 {
251     if (!cachedStylesheet && stylesheetRootNode) {
252         cachedStylesheet = XSLStyleSheet::createForXSLTProcessor(stylesheetRootNode->parentNode() ? stylesheetRootNode->parentNode() : stylesheetRootNode,
253             stylesheetRootNode->document()->url().string(),
254             stylesheetRootNode->document()->url()); // FIXME: Should we use baseURL here?
255
256         // According to Mozilla documentation, the node must be a Document node, an xsl:stylesheet or xsl:transform element.
257         // But we just use text content regardless of node type.
258         cachedStylesheet->parseString(createMarkup(stylesheetRootNode));
259     }
260
261     if (!cachedStylesheet || !cachedStylesheet->document())
262         return 0;
263
264     return cachedStylesheet->compileStyleSheet();
265 }
266
267 static inline xmlDocPtr xmlDocPtrFromNode(Node* sourceNode, bool& shouldDelete)
268 {
269     RefPtr<Document> ownerDocument = sourceNode->document();
270     bool sourceIsDocument = (sourceNode == ownerDocument.get());
271
272     xmlDocPtr sourceDoc = 0;
273     if (sourceIsDocument && ownerDocument->transformSource())
274         sourceDoc = (xmlDocPtr)ownerDocument->transformSource()->platformSource();
275     if (!sourceDoc) {
276         sourceDoc = (xmlDocPtr)xmlDocPtrForString(ownerDocument->cachedResourceLoader(), createMarkup(sourceNode),
277             sourceIsDocument ? ownerDocument->url().string() : String());
278         shouldDelete = sourceDoc;
279     }
280     return sourceDoc;
281 }
282
283 static inline String resultMIMEType(xmlDocPtr resultDoc, xsltStylesheetPtr sheet)
284 {
285     // There are three types of output we need to be able to deal with:
286     // HTML (create an HTML document), XML (create an XML document),
287     // and text (wrap in a <pre> and create an XML document).
288
289     const xmlChar* resultType = 0;
290     XSLT_GET_IMPORT_PTR(resultType, sheet, method);
291     if (!resultType && resultDoc->type == XML_HTML_DOCUMENT_NODE)
292         resultType = (const xmlChar*)"html";
293
294     if (xmlStrEqual(resultType, (const xmlChar*)"html"))
295         return "text/html";
296     if (xmlStrEqual(resultType, (const xmlChar*)"text"))
297         return "text/plain";
298
299     return "application/xml";
300 }
301
302 bool XSLTProcessor::transformToString(Node* sourceNode, String& mimeType, String& resultString, String& resultEncoding)
303 {
304     RefPtr<Document> ownerDocument = sourceNode->document();
305
306     setXSLTLoadCallBack(docLoaderFunc, this, ownerDocument->cachedResourceLoader());
307     xsltStylesheetPtr sheet = xsltStylesheetPointer(m_stylesheet, m_stylesheetRootNode.get());
308     if (!sheet) {
309         setXSLTLoadCallBack(0, 0, 0);
310         return false;
311     }
312     m_stylesheet->clearDocuments();
313
314     xmlChar* origMethod = sheet->method;
315     if (!origMethod && mimeType == "text/html")
316         sheet->method = (xmlChar*)"html";
317
318     bool success = false;
319     bool shouldFreeSourceDoc = false;
320     if (xmlDocPtr sourceDoc = xmlDocPtrFromNode(sourceNode, shouldFreeSourceDoc)) {
321         // The XML declaration would prevent parsing the result as a fragment, and it's not needed even for documents,
322         // as the result of this function is always immediately parsed.
323         sheet->omitXmlDeclaration = true;
324
325         xsltTransformContextPtr transformContext = xsltNewTransformContext(sheet, sourceDoc);
326         registerXSLTExtensions(transformContext);
327
328         xsltSecurityPrefsPtr securityPrefs = xsltNewSecurityPrefs();
329         // Read permissions are checked by docLoaderFunc.
330         if (0 != xsltSetSecurityPrefs(securityPrefs, XSLT_SECPREF_WRITE_FILE, xsltSecurityForbid))
331             CRASH();
332         if (0 != xsltSetSecurityPrefs(securityPrefs, XSLT_SECPREF_CREATE_DIRECTORY, xsltSecurityForbid))
333             CRASH();
334         if (0 != xsltSetSecurityPrefs(securityPrefs, XSLT_SECPREF_WRITE_NETWORK, xsltSecurityForbid))
335             CRASH();
336         if (0 != xsltSetCtxtSecurityPrefs(securityPrefs, transformContext))
337             CRASH();
338
339         // <http://bugs.webkit.org/show_bug.cgi?id=16077>: XSLT processor <xsl:sort> algorithm only compares by code point.
340         xsltSetCtxtSortFunc(transformContext, xsltUnicodeSortFunction);
341
342         // This is a workaround for a bug in libxslt.
343         // The bug has been fixed in version 1.1.13, so once we ship that this can be removed.
344         if (!transformContext->globalVars)
345            transformContext->globalVars = xmlHashCreate(20);
346
347         const char** params = xsltParamArrayFromParameterMap(m_parameters);
348         xsltQuoteUserParams(transformContext, params);
349         xmlDocPtr resultDoc = xsltApplyStylesheetUser(sheet, sourceDoc, 0, 0, 0, transformContext);
350
351         xsltFreeTransformContext(transformContext);
352         xsltFreeSecurityPrefs(securityPrefs);
353         freeXsltParamArray(params);
354
355         if (shouldFreeSourceDoc)
356             xmlFreeDoc(sourceDoc);
357
358         if ((success = saveResultToString(resultDoc, sheet, resultString))) {
359             mimeType = resultMIMEType(resultDoc, sheet);
360             resultEncoding = (char*)resultDoc->encoding;
361         }
362         xmlFreeDoc(resultDoc);
363     }
364
365     sheet->method = origMethod;
366     setXSLTLoadCallBack(0, 0, 0);
367     xsltFreeStylesheet(sheet);
368     m_stylesheet = 0;
369
370     return success;
371 }
372
373 } // namespace WebCore
374
375 #endif // ENABLE(XSLT)