svtools/source/filter.vcl/filter/FilterConfigItem.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: FilterConfigItem.cxx,v $
  10  * $Revision: 1.17 $
  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_svtools.hxx"
  33 #include <svtools/FilterConfigItem.hxx>
  34
  35 #include <tools/debug.hxx>
  36 #include <unotools/configmgr.hxx>
  37 #include <unotools/processfactory.hxx>
  38 #include <com/sun/star/beans/PropertyValue.hpp>
  39 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  40 #include <com/sun/star/util/XChangesBatch.hpp>
  41 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  42 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  43
  44 using namespace ::rtl;
  45 using namespace ::utl                                           ;       // getProcessServiceFactory
  46 using namespace ::com::sun::star::lang          ;       // XMultiServiceFactory
  47 using namespace ::com::sun::star::beans         ;       // PropertyValue
  48 using namespace ::com::sun::star::uno           ;       // Reference
  49 using namespace ::com::sun::star::util          ;       // XChangesBatch
  50 using namespace ::com::sun::star::awt           ;       // Size
  51 using namespace ::com::sun::star::container ;   //
  52 using namespace ::com::sun::star::task          ;       // XStatusIndicator
  53
  54 static sal_Bool ImpIsTreeAvailable( Reference< XMultiServiceFactory >& rXCfgProv, const String& rTree )
  55 {
  56     sal_Bool    bAvailable = rTree.Len() != 0;
  57     if ( bAvailable )
  58     {
  59         xub_StrLen      nTokenCount = rTree.GetTokenCount( (sal_Unicode)'/' );
  60         xub_StrLen      i = 0;
  61
  62         if ( rTree.GetChar( 0 ) == (sal_Unicode)'/' )
  63             i++;
  64         if ( rTree.GetChar( rTree.Len() - 1 ) == (sal_Unicode)'/' )
  65             nTokenCount--;
  66
  67         Any aAny;
  68         aAny <<= (OUString)rTree.GetToken( i++, (sal_Unicode)'/' );
  69
  70         // creation arguments: nodepath
  71         PropertyValue aPathArgument;
  72         aPathArgument.Name = OUString( RTL_CONSTASCII_USTRINGPARAM( "nodepath" ) );
  73         aPathArgument.Value = aAny;
  74
  75         Sequence< Any > aArguments( 1 );
  76         aArguments[ 0 ] <<= aPathArgument;
  77
  78         Reference< XInterface > xReadAccess;
  79         try
  80         {
  81             xReadAccess = rXCfgProv->createInstanceWithArguments(
  82                 OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.configuration.ConfigurationAccess" ) ),
  83                     aArguments );
  84         }
  85         catch ( ::com::sun::star::uno::Exception& )
  86         {
  87             bAvailable = sal_False;
  88         }
  89         if ( xReadAccess.is() )
  90         {
  91             for ( ; bAvailable && ( i < nTokenCount ); i++ )
  92             {
  93                 Reference< XHierarchicalNameAccess > xHierarchicalNameAccess
  94                     ( xReadAccess, UNO_QUERY );
  95
  96                 if ( !xHierarchicalNameAccess.is() )
  97                     bAvailable = sal_False;
  98                 else
  99                 {
 100                     String aNode( rTree.GetToken( i, (sal_Unicode)'/' ) );
 101                     if ( !xHierarchicalNameAccess->hasByHierarchicalName( aNode ) )
 102                         bAvailable = sal_False;
 103                     else
 104                     {
 105                         Any a( xHierarchicalNameAccess->getByHierarchicalName( aNode ) );
 106                         try
 107                         {
 108                             a >>= xReadAccess;
 109                         }
 110                         catch ( ::com::sun::star::uno::Exception& )
 111                         {
 112                             bAvailable = sal_False;
 113                         }
 114                     }
 115                 }
 116             }
 117         }
 118     }
 119     return bAvailable;
 120 }
 121
 122 void FilterConfigItem::ImpInitTree( const String& rSubTree )
 123 {
 124     bModified = sal_False;
 125
 126     OUString sTree( ConfigManager::GetConfigBaseURL() );
 127     sTree += rSubTree;
 128     Reference< XMultiServiceFactory > xSMGR = getProcessServiceFactory();       // get global uno service manager
 129
 130     Reference< XMultiServiceFactory > xCfgProv(
 131         xSMGR->createInstance( OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.configuration.ConfigurationProvider" ) ) ),
 132             UNO_QUERY );
 133
 134     if ( xCfgProv.is() )
 135     {
 136         if ( ImpIsTreeAvailable( xCfgProv, String( sTree ) ) )
 137         {
 138             Any aAny;
 139             // creation arguments: nodepath
 140             PropertyValue aPathArgument;
 141             aAny <<= sTree;
 142             aPathArgument.Name = OUString( RTL_CONSTASCII_USTRINGPARAM( "nodepath" ) );
 143             aPathArgument.Value = aAny;
 144
 145             // creation arguments: commit mode
 146             PropertyValue aModeArgument;
 147             sal_Bool bAsyncron = sal_True;
 148             aAny <<= bAsyncron;
 149             aModeArgument.Name = OUString( RTL_CONSTASCII_USTRINGPARAM( "lazywrite" ) );
 150             aModeArgument.Value = aAny;
 151
 152             Sequence< Any > aArguments( 2 );
 153             aArguments[ 0 ] <<= aPathArgument;
 154             aArguments[ 1 ] <<= aModeArgument;
 155
 156             try
 157             {
 158                 xUpdatableView = xCfgProv->createInstanceWithArguments(
 159                     OUString( RTL_CONSTASCII_USTRINGPARAM( "com.sun.star.configuration.ConfigurationUpdateAccess" ) ),
 160                         aArguments );
 161                 if ( xUpdatableView.is() )
 162                     xPropSet = Reference< XPropertySet >( xUpdatableView, UNO_QUERY );
 163             }
 164             catch ( ::com::sun::star::uno::Exception& )
 165             {
 166                 DBG_ERROR( "FilterConfigItem::FilterConfigItem - Could not access configuration Key" );
 167             }
 168         }
 169     }
 170 }
 171
 172 FilterConfigItem::FilterConfigItem( const OUString& rSubTree )
 173 {
 174     ImpInitTree( rSubTree );
 175 }
 176
 177 FilterConfigItem::FilterConfigItem( ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >* pFilterData )
 178 {
 179     if ( pFilterData )
 180         aFilterData = *pFilterData;
 181 }
 182
 183 FilterConfigItem::FilterConfigItem( const OUString& rSubTree,
 184     ::com::sun::star::uno::Sequence< ::com::sun::star::beans::PropertyValue >* pFilterData )
 185 {
 186     ImpInitTree( rSubTree );
 187
 188     if ( pFilterData )
 189         aFilterData = *pFilterData;
 190 };
 191
 192 FilterConfigItem::~FilterConfigItem()
 193 {
 194     if ( xUpdatableView.is() )
 195     {
 196         if ( xPropSet.is() && bModified )
 197         {
 198             Reference< XChangesBatch > xUpdateControl( xUpdatableView, UNO_QUERY );
 199             if ( xUpdateControl.is() )
 200             {
 201                 try
 202                 {
 203                     xUpdateControl->commitChanges();
 204                 }
 205                 catch ( ::com::sun::star::uno::Exception& )
 206                 {
 207                     DBG_ERROR( "FilterConfigItem::FilterConfigItem - Could not update configuration data" );
 208                 }
 209             }
 210         }
 211     }
 212 }
 213
 214 sal_Bool FilterConfigItem::ImplGetPropertyValue( Any& rAny, const Reference< XPropertySet >& rXPropSet, const OUString& rString, sal_Bool bTestPropertyAvailability )
 215 {
 216     sal_Bool bRetValue = sal_True;
 217
 218     if ( rXPropSet.is() )
 219     {
 220         if ( bTestPropertyAvailability )
 221         {
 222             bRetValue = sal_False;
 223             try
 224             {
 225                 Reference< XPropertySetInfo >
 226                     aXPropSetInfo( rXPropSet->getPropertySetInfo() );
 227                 if ( aXPropSetInfo.is() )
 228                     bRetValue = aXPropSetInfo->hasPropertyByName( rString );
 229             }
 230             catch( ::com::sun::star::uno::Exception& )
 231             {
 232                 //
 233             }
 234         }
 235         if ( bRetValue )
 236         {
 237             try
 238             {
 239                 rAny = rXPropSet->getPropertyValue( rString );
 240                 if ( !rAny.hasValue() )
 241                     bRetValue = sal_False;
 242             }
 243             catch( ::com::sun::star::uno::Exception& )
 244             {
 245                 bRetValue = sal_False;
 246             }
 247         }
 248     }
 249     else
 250         bRetValue = sal_False;
 251     return bRetValue;
 252 }
 253
 254
 255 // if property is available it returns a pointer,
 256 // otherwise the result is null
 257 PropertyValue* FilterConfigItem::GetPropertyValue( Sequence< PropertyValue >& rPropSeq, const OUString& rName )
 258 {
 259     PropertyValue* pPropValue = NULL;
 260
 261     sal_Int32 i, nCount;
 262     for ( i = 0, nCount = rPropSeq.getLength(); i < nCount; i++ )
 263     {
 264         if ( rPropSeq[ i ].Name == rName )
 265         {
 266             pPropValue = &rPropSeq[ i ];
 267             break;
 268         }
 269     }
 270     return pPropValue;
 271 }
 272
 273 /* if PropertySequence already includes a PropertyValue using the same name, the
 274     corresponding PropertyValue is replaced, otherwise the given PropertyValue
 275     will be appended */
 276
 277 sal_Bool FilterConfigItem::WritePropertyValue( Sequence< PropertyValue >& rPropSeq, const PropertyValue& rPropValue )
 278 {
 279     sal_Bool bRet = sal_False;
 280     if ( rPropValue.Name.getLength() )
 281     {
 282         sal_Int32 i, nCount;
 283         for ( i = 0, nCount = rPropSeq.getLength(); i < nCount; i++ )
 284         {
 285             if ( rPropSeq[ i ].Name == rPropValue.Name )
 286                 break;
 287         }
 288         if ( i == nCount )
 289             rPropSeq.realloc( ++nCount );
 290
 291         rPropSeq[ i ] = rPropValue;
 292
 293         bRet = sal_True;
 294     }
 295     return bRet;
 296 }
 297
 298 sal_Bool FilterConfigItem::ReadBool( const OUString& rKey, sal_Bool bDefault )
 299 {
 300     Any aAny;
 301     sal_Bool bRetValue = bDefault;
 302     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 303     if ( pPropVal )
 304     {
 305         pPropVal->Value >>= bRetValue;
 306     }
 307     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 308     {
 309         aAny >>= bRetValue;
 310     }
 311     PropertyValue aBool;
 312     aBool.Name = rKey;
 313     aBool.Value <<= bRetValue;
 314     WritePropertyValue( aFilterData, aBool );
 315     return bRetValue;
 316 }
 317
 318 sal_Int32 FilterConfigItem::ReadInt32( const OUString& rKey, sal_Int32 nDefault )
 319 {
 320     Any aAny;
 321     sal_Int32 nRetValue = nDefault;
 322     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 323     if ( pPropVal )
 324     {
 325         pPropVal->Value >>= nRetValue;
 326     }
 327     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 328     {
 329         aAny >>= nRetValue;
 330     }
 331     PropertyValue aInt32;
 332     aInt32.Name = rKey;
 333     aInt32.Value <<= nRetValue;
 334     WritePropertyValue( aFilterData, aInt32 );
 335     return nRetValue;
 336 }
 337
 338
 339 Size FilterConfigItem::ReadSize( const OUString& rKey, const Size& rDefault )
 340 {
 341     Any aAny;
 342     Size aRetValue( rDefault );
 343
 344     const OUString sWidth( RTL_CONSTASCII_USTRINGPARAM( "LogicalWidth" ) );
 345     const OUString sHeight( RTL_CONSTASCII_USTRINGPARAM( "LogicalHeight" ) );
 346
 347     Reference< XPropertySet > aXPropSet;
 348     try
 349     {
 350         PropertyValue* pPropWidth = GetPropertyValue( aFilterData, sWidth  );
 351         PropertyValue* pPropHeight= GetPropertyValue( aFilterData, sHeight );
 352         if ( pPropWidth && pPropHeight )
 353         {
 354             pPropWidth->Value >>= aRetValue.Width;
 355             pPropHeight->Value >>= aRetValue.Height;
 356         }
 357         else if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 358         {
 359             if ( aAny >>= aXPropSet )
 360             {
 361                 if ( ImplGetPropertyValue( aAny, aXPropSet, sWidth, sal_True ) )
 362                     aAny >>= aRetValue.Width;
 363                 if ( ImplGetPropertyValue( aAny, aXPropSet, sHeight, sal_True ) )
 364                     aAny >>= aRetValue.Height;
 365             }
 366         }
 367     }
 368     catch ( ::com::sun::star::uno::Exception& )
 369     {
 370         DBG_ERROR( "FilterConfigItem::ReadSize - could not read PropertyValue" );
 371     }
 372     PropertyValue aWidth;
 373     aWidth.Name = sWidth;
 374     aWidth.Value <<= aRetValue.Width;
 375     WritePropertyValue( aFilterData, aWidth );
 376     PropertyValue aHeight;
 377     aHeight.Name = sHeight;
 378     aHeight.Value <<= aRetValue.Height;
 379     WritePropertyValue( aFilterData, aHeight );
 380     return aRetValue;
 381 }
 382
 383 OUString FilterConfigItem::ReadString( const OUString& rKey, const OUString& rDefault )
 384 {
 385     Any aAny;
 386     OUString aRetValue( rDefault );
 387     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 388     if ( pPropVal )
 389     {
 390         pPropVal->Value >>= aRetValue;
 391     }
 392     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 393     {
 394         aAny >>= aRetValue;
 395     }
 396     PropertyValue aString;
 397     aString.Name = rKey;
 398     aString.Value <<= aRetValue;
 399     WritePropertyValue( aFilterData, aString );
 400     return aRetValue;
 401 }
 402
 403 Any FilterConfigItem::ReadAny( const ::rtl::OUString& rKey, const Any& rDefault )
 404 {
 405     Any aAny, aRetValue( rDefault );
 406     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 407     if ( pPropVal )
 408     {
 409         aRetValue = pPropVal->Value;
 410     }
 411     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 412     {
 413         aRetValue = aAny;
 414     }
 415     PropertyValue aPropValue;
 416     aPropValue.Name = rKey;
 417     aPropValue.Value = aRetValue;
 418     WritePropertyValue( aFilterData, aPropValue );
 419     return aRetValue;
 420 }
 421
 422 void FilterConfigItem::WriteBool( const OUString& rKey, sal_Bool bNewValue )
 423 {
 424     PropertyValue aBool;
 425     aBool.Name = rKey;
 426     aBool.Value <<= bNewValue;
 427     WritePropertyValue( aFilterData, aBool );
 428
 429     if ( xPropSet.is() )
 430     {
 431         Any aAny;
 432         if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 433         {
 434             sal_Bool bOldValue;
 435             if ( aAny >>= bOldValue )
 436             {
 437                 if ( bOldValue != bNewValue )
 438                 {
 439                     aAny <<= bNewValue;
 440                     try
 441                     {
 442                         xPropSet->setPropertyValue( rKey, aAny );
 443                         bModified = sal_True;
 444                     }
 445                     catch ( ::com::sun::star::uno::Exception& )
 446                     {
 447                         DBG_ERROR( "FilterConfigItem::WriteBool - could not set PropertyValue" );
 448                     }
 449                 }
 450             }
 451         }
 452     }
 453 }
 454
 455 void FilterConfigItem::WriteInt32( const OUString& rKey, sal_Int32 nNewValue )
 456 {
 457     PropertyValue aInt32;
 458     aInt32.Name = rKey;
 459     aInt32.Value <<= nNewValue;
 460     WritePropertyValue( aFilterData, aInt32 );
 461
 462     if ( xPropSet.is() )
 463     {
 464         Any aAny;
 465
 466         if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 467         {
 468             sal_Int32 nOldValue;
 469             if ( aAny >>= nOldValue )
 470             {
 471                 if ( nOldValue != nNewValue )
 472                 {
 473                     aAny <<= nNewValue;
 474                     try
 475                     {
 476                         xPropSet->setPropertyValue( rKey, aAny );
 477                         bModified = sal_True;
 478                     }
 479                     catch ( ::com::sun::star::uno::Exception& )
 480                     {
 481                         DBG_ERROR( "FilterConfigItem::WriteInt32 - could not set PropertyValue" );
 482                     }
 483                 }
 484             }
 485         }
 486     }
 487 }
 488
 489 void FilterConfigItem::WriteSize( const OUString& rKey, const Size& rNewValue )
 490 {
 491     const OUString sWidth( RTL_CONSTASCII_USTRINGPARAM( "LogicalWidth" ) );
 492     const OUString sHeight( RTL_CONSTASCII_USTRINGPARAM( "LogicalHeight" ) );
 493
 494     PropertyValue aWidth;
 495     aWidth.Name = sWidth;
 496     aWidth.Value <<= rNewValue.Width;
 497     WritePropertyValue( aFilterData, aWidth );
 498
 499     PropertyValue aHeight;
 500     aHeight.Name = sHeight;
 501     aHeight.Value <<= rNewValue.Height;
 502     WritePropertyValue( aFilterData, aHeight );
 503
 504     if ( xPropSet.is() )
 505     {
 506         Any aAny;
 507         sal_Int32 nOldWidth = rNewValue.Width;
 508         sal_Int32 nOldHeight = rNewValue.Height;
 509
 510         if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 511         {
 512             try
 513             {
 514                 Reference< XPropertySet > aXPropSet;
 515                 if ( aAny >>= aXPropSet )
 516                 {
 517                     if ( ImplGetPropertyValue( aAny, aXPropSet, sWidth, sal_True ) )
 518                         aAny >>= nOldWidth;
 519                     if ( ImplGetPropertyValue( aAny, aXPropSet, sHeight, sal_True ) )
 520                         aAny >>= nOldHeight;
 521                 }
 522                 if ( ( nOldWidth != rNewValue.Width ) || ( nOldHeight != rNewValue.Height ) )
 523                 {
 524                     aAny <<= rNewValue.Width;
 525                     aXPropSet->setPropertyValue( sWidth, aAny );
 526                     aAny <<= rNewValue.Height;
 527                     aXPropSet->setPropertyValue( sHeight, aAny );
 528                     bModified = sal_True;
 529                 }
 530             }
 531             catch ( ::com::sun::star::uno::Exception& )
 532             {
 533                 DBG_ERROR( "FilterConfigItem::WriteSize - could not read PropertyValue" );
 534             }
 535         }
 536     }
 537 }
 538
 539 void FilterConfigItem::WriteString( const OUString& rKey, const OUString& rNewValue )
 540 {
 541     PropertyValue aString;
 542     aString.Name = rKey;
 543     aString.Value <<= rNewValue;
 544     WritePropertyValue( aFilterData, aString );
 545
 546     if ( xPropSet.is() )
 547     {
 548         Any aAny;
 549
 550         if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 551         {
 552             OUString aOldValue;
 553             if ( aAny >>= aOldValue )
 554             {
 555                 if ( aOldValue != rNewValue )
 556                 {
 557                     aAny <<= rNewValue;
 558                     try
 559                     {
 560                         xPropSet->setPropertyValue( rKey, aAny );
 561                         bModified = sal_True;
 562                     }
 563                     catch ( ::com::sun::star::uno::Exception& )
 564                     {
 565                         DBG_ERROR( "FilterConfigItem::WriteInt32 - could not set PropertyValue" );
 566                     }
 567                 }
 568             }
 569         }
 570     }
 571 }
 572
 573 void FilterConfigItem::WriteAny( const OUString& rKey, const Any& rNewAny )
 574 {
 575     PropertyValue aPropValue;
 576     aPropValue.Name = rKey;
 577     aPropValue.Value = rNewAny;
 578     WritePropertyValue( aFilterData, aPropValue );
 579     if ( xPropSet.is() )
 580     {
 581         Any aAny;
 582         if ( ImplGetPropertyValue( aAny, xPropSet, rKey, sal_True ) )
 583         {
 584             if ( aAny != rNewAny )
 585             {
 586                 try
 587                 {
 588                     xPropSet->setPropertyValue( rKey, rNewAny );
 589                     bModified = sal_True;
 590                 }
 591                 catch ( com::sun::star::uno::Exception& )
 592                 {
 593                     DBG_ERROR( "FilterConfigItem::WriteAny - could not set PropertyValue" );
 594
 595                 }
 596             }
 597         }
 598     }
 599 }
 600
 601 // ------------------------------------------------------------------------
 602
 603 Sequence< PropertyValue > FilterConfigItem::GetFilterData() const
 604 {
 605     return aFilterData;
 606 }
 607
 608 // ------------------------------------------------------------------------
 609
 610 Reference< XStatusIndicator > FilterConfigItem::GetStatusIndicator() const
 611 {
 612     Reference< XStatusIndicator > xStatusIndicator;
 613     const rtl::OUString sStatusIndicator( RTL_CONSTASCII_USTRINGPARAM( "StatusIndicator" ) );
 614
 615     sal_Int32 i, nCount = aFilterData.getLength();
 616     for ( i = 0; i < nCount; i++ )
 617     {
 618         if ( aFilterData[ i ].Name == sStatusIndicator )
 619         {
 620             aFilterData[ i ].Value >>= xStatusIndicator;
 621             break;
 622         }
 623     }
 624     return xStatusIndicator;
 625 }
 626