vcl/source/filter/FilterConfigItem.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 <vcl/FilterConfigItem.hxx>
  21
  22 #include <unotools/configmgr.hxx>
  23 #include <comphelper/processfactory.hxx>
  24 #include <osl/diagnose.h>
  25 #include <com/sun/star/beans/PropertyValue.hpp>
  26 #include <com/sun/star/configuration/theDefaultProvider.hpp>
  27 #include <com/sun/star/lang/XMultiServiceFactory.hpp>
  28 #include <com/sun/star/util/XChangesBatch.hpp>
  29 #include <com/sun/star/beans/XPropertySetInfo.hpp>
  30 #include <com/sun/star/beans/XPropertySet.hpp>
  31 #include <com/sun/star/container/XHierarchicalNameAccess.hpp>
  32 #include <com/sun/star/awt/Size.hpp>
  33 #include <com/sun/star/task/XStatusIndicator.hpp>
  34
  35 using namespace ::com::sun::star::lang      ;   // XMultiServiceFactory
  36 using namespace ::com::sun::star::beans     ;   // PropertyValue
  37 using namespace ::com::sun::star::uno       ;   // Reference
  38 using namespace ::com::sun::star::util      ;   // XChangesBatch
  39 using namespace ::com::sun::star::awt       ;   // Size
  40 using namespace ::com::sun::star::container ;
  41 using namespace ::com::sun::star::configuration;
  42 using namespace ::com::sun::star::task      ;   // XStatusIndicator
  43
  44 static bool ImpIsTreeAvailable( Reference< XMultiServiceFactory > const & rXCfgProv, const OUString& rTree )
  45 {
  46     bool bAvailable = !rTree.isEmpty();
  47     if ( bAvailable )
  48     {
  49         sal_Int32 nIdx{0};
  50         if ( rTree[0] == '/' )
  51             ++nIdx;
  52
  53         // creation arguments: nodepath
  54         PropertyValue aPathArgument;
  55         aPathArgument.Name = "nodepath";
  56         aPathArgument.Value <<= rTree.getToken(0, '/', nIdx);
  57
  58         Sequence< Any > aArguments( 1 );
  59         aArguments[ 0 ] <<= aPathArgument;
  60
  61         Reference< XInterface > xReadAccess;
  62         try
  63         {
  64             xReadAccess = rXCfgProv->createInstanceWithArguments(
  65                     "com.sun.star.configuration.ConfigurationAccess",
  66                     aArguments );
  67         }
  68         catch (const css::uno::Exception&)
  69         {
  70             bAvailable = false;
  71         }
  72         if ( xReadAccess.is() )
  73         {
  74             const sal_Int32 nEnd {rTree.getLength()};
  75             while (bAvailable && nIdx>=0 && nIdx<nEnd)
  76             {
  77                 Reference< XHierarchicalNameAccess > xHierarchicalNameAccess
  78                     ( xReadAccess, UNO_QUERY );
  79
  80                 if ( !xHierarchicalNameAccess.is() )
  81                     bAvailable = false;
  82                 else
  83                 {
  84                     const OUString aNode( rTree.getToken(0, '/', nIdx) );
  85                     if ( !xHierarchicalNameAccess->hasByHierarchicalName( aNode ) )
  86                         bAvailable = false;
  87                     else
  88                     {
  89                         Any a( xHierarchicalNameAccess->getByHierarchicalName( aNode ) );
  90                         bAvailable = (a >>= xReadAccess);
  91                     }
  92                 }
  93             }
  94         }
  95     }
  96     return bAvailable;
  97 }
  98
  99 void FilterConfigItem::ImpInitTree( std::u16string_view rSubTree )
 100 {
 101     bModified = false;
 102
 103     Reference< XComponentContext > xContext( comphelper::getProcessComponentContext() );
 104
 105     Reference< XMultiServiceFactory > xCfgProv = theDefaultProvider::get( xContext );
 106
 107     OUString sTree = OUString::Concat("/org.openoffice.") + rSubTree;
 108     if ( !ImpIsTreeAvailable(xCfgProv, sTree) )
 109         return;
 110
 111     // creation arguments: nodepath
 112     PropertyValue aPathArgument;
 113     aPathArgument.Name = "nodepath";
 114     aPathArgument.Value <<= sTree;
 115
 116     Sequence< Any > aArguments( 1 );
 117     aArguments[ 0 ] <<= aPathArgument;
 118
 119     try
 120     {
 121         xUpdatableView = xCfgProv->createInstanceWithArguments(
 122                 "com.sun.star.configuration.ConfigurationUpdateAccess",
 123                 aArguments );
 124         if ( xUpdatableView.is() )
 125             xPropSet.set( xUpdatableView, UNO_QUERY );
 126     }
 127     catch ( css::uno::Exception& )
 128     {
 129         OSL_FAIL( "FilterConfigItem::FilterConfigItem - Could not access configuration Key" );
 130     }
 131 }
 132
 133 FilterConfigItem::FilterConfigItem( std::u16string_view rSubTree )
 134 {
 135     ImpInitTree( rSubTree );
 136 }
 137
 138 FilterConfigItem::FilterConfigItem( css::uno::Sequence< css::beans::PropertyValue > const * pFilterData )
 139     : bModified(false)
 140 {
 141     if ( pFilterData )
 142         aFilterData = *pFilterData;
 143 }
 144
 145 FilterConfigItem::FilterConfigItem( std::u16string_view rSubTree,
 146     css::uno::Sequence< css::beans::PropertyValue > const * pFilterData )
 147 {
 148     ImpInitTree( rSubTree );
 149
 150     if ( pFilterData )
 151         aFilterData = *pFilterData;
 152 };
 153
 154 FilterConfigItem::~FilterConfigItem()
 155 {
 156     WriteModifiedConfig();
 157 }
 158
 159 void FilterConfigItem::WriteModifiedConfig()
 160 {
 161     if ( !xUpdatableView.is() )
 162         return;
 163
 164     if ( !(xPropSet.is() && bModified) )
 165         return;
 166
 167     Reference< XChangesBatch > xUpdateControl( xUpdatableView, UNO_QUERY );
 168     if ( xUpdateControl.is() )
 169     {
 170         try
 171         {
 172             xUpdateControl->commitChanges();
 173             bModified = false;
 174         }
 175         catch ( css::uno::Exception& )
 176         {
 177             OSL_FAIL( "FilterConfigItem::FilterConfigItem - Could not update configuration data" );
 178         }
 179     }
 180 }
 181
 182 bool FilterConfigItem::ImplGetPropertyValue( Any& rAny, const Reference< XPropertySet >& rXPropSet, const OUString& rString )
 183 {
 184     bool bRetValue = true;
 185
 186     if ( rXPropSet.is() )
 187     {
 188         bRetValue = false;
 189         try
 190         {
 191             Reference< XPropertySetInfo >
 192                 aXPropSetInfo( rXPropSet->getPropertySetInfo() );
 193             if ( aXPropSetInfo.is() )
 194                 bRetValue = aXPropSetInfo->hasPropertyByName( rString );
 195         }
 196         catch( css::uno::Exception& )
 197         {
 198         }
 199         if ( bRetValue )
 200         {
 201             try
 202             {
 203                 rAny = rXPropSet->getPropertyValue( rString );
 204                 if ( !rAny.hasValue() )
 205                     bRetValue = false;
 206             }
 207             catch( css::uno::Exception& )
 208             {
 209                 bRetValue = false;
 210             }
 211         }
 212     }
 213     else
 214         bRetValue = false;
 215     return bRetValue;
 216 }
 217
 218 // if property is available it returns a pointer,
 219 // otherwise the result is null
 220 PropertyValue* FilterConfigItem::GetPropertyValue( Sequence< PropertyValue >& rPropSeq, const OUString& rName )
 221 {
 222     auto pProp = std::find_if(rPropSeq.begin(), rPropSeq.end(),
 223         [&rName](const PropertyValue& rProp) { return rProp.Name == rName; });
 224     if (pProp != rPropSeq.end())
 225         return pProp;
 226     return nullptr;
 227 }
 228
 229 /* if PropertySequence already includes a PropertyValue using the same name, the
 230     corresponding PropertyValue is replaced, otherwise the given PropertyValue
 231     will be appended */
 232
 233 bool FilterConfigItem::WritePropertyValue( Sequence< PropertyValue >& rPropSeq, const PropertyValue& rPropValue )
 234 {
 235     bool bRet = false;
 236     if ( !rPropValue.Name.isEmpty() )
 237     {
 238         auto pProp = std::find_if(rPropSeq.begin(), rPropSeq.end(),
 239             [&rPropValue](const PropertyValue& rProp) { return rProp.Name == rPropValue.Name; });
 240         sal_Int32 i = std::distance(rPropSeq.begin(), pProp);
 241         sal_Int32 nCount = rPropSeq.getLength();
 242         if ( i == nCount )
 243             rPropSeq.realloc( ++nCount );
 244
 245         rPropSeq[ i ] = rPropValue;
 246
 247         bRet = true;
 248     }
 249     return bRet;
 250 }
 251
 252 bool FilterConfigItem::ReadBool( const OUString& rKey, bool bDefault )
 253 {
 254     Any aAny;
 255     bool bRetValue = bDefault;
 256     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 257     if ( pPropVal )
 258     {
 259         pPropVal->Value >>= bRetValue;
 260     }
 261     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey ) )
 262     {
 263         aAny >>= bRetValue;
 264     }
 265     PropertyValue aBool;
 266     aBool.Name = rKey;
 267     aBool.Value <<= bRetValue;
 268     WritePropertyValue( aFilterData, aBool );
 269     return bRetValue;
 270 }
 271
 272 sal_Int32 FilterConfigItem::ReadInt32( const OUString& rKey, sal_Int32 nDefault )
 273 {
 274     Any aAny;
 275     sal_Int32 nRetValue = nDefault;
 276     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 277     if ( pPropVal )
 278     {
 279         pPropVal->Value >>= nRetValue;
 280     }
 281     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey ) )
 282     {
 283         aAny >>= nRetValue;
 284     }
 285     PropertyValue aInt32;
 286     aInt32.Name = rKey;
 287     aInt32.Value <<= nRetValue;
 288     WritePropertyValue( aFilterData, aInt32 );
 289     return nRetValue;
 290 }
 291
 292 OUString FilterConfigItem::ReadString( const OUString& rKey, const OUString& rDefault )
 293 {
 294     Any aAny;
 295     OUString aRetValue( rDefault );
 296     PropertyValue* pPropVal = GetPropertyValue( aFilterData, rKey );
 297     if ( pPropVal )
 298     {
 299         pPropVal->Value >>= aRetValue;
 300     }
 301     else if ( ImplGetPropertyValue( aAny, xPropSet, rKey ) )
 302     {
 303         aAny >>= aRetValue;
 304     }
 305     PropertyValue aString;
 306     aString.Name = rKey;
 307     aString.Value <<= aRetValue;
 308     WritePropertyValue( aFilterData, aString );
 309     return aRetValue;
 310 }
 311
 312 void FilterConfigItem::WriteBool( const OUString& rKey, bool bNewValue )
 313 {
 314     PropertyValue aBool;
 315     aBool.Name = rKey;
 316     aBool.Value <<= bNewValue;
 317     WritePropertyValue( aFilterData, aBool );
 318
 319     if ( !xPropSet.is() )
 320         return;
 321
 322     Any aAny;
 323     if ( !ImplGetPropertyValue( aAny, xPropSet, rKey ) )
 324         return;
 325
 326     bool bOldValue(true);
 327     if ( !(aAny >>= bOldValue) )
 328         return;
 329
 330     if ( bOldValue != bNewValue )
 331     {
 332         try
 333         {
 334             xPropSet->setPropertyValue( rKey, Any(bNewValue) );
 335             bModified = true;
 336         }
 337         catch ( css::uno::Exception& )
 338         {
 339             OSL_FAIL( "FilterConfigItem::WriteBool - could not set PropertyValue" );
 340         }
 341     }
 342 }
 343
 344 void FilterConfigItem::WriteInt32( const OUString& rKey, sal_Int32 nNewValue )
 345 {
 346     PropertyValue aInt32;
 347     aInt32.Name = rKey;
 348     aInt32.Value <<= nNewValue;
 349     WritePropertyValue( aFilterData, aInt32 );
 350
 351     if ( !xPropSet.is() )
 352         return;
 353
 354     Any aAny;
 355
 356     if ( !ImplGetPropertyValue( aAny, xPropSet, rKey ) )
 357         return;
 358
 359     sal_Int32 nOldValue = 0;
 360     if ( !(aAny >>= nOldValue) )
 361         return;
 362
 363     if ( nOldValue != nNewValue )
 364     {
 365         try
 366         {
 367             xPropSet->setPropertyValue( rKey, Any(nNewValue) );
 368             bModified = true;
 369         }
 370         catch ( css::uno::Exception& )
 371         {
 372             OSL_FAIL( "FilterConfigItem::WriteInt32 - could not set PropertyValue" );
 373         }
 374     }
 375 }
 376
 377
 378 Reference< XStatusIndicator > FilterConfigItem::GetStatusIndicator() const
 379 {
 380     Reference< XStatusIndicator > xStatusIndicator;
 381
 382     auto pPropVal = std::find_if(aFilterData.begin(), aFilterData.end(),
 383         [](const css::beans::PropertyValue& rPropVal) {
 384             return rPropVal.Name == "StatusIndicator"; });
 385     if (pPropVal != aFilterData.end())
 386     {
 387         pPropVal->Value >>= xStatusIndicator;
 388     }
 389     return xStatusIndicator;
 390 }
 391
 392 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */