oox/source/xls/workbooksettings.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: workbooksettings.cxx,v $
  10  * $Revision: 1.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 #include "oox/xls/workbooksettings.hxx"
  32 #include <com/sun/star/util/Date.hpp>
  33 #include <com/sun/star/util/XNumberFormatsSupplier.hpp>
  34 #include <com/sun/star/sheet/XCalculatable.hpp>
  35 #include <comphelper/mediadescriptor.hxx>
  36 #include "properties.hxx"
  37 #include "oox/helper/attributelist.hxx"
  38 #include "oox/helper/propertyset.hxx"
  39 #include "oox/helper/recordinputstream.hxx"
  40 #include "oox/core/filterbase.hxx"
  41 #include "oox/xls/biffinputstream.hxx"
  42 #include "oox/xls/unitconverter.hxx"
  43
  44 using ::rtl::OUString;
  45 using ::com::sun::star::uno::Reference;
  46 using ::com::sun::star::uno::UNO_QUERY;
  47 using ::com::sun::star::util::Date;
  48 using ::com::sun::star::util::XNumberFormatsSupplier;
  49 using ::com::sun::star::sheet::XCalculatable;
  50 using ::oox::core::CodecHelper;
  51
  52 namespace oox {
  53 namespace xls {
  54
  55 // ============================================================================
  56
  57 namespace {
  58
  59 const sal_uInt32 OOBIN_WORKBOOKPR_DATE1904  = 0x00000001;
  60 const sal_uInt32 OOBIN_WORKBOOKPR_STRIPEXT  = 0x00000080;
  61
  62 const sal_uInt16 OOBIN_CALCPR_A1            = 0x0002;
  63 const sal_uInt16 OOBIN_CALCPR_ITERATE       = 0x0004;
  64 const sal_uInt16 OOBIN_CALCPR_FULLPRECISION = 0x0008;
  65 const sal_uInt16 OOBIN_CALCPR_CALCCOMPLETED = 0x0010;
  66 const sal_uInt16 OOBIN_CALCPR_CALCONSAVE    = 0x0020;
  67 const sal_uInt16 OOBIN_CALCPR_CONCURRENT    = 0x0040;
  68 const sal_uInt16 OOBIN_CALCPR_MANUALPROC    = 0x0080;
  69
  70 // no predefined constants for show objects mode
  71 const sal_Int16 API_SHOWMODE_SHOW               = 0;        /// Show drawing objects.
  72 const sal_Int16 API_SHOWMODE_HIDE               = 1;        /// Hide drawing objects.
  73 const sal_Int16 API_SHOWMODE_PLACEHOLDER        = 2;        /// Show placeholders for drawing objects.
  74
  75 } // namespace
  76
  77 // ============================================================================
  78
  79 FileSharingModel::FileSharingModel() :
  80     mnPasswordHash( 0 ),
  81     mbRecommendReadOnly( false )
  82 {
  83 }
  84
  85 // ============================================================================
  86
  87 WorkbookSettingsModel::WorkbookSettingsModel() :
  88     mnShowObjectMode( XML_all ),
  89     mnUpdateLinksMode( XML_userSet ),
  90     mnDefaultThemeVer( -1 ),
  91     mbDateMode1904( false ),
  92     mbSaveExtLinkValues( true )
  93 {
  94 }
  95
  96 void WorkbookSettingsModel::setBinObjectMode( sal_uInt16 nObjMode )
  97 {
  98     static const sal_Int32 spnObjModes[] = { XML_all, XML_placeholders, XML_none };
  99     mnShowObjectMode = STATIC_ARRAY_SELECT( spnObjModes, nObjMode, XML_all );
 100 }
 101
 102 // ============================================================================
 103
 104 CalcSettingsModel::CalcSettingsModel() :
 105     mfIterateDelta( 0.001 ),
 106     mnCalcId( -1 ),
 107     mnRefMode( XML_A1 ),
 108     mnCalcMode( XML_auto ),
 109     mnIterateCount( 100 ),
 110     mnProcCount( -1 ),
 111     mbCalcOnSave( true ),
 112     mbCalcCompleted( true ),
 113     mbFullPrecision( true ),
 114     mbIterate( false ),
 115     mbConcurrent( true ),
 116     mbUseNlr( false )
 117 {
 118 }
 119
 120 // ============================================================================
 121
 122 WorkbookSettings::WorkbookSettings( const WorkbookHelper& rHelper ) :
 123     WorkbookHelper( rHelper )
 124 {
 125 }
 126
 127 void WorkbookSettings::importFileSharing( const AttributeList& rAttribs )
 128 {
 129     maFileSharing.maUserName          = rAttribs.getXString( XML_userName, OUString() );
 130     maFileSharing.mnPasswordHash      = CodecHelper::getPasswordHash( rAttribs, XML_reservationPassword );
 131     maFileSharing.mbRecommendReadOnly = rAttribs.getBool( XML_readOnlyRecommended, false );
 132 }
 133
 134 void WorkbookSettings::importWorkbookPr( const AttributeList& rAttribs )
 135 {
 136     maBookSettings.maCodeName          = rAttribs.getString( XML_codePage, OUString() );
 137     maBookSettings.mnShowObjectMode    = rAttribs.getToken( XML_showObjects, XML_all );
 138     maBookSettings.mnUpdateLinksMode   = rAttribs.getToken( XML_updateLinks, XML_userSet );
 139     maBookSettings.mnDefaultThemeVer   = rAttribs.getInteger( XML_defaultThemeVersion, -1 );
 140     maBookSettings.mbSaveExtLinkValues = rAttribs.getBool( XML_saveExternalLinkValues, true );
 141     setDateMode( rAttribs.getBool( XML_date1904, false ) );
 142 }
 143
 144 void WorkbookSettings::importCalcPr( const AttributeList& rAttribs )
 145 {
 146     maCalcSettings.mfIterateDelta  = rAttribs.getDouble( XML_iterateDelta, 0.0001 );
 147     maCalcSettings.mnCalcId        = rAttribs.getInteger( XML_calcId, -1 );
 148     maCalcSettings.mnRefMode       = rAttribs.getToken( XML_refMode, XML_A1 );
 149     maCalcSettings.mnCalcMode      = rAttribs.getToken( XML_calcMode, XML_auto );
 150     maCalcSettings.mnIterateCount  = rAttribs.getInteger( XML_iterateCount, 100 );
 151     maCalcSettings.mnProcCount     = rAttribs.getInteger( XML_concurrentManualCount, -1 );
 152     maCalcSettings.mbCalcOnSave    = rAttribs.getBool( XML_calcOnSave, true );
 153     maCalcSettings.mbCalcCompleted = rAttribs.getBool( XML_calcCompleted, true );
 154     maCalcSettings.mbFullPrecision = rAttribs.getBool( XML_fullPrecision, true );
 155     maCalcSettings.mbIterate       = rAttribs.getBool( XML_iterate, false );
 156     maCalcSettings.mbConcurrent    = rAttribs.getBool( XML_concurrentCalc, true );
 157 }
 158
 159 void WorkbookSettings::importFileSharing( RecordInputStream& rStrm )
 160 {
 161     maFileSharing.mbRecommendReadOnly = rStrm.readuInt16() != 0;
 162     rStrm >> maFileSharing.mnPasswordHash >> maFileSharing.maUserName;
 163 }
 164
 165 void WorkbookSettings::importWorkbookPr( RecordInputStream& rStrm )
 166 {
 167     sal_uInt32 nFlags;
 168     rStrm >> nFlags >> maBookSettings.mnDefaultThemeVer >> maBookSettings.maCodeName;
 169     maBookSettings.setBinObjectMode( extractValue< sal_uInt16 >( nFlags, 13, 2 ) );
 170     // set flag means: strip external link values
 171     maBookSettings.mbSaveExtLinkValues = !getFlag( nFlags, OOBIN_WORKBOOKPR_STRIPEXT );
 172     setDateMode( getFlag( nFlags, OOBIN_WORKBOOKPR_DATE1904 ) );
 173 }
 174
 175 void WorkbookSettings::importCalcPr( RecordInputStream& rStrm )
 176 {
 177     sal_Int32 nCalcMode, nProcCount;
 178     sal_uInt16 nFlags;
 179     rStrm >> maCalcSettings.mnCalcId >> nCalcMode >> maCalcSettings.mnIterateCount >> maCalcSettings.mfIterateDelta >> nProcCount >> nFlags;
 180
 181     static const sal_Int32 spnCalcModes[] = { XML_manual, XML_auto, XML_autoNoTable };
 182     maCalcSettings.mnRefMode       = getFlagValue( nFlags, OOBIN_CALCPR_A1, XML_A1, XML_R1C1 );
 183     maCalcSettings.mnCalcMode      = STATIC_ARRAY_SELECT( spnCalcModes, nCalcMode, XML_auto );
 184     maCalcSettings.mnProcCount     = getFlagValue< sal_Int32 >( nFlags, OOBIN_CALCPR_MANUALPROC, nProcCount, -1 );
 185     maCalcSettings.mbCalcOnSave    = getFlag( nFlags, OOBIN_CALCPR_CALCONSAVE );
 186     maCalcSettings.mbCalcCompleted = getFlag( nFlags, OOBIN_CALCPR_CALCCOMPLETED );
 187     maCalcSettings.mbFullPrecision = getFlag( nFlags, OOBIN_CALCPR_FULLPRECISION );
 188     maCalcSettings.mbIterate       = getFlag( nFlags, OOBIN_CALCPR_ITERATE );
 189     maCalcSettings.mbConcurrent    = getFlag( nFlags, OOBIN_CALCPR_CONCURRENT );
 190 }
 191
 192 void WorkbookSettings::setSaveExtLinkValues( bool bSaveExtLinks )
 193 {
 194     maBookSettings.mbSaveExtLinkValues = bSaveExtLinks;
 195 }
 196
 197 void WorkbookSettings::importFileSharing( BiffInputStream& rStrm )
 198 {
 199     maFileSharing.mbRecommendReadOnly = rStrm.readuInt16() != 0;
 200     rStrm >> maFileSharing.mnPasswordHash;
 201     if( getBiff() == BIFF8 )
 202     {
 203         sal_uInt16 nStrLen = rStrm.readuInt16();
 204         // there is no string flags field if string is empty
 205         if( nStrLen > 0 )
 206             maFileSharing.maUserName = rStrm.readUniStringBody( nStrLen );
 207     }
 208     else
 209     {
 210         maFileSharing.maUserName = rStrm.readByteStringUC( false, getTextEncoding() );
 211     }
 212 }
 213
 214 void WorkbookSettings::importBookBool( BiffInputStream& rStrm )
 215 {
 216     // value of 0 means save external values, value of 1 means strip external values
 217     maBookSettings.mbSaveExtLinkValues = rStrm.readuInt16() == 0;
 218 }
 219
 220 void WorkbookSettings::importCalcCount( BiffInputStream& rStrm )
 221 {
 222     maCalcSettings.mnIterateCount = rStrm.readuInt16();
 223 }
 224
 225 void WorkbookSettings::importCalcMode( BiffInputStream& rStrm )
 226 {
 227     sal_Int16 nCalcMode = rStrm.readInt16() + 1;
 228     static const sal_Int32 spnCalcModes[] = { XML_autoNoTable, XML_manual, XML_auto };
 229     maCalcSettings.mnCalcMode = STATIC_ARRAY_SELECT( spnCalcModes, nCalcMode, XML_auto );
 230 }
 231
 232 void WorkbookSettings::importCodeName( BiffInputStream& rStrm )
 233 {
 234     maBookSettings.maCodeName = rStrm.readUniString();
 235 }
 236
 237 void WorkbookSettings::importDateMode( BiffInputStream& rStrm )
 238 {
 239     setDateMode( rStrm.readuInt16() != 0 );
 240 }
 241
 242 void WorkbookSettings::importDelta( BiffInputStream& rStrm )
 243 {
 244     rStrm >> maCalcSettings.mfIterateDelta;
 245 }
 246
 247 void WorkbookSettings::importHideObj( BiffInputStream& rStrm )
 248 {
 249     maBookSettings.setBinObjectMode( rStrm.readuInt16() );
 250 }
 251
 252 void WorkbookSettings::importIteration( BiffInputStream& rStrm )
 253 {
 254     maCalcSettings.mbIterate = rStrm.readuInt16() != 0;
 255 }
 256
 257 void WorkbookSettings::importPrecision( BiffInputStream& rStrm )
 258 {
 259     maCalcSettings.mbFullPrecision = rStrm.readuInt16() != 0;
 260 }
 261
 262 void WorkbookSettings::importRefMode( BiffInputStream& rStrm )
 263 {
 264     maCalcSettings.mnRefMode = (rStrm.readuInt16() == 0) ? XML_R1C1 : XML_A1;
 265 }
 266
 267 void WorkbookSettings::importSaveRecalc( BiffInputStream& rStrm )
 268 {
 269     maCalcSettings.mbCalcOnSave = rStrm.readuInt16() != 0;
 270 }
 271
 272 void WorkbookSettings::importUncalced( BiffInputStream& )
 273 {
 274     // existence of this record indicates incomplete recalc
 275     maCalcSettings.mbCalcCompleted = false;
 276 }
 277
 278 void WorkbookSettings::importUsesElfs( BiffInputStream& rStrm )
 279 {
 280     maCalcSettings.mbUseNlr = rStrm.readuInt16() != 0;
 281 }
 282
 283 void WorkbookSettings::finalizeImport()
 284 {
 285     // default settings
 286     PropertySet aPropSet( getDocument() );
 287     switch( getFilterType() )
 288     {
 289         case FILTER_OOX:
 290         case FILTER_BIFF:
 291             aPropSet.setProperty( PROP_IgnoreCase,          true );     // always in Excel
 292             aPropSet.setProperty( PROP_RegularExpressions,  false );    // not supported in Excel
 293         break;
 294         case FILTER_UNKNOWN:
 295         break;
 296     }
 297
 298     // write protection
 299     if( maFileSharing.mbRecommendReadOnly || (maFileSharing.mnPasswordHash != 0) )
 300         getBaseFilter().getMediaDescriptor()[ CREATE_OUSTRING( "ReadOnly" ) ] <<= true;
 301
 302     // calculation settings
 303     Date aNullDate = getNullDate();
 304
 305     aPropSet.setProperty( PROP_NullDate,           aNullDate );
 306     aPropSet.setProperty( PROP_IsIterationEnabled, maCalcSettings.mbIterate );
 307     aPropSet.setProperty( PROP_IterationCount,     maCalcSettings.mnIterateCount );
 308     aPropSet.setProperty( PROP_IterationEpsilon,   maCalcSettings.mfIterateDelta );
 309     aPropSet.setProperty( PROP_CalcAsShown,        !maCalcSettings.mbFullPrecision );
 310     aPropSet.setProperty( PROP_LookUpLabels,       maCalcSettings.mbUseNlr );
 311
 312     Reference< XNumberFormatsSupplier > xNumFmtsSupp( getDocument(), UNO_QUERY );
 313     if( xNumFmtsSupp.is() )
 314     {
 315         PropertySet aNumFmtProp( xNumFmtsSupp->getNumberFormatSettings() );
 316         aNumFmtProp.setProperty( PROP_NullDate, aNullDate );
 317     }
 318
 319     Reference< XCalculatable > xCalculatable( getDocument(), UNO_QUERY );
 320     if( xCalculatable.is() )
 321         xCalculatable->enableAutomaticCalculation( (maCalcSettings.mnCalcMode == XML_auto) || (maCalcSettings.mnCalcMode == XML_autoNoTable) );
 322 }
 323
 324 sal_Int16 WorkbookSettings::getApiShowObjectMode() const
 325 {
 326     switch( maBookSettings.mnShowObjectMode )
 327     {
 328         case XML_all:           return API_SHOWMODE_SHOW;
 329         case XML_none:          return API_SHOWMODE_HIDE;
 330         // #i80528# placeholders not supported anymore, but this is handled internally in Calc
 331         case XML_placeholders:  return API_SHOWMODE_PLACEHOLDER;
 332     }
 333     return API_SHOWMODE_SHOW;
 334 }
 335
 336 Date WorkbookSettings::getNullDate() const
 337 {
 338     static const Date saDate1900( 30, 12, 1899 ), saDate1904( 1, 1, 1904 );
 339     return maBookSettings.mbDateMode1904 ? saDate1904 : saDate1900;
 340 }
 341
 342 void WorkbookSettings::setDateMode( bool bDateMode1904 )
 343 {
 344     maBookSettings.mbDateMode1904 = bDateMode1904;
 345     getUnitConverter().finalizeNullDate( getNullDate() );
 346 }
 347
 348 // ============================================================================
 349
 350 } // namespace xls
 351 } // namespace oox
 352