1
0
Fork 0
libreoffice/ucb/source/ucp/webdav-curl/DAVResourceAccess.hxx
Daniel Baumann 8e63e14cf6
Adding upstream version 4:25.2.3.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
2025-06-22 16:20:04 +02:00

219 lines
7.3 KiB
C++

/* -*- 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 .
*/
#pragma once
#include <vector>
#include <rtl/ustring.hxx>
#include <rtl/ref.hxx>
#include <osl/mutex.hxx>
#include <com/sun/star/io/XInputStream.hpp>
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/beans/NamedValue.hpp>
#include <com/sun/star/ucb/Lock.hpp>
#include <com/sun/star/ucb/XCommandEnvironment.hpp>
#include <com/sun/star/ucb/WebDAVHTTPMethod.hpp>
#include "DAVAuthListener.hxx"
#include "DAVException.hxx"
#include "DAVSession.hxx"
#include "DAVResource.hxx"
#include "DAVTypes.hxx"
#include "CurlUri.hxx"
namespace http_dav_ucp
{
class DAVSessionFactory;
class DAVResourceAccess
{
osl::Mutex m_aMutex;
OUString m_aURL;
OUString m_aPath;
css::uno::Sequence< css::beans::NamedValue > m_aFlags;
rtl::Reference< DAVSession > m_xSession;
rtl::Reference< DAVSessionFactory > m_xSessionFactory;
css::uno::Reference< css::uno::XComponentContext > m_xContext;
std::vector<CurlUri> m_aRedirectURIs;
public:
DAVResourceAccess() = default;
DAVResourceAccess( css::uno::Reference< css::uno::XComponentContext > xContext,
rtl::Reference< DAVSessionFactory > xSessionFactory,
OUString aURL );
DAVResourceAccess( const DAVResourceAccess & rOther );
DAVResourceAccess & operator=( const DAVResourceAccess & rOther );
/// @throws DAVException
void setFlags( const css::uno::Sequence< css::beans::NamedValue >& rFlags );
/// @throws DAVException
void setURL( const OUString & rNewURL );
void resetUri();
const OUString & getURL() const { return m_aURL; }
const rtl::Reference< DAVSessionFactory > & getSessionFactory() const
{ return m_xSessionFactory; }
// DAV methods
/// @throws DAVException
void
OPTIONS(
DAVOptions & rOptions,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
// allprop & named
/// @throws DAVException
void
PROPFIND( const Depth nDepth,
const std::vector< OUString > & rPropertyNames,
std::vector< DAVResource > & rResources,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
// propnames
/// @throws DAVException
void
PROPFIND( const Depth nDepth,
std::vector< DAVResourceInfo > & rResInfo,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
PROPPATCH( const std::vector< ProppatchValue > & rValues,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
/// @throws DAVException
void
HEAD( const std::vector< OUString > & rHeaderNames, // empty == 'all'
DAVResource & rResource,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
/// @throws DAVException
css::uno::Reference< css::io::XInputStream >
GET( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
GET( css::uno::Reference< css::io::XOutputStream > & rStream,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
css::uno::Reference< css::io::XInputStream >
GET( const std::vector< OUString > & rHeaderNames, // empty == 'all'
DAVResource & rResource,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// used as HEAD substitute when HEAD is not implemented on server
/// @throws DAVException
void
GET0( DAVRequestHeaders & rRequestHeaders,
const std::vector< OUString > & rHeaderNames, // empty == 'all'
DAVResource & rResource,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
GET( css::uno::Reference< css::io::XOutputStream > & rStream,
const std::vector< OUString > & rHeaderNames, // empty == 'all'
DAVResource & rResource,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
PUT( const css::uno::Reference< css::io::XInputStream > & rStream,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
css::uno::Reference< css::io::XInputStream >
POST( const OUString & rContentType,
const OUString & rReferer,
const css::uno::Reference< css::io::XInputStream > & rInputStream,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
/// @throws DAVException
void
POST( const OUString & rContentType,
const OUString & rReferer,
const css::uno::Reference< css::io::XInputStream > & rInputStream,
css::uno::Reference< css::io::XOutputStream > & rOutputStream,
const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
/// @throws DAVException
void
MKCOL( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
COPY( const OUString & rSourcePath,
const OUString & rDestinationURI,
bool bOverwrite,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
MOVE( const OUString & rSourcePath,
const OUString & rDestinationURI,
bool bOverwrite,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
DESTROY( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
// set new lock.
/// @throws DAVException
void
LOCK( css::ucb::Lock & inLock,
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
UNLOCK( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
/// @throws DAVException
void
abort();
// helper
static void
getUserRequestHeaders(
const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv,
const OUString & rURI,
css::ucb::WebDAVHTTPMethod eMethod,
DAVRequestHeaders & rRequestHeaders );
/// @throws DAVException
bool handleException(DAVException const& e, int errorCount);
private:
const OUString & getRequestURI() const;
/// @throws DAVException
bool detectRedirectCycle(::std::u16string_view rRedirectURL);
/// @throws DAVException
void initialize();
};
} // namespace http_dav_ucp
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */