1*b1cdbd2cSJim Jagielski /**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski
24*b1cdbd2cSJim Jagielski // MARKER(update_precomp.py): autogen include statement, do not remove
25*b1cdbd2cSJim Jagielski #include "precompiled_xmloff.hxx"
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski #include "DomBuilderContext.hxx"
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielski #include <xmloff/nmspmap.hxx>
30*b1cdbd2cSJim Jagielski #include <xmloff/xmlimp.hxx>
31*b1cdbd2cSJim Jagielski #include "xmloff/xmlerror.hxx"
32*b1cdbd2cSJim Jagielski
33*b1cdbd2cSJim Jagielski #include <com/sun/star/lang/XMultiServiceFactory.hpp>
34*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Reference.hxx>
35*b1cdbd2cSJim Jagielski #include <com/sun/star/uno/Sequence.hxx>
36*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/dom/XAttr.hpp>
37*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/dom/XDocumentBuilder.hpp>
38*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/dom/XNode.hpp>
39*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/dom/XElement.hpp>
40*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/sax/XAttributeList.hpp>
41*b1cdbd2cSJim Jagielski #include <com/sun/star/xml/dom/NodeType.hpp>
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski #include <rtl/ustring.hxx>
44*b1cdbd2cSJim Jagielski #include <tools/debug.hxx>
45*b1cdbd2cSJim Jagielski
46*b1cdbd2cSJim Jagielski #include <unotools/processfactory.hxx>
47*b1cdbd2cSJim Jagielski
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski using com::sun::star::lang::XMultiServiceFactory;
50*b1cdbd2cSJim Jagielski using com::sun::star::uno::Reference;
51*b1cdbd2cSJim Jagielski using com::sun::star::uno::Sequence;
52*b1cdbd2cSJim Jagielski using com::sun::star::uno::UNO_QUERY;
53*b1cdbd2cSJim Jagielski using com::sun::star::uno::UNO_QUERY_THROW;
54*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::XAttr;
55*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::XDocument;
56*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::XDocumentBuilder;
57*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::XNode;
58*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::XElement;
59*b1cdbd2cSJim Jagielski using com::sun::star::xml::sax::XAttributeList;
60*b1cdbd2cSJim Jagielski using com::sun::star::xml::dom::NodeType_ELEMENT_NODE;
61*b1cdbd2cSJim Jagielski using rtl::OUString;
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski
64*b1cdbd2cSJim Jagielski // helper functions; implemented below
65*b1cdbd2cSJim Jagielski Reference<XNode> lcl_createDomInstance();
66*b1cdbd2cSJim Jagielski Reference<XNode> lcl_createElement( SvXMLImport& rImport,
67*b1cdbd2cSJim Jagielski sal_uInt16 nPrefix,
68*b1cdbd2cSJim Jagielski const OUString rLocalName,
69*b1cdbd2cSJim Jagielski Reference<XNode> xParent);
70*b1cdbd2cSJim Jagielski
71*b1cdbd2cSJim Jagielski
DomBuilderContext(SvXMLImport & rImport,sal_uInt16 nPrefix,const OUString & rLocalName)72*b1cdbd2cSJim Jagielski DomBuilderContext::DomBuilderContext( SvXMLImport& rImport,
73*b1cdbd2cSJim Jagielski sal_uInt16 nPrefix,
74*b1cdbd2cSJim Jagielski const OUString& rLocalName ) :
75*b1cdbd2cSJim Jagielski SvXMLImportContext( rImport, nPrefix, rLocalName ),
76*b1cdbd2cSJim Jagielski mxNode( lcl_createElement( rImport, nPrefix, rLocalName,
77*b1cdbd2cSJim Jagielski lcl_createDomInstance() ) )
78*b1cdbd2cSJim Jagielski {
79*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode.is(), "empty XNode not allowed" );
80*b1cdbd2cSJim Jagielski DBG_ASSERT( Reference<XElement>( mxNode, UNO_QUERY ).is(), "need element" );
81*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode->getNodeType() == NodeType_ELEMENT_NODE, "need element" );
82*b1cdbd2cSJim Jagielski }
83*b1cdbd2cSJim Jagielski
DomBuilderContext(SvXMLImport & rImport,sal_uInt16 nPrefix,const OUString & rLocalName,Reference<XNode> & xParent)84*b1cdbd2cSJim Jagielski DomBuilderContext::DomBuilderContext( SvXMLImport& rImport,
85*b1cdbd2cSJim Jagielski sal_uInt16 nPrefix,
86*b1cdbd2cSJim Jagielski const OUString& rLocalName,
87*b1cdbd2cSJim Jagielski Reference<XNode>& xParent ) :
88*b1cdbd2cSJim Jagielski SvXMLImportContext( rImport, nPrefix, rLocalName ),
89*b1cdbd2cSJim Jagielski mxNode( lcl_createElement( rImport, nPrefix, rLocalName, xParent ) )
90*b1cdbd2cSJim Jagielski {
91*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode.is(), "empty XNode not allowed" );
92*b1cdbd2cSJim Jagielski DBG_ASSERT( Reference<XElement>( mxNode, UNO_QUERY ).is(), "need element" );
93*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode->getNodeType() == NodeType_ELEMENT_NODE, "need element" );
94*b1cdbd2cSJim Jagielski }
95*b1cdbd2cSJim Jagielski
~DomBuilderContext()96*b1cdbd2cSJim Jagielski DomBuilderContext::~DomBuilderContext()
97*b1cdbd2cSJim Jagielski {
98*b1cdbd2cSJim Jagielski }
99*b1cdbd2cSJim Jagielski
getTree()100*b1cdbd2cSJim Jagielski Reference<XDocument> DomBuilderContext::getTree()
101*b1cdbd2cSJim Jagielski {
102*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode.is(), "empty XNode not allowed" );
103*b1cdbd2cSJim Jagielski return mxNode->getOwnerDocument();
104*b1cdbd2cSJim Jagielski }
105*b1cdbd2cSJim Jagielski
getNode()106*b1cdbd2cSJim Jagielski Reference<XNode> DomBuilderContext::getNode()
107*b1cdbd2cSJim Jagielski {
108*b1cdbd2cSJim Jagielski return mxNode;
109*b1cdbd2cSJim Jagielski }
110*b1cdbd2cSJim Jagielski
111*b1cdbd2cSJim Jagielski
CreateChildContext(sal_uInt16 nPrefix,const OUString & rLocalName,const Reference<XAttributeList> &)112*b1cdbd2cSJim Jagielski SvXMLImportContext* DomBuilderContext::CreateChildContext(
113*b1cdbd2cSJim Jagielski sal_uInt16 nPrefix,
114*b1cdbd2cSJim Jagielski const OUString& rLocalName,
115*b1cdbd2cSJim Jagielski const Reference<XAttributeList>& )
116*b1cdbd2cSJim Jagielski {
117*b1cdbd2cSJim Jagielski // create DomBuilder for subtree
118*b1cdbd2cSJim Jagielski return new DomBuilderContext( GetImport(), nPrefix, rLocalName, mxNode );
119*b1cdbd2cSJim Jagielski }
120*b1cdbd2cSJim Jagielski
121*b1cdbd2cSJim Jagielski
StartElement(const Reference<XAttributeList> & xAttrList)122*b1cdbd2cSJim Jagielski void DomBuilderContext::StartElement(
123*b1cdbd2cSJim Jagielski const Reference<XAttributeList>& xAttrList )
124*b1cdbd2cSJim Jagielski {
125*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode.is(), "empty XNode not allowed" );
126*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode->getOwnerDocument().is(), "XNode must have XDocument" );
127*b1cdbd2cSJim Jagielski
128*b1cdbd2cSJim Jagielski // add attribute nodes to new node
129*b1cdbd2cSJim Jagielski sal_Int16 nAttributeCount = xAttrList->getLength();
130*b1cdbd2cSJim Jagielski for( sal_Int16 i = 0; i < nAttributeCount; i++ )
131*b1cdbd2cSJim Jagielski {
132*b1cdbd2cSJim Jagielski // get name & value for attribute
133*b1cdbd2cSJim Jagielski const OUString& rName = xAttrList->getNameByIndex( i );
134*b1cdbd2cSJim Jagielski const OUString& rValue = xAttrList->getValueByIndex( i );
135*b1cdbd2cSJim Jagielski
136*b1cdbd2cSJim Jagielski // namespace handling: determine namespace & namespace keykey
137*b1cdbd2cSJim Jagielski OUString sNamespace;
138*b1cdbd2cSJim Jagielski sal_uInt16 nNamespaceKey =
139*b1cdbd2cSJim Jagielski GetImport().GetNamespaceMap()._GetKeyByAttrName(
140*b1cdbd2cSJim Jagielski rName, NULL, NULL, &sNamespace );
141*b1cdbd2cSJim Jagielski
142*b1cdbd2cSJim Jagielski // create attribute node and set value
143*b1cdbd2cSJim Jagielski Reference<XElement> xElement( mxNode, UNO_QUERY_THROW );
144*b1cdbd2cSJim Jagielski switch( nNamespaceKey )
145*b1cdbd2cSJim Jagielski {
146*b1cdbd2cSJim Jagielski case XML_NAMESPACE_NONE:
147*b1cdbd2cSJim Jagielski // no namespace: create a non-namespaced attribute
148*b1cdbd2cSJim Jagielski xElement->setAttribute( rName, rValue );
149*b1cdbd2cSJim Jagielski break;
150*b1cdbd2cSJim Jagielski case XML_NAMESPACE_XMLNS:
151*b1cdbd2cSJim Jagielski // namespace declaration: ignore, since the DOM tree handles these
152*b1cdbd2cSJim Jagielski // declarations implicitly
153*b1cdbd2cSJim Jagielski break;
154*b1cdbd2cSJim Jagielski case XML_NAMESPACE_UNKNOWN:
155*b1cdbd2cSJim Jagielski // unknown namespace: illegal input. Raise Warning.
156*b1cdbd2cSJim Jagielski {
157*b1cdbd2cSJim Jagielski Sequence<OUString> aSeq(2);
158*b1cdbd2cSJim Jagielski aSeq[0] = rName;
159*b1cdbd2cSJim Jagielski aSeq[1] = rValue;
160*b1cdbd2cSJim Jagielski GetImport().SetError(
161*b1cdbd2cSJim Jagielski XMLERROR_FLAG_WARNING | XMLERROR_NAMESPACE_TROUBLE, aSeq );
162*b1cdbd2cSJim Jagielski }
163*b1cdbd2cSJim Jagielski break;
164*b1cdbd2cSJim Jagielski default:
165*b1cdbd2cSJim Jagielski // a real and proper namespace: create namespaced attribute
166*b1cdbd2cSJim Jagielski xElement->setAttributeNS( sNamespace, rName, rValue );
167*b1cdbd2cSJim Jagielski break;
168*b1cdbd2cSJim Jagielski }
169*b1cdbd2cSJim Jagielski }
170*b1cdbd2cSJim Jagielski }
171*b1cdbd2cSJim Jagielski
EndElement()172*b1cdbd2cSJim Jagielski void DomBuilderContext::EndElement()
173*b1cdbd2cSJim Jagielski {
174*b1cdbd2cSJim Jagielski // nothing to be done!
175*b1cdbd2cSJim Jagielski }
176*b1cdbd2cSJim Jagielski
Characters(const OUString & rCharacters)177*b1cdbd2cSJim Jagielski void DomBuilderContext::Characters( const OUString& rCharacters )
178*b1cdbd2cSJim Jagielski {
179*b1cdbd2cSJim Jagielski DBG_ASSERT( mxNode.is(), "empty XNode not allowed" );
180*b1cdbd2cSJim Jagielski
181*b1cdbd2cSJim Jagielski // TODO: I assume adjacent text nodes should be joined, to preserve
182*b1cdbd2cSJim Jagielski // processinf model? (I.e., if the SAX parser breaks a string into 2
183*b1cdbd2cSJim Jagielski // Characters(..) calls, the DOM model would still see only one child.)
184*b1cdbd2cSJim Jagielski
185*b1cdbd2cSJim Jagielski // create text node and append to parent
186*b1cdbd2cSJim Jagielski Reference<XNode> xNew(
187*b1cdbd2cSJim Jagielski mxNode->getOwnerDocument()->createTextNode( rCharacters ),
188*b1cdbd2cSJim Jagielski UNO_QUERY_THROW );
189*b1cdbd2cSJim Jagielski mxNode->appendChild( xNew );
190*b1cdbd2cSJim Jagielski }
191*b1cdbd2cSJim Jagielski
192*b1cdbd2cSJim Jagielski
193*b1cdbd2cSJim Jagielski //
194*b1cdbd2cSJim Jagielski // helper function implementations
195*b1cdbd2cSJim Jagielski //
196*b1cdbd2cSJim Jagielski
197*b1cdbd2cSJim Jagielski const sal_Char sDocumentBuilder[] = "com.sun.star.xml.dom.DocumentBuilder";
198*b1cdbd2cSJim Jagielski
lcl_createDomInstance()199*b1cdbd2cSJim Jagielski Reference<XNode> lcl_createDomInstance()
200*b1cdbd2cSJim Jagielski {
201*b1cdbd2cSJim Jagielski Reference<XMultiServiceFactory> xFactory = utl::getProcessServiceFactory();
202*b1cdbd2cSJim Jagielski DBG_ASSERT( xFactory.is(), "can't get service factory" );
203*b1cdbd2cSJim Jagielski
204*b1cdbd2cSJim Jagielski Reference<XDocumentBuilder> xBuilder(
205*b1cdbd2cSJim Jagielski xFactory->createInstance(
206*b1cdbd2cSJim Jagielski OUString( RTL_CONSTASCII_USTRINGPARAM( sDocumentBuilder ) ) ),
207*b1cdbd2cSJim Jagielski UNO_QUERY_THROW );
208*b1cdbd2cSJim Jagielski
209*b1cdbd2cSJim Jagielski return Reference<XNode>( xBuilder->newDocument(), UNO_QUERY_THROW );
210*b1cdbd2cSJim Jagielski }
211*b1cdbd2cSJim Jagielski
lcl_createElement(SvXMLImport & rImport,sal_uInt16 nPrefix,const OUString rLocalName,Reference<XNode> xParent)212*b1cdbd2cSJim Jagielski Reference<XNode> lcl_createElement( SvXMLImport& rImport,
213*b1cdbd2cSJim Jagielski sal_uInt16 nPrefix,
214*b1cdbd2cSJim Jagielski const OUString rLocalName,
215*b1cdbd2cSJim Jagielski Reference<XNode> xParent)
216*b1cdbd2cSJim Jagielski {
217*b1cdbd2cSJim Jagielski DBG_ASSERT( xParent.is(), "need parent node" );
218*b1cdbd2cSJim Jagielski
219*b1cdbd2cSJim Jagielski Reference<XDocument> xDocument = xParent->getOwnerDocument();
220*b1cdbd2cSJim Jagielski DBG_ASSERT( xDocument.is(), "no XDocument found!" );
221*b1cdbd2cSJim Jagielski
222*b1cdbd2cSJim Jagielski // TODO: come up with proper way of handling namespaces; re-creating the
223*b1cdbd2cSJim Jagielski // namespace from the key is NOT a good idea, and will not work for
224*b1cdbd2cSJim Jagielski // multiple prefixes for the same namespace. Fortunately, those are rare.
225*b1cdbd2cSJim Jagielski
226*b1cdbd2cSJim Jagielski Reference<XElement> xElement;
227*b1cdbd2cSJim Jagielski switch( nPrefix )
228*b1cdbd2cSJim Jagielski {
229*b1cdbd2cSJim Jagielski case XML_NAMESPACE_NONE:
230*b1cdbd2cSJim Jagielski // no namespace: use local name
231*b1cdbd2cSJim Jagielski xElement = xDocument->createElement( rLocalName );
232*b1cdbd2cSJim Jagielski break;
233*b1cdbd2cSJim Jagielski case XML_NAMESPACE_XMLNS:
234*b1cdbd2cSJim Jagielski case XML_NAMESPACE_UNKNOWN:
235*b1cdbd2cSJim Jagielski // both cases are illegal; raise warning (and use only local name)
236*b1cdbd2cSJim Jagielski xElement = xDocument->createElement( rLocalName );
237*b1cdbd2cSJim Jagielski {
238*b1cdbd2cSJim Jagielski Sequence<OUString> aSeq(1);
239*b1cdbd2cSJim Jagielski aSeq[0] = rLocalName;
240*b1cdbd2cSJim Jagielski rImport.SetError(
241*b1cdbd2cSJim Jagielski XMLERROR_FLAG_WARNING | XMLERROR_NAMESPACE_TROUBLE, aSeq );
242*b1cdbd2cSJim Jagielski }
243*b1cdbd2cSJim Jagielski break;
244*b1cdbd2cSJim Jagielski default:
245*b1cdbd2cSJim Jagielski // We are only given the prefix and the local name; thus we have to ask
246*b1cdbd2cSJim Jagielski // the namespace map to create a qualified name for us. Technically,
247*b1cdbd2cSJim Jagielski // this is a bug, since this will fail for multiple prefixes used for
248*b1cdbd2cSJim Jagielski // the same namespace.
249*b1cdbd2cSJim Jagielski xElement = xDocument->createElementNS(
250*b1cdbd2cSJim Jagielski rImport.GetNamespaceMap().GetNameByKey( nPrefix ),
251*b1cdbd2cSJim Jagielski rImport.GetNamespaceMap().GetQNameByKey( nPrefix, rLocalName ) );
252*b1cdbd2cSJim Jagielski break;
253*b1cdbd2cSJim Jagielski }
254*b1cdbd2cSJim Jagielski DBG_ASSERT( xElement.is(), "can't create element" );
255*b1cdbd2cSJim Jagielski
256*b1cdbd2cSJim Jagielski // add new element to parent and return
257*b1cdbd2cSJim Jagielski Reference<XNode> xNode( xElement, UNO_QUERY_THROW );
258*b1cdbd2cSJim Jagielski xParent->appendChild( xNode );
259*b1cdbd2cSJim Jagielski return xNode;
260*b1cdbd2cSJim Jagielski }
261