interactionrequest.hxx

Go to the documentation of this file.

/* -*- 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_UCBHELPER_INTERACTIONREQUEST_HXX
#define INCLUDED_UCBHELPER_INTERACTIONREQUEST_HXX
 
#include <config_options.h>
#include <com/sun/star/lang/XTypeProvider.hpp>
#include <com/sun/star/task/XInteractionRequest.hpp>
#include <com/sun/star/task/XInteractionAbort.hpp>
#include <com/sun/star/task/XInteractionRetry.hpp>
#include <com/sun/star/task/XInteractionApprove.hpp>
#include <com/sun/star/task/XInteractionDisapprove.hpp>
#include <com/sun/star/ucb/XInteractionAuthFallback.hpp>
#include <com/sun/star/ucb/XInteractionReplaceExistingData.hpp>
#include <com/sun/star/ucb/XInteractionSupplyAuthentication2.hpp>
#include <cppuhelper/implbase.hxx>
#include <ucbhelper/ucbhelperdllapi.h>
#include <memory>
 
namespace rtl { template <class reference_type> class Reference; }
 
namespace ucbhelper {
 
class InteractionContinuation;
 
 
struct InteractionRequest_Impl;
 
class UCBHELPER_DLLPUBLIC InteractionRequest :
                           public cppu::WeakImplHelper<css::task::XInteractionRequest>
{
    std::unique_ptr<InteractionRequest_Impl> m_pImpl;
 
protected:
    void setRequest( const css::uno::Any & rRequest );
 
    InteractionRequest();
    virtual ~InteractionRequest() override;
 
public:
    InteractionRequest( const css::uno::Any & rRequest );
 
    void setContinuations(
        const css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > & rContinuations );
 
    // XInteractionRequest
    virtual css::uno::Any SAL_CALL
    getRequest() override;
    virtual css::uno::Sequence< css::uno::Reference< css::task::XInteractionContinuation > > SAL_CALL
    getContinuations() override;
 
    // Non-interface methods.
 
    rtl::Reference< InteractionContinuation > const & getSelection() const;
 
    void
    setSelection(
        const rtl::Reference< InteractionContinuation > & rxSelection );
};
 
 
class UCBHELPER_DLLPUBLIC InteractionContinuation : public cppu::OWeakObject
{
    InteractionRequest* m_pRequest;
 
protected:
    void recordSelection();
    virtual ~InteractionContinuation() override;
 
public:
    InteractionContinuation( InteractionRequest * pRequest );
};
 
 
class UCBHELPER_DLLPUBLIC InteractionAbort final : public InteractionContinuation,
                         public css::lang::XTypeProvider,
                         public css::task::XInteractionAbort
{
public:
    InteractionAbort( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
};
 
 
class UCBHELPER_DLLPUBLIC InteractionRetry final : public InteractionContinuation,
                         public css::lang::XTypeProvider,
                         public css::task::XInteractionRetry
{
public:
    InteractionRetry( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
};
 
 
class UCBHELPER_DLLPUBLIC InteractionApprove final : public InteractionContinuation,
                           public css::lang::XTypeProvider,
                           public css::task::XInteractionApprove
{
public:
    InteractionApprove( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
};
 
 
class UCBHELPER_DLLPUBLIC InteractionDisapprove final : public InteractionContinuation,
                              public css::lang::XTypeProvider,
                              public css::task::XInteractionDisapprove
{
public:
    InteractionDisapprove( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
};
 
 
class UCBHELPER_DLLPUBLIC InteractionSupplyAuthentication final :
                  public InteractionContinuation,
                  public css::lang::XTypeProvider,
                  public css::ucb::XInteractionSupplyAuthentication2
{
    css::uno::Sequence< css::ucb::RememberAuthentication >
                  m_aRememberPasswordModes;
    css::uno::Sequence< css::ucb::RememberAuthentication >
                  m_aRememberAccountModes;
    OUString m_aRealm;
    OUString m_aUserName;
    OUString m_aPassword;
    css::ucb::RememberAuthentication m_eRememberPasswordMode;
    css::ucb::RememberAuthentication m_eDefaultRememberPasswordMode;
    css::ucb::RememberAuthentication m_eDefaultRememberAccountMode;
    bool m_bCanSetRealm    : 1;
    bool m_bCanSetUserName : 1;
    bool m_bCanSetPassword : 1;
    bool m_bCanSetAccount  : 1;
    bool m_bCanUseSystemCredentials     : 1;
    bool m_bUseSystemCredentials        : 1;
 
public:
    inline InteractionSupplyAuthentication(
                    InteractionRequest * pRequest,
                    bool bCanSetRealm,
                    bool bCanSetUserName,
                    bool bCanSetPassword,
                    bool bCanSetAccount,
                    const css::uno::Sequence< css::ucb::RememberAuthentication > & rRememberPasswordModes,
                    const css::ucb::RememberAuthentication eDefaultRememberPasswordMode,
                    const css::uno::Sequence< css::ucb::RememberAuthentication > & rRememberAccountModes,
                    const css::ucb::RememberAuthentication  eDefaultRememberAccountMode,
                    bool bCanUseSystemCredentials );
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
 
    // XInteractionSupplyAuthentication
    virtual sal_Bool SAL_CALL
    canSetRealm() override;
    virtual void SAL_CALL
    setRealm( const OUString& Realm ) override;
 
    virtual sal_Bool SAL_CALL
    canSetUserName() override;
    virtual void SAL_CALL
    setUserName( const OUString& UserName ) override;
 
    virtual sal_Bool SAL_CALL
    canSetPassword() override;
    virtual void SAL_CALL
    setPassword( const OUString& Password ) override;
 
    virtual css::uno::Sequence<
                css::ucb::RememberAuthentication > SAL_CALL
    getRememberPasswordModes(
            css::ucb::RememberAuthentication& Default ) override;
    virtual void SAL_CALL
    setRememberPassword( css::ucb::RememberAuthentication Remember ) override;
 
    virtual sal_Bool SAL_CALL
    canSetAccount() override;
    virtual void SAL_CALL
    setAccount( const OUString& Account ) override;
 
    virtual css::uno::Sequence< css::ucb::RememberAuthentication > SAL_CALL
    getRememberAccountModes(
            css::ucb::RememberAuthentication& Default ) override;
    virtual void SAL_CALL
    setRememberAccount( css::ucb::RememberAuthentication Remember ) override;
 
    // XInteractionSupplyAuthentication2
    virtual sal_Bool SAL_CALL canUseSystemCredentials( sal_Bool& Default ) override;
    virtual void SAL_CALL setUseSystemCredentials( sal_Bool UseSystemCredentials ) override;
 
    // Non-interface methods.
 
    const OUString & getRealm()    const { return m_aRealm; }
 
    const OUString & getUserName() const { return m_aUserName; }
 
    const OUString & getPassword() const { return m_aPassword; }
 
    const css::ucb::RememberAuthentication &
    getRememberPasswordMode() const { return m_eRememberPasswordMode; }
 
    bool getUseSystemCredentials() const { return m_bUseSystemCredentials; }
};
 
 
 
inline InteractionSupplyAuthentication::InteractionSupplyAuthentication(
    InteractionRequest * pRequest,
    bool bCanSetRealm,
    bool bCanSetUserName,
    bool bCanSetPassword,
    bool bCanSetAccount,
    const css::uno::Sequence< css::ucb::RememberAuthentication > & rRememberPasswordModes,
    const css::ucb::RememberAuthentication eDefaultRememberPasswordMode,
    const css::uno::Sequence< css::ucb::RememberAuthentication > & rRememberAccountModes,
    const css::ucb::RememberAuthentication eDefaultRememberAccountMode,
    bool bCanUseSystemCredentials )
: InteractionContinuation( pRequest ),
  m_aRememberPasswordModes( rRememberPasswordModes ),
  m_aRememberAccountModes( rRememberAccountModes ),
  m_eRememberPasswordMode( eDefaultRememberPasswordMode ),
  m_eDefaultRememberPasswordMode( eDefaultRememberPasswordMode ),
  m_eDefaultRememberAccountMode( eDefaultRememberAccountMode ),
  m_bCanSetRealm( bCanSetRealm ),
  m_bCanSetUserName( bCanSetUserName ),
  m_bCanSetPassword( bCanSetPassword ),
  m_bCanSetAccount( bCanSetAccount ),
  m_bCanUseSystemCredentials( bCanUseSystemCredentials ),
  m_bUseSystemCredentials( false )
{
}
 
 
class InteractionReplaceExistingData final :
                  public InteractionContinuation,
                  public css::lang::XTypeProvider,
                  public css::ucb::XInteractionReplaceExistingData
{
public:
    InteractionReplaceExistingData( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XTypeProvider
    virtual css::uno::Sequence< css::uno::Type > SAL_CALL
    getTypes() override;
    virtual css::uno::Sequence< sal_Int8 > SAL_CALL
    getImplementationId() override;
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
};
 
class UCBHELPER_DLLPUBLIC InteractionAuthFallback final :
                  public InteractionContinuation,
                  public css::ucb::XInteractionAuthFallback
{
    OUString m_aCode;
 
public:
    InteractionAuthFallback( InteractionRequest * pRequest )
    : InteractionContinuation( pRequest ) {}
 
    // XInterface
    virtual css::uno::Any SAL_CALL
    queryInterface( const css::uno::Type & rType ) override;
    virtual void SAL_CALL acquire() noexcept override
    { OWeakObject::acquire(); }
    virtual void SAL_CALL release() noexcept override
    { OWeakObject::release(); }
 
    // XInteractionContinuation
    virtual void SAL_CALL select() override;
 
    // XAuthFallback
    virtual void SAL_CALL setCode( const OUString& code ) override;
    const OUString& getCode() const;
 
 
};
 
 
} // namespace ucbhelper
 
#endif /* ! INCLUDED_UCBHELPER_INTERACTIONREQUEST_HXX */
 
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */