unotools/source/config/compatibility.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 <unotools/compatibility.hxx>
  21 #include <unotools/configitem.hxx>
  22 #include <unotools/syslocale.hxx>
  23 #include <tools/debug.hxx>
  24 #include <sal/log.hxx>
  25 #include <com/sun/star/uno/Any.hxx>
  26 #include <com/sun/star/uno/Sequence.hxx>
  27 #include <com/sun/star/beans/PropertyValue.hpp>
  28 #include <com/sun/star/lang/Locale.hpp>
  29 #include <i18nlangtag/languagetag.hxx>
  30
  31 #include "itemholder1.hxx"
  32
  33 #include <algorithm>
  34 #include <vector>
  35
  36 using namespace ::std;
  37 using namespace ::utl;
  38 using namespace ::osl;
  39 using namespace ::com::sun::star::uno;
  40 using namespace ::com::sun::star::beans;
  41
  42 #define ROOTNODE_OPTIONS        "Office.Compatibility"
  43 #define PATHDELIMITER           "/"
  44 #define SETNODE_ALLFILEFORMATS  "AllFileFormats"
  45
  46 SvtCompatibilityEntry::SvtCompatibilityEntry()
  47     : m_aPropertyValue( SvtCompatibilityEntry::getElementCount() )
  48 {
  49     /* Should be in the start. Do not remove it. */
  50     setValue<OUString>( Index::Name, OUString() );
  51     setValue<OUString>( Index::Module, OUString() );
  52
  53     /* Editable list of default values. Sync it with the SvtCompatibilityEntry::Index enum class. */
  54     setValue<bool>( Index::UsePrtMetrics, false );
  55     setValue<bool>( Index::AddSpacing, false );
  56     setValue<bool>( Index::AddSpacingAtPages, false );
  57     setValue<bool>( Index::UseOurTabStops, false );
  58     setValue<bool>( Index::NoExtLeading, false );
  59     setValue<bool>( Index::UseLineSpacing, false );
  60     setValue<bool>( Index::AddTableSpacing, false );
  61     setValue<bool>( Index::UseObjectPositioning, false );
  62     setValue<bool>( Index::UseOurTextWrapping, false );
  63     setValue<bool>( Index::ConsiderWrappingStyle, false );
  64     setValue<bool>( Index::ExpandWordSpace, true );
  65     setValue<bool>( Index::ProtectForm, false );
  66     setValue<bool>( Index::MsWordTrailingBlanks, false );
  67     setValue<bool>( Index::SubtractFlysAnchoredAtFlys, false );
  68     setValue<bool>( Index::EmptyDbFieldHidesPara, true );
  69     setValue<bool>( Index::AddTableLineSpacing, false );
  70
  71     setDefaultEntry( false );
  72 }
  73
  74 OUString SvtCompatibilityEntry::getName( const Index rIdx )
  75 {
  76     static const char* sPropertyName[] =
  77     {
  78         /* Should be in the start. Do not remove it. */
  79         "Name",
  80         "Module",
  81
  82         /* Editable list of compatibility option names. Sync it with the SvtCompatibilityEntry::Index enum class. */
  83         "UsePrinterMetrics",
  84         "AddSpacing",
  85         "AddSpacingAtPages",
  86         "UseOurTabStopFormat",
  87         "NoExternalLeading",
  88         "UseLineSpacing",
  89         "AddTableSpacing",
  90         "UseObjectPositioning",
  91         "UseOurTextWrapping",
  92         "ConsiderWrappingStyle",
  93         "ExpandWordSpace",
  94         "ProtectForm",
  95         "MsWordCompTrailingBlanks",
  96         "SubtractFlysAnchoredAtFlys",
  97         "EmptyDbFieldHidesPara",
  98         "AddTableLineSpacing",
  99     };
 100
 101     /* Size of sPropertyName array not equal size of the SvtCompatibilityEntry::Index enum class */
 102     assert( SAL_N_ELEMENTS(sPropertyName) == static_cast<int>( SvtCompatibilityEntry::getElementCount() ) );
 103
 104     return OUString::createFromAscii( sPropertyName[ static_cast<int>(rIdx) ] );
 105 }
 106
 107 /*-****************************************************************************************************************
 108     @descr  support simple menu structures and operations on it
 109 ****************************************************************************************************************-*/
 110
 111 /*-****************************************************************************************************
 112     @short      base implementation of public interface for "SvtCompatibilityOptions"!
 113     @descr      These class is used as static member of "SvtCompatibilityOptions" ...
 114                 => The code exist only for one time and isn't duplicated for every instance!
 115 *//*-*****************************************************************************************************/
 116 class SvtCompatibilityOptions_Impl : public ConfigItem
 117 {
 118     public:
 119         SvtCompatibilityOptions_Impl();
 120         virtual ~SvtCompatibilityOptions_Impl() override;
 121
 122         void AppendItem( const SvtCompatibilityEntry& aItem );
 123         void Clear();
 124
 125         void SetDefault( SvtCompatibilityEntry::Index rIdx, bool rValue );
 126         bool GetDefault( SvtCompatibilityEntry::Index rIdx ) const;
 127
 128         Sequence< Sequence< PropertyValue > > GetList() const;
 129
 130         /*-****************************************************************************************************
 131             @short      called for notify of configmanager
 132             @descr      This method is called from the ConfigManager before the application ends or from the
 133                         PropertyChangeListener if the sub tree broadcasts changes. You must update your
 134                         internal values.
 135
 136             @seealso    baseclass ConfigItem
 137
 138             @param      "lPropertyNames" is the list of properties which should be updated.
 139         *//*-*****************************************************************************************************/
 140         virtual void Notify( const Sequence< OUString >& lPropertyNames ) override;
 141
 142     private:
 143         virtual void ImplCommit() override;
 144
 145         /*-****************************************************************************************************
 146             @short      return list of key names of our configuration management which represent one module tree
 147             @descr      These methods return the current list of key names! We need it to get needed values from our
 148                         configuration management and support dynamical menu item lists!
 149             @return     A list of configuration key names is returned.
 150         *//*-*****************************************************************************************************/
 151         Sequence< OUString > impl_GetPropertyNames( Sequence< OUString >& rItems );
 152
 153     private:
 154         std::vector< SvtCompatibilityEntry > m_aOptions;
 155         SvtCompatibilityEntry                m_aDefOptions;
 156 };
 157
 158 SvtCompatibilityOptions_Impl::SvtCompatibilityOptions_Impl() : ConfigItem( ROOTNODE_OPTIONS )
 159 {
 160     // Get names and values of all accessible menu entries and fill internal structures.
 161     // See impl_GetPropertyNames() for further information.
 162     Sequence< OUString > lNodes;
 163     Sequence< OUString > lNames  = impl_GetPropertyNames( lNodes );
 164     Sequence< Any >      lValues = GetProperties( lNames );
 165
 166     // Safe impossible cases.
 167     // We need values from ALL configuration keys.
 168     // Follow assignment use order of values in relation to our list of key names!
 169     DBG_ASSERT( !( lNames.getLength()!=lValues.getLength() ), "SvtCompatibilityOptions_Impl::SvtCompatibilityOptions_Impl()\nI miss some values of configuration keys!\n" );
 170
 171     // Get names/values for new menu.
 172     // 4 subkeys for every item!
 173     bool bDefaultFound = false;
 174     sal_Int32 nDestStep    = 0;
 175     for ( const auto& rNode : std::as_const(lNodes) )
 176     {
 177         SvtCompatibilityEntry aItem;
 178
 179         aItem.setValue<OUString>( SvtCompatibilityEntry::Index::Name, rNode );
 180
 181         for ( int i = static_cast<int>(SvtCompatibilityEntry::Index::Module); i < static_cast<int>(SvtCompatibilityEntry::Index::INVALID); ++i )
 182         {
 183             aItem.setValue( SvtCompatibilityEntry::Index(i), lValues[ nDestStep ] );
 184             nDestStep++;
 185         }
 186
 187         m_aOptions.push_back( aItem );
 188
 189         if ( !bDefaultFound && aItem.getValue<OUString>( SvtCompatibilityEntry::Index::Name ) == SvtCompatibilityEntry::getDefaultEntryName() )
 190         {
 191             SvtSysLocale aSysLocale;
 192             css::lang::Locale aLocale = aSysLocale.GetLanguageTag().getLocale();
 193             if ( aLocale.Language == "zh" || aLocale.Language == "ja" || aLocale.Language == "ko" )
 194                 aItem.setValue<bool>( SvtCompatibilityEntry::Index::ExpandWordSpace, false );
 195
 196             m_aDefOptions = aItem;
 197             bDefaultFound = true;
 198         }
 199     }
 200 }
 201
 202 SvtCompatibilityOptions_Impl::~SvtCompatibilityOptions_Impl()
 203 {
 204     assert( !IsModified() ); // should have been committed
 205 }
 206
 207 void SvtCompatibilityOptions_Impl::AppendItem( const SvtCompatibilityEntry& aItem )
 208 {
 209     m_aOptions.push_back( aItem );
 210
 211     // default item reset?
 212     if ( aItem.getValue<OUString>( SvtCompatibilityEntry::Index::Name ) == SvtCompatibilityEntry::getDefaultEntryName() )
 213         m_aDefOptions = aItem;
 214
 215     SetModified();
 216 }
 217
 218 void SvtCompatibilityOptions_Impl::Clear()
 219 {
 220     m_aOptions.clear();
 221
 222     SetModified();
 223 }
 224
 225 void SvtCompatibilityOptions_Impl::SetDefault( SvtCompatibilityEntry::Index rIdx, bool rValue )
 226 {
 227     /* Are not set Name and Module */
 228     assert( rIdx != SvtCompatibilityEntry::Index::Name && rIdx != SvtCompatibilityEntry::Index::Module );
 229
 230     m_aDefOptions.setValue<bool>( rIdx, rValue );
 231 }
 232
 233 bool SvtCompatibilityOptions_Impl::GetDefault( SvtCompatibilityEntry::Index rIdx ) const
 234 {
 235     /* Are not set Name and Module */
 236     assert( rIdx != SvtCompatibilityEntry::Index::Name && rIdx != SvtCompatibilityEntry::Index::Module );
 237
 238     return m_aDefOptions.getValue<bool>( rIdx );
 239 }
 240
 241 Sequence< Sequence< PropertyValue > > SvtCompatibilityOptions_Impl::GetList() const
 242 {
 243     Sequence< PropertyValue >             lProperties( SvtCompatibilityEntry::getElementCount() );
 244     Sequence< Sequence< PropertyValue > > lResult( m_aOptions.size() );
 245
 246     for ( int i = static_cast<int>(SvtCompatibilityEntry::Index::Name); i < static_cast<int>(SvtCompatibilityEntry::Index::INVALID); ++i )
 247         lProperties[i].Name = SvtCompatibilityEntry::getName( SvtCompatibilityEntry::Index(i) );
 248
 249     sal_Int32 j = 0;
 250     for ( const auto& rItem : m_aOptions )
 251     {
 252         for ( int i = static_cast<int>(SvtCompatibilityEntry::Index::Name); i < static_cast<int>(SvtCompatibilityEntry::Index::INVALID); ++i )
 253             lProperties[i].Value = rItem.getValue( SvtCompatibilityEntry::Index(i) );
 254         lResult[ j++ ] = lProperties;
 255     }
 256
 257     return lResult;
 258 }
 259
 260 void SvtCompatibilityOptions_Impl::Notify( const Sequence< OUString >& )
 261 {
 262     SAL_WARN( "unotools.config", "SvtCompatibilityOptions_Impl::Notify() Not implemented yet! I don't know how I can handle a dynamical list of unknown properties ..." );
 263 }
 264
 265 void SvtCompatibilityOptions_Impl::ImplCommit()
 266 {
 267     // Write all properties!
 268     // Delete complete set first.
 269     ClearNodeSet( SETNODE_ALLFILEFORMATS );
 270
 271     Sequence< PropertyValue > lPropertyValues( SvtCompatibilityEntry::getElementCount() - 1 );
 272     sal_uInt32 nNewCount = m_aOptions.size();
 273     for ( sal_uInt32 nItem = 0; nItem < nNewCount; ++nItem )
 274     {
 275         SvtCompatibilityEntry aItem = m_aOptions[ nItem ];
 276         OUString              sNode = SETNODE_ALLFILEFORMATS PATHDELIMITER + aItem.getValue<OUString>( SvtCompatibilityEntry::Index::Name ) + PATHDELIMITER;
 277
 278         for ( int i = static_cast<int>(SvtCompatibilityEntry::Index::Module); i < static_cast<int>(SvtCompatibilityEntry::Index::INVALID); ++i )
 279         {
 280             lPropertyValues[ i - 1 ].Name  = sNode + SvtCompatibilityEntry::getName( SvtCompatibilityEntry::Index(i) );
 281             lPropertyValues[ i - 1 ].Value = aItem.getValue( SvtCompatibilityEntry::Index(i) );
 282         }
 283
 284         SetSetProperties( SETNODE_ALLFILEFORMATS, lPropertyValues );
 285     }
 286 }
 287
 288 Sequence< OUString > SvtCompatibilityOptions_Impl::impl_GetPropertyNames( Sequence< OUString >& rItems )
 289 {
 290     // First get ALL names of current existing list items in configuration!
 291     rItems = GetNodeNames( SETNODE_ALLFILEFORMATS );
 292
 293     // expand list to result list ...
 294     Sequence< OUString > lProperties( rItems.getLength() * ( SvtCompatibilityEntry::getElementCount() - 1 ) );
 295
 296     sal_Int32 nDestStep    = 0;
 297     // Copy entries to destination and expand every item with 2 supported sub properties.
 298     for ( const auto& rItem : std::as_const(rItems) )
 299     {
 300         OUString sFixPath = SETNODE_ALLFILEFORMATS PATHDELIMITER + rItem + PATHDELIMITER;
 301         for ( int i = static_cast<int>(SvtCompatibilityEntry::Index::Module); i < static_cast<int>(SvtCompatibilityEntry::Index::INVALID); ++i )
 302         {
 303             lProperties[ nDestStep ] = sFixPath + SvtCompatibilityEntry::getName( SvtCompatibilityEntry::Index(i) );
 304             nDestStep++;
 305         }
 306     }
 307
 308     // Return result.
 309     return lProperties;
 310 }
 311
 312 namespace
 313 {
 314     std::weak_ptr<SvtCompatibilityOptions_Impl> theOptions;
 315 }
 316
 317 SvtCompatibilityOptions::SvtCompatibilityOptions()
 318 {
 319     // Global access, must be guarded (multithreading!).
 320     MutexGuard aGuard( GetOwnStaticMutex() );
 321
 322     m_pImpl = theOptions.lock();
 323     if ( !m_pImpl )
 324     {
 325         m_pImpl    = std::make_shared<SvtCompatibilityOptions_Impl>();
 326         theOptions = m_pImpl;
 327         ItemHolder1::holdConfigItem( EItem::Compatibility );
 328     }
 329 }
 330
 331 SvtCompatibilityOptions::~SvtCompatibilityOptions()
 332 {
 333     // Global access, must be guarded (multithreading!)
 334     MutexGuard aGuard( GetOwnStaticMutex() );
 335     m_pImpl.reset();
 336 }
 337
 338 void SvtCompatibilityOptions::AppendItem( const SvtCompatibilityEntry& aItem )
 339 {
 340     MutexGuard aGuard( GetOwnStaticMutex() );
 341     m_pImpl->AppendItem( aItem );
 342 }
 343
 344 void SvtCompatibilityOptions::Clear()
 345 {
 346     MutexGuard aGuard( GetOwnStaticMutex() );
 347     m_pImpl->Clear();
 348 }
 349
 350 void SvtCompatibilityOptions::SetDefault( SvtCompatibilityEntry::Index rIdx, bool rValue )
 351 {
 352     MutexGuard aGuard( GetOwnStaticMutex() );
 353     m_pImpl->SetDefault( rIdx, rValue );
 354 }
 355
 356 bool SvtCompatibilityOptions::GetDefault( SvtCompatibilityEntry::Index rIdx ) const
 357 {
 358     MutexGuard aGuard( GetOwnStaticMutex() );
 359     return m_pImpl->GetDefault( rIdx );
 360 }
 361
 362 Sequence< Sequence< PropertyValue > > SvtCompatibilityOptions::GetList() const
 363 {
 364     MutexGuard aGuard( GetOwnStaticMutex() );
 365     return m_pImpl->GetList();
 366 }
 367
 368 namespace
 369 {
 370     class theCompatibilityOptionsMutex : public rtl::Static<osl::Mutex, theCompatibilityOptionsMutex>{};
 371 }
 372
 373 Mutex& SvtCompatibilityOptions::GetOwnStaticMutex()
 374 {
 375     return theCompatibilityOptionsMutex::get();
 376 }
 377
 378 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */