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
|
/* -*- 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 <i18nlangtag/languagetag.hxx>
#include <rtl/ustrbuf.hxx>
#include <sal/log.hxx>
#include <utility>
#include <xmloff/xmlmetae.hxx>
#include <xmloff/xmlexp.hxx>
#include <xmloff/namespacemap.hxx>
#include <xmloff/xmlnamespace.hxx>
#include <com/sun/star/beans/XPropertyAccess.hpp>
#include <com/sun/star/beans/StringPair.hpp>
#include <com/sun/star/document/XDocumentProperties.hpp>
#include <com/sun/star/util/DateTime.hpp>
#include <com/sun/star/util/Duration.hpp>
#include <com/sun/star/xml/sax/XSAXSerializable.hpp>
#include <sax/tools/converter.hxx>
#include <comphelper/sequence.hxx>
#include <unotools/docinfohelper.hxx>
using namespace com::sun::star;
using namespace ::xmloff::token;
static void lcl_AddTwoDigits( OUStringBuffer& rStr, sal_Int32 nVal )
{
if ( nVal < 10 )
rStr.append( '0' );
rStr.append( nVal );
}
OUString
SvXMLMetaExport::GetISODateTimeString( const util::DateTime& rDateTime )
{
// return ISO date string "YYYY-MM-DDThh:mm:ss"
OUStringBuffer sTmp;
sTmp.append( static_cast<sal_Int32>(rDateTime.Year) );
sTmp.append( '-' );
lcl_AddTwoDigits( sTmp, rDateTime.Month );
sTmp.append( '-' );
lcl_AddTwoDigits( sTmp, rDateTime.Day );
sTmp.append( 'T' );
lcl_AddTwoDigits( sTmp, rDateTime.Hours );
sTmp.append( ':' );
lcl_AddTwoDigits( sTmp, rDateTime.Minutes );
sTmp.append( ':' );
lcl_AddTwoDigits( sTmp, rDateTime.Seconds );
return sTmp.makeStringAndClear();
}
void SvXMLMetaExport::SimpleStringElement( const OUString& rText,
sal_uInt16 nNamespace, enum XMLTokenEnum eElementName )
{
if ( !rText.isEmpty() ) {
SvXMLElementExport aElem( mrExport, nNamespace, eElementName,
true, false );
mrExport.Characters( rText );
}
}
void SvXMLMetaExport::SimpleDateTimeElement( const util::DateTime & rDate,
sal_uInt16 nNamespace, enum XMLTokenEnum eElementName )
{
if (rDate.Month != 0) { // invalid dates are 0-0-0
OUString sValue = GetISODateTimeString( rDate );
if ( !sValue.isEmpty() ) {
SvXMLElementExport aElem( mrExport, nNamespace, eElementName,
true, false );
mrExport.Characters( sValue );
}
}
}
void SvXMLMetaExport::MExport_()
{
// generator
{
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_META, XML_GENERATOR,
true, true );
mrExport.Characters( ::utl::DocInfoHelper::GetGeneratorString() );
}
// document title
SimpleStringElement ( mxDocProps->getTitle(),
XML_NAMESPACE_DC, XML_TITLE );
// description
SimpleStringElement ( mxDocProps->getDescription(),
XML_NAMESPACE_DC, XML_DESCRIPTION );
// subject
SimpleStringElement ( mxDocProps->getSubject(),
XML_NAMESPACE_DC, XML_SUBJECT );
// created...
SimpleStringElement ( mxDocProps->getAuthor(),
XML_NAMESPACE_META, XML_INITIAL_CREATOR );
SimpleDateTimeElement( mxDocProps->getCreationDate(),
XML_NAMESPACE_META, XML_CREATION_DATE );
// modified...
SimpleStringElement ( mxDocProps->getModifiedBy(),
XML_NAMESPACE_DC, XML_CREATOR );
SimpleDateTimeElement( mxDocProps->getModificationDate(),
XML_NAMESPACE_DC, XML_DATE );
// printed...
SimpleStringElement ( mxDocProps->getPrintedBy(),
XML_NAMESPACE_META, XML_PRINTED_BY );
SimpleDateTimeElement( mxDocProps->getPrintDate(),
XML_NAMESPACE_META, XML_PRINT_DATE );
// keywords
const uno::Sequence< OUString > keywords = mxDocProps->getKeywords();
for (const auto& rKeyword : keywords) {
SvXMLElementExport aKwElem( mrExport, XML_NAMESPACE_META, XML_KEYWORD,
true, false );
mrExport.Characters( rKeyword );
}
// document language
{
OUString sValue = LanguageTag( mxDocProps->getLanguage()).getBcp47( false);
if (!sValue.isEmpty()) {
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_DC, XML_LANGUAGE,
true, false );
mrExport.Characters( sValue );
}
}
// editing cycles
{
SvXMLElementExport aElem( mrExport,
XML_NAMESPACE_META, XML_EDITING_CYCLES,
true, false );
mrExport.Characters( OUString::number(
mxDocProps->getEditingCycles() ) );
}
// editing duration
// property is a int32 (seconds)
{
sal_Int32 secs = mxDocProps->getEditingDuration();
SvXMLElementExport aElem( mrExport,
XML_NAMESPACE_META, XML_EDITING_DURATION,
true, false );
OUStringBuffer buf;
::sax::Converter::convertDuration(buf, util::Duration(
false, 0, 0, 0, secs/3600, (secs%3600)/60, secs%60, 0));
mrExport.Characters(buf.makeStringAndClear());
}
// default target
const OUString sDefTarget = mxDocProps->getDefaultTarget();
if ( !sDefTarget.isEmpty() )
{
mrExport.AddAttribute( XML_NAMESPACE_OFFICE, XML_TARGET_FRAME_NAME,
sDefTarget );
//! define strings for xlink:show values
const XMLTokenEnum eShow = sDefTarget == "_blank" ? XML_NEW : XML_REPLACE;
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_SHOW, eShow );
SvXMLElementExport aElem( mrExport,
XML_NAMESPACE_META,XML_HYPERLINK_BEHAVIOUR,
true, false );
}
// auto-reload
const OUString sReloadURL = mxDocProps->getAutoloadURL();
const sal_Int32 sReloadDelay = mxDocProps->getAutoloadSecs();
if (sReloadDelay != 0 || !sReloadURL.isEmpty())
{
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_HREF,
mrExport.GetRelativeReference( sReloadURL ) );
OUStringBuffer buf;
::sax::Converter::convertDuration(buf, util::Duration(false, 0, 0, 0,
sReloadDelay/3600, (sReloadDelay%3600)/60, sReloadDelay%60, 0));
mrExport.AddAttribute( XML_NAMESPACE_META, XML_DELAY,
buf.makeStringAndClear());
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_META, XML_AUTO_RELOAD,
true, false );
}
// template
const OUString sTplPath = mxDocProps->getTemplateURL();
if ( !sTplPath.isEmpty() )
{
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_TYPE, XML_SIMPLE );
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_ACTUATE, XML_ONREQUEST );
// template URL
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_HREF,
mrExport.GetRelativeReference(sTplPath) );
// template name
mrExport.AddAttribute( XML_NAMESPACE_XLINK, XML_TITLE,
mxDocProps->getTemplateName() );
// template date
mrExport.AddAttribute( XML_NAMESPACE_META, XML_DATE,
GetISODateTimeString( mxDocProps->getTemplateDate() ) );
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_META, XML_TEMPLATE,
true, false );
}
// user defined fields
uno::Reference< beans::XPropertyAccess > xUserDefined(
mxDocProps->getUserDefinedProperties(), uno::UNO_QUERY_THROW);
const uno::Sequence< beans::PropertyValue > props =
xUserDefined->getPropertyValues();
for (const auto& rProp : props) {
OUStringBuffer sValueBuffer;
OUStringBuffer sType;
if (!::sax::Converter::convertAny(sValueBuffer, sType, rProp.Value))
{
continue;
}
mrExport.AddAttribute( XML_NAMESPACE_META, XML_NAME, rProp.Name );
mrExport.AddAttribute( XML_NAMESPACE_META, XML_VALUE_TYPE,
sType.makeStringAndClear() );
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_META,
XML_USER_DEFINED, true, false );
mrExport.Characters( sValueBuffer.makeStringAndClear() );
}
const uno::Sequence< beans::NamedValue > aDocStatistic =
mxDocProps->getDocumentStatistics();
// write document statistic if there is any provided
if ( !aDocStatistic.hasElements() )
return;
for ( const auto& rDocStat : aDocStatistic )
{
sal_Int32 nValue = 0;
if ( rDocStat.Value >>= nValue )
{
OUString aValue = OUString::number( nValue );
if ( rDocStat.Name == "TableCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_TABLE_COUNT, aValue );
else if ( rDocStat.Name == "ObjectCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_OBJECT_COUNT, aValue );
else if ( rDocStat.Name == "ImageCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_IMAGE_COUNT, aValue );
else if ( rDocStat.Name == "PageCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_PAGE_COUNT, aValue );
else if ( rDocStat.Name == "ParagraphCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_PARAGRAPH_COUNT, aValue );
else if ( rDocStat.Name == "WordCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_WORD_COUNT, aValue );
else if ( rDocStat.Name == "CharacterCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_CHARACTER_COUNT, aValue );
else if ( rDocStat.Name == "CellCount" )
mrExport.AddAttribute(
XML_NAMESPACE_META, XML_CELL_COUNT, aValue );
else
{
SAL_WARN("xmloff", "Unknown statistic value!");
}
}
}
SvXMLElementExport aElem( mrExport,
XML_NAMESPACE_META, XML_DOCUMENT_STATISTIC, true, true );
}
const char s_xmlns[] = "xmlns";
const char s_xmlns2[] = "xmlns:";
const char s_meta[] = "meta:";
const char s_href[] = "xlink:href";
SvXMLMetaExport::SvXMLMetaExport(
SvXMLExport& i_rExp,
uno::Reference<document::XDocumentProperties> i_rDocProps ) :
mrExport( i_rExp ),
mxDocProps(std::move( i_rDocProps )),
m_level( 0 )
{
assert(mxDocProps.is());
}
SvXMLMetaExport::~SvXMLMetaExport()
{
}
void SvXMLMetaExport::Export()
{
uno::Reference< xml::sax::XSAXSerializable> xSAXable(mxDocProps,
uno::UNO_QUERY);
if (xSAXable.is()) {
::std::vector< beans::StringPair > namespaces;
const SvXMLNamespaceMap & rNsMap(mrExport.GetNamespaceMap());
for (sal_uInt16 key = rNsMap.GetFirstKey();
key != USHRT_MAX; key = rNsMap.GetNextKey(key)) {
beans::StringPair ns;
const OUString attrname = rNsMap.GetAttrNameByKey(key);
if (!attrname.startsWith(s_xmlns2, &ns.First)
|| attrname == s_xmlns) // default initialized empty string
{
assert(!"namespace attribute not starting with xmlns unexpected");
}
ns.Second = rNsMap.GetNameByKey(key);
namespaces.push_back(ns);
}
xSAXable->serialize(this, comphelper::containerToSequence(namespaces));
} else {
// office:meta
SvXMLElementExport aElem( mrExport, XML_NAMESPACE_OFFICE, XML_META,
true, true );
// fall back to using public interface of XDocumentProperties
MExport_();
}
}
// css::xml::sax::XDocumentHandler:
void SAL_CALL
SvXMLMetaExport::startDocument()
{
// ignore: has already been done by SvXMLExport::exportDoc
assert(m_level == 0 && "SvXMLMetaExport: level error");
}
void SAL_CALL
SvXMLMetaExport::endDocument()
{
// ignore: will be done by SvXMLExport::exportDoc
assert(m_level == 0 && "SvXMLMetaExport: level error");
}
// unfortunately, this method contains far too much ugly namespace mangling.
void SAL_CALL
SvXMLMetaExport::startElement(const OUString & i_rName,
const uno::Reference< xml::sax::XAttributeList > & i_xAttribs)
{
if (m_level == 0) {
// namespace decls: default ones have been written at the root element
// non-default ones must be preserved here
const sal_Int16 nCount = i_xAttribs->getLength();
for (sal_Int16 i = 0; i < nCount; ++i) {
const OUString name(i_xAttribs->getNameByIndex(i));
if (name.startsWith(s_xmlns)) {
bool found(false);
const SvXMLNamespaceMap & rNsMap(mrExport.GetNamespaceMap());
for (sal_uInt16 key = rNsMap.GetFirstKey();
key != USHRT_MAX; key = rNsMap.GetNextKey(key)) {
if (name == rNsMap.GetAttrNameByKey(key)) {
found = true;
break;
}
}
if (!found) {
m_preservedNSs.emplace_back(name,
i_xAttribs->getValueByIndex(i));
}
}
}
// ignore the root: it has been written already
++m_level;
return;
}
if (m_level == 1) {
// attach preserved namespace decls from root node here
for (const auto& rPreservedNS : m_preservedNSs) {
const OUString ns(rPreservedNS.First);
bool found(false);
// but only if it is not already there
const sal_Int16 nCount = i_xAttribs->getLength();
for (sal_Int16 i = 0; i < nCount; ++i) {
const OUString name(i_xAttribs->getNameByIndex(i));
if (ns == name) {
found = true;
break;
}
}
if (!found) {
mrExport.AddAttribute(ns, rPreservedNS.Second);
}
}
}
// attach the attributes
if (i_rName.startsWith(s_meta)) {
// special handling for all elements that may have
// xlink:href attributes; these must be made relative
const sal_Int16 nLength = i_xAttribs->getLength();
for (sal_Int16 i = 0; i < nLength; ++i) {
const OUString name (i_xAttribs->getNameByIndex (i));
OUString value(i_xAttribs->getValueByIndex(i));
if (name.startsWith(s_href)) {
value = mrExport.GetRelativeReference(value);
}
mrExport.AddAttribute(name, value);
}
} else {
const sal_Int16 nLength = i_xAttribs->getLength();
for (sal_Int16 i = 0; i < nLength; ++i) {
const OUString name (i_xAttribs->getNameByIndex(i));
const OUString value (i_xAttribs->getValueByIndex(i));
mrExport.AddAttribute(name, value);
}
}
// finally, start the element
// #i107240# no whitespace here, because the DOM may already contain
// whitespace, which is not cleared when loading and thus accumulates.
mrExport.StartElement(i_rName, m_level <= 1);
++m_level;
}
void SAL_CALL
SvXMLMetaExport::endElement(const OUString & i_rName)
{
--m_level;
if (m_level == 0) {
// ignore the root; see startElement
return;
}
assert(m_level >= 0 && "SvXMLMetaExport: level error");
mrExport.EndElement(i_rName, false);
}
void SAL_CALL
SvXMLMetaExport::characters(const OUString & i_rChars)
{
mrExport.Characters(i_rChars);
}
void SAL_CALL
SvXMLMetaExport::ignorableWhitespace(const OUString & /*i_rWhitespaces*/)
{
mrExport.IgnorableWhitespace(/*i_rWhitespaces*/);
}
void SAL_CALL
SvXMLMetaExport::processingInstruction(const OUString &,
const OUString &)
{
// ignore; the exporter cannot handle these
}
void SAL_CALL
SvXMLMetaExport::setDocumentLocator(const uno::Reference<xml::sax::XLocator>&)
{
// nothing to do here, move along...
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|