sc/source/filter/excel/excdoc.cxx

   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 <sfx2/objsh.hxx>
  21 #include <rtl/ustring.hxx>
  22
  23 #include <document.hxx>
  24 #include <scextopt.hxx>
  25 #include <docoptio.hxx>
  26 #include <tabprotection.hxx>
  27 #include <postit.hxx>
  28 #include <root.hxx>
  29
  30 #include <excdoc.hxx>
  31 #include <xeextlst.hxx>
  32 #include <biffhelper.hxx>
  33
  34 #include <xcl97rec.hxx>
  35 #include <xetable.hxx>
  36 #include <xelink.hxx>
  37 #include <xepage.hxx>
  38 #include <xeview.hxx>
  39 #include <xecontent.hxx>
  40 #include <xeescher.hxx>
  41 #include <xepivot.hxx>
  42 #include <XclExpChangeTrack.hxx>
  43 #include <xepivotxml.hxx>
  44 #include <xedbdata.hxx>
  45 #include <xlcontent.hxx>
  46 #include <xlname.hxx>
  47 #include <xllink.hxx>
  48 #include <xltools.hxx>
  49
  50 #include <com/sun/star/document/XDocumentPropertiesSupplier.hpp>
  51 #include <oox/token/tokens.hxx>
  52 #include <oox/token/namespaces.hxx>
  53 #include <memory>
  54
  55 using namespace oox;
  56
  57 static OUString lcl_GetVbaTabName( SCTAB n )
  58 {
  59     OUString aRet = "__VBA__"  + OUString::number( static_cast<sal_uInt16>(n) );
  60     return aRet;
  61 }
  62
  63 static void lcl_AddBookviews( XclExpRecordList<>& aRecList, const ExcTable& self )
  64 {
  65     aRecList.AppendNewRecord( new XclExpXmlStartElementRecord( XML_bookViews ) );
  66     aRecList.AppendNewRecord( new XclExpWindow1( self.GetRoot() ) );
  67     aRecList.AppendNewRecord( new XclExpXmlEndElementRecord( XML_bookViews ) );
  68 }
  69
  70 static void lcl_AddCalcPr( XclExpRecordList<>& aRecList, const ExcTable& self )
  71 {
  72     ScDocument& rDoc = self.GetDoc();
  73
  74     aRecList.AppendNewRecord( new XclExpXmlStartSingleElementRecord( XML_calcPr ) );
  75     // OOXTODO: calcCompleted, calcId, calcMode, calcOnSave,
  76     //          concurrentCalc, concurrentManualCount,
  77     //          forceFullCalc, fullCalcOnLoad, fullPrecision
  78     aRecList.AppendNewRecord( new XclCalccount( rDoc ) );
  79     aRecList.AppendNewRecord( new XclRefmode( rDoc ) );
  80     aRecList.AppendNewRecord( new XclIteration( rDoc ) );
  81     aRecList.AppendNewRecord( new XclDelta( rDoc ) );
  82     aRecList.AppendNewRecord( new XclExpBoolRecord(oox::xls::BIFF_ID_SAVERECALC, true) );
  83     aRecList.AppendNewRecord( new XclExpXmlEndSingleElementRecord() );  // XML_calcPr
  84 }
  85
  86 static void lcl_AddWorkbookProtection( XclExpRecordList<>& aRecList, const ExcTable& self )
  87 {
  88     aRecList.AppendNewRecord( new XclExpXmlStartSingleElementRecord( XML_workbookProtection ) );
  89
  90     const ScDocProtection* pProtect = self.GetDoc().GetDocProtection();
  91     if (pProtect && pProtect->isProtected())
  92     {
  93         aRecList.AppendNewRecord( new XclExpWindowProtection(pProtect->isOptionEnabled(ScDocProtection::WINDOWS)) );
  94         aRecList.AppendNewRecord( new XclExpProtection(pProtect->isOptionEnabled(ScDocProtection::STRUCTURE)) );
  95         aRecList.AppendNewRecord( new XclExpPassHash(pProtect->getPasswordHash(PASSHASH_XL)) );
  96     }
  97
  98     aRecList.AppendNewRecord( new XclExpXmlEndSingleElementRecord() );   // XML_workbookProtection
  99 }
 100
 101 static void lcl_AddScenariosAndFilters( XclExpRecordList<>& aRecList, const XclExpRoot& rRoot, SCTAB nScTab )
 102 {
 103     // Scenarios
 104     aRecList.AppendNewRecord( new ExcEScenarioManager( rRoot, nScTab ) );
 105     // filter
 106     aRecList.AppendRecord( rRoot.GetFilterManager().CreateRecord( nScTab ) );
 107 }
 108
 109 ExcTable::ExcTable( const XclExpRoot& rRoot ) :
 110     XclExpRoot( rRoot ),
 111     mnScTab( SCTAB_GLOBAL ),
 112     nExcTab( EXC_NOTAB ),
 113     mxNoteList( new XclExpNoteList )
 114 {
 115 }
 116
 117 ExcTable::ExcTable( const XclExpRoot& rRoot, SCTAB nScTab ) :
 118     XclExpRoot( rRoot ),
 119     mnScTab( nScTab ),
 120     nExcTab( rRoot.GetTabInfo().GetXclTab( nScTab ) ),
 121     mxNoteList( new XclExpNoteList )
 122 {
 123 }
 124
 125 ExcTable::~ExcTable()
 126 {
 127 }
 128
 129 void ExcTable::Add( XclExpRecordBase* pRec )
 130 {
 131     OSL_ENSURE( pRec, "-ExcTable::Add(): pRec is NULL!" );
 132     aRecList.AppendNewRecord( pRec );
 133 }
 134
 135 void ExcTable::FillAsHeaderBinary( ExcBoundsheetList& rBoundsheetList )
 136 {
 137     InitializeGlobals();
 138
 139     RootData& rR = GetOldRoot();
 140     ScDocument& rDoc = GetDoc();
 141     XclExpTabInfo& rTabInfo = GetTabInfo();
 142
 143     if ( GetBiff() <= EXC_BIFF5 )
 144         Add( new ExcBofW );
 145     else
 146         Add( new ExcBofW8 );
 147
 148     sal_uInt16  nExcTabCount    = rTabInfo.GetXclTabCount();
 149     sal_uInt16  nCodenames      = static_cast< sal_uInt16 >( GetExtDocOptions().GetCodeNameCount() );
 150
 151     SfxObjectShell* pShell = GetDocShell();
 152     sal_uInt16 nWriteProtHash = pShell ? pShell->GetModifyPasswordHash() : 0;
 153     bool bRecommendReadOnly = pShell && pShell->IsLoadReadonly();
 154
 155     if( (nWriteProtHash > 0) || bRecommendReadOnly )
 156         Add( new XclExpEmptyRecord( EXC_ID_WRITEPROT ) );
 157
 158     // TODO: correct codepage for BIFF5?
 159     sal_uInt16 nCodePage = XclTools::GetXclCodePage( (GetBiff() <= EXC_BIFF5) ? RTL_TEXTENCODING_MS_1252 : RTL_TEXTENCODING_UNICODE );
 160
 161     if( GetBiff() <= EXC_BIFF5 )
 162     {
 163         Add( new XclExpEmptyRecord( EXC_ID_INTERFACEHDR ) );
 164         Add( new XclExpUInt16Record( EXC_ID_MMS, 0 ) );
 165         Add( new XclExpEmptyRecord( EXC_ID_TOOLBARHDR ) );
 166         Add( new XclExpEmptyRecord( EXC_ID_TOOLBAREND ) );
 167         Add( new XclExpEmptyRecord( EXC_ID_INTERFACEEND ) );
 168         Add( new ExcDummy_00 );
 169     }
 170     else
 171     {
 172         if( IsDocumentEncrypted() )
 173             Add( new XclExpFileEncryption( GetRoot() ) );
 174         Add( new XclExpInterfaceHdr( nCodePage ) );
 175         Add( new XclExpUInt16Record( EXC_ID_MMS, 0 ) );
 176         Add( new XclExpInterfaceEnd );
 177         Add( new XclExpWriteAccess );
 178     }
 179
 180     Add( new XclExpFileSharing( GetRoot(), nWriteProtHash, bRecommendReadOnly ) );
 181     Add( new XclExpUInt16Record( EXC_ID_CODEPAGE, nCodePage ) );
 182
 183     if( GetBiff() == EXC_BIFF8 )
 184     {
 185         Add( new XclExpBoolRecord( EXC_ID_DSF, false ) );
 186         Add( new XclExpEmptyRecord( EXC_ID_XL9FILE ) );
 187         rR.pTabId = new XclExpChTrTabId( std::max( nExcTabCount, nCodenames ) );
 188         Add( rR.pTabId );
 189         if( HasVbaStorage() )
 190         {
 191             Add( new XclObproj );
 192             const OUString& rCodeName = GetExtDocOptions().GetDocSettings().maGlobCodeName;
 193             if( !rCodeName.isEmpty() )
 194                 Add( new XclCodename( rCodeName ) );
 195         }
 196     }
 197
 198     Add( new XclExpUInt16Record( EXC_ID_FNGROUPCOUNT, 14 ) );
 199
 200     if ( GetBiff() <= EXC_BIFF5 )
 201     {
 202         // global link table: EXTERNCOUNT, EXTERNSHEET, NAME
 203         aRecList.AppendRecord( CreateRecord( EXC_ID_EXTERNSHEET ) );
 204         aRecList.AppendRecord( CreateRecord( EXC_ID_NAME ) );
 205     }
 206
 207     // document protection options
 208     lcl_AddWorkbookProtection( aRecList, *this );
 209
 210     if( GetBiff() == EXC_BIFF8 )
 211     {
 212         Add( new XclExpProt4Rev );
 213         Add( new XclExpProt4RevPass );
 214     }
 215
 216     lcl_AddBookviews( aRecList, *this );
 217
 218     Add( new XclExpXmlStartSingleElementRecord( XML_workbookPr ) );
 219     if ( GetBiff() == EXC_BIFF8 && GetOutput() != EXC_OUTPUT_BINARY )
 220     {
 221         Add( new XclExpBoolRecord(0x0040, false, XML_backupFile ) );    // BACKUP
 222         Add( new XclExpBoolRecord(0x008D, false, XML_showObjects ) );   // HIDEOBJ
 223     }
 224
 225     if ( GetBiff() == EXC_BIFF8 )
 226     {
 227         Add( new XclExpBoolRecord(0x0040, false) ); // BACKUP
 228         Add( new XclExpBoolRecord(0x008D, false) ); // HIDEOBJ
 229     }
 230
 231     if( GetBiff() <= EXC_BIFF5 )
 232     {
 233         Add( new ExcDummy_040 );
 234         Add( new Exc1904( rDoc ) );
 235         Add( new ExcDummy_041 );
 236     }
 237     else
 238     {
 239         // BIFF8
 240         Add( new Exc1904( rDoc ) );
 241         Add( new XclExpBoolRecord( 0x000E, !rDoc.GetDocOptions().IsCalcAsShown() ) );
 242         Add( new XclExpBoolRecord(0x01B7, false) ); // REFRESHALL
 243         Add( new XclExpBoolRecord(0x00DA, false) ); // BOOKBOOL
 244     }
 245
 246     // Formatting: FONT, FORMAT, XF, STYLE, PALETTE
 247     aRecList.AppendRecord( CreateRecord( EXC_ID_FONTLIST ) );
 248     aRecList.AppendRecord( CreateRecord( EXC_ID_FORMATLIST ) );
 249     aRecList.AppendRecord( CreateRecord( EXC_ID_XFLIST ) );
 250     aRecList.AppendRecord( CreateRecord( EXC_ID_PALETTE ) );
 251
 252     SCTAB   nC;
 253     SCTAB  nScTabCount     = rTabInfo.GetScTabCount();
 254     if( GetBiff() <= EXC_BIFF5 )
 255     {
 256         // Bundlesheet
 257         for( nC = 0 ; nC < nScTabCount ; nC++ )
 258             if( rTabInfo.IsExportTab( nC ) )
 259             {
 260                 ExcBoundsheetList::RecordRefType xBoundsheet( new ExcBundlesheet( rR, nC ) );
 261                 aRecList.AppendRecord( xBoundsheet );
 262                 rBoundsheetList.AppendRecord( xBoundsheet );
 263             }
 264     }
 265     else
 266     {
 267         // Pivot Cache
 268         GetPivotTableManager().CreatePivotTables();
 269         aRecList.AppendRecord( GetPivotTableManager().CreatePivotCachesRecord() );
 270
 271         // Change tracking
 272         if( rDoc.GetChangeTrack() )
 273         {
 274             rR.pUserBViewList = new XclExpUserBViewList( *rDoc.GetChangeTrack() );
 275             Add( rR.pUserBViewList );
 276         }
 277
 278         // Natural Language Formulas Flag
 279         aRecList.AppendNewRecord( new XclExpBoolRecord( EXC_ID_USESELFS, GetDoc().GetDocOptions().IsLookUpColRowNames() ) );
 280
 281         // Bundlesheet
 282         for( nC = 0 ; nC < nScTabCount ; nC++ )
 283             if( rTabInfo.IsExportTab( nC ) )
 284             {
 285                 ExcBoundsheetList::RecordRefType xBoundsheet( new ExcBundlesheet8( rR, nC ) );
 286                 aRecList.AppendRecord( xBoundsheet );
 287                 rBoundsheetList.AppendRecord( xBoundsheet );
 288             }
 289
 290         OUString aTmpString;
 291         for( SCTAB nAdd = 0; nC < static_cast<SCTAB>(nCodenames) ; nC++, nAdd++ )
 292         {
 293             aTmpString = lcl_GetVbaTabName( nAdd );
 294             ExcBoundsheetList::RecordRefType xBoundsheet( new ExcBundlesheet8( aTmpString ) );
 295             aRecList.AppendRecord( xBoundsheet );
 296             rBoundsheetList.AppendRecord( xBoundsheet );
 297         }
 298
 299         // COUNTRY - in BIFF8 in workbook globals
 300         Add( new XclExpCountry( GetRoot() ) );
 301
 302         // link table: SUPBOOK, XCT, CRN, EXTERNNAME, EXTERNSHEET, NAME
 303         aRecList.AppendRecord( CreateRecord( EXC_ID_EXTERNSHEET ) );
 304         aRecList.AppendRecord( CreateRecord( EXC_ID_NAME ) );
 305
 306         Add( new XclExpRecalcId );
 307
 308         // MSODRAWINGGROUP per-document data
 309         aRecList.AppendRecord( GetObjectManager().CreateDrawingGroup() );
 310         // Shared string table: SST, EXTSST
 311         aRecList.AppendRecord( CreateRecord( EXC_ID_SST ) );
 312
 313         Add( new XclExpBookExt );
 314     }
 315
 316     Add( new ExcEof );
 317 }
 318
 319 void ExcTable::FillAsHeaderXml( ExcBoundsheetList& rBoundsheetList )
 320 {
 321     InitializeGlobals();
 322
 323     RootData& rR = GetOldRoot();
 324     ScDocument& rDoc = GetDoc();
 325     XclExpTabInfo& rTabInfo = GetTabInfo();
 326
 327     sal_uInt16  nExcTabCount    = rTabInfo.GetXclTabCount();
 328     sal_uInt16  nCodenames      = static_cast< sal_uInt16 >( GetExtDocOptions().GetCodeNameCount() );
 329
 330     rR.pTabId = new XclExpChTrTabId( std::max( nExcTabCount, nCodenames ) );
 331     Add( rR.pTabId );
 332
 333     Add( new XclExpXmlStartSingleElementRecord( XML_workbookPr ) );
 334     Add( new XclExpBoolRecord(0x0040, false, XML_backupFile ) );    // BACKUP
 335     Add( new XclExpBoolRecord(0x008D, false, XML_showObjects ) );   // HIDEOBJ
 336
 337     Add( new Exc1904( rDoc ) );
 338     // OOXTODO: The following /workbook/workbookPr attributes are mapped
 339     //          to various BIFF records that are not currently supported:
 340     //
 341     //          XML_allowRefreshQuery:          QSISTAG 802h: fEnableRefresh
 342     //          XML_autoCompressPictures:       COMPRESSPICTURES 89Bh: fAutoCompressPictures
 343     //          XML_checkCompatibility:         COMPAT12 88Ch: fNoCompatChk
 344     //          XML_codeName:                   "Calc"
 345     //          XML_defaultThemeVersion:        ???
 346     //          XML_filterPrivacy:              BOOKEXT 863h: fFilterPrivacy
 347     //          XML_hidePivotFieldList:         BOOKBOOL DAh: fHidePivotTableFList
 348     //          XML_promptedSolutions:          BOOKEXT 863h: fBuggedUserAboutSolution
 349     //          XML_publishItems:               NAMEPUBLISH 893h: fPublished
 350     //          XML_saveExternalLinkValues:     BOOKBOOL DAh: fNoSavSupp
 351     //          XML_showBorderUnselectedTables: BOOKBOOL DAh: fHideBorderUnsels
 352     //          XML_showInkAnnotation:          BOOKEXT 863h: fShowInkAnnotation
 353     //          XML_showPivotChart:             PIVOTCHARTBITS 859h: fGXHide??
 354     //          XML_updateLinks:                BOOKBOOL DAh: grbitUpdateLinks
 355     Add( new XclExpXmlEndSingleElementRecord() );   // XML_workbookPr
 356
 357     // Formatting: FONT, FORMAT, XF, STYLE, PALETTE
 358     aRecList.AppendNewRecord( new XclExpXmlStyleSheet( *this ) );
 359
 360     // Change tracking
 361     if( rDoc.GetChangeTrack() )
 362     {
 363         rR.pUserBViewList = new XclExpUserBViewList( *rDoc.GetChangeTrack() );
 364         Add( rR.pUserBViewList );
 365     }
 366
 367     lcl_AddWorkbookProtection( aRecList, *this );
 368     lcl_AddBookviews( aRecList, *this );
 369
 370     // Bundlesheet
 371     SCTAB nC;
 372     SCTAB nScTabCount = rTabInfo.GetScTabCount();
 373     aRecList.AppendNewRecord( new XclExpXmlStartElementRecord( XML_sheets ) );
 374     for( nC = 0 ; nC < nScTabCount ; nC++ )
 375         if( rTabInfo.IsExportTab( nC ) )
 376         {
 377             ExcBoundsheetList::RecordRefType xBoundsheet( new ExcBundlesheet8( rR, nC ) );
 378             aRecList.AppendRecord( xBoundsheet );
 379             rBoundsheetList.AppendRecord( xBoundsheet );
 380         }
 381     aRecList.AppendNewRecord( new XclExpXmlEndElementRecord( XML_sheets ) );
 382
 383     OUString aTmpString;
 384     for( SCTAB nAdd = 0; nC < static_cast<SCTAB>(nCodenames) ; nC++, nAdd++ )
 385     {
 386         aTmpString = lcl_GetVbaTabName( nAdd );
 387         ExcBoundsheetList::RecordRefType xBoundsheet( new ExcBundlesheet8( aTmpString ) );
 388         aRecList.AppendRecord( xBoundsheet );
 389         rBoundsheetList.AppendRecord( xBoundsheet );
 390     }
 391
 392     // link table: SUPBOOK, XCT, CRN, EXTERNNAME, EXTERNSHEET, NAME
 393     aRecList.AppendRecord( CreateRecord( EXC_ID_EXTERNSHEET ) );
 394     aRecList.AppendRecord( CreateRecord( EXC_ID_NAME ) );
 395
 396     lcl_AddCalcPr( aRecList, *this );
 397
 398     // MSODRAWINGGROUP per-document data
 399     aRecList.AppendRecord( GetObjectManager().CreateDrawingGroup() );
 400     // Shared string table: SST, EXTSST
 401     aRecList.AppendRecord( CreateRecord( EXC_ID_SST ) );
 402 }
 403
 404 void ExcTable::FillAsTableBinary( SCTAB nCodeNameIdx )
 405 {
 406     InitializeTable( mnScTab );
 407
 408     RootData& rR = GetOldRoot();
 409     XclBiff eBiff = GetBiff();
 410     ScDocument& rDoc = GetDoc();
 411
 412     OSL_ENSURE( (mnScTab >= 0) && (mnScTab <= MAXTAB), "-ExcTable::Table(): mnScTab - no ordinary table!" );
 413     OSL_ENSURE( nExcTab <= static_cast<sal_uInt16>(MAXTAB), "-ExcTable::Table(): nExcTab - no ordinary table!" );
 414
 415     // create a new OBJ list for this sheet (may be used by notes, autofilter, data validation)
 416     if( eBiff == EXC_BIFF8 )
 417         GetObjectManager().StartSheet();
 418
 419     // cell table: DEFROWHEIGHT, DEFCOLWIDTH, COLINFO, DIMENSIONS, ROW, cell records
 420     mxCellTable.reset( new XclExpCellTable( GetRoot() ) );
 421
 422     //export cell notes
 423     std::vector<sc::NoteEntry> aNotes;
 424     rDoc.GetAllNoteEntries(aNotes);
 425     for (const auto& rNote : aNotes)
 426     {
 427         if (rNote.maPos.Tab() != mnScTab)
 428             continue;
 429
 430         mxNoteList->AppendNewRecord(new XclExpNote(GetRoot(), rNote.maPos, rNote.mpNote, OUString()));
 431     }
 432
 433     // WSBOOL needs data from page settings, create it here, add it later
 434     std::shared_ptr< XclExpPageSettings > xPageSett( new XclExpPageSettings( GetRoot() ) );
 435     bool bFitToPages = xPageSett->GetPageData().mbFitToPages;
 436
 437     if( eBiff <= EXC_BIFF5 )
 438     {
 439         Add( new ExcBof );
 440         Add( new ExcDummy_02a );
 441     }
 442     else
 443     {
 444         Add( new ExcBof8 );
 445         lcl_AddCalcPr( aRecList, *this );
 446     }
 447
 448     // GUTS (count & size of outline icons)
 449     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_GUTS ) );
 450     // DEFROWHEIGHT, created by the cell table
 451     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID2_DEFROWHEIGHT ) );
 452
 453     // COUNTRY - in BIFF5/7 in every worksheet
 454     if( eBiff <= EXC_BIFF5 )
 455         Add( new XclExpCountry( GetRoot() ) );
 456
 457     Add( new XclExpWsbool( bFitToPages ) );
 458
 459     // page settings (SETUP and various other records)
 460     aRecList.AppendRecord( xPageSett );
 461
 462     const ScTableProtection* pTabProtect = rDoc.GetTabProtection(mnScTab);
 463     if (pTabProtect && pTabProtect->isProtected())
 464     {
 465         Add( new XclExpProtection(true) );
 466         Add( new XclExpBoolRecord(oox::xls::BIFF_ID_SCENPROTECT, pTabProtect->isOptionEnabled(ScTableProtection::SCENARIOS)) );
 467         if (pTabProtect->isOptionEnabled(ScTableProtection::OBJECTS))
 468             Add( new XclExpBoolRecord(oox::xls::BIFF_ID_OBJECTPROTECT, true ));
 469         Add( new XclExpPassHash(pTabProtect->getPasswordHash(PASSHASH_XL)) );
 470     }
 471
 472     // local link table: EXTERNCOUNT, EXTERNSHEET
 473     if( eBiff <= EXC_BIFF5 )
 474         aRecList.AppendRecord( CreateRecord( EXC_ID_EXTERNSHEET ) );
 475
 476     if ( eBiff == EXC_BIFF8 )
 477         lcl_AddScenariosAndFilters( aRecList, GetRoot(), mnScTab );
 478
 479     // cell table: DEFCOLWIDTH, COLINFO, DIMENSIONS, ROW, cell records
 480     aRecList.AppendRecord( mxCellTable );
 481
 482     // MERGEDCELLS record, generated by the cell table
 483     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_MERGEDCELLS ) );
 484     // label ranges
 485     if( eBiff == EXC_BIFF8 )
 486         Add( new XclExpLabelranges( GetRoot() ) );
 487     // data validation (DVAL and list of DV records), generated by the cell table
 488     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_DVAL ) );
 489
 490     if( eBiff == EXC_BIFF8 )
 491     {
 492         // all MSODRAWING and OBJ stuff of this sheet goes here
 493         aRecList.AppendRecord( GetObjectManager().ProcessDrawing( GetSdrPage( mnScTab ) ) );
 494         // pivot tables
 495         aRecList.AppendRecord( GetPivotTableManager().CreatePivotTablesRecord( mnScTab ) );
 496     }
 497
 498     // list of NOTE records, generated by the cell table
 499     aRecList.AppendRecord( mxNoteList );
 500
 501     // sheet view settings: WINDOW2, SCL, PANE, SELECTION
 502     aRecList.AppendNewRecord( new XclExpTabViewSettings( GetRoot(), mnScTab ) );
 503
 504     if( eBiff == EXC_BIFF8 )
 505     {
 506         // sheet protection options
 507         Add( new XclExpSheetProtectOptions( GetRoot(), mnScTab ) );
 508
 509         // enhanced protections if there are
 510         if (pTabProtect)
 511         {
 512             const ::std::vector<ScEnhancedProtection>& rProts( pTabProtect->getEnhancedProtection());
 513             for (const auto& rProt : rProts)
 514             {
 515                 Add( new XclExpSheetEnhancedProtection( GetRoot(), rProt));
 516             }
 517         }
 518
 519         // web queries
 520         Add( new XclExpWebQueryBuffer( GetRoot() ) );
 521
 522         // conditional formats
 523         Add( new XclExpCondFormatBuffer( GetRoot(), XclExtLstRef() ) );
 524
 525         if( HasVbaStorage() )
 526             if( nCodeNameIdx < GetExtDocOptions().GetCodeNameCount() )
 527                 Add( new XclCodename( GetExtDocOptions().GetCodeName( nCodeNameIdx ) ) );
 528     }
 529
 530     // list of HLINK records, generated by the cell table
 531     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_HLINK ) );
 532
 533     // change tracking
 534     if( rR.pUserBViewList )
 535     {
 536         XclExpUserBViewList::const_iterator iter;
 537         for ( iter = rR.pUserBViewList->cbegin(); iter != rR.pUserBViewList->cend(); ++iter)
 538         {
 539             Add( new XclExpUsersViewBegin( (*iter).GetGUID(), nExcTab ) );
 540             Add( new XclExpUsersViewEnd );
 541         }
 542     }
 543
 544     // EOF
 545     Add( new ExcEof );
 546 }
 547
 548 void ExcTable::FillAsTableXml()
 549 {
 550     InitializeTable( mnScTab );
 551
 552     ScDocument& rDoc = GetDoc();
 553
 554     OSL_ENSURE( (mnScTab >= 0) && (mnScTab <= MAXTAB), "-ExcTable::Table(): mnScTab - no ordinary table!" );
 555     OSL_ENSURE( nExcTab <= static_cast<sal_uInt16>(MAXTAB), "-ExcTable::Table(): nExcTab - no ordinary table!" );
 556
 557     // create a new OBJ list for this sheet (may be used by notes, autofilter, data validation)
 558     GetObjectManager().StartSheet();
 559
 560     // cell table: DEFROWHEIGHT, DEFCOLWIDTH, COLINFO, DIMENSIONS, ROW, cell records
 561     mxCellTable.reset( new XclExpCellTable( GetRoot() ) );
 562
 563     //export cell notes
 564     std::vector<sc::NoteEntry> aNotes;
 565     rDoc.GetAllNoteEntries(aNotes);
 566     for (const auto& rNote : aNotes)
 567     {
 568         if (rNote.maPos.Tab() != mnScTab)
 569             continue;
 570
 571         mxNoteList->AppendNewRecord(new XclExpNote(GetRoot(), rNote.maPos, rNote.mpNote, OUString()));
 572     }
 573
 574     // WSBOOL needs data from page settings, create it here, add it later
 575     std::shared_ptr< XclExpPageSettings > xPageSett( new XclExpPageSettings( GetRoot() ) );
 576     XclExtLstRef xExtLst( new XclExtLst( GetRoot() ) );
 577     bool bFitToPages = xPageSett->GetPageData().mbFitToPages;
 578
 579     Color aTabColor = GetRoot().GetDoc().GetTabBgColor(mnScTab);
 580     Add(new XclExpXmlSheetPr(bFitToPages, mnScTab, aTabColor, &GetFilterManager()));
 581
 582     // GUTS (count & size of outline icons)
 583     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_GUTS ) );
 584     // DEFROWHEIGHT, created by the cell table
 585     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID2_DEFROWHEIGHT ) );
 586
 587     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID3_DIMENSIONS ) );
 588
 589     // sheet view settings: WINDOW2, SCL, PANE, SELECTION
 590     aRecList.AppendNewRecord( new XclExpTabViewSettings( GetRoot(), mnScTab ) );
 591
 592     // cell table: DEFCOLWIDTH, COLINFO, DIMENSIONS, ROW, cell records
 593     aRecList.AppendRecord( mxCellTable );
 594
 595     // list of NOTE records, generated by the cell table
 596     // not in the worksheet file
 597     if( mxNoteList != nullptr && !mxNoteList->IsEmpty() )
 598         aRecList.AppendNewRecord( new XclExpComments( mnScTab, *mxNoteList ) );
 599
 600     const ScTableProtection* pTabProtect = rDoc.GetTabProtection(mnScTab);
 601     if (pTabProtect && pTabProtect->isProtected())
 602         Add( new XclExpSheetProtection(true, mnScTab) );
 603
 604     lcl_AddScenariosAndFilters( aRecList, GetRoot(), mnScTab );
 605
 606     // MERGEDCELLS record, generated by the cell table
 607     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_MERGEDCELLS ) );
 608
 609     // conditional formats
 610     Add( new XclExpCondFormatBuffer( GetRoot(), xExtLst ) );
 611
 612     // data validation (DVAL and list of DV records), generated by the cell table
 613     aRecList.AppendRecord( mxCellTable->CreateRecord( EXC_ID_DVAL ) );
 614
 615     // list of HLINK records, generated by the cell table
 616     XclExpRecordRef xHyperlinks = mxCellTable->CreateRecord( EXC_ID_HLINK );
 617     XclExpHyperlinkList* pHyperlinkList = dynamic_cast<XclExpHyperlinkList*>(xHyperlinks.get());
 618     if( pHyperlinkList != nullptr && !pHyperlinkList->IsEmpty() )
 619     {
 620         aRecList.AppendNewRecord( new XclExpXmlStartElementRecord( XML_hyperlinks ) );
 621         aRecList.AppendRecord( xHyperlinks );
 622         aRecList.AppendNewRecord( new XclExpXmlEndElementRecord( XML_hyperlinks ) );
 623     }
 624
 625     aRecList.AppendRecord( xPageSett );
 626
 627     // all MSODRAWING and OBJ stuff of this sheet goes here
 628     aRecList.AppendRecord( GetObjectManager().ProcessDrawing( GetSdrPage( mnScTab ) ) );
 629
 630     XclExpImgData* pImgData = xPageSett->getGraphicExport();
 631     if (pImgData)
 632         aRecList.AppendRecord(std::shared_ptr<XclExpRecordBase>(pImgData));
 633
 634     // <tableParts> after <drawing> and before <extLst>
 635     aRecList.AppendRecord( GetTablesManager().GetTablesBySheet( mnScTab));
 636
 637     aRecList.AppendRecord( xExtLst );
 638 }
 639
 640 void ExcTable::FillAsEmptyTable( SCTAB nCodeNameIdx )
 641 {
 642     InitializeTable( mnScTab );
 643
 644     if( HasVbaStorage() && (nCodeNameIdx < GetExtDocOptions().GetCodeNameCount()) )
 645     {
 646         if( GetBiff() <= EXC_BIFF5 )
 647         {
 648             Add( new ExcBof );
 649         }
 650         else
 651         {
 652             Add( new ExcBof8 );
 653             Add( new XclCodename( GetExtDocOptions().GetCodeName( nCodeNameIdx ) ) );
 654         }
 655         // sheet view settings: WINDOW2, SCL, PANE, SELECTION
 656         aRecList.AppendNewRecord( new XclExpTabViewSettings( GetRoot(), mnScTab ) );
 657         Add( new ExcEof );
 658     }
 659 }
 660
 661 void ExcTable::Write( XclExpStream& rStrm )
 662 {
 663     SetCurrScTab( mnScTab );
 664     if( mxCellTable.get() )
 665         mxCellTable->Finalize(true);
 666     aRecList.Save( rStrm );
 667 }
 668
 669 void ExcTable::WriteXml( XclExpXmlStream& rStrm )
 670 {
 671     if (!GetTabInfo().IsExportTab(mnScTab))
 672     {
 673         // header export.
 674         SetCurrScTab(mnScTab);
 675         if (mxCellTable)
 676             mxCellTable->Finalize(false);
 677         aRecList.SaveXml(rStrm);
 678
 679         return;
 680     }
 681
 682     // worksheet export
 683     OUString sSheetName = XclXmlUtils::GetStreamName( "xl/", "worksheets/sheet", mnScTab+1 );
 684
 685     sax_fastparser::FSHelperPtr pWorksheet = rStrm.GetStreamForPath( sSheetName );
 686
 687     rStrm.PushStream( pWorksheet );
 688
 689     pWorksheet->startElement( XML_worksheet,
 690             XML_xmlns, rStrm.getNamespaceURL(OOX_NS(xls)).toUtf8(),
 691             FSNS(XML_xmlns, XML_r), rStrm.getNamespaceURL(OOX_NS(officeRel)).toUtf8() );
 692
 693     SetCurrScTab( mnScTab );
 694     if (mxCellTable)
 695         mxCellTable->Finalize(false);
 696     aRecList.SaveXml( rStrm );
 697
 698     XclExpXmlPivotTables* pPT = GetXmlPivotTableManager().GetTablesBySheet(mnScTab);
 699     if (pPT)
 700         pPT->SaveXml(rStrm);
 701
 702     rStrm.GetCurrentStream()->endElement( XML_worksheet );
 703     rStrm.PopStream();
 704 }
 705
 706 ExcDocument::ExcDocument( const XclExpRoot& rRoot ) :
 707     XclExpRoot( rRoot ),
 708     aHeader( rRoot )
 709 {
 710 }
 711
 712 ExcDocument::~ExcDocument()
 713 {
 714     maTableList.RemoveAllRecords();    // for the following assertion!
 715 }
 716
 717 void ExcDocument::ReadDoc()
 718 {
 719     InitializeConvert();
 720
 721     if (GetOutput() == EXC_OUTPUT_BINARY)
 722         aHeader.FillAsHeaderBinary(maBoundsheetList);
 723     else
 724     {
 725         aHeader.FillAsHeaderXml(maBoundsheetList);
 726         GetXmlPivotTableManager().Initialize();
 727         GetTablesManager().Initialize();    // Move outside conditions if we wanted to support BIFF.
 728     }
 729
 730     SCTAB nScTab = 0, nScTabCount = GetTabInfo().GetScTabCount();
 731     SCTAB nCodeNameIdx = 0, nCodeNameCount = GetExtDocOptions().GetCodeNameCount();
 732
 733     for( ; nScTab < nScTabCount; ++nScTab )
 734     {
 735         if( GetTabInfo().IsExportTab( nScTab ) )
 736         {
 737             ExcTableList::RecordRefType xTab( new ExcTable( GetRoot(), nScTab ) );
 738             maTableList.AppendRecord( xTab );
 739             if (GetOutput() == EXC_OUTPUT_BINARY)
 740                 xTab->FillAsTableBinary(nCodeNameIdx);
 741             else
 742                 xTab->FillAsTableXml();
 743
 744             ++nCodeNameIdx;
 745         }
 746     }
 747     for( ; nCodeNameIdx < nCodeNameCount; ++nScTab, ++nCodeNameIdx )
 748     {
 749         ExcTableList::RecordRefType xTab( new ExcTable( GetRoot(), nScTab ) );
 750         maTableList.AppendRecord( xTab );
 751         xTab->FillAsEmptyTable( nCodeNameIdx );
 752     }
 753
 754     if ( GetBiff() == EXC_BIFF8 )
 755     {
 756         // complete temporary Escher stream
 757         GetObjectManager().EndDocument();
 758
 759         // change tracking
 760         if ( GetDoc().GetChangeTrack() )
 761             m_xExpChangeTrack.reset(new XclExpChangeTrack( GetRoot() ));
 762     }
 763 }
 764
 765 void ExcDocument::Write( SvStream& rSvStrm )
 766 {
 767     if( !maTableList.IsEmpty() )
 768     {
 769         InitializeSave();
 770
 771         XclExpStream aXclStrm( rSvStrm, GetRoot() );
 772
 773         aHeader.Write( aXclStrm );
 774
 775         OSL_ENSURE( maTableList.GetSize() == maBoundsheetList.GetSize(),
 776             "ExcDocument::Write - different number of sheets and BOUNDSHEET records" );
 777
 778         for( size_t nTab = 0, nTabCount = maTableList.GetSize(); nTab < nTabCount; ++nTab )
 779         {
 780             // set current stream position in BOUNDSHEET record
 781             ExcBoundsheetRef xBoundsheet = maBoundsheetList.GetRecord( nTab );
 782             if( xBoundsheet.get() )
 783                 xBoundsheet->SetStreamPos( aXclStrm.GetSvStreamPos() );
 784             // write the table
 785             maTableList.GetRecord( nTab )->Write( aXclStrm );
 786         }
 787
 788         // write the table stream positions into the BOUNDSHEET records
 789         for( size_t nBSheet = 0, nBSheetCount = maBoundsheetList.GetSize(); nBSheet < nBSheetCount; ++nBSheet )
 790             maBoundsheetList.GetRecord( nBSheet )->UpdateStreamPos( aXclStrm );
 791     }
 792     if( m_xExpChangeTrack )
 793         m_xExpChangeTrack->Write();
 794 }
 795
 796 void ExcDocument::WriteXml( XclExpXmlStream& rStrm )
 797 {
 798     SfxObjectShell* pDocShell = GetDocShell();
 799
 800     using namespace ::com::sun::star;
 801     uno::Reference<document::XDocumentPropertiesSupplier> xDPS( pDocShell->GetModel(), uno::UNO_QUERY_THROW );
 802     uno::Reference<document::XDocumentProperties> xDocProps = xDPS->getDocumentProperties();
 803
 804     rStrm.exportDocumentProperties(xDocProps, pDocShell->IsSecurityOptOpenReadOnly());
 805     rStrm.exportCustomFragments();
 806
 807     sax_fastparser::FSHelperPtr& rWorkbook = rStrm.GetCurrentStream();
 808     rWorkbook->startElement( XML_workbook,
 809             XML_xmlns, rStrm.getNamespaceURL(OOX_NS(xls)).toUtf8(),
 810             FSNS(XML_xmlns, XML_r), rStrm.getNamespaceURL(OOX_NS(officeRel)).toUtf8() );
 811     rWorkbook->singleElement( XML_fileVersion,
 812             XML_appName, "Calc"
 813             // OOXTODO: XML_codeName
 814             // OOXTODO: XML_lastEdited
 815             // OOXTODO: XML_lowestEdited
 816             // OOXTODO: XML_rupBuild
 817     );
 818
 819     if( !maTableList.IsEmpty() )
 820     {
 821         InitializeSave();
 822
 823         aHeader.WriteXml( rStrm );
 824
 825         for( size_t nTab = 0, nTabCount = maTableList.GetSize(); nTab < nTabCount; ++nTab )
 826         {
 827             // write the table
 828             maTableList.GetRecord( nTab )->WriteXml( rStrm );
 829         }
 830     }
 831
 832     if( m_xExpChangeTrack )
 833         m_xExpChangeTrack->WriteXml( rStrm );
 834
 835     XclExpXmlPivotCaches& rCaches = GetXmlPivotTableManager().GetCaches();
 836     if (rCaches.HasCaches())
 837         rCaches.SaveXml(rStrm);
 838
 839     const ScCalcConfig& rCalcConfig = GetDoc().GetCalcConfig();
 840     formula::FormulaGrammar::AddressConvention eConv = rCalcConfig.meStringRefAddressSyntax;
 841
 842     // don't save "unspecified" string ref syntax ... query formula grammar
 843     // and save that instead
 844     if( eConv == formula::FormulaGrammar::CONV_UNSPECIFIED)
 845     {
 846         eConv = GetDoc().GetAddressConvention();
 847     }
 848
 849     // write if it has been read|imported or explicitly changed
 850     // or if ref syntax isn't what would be native for our file format
 851     // i.e. ExcelA1 in this case
 852     if ( rCalcConfig.mbHasStringRefSyntax ||
 853          (eConv != formula::FormulaGrammar::CONV_XL_A1) )
 854     {
 855         XclExtLstRef xExtLst( new XclExtLst( GetRoot()  ) );
 856         xExtLst->AddRecord( XclExpExtRef( new XclExpExtCalcPr( GetRoot(), eConv ))  );
 857         xExtLst->SaveXml(rStrm);
 858     }
 859
 860     rWorkbook->endElement( XML_workbook );
 861     rWorkbook.reset();
 862 }
 863
 864 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */