Mercurial > hg > orthanc

annotate OrthancFramework/Sources/HttpServer/HttpToolbox.h @ 5639:b6a6179a2a69

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