Mercurial > hg > orthanc

annotate OrthancFramework/Sources/HttpServer/HttpToolbox.h @ 5858:66fd63b8601e find-refactoring tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
StorageAccessOnFind: cont
author Alain Mazy <am@orthanc.team>
date Mon, 04 Nov 2024 22:34:14 +0100
parents f7adfb22e20e
children
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
5640
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
5 * Copyright (C) 2017-2023 Osimis S.A., Belgium
f7adfb22e20e updated copyright, as Orthanc Team now replaces Osimis
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
6 * Copyright (C) 2024-2024 Orthanc Team SRL, Belgium
5485
48b8dae6dc77 upgrade to year 2024
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5185
diff changeset
7 * Copyright (C) 2021-2024 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 *
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * 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
10 * 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
11 * 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
12 * the License, or (at your option) any later version.
136
fe180eae201d openssl exception
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 59
diff changeset
13 *
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * 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
15 * WITHOUT ANY WARRANTY; without even the implied warranty of
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * 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
17 * Lesser General Public License for more details.
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 *
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
19 * 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
20 * 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
21 * <http://www.gnu.org/licenses/>.
0
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
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 #pragma once
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
27 #include "../Compatibility.h"
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
28 #include "../OrthancFramework.h"
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
29 #include "../Toolbox.h"
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
30
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
31 #include <boost/noncopyable.hpp>
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
32 #include <map>
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
33 #include <vector>
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
59
c996319e90bc renaming in Core
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 50
diff changeset
35 namespace Orthanc
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 {
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
37 class IHttpHandler;
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
38
3992
f9863630ec7f working on the shared library for Orthanc framework
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
39 class ORTHANC_PUBLIC HttpToolbox : public boost::noncopyable
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 {
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 public:
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
42 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
43 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
44
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
45 static void ParseGetArguments(GetArguments& result,
912
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
46 const char* query);
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
47
dcb2469f00f4 PluginsHttpHandler::RestApiGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 901
diff changeset
48 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
49 GetArguments& getArguments,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
50 const char* query);
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
52 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
53 const std::string& name,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
54 const std::string& defaultValue);
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
55
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
56 static std::string GetArgument(const GetArguments& getArguments,
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
57 const std::string& name,
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58 const std::string& defaultValue);
330
78a8eaa5f30b cookies
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 324
diff changeset
59
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
60 static void ParseCookies(Arguments& result,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
61 const Arguments& httpHeaders);
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
62
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
63 static void CompileGetArguments(Arguments& compiled,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
64 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
65
4332
17d209a3f397 fix missing symbols for stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
66 #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
67 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
68 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
69 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
70 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
71 const Arguments& httpHeaders));
4332
17d209a3f397 fix missing symbols for stone
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
72
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
73 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
74 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
75 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
76 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
77 const void* bodyData,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
78 size_t bodySize,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
79 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
80
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
81 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
82 IHttpHandler& handler,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
83 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
84 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
85 const void* bodyData,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
86 size_t bodySize,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
87 const Arguments& httpHeaders));
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
88
4350
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
89 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
90 RequestOrigin origin,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
91 const std::string& uri,
e457c30970cf fix ORTHANC_DEPRECATED macro for C++14
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4332
diff changeset
92 const Arguments& httpHeaders));
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4329
diff changeset
93 #endif
0
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 };
3959d33612cc initial commit
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95 }