Adding upstream version 4:24.2.0.upstream/4%24.2.0

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

1 files changed, 305 insertions, 0 deletions

diff --git a/ucb/source/ucp/webdav-curl/webdavcontent.hxx b/ucb/source/ucp/webdav-curl/webdavcontent.hxx
new file mode 100644
index 0000000000..60661b8674
--- /dev/null
+++ b/ucb/source/ucp/webdav-curl/webdavcontent.hxx
@@ -0,0 +1,305 @@
+/* -*- 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 <memory>
+#include <list>
+#include <rtl/ref.hxx>
+#include <com/sun/star/ucb/ContentCreationException.hpp>
+#include <com/sun/star/ucb/XContentCreator.hpp>
+#include <ucbhelper/contenthelper.hxx>
+#include "DAVResourceAccess.hxx"
+#include "PropertyMap.hxx"
+
+namespace com::sun::star::beans {
+    struct Property;
+    struct PropertyValue;
+}
+
+namespace com::sun::star::io {
+    class XInputStream;
+}
+
+namespace com::sun::star::sdbc {
+    class XRow;
+}
+
+namespace com::sun::star::ucb {
+    struct OpenCommandArgument3;
+    struct PropertyCommandArgument;
+    struct PostCommandArgument2;
+    struct TransferInfo;
+}
+
+namespace http_dav_ucp
+{
+
+
+// UNO service name for the content.
+inline constexpr OUString WEBDAV_CONTENT_SERVICE_NAME = u"com.sun.star.ucb.WebDAVContent"_ustr;
+
+
+class ContentProvider;
+class ContentProperties;
+class CachableContentProperties;
+
+class Content : public ::ucbhelper::ContentImplHelper,
+                public css::ucb::XContentCreator
+{
+    enum ResourceType
+    {
+        UNKNOWN,    // the type of the Web resource is unknown
+        NOT_FOUND,  // the Web resource does not exists
+        NON_DAV,    // the Web resource exists but it's not DAV
+        DAV,        // the type of the Web resource is DAV with lock/unlock available
+        DAV_NOLOCK  // the type of the Web resource is DAV with no lock/unlock available
+    };
+
+    std::unique_ptr< DAVResourceAccess > m_xResAccess;
+    std::unique_ptr< CachableContentProperties > m_xCachedProps; // locally cached props
+    OUString     m_aEscapedTitle;
+    // resource type for general DAV methods
+    ResourceType      m_eResourceType;
+    // resource type for general LOCK method only
+    ResourceType      m_eResourceTypeForLocks;
+    ContentProvider*  m_pProvider; // No need for a ref, base class holds object
+    bool              m_bTransient;
+    bool const        m_bCollection;
+    bool              m_bDidGetOrHead;
+    std::vector< OUString > m_aFailedPropNames;
+    // Options Cache lifetime
+    // for web site implementing OPTIONS, but not dav
+    sal_uInt32 m_nOptsCacheLifeImplWeb;
+    // for WebDAV site where OPTIONS is mandatory
+    sal_uInt32 m_nOptsCacheLifeDAV;
+    // same as above, but when the resource is locked by us
+    sal_uInt32 m_nOptsCacheLifeDAVLocked;
+// For web site not implementing OPTIONS
+    // during this time we assume the site doesn't turn to WebDAV
+    // but remains a simple Web
+    sal_uInt32 m_nOptsCacheLifeNotImpl;
+    // When resource is not found
+    // may be the resource is unavailable only briefly?
+    // so better have this small
+    sal_uInt32 m_nOptsCacheLifeNotFound;
+
+    void initOptsCacheLifeTime();
+
+private:
+    virtual css::uno::Sequence< css::beans::Property >
+    getProperties( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv ) override;
+    virtual css::uno::Sequence< css::ucb::CommandInfo >
+    getCommands( const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv ) override;
+    virtual OUString getParentURL() override;
+
+    /// @throws css::uno::Exception
+    bool isFolder( const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
+
+    /// @throws css::uno::Exception
+    css::uno::Reference< css::sdbc::XRow >
+    getPropertyValues( const css::uno::Sequence< css::beans::Property >& rProperties,
+                       const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
+
+    /// @throws css::uno::Exception
+    css::uno::Sequence< css::uno::Any >
+    setPropertyValues( const css::uno::Sequence< css::beans::PropertyValue >& rValues,
+                       const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
+
+    typedef rtl::Reference< Content > ContentRef;
+    typedef std::vector< ContentRef > ContentRefList;
+    void queryChildren( ContentRefList& rChildren);
+
+    bool
+    exchangeIdentity( const css::uno::Reference< css::ucb::XContentIdentifier >& xNewId );
+
+    OUString
+    getBaseURI( const std::unique_ptr< DAVResourceAccess > & rResAccess );
+
+    /// @throws css::uno::Exception
+    ResourceType
+    getResourceType( const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv );
+
+    /// @throws css::uno::Exception
+    ResourceType
+    getResourceType( const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv,
+                     const std::unique_ptr< DAVResourceAccess > & rResAccess,
+                     bool * networkAccessAllowed = nullptr );
+
+    // Command "open"
+    /// @throws css::uno::Exception
+    css::uno::Any open(
+                const css::ucb::OpenCommandArgument3 & rArg,
+                const css::uno::Reference<
+                    css::ucb::XCommandEnvironment > & xEnv );
+
+    // Command "post"
+    /// @throws css::uno::Exception
+    void post( const css::ucb::PostCommandArgument2 & rArg,
+               const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv );
+
+    // Command "insert"
+    /// @throws css::uno::Exception
+    void insert( const css::uno::Reference< css::io::XInputStream > & xInputStream,
+                 bool bReplaceExisting,
+                 const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+
+    // Command "transfer"
+    /// @throws css::uno::Exception
+    void transfer( const css::ucb::TransferInfo & rArgs,
+                   const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+
+    // Command "delete"
+    /// @throws css::uno::Exception
+    void destroy( bool bDeletePhysical );
+
+    // Command "lock"
+    /// @throws css::uno::Exception
+    void lock( const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+
+    // Command "unlock"
+    /// @throws css::uno::Exception
+    void unlock( const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+
+    css::uno::Any MapDAVException( const DAVException & e,
+                                                bool bWrite );
+    /// @throws css::uno::Exception
+    void cancelCommandExecution(
+                    const DAVException & e,
+                    const css::uno::Reference< css::ucb::XCommandEnvironment > & xEnv,
+                    bool bWrite = false );
+
+    static bool shouldAccessNetworkAfterException( const DAVException & e );
+
+    ResourceType resourceTypeForLocks(
+        const css::uno::Reference< css::ucb::XCommandEnvironment >& rEnvironment,
+        const std::unique_ptr< DAVResourceAccess > & rResAccess );
+
+    ResourceType resourceTypeForLocks(
+        const css::uno::Reference< css::ucb::XCommandEnvironment >& rEnvironment );
+
+    // XPropertyContainer replacement
+    /// @throws css::beans::PropertyExistException
+    /// @throws css::beans::IllegalTypeException
+    /// @throws css::lang::IllegalArgumentException
+    /// @throws css::uno::RuntimeException
+    void addProperty( const css::ucb::PropertyCommandArgument &aCmdArg,
+                      const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+
+    /// @throws css::beans::PropertyExistException
+    /// @throws css::beans::NotRemoveableException
+    /// @throws css::uno::RuntimeException
+    void removeProperty( const OUString& Name,
+                         const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment );
+public:
+    /// @throws css::ucb::ContentCreationException
+    Content( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+             ContentProvider* pProvider,
+             const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier,
+             rtl::Reference< DAVSessionFactory > const & rSessionFactory );
+    /// @throws css::ucb::ContentCreationException
+    Content( const css::uno::Reference< css::uno::XComponentContext >& rxContext,
+             ContentProvider* pProvider,
+             const css::uno::Reference< css::ucb::XContentIdentifier >& Identifier,
+             rtl::Reference< DAVSessionFactory > const & rSessionFactory,
+             bool isCollection );
+    virtual ~Content() override;
+
+    // XInterface
+    virtual css::uno::Any SAL_CALL queryInterface( const css::uno::Type & rType ) override;
+    virtual void SAL_CALL acquire()
+        noexcept override;
+    virtual void SAL_CALL release()
+        noexcept override;
+
+    // XTypeProvider
+    virtual css::uno::Sequence< sal_Int8 > SAL_CALL getImplementationId() override;
+    virtual css::uno::Sequence< css::uno::Type > SAL_CALL getTypes() override;
+
+    // XServiceInfo
+    virtual OUString SAL_CALL
+    getImplementationName() override;
+
+    virtual css::uno::Sequence< OUString > SAL_CALL
+    getSupportedServiceNames() override;
+
+    // XContent
+    virtual OUString SAL_CALL
+    getContentType() override;
+
+    // XCommandProcessor
+    virtual css::uno::Any SAL_CALL
+    execute( const css::ucb::Command& aCommand,
+             sal_Int32 CommandId,
+             const css::uno::Reference< css::ucb::XCommandEnvironment >& Environment ) override;
+    virtual void SAL_CALL
+    abort( sal_Int32 CommandId ) override;
+
+    // XPropertyContainer
+    virtual void SAL_CALL
+    addProperty( const OUString& Name,
+                 sal_Int16 Attributes,
+                 const css::uno::Any& DefaultValue ) override;
+
+    virtual void SAL_CALL
+    removeProperty( const OUString& Name ) override;
+
+
+    // Additional interfaces
+
+
+    // XContentCreator
+    virtual css::uno::Sequence< css::ucb::ContentInfo > SAL_CALL
+   queryCreatableContentsInfo() override;
+    virtual css::uno::Reference< css::ucb::XContent > SAL_CALL
+    createNewContent( const css::ucb::ContentInfo& Info ) override;
+
+
+    // Non-interface methods.
+
+
+    DAVResourceAccess & getResourceAccess() { return *m_xResAccess; }
+
+    // Called from resultset data supplier.
+    static css::uno::Reference< css::sdbc::XRow >
+    getPropertyValues( const css::uno::Reference< css::uno::XComponentContext >& rContext,
+                       const css::uno::Sequence< css::beans::Property >& rProperties,
+                       const ContentProperties& rData,
+                       const rtl::Reference< ::ucbhelper::ContentProviderImplHelper >& rProvider,
+                       const OUString& rContentId );
+
+    /// Use OPTIONS method to retrieve the type of the Web resource
+    /// @throws css::uno::Exception
+    void getResourceOptions( const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv,
+                             DAVOptions& rDAVOptions,
+                             const std::unique_ptr< DAVResourceAccess > & rResAccess,
+                             bool * networkAccessAllowed = nullptr);
+
+    static bool isResourceAvailable( const css::uno::Reference< css::ucb::XCommandEnvironment >& xEnv,
+                             const std::unique_ptr< DAVResourceAccess > & rResAccess,
+                                     DAVOptions& rDAVOptions );
+
+    static void removeCachedPropertyNames( const OUString & rURL );
+
+};
+
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */