GDAL
cpl_alibaba_oss.h
1 /**********************************************************************
2  * $Id$
3  *
4  * Name: cpl_alibaba_oss.h
5  * Project: CPL - Common Portability Library
6  * Purpose: Alibaba Cloud Object Storage Service
7  * Author: Even Rouault <even.rouault at spatialys.com>
8  *
9  **********************************************************************
10  * Copyright (c) 2017, Even Rouault <even.rouault at spatialys.com>
11  *
12  * Permission is hereby granted, free of charge, to any person obtaining a
13  * copy of this software and associated documentation files (the "Software"),
14  * to deal in the Software without restriction, including without limitation
15  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
16  * and/or sell copies of the Software, and to permit persons to whom the
17  * Software is furnished to do so, subject to the following conditions:
18  *
19  * The above copyright notice and this permission notice shall be included
20  * in all copies or substantial portions of the Software.
21  *
22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
23  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
25  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
27  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
28  * DEALINGS IN THE SOFTWARE.
29  ****************************************************************************/
30 
31 #ifndef CPL_ALIBABA_OSS_INCLUDED_H
32 #define CPL_ALIBABA_OSS_INCLUDED_H
33 
34 #ifndef DOXYGEN_SKIP
35 
36 #include <cstddef>
37 
38 #include "cpl_string.h"
39 
40 #ifdef HAVE_CURL
41 
42 #include <curl/curl.h>
43 #include <map>
44 #include "cpl_aws.h"
45 
46 class VSIOSSHandleHelper final: public IVSIS3LikeHandleHelper
47 {
48  CPL_DISALLOW_COPY_ASSIGN(VSIOSSHandleHelper)
49 
50  CPLString m_osURL{};
51  CPLString m_osSecretAccessKey{};
52  CPLString m_osAccessKeyId{};
53  CPLString m_osEndpoint{};
54  CPLString m_osBucket{};
55  CPLString m_osObjectKey{};
56  bool m_bUseHTTPS = false;
57  bool m_bUseVirtualHosting = false;
58 
59  void RebuildURL() override;
60 
61  static bool GetConfiguration(const std::string& osPathForOption,
62  CSLConstList papszOptions,
63  CPLString& osSecretAccessKey,
64  CPLString& osAccessKeyId);
65 
66  protected:
67 
68  public:
69  VSIOSSHandleHelper(const CPLString& osSecretAccessKey,
70  const CPLString& osAccessKeyId,
71  const CPLString& osEndpoint,
72  const CPLString& osBucket,
73  const CPLString& osObjectKey,
74  bool bUseHTTPS, bool bUseVirtualHosting);
75  ~VSIOSSHandleHelper();
76 
77  static VSIOSSHandleHelper* BuildFromURI(const char* pszURI,
78  const char* pszFSPrefix,
79  bool bAllowNoObject,
80  CSLConstList papszOptions = nullptr);
81  static CPLString BuildURL(const CPLString& osEndpoint,
82  const CPLString& osBucket,
83  const CPLString& osObjectKey,
84  bool bUseHTTPS, bool bUseVirtualHosting);
85 
86  struct curl_slist* GetCurlHeaders(
87  const CPLString& osVerb,
88  const struct curl_slist* psExistingHeaders,
89  const void *pabyDataContent = nullptr,
90  size_t nBytesContent = 0 ) const override;
91 
92  bool CanRestartOnError(const char*, const char* pszHeaders,
93  bool bSetError,
94  bool* pbUpdateMap = nullptr) override;
95 
96  const CPLString& GetURL() const override { return m_osURL; }
97  const CPLString& GetBucket() const { return m_osBucket; }
98  const CPLString& GetObjectKey() const { return m_osObjectKey; }
99  const CPLString& GetEndpoint()const { return m_osEndpoint; }
100  bool GetVirtualHosting() const { return m_bUseVirtualHosting; }
101 
102  CPLString GetCopySourceHeader() const override { return "x-oss-copy-source"; }
103 
104  void SetEndpoint(const CPLString &osStr);
105  void SetVirtualHosting(bool b);
106 
107  CPLString GetSignedURL(CSLConstList papszOptions);
108 };
109 
110 class VSIOSSUpdateParams
111 {
112  public:
113  CPLString m_osEndpoint{};
114 
115  VSIOSSUpdateParams() = default;
116 
117  explicit VSIOSSUpdateParams(const VSIOSSHandleHelper* poHelper) :
118  m_osEndpoint(poHelper->GetEndpoint()) {}
119 
120  void UpdateHandlerHelper(VSIOSSHandleHelper* poHelper) {
121  poHelper->SetEndpoint(m_osEndpoint);
122  }
123 };
124 
125 #endif /* HAVE_CURL */
126 
127 #endif /* #ifndef DOXYGEN_SKIP */
128 
129 #endif /* CPL_ALIBABA_OSS_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:319
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1053
cpl_string.h
CPL_DISALLOW_COPY_ASSIGN
#define CPL_DISALLOW_COPY_ASSIGN(ClassName)
Helper to remove the copy and assignment constructors so that the compiler will not generate the defa...
Definition: cpl_port.h:927