Line data Source code
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 : #include "XMLTextMarkImportContext.hxx"
21 :
22 :
23 : #include <rtl/ustring.hxx>
24 : #include <osl/diagnose.h>
25 : #include <tools/debug.hxx>
26 : #include <xmloff/xmluconv.hxx>
27 : #include <xmloff/xmltoken.hxx>
28 : #include <xmloff/xmlimp.hxx>
29 : #include <xmloff/nmspmap.hxx>
30 : #include <xmloff/xmlnmspe.hxx>
31 : #include <xmloff/odffields.hxx>
32 : #include <com/sun/star/xml/sax/XAttributeList.hpp>
33 : #include <com/sun/star/text/XTextContent.hpp>
34 : #include <com/sun/star/beans/XPropertySet.hpp>
35 : #include <com/sun/star/lang/XMultiServiceFactory.hpp>
36 : #include <com/sun/star/container/XNamed.hpp>
37 : #include <com/sun/star/rdf/XMetadatable.hpp>
38 :
39 : #include <com/sun/star/text/XFormField.hpp>
40 :
41 : #include "RDFaImportHelper.hxx"
42 :
43 :
44 :
45 : using namespace ::com::sun::star;
46 : using namespace ::com::sun::star::text;
47 : using namespace ::com::sun::star::uno;
48 : using namespace ::com::sun::star::beans;
49 : using namespace ::com::sun::star::lang;
50 : using namespace ::com::sun::star::container;
51 : using namespace ::com::sun::star::xml::sax;
52 : using namespace ::xmloff::token;
53 :
54 :
55 :
56 0 : XMLFieldParamImportContext::XMLFieldParamImportContext(
57 : SvXMLImport& rImport,
58 : XMLTextImportHelper& rHlp,
59 : sal_uInt16 nPrefix,
60 : const OUString& rLocalName ) :
61 : SvXMLImportContext(rImport, nPrefix, rLocalName),
62 0 : rHelper(rHlp)
63 : {
64 0 : }
65 :
66 :
67 0 : void XMLFieldParamImportContext::StartElement(const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList> & xAttrList)
68 : {
69 0 : SvXMLImport& rImport = GetImport();
70 0 : OUString sName;
71 0 : OUString sValue;
72 :
73 0 : sal_Int16 nLength = xAttrList->getLength();
74 0 : for(sal_Int16 nAttr = 0; nAttr < nLength; nAttr++)
75 : {
76 0 : OUString sLocalName;
77 0 : sal_uInt16 nPrefix = rImport.GetNamespaceMap().
78 0 : GetKeyByAttrName( xAttrList->getNameByIndex(nAttr),
79 0 : &sLocalName );
80 :
81 0 : if ( (XML_NAMESPACE_FIELD == nPrefix) &&
82 0 : IsXMLToken(sLocalName, XML_NAME) )
83 : {
84 0 : sName = xAttrList->getValueByIndex(nAttr);
85 : }
86 0 : if ( (XML_NAMESPACE_FIELD == nPrefix) &&
87 0 : IsXMLToken(sLocalName, XML_VALUE) )
88 : {
89 0 : sValue = xAttrList->getValueByIndex(nAttr);
90 : }
91 0 : }
92 0 : if (rHelper.hasCurrentFieldCtx() && !sName.isEmpty()) {
93 0 : rHelper.addFieldParam(sName, sValue);
94 0 : }
95 0 : }
96 :
97 :
98 0 : TYPEINIT1( XMLTextMarkImportContext, SvXMLImportContext);
99 :
100 2016 : XMLTextMarkImportContext::XMLTextMarkImportContext(
101 : SvXMLImport& rImport,
102 : XMLTextImportHelper& rHlp,
103 : sal_uInt16 nPrefix,
104 : const OUString& rLocalName )
105 : : SvXMLImportContext(rImport, nPrefix, rLocalName)
106 : , m_rHelper(rHlp)
107 2016 : , m_bHaveAbout(false)
108 : {
109 2016 : }
110 :
111 : enum lcl_MarkType { TypeReference, TypeReferenceStart, TypeReferenceEnd,
112 : TypeBookmark, TypeBookmarkStart, TypeBookmarkEnd,
113 : TypeFieldmark, TypeFieldmarkStart, TypeFieldmarkEnd
114 : };
115 :
116 : static SvXMLEnumMapEntry const lcl_aMarkTypeMap[] =
117 : {
118 : { XML_REFERENCE_MARK, TypeReference },
119 : { XML_REFERENCE_MARK_START, TypeReferenceStart },
120 : { XML_REFERENCE_MARK_END, TypeReferenceEnd },
121 : { XML_BOOKMARK, TypeBookmark },
122 : { XML_BOOKMARK_START, TypeBookmarkStart },
123 : { XML_BOOKMARK_END, TypeBookmarkEnd },
124 : { XML_FIELDMARK, TypeFieldmark },
125 : { XML_FIELDMARK_START, TypeFieldmarkStart },
126 : { XML_FIELDMARK_END, TypeFieldmarkEnd },
127 : { XML_TOKEN_INVALID, 0 },
128 : };
129 :
130 :
131 20 : static const char *lcl_getFormFieldmarkName(OUString &name)
132 : {
133 : static const char sCheckbox[]=ODF_FORMCHECKBOX;
134 : static const char sFormDropDown[]=ODF_FORMDROPDOWN;
135 40 : if (name == "msoffice.field.FORMCHECKBOX" ||
136 20 : name == "ecma.office-open-xml.field.FORMCHECKBOX")
137 0 : return sCheckbox;
138 20 : else if (name == ODF_FORMCHECKBOX)
139 0 : return sCheckbox;
140 40 : if (name == ODF_FORMDROPDOWN ||
141 20 : name == "ecma.office-open-xml.field.FORMDROPDOWN")
142 0 : return sFormDropDown;
143 : else
144 20 : return NULL;
145 : }
146 :
147 1 : static OUString lcl_getFieldmarkName(OUString const& name)
148 : {
149 2 : if (name == "msoffice.field.FORMTEXT" ||
150 1 : name == "ecma.office-open-xml.field.FORMTEXT")
151 0 : return OUString(ODF_FORMTEXT);
152 : else
153 1 : return name;
154 : }
155 :
156 :
157 2016 : void XMLTextMarkImportContext::StartElement(
158 : const Reference<XAttributeList> & xAttrList)
159 : {
160 2016 : if (!FindName(GetImport(), xAttrList))
161 : {
162 1 : m_sBookmarkName.clear();
163 : }
164 :
165 2016 : if (IsXMLToken(GetLocalName(), XML_FIELDMARK_END))
166 : {
167 1 : m_sBookmarkName = m_rHelper.FindActiveBookmarkName();
168 : }
169 :
170 2016 : if (IsXMLToken(GetLocalName(), XML_FIELDMARK_START) || IsXMLToken(GetLocalName(), XML_FIELDMARK))
171 : {
172 1 : if (m_sBookmarkName.isEmpty())
173 : {
174 0 : m_sBookmarkName = "Unknown";
175 : }
176 1 : m_rHelper.pushFieldCtx( m_sBookmarkName, m_sFieldName );
177 : }
178 2016 : }
179 :
180 2016 : void XMLTextMarkImportContext::EndElement()
181 : {
182 2016 : SvXMLImportContext::EndElement();
183 :
184 : static const char sAPI_reference_mark[] = "com.sun.star.text.ReferenceMark";
185 : static const char sAPI_bookmark[] = "com.sun.star.text.Bookmark";
186 : static const char sAPI_fieldmark[] = "com.sun.star.text.Fieldmark";
187 : static const char sAPI_formfieldmark[] = "com.sun.star.text.FormFieldmark";
188 :
189 2016 : if (!m_sBookmarkName.isEmpty())
190 : {
191 : sal_uInt16 nTmp;
192 2016 : if (SvXMLUnitConverter::convertEnum(nTmp, GetLocalName(),
193 : lcl_aMarkTypeMap))
194 : {
195 2016 : switch ((lcl_MarkType)nTmp)
196 : {
197 : case TypeReference:
198 : // export point reference mark
199 0 : CreateAndInsertMark(GetImport(),
200 : sAPI_reference_mark,
201 : m_sBookmarkName,
202 0 : m_rHelper.GetCursorAsRange()->getStart(),
203 0 : OUString());
204 0 : break;
205 :
206 : case TypeFieldmark:
207 : case TypeBookmark:
208 : {
209 20 : const char *formFieldmarkName=lcl_getFormFieldmarkName(m_sFieldName);
210 20 : bool bImportAsField=((lcl_MarkType)nTmp==TypeFieldmark && formFieldmarkName!=NULL); //@TODO handle abbreviation cases..
211 : // export point bookmark
212 : const Reference<XInterface> xContent(
213 20 : CreateAndInsertMark(GetImport(),
214 : (bImportAsField ? OUString(sAPI_formfieldmark) : OUString(sAPI_bookmark)),
215 : m_sBookmarkName,
216 20 : m_rHelper.GetCursorAsRange()->getStart(),
217 60 : m_sXmlId) );
218 20 : if ((lcl_MarkType)nTmp==TypeFieldmark) {
219 0 : if (xContent.is() && bImportAsField) {
220 : // setup fieldmark...
221 0 : Reference< ::com::sun::star::text::XFormField> xFormField(xContent, UNO_QUERY);
222 0 : xFormField->setFieldType(OUString::createFromAscii(formFieldmarkName));
223 0 : if (xFormField.is() && m_rHelper.hasCurrentFieldCtx()) {
224 0 : m_rHelper.setCurrentFieldParamsTo(xFormField);
225 0 : }
226 : }
227 0 : m_rHelper.popFieldCtx();
228 20 : }
229 : }
230 20 : break;
231 :
232 : case TypeFieldmarkStart:
233 : case TypeBookmarkStart:
234 : // save XTextRange for later construction of bookmark
235 : {
236 : std::shared_ptr< ::xmloff::ParsedRDFaAttributes >
237 998 : xRDFaAttributes;
238 1002 : if (m_bHaveAbout && (TypeBookmarkStart
239 4 : == static_cast<lcl_MarkType>(nTmp)))
240 : {
241 12 : xRDFaAttributes =
242 4 : GetImport().GetRDFaImportHelper().ParseRDFa(
243 : m_sAbout, m_sProperty,
244 4 : m_sContent, m_sDatatype);
245 : }
246 : m_rHelper.InsertBookmarkStartRange(
247 : m_sBookmarkName,
248 998 : m_rHelper.GetCursorAsRange()->getStart(),
249 1996 : m_sXmlId, xRDFaAttributes);
250 : }
251 998 : break;
252 :
253 : case TypeFieldmarkEnd:
254 : case TypeBookmarkEnd:
255 : {
256 : // get old range, and construct
257 998 : Reference<XTextRange> xStartRange;
258 : std::shared_ptr< ::xmloff::ParsedRDFaAttributes >
259 1996 : xRDFaAttributes;
260 998 : if (m_rHelper.FindAndRemoveBookmarkStartRange(
261 : m_sBookmarkName, xStartRange,
262 998 : m_sXmlId, xRDFaAttributes))
263 : {
264 : Reference<XTextRange> xEndRange(
265 998 : m_rHelper.GetCursorAsRange()->getStart());
266 :
267 : // check if beginning and end are in same XText
268 998 : if (xStartRange->getText() == xEndRange->getText())
269 : {
270 : // create range for insertion
271 : Reference<XTextCursor> xInsertionCursor =
272 998 : m_rHelper.GetText()->createTextCursorByRange(
273 998 : xEndRange);
274 : try {
275 998 : xInsertionCursor->gotoRange(xStartRange, sal_True);
276 0 : } catch (uno::Exception&) {
277 : OSL_ENSURE(false,
278 : "cannot go to end position of bookmark");
279 : }
280 :
281 : //DBG_ASSERT(! xInsertionCursor->isCollapsed(),
282 : // "we want no point mark");
283 : // can't assert, because someone could
284 : // create a file with subsequence
285 : // start/end elements
286 :
287 998 : bool bImportAsField=((lcl_MarkType)nTmp==TypeFieldmarkEnd && m_rHelper.hasCurrentFieldCtx());
288 :
289 : // fdo#86795 check if it's actually a checkbox first
290 998 : bool isInvalid(false);
291 1996 : OUString fieldmarkTypeName;
292 998 : if (bImportAsField && m_rHelper.hasCurrentFieldCtx())
293 : {
294 :
295 1 : OUString const type(m_rHelper.getCurrentFieldType());
296 1 : fieldmarkTypeName = lcl_getFieldmarkName(type);
297 2 : if (fieldmarkTypeName == ODF_FORMCHECKBOX ||
298 1 : fieldmarkTypeName == ODF_FORMDROPDOWN)
299 : { // sw can't handle checkbox with start+end
300 : SAL_INFO("xmloff.text", "invalid fieldmark-start/fieldmark-end ignored");
301 0 : isInvalid = true;
302 1 : }
303 : }
304 :
305 1996 : Reference<XInterface> xContent;
306 998 : if (!isInvalid)
307 : {
308 : // insert reference
309 1996 : xContent = CreateAndInsertMark(GetImport(),
310 : (bImportAsField
311 : ? OUString(sAPI_fieldmark)
312 : : OUString(sAPI_bookmark)),
313 : m_sBookmarkName,
314 : xInsertionCursor,
315 998 : m_sXmlId);
316 998 : if (xRDFaAttributes)
317 : {
318 : const Reference<rdf::XMetadatable>
319 4 : xMeta(xContent, UNO_QUERY);
320 4 : GetImport().GetRDFaImportHelper().AddRDFa(
321 4 : xMeta, xRDFaAttributes);
322 : }
323 : }
324 :
325 998 : if ((lcl_MarkType)nTmp==TypeFieldmarkEnd) {
326 1 : if (xContent.is() && bImportAsField) {
327 : // setup fieldmark...
328 1 : Reference< ::com::sun::star::text::XFormField> xFormField(xContent, UNO_QUERY);
329 1 : if (xFormField.is() && m_rHelper.hasCurrentFieldCtx()) {
330 :
331 1 : xFormField->setFieldType(fieldmarkTypeName);
332 1 : m_rHelper.setCurrentFieldParamsTo(xFormField);
333 1 : }
334 : }
335 1 : m_rHelper.popFieldCtx();
336 998 : }
337 998 : }
338 : // else: beginning/end in different XText -> ignore!
339 : }
340 : // else: no start found -> ignore!
341 1996 : break;
342 : }
343 :
344 : case TypeReferenceStart:
345 : case TypeReferenceEnd:
346 : OSL_FAIL("reference start/end are handled in txtparai !");
347 0 : break;
348 :
349 : default:
350 : OSL_FAIL("unknown mark type");
351 0 : break;
352 : }
353 : }
354 : }
355 2016 : }
356 :
357 0 : SvXMLImportContext *XMLTextMarkImportContext::CreateChildContext( sal_uInt16 nPrefix,
358 : const OUString& rLocalName,
359 : const ::com::sun::star::uno::Reference< ::com::sun::star::xml::sax::XAttributeList >& )
360 : {
361 0 : return new XMLFieldParamImportContext(GetImport(), m_rHelper,
362 0 : nPrefix, rLocalName);
363 : }
364 :
365 :
366 1056 : Reference<XTextContent> XMLTextMarkImportContext::CreateAndInsertMark(
367 : SvXMLImport& rImport,
368 : const OUString& sServiceName,
369 : const OUString& sMarkName,
370 : const Reference<XTextRange> & rRange,
371 : const OUString& i_rXmlId)
372 : {
373 : // create mark
374 1056 : const Reference<XMultiServiceFactory> xFactory(rImport.GetModel(),
375 1056 : UNO_QUERY);
376 2112 : Reference<XInterface> xIfc;
377 :
378 1056 : if (xFactory.is())
379 : {
380 1056 : xIfc = xFactory->createInstance(sServiceName);
381 :
382 1056 : if (!xIfc.is())
383 : {
384 : OSL_FAIL("CreateAndInsertMark: cannot create service?");
385 1056 : return 0;
386 : }
387 :
388 : // set name (unless there is no name (text:meta))
389 1056 : const Reference<XNamed> xNamed(xIfc, UNO_QUERY);
390 1056 : if (xNamed.is())
391 : {
392 1018 : xNamed->setName(sMarkName);
393 : }
394 : else
395 : {
396 38 : if (!sMarkName.isEmpty())
397 : {
398 : OSL_FAIL("name given, but XNamed not supported?");
399 0 : return 0;
400 : }
401 : }
402 :
403 : // cast to XTextContent and attach to document
404 1056 : const Reference<XTextContent> xTextContent(xIfc, UNO_QUERY);
405 1056 : if (xTextContent.is())
406 : {
407 : try
408 : {
409 : // if inserting marks, bAbsorb==sal_False will cause
410 : // collapsing of the given XTextRange.
411 2112 : rImport.GetTextImport()->GetText()->insertTextContent(rRange,
412 1056 : xTextContent, sal_True);
413 :
414 : // xml:id for RDF metadata -- after insertion!
415 1056 : rImport.SetXmlId(xIfc, i_rXmlId);
416 :
417 1056 : return xTextContent;
418 : }
419 0 : catch (com::sun::star::lang::IllegalArgumentException &)
420 : {
421 : OSL_FAIL("CreateAndInsertMark: cannot insert?");
422 0 : return 0;
423 : }
424 0 : }
425 : }
426 1056 : return 0;
427 : }
428 :
429 2016 : bool XMLTextMarkImportContext::FindName(
430 : SvXMLImport& rImport,
431 : const Reference<XAttributeList> & xAttrList)
432 : {
433 2016 : bool bNameOK = false;
434 :
435 : // find name attribute first
436 2016 : const sal_Int16 nLength = xAttrList->getLength();
437 4062 : for(sal_Int16 nAttr = 0; nAttr < nLength; nAttr++)
438 : {
439 2046 : OUString sLocalName;
440 2046 : const sal_uInt16 nPrefix = rImport.GetNamespaceMap().
441 2046 : GetKeyByAttrName( xAttrList->getNameByIndex(nAttr),
442 4092 : &sLocalName );
443 :
444 4061 : if ( (XML_NAMESPACE_TEXT == nPrefix) &&
445 2015 : IsXMLToken(sLocalName, XML_NAME) )
446 : {
447 2015 : m_sBookmarkName = xAttrList->getValueByIndex(nAttr);
448 2015 : bNameOK = true;
449 : }
450 41 : else if ( (XML_NAMESPACE_XML == nPrefix) &&
451 10 : IsXMLToken(sLocalName, XML_ID) )
452 : {
453 10 : m_sXmlId = xAttrList->getValueByIndex(nAttr);
454 : }
455 21 : else if ( XML_NAMESPACE_XHTML == nPrefix )
456 : {
457 : // RDFa
458 16 : if ( IsXMLToken( sLocalName, XML_ABOUT) )
459 : {
460 4 : m_sAbout = xAttrList->getValueByIndex(nAttr);
461 4 : m_bHaveAbout = true;
462 : }
463 12 : else if ( IsXMLToken( sLocalName, XML_PROPERTY) )
464 : {
465 4 : m_sProperty = xAttrList->getValueByIndex(nAttr);
466 : }
467 8 : else if ( IsXMLToken( sLocalName, XML_CONTENT) )
468 : {
469 4 : m_sContent = xAttrList->getValueByIndex(nAttr);
470 : }
471 4 : else if ( IsXMLToken( sLocalName, XML_DATATYPE) )
472 : {
473 4 : m_sDatatype = xAttrList->getValueByIndex(nAttr);
474 : }
475 : }
476 6 : else if ( (XML_NAMESPACE_FIELD == nPrefix) &&
477 1 : IsXMLToken(sLocalName, XML_TYPE) )
478 : {
479 1 : m_sFieldName = xAttrList->getValueByIndex(nAttr);
480 : }
481 2046 : }
482 :
483 2016 : return bNameOK;
484 : }
485 :
486 : /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
