sc/source/filter/xml/xmltabi.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: xmltabi.cxx,v $
  10  * $Revision: 1.40.134.4 $
  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_sc.hxx"
  33
  34
  35
  36 // INCLUDE ---------------------------------------------------------------
  37
  38 #include "xmltabi.hxx"
  39 #include "xmlimprt.hxx"
  40 #include "xmlrowi.hxx"
  41 #include "xmlcoli.hxx"
  42 #include "xmlsceni.hxx"
  43 #include "xmlexternaltabi.hxx"
  44 #include "document.hxx"
  45 #include "docuno.hxx"
  46 #include "olinetab.hxx"
  47 #include "XMLConverter.hxx"
  48 #include "XMLTableShapesContext.hxx"
  49 #include "XMLTableSourceContext.hxx"
  50 #include "XMLStylesImportHelper.hxx"
  51 #include "rangeutl.hxx"
  52 #include "externalrefmgr.hxx"
  53
  54 #include <xmloff/xmltkmap.hxx>
  55 #include <xmloff/nmspmap.hxx>
  56 #include <xmloff/formsimp.hxx>
  57 #include <xmloff/xmltoken.hxx>
  58
  59 #include <com/sun/star/sheet/XSpreadsheetDocument.hpp>
  60 #include <com/sun/star/sheet/XSpreadsheets.hpp>
  61 #include <com/sun/star/sheet/XSpreadsheet.hpp>
  62 #include <com/sun/star/sheet/XPrintAreas.hpp>
  63 #include <com/sun/star/table/CellAddress.hpp>
  64
  65 using namespace com::sun::star;
  66 using namespace xmloff::token;
  67 using ::com::sun::star::uno::Reference;
  68 using ::com::sun::star::xml::sax::XAttributeList;
  69 using ::rtl::OUString;
  70
  71 /**
  72  * Determine whether this table is an external reference cache from its
  73  * name.  There is currently no way of determining whether a table is a
  74  * regular table or an external reference cache other than examining the
  75  * name itself.  We should probably introduce a new boolean value for
  76  * table:table element and use it instead of doing this, to make it more
  77  * reliable and future-proof.
  78  *
  79  * @param rName
  80  *
  81  * @return
  82  */
  83 static bool lcl_isExternalRefCache(const rtl::OUString& rName, rtl::OUString& rUrl, rtl::OUString& rExtTabName)
  84 {
  85     // 'file:///path/to/file.ods'#MySheet
  86     // 'file:///path/to/file.ods'#MySheet with space
  87     // 'file:///path/to/file's.ods'#Sheet (Notice the quote in the file name.
  88     //  That's allowed.)
  89
  90     static const sal_Unicode aPrefix[] = {
  91         '\'', 'f', 'i', 'l', 'e', ':', '/', '/'
  92     };
  93
  94     rtl::OUStringBuffer aUrlBuf, aTabNameBuf;
  95     aUrlBuf.appendAscii("file://");
  96     sal_Int32 n = rName.getLength();
  97     const sal_Unicode* p = rName.getStr();
  98
  99     bool bInUrl = true;
 100     sal_Unicode cPrev = 0;
 101     for (sal_Int32 i = 0; i < n; ++i)
 102     {
 103         const sal_Unicode c = p[i];
 104         if (i <= 7)
 105         {
 106             if (c != aPrefix[i])
 107                 return false;
 108         }
 109         else if (c == '#')
 110         {
 111             if (cPrev != '\'')
 112                 return false;
 113
 114             rUrl = aUrlBuf.makeStringAndClear();
 115             rUrl = rUrl.copy(0, rUrl.getLength()-1); // remove the trailing single-quote.
 116             bInUrl = false;
 117         }
 118         else if (bInUrl)
 119             aUrlBuf.append(c);
 120         else
 121             aTabNameBuf.append(c);
 122
 123         cPrev = c;
 124     }
 125
 126     if (bInUrl)
 127         return false;
 128
 129     if (aTabNameBuf.getLength() == 0)
 130         return false;
 131
 132     rExtTabName = aTabNameBuf.makeStringAndClear();
 133
 134     return true;
 135 }
 136
 137 ScXMLExternalTabData::ScXMLExternalTabData() :
 138     mpCacheTable(), mnRow(0), mnCol(0), mnFileId(0)
 139 {
 140 }
 141
 142 //------------------------------------------------------------------
 143
 144 ScXMLTableContext::ScXMLTableContext( ScXMLImport& rImport,
 145                                                                           USHORT nPrfx,
 146                                                                           const ::rtl::OUString& rLName,
 147                                                                           const ::com::sun::star::uno::Reference<
 148                                                                           ::com::sun::star::xml::sax::XAttributeList>& xAttrList,
 149                                                                           const sal_Bool bTempIsSubTable,
 150                                                                           const sal_Int32 nSpannedCols) :
 151         SvXMLImportContext( rImport, nPrfx, rLName ),
 152     pExternalRefInfo(NULL),
 153         bStartFormPage(sal_False),
 154     bPrintEntireSheet(sal_True)
 155 {
 156         if (!bTempIsSubTable)
 157         {
 158         ScXMLTabProtectionData aProtectData;
 159                 rtl::OUString sName;
 160                 rtl::OUString sStyleName;
 161                 sal_Int16 nAttrCount(xAttrList.is() ? xAttrList->getLength() : 0);
 162                 const SvXMLTokenMap& rAttrTokenMap = GetScImport().GetTableAttrTokenMap();
 163                 for( sal_Int16 i=0; i < nAttrCount; ++i )
 164                 {
 165                         const rtl::OUString& sAttrName(xAttrList->getNameByIndex( i ));
 166                         rtl::OUString aLocalName;
 167                         USHORT nPrefix(GetScImport().GetNamespaceMap().GetKeyByAttrName(
 168                                                                                                 sAttrName, &aLocalName ));
 169                         const rtl::OUString& sValue(xAttrList->getValueByIndex( i ));
 170
 171                         switch( rAttrTokenMap.Get( nPrefix, aLocalName ) )
 172                         {
 173                                 case XML_TOK_TABLE_NAME:
 174                                                 sName = sValue;
 175                                         break;
 176                                 case XML_TOK_TABLE_STYLE_NAME:
 177                                                 sStyleName = sValue;
 178                                         break;
 179                                 case XML_TOK_TABLE_PROTECTED:
 180                     aProtectData.mbProtected = IsXMLToken(sValue, XML_TRUE);
 181                 break;
 182                                 case XML_TOK_TABLE_PRINT_RANGES:
 183                                                 sPrintRanges = sValue;
 184                                         break;
 185                                 case XML_TOK_TABLE_PASSWORD:
 186                     aProtectData.maPassword = sValue;
 187                 break;
 188                 case XML_TOK_TABLE_PASSHASH:
 189                     aProtectData.meHash1 = ScPassHashHelper::getHashTypeFromURI(sValue);
 190                 break;
 191                 case XML_TOK_TABLE_PASSHASH_2:
 192                     aProtectData.meHash2 = ScPassHashHelper::getHashTypeFromURI(sValue);
 193                 break;
 194                 case XML_TOK_TABLE_PRINT:
 195                     {
 196                         if (IsXMLToken(sValue, XML_FALSE))
 197                             bPrintEntireSheet = sal_False;
 198                     }
 199                     break;
 200                         }
 201                 }
 202
 203         rtl::OUString aExtUrl, aExtTabName;
 204         if (lcl_isExternalRefCache(sName, aExtUrl, aExtTabName))
 205         {
 206             // This is an external ref cache table.
 207             pExternalRefInfo.reset(new ScXMLExternalTabData);
 208             pExternalRefInfo->maFileUrl = aExtUrl;
 209             ScDocument* pDoc = GetScImport().GetDocument();
 210             if (pDoc)
 211             {
 212                 ScExternalRefManager* pRefMgr = pDoc->GetExternalRefManager();
 213                 pExternalRefInfo->mnFileId = pRefMgr->getExternalFileId(aExtUrl);
 214                 pExternalRefInfo->mpCacheTable = pRefMgr->getCacheTable(pExternalRefInfo->mnFileId, aExtTabName, true);
 215             }
 216         }
 217         else
 218         {
 219             // This is a regular table.
 220             GetScImport().GetTables().NewSheet(sName, sStyleName, aProtectData);
 221         }
 222         }
 223         else
 224         {
 225                 GetScImport().GetTables().NewTable(nSpannedCols);
 226         }
 227 }
 228
 229 ScXMLTableContext::~ScXMLTableContext()
 230 {
 231 }
 232
 233 SvXMLImportContext *ScXMLTableContext::CreateChildContext( USHORT nPrefix,
 234                                                                                         const ::rtl::OUString& rLName,
 235                                                                                         const ::com::sun::star::uno::Reference<
 236                                                                                 ::com::sun::star::xml::sax::XAttributeList>& xAttrList )
 237 {
 238         const SvXMLTokenMap& rTokenMap(GetScImport().GetTableElemTokenMap());
 239     sal_uInt16 nToken = rTokenMap.Get(nPrefix, rLName);
 240     if (pExternalRefInfo.get())
 241     {
 242         // We only care about the table-row and table-source elements for
 243         // external cache data.
 244         switch (nToken)
 245         {
 246             case XML_TOK_TABLE_ROW_GROUP:
 247             case XML_TOK_TABLE_HEADER_ROWS:
 248             case XML_TOK_TABLE_ROWS:
 249                 // #i101319# don't discard rows in groups or header (repeat range)
 250                 return new ScXMLExternalRefRowsContext(
 251                     GetScImport(), nPrefix, rLName, xAttrList, *pExternalRefInfo);
 252             case XML_TOK_TABLE_ROW:
 253                 return new ScXMLExternalRefRowContext(
 254                     GetScImport(), nPrefix, rLName, xAttrList, *pExternalRefInfo);
 255             case XML_TOK_TABLE_SOURCE:
 256                 return new ScXMLExternalRefTabSourceContext(
 257                     GetScImport(), nPrefix, rLName, xAttrList, *pExternalRefInfo);
 258             default:
 259                 ;
 260         }
 261
 262         return new SvXMLImportContext(GetImport(), nPrefix, rLName);
 263     }
 264
 265         SvXMLImportContext *pContext(0);
 266
 267         switch (nToken)
 268         {
 269         case XML_TOK_TABLE_COL_GROUP:
 270                 pContext = new ScXMLTableColsContext( GetScImport(), nPrefix,
 271                                                                                                    rLName, xAttrList,
 272                                                                                                    sal_False, sal_True );
 273                 break;
 274         case XML_TOK_TABLE_HEADER_COLS:
 275                 pContext = new ScXMLTableColsContext( GetScImport(), nPrefix,
 276                                                                                                    rLName, xAttrList,
 277                                                                                                    sal_True, sal_False );
 278                 break;
 279         case XML_TOK_TABLE_COLS:
 280                 pContext = new ScXMLTableColsContext( GetScImport(), nPrefix,
 281                                                                                                    rLName, xAttrList,
 282                                                                                                    sal_False, sal_False );
 283                 break;
 284         case XML_TOK_TABLE_COL:
 285                         pContext = new ScXMLTableColContext( GetScImport(), nPrefix,
 286                                                                                                           rLName, xAttrList );
 287                 break;
 288     case XML_TOK_TABLE_PROTECTION:
 289         pContext = new ScXMLTableProtectionContext( GetScImport(), nPrefix, rLName, xAttrList );
 290         break;
 291         case XML_TOK_TABLE_ROW_GROUP:
 292                 pContext = new ScXMLTableRowsContext( GetScImport(), nPrefix,
 293                                                                                                    rLName, xAttrList,
 294                                                                                                    sal_False, sal_True );
 295                 break;
 296         case XML_TOK_TABLE_HEADER_ROWS:
 297                 pContext = new ScXMLTableRowsContext( GetScImport(), nPrefix,
 298                                                                                                    rLName, xAttrList,
 299                                                                                                    sal_True, sal_False );
 300                 break;
 301         case XML_TOK_TABLE_ROWS:
 302                 pContext = new ScXMLTableRowsContext( GetScImport(), nPrefix,
 303                                                                                                    rLName, xAttrList,
 304                                                                                                    sal_False, sal_False );
 305                 break;
 306         case XML_TOK_TABLE_ROW:
 307                         pContext = new ScXMLTableRowContext( GetScImport(), nPrefix,
 308                                                                                                           rLName, xAttrList//,
 309                                                                                                           //this
 310                                                                                                           );
 311                 break;
 312         case XML_TOK_TABLE_SOURCE:
 313                 pContext = new ScXMLTableSourceContext( GetScImport(), nPrefix, rLName, xAttrList);
 314                 break;
 315         case XML_TOK_TABLE_SCENARIO:
 316                 pContext = new ScXMLTableScenarioContext( GetScImport(), nPrefix, rLName, xAttrList);
 317                 break;
 318         case XML_TOK_TABLE_SHAPES:
 319                 pContext = new ScXMLTableShapesContext( GetScImport(), nPrefix, rLName, xAttrList);
 320                 break;
 321         case XML_TOK_TABLE_FORMS:
 322                 {
 323                         GetScImport().GetFormImport()->startPage(GetScImport().GetTables().GetCurrentXDrawPage());
 324                         bStartFormPage = sal_True;
 325                         pContext = GetScImport().GetFormImport()->createOfficeFormsContext( GetScImport(), nPrefix, rLName );
 326                 }
 327                 break;
 328     default:
 329         ;
 330         }
 331
 332         if( !pContext )
 333                 pContext = new SvXMLImportContext( GetImport(), nPrefix, rLName );
 334
 335         return pContext;
 336 }
 337
 338 void ScXMLTableContext::EndElement()
 339 {
 340         GetScImport().LockSolarMutex();
 341         GetScImport().GetStylesImportHelper()->EndTable();
 342         ScDocument* pDoc(GetScImport().GetDocument());
 343         if (pDoc)
 344         {
 345                 if (sPrintRanges.getLength())
 346                 {
 347                         uno::Reference< sheet::XPrintAreas > xPrintAreas( GetScImport().GetTables().GetCurrentXSheet(), uno::UNO_QUERY );
 348                         if( xPrintAreas.is() )
 349                         {
 350                                 uno::Sequence< table::CellRangeAddress > aRangeList;
 351                                 ScRangeStringConverter::GetRangeListFromString( aRangeList, sPrintRanges, pDoc, ::formula::FormulaGrammar::CONV_OOO );
 352                                 xPrintAreas->setPrintAreas( aRangeList );
 353                         }
 354                 }
 355         else if (bPrintEntireSheet) pDoc->SetPrintEntireSheet(static_cast<SCTAB>(GetScImport().GetTables().GetCurrentSheet()));
 356
 357                 ScOutlineTable* pOutlineTable(pDoc->GetOutlineTable(static_cast<SCTAB>(GetScImport().GetTables().GetCurrentSheet()), sal_False));
 358                 if (pOutlineTable)
 359                 {
 360                         ScOutlineArray* pColArray(pOutlineTable->GetColArray());
 361                         sal_Int32 nDepth(pColArray->GetDepth());
 362             sal_Int32 i;
 363             for (i = 0; i < nDepth; ++i)
 364                         {
 365                                 sal_Int32 nCount(pColArray->GetCount(static_cast<USHORT>(i)));
 366                                 for (sal_Int32 j = 0; j < nCount; ++j)
 367                                 {
 368                                         ScOutlineEntry* pEntry(pColArray->GetEntry(static_cast<USHORT>(i), static_cast<USHORT>(j)));
 369                                         if (pEntry->IsHidden())
 370                                                 pColArray->SetVisibleBelow(static_cast<USHORT>(i), static_cast<USHORT>(j), sal_False);
 371                                 }
 372                         }
 373                         ScOutlineArray* pRowArray(pOutlineTable->GetRowArray());
 374                         nDepth = pRowArray->GetDepth();
 375                         for (i = 0; i < nDepth; ++i)
 376                         {
 377                                 sal_Int32 nCount(pRowArray->GetCount(static_cast<USHORT>(i)));
 378                                 for (sal_Int32 j = 0; j < nCount; ++j)
 379                                 {
 380                                         ScOutlineEntry* pEntry(pRowArray->GetEntry(static_cast<USHORT>(i), static_cast<USHORT>(j)));
 381                                         if (pEntry->IsHidden())
 382                                                 pRowArray->SetVisibleBelow(static_cast<USHORT>(i), static_cast<USHORT>(j), sal_False);
 383                                 }
 384                         }
 385                 }
 386                 if (GetScImport().GetTables().HasDrawPage())
 387                 {
 388                         if (GetScImport().GetTables().HasXShapes())
 389                         {
 390                                 GetScImport().GetShapeImport()->popGroupAndSort();
 391                                 uno::Reference < drawing::XShapes > xTempShapes(GetScImport().GetTables().GetCurrentXShapes());
 392                                 GetScImport().GetShapeImport()->endPage(xTempShapes);
 393                         }
 394                         if (bStartFormPage)
 395                                 GetScImport().GetFormImport()->endPage();
 396                 }
 397
 398                 GetScImport().GetTables().DeleteTable();
 399                 GetScImport().ProgressBarIncrement(sal_False);
 400         }
 401         GetScImport().UnlockSolarMutex();
 402 }
 403
 404 // ============================================================================
 405
 406 ScXMLImport& ScXMLTableProtectionContext::GetScImport()
 407 {
 408     return static_cast<ScXMLImport&>(GetImport());
 409 }
 410
 411 ScXMLTableProtectionContext::ScXMLTableProtectionContext(
 412     ScXMLImport& rImport, USHORT nPrefix, const OUString& rLName,
 413     const Reference<XAttributeList>& xAttrList ) :
 414     SvXMLImportContext( rImport, nPrefix, rLName )
 415 {
 416     const SvXMLTokenMap& rAttrTokenMap = GetScImport().GetTableProtectionAttrTokenMap();
 417     bool bSelectProtectedCells = false;
 418     bool bSelectUnprotectedCells = false;
 419
 420     sal_Int16 nAttrCount = xAttrList.is() ? xAttrList->getLength() : 0;
 421
 422     for (sal_Int16 i = 0; i < nAttrCount; ++i)
 423     {
 424         const OUString& aAttrName = xAttrList->getNameByIndex(i);
 425         const OUString aValue = xAttrList->getValueByIndex(i);
 426
 427         OUString aLocalName;
 428         USHORT nLocalPrefix = GetScImport().GetNamespaceMap().GetKeyByAttrName(
 429             aAttrName, &aLocalName);
 430
 431         switch (rAttrTokenMap.Get(nLocalPrefix, aLocalName))
 432         {
 433             case XML_TOK_TABLE_SELECT_PROTECTED_CELLS:
 434                 bSelectProtectedCells = IsXMLToken(aValue, XML_TRUE);
 435             break;
 436             case XML_TOK_TABLE_SELECT_UNPROTECTED_CELLS:
 437                 bSelectUnprotectedCells = IsXMLToken(aValue, XML_TRUE);
 438             break;
 439             default:
 440                 ;
 441         }
 442     }
 443
 444     ScXMLTabProtectionData& rProtectData = GetScImport().GetTables().GetCurrentProtectionData();
 445     rProtectData.mbSelectProtectedCells   = bSelectProtectedCells;
 446     rProtectData.mbSelectUnprotectedCells = bSelectUnprotectedCells;
 447 }
 448
 449 ScXMLTableProtectionContext::~ScXMLTableProtectionContext()
 450 {
 451 }
 452
 453 SvXMLImportContext* ScXMLTableProtectionContext::CreateChildContext(
 454     USHORT /*nPrefix*/, const OUString& /*rLocalName*/, const Reference<XAttributeList>& /*xAttrList*/ )
 455 {
 456     return NULL;
 457 }
 458
 459 void ScXMLTableProtectionContext::EndElement()
 460 {
 461 }