Source/WebCore/xml/XSLStyleSheetLibxslt.cpp

   1 /*
   2  * This file is part of the XSL implementation.
   3  *
   4  * Copyright (C) 2004, 2005, 2006, 2008, 2012 Apple Inc. All rights reserved.
   5  *
   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.
  10  *
  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.
  15  *
  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.
  20  */
  21
  22 #include "config.h"
  23 #include "XSLStyleSheet.h"
  24
  25 #if ENABLE(XSLT)
  26
  27 #include "Console.h"
  28 #include "DOMWindow.h"
  29 #include "CachedResourceLoader.h"
  30 #include "Document.h"
  31 #include "Frame.h"
  32 #include "Node.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>
  39
  40 #include <libxml/uri.h>
  41 #include <libxslt/xsltutils.h>
  42
  43 #if PLATFORM(MAC)
  44 #include "SoftLinking.h"
  45 #endif
  46
  47 #if PLATFORM(MAC)
  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))
  53 #endif
  54
  55 namespace WebCore {
  56
  57 XSLStyleSheet::XSLStyleSheet(XSLImportRule* parentRule, const String& originalURL, const KURL& finalURL)
  58     : m_ownerNode(0)
  59     , m_originalURL(originalURL)
  60     , m_finalURL(finalURL)
  61     , m_isDisabled(false)
  62     , m_embedded(false)
  63     , m_processed(false) // Child sheets get marked as processed when the libxslt engine has finally seen them.
  64     , m_stylesheetDoc(0)
  65     , m_stylesheetDocTaken(false)
  66     , m_parentStyleSheet(parentRule ? parentRule->parentStyleSheet() : 0)
  67 {
  68 }
  69
  70 XSLStyleSheet::XSLStyleSheet(Node* parentNode, const String& originalURL, const KURL& finalURL,  bool embedded)
  71     : m_ownerNode(parentNode)
  72     , m_originalURL(originalURL)
  73     , m_finalURL(finalURL)
  74     , m_isDisabled(false)
  75     , m_embedded(embedded)
  76     , m_processed(true) // The root sheet starts off processed.
  77     , m_stylesheetDoc(0)
  78     , m_stylesheetDocTaken(false)
  79     , m_parentStyleSheet(0)
  80 {
  81 }
  82
  83 XSLStyleSheet::~XSLStyleSheet()
  84 {
  85     if (!m_stylesheetDocTaken)
  86         xmlFreeDoc(m_stylesheetDoc);
  87
  88     for (unsigned i = 0; i < m_children.size(); ++i) {
  89         ASSERT(m_children.at(i)->parentStyleSheet() == this);
  90         m_children.at(i)->setParentStyleSheet(0);
  91     }
  92 }
  93
  94 bool XSLStyleSheet::isLoading() const
  95 {
  96     for (unsigned i = 0; i < m_children.size(); ++i) {
  97         if (m_children.at(i)->isLoading())
  98             return true;
  99     }
 100     return false;
 101 }
 102
 103 void XSLStyleSheet::checkLoaded()
 104 {
 105     if (isLoading())
 106         return;
 107     if (XSLStyleSheet* styleSheet = parentStyleSheet())
 108         styleSheet->checkLoaded();
 109     if (ownerNode())
 110         ownerNode()->sheetLoaded();
 111 }
 112
 113 xmlDocPtr XSLStyleSheet::document()
 114 {
 115     if (m_embedded && ownerDocument() && ownerDocument()->transformSource())
 116         return (xmlDocPtr)ownerDocument()->transformSource()->platformSource();
 117     return m_stylesheetDoc;
 118 }
 119
 120 void XSLStyleSheet::clearDocuments()
 121 {
 122     m_stylesheetDoc = 0;
 123     for (unsigned i = 0; i < m_children.size(); ++i) {
 124         XSLImportRule* import = m_children.at(i).get();
 125         if (import->styleSheet())
 126             import->styleSheet()->clearDocuments();
 127     }
 128 }
 129
 130 CachedResourceLoader* XSLStyleSheet::cachedResourceLoader()
 131 {
 132     Document* document = ownerDocument();
 133     if (!document)
 134         return 0;
 135     return document->cachedResourceLoader();
 136 }
 137
 138 bool XSLStyleSheet::parseString(const String& string)
 139 {
 140     // Parse in a single chunk into an xmlDocPtr
 141     const UChar BOM = 0xFEFF;
 142     const unsigned char BOMHighByte = *reinterpret_cast<const unsigned char*>(&BOM);
 143     if (!m_stylesheetDocTaken)
 144         xmlFreeDoc(m_stylesheetDoc);
 145     m_stylesheetDocTaken = false;
 146
 147     Console* console = 0;
 148     if (Frame* frame = ownerDocument()->frame())
 149         console = frame->domWindow()->console();
 150
 151     XMLDocumentParserScope scope(cachedResourceLoader(), XSLTProcessor::genericErrorFunc, XSLTProcessor::parseErrorFunc, console);
 152
 153     const char* buffer = reinterpret_cast<const char*>(string.characters());
 154     int size = string.length() * sizeof(UChar);
 155
 156     xmlParserCtxtPtr ctxt = xmlCreateMemoryParserCtxt(buffer, size);
 157     if (!ctxt)
 158         return 0;
 159
 160     if (m_parentStyleSheet) {
 161         // The XSL transform may leave the newly-transformed document
 162         // with references to the symbol dictionaries of the style sheet
 163         // and any of its children. XML document disposal can corrupt memory
 164         // if a document uses more than one symbol dictionary, so we
 165         // ensure that all child stylesheets use the same dictionaries as their
 166         // parents.
 167         xmlDictFree(ctxt->dict);
 168         ctxt->dict = m_parentStyleSheet->m_stylesheetDoc->dict;
 169         xmlDictReference(ctxt->dict);
 170     }
 171
 172     m_stylesheetDoc = xmlCtxtReadMemory(ctxt, buffer, size,
 173         finalURL().string().utf8().data(),
 174         BOMHighByte == 0xFF ? "UTF-16LE" : "UTF-16BE",
 175         XML_PARSE_NOENT | XML_PARSE_DTDATTR | XML_PARSE_NOWARNING | XML_PARSE_NOCDATA);
 176     xmlFreeParserCtxt(ctxt);
 177
 178     loadChildSheets();
 179
 180     return m_stylesheetDoc;
 181 }
 182
 183 void XSLStyleSheet::loadChildSheets()
 184 {
 185     if (!document())
 186         return;
 187
 188     xmlNodePtr stylesheetRoot = document()->children;
 189
 190     // Top level children may include other things such as DTD nodes, we ignore those.
 191     while (stylesheetRoot && stylesheetRoot->type != XML_ELEMENT_NODE)
 192         stylesheetRoot = stylesheetRoot->next;
 193
 194     if (m_embedded) {
 195         // We have to locate (by ID) the appropriate embedded stylesheet element, so that we can walk the
 196         // import/include list.
 197         xmlAttrPtr idNode = xmlGetID(document(), (const xmlChar*)(finalURL().string().utf8().data()));
 198         if (!idNode)
 199             return;
 200         stylesheetRoot = idNode->parent;
 201     } else {
 202         // FIXME: Need to handle an external URI with a # in it.  This is a pretty minor edge case, so we'll deal
 203         // with it later.
 204     }
 205
 206     if (stylesheetRoot) {
 207         // Walk the children of the root element and look for import/include elements.
 208         // Imports must occur first.
 209         xmlNodePtr curr = stylesheetRoot->children;
 210         while (curr) {
 211             if (curr->type != XML_ELEMENT_NODE) {
 212                 curr = curr->next;
 213                 continue;
 214             }
 215             if (IS_XSLT_ELEM(curr) && IS_XSLT_NAME(curr, "import")) {
 216                 xmlChar* uriRef = xsltGetNsProp(curr, (const xmlChar*)"href", XSLT_NAMESPACE);
 217                 loadChildSheet(String::fromUTF8((const char*)uriRef));
 218                 xmlFree(uriRef);
 219             } else
 220                 break;
 221             curr = curr->next;
 222         }
 223
 224         // Now handle includes.
 225         while (curr) {
 226             if (curr->type == XML_ELEMENT_NODE && IS_XSLT_ELEM(curr) && IS_XSLT_NAME(curr, "include")) {
 227                 xmlChar* uriRef = xsltGetNsProp(curr, (const xmlChar*)"href", XSLT_NAMESPACE);
 228                 loadChildSheet(String::fromUTF8((const char*)uriRef));
 229                 xmlFree(uriRef);
 230             }
 231             curr = curr->next;
 232         }
 233     }
 234 }
 235
 236 void XSLStyleSheet::loadChildSheet(const String& href)
 237 {
 238     OwnPtr<XSLImportRule> childRule = XSLImportRule::create(this, href);
 239     XSLImportRule* c = childRule.get();
 240     m_children.append(childRule.release());
 241     c->loadSheet();
 242 }
 243
 244 xsltStylesheetPtr XSLStyleSheet::compileStyleSheet()
 245 {
 246     // FIXME: Hook up error reporting for the stylesheet compilation process.
 247     if (m_embedded)
 248         return xsltLoadStylesheetPI(document());
 249
 250     // xsltParseStylesheetDoc makes the document part of the stylesheet
 251     // so we have to release our pointer to it.
 252     ASSERT(!m_stylesheetDocTaken);
 253     xsltStylesheetPtr result = xsltParseStylesheetDoc(m_stylesheetDoc);
 254     if (result)
 255         m_stylesheetDocTaken = true;
 256     return result;
 257 }
 258
 259 void XSLStyleSheet::setParentStyleSheet(XSLStyleSheet* parent)
 260 {
 261     m_parentStyleSheet = parent;
 262 }
 263
 264 Document* XSLStyleSheet::ownerDocument()
 265 {
 266     for (XSLStyleSheet* styleSheet = this; styleSheet; styleSheet = styleSheet->parentStyleSheet()) {
 267         Node* node = styleSheet->ownerNode();
 268         if (node)
 269             return node->document();
 270     }
 271     return 0;
 272 }
 273
 274 xmlDocPtr XSLStyleSheet::locateStylesheetSubResource(xmlDocPtr parentDoc, const xmlChar* uri)
 275 {
 276     bool matchedParent = (parentDoc == document());
 277     for (unsigned i = 0; i < m_children.size(); ++i) {
 278         XSLImportRule* import = m_children.at(i).get();
 279         XSLStyleSheet* child = import->styleSheet();
 280         if (!child)
 281             continue;
 282         if (matchedParent) {
 283             if (child->processed())
 284                 continue; // libxslt has been given this sheet already.
 285
 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);
 294             xmlFree(base);
 295             xmlFree(childURI);
 296             if (equalURIs) {
 297                 child->markAsProcessed();
 298                 return child->document();
 299             }
 300             continue;
 301         }
 302         xmlDocPtr result = import->styleSheet()->locateStylesheetSubResource(parentDoc, uri);
 303         if (result)
 304             return result;
 305     }
 306
 307     return 0;
 308 }
 309
 310 void XSLStyleSheet::markAsProcessed()
 311 {
 312     ASSERT(!m_processed);
 313     ASSERT(!m_stylesheetDocTaken);
 314     m_processed = true;
 315     m_stylesheetDocTaken = true;
 316 }
 317
 318 } // namespace WebCore
 319
 320 #endif // ENABLE(XSLT)