Adding upstream version 1:7.0.4.upstream/1%7.0.4upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 378 insertions, 0 deletions

diff --git a/unotools/source/config/eventcfg.cxx b/unotools/source/config/eventcfg.cxx
new file mode 100644
index 000000000..b0e36fc62
--- /dev/null
+++ b/unotools/source/config/eventcfg.cxx
@@ -0,0 +1,378 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ *   Licensed to the Apache Software Foundation (ASF) under one or more
+ *   contributor license agreements. See the NOTICE file distributed
+ *   with this work for additional information regarding copyright
+ *   ownership. The ASF licenses this file to you under the Apache
+ *   License, Version 2.0 (the "License"); you may not use this file
+ *   except in compliance with the License. You may obtain a copy of
+ *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#include <unotools/eventcfg.hxx>
+#include <unotools/configmgr.hxx>
+#include <unotools/configitem.hxx>
+#include <com/sun/star/uno/Any.hxx>
+#include <com/sun/star/uno/Sequence.hxx>
+#include <com/sun/star/beans/PropertyValue.hpp>
+#include <o3tl/enumarray.hxx>
+#include <o3tl/enumrange.hxx>
+#include <rtl/ref.hxx>
+#include <sal/log.hxx>
+
+#include "itemholder1.hxx"
+
+#include <algorithm>
+#include <unordered_map>
+
+using namespace ::std;
+using namespace ::utl;
+using namespace ::osl;
+using namespace ::com::sun::star::uno;
+using namespace ::com::sun::star;
+
+#define PATHDELIMITER "/"
+#define SETNODE_BINDINGS "Bindings"
+#define PROPERTYNAME_BINDINGURL "BindingURL"
+
+static o3tl::enumarray<GlobalEventId, const char*> pEventAsciiNames =
+{
+"OnStartApp",
+"OnCloseApp",
+"OnCreate",
+"OnNew",
+"OnLoadFinished",
+"OnLoad",
+"OnPrepareUnload",
+"OnUnload",
+"OnSave",
+"OnSaveDone",
+"OnSaveFailed",
+"OnSaveAs",
+"OnSaveAsDone",
+"OnSaveAsFailed",
+"OnCopyTo",
+"OnCopyToDone",
+"OnCopyToFailed",
+"OnFocus",
+"OnUnfocus",
+"OnPrint",
+"OnViewCreated",
+"OnPrepareViewClosing",
+"OnViewClosed",
+"OnModifyChanged",
+"OnTitleChanged",
+"OnVisAreaChanged",
+"OnModeChanged",
+"OnStorageChanged"
+};
+
+typedef std::unordered_map< OUString, OUString > EventBindingHash;
+typedef o3tl::enumarray< GlobalEventId, OUString > SupportedEventsVector;
+
+class GlobalEventConfig_Impl : public utl::ConfigItem
+{
+private:
+    EventBindingHash m_eventBindingHash;
+    SupportedEventsVector m_supportedEvents;
+
+    void initBindingInfo();
+
+    virtual void ImplCommit() override;
+
+public:
+    GlobalEventConfig_Impl( );
+    virtual ~GlobalEventConfig_Impl( ) override;
+
+    void            Notify( const css::uno::Sequence<OUString>& aPropertyNames) override;
+
+    /// @throws css::lang::IllegalArgumentException
+    /// @throws css::container::NoSuchElementException
+    /// @throws css::lang::WrappedTargetException
+    /// @throws css::uno::RuntimeException
+    void replaceByName( const OUString& aName, const css::uno::Any& aElement );
+    /// @throws css::container::NoSuchElementException
+    /// @throws css::lang::WrappedTargetException
+    /// @throws css::uno::RuntimeException
+    css::uno::Any getByName( const OUString& aName );
+    /// @throws css::uno::RuntimeException
+    css::uno::Sequence< OUString > getElementNames(  );
+    /// @throws css::uno::RuntimeException
+    bool hasByName( const OUString& aName );
+    /// @throws css::uno::RuntimeException
+    static css::uno::Type const & getElementType(  );
+    /// @throws css::uno::RuntimeException
+    bool hasElements() const;
+    OUString const & GetEventName( GlobalEventId nID ) const;
+};
+
+
+GlobalEventConfig_Impl::GlobalEventConfig_Impl()
+    :   ConfigItem( "Office.Events/ApplicationEvents", ConfigItemMode::NONE )
+{
+    // the supported event names
+    for (const GlobalEventId id : o3tl::enumrange<GlobalEventId>())
+        m_supportedEvents[id] = OUString::createFromAscii( pEventAsciiNames[id] );
+
+    initBindingInfo();
+
+/*TODO: Not used in the moment! see Notify() ...
+    // Enable notification mechanism of our baseclass.
+    // We need it to get information about changes outside these class on our used configuration keys! */
+    Sequence<OUString> aNotifySeq { "Events" };
+    EnableNotification( aNotifySeq, true );
+}
+
+//  destructor
+
+GlobalEventConfig_Impl::~GlobalEventConfig_Impl()
+{
+    assert(!IsModified()); // should have been committed
+}
+
+OUString const & GlobalEventConfig_Impl::GetEventName( GlobalEventId nIndex ) const
+{
+    return m_supportedEvents[nIndex];
+}
+
+//  public method
+
+void GlobalEventConfig_Impl::Notify( const Sequence< OUString >& )
+{
+    MutexGuard aGuard( GlobalEventConfig::GetOwnStaticMutex() );
+
+    initBindingInfo();
+}
+
+//  public method
+
+void GlobalEventConfig_Impl::ImplCommit()
+{
+    //DF need to check it this is correct??
+    SAL_INFO("unotools", "In GlobalEventConfig_Impl::ImplCommit");
+    // clear the existing nodes
+    ClearNodeSet( SETNODE_BINDINGS );
+    Sequence< beans::PropertyValue > seqValues( 1 );
+    OUString sNode;
+    //step through the list of events
+    for(const auto& rEntry : m_eventBindingHash)
+    {
+        //no point in writing out empty bindings!
+        if(rEntry.second.isEmpty() )
+            continue;
+        sNode = SETNODE_BINDINGS PATHDELIMITER "BindingType['" +
+                rEntry.first +
+                "']" PATHDELIMITER PROPERTYNAME_BINDINGURL;
+        SAL_INFO("unotools", "writing binding for: " << sNode);
+        seqValues[ 0 ].Name = sNode;
+        seqValues[ 0 ].Value <<= rEntry.second;
+        //write the data to the registry
+        SetSetProperties(SETNODE_BINDINGS,seqValues);
+    }
+}
+
+//  private method
+
+void GlobalEventConfig_Impl::initBindingInfo()
+{
+    // Get ALL names of current existing list items in configuration!
+    const Sequence< OUString > lEventNames = GetNodeNames( SETNODE_BINDINGS, utl::ConfigNameFormat::LocalPath );
+
+    OUString aSetNode = SETNODE_BINDINGS PATHDELIMITER;
+    OUString aCommandKey = PATHDELIMITER PROPERTYNAME_BINDINGURL;
+
+    // Expand all keys
+    Sequence< OUString > lMacros(1);
+    for (const auto& rEventName : lEventNames )
+    {
+        lMacros[0] = aSetNode + rEventName + aCommandKey;
+        SAL_INFO("unotools", "reading binding for: " << lMacros[0]);
+        Sequence< Any > lValues = GetProperties( lMacros );
+        OUString sMacroURL;
+        if( lValues.hasElements() )
+        {
+            lValues[0] >>= sMacroURL;
+            sal_Int32 startIndex = rEventName.indexOf('\'');
+            sal_Int32 endIndex =  rEventName.lastIndexOf('\'');
+            if( startIndex >=0 && endIndex > 0 )
+            {
+                startIndex++;
+                OUString eventName = rEventName.copy(startIndex,endIndex-startIndex);
+                m_eventBindingHash[ eventName ] = sMacroURL;
+            }
+        }
+    }
+}
+
+void GlobalEventConfig_Impl::replaceByName( const OUString& aName, const Any& aElement )
+{
+    Sequence< beans::PropertyValue > props;
+    //DF should we prepopulate the hash with a list of valid event Names?
+    if( !( aElement >>= props ) )
+    {
+        throw lang::IllegalArgumentException( OUString(),
+                Reference< XInterface > (), 2);
+    }
+    OUString macroURL;
+    for( const auto& rProp : std::as_const(props) )
+    {
+        if ( rProp.Name == "Script" )
+            rProp.Value >>= macroURL;
+    }
+    m_eventBindingHash[ aName ] = macroURL;
+    SetModified();
+}
+
+Any GlobalEventConfig_Impl::getByName( const OUString& aName )
+{
+    Any aRet;
+    Sequence< beans::PropertyValue > props(2);
+    props[0].Name = "EventType";
+    props[0].Value <<= OUString("Script");
+    props[1].Name = "Script";
+    EventBindingHash::const_iterator it = m_eventBindingHash.find( aName );
+    if( it != m_eventBindingHash.end() )
+    {
+        props[1].Value <<= it->second;
+    }
+    else
+    {
+        // not yet accessed - is it a supported name?
+        SupportedEventsVector::iterator pos = ::std::find(
+            m_supportedEvents.begin(), m_supportedEvents.end(), aName );
+        if ( pos == m_supportedEvents.end() )
+            throw container::NoSuchElementException( aName );
+
+        props[1].Value <<= OUString();
+    }
+    aRet <<= props;
+    return aRet;
+}
+
+Sequence< OUString > GlobalEventConfig_Impl::getElementNames(  )
+{
+    return uno::Sequence< OUString >(m_supportedEvents.data(), SupportedEventsVector::size());
+}
+
+bool GlobalEventConfig_Impl::hasByName( const OUString& aName )
+{
+    if ( m_eventBindingHash.find( aName ) != m_eventBindingHash.end() )
+        return true;
+
+    // never accessed before - is it supported in general?
+    SupportedEventsVector::iterator pos = ::std::find(
+        m_supportedEvents.begin(), m_supportedEvents.end(), aName );
+    return pos != m_supportedEvents.end();
+}
+
+Type const & GlobalEventConfig_Impl::getElementType(  )
+{
+    //DF definitely not sure about this??
+    return cppu::UnoType<Sequence<beans::PropertyValue>>::get();
+}
+
+bool GlobalEventConfig_Impl::hasElements() const
+{
+    return !m_eventBindingHash.empty();
+}
+
+// and now the wrapper
+
+//initialize static member
+GlobalEventConfig_Impl*     GlobalEventConfig::m_pImpl = nullptr;
+sal_Int32                   GlobalEventConfig::m_nRefCount      = 0;
+
+GlobalEventConfig::GlobalEventConfig()
+{
+    // Global access, must be guarded (multithreading!).
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    // Increase our refcount ...
+    ++m_nRefCount;
+    // ... and initialize our data container only if it not already exist!
+    if( m_pImpl == nullptr )
+    {
+        m_pImpl = new GlobalEventConfig_Impl;
+        ItemHolder1::holdConfigItem(EItem::EventConfig);
+    }
+}
+
+GlobalEventConfig::~GlobalEventConfig()
+{
+    // Global access, must be guarded (multithreading!)
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    // Decrease our refcount.
+    --m_nRefCount;
+    // If last instance was deleted ...
+    // we must destroy our static data container!
+    if( m_nRefCount <= 0 )
+    {
+        delete m_pImpl;
+        m_pImpl = nullptr;
+    }
+}
+
+Reference< container::XNameReplace > SAL_CALL GlobalEventConfig::getEvents()
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    Reference< container::XNameReplace > ret(this);
+    return ret;
+}
+
+void SAL_CALL GlobalEventConfig::replaceByName( const OUString& aName, const Any& aElement )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    m_pImpl->replaceByName( aName, aElement );
+}
+Any SAL_CALL GlobalEventConfig::getByName( const OUString& aName )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->getByName( aName );
+}
+Sequence< OUString > SAL_CALL GlobalEventConfig::getElementNames(  )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->getElementNames( );
+}
+sal_Bool SAL_CALL GlobalEventConfig::hasByName( const OUString& aName )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->hasByName( aName );
+}
+Type SAL_CALL GlobalEventConfig::getElementType(  )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return GlobalEventConfig_Impl::getElementType( );
+}
+sal_Bool SAL_CALL GlobalEventConfig::hasElements(  )
+{
+    MutexGuard aGuard( GetOwnStaticMutex() );
+    return m_pImpl->hasElements( );
+}
+
+namespace
+{
+    class theGlobalEventConfigMutex : public rtl::Static<osl::Mutex, theGlobalEventConfigMutex>{};
+}
+
+Mutex& GlobalEventConfig::GetOwnStaticMutex()
+{
+    return theGlobalEventConfigMutex::get();
+}
+
+OUString GlobalEventConfig::GetEventName( GlobalEventId nIndex )
+{
+    if (utl::ConfigManager::IsFuzzing())
+        return OUString();
+    rtl::Reference<GlobalEventConfig> createImpl(new GlobalEventConfig);
+    return GlobalEventConfig::m_pImpl->GetEventName( nIndex );
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */