xmltooling/AbstractDOMCachingXMLObject.cpp

   1 /*
   2  *  Copyright 2001-2010 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * AbstractDOMCachingXMLObject.cpp
  19  *
  20  * Extension of AbstractXMLObject that implements a DOMCachingXMLObject.
  21  */
  22
  23 #include "internal.h"
  24 #include "AbstractDOMCachingXMLObject.h"
  25 #include "exceptions.h"
  26 #include "XMLObjectBuilder.h"
  27 #include "util/XMLHelper.h"
  28
  29 #include <algorithm>
  30 #include <functional>
  31
  32 using namespace xmltooling;
  33 using namespace xercesc;
  34 using namespace std;
  35
  36 AbstractDOMCachingXMLObject::AbstractDOMCachingXMLObject() : m_dom(NULL), m_document(NULL)
  37 {
  38 }
  39
  40 AbstractDOMCachingXMLObject::AbstractDOMCachingXMLObject(const AbstractDOMCachingXMLObject& src)
  41     : AbstractXMLObject(src), m_dom(NULL), m_document(NULL)
  42 {
  43 }
  44
  45 AbstractDOMCachingXMLObject::~AbstractDOMCachingXMLObject()
  46 {
  47     if (m_document)
  48         m_document->release();
  49 }
  50
  51 DOMElement* AbstractDOMCachingXMLObject::getDOM() const
  52 {
  53     return m_dom;
  54 }
  55
  56 void AbstractDOMCachingXMLObject::setDOM(DOMElement* dom, bool bindDocument) const
  57 {
  58     m_dom=dom;
  59     if (dom) {
  60         if (bindDocument) {
  61             setDocument(dom->getOwnerDocument());
  62         }
  63     }
  64 }
  65
  66 void AbstractDOMCachingXMLObject::setDocument(DOMDocument* doc) const
  67 {
  68     if (m_document != doc) {
  69         if (m_document)
  70             m_document->release();
  71         m_document=doc;
  72     }
  73 }
  74
  75 void AbstractDOMCachingXMLObject::releaseDOM() const
  76 {
  77     if (m_dom) {
  78         if (m_log.isDebugEnabled()) {
  79             string qname=getElementQName().toString();
  80             m_log.debug("releasing cached DOM representation for (%s)", qname.empty() ? "unknown" : qname.c_str());
  81         }
  82         setDOM(NULL);
  83     }
  84 }
  85
  86 void AbstractDOMCachingXMLObject::releaseParentDOM(bool propagateRelease) const
  87 {
  88     if (getParent() && getParent()->getDOM()) {
  89         m_log.debug(
  90             "releasing cached DOM representation for parent object with propagation set to %s",
  91             propagateRelease ? "true" : "false"
  92             );
  93         getParent()->releaseDOM();
  94         if (propagateRelease)
  95             getParent()->releaseParentDOM(propagateRelease);
  96     }
  97 }
  98
  99 namespace {
 100     class _release : public binary_function<XMLObject*,bool,void> {
 101     public:
 102         void operator()(XMLObject* obj, bool propagate) const {
 103             if (obj) {
 104                 obj->releaseDOM();
 105                 if (propagate)
 106                     obj->releaseChildrenDOM(propagate);
 107             }
 108         }
 109     };
 110 };
 111
 112 void AbstractDOMCachingXMLObject::releaseChildrenDOM(bool propagateRelease) const
 113 {
 114     if (hasChildren()) {
 115         m_log.debug(
 116             "releasing cached DOM representation for children with propagation set to %s",
 117             propagateRelease ? "true" : "false"
 118             );
 119         const list<XMLObject*>& children=getOrderedChildren();
 120         for_each(children.begin(),children.end(),bind2nd(_release(),propagateRelease));
 121     }
 122 }
 123
 124 DOMElement* AbstractDOMCachingXMLObject::cloneDOM(DOMDocument* doc) const
 125 {
 126     if (getDOM()) {
 127         DOMDocument* cloneDoc = doc;
 128         if (!cloneDoc)
 129             cloneDoc=DOMImplementationRegistry::getDOMImplementation(NULL)->createDocument();
 130         try {
 131             return static_cast<DOMElement*>(cloneDoc->importNode(getDOM(),true));
 132         }
 133         catch (XMLException& ex) {
 134             if (!doc)
 135                 cloneDoc->release();
 136             auto_ptr_char temp(ex.getMessage());
 137             m_log.error("DOM clone failed: %s", temp.get());
 138         }
 139     }
 140     return NULL;
 141 }
 142
 143 XMLObject* AbstractDOMCachingXMLObject::clone() const
 144 {
 145     // See if we can clone via the DOM.
 146     DOMElement* domCopy=cloneDOM();
 147     if (domCopy) {
 148         // Seemed to work, so now we unmarshall the DOM to produce the clone.
 149         const XMLObjectBuilder* b=XMLObjectBuilder::getBuilder(domCopy);
 150         if (!b) {
 151             auto_ptr<QName> q(XMLHelper::getNodeQName(domCopy));
 152             m_log.error(
 153                 "DOM clone failed, unable to locate builder for element (%s)", q->toString().c_str()
 154                 );
 155             domCopy->getOwnerDocument()->release();
 156             throw UnmarshallingException("Unable to locate builder for cloned element.");
 157         }
 158         XercesJanitor<DOMDocument> janitor(domCopy->getOwnerDocument());
 159         XMLObject* ret = b->buildFromElement(domCopy,true); // bind document
 160         janitor.release(); // safely transferred
 161         return ret;
 162     }
 163     return NULL;
 164 }
 165
 166 void AbstractDOMCachingXMLObject::detach()
 167 {
 168     // This is an override that duplicates some of the checking in the base class but
 169     // adds document management in preparation for deletion of the parent.
 170
 171     if (!getParent())
 172         return;
 173
 174     if (getParent()->hasParent())
 175         throw XMLObjectException("Cannot detach an object whose parent is itself a child.");
 176
 177     AbstractDOMCachingXMLObject* parent = dynamic_cast<AbstractDOMCachingXMLObject*>(getParent());
 178     if (parent && parent->m_document) {
 179         // Transfer control of document to me...
 180         setDocument(parent->m_document);
 181         parent->m_document = NULL;
 182     }
 183     // The rest is done by the base.
 184     AbstractXMLObject::detach();
 185 }