Exiv2
futils.hpp
1 // ***************************************************************** -*- C++ -*-
2 /*
3  * Copyright (C) 2004-2021 Exiv2 authors
4  * This program is part of the Exiv2 distribution.
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, 5th Floor, Boston, MA 02110-1301 USA.
19  */
20 #ifndef FUTILS_HPP_
21 #define FUTILS_HPP_
22 
23 #include "exiv2lib_export.h"
24 #include "config.h"
25 
26 #include <string>
27 
28 // namespace extensions
29 namespace Exiv2
30 {
32  enum EnVar
33  {
34  envHTTPPOST = 0,
35  envTIMEOUT = 1
36  };
38  enum Protocol
39  {
40  pFile = 0,
41  pHttp,
42  pFtp,
43  pHttps,
44  pSftp,
45  pSsh,
46  pFileUri,
47  pDataUri,
48  pStdin
49  };
50  // *********************************************************************
51  // free functions
58  EXIV2API std::string getEnv(int env_var);
59 
67  EXIV2API std::string urlencode(const char* str);
68 
78  EXIV2API char* urldecode(const char* str);
79 
84  EXIV2API void urldecode(std::string& str);
85 
97  EXIV2API int base64encode(const void* data_buf, size_t dataLength, char* result, size_t resultSize);
98 
108  EXIV2API long base64decode(const char* in, char* out, size_t out_size);
109 
115  EXIV2API Protocol fileProtocol(const std::string& path);
116 
117 #ifdef EXV_UNICODE_PATH
122  EXIV2API Protocol fileProtocol(const std::wstring& wpath);
123 #endif
124 
137  EXIV2API bool fileExists(const std::string& path, bool ct = false);
138 
139 #ifdef EXV_UNICODE_PATH
145  EXIV2API bool fileExists(const std::wstring& wpath, bool ct = false);
146 #endif
147 
154  EXIV2API std::string pathOfFileUrl(const std::string& url);
155 
156 #ifdef EXV_UNICODE_PATH
161  EXIV2API std::wstring pathOfFileUrl(const std::wstring& wurl);
162 #endif
163 
168  EXIV2API std::string strError();
169 
171  EXIV2API std::string getProcessPath();
172 
181  class Uri
182  {
183  public:
184  // DATA
185  std::string QueryString;
186  std::string Path;
187  std::string Protocol;
188  std::string Host;
189  std::string Port;
190  std::string Username;
191  std::string Password;
192 
194  static Uri EXIV2API Parse(const std::string& uri);
195 
197  static void EXIV2API Decode(Uri& uri);
198  };
199 
200 } // namespace Exiv2
201 
202 #endif // #ifndef FUTILS_HPP_
A container for URL components. It also provides the method to parse a URL to get the protocol,...
Definition: futils.hpp:182
std::string Host
URL host.
Definition: futils.hpp:188
static void EXIV2API Decode(Uri &uri)
Decode the url components.
Definition: futils.cpp:346
std::string Port
URL port.
Definition: futils.hpp:189
std::string Password
URL password.
Definition: futils.hpp:191
static Uri EXIV2API Parse(const std::string &uri)
Parse the input URL to the protocol, host, path, username, password.
Definition: futils.cpp:355
std::string Path
URL file path.
Definition: futils.hpp:186
std::string Username
URL username.
Definition: futils.hpp:190
std::string Protocol
URL protocol.
Definition: futils.hpp:187
std::string QueryString
URL query string.
Definition: futils.hpp:185
Provides classes and functions to encode and decode Exif and Iptc data. The libexiv2 API consists of ...
Definition: asfvideo.hpp:36
EXIV2API std::string urlencode(const char *str)
Encode the input url.
Definition: futils.cpp:94
Protocol
the collection of protocols.
Definition: futils.hpp:39
EnVar
the name of environmental variables.
Definition: futils.hpp:33
EXIV2API long base64decode(const char *in, char *out, size_t out_size)
Decode base64 data and put the resulting string in out.
Definition: futils.cpp:181
EXIV2API std::string getEnv(int env_var)
Return the value of environmental variable.
Definition: futils.cpp:74
EXIV2API bool fileExists(const std::string &path, bool ct=false)
Test if a file exists.
Definition: futils.cpp:271
EXIV2API char * urldecode(const char *str)
Decode the input url.
Definition: futils.cpp:115
EXIV2API int base64encode(const void *data_buf, size_t dataLength, char *result, size_t resultSize)
Encode in base64 the data in data_buf and put the resulting string in result.
Definition: futils.cpp:152
EXIV2API std::string pathOfFileUrl(const std::string &url)
Get the path of file URL.
Definition: futils.cpp:301
EXIV2API Protocol fileProtocol(const std::string &path)
Return the protocol of the path.
Definition: futils.cpp:221
EXIV2API std::string getProcessPath()
Return the path of the current process.
Definition: futils.cpp:434
EXIV2API std::string strError()
Return a system error message and the error code (errno). See strerror(3).
Definition: futils.cpp:316