1*9646dec5SDamjan Jovanovic /************************************************************** 2*9646dec5SDamjan Jovanovic * 3*9646dec5SDamjan Jovanovic * Licensed to the Apache Software Foundation (ASF) under one 4*9646dec5SDamjan Jovanovic * or more contributor license agreements. See the NOTICE file 5*9646dec5SDamjan Jovanovic * distributed with this work for additional information 6*9646dec5SDamjan Jovanovic * regarding copyright ownership. The ASF licenses this file 7*9646dec5SDamjan Jovanovic * to you under the Apache License, Version 2.0 (the 8*9646dec5SDamjan Jovanovic * "License"); you may not use this file except in compliance 9*9646dec5SDamjan Jovanovic * with the License. You may obtain a copy of the License at 10*9646dec5SDamjan Jovanovic * 11*9646dec5SDamjan Jovanovic * http://www.apache.org/licenses/LICENSE-2.0 12*9646dec5SDamjan Jovanovic * 13*9646dec5SDamjan Jovanovic * Unless required by applicable law or agreed to in writing, 14*9646dec5SDamjan Jovanovic * software distributed under the License is distributed on an 15*9646dec5SDamjan Jovanovic * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*9646dec5SDamjan Jovanovic * KIND, either express or implied. See the License for the 17*9646dec5SDamjan Jovanovic * specific language governing permissions and limitations 18*9646dec5SDamjan Jovanovic * under the License. 19*9646dec5SDamjan Jovanovic * 20*9646dec5SDamjan Jovanovic *************************************************************/ 21*9646dec5SDamjan Jovanovic 22*9646dec5SDamjan Jovanovic #ifndef INCLUDED_CURLREQUEST_HXX 23*9646dec5SDamjan Jovanovic #define INCLUDED_CURLREQUEST_HXX 24*9646dec5SDamjan Jovanovic 25*9646dec5SDamjan Jovanovic #include <vector> 26*9646dec5SDamjan Jovanovic #include "DAVException.hxx" 27*9646dec5SDamjan Jovanovic #include <com/sun/star/io/XOutputStream.hpp> 28*9646dec5SDamjan Jovanovic #include "CurlInputStream.hxx" 29*9646dec5SDamjan Jovanovic #include "CurlTypes.hxx" 30*9646dec5SDamjan Jovanovic #include "CurlUri.hxx" 31*9646dec5SDamjan Jovanovic #include <curl/curl.h> 32*9646dec5SDamjan Jovanovic 33*9646dec5SDamjan Jovanovic namespace http_dav_ucp 34*9646dec5SDamjan Jovanovic { 35*9646dec5SDamjan Jovanovic 36*9646dec5SDamjan Jovanovic /* Since Curl persists all settings for the duration of 37*9646dec5SDamjan Jovanovic * the CURL* structure, and we need some of them to only last for 38*9646dec5SDamjan Jovanovic * the duration of a request, use this class to reset the short-lived 39*9646dec5SDamjan Jovanovic * settings at the end of each request using RAII, and to capture 40*9646dec5SDamjan Jovanovic * some results in a convenient format. 41*9646dec5SDamjan Jovanovic * 42*9646dec5SDamjan Jovanovic * Features are opt-in to their non-default values. 43*9646dec5SDamjan Jovanovic * 44*9646dec5SDamjan Jovanovic * External pointers (CURL*, request body, etc.) are only shared with us, 45*9646dec5SDamjan Jovanovic * never copied, temporarily used by us, and never belong to us. 46*9646dec5SDamjan Jovanovic */ 47*9646dec5SDamjan Jovanovic class CurlRequest 48*9646dec5SDamjan Jovanovic { 49*9646dec5SDamjan Jovanovic public: 50*9646dec5SDamjan Jovanovic class Header 51*9646dec5SDamjan Jovanovic { 52*9646dec5SDamjan Jovanovic public: 53*9646dec5SDamjan Jovanovic rtl::OString name; 54*9646dec5SDamjan Jovanovic rtl::OString value; 55*9646dec5SDamjan Jovanovic }; 56*9646dec5SDamjan Jovanovic 57*9646dec5SDamjan Jovanovic CurlRequest( CURL *curl ); 58*9646dec5SDamjan Jovanovic ~CurlRequest(); 59*9646dec5SDamjan Jovanovic 60*9646dec5SDamjan Jovanovic // Request setup methods: 61*9646dec5SDamjan Jovanovic void addHeader( const rtl::OString &name, const rtl::OString &value ) throw (DAVException); 62*9646dec5SDamjan Jovanovic void setRequestBody( const char *body, size_t size ); isChunkedEncoding()63*9646dec5SDamjan Jovanovic bool isChunkedEncoding() { return useChunkedEncoding; } setChunkedEncoding(bool isChunkedEncoding)64*9646dec5SDamjan Jovanovic void setChunkedEncoding( bool isChunkedEncoding ) { useChunkedEncoding = isChunkedEncoding; } 65*9646dec5SDamjan Jovanovic void saveResponseBodyTo( const com::sun::star::uno::Reference< com::sun::star::io::XOutputStream > & xOutputStream ); 66*9646dec5SDamjan Jovanovic void setProvideCredentialsCallback( 67*9646dec5SDamjan Jovanovic bool (*provideCredsCallback)(long statusCode, void *userdata) throw (DAVException), 68*9646dec5SDamjan Jovanovic void *credsUserdata ); 69*9646dec5SDamjan Jovanovic 70*9646dec5SDamjan Jovanovic // Requests 71*9646dec5SDamjan Jovanovic CURLcode copy( CurlUri uri, rtl::OUString path ) throw(DAVException); 72*9646dec5SDamjan Jovanovic CURLcode delete_( CurlUri uri, rtl::OUString path ) throw(DAVException); 73*9646dec5SDamjan Jovanovic CURLcode get( CurlUri uri, rtl::OUString path ) throw(DAVException); 74*9646dec5SDamjan Jovanovic CURLcode head( CurlUri uri, rtl::OUString path ) throw(DAVException); 75*9646dec5SDamjan Jovanovic CURLcode lock( CurlUri uri, rtl::OUString path ) throw(DAVException); 76*9646dec5SDamjan Jovanovic CURLcode mkcol( CurlUri uri, rtl::OUString path ) throw(DAVException); 77*9646dec5SDamjan Jovanovic CURLcode move( CurlUri uri, rtl::OUString path ) throw(DAVException); 78*9646dec5SDamjan Jovanovic CURLcode post( CurlUri uri, rtl::OUString path ) throw(DAVException); 79*9646dec5SDamjan Jovanovic CURLcode propfind( CurlUri uri, rtl::OUString path ) throw(DAVException); 80*9646dec5SDamjan Jovanovic CURLcode proppatch( CurlUri uri, rtl::OUString path ) throw(DAVException); 81*9646dec5SDamjan Jovanovic CURLcode put( CurlUri uri, rtl::OUString path ) throw(DAVException); 82*9646dec5SDamjan Jovanovic CURLcode unlock( CurlUri uri, rtl::OUString path ) throw(DAVException); 83*9646dec5SDamjan Jovanovic 84*9646dec5SDamjan Jovanovic // Response methods: getStatusCode()85*9646dec5SDamjan Jovanovic int getStatusCode() { return statusCode; } getReasonPhrase()86*9646dec5SDamjan Jovanovic rtl::OString& getReasonPhrase() { return reasonPhrase; } 87*9646dec5SDamjan Jovanovic // TODO: a multimap would be O(n * log(m)) instead of O(n * m) getResponseHeaders()88*9646dec5SDamjan Jovanovic std::vector<Header>& getResponseHeaders() { return responseHeaders; } 89*9646dec5SDamjan Jovanovic const Header *findResponseHeader( const rtl::OString &name ); getResponseBody()90*9646dec5SDamjan Jovanovic com::sun::star::uno::Reference < CurlInputStream > getResponseBody() { return responseBodyInputStream; } 91*9646dec5SDamjan Jovanovic 92*9646dec5SDamjan Jovanovic private: 93*9646dec5SDamjan Jovanovic CurlRequest( const CurlRequest &curlRequest ); // No copy constructor. 94*9646dec5SDamjan Jovanovic void setURI( CurlUri uri, rtl::OUString path ) throw (DAVException); 95*9646dec5SDamjan Jovanovic CURLcode perform() throw (DAVException); 96*9646dec5SDamjan Jovanovic 97*9646dec5SDamjan Jovanovic static int Curl_SeekCallback(void *userp, curl_off_t offset, int origin); 98*9646dec5SDamjan Jovanovic 99*9646dec5SDamjan Jovanovic static size_t Curl_SendMoreBody( char *buffer, size_t size, size_t nitems, void *userdata ); 100*9646dec5SDamjan Jovanovic size_t curlSendMoreBody( char *buffer, size_t len ); 101*9646dec5SDamjan Jovanovic 102*9646dec5SDamjan Jovanovic static size_t Curl_HeaderReceived( char *buffer, size_t size, size_t nitems, void *userdata ); 103*9646dec5SDamjan Jovanovic void curlHeaderReceived( const char *buffer, size_t len ); 104*9646dec5SDamjan Jovanovic 105*9646dec5SDamjan Jovanovic static size_t Curl_MoreBodyReceived( char *buffer, size_t size, size_t nitems, void *userdata ); 106*9646dec5SDamjan Jovanovic void curlMoreBodyReceived( const char *buffer, size_t len ); 107*9646dec5SDamjan Jovanovic 108*9646dec5SDamjan Jovanovic CURL *curl; 109*9646dec5SDamjan Jovanovic CURLU *curlUrl; 110*9646dec5SDamjan Jovanovic 111*9646dec5SDamjan Jovanovic // Request values: 112*9646dec5SDamjan Jovanovic curl_slist *requestHeaders; 113*9646dec5SDamjan Jovanovic const char *requestBody; 114*9646dec5SDamjan Jovanovic size_t requestBodyOffset; 115*9646dec5SDamjan Jovanovic size_t requestBodySize; 116*9646dec5SDamjan Jovanovic bool useChunkedEncoding; 117*9646dec5SDamjan Jovanovic bool (*provideCredentialsCallback)( long statusCode, void *userdata ) throw (DAVException); 118*9646dec5SDamjan Jovanovic void *provideCredentialsUserdata; 119*9646dec5SDamjan Jovanovic 120*9646dec5SDamjan Jovanovic // Response values: 121*9646dec5SDamjan Jovanovic rtl::OString reasonPhrase; 122*9646dec5SDamjan Jovanovic int statusCode; 123*9646dec5SDamjan Jovanovic std::vector<Header> responseHeaders; 124*9646dec5SDamjan Jovanovic com::sun::star::uno::Reference < CurlInputStream > responseBodyInputStream; 125*9646dec5SDamjan Jovanovic com::sun::star::uno::Reference< com::sun::star::io::XOutputStream > xOutputStream; 126*9646dec5SDamjan Jovanovic }; 127*9646dec5SDamjan Jovanovic 128*9646dec5SDamjan Jovanovic } // namespace http_dav_ucp 129*9646dec5SDamjan Jovanovic 130*9646dec5SDamjan Jovanovic #endif // INCLUDED_CURLREQUEST_HXX