/* -*- 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 .
 */

#ifndef INCLUDED_FRAMEWORK_PREVENTDUPLICATEINTERACTION_HXX
#define INCLUDED_FRAMEWORK_PREVENTDUPLICATEINTERACTION_HXX

#include <vector>

#include <com/sun/star/frame/Desktop.hpp>
#include <com/sun/star/frame/TerminationVetoException.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/task/XInteractionHandler2.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>

#include <comphelper/compbase.hxx>
#include <cppuhelper/implbase.hxx>

#include <toolkit/helper/vclunohelper.hxx>
#include <vcl/wrkwin.hxx>
#include <vcl/svapp.hxx>
#include <mutex>

namespace com::sun::star::uno {
    class XComponentContext;
}

namespace sfx2 {

inline void closedialogs(SystemWindow& rTopLevel, bool bCloseRoot)
{
    for (vcl::Window *pChild = rTopLevel.GetWindow(GetWindowType::FirstTopWindowChild); pChild; pChild = rTopLevel.GetWindow(GetWindowType::NextTopWindowSibling))
        closedialogs(dynamic_cast<SystemWindow&>(*pChild), true);
    if (bCloseRoot)
        rTopLevel.Close();
}

// This is intended to be the parent for any warning dialogs launched
// during the load of a document so that those dialogs are modal to
// this window and don't block any existing windows.
//
// If there are dialog children open on exit then veto termination,
// close the topmost dialog and retry termination.
class WarningDialogsParent final :
    public comphelper::WeakComponentImplHelper<css::frame::XTerminateListener>
{
private:
    VclPtr<WorkWindow> m_xWin;
    css::uno::Reference<css::awt::XWindow> m_xInterface;

private:

    DECL_STATIC_LINK(WarningDialogsParent, TerminateDesktop, void*, void);

    void closewarningdialogs()
    {
        if (!m_xWin)
            return;
        SolarMutexGuard aSolarGuard;
        closedialogs(*m_xWin, false);
    }

public:

    using comphelper::WeakComponentImplHelperBase::disposing;
    virtual void SAL_CALL disposing(const css::lang::EventObject&) override
    {
    }

    // XTerminateListener
    virtual void SAL_CALL queryTermination(const css::lang::EventObject&) override
    {
        closewarningdialogs();
        Application::PostUserEvent(LINK(this, WarningDialogsParent, TerminateDesktop));
        throw css::frame::TerminationVetoException();
    }

    virtual void SAL_CALL notifyTermination(const css::lang::EventObject&) override
    {
    }

public:
    WarningDialogsParent()
    {
        SolarMutexGuard aSolarGuard;
        m_xWin = VclPtr<WorkWindow>::Create(nullptr, WB_STDWORK);
        m_xWin->SetText(u"dialog parent for warning dialogs during load"_ustr);
        m_xInterface = VCLUnoHelper::GetInterface(m_xWin);
    }

    virtual ~WarningDialogsParent() override
    {
        closewarningdialogs();
        m_xWin.disposeAndClear();
    }

    const css::uno::Reference<css::awt::XWindow>& GetDialogParent() const
    {
        return m_xInterface;
    }
};

class WarningDialogsParentScope
{
private:
    css::uno::Reference<css::frame::XDesktop> m_xDesktop;
    rtl::Reference<WarningDialogsParent> m_xListener;

public:
    WarningDialogsParentScope(const css::uno::Reference<css::uno::XComponentContext>& rContext)
        : m_xDesktop(css::frame::Desktop::create(rContext), css::uno::UNO_QUERY_THROW)
        , m_xListener(new WarningDialogsParent)
    {
        m_xDesktop->addTerminateListener(m_xListener);
    }

    const css::uno::Reference<css::awt::XWindow>& GetDialogParent() const
    {
        return m_xListener->GetDialogParent();
    }

