Add an interaction handler wrapper for simple file access.
This wrapper is to be used when you want to avoid the error messages displayed when accessing a file (the messages activated by ucphelper::cancelCommandExecution), especially when accessing a Web/DAV connection to enable https certificate validation and optionally enabling the authentication dialog that may be needed in these operations. Change-Id: I19f3072b91b6c4f453a54b56a3d9883b3383dfa5 Reviewed-on: https://gerrit.libreoffice.org/24274 Tested-by: Jenkins <ci@libreoffice.org> Reviewed-by: Stephan Bergmann <sbergman@redhat.com>
This commit is contained in:
Giuseppe Castagno
Stephan Bergmann
parent
608b8cc54e
commit
bbe51f039d
3 changed files with 191 additions and 0 deletions
|
|
@ -111,6 +111,7 @@ $(eval $(call gb_Library_add_exception_objects,comphelper,\
|
|||
comphelper/source/misc/servicedecl \
|
||||
comphelper/source/misc/serviceinfohelper \
|
||||
comphelper/source/misc/sharedmutex \
|
||||
comphelper/source/misc/simplefileaccessinteraction \
|
||||
comphelper/source/misc/solarmutex \
|
||||
comphelper/source/misc/stillreadwriteinteraction \
|
||||
comphelper/source/misc/anycompare \
|
||||
|
|
|
|||
140
comphelper/source/misc/simplefileaccessinteraction.cxx
Normal file
140
comphelper/source/misc/simplefileaccessinteraction.cxx
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
/* -*- 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/.
|
||||
*/
|
||||
|
||||
#include <comphelper/simplefileaccessinteraction.hxx>
|
||||
#include <com/sun/star/task/XInteractionAbort.hpp>
|
||||
#include <com/sun/star/task/XInteractionApprove.hpp>
|
||||
#include <com/sun/star/ucb/AuthenticationRequest.hpp>
|
||||
#include <com/sun/star/ucb/CertificateValidationRequest.hpp>
|
||||
#include <com/sun/star/ucb/InteractiveIOException.hpp>
|
||||
#include <com/sun/star/ucb/InteractiveNetworkException.hpp>
|
||||
#include <com/sun/star/ucb/UnsupportedDataSinkException.hpp>
|
||||
|
||||
namespace comphelper {
|
||||
|
||||
/// Will handle com::sun::star::ucb::InteractiveIOException and derived classes
|
||||
static const sal_Int32 HANDLE_INTERACTIVEIOEXCEPTION = 0;
|
||||
/// Will handle com::sun::star::ucb::UnsupportedDataSinkException
|
||||
static const sal_Int32 HANDLE_UNSUPPORTEDDATASINKEXCEPTION = 1;
|
||||
/// Will handle com::sun::star::ucb::InteractiveNetworkException
|
||||
static const sal_Int32 HANDLE_INTERACTIVENETWORKEXCEPTION = 2;
|
||||
/// Will handle com::sun::star::ucb::CertificateValidationRequest
|
||||
static const sal_Int32 HANDLE_CERTIFICATEREQUEST = 3;
|
||||
/// Will handle com::sun::star::ucb::AuthenticationRequest
|
||||
static const sal_Int32 HANDLE_AUTHENTICATIONREQUEST = 4;
|
||||
|
||||
SimpleFileAccessInteraction::SimpleFileAccessInteraction(
|
||||
const css::uno::Reference< css::task::XInteractionHandler >& xHandler )
|
||||
{
|
||||
::std::vector< ::ucbhelper::InterceptedInteraction::InterceptedRequest > lInterceptions;
|
||||
::ucbhelper::InterceptedInteraction::InterceptedRequest aInterceptedRequest;
|
||||
|
||||
//intercept standard IO error exception (local file and WebDAV)
|
||||
aInterceptedRequest.Handle = HANDLE_INTERACTIVEIOEXCEPTION;
|
||||
aInterceptedRequest.Request <<= css::ucb::InteractiveIOException();
|
||||
aInterceptedRequest.Continuation = cppu::UnoType<css::task::XInteractionAbort>::get();
|
||||
aInterceptedRequest.MatchExact = false;
|
||||
lInterceptions.push_back(aInterceptedRequest);
|
||||
|
||||
//intercept internal error
|
||||
aInterceptedRequest.Handle = HANDLE_UNSUPPORTEDDATASINKEXCEPTION;
|
||||
aInterceptedRequest.Request <<= css::ucb::UnsupportedDataSinkException();
|
||||
aInterceptedRequest.Continuation = cppu::UnoType<css::task::XInteractionAbort>::get();
|
||||
aInterceptedRequest.MatchExact = false;
|
||||
lInterceptions.push_back(aInterceptedRequest);
|
||||
|
||||
//intercept network error exception (WebDAV ucp provider)
|
||||
aInterceptedRequest.Handle = HANDLE_INTERACTIVENETWORKEXCEPTION;
|
||||
aInterceptedRequest.Request <<= css::ucb::InteractiveNetworkException();
|
||||
aInterceptedRequest.Continuation = cppu::UnoType<css::task::XInteractionAbort>::get();
|
||||
aInterceptedRequest.MatchExact = false;
|
||||
lInterceptions.push_back(aInterceptedRequest);
|
||||
|
||||
//intercept certificate validation request (WebDAV ucp provider)
|
||||
aInterceptedRequest.Handle = HANDLE_CERTIFICATEREQUEST;
|
||||
aInterceptedRequest.Request <<= css::ucb::CertificateValidationRequest();
|
||||
aInterceptedRequest.Continuation = cppu::UnoType<css::task::XInteractionAbort>::get();
|
||||
aInterceptedRequest.MatchExact = false;
|
||||
lInterceptions.push_back(aInterceptedRequest);
|
||||
|
||||
//intercept authentication request (WebDAV ucp provider)
|
||||
aInterceptedRequest.Handle = HANDLE_AUTHENTICATIONREQUEST;
|
||||
aInterceptedRequest.Request <<= css::ucb::AuthenticationRequest();
|
||||
aInterceptedRequest.Continuation = cppu::UnoType<css::task::XInteractionApprove>::get();
|
||||
aInterceptedRequest.MatchExact = false;
|
||||
lInterceptions.push_back(aInterceptedRequest);
|
||||
|
||||
setInterceptedHandler(xHandler);
|
||||
setInterceptions(lInterceptions);
|
||||
}
|
||||
|
||||
SimpleFileAccessInteraction::~SimpleFileAccessInteraction()
|
||||
{
|
||||
}
|
||||
|
||||
ucbhelper::InterceptedInteraction::EInterceptionState SimpleFileAccessInteraction::intercepted(
|
||||
const ::ucbhelper::InterceptedInteraction::InterceptedRequest& aRequest,
|
||||
const css::uno::Reference< css::task::XInteractionRequest >& xRequest)
|
||||
{
|
||||
bool bAbort = false;
|
||||
switch(aRequest.Handle)
|
||||
{
|
||||
case HANDLE_UNSUPPORTEDDATASINKEXCEPTION:
|
||||
case HANDLE_INTERACTIVENETWORKEXCEPTION:
|
||||
case HANDLE_INTERACTIVEIOEXCEPTION:
|
||||
{
|
||||
bAbort = true;
|
||||
}
|
||||
break;
|
||||
|
||||
case HANDLE_CERTIFICATEREQUEST:
|
||||
{
|
||||
// use default internal handler.
|
||||
if (m_xInterceptedHandler.is())
|
||||
{
|
||||
m_xInterceptedHandler->handle(xRequest);
|
||||
return ::ucbhelper::InterceptedInteraction::E_INTERCEPTED;
|
||||
}
|
||||
else
|
||||
bAbort = true;
|
||||
break;
|
||||
}
|
||||
|
||||
case HANDLE_AUTHENTICATIONREQUEST:
|
||||
{
|
||||
// use default internal handler.
|
||||
if (m_xInterceptedHandler.is())
|
||||
{
|
||||
m_xInterceptedHandler->handle(xRequest);
|
||||
return ::ucbhelper::InterceptedInteraction::E_INTERCEPTED;
|
||||
}
|
||||
else //simply abort
|
||||
bAbort = true;
|
||||
}
|
||||
break;
|
||||
}
|
||||
|
||||
// handle interaction by ourself, by not doing
|
||||
// any selection...
|
||||
if (bAbort)
|
||||
{
|
||||
css::uno::Reference< css::task::XInteractionContinuation > xAbort =
|
||||
::ucbhelper::InterceptedInteraction::extractContinuation(
|
||||
xRequest->getContinuations(),
|
||||
cppu::UnoType<css::task::XInteractionAbort>::get() );
|
||||
if (!xAbort.is())
|
||||
return ::ucbhelper::InterceptedInteraction::E_NO_CONTINUATION_FOUND;
|
||||
return ::ucbhelper::InterceptedInteraction::E_INTERCEPTED;
|
||||
}
|
||||
|
||||
return ::ucbhelper::InterceptedInteraction::E_INTERCEPTED;
|
||||
}
|
||||
}
|
||||
|
||||
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
||||
50
include/comphelper/simplefileaccessinteraction.hxx
Normal file
50
include/comphelper/simplefileaccessinteraction.hxx
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
/* -*- 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/.
|
||||
*/
|
||||
|
||||
#ifndef INCLUDED_COMPHELPER_SIMPLEFILEACCESSINTERACTION_HXX
|
||||
#define INCLUDED_COMPHELPER_SIMPLEFILEACCESSINTERACTION_HXX
|
||||
|
||||
#include <sal/config.h>
|
||||
#include <ucbhelper/interceptedinteraction.hxx>
|
||||
#include <com/sun/star/task/XInteractionHandler.hpp>
|
||||
#include <comphelper/comphelperdllapi.h>
|
||||
|
||||
namespace comphelper {
|
||||
/** An interaction handler wrapper for simple file access.
|
||||
|
||||
This wrapper is to be used together with XSimpleFileAccess when
|
||||
you want to avoid the error messages displayed when accessing a file (the messages activated
|
||||
by ucphelper::cancelCommandExecution).
|
||||
|
||||
This wrapper is especially useful when you need to access a Web/DAV connection
|
||||
enabling https certificate validation and optionally enabling the authentication
|
||||
dialog that may be needed in these operations.
|
||||
|
||||
@param xHandler
|
||||
Used handler, always needed.
|
||||
It will be used for Certificate Validation dialog or authentication dialog.
|
||||
The authentication is used in Web/DAV access when the server requests credentials to be accessed.
|
||||
*/
|
||||
class COMPHELPER_DLLPUBLIC SimpleFileAccessInteraction : public ::ucbhelper::InterceptedInteraction
|
||||
{
|
||||
|
||||
public:
|
||||
SimpleFileAccessInteraction(const css::uno::Reference< css::task::XInteractionHandler >& xHandler);
|
||||
virtual ~SimpleFileAccessInteraction();
|
||||
|
||||
private:
|
||||
|
||||
virtual ucbhelper::InterceptedInteraction::EInterceptionState intercepted(const ::ucbhelper::InterceptedInteraction::InterceptedRequest& aRequest,
|
||||
const css::uno::Reference< css::task::XInteractionRequest >& xRequest) override;
|
||||
|
||||
};
|
||||
}
|
||||
#endif
|
||||
|
||||
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
||||
Loading…
Reference in a new issue