Mercurial > hg > orthanc

annotate OrthancFramework/Sources/HttpServer/HttpToolbox.h @ 4437:d9473bd5ed43

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
upgrade to year 2021
author Sebastien Jodogne <s.jodogne@gmail.com>
date Wed, 06 Jan 2021 17:27:28 +0100
parents e457c30970cf
children 7053502fbf97
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1780
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1288
6e7e5ed91c2d upgrade to year 2015
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 912
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4350
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
8 * modify it under the terms of the GNU Lesser General Public License
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
10 * the License, or (at your option) any later version.
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
11 *
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
15 * Lesser General Public License for more details.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
4119
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
17 * You should have received a copy of the GNU Lesser General Public
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
18 * License along with this program. If not, see
bf7b9edf6b81 re-licensing the OrthancFramework to LGPL, in order to license Stone of Orthanc under LGPL
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
19 * <http://www.gnu.org/licenses/>.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
25 #include "../Compatibility.h"
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
26 #include "../OrthancFramework.h"
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
27 #include "../Toolbox.h"
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
28
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
29 #include <boost/noncopyable.hpp>
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
30 #include <map>
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
31 #include <vector>
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
33 namespace Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34 {
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
35 class IHttpHandler;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
36
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
37 class ORTHANC_PUBLIC HttpToolbox : public boost::noncopyable
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
38 {
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39 public:
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
40 typedef std::map<std::string, std::string> Arguments;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
41 typedef std::vector< std::pair<std::string, std::string> > GetArguments;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
42
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
43 static void ParseGetArguments(GetArguments& result,
912
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
44 const char* query);
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
45
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
46 static void ParseGetQuery(UriComponents& uri,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
47 GetArguments& getArguments,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 const char* query);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
49
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
50 static std::string GetArgument(const Arguments& getArguments,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
51 const std::string& name,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
52 const std::string& defaultValue);
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
53
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
54 static std::string GetArgument(const GetArguments& getArguments,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55 const std::string& name,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 const std::string& defaultValue);
330
78a8eaa5f30b cookies
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 324
diff changeset
57
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
58 static void ParseCookies(Arguments& result,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
59 const Arguments& httpHeaders);
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
60
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
61 static void CompileGetArguments(Arguments& compiled,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
62 const GetArguments& source);
1363
feaf2840917c Plugins now receive duplicated GET arguments in their REST callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
63
4332
17d209a3f397 fix missing symbols for stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
64 #if (ORTHANC_ENABLE_MONGOOSE == 1 || ORTHANC_ENABLE_CIVETWEB == 1)
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
65 ORTHANC_DEPRECATED(static bool SimpleGet(std::string& result,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
66 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
67 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
68 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
69 const Arguments& httpHeaders));
4332
17d209a3f397 fix missing symbols for stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
70
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
71 ORTHANC_DEPRECATED(static bool SimplePost(std::string& result,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
72 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
73 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
74 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
75 const void* bodyData,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
76 size_t bodySize,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
77 const Arguments& httpHeaders));
1363
feaf2840917c Plugins now receive duplicated GET arguments in their REST callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1288
diff changeset
78
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
79 ORTHANC_DEPRECATED(static bool SimplePut(std::string& result,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
80 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
81 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
82 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
83 const void* bodyData,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
84 size_t bodySize,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
85 const Arguments& httpHeaders));
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
86
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
87 ORTHANC_DEPRECATED(static bool SimpleDelete(IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
88 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
89 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
90 const Arguments& httpHeaders));
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
91 #endif
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
92 };
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
93 }