    ~WarningDialogsParentScope()
    {
        m_xDesktop->removeTerminateListener(m_xListener);
    }
};

/**
    @short      Prevent us from showing the same interaction more than once during
                the same transaction.

    @descr      Every interaction provided to this helper will be safed ... handled by the internal
                used UUIInteractionHandler (!) and never be handled a second time!

                On the other side there exists some interactions, which allow a retry.
                So this helper allow to set a list of interactions combined with a retry value.
 */
class PreventDuplicateInteraction final :
                                  public ::cppu::WeakImplHelper<css::lang::XInitialization, css::task::XInteractionHandler2>
{
    mutable std::mutex m_aLock;

    // structs, types etc.
    public:

        struct InteractionInfo
        {
            public:
                /// describe the interaction.
                css::uno::Type m_aInteraction;
                /// after max count was reached this interaction will be blocked.
                sal_Int32 m_nMaxCount;
                /// count how often this interaction was called.
                sal_Int32 m_nCallCount;
                /** hold the last intercepted request (matching the set interaction type) alive
                so it can be used for further checks */
                css::uno::Reference< css::task::XInteractionRequest > m_xRequest;

            public:

                InteractionInfo(const css::uno::Type& aInteraction)
                    : m_aInteraction(aInteraction)
                    , m_nMaxCount   (1   )
                    , m_nCallCount  (0           )
                {}
        };

    // member
    private:

        /// Used to create needed uno services at runtime.
        css::uno::Reference< css::uno::XComponentContext > m_xContext;

        /** The outside interaction handler, which is used to handle every incoming interaction,
            if it's not blocked. */
        css::uno::Reference< css::task::XInteractionHandler > m_xHandler;

        std::unique_ptr<WarningDialogsParentScope> m_xWarningDialogsParent;

        /** This list describe which and how incoming interactions must be handled.
            Further it contains all collected information after this interaction
            object was used.*/
        std::vector< InteractionInfo > m_lInteractionRules;


    // uno interface
    public:

        virtual void SAL_CALL initialize(const css::uno::Sequence<css::uno::Any>& rArguments) override;

        /**
            @interface  XInteractionHandler
            @short      called from outside to handle a problem
            @descr      We filter the incoming interactions. some of them
                        will be forwarded to the generic UI interaction handler.
                        So we must not implement it twice. Some other ones
                        will be aborted only.

            @threadsafe yes
        */
        virtual void SAL_CALL handle(const css::uno::Reference< css::task::XInteractionRequest >& xRequest) override;


        /**
            @interface  XInteractionHandler2
            @short      called from outside to handle a problem
            @descr      We filter the incoming interactions. some of them
                        will be forwarded to the generic UI interaction handler.
                        So we must not implement it twice. Some other ones
                        will be aborted only.

            @threadsafe yes
        */
        virtual sal_Bool SAL_CALL handleInteractionRequest( const css::uno::Reference< css::task::XInteractionRequest >& xRequest ) override;


        /**
            @interface  XInterface
            @short      called to query another interface of the component
            @descr      Will allow to query for XInteractionHandler2 if and only if m_xHandler supports this interface, too.

            @threadsafe yes
        */
        virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type& aType ) override;

    // c++ interface
    public:


        /**
            @short      ctor to guarantee right initialized instances of this class
            @descr      It uses the given uno service manager to create the global
                        generic UI interaction handler for later internal using.

            @param      xSMGR
                            uno service manager for creating services internally

            @threadsafe not necessary
        */
        PreventDuplicateInteraction(css::uno::Reference< css::uno::XComponentContext > xContext);


        /**
            @short      dtor to free used memory.
         */
        virtual ~PreventDuplicateInteraction() override;


        /**
            @short      set the outside interaction handler, which must be used internally
                        if the interaction will not be blocked by the set list of rules.

            @note       This overwrites the settings of e.g. useDefaultUUIHandler()!

            @param      xHandler
                        the new interaction handler
         */
        void setHandler(const css::uno::Reference< css::task::XInteractionHandler >& xHandler);


        /**
            @short      instead of setting an outside interaction handler, this method
                        make sure the default UUI interaction handler of the office is used.

            @note       This overwrites the settings of e.g. setHandler()!
         */
        void useDefaultUUIHandler();


        /**
            @short      add a new interaction to the list of interactions, which
                        must be handled by this helper.

            @descr      This method must be called immediately after a new instance of this helper was
                        created. Without such list of InteractionRules, this instances does nothing!
                        On the other side there is no possibility to remove rules.
                        So the same instance can't be used within different transactions.
                        It's a OneWay-object .-)

            @param      aInteractionInfo
                        describe the type of interaction, hos often it can be called etcpp.

            @threadsafe yes
        */
        void addInteractionRule(const PreventDuplicateInteraction::InteractionInfo& aInteractionInfo);


        /**
            @short      return the info struct for the specified interaction.

            @param      aInteraction
                        specify the interaction.

            @param      pReturn
                        provides information about:
                        - the count how often this interaction was handled during the
                          lifetime of this helper.
                        - the interaction itself, so it can be analyzed further

            @return     [boolean]
                        true if the queried interaction could be found.
                        false otherwise.

            @threadsafe yes
        */
        bool getInteractionInfo(const css::uno::Type&                               aInteraction,
                                                  PreventDuplicateInteraction::InteractionInfo* pReturn     ) const;
};

} // namespace sfx2

#endif // INCLUDED_FRAMEWORK_PREVENTDUPLICATEINTERACTION_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */