xmloff/source/text/XMLSectionImportContext.cxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XMLSectionImportContext.cxx,v $
  10  * $Revision: 1.27 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 // MARKER(update_precomp.py): autogen include statement, do not remove
  32 #include "precompiled_xmloff.hxx"
  33 #include "XMLSectionImportContext.hxx"
  34 #include "XMLSectionSourceImportContext.hxx"
  35 #include "XMLSectionSourceDDEImportContext.hxx"
  36 #include <xmloff/xmlictxt.hxx>
  37 #include <xmloff/xmlimp.hxx>
  38 #include <xmloff/txtimp.hxx>
  39 #include <xmloff/nmspmap.hxx>
  40 #include "xmlnmspe.hxx"
  41 #include <xmloff/xmltoken.hxx>
  42 #include <xmloff/xmluconv.hxx>
  43 #include <xmloff/prstylei.hxx>
  44 #include <com/sun/star/container/XNamed.hpp>
  45 #include <com/sun/star/uno/Reference.h>
  46 #include <com/sun/star/text/XTextContent.hpp>
  47 #include <com/sun/star/beans/XPropertySet.hpp>
  48 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  49 #include <com/sun/star/text/ControlCharacter.hpp>
  50
  51
  52 using ::rtl::OUString;
  53 using ::com::sun::star::beans::XPropertySet;
  54 using ::com::sun::star::uno::Reference;
  55 using ::com::sun::star::xml::sax::XAttributeList;
  56 using ::com::sun::star::lang::XMultiServiceFactory;
  57 using ::com::sun::star::container::XNamed;
  58
  59 using namespace ::com::sun::star::uno;
  60 using namespace ::com::sun::star::text;
  61 using namespace ::xmloff::token;
  62
  63
  64 TYPEINIT1( XMLSectionImportContext, SvXMLImportContext );
  65
  66 const sal_Char sAPI_TextSection[] = "com.sun.star.text.TextSection";
  67 const sal_Char sAPI_IndexHeaderSection[] = "com.sun.star.text.IndexHeaderSection";
  68 const sal_Char sAPI_IsProtected[] = "IsProtected";
  69 const sal_Char sAPI_Condition[] = "Condition";
  70 const sal_Char sAPI_IsVisible[] = "IsVisible";
  71 const sal_Char sAPI_IsCurrentlyVisible[] = "IsCurrentlyVisible";
  72 const sal_Char sAPI_ProtectionKey[] = "ProtectionKey";
  73
  74 enum XMLSectionToken
  75 {
  76     XML_TOK_SECTION_XMLID,
  77     XML_TOK_SECTION_STYLE_NAME,
  78     XML_TOK_SECTION_NAME,
  79     XML_TOK_SECTION_CONDITION,
  80     XML_TOK_SECTION_DISPLAY,
  81     XML_TOK_SECTION_PROTECT,
  82     XML_TOK_SECTION_PROTECTION_KEY,
  83     XML_TOK_SECTION_IS_HIDDEN
  84 };
  85
  86 static __FAR_DATA SvXMLTokenMapEntry aSectionTokenMap[] =
  87 {
  88     { XML_NAMESPACE_XML , XML_ID, XML_TOK_SECTION_XMLID },
  89     { XML_NAMESPACE_TEXT, XML_STYLE_NAME, XML_TOK_SECTION_STYLE_NAME },
  90     { XML_NAMESPACE_TEXT, XML_NAME, XML_TOK_SECTION_NAME },
  91     { XML_NAMESPACE_TEXT, XML_CONDITION, XML_TOK_SECTION_CONDITION },
  92     { XML_NAMESPACE_TEXT, XML_DISPLAY, XML_TOK_SECTION_DISPLAY },
  93     { XML_NAMESPACE_TEXT, XML_PROTECTED, XML_TOK_SECTION_PROTECT },
  94     { XML_NAMESPACE_TEXT, XML_PROTECTION_KEY, XML_TOK_SECTION_PROTECTION_KEY},
  95     { XML_NAMESPACE_TEXT, XML_IS_HIDDEN, XML_TOK_SECTION_IS_HIDDEN },
  96     // compatibility with SRC629 (or earlier) versions
  97     { XML_NAMESPACE_TEXT, XML_PROTECT, XML_TOK_SECTION_PROTECT },
  98     XML_TOKEN_MAP_END
  99 };
 100
 101
 102 // section import: This one is fairly tricky due to a variety of
 103 // limits of the core or the API. The main problem is that if you
 104 // insert a section within another section, you can't move the cursor
 105 // between the ends of the inner and the enclosing section. To avoid
 106 // these problems, additional markers are first inserted and later deleted.
 107 XMLSectionImportContext::XMLSectionImportContext(
 108     SvXMLImport& rImport,
 109     sal_uInt16 nPrfx,
 110     const OUString& rLocalName )
 111 :       SvXMLImportContext(rImport, nPrfx, rLocalName)
 112 ,       sTextSection(RTL_CONSTASCII_USTRINGPARAM(sAPI_TextSection))
 113 ,       sIndexHeaderSection(RTL_CONSTASCII_USTRINGPARAM(sAPI_IndexHeaderSection))
 114 ,       sCondition(RTL_CONSTASCII_USTRINGPARAM(sAPI_Condition))
 115 ,       sIsVisible(RTL_CONSTASCII_USTRINGPARAM(sAPI_IsVisible))
 116 ,       sProtectionKey(RTL_CONSTASCII_USTRINGPARAM(sAPI_ProtectionKey))
 117 ,       sIsProtected(RTL_CONSTASCII_USTRINGPARAM(sAPI_IsProtected))
 118 ,       sIsCurrentlyVisible(RTL_CONSTASCII_USTRINGPARAM(sAPI_IsCurrentlyVisible))
 119 ,       bProtect(sal_False)
 120 ,       bCondOK(sal_False)
 121 ,       bIsVisible(sal_True)
 122 ,       bValid(sal_False)
 123 ,       bSequenceOK(sal_False)
 124 ,       bIsCurrentlyVisible(sal_True)
 125 ,       bIsCurrentlyVisibleOK(sal_False)
 126 ,       bHasContent(sal_False)
 127 {
 128 }
 129
 130 XMLSectionImportContext::~XMLSectionImportContext()
 131 {
 132 }
 133
 134 void XMLSectionImportContext::StartElement(
 135     const Reference<XAttributeList> & xAttrList)
 136 {
 137     // process attributes
 138     ProcessAttributes(xAttrList);
 139
 140     // process index headers:
 141     sal_Bool bIsIndexHeader = IsXMLToken( GetLocalName(), XML_INDEX_TITLE );
 142     if (bIsIndexHeader)
 143     {
 144         bValid = sal_True;
 145     }
 146
 147     UniReference<XMLTextImportHelper> rHelper = GetImport().GetTextImport();
 148
 149     // valid?
 150     if (bValid)
 151     {
 152         // create text section (as XPropertySet)
 153         Reference<XMultiServiceFactory> xFactory(
 154             GetImport().GetModel(),UNO_QUERY);
 155         if (xFactory.is())
 156         {
 157             Reference<XInterface> xIfc =
 158                 xFactory->createInstance( bIsIndexHeader ? sIndexHeaderSection
 159                                                         : sTextSection );
 160             if (xIfc.is())
 161             {
 162                 Reference<XPropertySet> xPropSet(xIfc, UNO_QUERY);
 163
 164                 // save PropertySet (for CreateChildContext)
 165                 xSectionPropertySet = xPropSet;
 166
 167                 // xml:id for RDF metadata
 168                 GetImport().SetXmlId(xIfc, sXmlId);
 169
 170                 // name
 171                 Reference<XNamed> xNamed(xPropSet, UNO_QUERY);
 172                 xNamed->setName(sName);
 173
 174                 // stylename?
 175                 if (sStyleName.getLength() > 0)
 176                 {
 177                     XMLPropStyleContext* pStyle = rHelper->
 178                         FindSectionStyle(sStyleName);
 179
 180                     if (pStyle != NULL)
 181                     {
 182                         pStyle->FillPropertySet( xPropSet );
 183                     }
 184                 }
 185
 186                 // IsVisible and condition (not for index headers)
 187                 if (! bIsIndexHeader)
 188                 {
 189                     Any aAny;
 190                     aAny.setValue( &bIsVisible, ::getBooleanCppuType() );
 191                     xPropSet->setPropertyValue( sIsVisible, aAny );
 192
 193                     // #97450# hidden sections must be hidden on reload
 194                     // For backwards compatibilty, set flag only if it is
 195                     // present
 196                     if( bIsCurrentlyVisibleOK )
 197                     {
 198                         aAny.setValue( &bIsCurrentlyVisible,
 199                                        ::getBooleanCppuType() );
 200                         xPropSet->setPropertyValue( sIsCurrentlyVisible, aAny);
 201                     }
 202
 203                     if (bCondOK)
 204                     {
 205                         aAny <<= sCond;
 206                         xPropSet->setPropertyValue( sCondition, aAny );
 207                     }
 208                 }
 209
 210                 // password (only for regular sections)
 211                 if ( bSequenceOK &&
 212                      IsXMLToken(GetLocalName(), XML_SECTION) )
 213                 {
 214                     Any aAny;
 215                     aAny <<= aSequence;
 216                     xPropSet->setPropertyValue(sProtectionKey, aAny);
 217                 }
 218
 219                 // protection
 220                 Any aAny;
 221                 aAny.setValue( &bProtect, ::getBooleanCppuType() );
 222                 xPropSet->setPropertyValue( sIsProtected, aAny );
 223
 224                 // insert marker, <paragraph>, marker; then insert
 225                 // section over the first marker character, and delete the
 226                 // last paragraph (and marker) when closing a section.
 227                 Reference<XTextRange> xStart =
 228                     rHelper->GetCursor()->getStart();
 229 #ifdef PRODUCT
 230                 static const sal_Char sMarker[] = " ";
 231 #else
 232                 static const sal_Char sMarker[] = "X";
 233 #endif
 234                 OUString sMarkerString(RTL_CONSTASCII_USTRINGPARAM(sMarker));
 235                 rHelper->InsertString(sMarkerString);
 236                 rHelper->InsertControlCharacter(
 237                     ControlCharacter::APPEND_PARAGRAPH );
 238                 rHelper->InsertString(sMarkerString);
 239
 240                 // select first marker
 241                 rHelper->GetCursor()->gotoRange(xStart, sal_False);
 242                 rHelper->GetCursor()->goRight(1, sal_True);
 243
 244                 // convert section to XTextContent
 245                 Reference<XTextContent> xTextContent(xSectionPropertySet,
 246                                                      UNO_QUERY);
 247
 248                 // and insert (over marker)
 249                 rHelper->GetText()->insertTextContent(
 250                     rHelper->GetCursorAsRange(), xTextContent, sal_True );
 251
 252                 // and delete first marker (in section)
 253                 rHelper->GetText()->insertString(
 254                     rHelper->GetCursorAsRange(), sEmpty, sal_True);
 255
 256                 // finally, check for redlines that should start at
 257                 // the section start node
 258                 rHelper->RedlineAdjustStartNodeCursor(sal_True); // start ???
 259             }
 260         }
 261     }
 262 }
 263
 264 void XMLSectionImportContext::ProcessAttributes(
 265     const Reference<XAttributeList> & xAttrList )
 266 {
 267     SvXMLTokenMap aTokenMap(aSectionTokenMap);
 268
 269     sal_Int16 nLength = xAttrList->getLength();
 270     for(sal_Int16 nAttr = 0; nAttr < nLength; nAttr++)
 271     {
 272         OUString sLocalName;
 273         sal_uInt16 nNamePrefix = GetImport().GetNamespaceMap().
 274             GetKeyByAttrName( xAttrList->getNameByIndex(nAttr),
 275                               &sLocalName );
 276         OUString sAttr = xAttrList->getValueByIndex(nAttr);
 277
 278         switch (aTokenMap.Get(nNamePrefix, sLocalName))
 279         {
 280             case XML_TOK_SECTION_XMLID:
 281                 sXmlId = sAttr;
 282                 break;
 283             case XML_TOK_SECTION_STYLE_NAME:
 284                 sStyleName = sAttr;
 285                 break;
 286             case XML_TOK_SECTION_NAME:
 287                 sName = sAttr;
 288                 bValid = sal_True;
 289                 break;
 290             case XML_TOK_SECTION_CONDITION:
 291                 {
 292                     OUString sTmp;
 293                     sal_uInt16 nPrefix = GetImport().GetNamespaceMap().
 294                                     _GetKeyByAttrName( sAttr, &sTmp, sal_False );
 295                     if( XML_NAMESPACE_OOOW == nPrefix )
 296                     {
 297                         sCond = sTmp;
 298                         bCondOK = sal_True;
 299                     }
 300                     else
 301                         sCond = sAttr;
 302                 }
 303                 break;
 304             case XML_TOK_SECTION_DISPLAY:
 305                 if (IsXMLToken(sAttr, XML_TRUE))
 306                 {
 307                     bIsVisible = sal_True;
 308                 }
 309                 else if ( IsXMLToken(sAttr, XML_NONE) ||
 310                           IsXMLToken(sAttr, XML_CONDITION) )
 311                 {
 312                     bIsVisible = sal_False;
 313                 }
 314                 // else: ignore
 315                 break;
 316             case XML_TOK_SECTION_IS_HIDDEN:
 317                 {
 318                     sal_Bool bTmp;
 319                     if (SvXMLUnitConverter::convertBool(bTmp, sAttr))
 320                     {
 321                         bIsCurrentlyVisible = !bTmp;
 322                         bIsCurrentlyVisibleOK = sal_True;
 323                     }
 324                 }
 325                 break;
 326             case XML_TOK_SECTION_PROTECTION_KEY:
 327                 SvXMLUnitConverter::decodeBase64(aSequence, sAttr);
 328                 bSequenceOK = sal_True;
 329                 break;
 330             case XML_TOK_SECTION_PROTECT:
 331             {
 332                 sal_Bool bTmp;
 333                 if (SvXMLUnitConverter::convertBool(bTmp, sAttr))
 334                 {
 335                     bProtect = bTmp;
 336                 }
 337                 break;
 338             }
 339             default:
 340                 ; // ignore
 341                 break;
 342         }
 343     }
 344 }
 345
 346 void XMLSectionImportContext::EndElement()
 347 {
 348     // get rid of last paragraph
 349     // (unless it's the only paragraph in the section)
 350     UniReference<XMLTextImportHelper> rHelper = GetImport().GetTextImport();
 351     rHelper->GetCursor()->goRight(1, sal_False);
 352     if (bHasContent)
 353     {
 354         rHelper->GetCursor()->goLeft(1, sal_True);
 355         rHelper->GetText()->insertString(rHelper->GetCursorAsRange(),
 356                                          sEmpty, sal_True);
 357     }
 358
 359     // and delete second marker
 360     rHelper->GetCursor()->goRight(1, sal_True);
 361     rHelper->GetText()->insertString(rHelper->GetCursorAsRange(),
 362                                      sEmpty, sal_True);
 363
 364     // check for redlines to our endnode
 365     rHelper->RedlineAdjustStartNodeCursor(sal_False);
 366 }
 367
 368 SvXMLImportContext* XMLSectionImportContext::CreateChildContext(
 369     sal_uInt16 nPrefix,
 370     const OUString& rLocalName,
 371     const Reference<XAttributeList> & xAttrList )
 372 {
 373     SvXMLImportContext* pContext = NULL;
 374
 375     // section-source (-dde) elements
 376     if ( (XML_NAMESPACE_TEXT == nPrefix) &&
 377          IsXMLToken(rLocalName, XML_SECTION_SOURCE) )
 378     {
 379         pContext = new XMLSectionSourceImportContext(GetImport(),
 380                                                      nPrefix, rLocalName,
 381                                                      xSectionPropertySet);
 382     }
 383     else if ( (XML_NAMESPACE_OFFICE == nPrefix) &&
 384               IsXMLToken(rLocalName, XML_DDE_SOURCE) )
 385     {
 386         pContext = new XMLSectionSourceDDEImportContext(GetImport(),
 387                                                         nPrefix, rLocalName,
 388                                                         xSectionPropertySet);
 389     }
 390     else
 391     {
 392         // otherwise: text context
 393         pContext = GetImport().GetTextImport()->CreateTextChildContext(
 394             GetImport(), nPrefix, rLocalName, xAttrList,
 395             XML_TEXT_TYPE_SECTION );
 396
 397         // if that fails, default context
 398         if (NULL == pContext)
 399         {
 400             pContext = new SvXMLImportContext( GetImport(),
 401                                                nPrefix, rLocalName );
 402         }
 403         else
 404             bHasContent = sal_True;
 405     }
 406
 407     return pContext;
 408 }
 409