SerfRequestProcessor.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_UCB_SOURCE_UCP_WEBDAV_SERFREQUESTPROCESSOR_HXX
#define INCLUDED_UCB_SOURCE_UCP_WEBDAV_SERFREQUESTPROCESSOR_HXX

#include <apr_errno.h>
#include <apr_pools.h>

#include <serf.h>

#include "DAVTypes.hxx"
#include "DAVResource.hxx"
#include "DAVException.hxx"

#include "SerfInputStream.hxx"
#include <com/sun/star/io/XOutputStream.hpp>
#include <com/sun/star/ucb/Lock.hpp>

#include <rtl/ref.hxx>

namespace http_dav_ucp
{

class SerfSession;
class SerfRequestProcessorImpl;

class SerfRequestProcessor
{
public:
    SerfRequestProcessor( SerfSession& rSerfSession,
                          const OUString & inPath,
                          const bool bUseChunkedEncoding );
    ~SerfRequestProcessor();

    // PROPFIND - allprop & named
    bool processPropFind( const Depth inDepth,
                          const std::vector< OUString > & inPropNames,
                          std::vector< DAVResource > & ioResources,
                          apr_status_t& outSerfStatus );

    // PROPFIND - property names
    bool processPropFind( const Depth inDepth,
                          std::vector< DAVResourceInfo > & ioResInfo,
                          apr_status_t& outSerfStatus );

    // PROPPATCH
    bool processPropPatch( const std::vector< ProppatchValue > & inProperties,
                           apr_status_t& outSerfStatus );

    // GET
    bool processGet( const rtl::Reference< SerfInputStream >& xioInStrm,
                     apr_status_t& outSerfStatus );

    // GET inclusive header fields
    bool processGet( const rtl::Reference< SerfInputStream >& xioInStrm,
                     const std::vector< OUString > & inHeaderNames,
                     DAVResource & ioResource,
                     apr_status_t& outSerfStatus );

    // GET
    bool processGet( const css::uno::Reference< css::io::XOutputStream >& xioOutStrm,
                     apr_status_t& outSerfStatus );

    // GET inclusive header fields
    bool processGet( const css::uno::Reference< css::io::XOutputStream >& xioOutStrm,
                     const std::vector< OUString > & inHeaderNames,
                     DAVResource & ioResource,
                     apr_status_t& outSerfStatus );

    // HEAD
    bool processHead( const std::vector< OUString > & inHeaderNames,
                      DAVResource & ioResource,
                      apr_status_t& outSerfStatus );

    // PUT
    bool processPut( const char* inData,
                     apr_size_t inDataLen,
                     apr_status_t& outSerfStatus );

    // POST
    bool processPost( const char* inData,
                      apr_size_t inDataLen,
                      const OUString & inContentType,
                      const OUString & inReferer,
                      const rtl::Reference< SerfInputStream >& xioInStrm,
                      apr_status_t& outSerfStatus );

    // POST
    bool processPost( const char* inData,
                      apr_size_t inDataLen,
                      const OUString & inContentType,
                      const OUString & inReferer,
                      const css::uno::Reference< css::io::XOutputStream >& xioOutStrm,
                      apr_status_t& outSerfStatus );

    // DELETE
    bool processDelete( apr_status_t& outSerfStatus );

    // MKCOL
    bool processMkCol( apr_status_t& outSerfStatus );

    // COPY
    bool processCopy( const OUString & inDestinationPath,
                      const bool inOverwrite,
                      apr_status_t& outSerfStatus );

    // MOVE
    bool processMove( const OUString & inDestinationPath,
                      const bool inOverwrite,
                      apr_status_t& outSerfStatus );

    //LOCK
    bool processLock( const css::ucb::Lock & rLock, sal_Int32 *plastChanceToSendRefreshRequest = nullptr );

    //UNLOCK
    bool processUnlock();

    apr_status_t provideSerfCredentials( char ** outUsername,
                                         char ** outPassword,
                                         serf_request_t * inRequest,
                                         int inCode,
                                         const char *inAuthProtocol,
                                         const char *inRealm,
                                         apr_pool_t *inAprPool );

    apr_status_t setupSerfRequest( serf_request_t * inSerfRequest,
                                   serf_bucket_t ** outSerfRequestBucket,
                                   serf_response_acceptor_t * outSerfResponseAcceptor,
                                   void ** outSerfResponseAcceptorBaton,
                                   serf_response_handler_t * outSerfResponseHandler,
                                   void ** outSerfResponseHandlerBaton,
                                   apr_pool_t * inAprPool );

    serf_bucket_t* acceptSerfResponse( serf_request_t * inSerfRequest,
                                       serf_bucket_t * inSerfStreamBucket,
                                       apr_pool_t* inAprPool );

    apr_status_t handleSerfResponse( serf_request_t * inSerfRequest,
                                     serf_bucket_t * inSerfResponseBucket,
                                     apr_pool_t * inAprPool );

//private:
    void prepareProcessor();
    apr_status_t runProcessor();
    void postprocessProcessor( const apr_status_t inStatus );

    SerfSession& mrSerfSession;
    const char* mPathStr;
    const bool mbUseChunkedEncoding;
    const char* mDestPathStr;
    const char* mContentType;
    const char* mReferer;
    SerfRequestProcessorImpl* mpProcImpl;

    bool mbProcessingDone;

    DAVException* mpDAVException;
    sal_uInt16 mnHTTPStatusCode;
    OUString mHTTPStatusCodeText;
    OUString mRedirectLocation;

    sal_uInt8 mnSuccessfulCredentialAttempts;
    bool mbInputOfCredentialsAborted;
    bool mbSetupSerfRequestCalled;
    bool mbAcceptSerfResponseCalled;
    bool mbHandleSerfResponseCalled;
};

} // namespace http_dav_ucp

#endif // INCLUDED_UCB_SOURCE_UCP_WEBDAV_SERFREQUESTPROCESSOR_HXX

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