unotools/source/config/viewoptions.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/viewoptions.hxx>
  21 #include <com/sun/star/uno/Any.hxx>
  22
  23 #include <com/sun/star/beans/NamedValue.hpp>
  24 #include <com/sun/star/container/XNameContainer.hpp>
  25 #include <com/sun/star/container/XNameAccess.hpp>
  26 #include <com/sun/star/beans/XPropertySet.hpp>
  27 #include <unotools/configmgr.hxx>
  28 #include <comphelper/configuration.hxx>
  29 #include <comphelper/configurationhelper.hxx>
  30 #include <comphelper/processfactory.hxx>
  31 #include <utility>
  32 #include <comphelper/diagnose_ex.hxx>
  33
  34 constexpr OUStringLiteral PACKAGE_VIEWS = u"org.openoffice.Office.Views";
  35 constexpr OUString PROPERTY_WINDOWSTATE = u"WindowState"_ustr;
  36 constexpr OUString PROPERTY_PAGEID = u"PageID"_ustr;
  37 constexpr OUString PROPERTY_VISIBLE = u"Visible"_ustr;
  38 constexpr OUString PROPERTY_USERDATA = u"UserData"_ustr;
  39
  40
  41 SvtViewOptions::SvtViewOptions( EViewType eType, OUString sViewName )
  42     :   m_eViewType ( eType     )
  43     ,   m_sViewName (std::move( sViewName ))
  44 {
  45     (void)m_eViewType; // so the release build does not complain, since we only use it in assert
  46     // we must know, which view type we must support
  47     switch( eType )
  48     {
  49         case EViewType::Dialog: m_sListName = "Dialogs"; break;
  50         case EViewType::TabDialog: m_sListName = "TabDialogs"; break;
  51         case EViewType::TabPage: m_sListName = "TabPages"; break;
  52         case EViewType::Window: m_sListName = "Windows"; break;
  53         default: assert(false);
  54     }
  55     if (comphelper::IsFuzzing())
  56         return;
  57
  58     try
  59     {
  60         m_xRoot.set( ::comphelper::ConfigurationHelper::openConfig(
  61                             ::comphelper::getProcessComponentContext(),
  62                             PACKAGE_VIEWS,
  63                             ::comphelper::EConfigurationModes::Standard),
  64                      css::uno::UNO_QUERY);
  65         if (m_xRoot.is())
  66             m_xRoot->getByName(m_sListName) >>= m_xSet;
  67     }
  68     catch(const css::uno::Exception&)
  69         {
  70             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
  71             m_xRoot.clear();
  72             m_xSet.clear();
  73         }
  74 }
  75
  76 //  public method
  77
  78 /*-************************************************************************************************************
  79     @short          checks for already existing entries
  80     @descr          If user don't know, if an entry already exist - he can get this information by calling this method.
  81
  82     @seealso        member m_aList
  83
  84     @param          "sName", name of entry to check exist state
  85     @return         true , if item exist
  86                     false, otherwise
  87 *//*-*************************************************************************************************************/
  88 bool SvtViewOptions::Exists() const
  89 {
  90     bool bExists = false;
  91
  92     try
  93     {
  94         if (m_xSet.is())
  95             bExists = m_xSet->hasByName(m_sViewName);
  96     }
  97     catch(const css::uno::Exception&)
  98         {
  99             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 100             bExists = false;
 101         }
 102
 103     return bExists;
 104 }
 105
 106 //  public method
 107
 108 /*-************************************************************************************************************
 109     @short          delete entry
 110     @descr          Use it to delete set entry by given name.
 111
 112     @seealso        member m_aList
 113
 114     @param          "sName", name of entry to delete it
 115 *//*-*************************************************************************************************************/
 116 void SvtViewOptions::Delete()
 117 {
 118     try
 119     {
 120         css::uno::Reference< css::container::XNameContainer > xSet(m_xSet, css::uno::UNO_QUERY_THROW);
 121         xSet->removeByName(m_sViewName);
 122         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 123     }
 124     catch(const css::container::NoSuchElementException&)
 125         { }
 126     catch(const css::uno::Exception&)
 127         {
 128             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 129         }
 130 }
 131
 132 //  public method
 133
 134 /*-************************************************************************************************************
 135     @short          read/write access to cache view items and her properties
 136     @descr          Follow methods support read/write access to all cache view items.
 137
 138     @seealso        member m_sList
 139 *//*-*************************************************************************************************************/
 140 OUString SvtViewOptions::GetWindowState() const
 141 {
 142     OUString sWindowState;
 143     try
 144     {
 145         css::uno::Reference< css::beans::XPropertySet > xNode(
 146             impl_getSetNode(m_sViewName, false),
 147             css::uno::UNO_QUERY);
 148         if (xNode.is())
 149             xNode->getPropertyValue(PROPERTY_WINDOWSTATE) >>= sWindowState;
 150     }
 151     catch(const css::uno::Exception&)
 152         {
 153             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 154             sWindowState.clear();
 155         }
 156
 157     return sWindowState;
 158 }
 159
 160
 161 //  public method
 162
 163 /*-************************************************************************************************************
 164     @short          ctor
 165     @descr          We use it to open right configuration file and let configuration objects fill her caches.
 166                     Then we read all existing entries from right list and cached it inside our object too.
 167                     Normally we should enable notifications for changes on these values too ... but these feature
 168                     isn't full implemented in the moment.
 169
 170     @seealso        baseclass ::utl::ConfigItem
 171     @seealso        method Notify()
 172 *//*-*************************************************************************************************************/
 173 void SvtViewOptions::SetWindowState( const OUString& sState )
 174 {
 175     try
 176     {
 177         css::uno::Reference< css::beans::XPropertySet > xNode(
 178             impl_getSetNode(m_sViewName, true),
 179             css::uno::UNO_QUERY_THROW);
 180         xNode->setPropertyValue(PROPERTY_WINDOWSTATE, css::uno::Any(sState));
 181         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 182     }
 183     catch(const css::uno::Exception&)
 184         {
 185             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 186         }
 187 }
 188
 189 //  public method
 190
 191 OUString SvtViewOptions::GetPageID() const
 192 {
 193     // Safe impossible cases.
 194     // These call isn't allowed for dialogs, tab-pages or windows!
 195     assert( m_eViewType == EViewType::TabDialog && "SvtViewOptions::GetPageID()\nCall not allowed for Dialogs, TabPages or Windows! I do nothing!" );
 196
 197     OUString sID;
 198     try
 199     {
 200         css::uno::Reference< css::beans::XPropertySet > xNode(
 201             impl_getSetNode(m_sViewName, false),
 202             css::uno::UNO_QUERY);
 203         if (xNode.is())
 204             xNode->getPropertyValue(PROPERTY_PAGEID) >>= sID;
 205     }
 206     catch(const css::uno::Exception&)
 207         {
 208             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 209         }
 210
 211     return sID;
 212 }
 213
 214
 215 //  public method
 216
 217 void SvtViewOptions::SetPageID(const OUString& rID)
 218 {
 219     // Safe impossible cases.
 220     // These call isn't allowed for dialogs, tab-pages or windows!
 221     assert( m_eViewType == EViewType::TabDialog && "SvtViewOptions::SetPageID()\nCall not allowed for Dialogs, TabPages or Windows! I do nothing!" );
 222
 223     try
 224     {
 225         css::uno::Reference< css::beans::XPropertySet > xNode(
 226             impl_getSetNode(m_sViewName, true),
 227             css::uno::UNO_QUERY_THROW);
 228         xNode->setPropertyValue(PROPERTY_PAGEID, css::uno::Any(rID));
 229         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 230     }
 231     catch(const css::uno::Exception&)
 232         {
 233             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 234         }
 235 }
 236
 237
 238 //  public method
 239
 240 bool SvtViewOptions::IsVisible() const
 241 {
 242     // Safe impossible cases.
 243     // These call isn't allowed for dialogs, tab-dialogs or tab-pages!
 244     assert( m_eViewType == EViewType::Window && "SvtViewOptions::IsVisible()\nCall not allowed for Dialogs, TabDialogs or TabPages! I do nothing!" );
 245
 246     return GetVisible() == STATE_TRUE;
 247 }
 248
 249 SvtViewOptions::State SvtViewOptions::GetVisible() const
 250 {
 251     State eState = STATE_NONE;
 252     try
 253     {
 254         css::uno::Reference< css::beans::XPropertySet > xNode(
 255             impl_getSetNode(m_sViewName, false),
 256             css::uno::UNO_QUERY);
 257         if (xNode.is())
 258         {
 259             bool bVisible = false;
 260             if (xNode->getPropertyValue(PROPERTY_VISIBLE) >>= bVisible)
 261             {
 262                 eState = bVisible ? STATE_TRUE : STATE_FALSE;
 263             }
 264         }
 265     }
 266     catch(const css::uno::Exception&)
 267         {
 268             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 269         }
 270     return eState;
 271 }
 272
 273 //  public method
 274
 275 void SvtViewOptions::SetVisible( bool bVisible )
 276 {
 277     // Safe impossible cases.
 278     // These call isn't allowed for dialogs, tab-dialogs or tab-pages!
 279     assert(m_eViewType == EViewType::Window && "SvtViewOptions::SetVisible()\nCall not allowed for Dialogs, TabDialogs or TabPages! I do nothing!" );
 280
 281     try
 282     {
 283         css::uno::Reference< css::beans::XPropertySet > xNode(
 284             impl_getSetNode(m_sViewName, true),
 285             css::uno::UNO_QUERY_THROW);
 286         xNode->setPropertyValue(PROPERTY_VISIBLE, css::uno::Any(bVisible));
 287         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 288     }
 289     catch(const css::uno::Exception&)
 290         {
 291             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 292         }
 293 }
 294
 295 //  public method
 296
 297 bool SvtViewOptions::HasVisible() const
 298 {
 299     // Safe impossible cases.
 300     // These call isn't allowed for dialogs, tab-dialogs or tab-pages!
 301     assert( m_eViewType == EViewType::Window && "SvtViewOptions::IsVisible()\nCall not allowed for Dialogs, TabDialogs or TabPages! I do nothing!" );
 302
 303     return GetVisible() != STATE_NONE;
 304 }
 305
 306 css::uno::Sequence< css::beans::NamedValue > SvtViewOptions::GetUserData() const
 307 {
 308     try
 309     {
 310         css::uno::Reference< css::container::XNameAccess > xNode(
 311             impl_getSetNode(m_sViewName, false),
 312             css::uno::UNO_QUERY); // no _THROW ! because we don't create missing items here. So we have to live with zero references .-)
 313         css::uno::Reference< css::container::XNameAccess > xUserData;
 314         if (xNode.is())
 315             xNode->getByName(PROPERTY_USERDATA) >>= xUserData;
 316         if (xUserData.is())
 317         {
 318             const css::uno::Sequence<OUString> lNames = xUserData->getElementNames();
 319             sal_Int32 c = lNames.getLength();
 320             css::uno::Sequence< css::beans::NamedValue > lUserData(c);
 321
 322             std::transform(lNames.begin(), lNames.end(), lUserData.getArray(),
 323                 [&xUserData](const OUString& rName) -> css::beans::NamedValue {
 324                     return { rName, xUserData->getByName(rName) }; });
 325
 326             return lUserData;
 327         }
 328     }
 329     catch(const css::uno::Exception&)
 330         {
 331             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 332         }
 333
 334     return css::uno::Sequence< css::beans::NamedValue >();
 335 }
 336
 337 void SvtViewOptions::SetUserData( const css::uno::Sequence< css::beans::NamedValue >& lData )
 338 {
 339     try
 340     {
 341         css::uno::Reference< css::container::XNameAccess > xNode(
 342             impl_getSetNode(m_sViewName, true),
 343             css::uno::UNO_QUERY_THROW);
 344         css::uno::Reference< css::container::XNameContainer > xUserData;
 345         xNode->getByName(PROPERTY_USERDATA) >>= xUserData;
 346         if (xUserData.is())
 347         {
 348             for (const css::beans::NamedValue& rData : lData)
 349             {
 350                 if (xUserData->hasByName(rData.Name))
 351                     xUserData->replaceByName(rData.Name, rData.Value);
 352                 else
 353                     xUserData->insertByName(rData.Name, rData.Value);
 354             }
 355         }
 356         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 357     }
 358     catch(const css::uno::Exception&)
 359         {
 360             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 361         }
 362 }
 363
 364 css::uno::Any SvtViewOptions::GetUserItem( const OUString& sItemName ) const
 365 {
 366     css::uno::Any aItem;
 367     try
 368     {
 369         css::uno::Reference< css::container::XNameAccess > xNode(
 370             impl_getSetNode(m_sViewName, false),
 371             css::uno::UNO_QUERY);
 372         css::uno::Reference< css::container::XNameAccess > xUserData;
 373         if (xNode.is())
 374             xNode->getByName(PROPERTY_USERDATA) >>= xUserData;
 375         if (xUserData.is())
 376             aItem = xUserData->getByName(sItemName);
 377     }
 378     catch(const css::container::NoSuchElementException&)
 379         { aItem.clear(); }
 380     catch(const css::uno::Exception&)
 381         {
 382             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 383             aItem.clear();
 384         }
 385
 386     return aItem;
 387 }
 388
 389 void SvtViewOptions::SetUserItem( const OUString& sItemName  ,
 390                                   const css::uno::Any&   aValue )
 391 {
 392     try
 393     {
 394         css::uno::Reference< css::container::XNameAccess > xNode(
 395             impl_getSetNode(m_sViewName, true),
 396             css::uno::UNO_QUERY_THROW);
 397         css::uno::Reference< css::container::XNameContainer > xUserData;
 398         xNode->getByName(PROPERTY_USERDATA) >>= xUserData;
 399         if (xUserData.is())
 400         {
 401             if (xUserData->hasByName(sItemName))
 402                 xUserData->replaceByName(sItemName, aValue);
 403             else
 404                 xUserData->insertByName(sItemName, aValue);
 405         }
 406         ::comphelper::ConfigurationHelper::flush(m_xRoot);
 407     }
 408     catch(const css::uno::Exception&)
 409         {
 410             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 411         }
 412 }
 413
 414
 415
 416 /*-************************************************************************************************************
 417     @short          create new set node with default values on disk
 418     @descr          To create a new UserData item - the super node of these property must already exist!
 419                     You can call this method to create these new entry with default values and change UserData then.
 420
 421     @seealso        method impl_writeDirectProp()
 422
 423     @param          "sNode", name of new entry
 424 *//*-*************************************************************************************************************/
 425 css::uno::Reference< css::uno::XInterface > SvtViewOptions::impl_getSetNode( const OUString& sNode           ,
 426                                                                                             bool         bCreateIfMissing) const
 427 {
 428     css::uno::Reference< css::uno::XInterface > xNode;
 429
 430     try
 431     {
 432         if (bCreateIfMissing)
 433             xNode = ::comphelper::ConfigurationHelper::makeSureSetNodeExists(m_xRoot, m_sListName, sNode);
 434         else
 435         {
 436             if (m_xSet.is() && m_xSet->hasByName(sNode) )
 437                 m_xSet->getByName(sNode) >>= xNode;
 438         }
 439     }
 440     catch(const css::container::NoSuchElementException&)
 441         { xNode.clear(); }
 442     catch(const css::uno::Exception&)
 443         {
 444             TOOLS_WARN_EXCEPTION("unotools", "Unexpected exception");
 445             xNode.clear();
 446         }
 447
 448     return xNode;
 449 }
 450
 451 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */