sc/source/filter/excel/xeroot.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 <rtl/random.h>
  21 #include <sfx2/docfile.hxx>
  22 #include <sfx2/request.hxx>
  23 #include <sfx2/frame.hxx>
  24 #include <sfx2/sfxsids.hrc>
  25 #include <unotools/saveopt.hxx>
  26 #include <svl/itemset.hxx>
  27 #include <svl/stritem.hxx>
  28 #include <svl/intitem.hxx>
  29 #include <svl/eitem.hxx>
  30 #include "xecontent.hxx"
  31 #include "xltracer.hxx"
  32 #include "xeescher.hxx"
  33 #include "xeformula.hxx"
  34 #include "xehelper.hxx"
  35 #include "xelink.hxx"
  36 #include "xename.hxx"
  37 #include "xepivot.hxx"
  38 #include "xestyle.hxx"
  39 #include "xeroot.hxx"
  40 #include <xepivotxml.hxx>
  41 #include "xedbdata.hxx"
  42
  43 #include "excrecds.hxx"
  44 #include "tabprotection.hxx"
  45 #include "document.hxx"
  46 #include "scextopt.hxx"
  47
  48 #include "formulabase.hxx"
  49 #include <com/sun/star/sheet/FormulaOpCodeMapEntry.hpp>
  50
  51 using namespace ::com::sun::star;
  52
  53 // Global data ================================================================
  54
  55 XclExpRootData::XclExpRootData( XclBiff eBiff, SfxMedium& rMedium,
  56         tools::SvRef<SotStorage> xRootStrg, ScDocument& rDoc, rtl_TextEncoding eTextEnc ) :
  57     XclRootData( eBiff, rMedium, xRootStrg, rDoc, eTextEnc, true )
  58 {
  59     SvtSaveOptions aSaveOpt;
  60     mbRelUrl = mrMedium.IsRemote() ? aSaveOpt.IsSaveRelINet() : aSaveOpt.IsSaveRelFSys();
  61     maStringBuf = OStringBuffer();
  62 }
  63
  64 XclExpRootData::~XclExpRootData()
  65 {
  66 }
  67
  68 XclExpRoot::XclExpRoot( XclExpRootData& rExpRootData ) :
  69     XclRoot( rExpRootData ),
  70     mrExpData( rExpRootData )
  71 {
  72 }
  73
  74 XclExpTabInfo& XclExpRoot::GetTabInfo() const
  75 {
  76     OSL_ENSURE( mrExpData.mxTabInfo, "XclExpRoot::GetTabInfo - missing object (wrong BIFF?)" );
  77     return *mrExpData.mxTabInfo;
  78 }
  79
  80 XclExpAddressConverter& XclExpRoot::GetAddressConverter() const
  81 {
  82     OSL_ENSURE( mrExpData.mxAddrConv, "XclExpRoot::GetAddressConverter - missing object (wrong BIFF?)" );
  83     return *mrExpData.mxAddrConv;
  84 }
  85
  86 XclExpFormulaCompiler& XclExpRoot::GetFormulaCompiler() const
  87 {
  88     OSL_ENSURE( mrExpData.mxFmlaComp, "XclExpRoot::GetFormulaCompiler - missing object (wrong BIFF?)" );
  89     return *mrExpData.mxFmlaComp;
  90 }
  91
  92 XclExpProgressBar& XclExpRoot::GetProgressBar() const
  93 {
  94     OSL_ENSURE( mrExpData.mxProgress, "XclExpRoot::GetProgressBar - missing object (wrong BIFF?)" );
  95     return *mrExpData.mxProgress;
  96 }
  97
  98 XclExpSst& XclExpRoot::GetSst() const
  99 {
 100     OSL_ENSURE( mrExpData.mxSst, "XclExpRoot::GetSst - missing object (wrong BIFF?)" );
 101     return *mrExpData.mxSst;
 102 }
 103
 104 XclExpPalette& XclExpRoot::GetPalette() const
 105 {
 106     OSL_ENSURE( mrExpData.mxPalette, "XclExpRoot::GetPalette - missing object (wrong BIFF?)" );
 107     return *mrExpData.mxPalette;
 108 }
 109
 110 XclExpFontBuffer& XclExpRoot::GetFontBuffer() const
 111 {
 112     OSL_ENSURE( mrExpData.mxFontBfr, "XclExpRoot::GetFontBuffer - missing object (wrong BIFF?)" );
 113     return *mrExpData.mxFontBfr;
 114 }
 115
 116 XclExpNumFmtBuffer& XclExpRoot::GetNumFmtBuffer() const
 117 {
 118     OSL_ENSURE( mrExpData.mxNumFmtBfr, "XclExpRoot::GetNumFmtBuffer - missing object (wrong BIFF?)" );
 119     return *mrExpData.mxNumFmtBfr;
 120 }
 121
 122 XclExpXFBuffer& XclExpRoot::GetXFBuffer() const
 123 {
 124     OSL_ENSURE( mrExpData.mxXFBfr, "XclExpRoot::GetXFBuffer - missing object (wrong BIFF?)" );
 125     return *mrExpData.mxXFBfr;
 126 }
 127
 128 XclExpLinkManager& XclExpRoot::GetGlobalLinkManager() const
 129 {
 130     OSL_ENSURE( mrExpData.mxGlobLinkMgr, "XclExpRoot::GetGlobalLinkManager - missing object (wrong BIFF?)" );
 131     return *mrExpData.mxGlobLinkMgr;
 132 }
 133
 134 XclExpLinkManager& XclExpRoot::GetLocalLinkManager() const
 135 {
 136     OSL_ENSURE( GetLocalLinkMgrRef(), "XclExpRoot::GetLocalLinkManager - missing object (wrong BIFF?)" );
 137     return *GetLocalLinkMgrRef();
 138 }
 139
 140 XclExpNameManager& XclExpRoot::GetNameManager() const
 141 {
 142     OSL_ENSURE( mrExpData.mxNameMgr, "XclExpRoot::GetNameManager - missing object (wrong BIFF?)" );
 143     return *mrExpData.mxNameMgr;
 144 }
 145
 146 XclExpObjectManager& XclExpRoot::GetObjectManager() const
 147 {
 148     OSL_ENSURE( mrExpData.mxObjMgr, "XclExpRoot::GetObjectManager - missing object (wrong BIFF?)" );
 149     return *mrExpData.mxObjMgr;
 150 }
 151
 152 XclExpFilterManager& XclExpRoot::GetFilterManager() const
 153 {
 154     OSL_ENSURE( mrExpData.mxFilterMgr, "XclExpRoot::GetFilterManager - missing object (wrong BIFF?)" );
 155     return *mrExpData.mxFilterMgr;
 156 }
 157
 158 XclExpDxfs& XclExpRoot::GetDxfs() const
 159 {
 160     OSL_ENSURE( mrExpData.mxDxfs, "XclExpRoot::GetDxfs - missing object ( wrong BIFF?)" );
 161     return *mrExpData.mxDxfs;
 162 }
 163
 164 XclExpPivotTableManager& XclExpRoot::GetPivotTableManager() const
 165 {
 166     OSL_ENSURE( mrExpData.mxPTableMgr, "XclExpRoot::GetPivotTableManager - missing object (wrong BIFF?)" );
 167     return *mrExpData.mxPTableMgr;
 168 }
 169
 170 XclExpXmlPivotTableManager& XclExpRoot::GetXmlPivotTableManager()
 171 {
 172     assert(mrExpData.mxXmlPTableMgr);
 173     return *mrExpData.mxXmlPTableMgr;
 174 }
 175
 176 XclExpTablesManager& XclExpRoot::GetTablesManager()
 177 {
 178     assert(mrExpData.mxTablesMgr);
 179     return *mrExpData.mxTablesMgr;
 180 }
 181
 182 void XclExpRoot::InitializeConvert()
 183 {
 184     mrExpData.mxTabInfo.reset( new XclExpTabInfo( GetRoot() ) );
 185     mrExpData.mxAddrConv.reset( new XclExpAddressConverter( GetRoot() ) );
 186     mrExpData.mxFmlaComp.reset( new XclExpFormulaCompiler( GetRoot() ) );
 187     mrExpData.mxProgress.reset( new XclExpProgressBar( GetRoot() ) );
 188
 189     GetProgressBar().Initialize();
 190 }
 191
 192 void XclExpRoot::InitializeGlobals()
 193 {
 194     SetCurrScTab( SCTAB_GLOBAL );
 195
 196     if( GetBiff() >= EXC_BIFF5 )
 197     {
 198         mrExpData.mxPalette.reset( new XclExpPalette( GetRoot() ) );
 199         mrExpData.mxFontBfr.reset( new XclExpFontBuffer( GetRoot() ) );
 200         mrExpData.mxNumFmtBfr.reset( new XclExpNumFmtBuffer( GetRoot() ) );
 201         mrExpData.mxXFBfr.reset( new XclExpXFBuffer( GetRoot() ) );
 202         mrExpData.mxGlobLinkMgr.reset( new XclExpLinkManager( GetRoot() ) );
 203         mrExpData.mxNameMgr.reset( new XclExpNameManager( GetRoot() ) );
 204     }
 205
 206     if( GetBiff() == EXC_BIFF8 )
 207     {
 208         mrExpData.mxSst.reset( new XclExpSst );
 209         mrExpData.mxObjMgr.reset( new XclExpObjectManager( GetRoot() ) );
 210         mrExpData.mxFilterMgr.reset( new XclExpFilterManager( GetRoot() ) );
 211         mrExpData.mxPTableMgr.reset( new XclExpPivotTableManager( GetRoot() ) );
 212         // BIFF8: only one link manager for all sheets
 213         mrExpData.mxLocLinkMgr = mrExpData.mxGlobLinkMgr;
 214         mrExpData.mxDxfs.reset( new XclExpDxfs( GetRoot() ) );
 215     }
 216
 217     if( GetOutput() == EXC_OUTPUT_XML_2007 )
 218     {
 219         mrExpData.mxXmlPTableMgr.reset(new XclExpXmlPivotTableManager(GetRoot()));
 220         mrExpData.mxTablesMgr.reset(new XclExpTablesManager(GetRoot()));
 221
 222         do
 223         {
 224             ScDocument& rDoc = GetDoc();
 225             // Pass the model factory to OpCodeProvider, not the process
 226             // service factory, otherwise a FormulaOpCodeMapperObj would be
 227             // instantiated instead of a ScFormulaOpCodeMapperObj and the
 228             // ScCompiler virtuals not be called! Which would be the case with
 229             // the current (2013-01-24) rDoc.GetServiceManager()
 230             const SfxObjectShell* pShell = rDoc.GetDocumentShell();
 231             if (!pShell)
 232             {
 233                 SAL_WARN( "sc", "XclExpRoot::InitializeGlobals - no object shell");
 234                 break;
 235             }
 236             uno::Reference< lang::XComponent > xComponent( pShell->GetModel(), uno::UNO_QUERY);
 237             if (!xComponent.is())
 238             {
 239                 SAL_WARN( "sc", "XclExpRoot::InitializeGlobals - no component");
 240                 break;
 241             }
 242             uno::Reference< lang::XMultiServiceFactory > xModelFactory( xComponent, uno::UNO_QUERY);
 243             // OOXML is also BIFF8 function-wise
 244             oox::xls::OpCodeProvider aOpCodeProvider( xModelFactory,
 245                     oox::xls::FILTER_OOXML, oox::xls::BIFF8, false);
 246             // Compiler mocks about non-matching ctor or conversion from
 247             // Sequence<...> to Sequence<const ...> if directly created or passed,
 248             // conversion through Any works around.
 249             uno::Any aAny( aOpCodeProvider.getOoxParserMap());
 250             uno::Sequence< const sheet::FormulaOpCodeMapEntry > aOpCodeMapping;
 251             if (!(aAny >>= aOpCodeMapping))
 252             {
 253                 SAL_WARN( "sc", "XclExpRoot::InitializeGlobals - no OpCodeMap");
 254                 break;
 255             }
 256             ScCompiler aCompiler( &rDoc, ScAddress());
 257             aCompiler.SetGrammar( rDoc.GetGrammar());
 258             mrExpData.mxOpCodeMap = formula::FormulaCompiler::CreateOpCodeMap( aOpCodeMapping, true);
 259         } while(false);
 260     }
 261
 262     GetXFBuffer().Initialize();
 263     GetNameManager().Initialize();
 264 }
 265
 266 void XclExpRoot::InitializeTable( SCTAB nScTab )
 267 {
 268     SetCurrScTab( nScTab );
 269     if( GetBiff() == EXC_BIFF5 )
 270     {
 271         // local link manager per sheet
 272         mrExpData.mxLocLinkMgr.reset( new XclExpLinkManager( GetRoot() ) );
 273     }
 274 }
 275
 276 void XclExpRoot::InitializeSave()
 277 {
 278     GetPalette().Finalize();
 279     GetXFBuffer().Finalize();
 280 }
 281
 282 XclExpRecordRef XclExpRoot::CreateRecord( sal_uInt16 nRecId ) const
 283 {
 284     XclExpRecordRef xRec;
 285     switch( nRecId )
 286     {
 287         case EXC_ID_PALETTE:        xRec = mrExpData.mxPalette;     break;
 288         case EXC_ID_FONTLIST:       xRec = mrExpData.mxFontBfr;     break;
 289         case EXC_ID_FORMATLIST:     xRec = mrExpData.mxNumFmtBfr;   break;
 290         case EXC_ID_XFLIST:         xRec = mrExpData.mxXFBfr;       break;
 291         case EXC_ID_SST:            xRec = mrExpData.mxSst;         break;
 292         case EXC_ID_EXTERNSHEET:    xRec = GetLocalLinkMgrRef();    break;
 293         case EXC_ID_NAME:           xRec = mrExpData.mxNameMgr;     break;
 294         case EXC_ID_DXFS:           xRec = mrExpData.mxDxfs;        break;
 295     }
 296     OSL_ENSURE( xRec, "XclExpRoot::CreateRecord - unknown record ID or missing object" );
 297     return xRec;
 298 }
 299
 300 bool XclExpRoot::IsDocumentEncrypted() const
 301 {
 302     // We need to encrypt the content when the document structure is protected.
 303     const ScDocProtection* pDocProt = GetDoc().GetDocProtection();
 304     if (pDocProt && pDocProt->isProtected() && pDocProt->isOptionEnabled(ScDocProtection::STRUCTURE))
 305         return true;
 306
 307     if ( GetEncryptionData().getLength() > 0 )
 308         // Password is entered directly into the save dialog.
 309         return true;
 310
 311     return false;
 312 }
 313
 314 uno::Sequence< beans::NamedValue > XclExpRoot::GenerateEncryptionData( const OUString& aPass )
 315 {
 316     uno::Sequence< beans::NamedValue > aEncryptionData;
 317
 318     if ( !aPass.isEmpty() && aPass.getLength() < 16 )
 319     {
 320         TimeValue aTime;
 321         osl_getSystemTime( &aTime );
 322         rtlRandomPool aRandomPool = rtl_random_createPool ();
 323         rtl_random_addBytes ( aRandomPool, &aTime, 8 );
 324
 325         sal_uInt8 pnDocId[16];
 326         rtl_random_getBytes( aRandomPool, pnDocId, 16 );
 327
 328         rtl_random_destroyPool( aRandomPool );
 329
 330         sal_uInt16 pnPasswd[16];
 331         memset( pnPasswd, 0, sizeof( pnPasswd ) );
 332         for( sal_Int32 nChar = 0; nChar < aPass.getLength(); ++nChar )
 333             pnPasswd[nChar] = aPass[nChar];
 334
 335         ::msfilter::MSCodec_Std97 aCodec;
 336         aCodec.InitKey( pnPasswd, pnDocId );
 337         aEncryptionData = aCodec.GetEncryptionData();
 338     }
 339
 340     return aEncryptionData;
 341 }
 342
 343 uno::Sequence< beans::NamedValue > XclExpRoot::GetEncryptionData() const
 344 {
 345     uno::Sequence< beans::NamedValue > aEncryptionData;
 346     const SfxUnoAnyItem* pEncryptionDataItem = SfxItemSet::GetItem<SfxUnoAnyItem>(GetMedium().GetItemSet(), SID_ENCRYPTIONDATA, false);
 347     if ( pEncryptionDataItem )
 348         pEncryptionDataItem->GetValue() >>= aEncryptionData;
 349     else
 350     {
 351         // try to get the encryption data from the password
 352         const SfxStringItem* pPasswordItem = SfxItemSet::GetItem<SfxStringItem>(GetMedium().GetItemSet(), SID_PASSWORD, false);
 353         if ( pPasswordItem && !pPasswordItem->GetValue().isEmpty() )
 354             aEncryptionData = GenerateEncryptionData( pPasswordItem->GetValue() );
 355     }
 356
 357     return aEncryptionData;
 358 }
 359
 360 uno::Sequence< beans::NamedValue > XclExpRoot::GenerateDefaultEncryptionData() const
 361 {
 362     uno::Sequence< beans::NamedValue > aEncryptionData;
 363     if ( !GetDefaultPassword().isEmpty() )
 364         aEncryptionData = GenerateEncryptionData( GetDefaultPassword() );
 365
 366     return aEncryptionData;
 367 }
 368
 369 XclExpRootData::XclExpLinkMgrRef XclExpRoot::GetLocalLinkMgrRef() const
 370 {
 371     return IsInGlobals() ? mrExpData.mxGlobLinkMgr : mrExpData.mxLocLinkMgr;
 372 }
 373
 374 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */