xmlsecurity/inc/xmlsec/xmldocumentwrapper_xmlsecimpl.hxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #pragma once
  21
  22 #include <com/sun/star/xml/wrapper/XXMLDocumentWrapper.hpp>
  23 #include <com/sun/star/xml/csax/XCompressedDocumentHandler.hpp>
  24 #include <com/sun/star/lang/XServiceInfo.hpp>
  25 #include <cppuhelper/implbase.hxx>
  26
  27 #include <xmlsec/saxhelper.hxx>
  28 #include <xsecxmlsecdllapi.h>
  29
  30 #define NODEPOSITION_NORMAL        1
  31 #define NODEPOSITION_STARTELEMENT  2
  32 #define NODEPOSITION_ENDELEMENT    3
  33
  34 class XMLDocumentWrapper_XmlSecImpl final : public cppu::WeakImplHelper
  35 <
  36     css::xml::wrapper::XXMLDocumentWrapper,
  37     css::xml::sax::XDocumentHandler,
  38     css::xml::csax::XCompressedDocumentHandler,
  39     css::lang::XServiceInfo
  40 >
  41 /**
  42  *   NAME
  43  *  XMLDocumentWrapper_XmlSecImpl -- Class to manipulate a libxml2
  44  *  document
  45  *
  46  *   FUNCTION
  47  *  Converts SAX events into a libxml2 document, converts the document back
  48  *  into SAX event stream, and manipulate nodes in the document.
  49  ******************************************************************************/
  50 {
  51 private:
  52     /* the sax helper */
  53     SAXHelper saxHelper;
  54
  55     /* the document used to convert SAX events to */
  56     xmlDocPtr m_pDocument;
  57
  58     /* the root element */
  59     xmlNodePtr m_pRootElement;
  60
  61     /*
  62      * the current active element. The next incoming SAX event will be
  63      * appended to this element
  64      */
  65     xmlNodePtr m_pCurrentElement;
  66
  67     /*
  68      * This variable is used when converting the document or part of it into
  69      * SAX events. See getNextSAXEvent method.
  70      */
  71     sal_Int32 m_nCurrentPosition;
  72
  73     /*
  74      * used for recursive deletion. See recursiveDelete method
  75      */
  76     xmlNodePtr m_pStopAtNode;
  77     xmlNodePtr m_pCurrentReservedNode;
  78     css::uno::Sequence< css::uno::Reference< css::xml::wrapper::XXMLElementWrapper > > m_aReservedNodes;
  79     sal_Int32 m_nReservedNodeIndex;
  80
  81 private:
  82     void getNextSAXEvent();
  83
  84     /// @throws css::xml::sax::SAXException
  85     static void sendStartElement(
  86         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler,
  87         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler2,
  88         const xmlNodePtr pNode);
  89
  90     /// @throws css::xml::sax::SAXException
  91     static void sendEndElement(
  92         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler,
  93         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler2,
  94         const xmlNodePtr pNode);
  95
  96     /// @throws css::xml::sax::SAXException
  97     static void sendNode(
  98         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler,
  99         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xHandler2,
 100         const xmlNodePtr pNode);
 101
 102     static OString getNodeQName(const xmlNodePtr pNode);
 103
 104     sal_Int32 recursiveDelete( const xmlNodePtr pNode);
 105
 106     void getNextReservedNode();
 107
 108     void removeNode( const xmlNodePtr pNode) const;
 109
 110     static xmlNodePtr checkElement(
 111         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& xXMLElement);
 112
 113     void buildIDAttr( xmlNodePtr pNode ) const;
 114     void rebuildIDLink( xmlNodePtr pNode ) const;
 115
 116 public:
 117     XSECXMLSEC_DLLPUBLIC XMLDocumentWrapper_XmlSecImpl();
 118     virtual ~XMLDocumentWrapper_XmlSecImpl() override;
 119
 120     /* css::xml::wrapper::XXMLDocumentWrapper */
 121     virtual css::uno::Reference< css::xml::wrapper::XXMLElementWrapper > SAL_CALL getCurrentElement(  ) override;
 122
 123     virtual void SAL_CALL setCurrentElement( const css::uno::Reference<
 124         css::xml::wrapper::XXMLElementWrapper >& element ) override;
 125
 126     virtual void SAL_CALL removeCurrentElement(  ) override;
 127
 128     virtual sal_Bool SAL_CALL isCurrent( const css::uno::Reference<
 129         css::xml::wrapper::XXMLElementWrapper >& node ) override;
 130
 131     virtual sal_Bool SAL_CALL isCurrentElementEmpty(  ) override;
 132
 133     virtual OUString SAL_CALL getNodeName( const css::uno::Reference<
 134         css::xml::wrapper::XXMLElementWrapper >& node ) override;
 135
 136     virtual void SAL_CALL clearUselessData(
 137         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& node,
 138         const css::uno::Sequence< css::uno::Reference< css::xml::wrapper::XXMLElementWrapper > >& reservedDescendants,
 139         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& stopAtNode ) override;
 140
 141     virtual void SAL_CALL collapse( const css::uno::Reference<
 142         css::xml::wrapper::XXMLElementWrapper >& node ) override;
 143
 144     virtual void SAL_CALL generateSAXEvents(
 145         const css::uno::Reference< css::xml::sax::XDocumentHandler >& handler,
 146         const css::uno::Reference< css::xml::sax::XDocumentHandler >& xEventKeeperHandler,
 147         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& startNode,
 148         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& endNode ) override;
 149
 150     virtual void SAL_CALL getTree(
 151         const css::uno::Reference< css::xml::sax::XDocumentHandler >& handler ) override;
 152
 153     virtual void SAL_CALL rebuildIDLink(
 154         const css::uno::Reference< css::xml::wrapper::XXMLElementWrapper >& node ) override;
 155
 156     /* css::xml::sax::XDocumentHandler */
 157     virtual void SAL_CALL startDocument(  ) override;
 158
 159     virtual void SAL_CALL endDocument(  ) override;
 160
 161     virtual void SAL_CALL startElement(
 162         const OUString& aName,
 163         const css::uno::Reference< css::xml::sax::XAttributeList >& xAttribs ) override;
 164
 165     virtual void SAL_CALL endElement( const OUString& aName ) override;
 166
 167     virtual void SAL_CALL characters( const OUString& aChars ) override;
 168
 169     virtual void SAL_CALL ignorableWhitespace( const OUString& aWhitespaces ) override;
 170
 171     virtual void SAL_CALL processingInstruction( const OUString& aTarget, const OUString& aData ) override;
 172
 173     virtual void SAL_CALL setDocumentLocator( const css::uno::Reference< css::xml::sax::XLocator >& xLocator ) override;
 174
 175     /* css::xml::csax::XCompressedDocumentHandler */
 176     virtual void SAL_CALL compressedStartDocument(  ) override;
 177
 178     virtual void SAL_CALL compressedEndDocument(  ) override;
 179
 180     virtual void SAL_CALL compressedStartElement(
 181         const OUString& aName,
 182         const css::uno::Sequence< css::xml::csax::XMLAttribute >& aAttributes ) override;
 183
 184     virtual void SAL_CALL compressedEndElement( const OUString& aName ) override;
 185
 186     virtual void SAL_CALL compressedCharacters( const OUString& aChars ) override;
 187
 188     virtual void SAL_CALL compressedIgnorableWhitespace( const OUString& aWhitespaces ) override;
 189
 190     virtual void SAL_CALL compressedProcessingInstruction( const OUString& aTarget, const OUString& aData ) override;
 191
 192     virtual void SAL_CALL compressedSetDocumentLocator(
 193         sal_Int32 columnNumber,
 194         sal_Int32 lineNumber,
 195         const OUString& publicId,
 196         const OUString& systemId ) override;
 197
 198     /* css::lang::XServiceInfo */
 199     virtual OUString SAL_CALL getImplementationName(  ) override;
 200
 201     virtual sal_Bool SAL_CALL supportsService( const OUString& ServiceName ) override;
 202
 203     virtual css::uno::Sequence< OUString > SAL_CALL getSupportedServiceNames(  ) override;
 204 };
 205
 206 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */