1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#include <comphelper/ofopxmlhelper.hxx>
#include <comphelper/attributelist.hxx>
#include <cppuhelper/implbase.hxx>
#include <com/sun/star/beans/StringPair.hpp>
#include <com/sun/star/lang/XMultiServiceFactory.hpp>
#include <com/sun/star/io/XActiveDataSource.hpp>
#include <com/sun/star/xml/sax/Parser.hpp>
#include <com/sun/star/xml/sax/XDocumentHandler.hpp>
#include <com/sun/star/xml/sax/Writer.hpp>
#include <com/sun/star/lang/IllegalArgumentException.hpp>
#define RELATIONINFO_FORMAT 0
#define CONTENTTYPE_FORMAT 1
#define FORMAT_MAX_ID CONTENTTYPE_FORMAT
using namespace ::com::sun::star;
namespace comphelper {
// this helper class is designed to allow to parse ContentType- and Relationship-related information from OfficeOpenXML format
class OFOPXMLHelper_Impl
: public cppu::WeakImplHelper< com::sun::star::xml::sax::XDocumentHandler >
{
sal_uInt16 m_nFormat; // which format to parse
// Relations info related strings
OUString m_aRelListElement;
OUString m_aRelElement;
OUString m_aIDAttr;
OUString m_aTypeAttr;
OUString m_aTargetModeAttr;
OUString m_aTargetAttr;
// ContentType related strings
OUString m_aTypesElement;
OUString m_aDefaultElement;
OUString m_aOverrideElement;
OUString m_aExtensionAttr;
OUString m_aPartNameAttr;
OUString m_aContentTypeAttr;
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > m_aResultSeq;
::com::sun::star::uno::Sequence< OUString > m_aElementsSeq; // stack of elements being parsed
public:
::com::sun::star::uno::Sequence< ::com::sun::star::uno::Sequence< ::com::sun::star::beans::StringPair > > GetParsingResult();
OFOPXMLHelper_Impl( sal_uInt16 nFormat ); // must not be created directly
virtual ~OFOPXMLHelper_Impl();
// XDocumentHandler
virtual void SAL_CALL startDocument() throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL endDocument() throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL startElement( const OUString& aName, const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& xAttribs ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL endElement( const OUString& aName ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL characters( const OUString& aChars ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL ignorableWhitespace( const OUString& aWhitespaces ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL processingInstruction( const OUString& aTarget, const OUString& aData ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
virtual void SAL_CALL setDocumentLocator( const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XLocator >& xLocator ) throw (::com::sun::star::xml::sax::SAXException, ::com::sun::star::uno::RuntimeException, std::exception) SAL_OVERRIDE;
};
namespace OFOPXMLHelper {
static uno::Sequence<uno::Sequence< beans::StringPair>> ReadSequence_Impl(
const uno::Reference<io::XInputStream>& xInStream,
const OUString& aStringID, sal_uInt16 nFormat,
const uno::Reference<uno::XComponentContext>& xContext)
throw (uno::Exception);
uno::Sequence< uno::Sequence< beans::StringPair > > ReadRelationsInfoSequence(
const uno::Reference< io::XInputStream >& xInStream,
const OUString & aStreamName,
const uno::Reference< uno::XComponentContext >& rContext )
throw( uno::Exception )
{
OUString aStringID = "_rels/";
aStringID += aStreamName;
return ReadSequence_Impl( xInStream, aStringID, RELATIONINFO_FORMAT, rContext );
}
uno::Sequence< uno::Sequence< beans::StringPair > > ReadContentTypeSequence(
const uno::Reference< io::XInputStream >& xInStream,
const uno::Reference< uno::XComponentContext >& rContext )
throw( uno::Exception )
{
OUString aStringID = "[Content_Types].xml";
return ReadSequence_Impl( xInStream, aStringID, CONTENTTYPE_FORMAT, rContext );
}
void WriteRelationsInfoSequence(
const uno::Reference< io::XOutputStream >& xOutStream,
const uno::Sequence< uno::Sequence< beans::StringPair > >& aSequence,
const uno::Reference< uno::XComponentContext >& rContext )
throw( uno::Exception )
{
if ( !xOutStream.is() )
throw uno::RuntimeException();
uno::Reference< xml::sax::XWriter > xWriter = xml::sax::Writer::create(rContext);
xWriter->setOutputStream( xOutStream );
OUString aRelListElement( "Relationships" );
OUString aRelElement( "Relationship" );
OUString aIDAttr( "Id" );
OUString aTypeAttr( "Type" );
OUString aTargetModeAttr( "TargetMode" );
OUString aTargetAttr( "Target" );
OUString aCDATAString( "CDATA" );
OUString aWhiteSpace( " " );
// write the namespace
AttributeList* pRootAttrList = new AttributeList;
uno::Reference< xml::sax::XAttributeList > xRootAttrList( pRootAttrList );
pRootAttrList->AddAttribute(
OUString( "xmlns" ),
aCDATAString,
OUString( "http://schemas.openxmlformats.org/package/2006/relationships" ) );
xWriter->startDocument();
xWriter->startElement( aRelListElement, xRootAttrList );
for ( sal_Int32 nInd = 0; nInd < aSequence.getLength(); nInd++ )
{
AttributeList *pAttrList = new AttributeList;
uno::Reference< xml::sax::XAttributeList > xAttrList( pAttrList );
for( sal_Int32 nSecInd = 0; nSecInd < aSequence[nInd].getLength(); nSecInd++ )
{
if ( aSequence[nInd][nSecInd].First.equals( aIDAttr )
|| aSequence[nInd][nSecInd].First.equals( aTypeAttr )
|| aSequence[nInd][nSecInd].First.equals( aTargetModeAttr )
|| aSequence[nInd][nSecInd].First.equals( aTargetAttr ) )
{
pAttrList->AddAttribute( aSequence[nInd][nSecInd].First, aCDATAString, aSequence[nInd][nSecInd].Second );
}
else
{
// TODO/LATER: should the extensions be allowed?
throw lang::IllegalArgumentException();
}
}
xWriter->startElement( aRelElement, xAttrList );
xWriter->ignorableWhitespace( aWhiteSpace );
xWriter->endElement( aRelElement );
}
xWriter->ignorableWhitespace( aWhiteSpace );
xWriter->endElement( aRelListElement );
xWriter->endDocument();
}
void WriteContentSequence(
const uno::Reference< io::XOutputStream >& xOutStream,
const uno::Sequence< beans::StringPair >& aDefaultsSequence,
const uno::Sequence< beans::StringPair >& aOverridesSequence,
const uno::Reference< uno::XComponentContext >& rContext )
throw( uno::Exception )
{
if ( !xOutStream.is() )
throw uno::RuntimeException();
uno::Reference< xml::sax::XWriter > xWriter = xml::sax::Writer::create(rContext);
xWriter->setOutputStream( xOutStream );
OUString aTypesElement( "Types" );
OUString aDefaultElement( "Default" );
OUString aOverrideElement( "Override" );
OUString aExtensionAttr( "Extension" );
OUString aPartNameAttr( "PartName" );
OUString aContentTypeAttr( "ContentType" );
OUString aCDATAString( "CDATA" );
OUString aWhiteSpace( " " );
// write the namespace
AttributeList* pRootAttrList = new AttributeList;
uno::Reference< xml::sax::XAttributeList > xRootAttrList( pRootAttrList );
pRootAttrList->AddAttribute(
OUString( "xmlns" ),
aCDATAString,
OUString( "http://schemas.openxmlformats.org/package/2006/content-types" ) );
xWriter->startDocument();
xWriter->startElement( aTypesElement, xRootAttrList );
for ( sal_Int32 nInd = 0; nInd < aDefaultsSequence.getLength(); nInd++ )
{
AttributeList *pAttrList = new AttributeList;
uno::Reference< xml::sax::XAttributeList > xAttrList( pAttrList );
pAttrList->AddAttribute( aExtensionAttr, aCDATAString, aDefaultsSequence[nInd].First );
pAttrList->AddAttribute( aContentTypeAttr, aCDATAString, aDefaultsSequence[nInd].Second );
xWriter->startElement( aDefaultElement, xAttrList );
xWriter->ignorableWhitespace( aWhiteSpace );
xWriter->endElement( aDefaultElement );
}
for ( sal_Int32 nInd = 0; nInd < aOverridesSequence.getLength(); nInd++ )
{
AttributeList *pAttrList = new AttributeList;
uno::Reference< xml::sax::XAttributeList > xAttrList( pAttrList );
pAttrList->AddAttribute( aPartNameAttr, aCDATAString, aOverridesSequence[nInd].First );
pAttrList->AddAttribute( aContentTypeAttr, aCDATAString, aOverridesSequence[nInd].Second );
xWriter->startElement( aOverrideElement, xAttrList );
xWriter->ignorableWhitespace( aWhiteSpace );
xWriter->endElement( aOverrideElement );
}
xWriter->ignorableWhitespace( aWhiteSpace );
xWriter->endElement( aTypesElement );
xWriter->endDocument();
}
uno::Sequence< uno::Sequence< beans::StringPair > > ReadSequence_Impl(
const uno::Reference< io::XInputStream >& xInStream,
const OUString& aStringID, sal_uInt16 nFormat,
const uno::Reference< uno::XComponentContext >& rContext )
throw( uno::Exception )
{
if ( !rContext.is() || !xInStream.is() || nFormat > FORMAT_MAX_ID )
throw uno::RuntimeException();
uno::Reference< xml::sax::XParser > xParser = xml::sax::Parser::create( rContext );
OFOPXMLHelper_Impl *const pHelper = new OFOPXMLHelper_Impl( nFormat );
uno::Reference< xml::sax::XDocumentHandler > xHelper( static_cast< xml::sax::XDocumentHandler* >( pHelper ) );
xml::sax::InputSource aParserInput;
aParserInput.aInputStream = xInStream;
aParserInput.sSystemId = aStringID;
xParser->setDocumentHandler( xHelper );
xParser->parseStream( aParserInput );
xParser->setDocumentHandler( uno::Reference < xml::sax::XDocumentHandler > () );
return pHelper->GetParsingResult();
}
} // namespace OFOPXMLHelper
OFOPXMLHelper_Impl::OFOPXMLHelper_Impl( sal_uInt16 nFormat )
: m_nFormat( nFormat )
, m_aRelListElement( "Relationships" )
, m_aRelElement( "Relationship" )
, m_aIDAttr( "Id" )
, m_aTypeAttr( "Type" )
, m_aTargetModeAttr( "TargetMode" )
, m_aTargetAttr( "Target" )
, m_aTypesElement( "Types" )
, m_aDefaultElement( "Default" )
, m_aOverrideElement( "Override" )
, m_aExtensionAttr( "Extension" )
, m_aPartNameAttr( "PartName" )
, m_aContentTypeAttr( "ContentType" )
{
}
OFOPXMLHelper_Impl::~OFOPXMLHelper_Impl()
{
}
uno::Sequence< uno::Sequence< beans::StringPair > > OFOPXMLHelper_Impl::GetParsingResult()
{
if ( m_aElementsSeq.getLength() )
throw uno::RuntimeException(); // the parsing has still not finished!
return m_aResultSeq;
}
void SAL_CALL OFOPXMLHelper_Impl::startDocument()
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
void SAL_CALL OFOPXMLHelper_Impl::endDocument()
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
void SAL_CALL OFOPXMLHelper_Impl::startElement( const OUString& aName, const uno::Reference< xml::sax::XAttributeList >& xAttribs )
throw( xml::sax::SAXException, uno::RuntimeException, std::exception )
{
if ( m_nFormat == RELATIONINFO_FORMAT )
{
if ( aName == m_aRelListElement )
{
sal_Int32 nNewLength = m_aElementsSeq.getLength() + 1;
if ( nNewLength != 1 )
throw xml::sax::SAXException(); // TODO: this element must be the first level element
m_aElementsSeq.realloc( nNewLength );
m_aElementsSeq[nNewLength-1] = aName;
return; // nothing to do
}
else if ( aName == m_aRelElement )
{
sal_Int32 nNewLength = m_aElementsSeq.getLength() + 1;
if ( nNewLength != 2 )
throw xml::sax::SAXException(); // TODO: this element must be the second level element
m_aElementsSeq.realloc( nNewLength );
m_aElementsSeq[nNewLength-1] = aName;
sal_Int32 nNewEntryNum = m_aResultSeq.getLength() + 1;
m_aResultSeq.realloc( nNewEntryNum );
sal_Int32 nAttrNum = 0;
m_aResultSeq[nNewEntryNum-1].realloc( 4 ); // the maximal expected number of arguments is 4
OUString aIDValue = xAttribs->getValueByName( m_aIDAttr );
if ( aIDValue.isEmpty() )
throw xml::sax::SAXException(); // TODO: the ID value must present
OUString aTypeValue = xAttribs->getValueByName( m_aTypeAttr );
OUString aTargetValue = xAttribs->getValueByName( m_aTargetAttr );
OUString aTargetModeValue = xAttribs->getValueByName( m_aTargetModeAttr );
m_aResultSeq[nNewEntryNum-1][++nAttrNum - 1].First = m_aIDAttr;
m_aResultSeq[nNewEntryNum-1][nAttrNum - 1].Second = aIDValue;
if ( !aTypeValue.isEmpty() )
{
m_aResultSeq[nNewEntryNum-1][++nAttrNum - 1].First = m_aTypeAttr;
m_aResultSeq[nNewEntryNum-1][nAttrNum - 1].Second = aTypeValue;
}
if ( !aTargetValue.isEmpty() )
{
m_aResultSeq[nNewEntryNum-1][++nAttrNum - 1].First = m_aTargetAttr;
m_aResultSeq[nNewEntryNum-1][nAttrNum - 1].Second = aTargetValue;
}
if ( !aTargetModeValue.isEmpty() )
{
m_aResultSeq[nNewEntryNum-1][++nAttrNum - 1].First = m_aTargetModeAttr;
m_aResultSeq[nNewEntryNum-1][nAttrNum - 1].Second = aTargetModeValue;
}
m_aResultSeq[nNewEntryNum-1].realloc( nAttrNum );
}
else
throw xml::sax::SAXException(); // TODO: no other elements expected!
}
else if ( m_nFormat == CONTENTTYPE_FORMAT )
{
if ( aName == m_aTypesElement )
{
sal_Int32 nNewLength = m_aElementsSeq.getLength() + 1;
if ( nNewLength != 1 )
throw xml::sax::SAXException(); // TODO: this element must be the first level element
m_aElementsSeq.realloc( nNewLength );
m_aElementsSeq[nNewLength-1] = aName;
if ( !m_aResultSeq.getLength() )
m_aResultSeq.realloc( 2 );
return; // nothing to do
}
else if ( aName == m_aDefaultElement )
{
sal_Int32 nNewLength = m_aElementsSeq.getLength() + 1;
if ( nNewLength != 2 )
throw xml::sax::SAXException(); // TODO: this element must be the second level element
m_aElementsSeq.realloc( nNewLength );
m_aElementsSeq[nNewLength-1] = aName;
if ( !m_aResultSeq.getLength() )
m_aResultSeq.realloc( 2 );
if ( m_aResultSeq.getLength() != 2 )
throw uno::RuntimeException();
OUString aExtensionValue = xAttribs->getValueByName( m_aExtensionAttr );
if ( aExtensionValue.isEmpty() )
throw xml::sax::SAXException(); // TODO: the Extension value must present
OUString aContentTypeValue = xAttribs->getValueByName( m_aContentTypeAttr );
if ( aContentTypeValue.isEmpty() )
throw xml::sax::SAXException(); // TODO: the ContentType value must present
sal_Int32 nNewResultLen = m_aResultSeq[0].getLength() + 1;
m_aResultSeq[0].realloc( nNewResultLen );
m_aResultSeq[0][nNewResultLen-1].First = aExtensionValue;
m_aResultSeq[0][nNewResultLen-1].Second = aContentTypeValue;
}
else if ( aName == m_aOverrideElement )
{
sal_Int32 nNewLength = m_aElementsSeq.getLength() + 1;
if ( nNewLength != 2 )
throw xml::sax::SAXException(); // TODO: this element must be the second level element
m_aElementsSeq.realloc( nNewLength );
m_aElementsSeq[nNewLength-1] = aName;
if ( !m_aResultSeq.getLength() )
m_aResultSeq.realloc( 2 );
if ( m_aResultSeq.getLength() != 2 )
throw uno::RuntimeException();
OUString aPartNameValue = xAttribs->getValueByName( m_aPartNameAttr );
if ( aPartNameValue.isEmpty() )
throw xml::sax::SAXException(); // TODO: the PartName value must present
OUString aContentTypeValue = xAttribs->getValueByName( m_aContentTypeAttr );
if ( aContentTypeValue.isEmpty() )
throw xml::sax::SAXException(); // TODO: the ContentType value must present
sal_Int32 nNewResultLen = m_aResultSeq[1].getLength() + 1;
m_aResultSeq[1].realloc( nNewResultLen );
m_aResultSeq[1][nNewResultLen-1].First = aPartNameValue;
m_aResultSeq[1][nNewResultLen-1].Second = aContentTypeValue;
}
else
throw xml::sax::SAXException(); // TODO: no other elements expected!
}
else
throw xml::sax::SAXException(); // TODO: no other elements expected!
}
void SAL_CALL OFOPXMLHelper_Impl::endElement( const OUString& aName )
throw( xml::sax::SAXException, uno::RuntimeException, std::exception )
{
if ( m_nFormat == RELATIONINFO_FORMAT || m_nFormat == CONTENTTYPE_FORMAT )
{
sal_Int32 nLength = m_aElementsSeq.getLength();
if ( nLength <= 0 )
throw xml::sax::SAXException(); // TODO: no other end elements expected!
if ( !m_aElementsSeq[nLength-1].equals( aName ) )
throw xml::sax::SAXException(); // TODO: unexpected element ended
m_aElementsSeq.realloc( nLength - 1 );
}
}
void SAL_CALL OFOPXMLHelper_Impl::characters( const OUString& /*aChars*/ )
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
void SAL_CALL OFOPXMLHelper_Impl::ignorableWhitespace( const OUString& /*aWhitespaces*/ )
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
void SAL_CALL OFOPXMLHelper_Impl::processingInstruction( const OUString& /*aTarget*/, const OUString& /*aData*/ )
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
void SAL_CALL OFOPXMLHelper_Impl::setDocumentLocator( const uno::Reference< xml::sax::XLocator >& /*xLocator*/ )
throw(xml::sax::SAXException, uno::RuntimeException, std::exception)
{
}
} // namespace comphelper
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|