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  public:
68  VSIOSSHandleHelper(const CPLString &osSecretAccessKey,
69  const CPLString &osAccessKeyId,
70  const CPLString &osEndpoint, const CPLString &osBucket,
71  const CPLString &osObjectKey, bool bUseHTTPS,
72  bool bUseVirtualHosting);
73  ~VSIOSSHandleHelper();
74 
75  static VSIOSSHandleHelper *
76  BuildFromURI(const char *pszURI, const char *pszFSPrefix,
77  bool bAllowNoObject, CSLConstList papszOptions = nullptr);
78  static CPLString BuildURL(const CPLString &osEndpoint,
79  const CPLString &osBucket,
80  const CPLString &osObjectKey, bool bUseHTTPS,
81  bool bUseVirtualHosting);
82 
83  struct curl_slist *
84  GetCurlHeaders(const CPLString &osVerb,
85  const struct curl_slist *psExistingHeaders,
86  const void *pabyDataContent = nullptr,
87  size_t nBytesContent = 0) const override;
88 
89  bool CanRestartOnError(const char *, const char *pszHeaders,
90  bool bSetError) override;
91 
92  const CPLString &GetURL() const override
93  {
94  return m_osURL;
95  }
96  const CPLString &GetBucket() const
97  {
98  return m_osBucket;
99  }
100  const CPLString &GetObjectKey() const
101  {
102  return m_osObjectKey;
103  }
104  const CPLString &GetEndpoint() const
105  {
106  return m_osEndpoint;
107  }
108  bool GetVirtualHosting() const
109  {
110  return m_bUseVirtualHosting;
111  }
112 
113  CPLString GetCopySourceHeader() const override
114  {
115  return "x-oss-copy-source";
116  }
117 
118  void SetEndpoint(const CPLString &osStr);
119  void SetVirtualHosting(bool b);
120 
121  CPLString GetSignedURL(CSLConstList papszOptions);
122 };
123 
124 class VSIOSSUpdateParams
125 {
126  private:
127  CPLString m_osEndpoint{};
128 
129  explicit VSIOSSUpdateParams(const VSIOSSHandleHelper *poHelper)
130  : m_osEndpoint(poHelper->GetEndpoint())
131  {
132  }
133 
134  void UpdateHandlerHelper(VSIOSSHandleHelper *poHelper)
135  {
136  poHelper->SetEndpoint(m_osEndpoint);
137  }
138 
139  static std::mutex gsMutex;
140  static std::map<CPLString, VSIOSSUpdateParams> goMapBucketsToOSSParams;
141 
142  public:
143  VSIOSSUpdateParams() = default;
144 
145  static void UpdateMapFromHandle(VSIOSSHandleHelper *poHandleHelper);
146  static void UpdateHandleFromMap(VSIOSSHandleHelper *poHandleHelper);
147  static void ClearCache();
148 };
149 
150 #endif /* HAVE_CURL */
151 
152 #endif /* #ifndef DOXYGEN_SKIP */
153 
154 #endif /* CPL_ALIBABA_OSS_INCLUDED_H */
CPLString
Convenient string class based on std::string.
Definition: cpl_string.h:311
CSLConstList
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1178
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:1042