annotate OrthancServer/Sources/OrthancHttpHandler.cpp @ 4831:7053502fbf97

added copyright UCLouvain
author Sebastien Jodogne <s.jodogne@gmail.com>
date Thu, 25 Nov 2021 19:01:11 +0100
parents d9473bd5ed43
children 2e71a08eea15 43e613a7756b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1571
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
4437
d9473bd5ed43 upgrade to year 2021
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4330
diff changeset
5 * Copyright (C) 2017-2021 Osimis S.A., Belgium
4831
7053502fbf97 added copyright UCLouvain
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4437
diff changeset
6 * Copyright (C) 2021-2021 Sebastien Jodogne, ICTEAM UCLouvain, Belgium
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * This program is free software: you can redistribute it and/or
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * modify it under the terms of the GNU General Public License as
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 * License, or (at your option) any later version.
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 *
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * In addition, as a special exception, the copyright holders of this
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * program give permission to link the code of its release with the
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * OpenSSL project's "OpenSSL" library (or with modified versions of it
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 * that use the same license as the "OpenSSL" library), and distribute
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * the linked executables. You must obey the GNU General Public License
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * in all respects for all of the code used other than "OpenSSL". If you
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 * modify file(s) with this exception, you may extend this exception to
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 * your version of the file(s), but you are not obligated to do so. If
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21 * you do not wish to do so, delete this exception statement from your
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 * version. If you delete this exception statement from all source files
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23 * in the program, then also delete it here.
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
24 *
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
25 * This program is distributed in the hope that it will be useful, but
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 * WITHOUT ANY WARRANTY; without even the implied warranty of
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28 * General Public License for more details.
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
29 *
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30 * You should have received a copy of the GNU General Public License
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 * along with this program. If not, see <http://www.gnu.org/licenses/>.
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 **/
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
33
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
34
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 #include "PrecompiledHeadersServer.h"
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 #include "OrthancHttpHandler.h"
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
37
4045
05b8fd21089c fix path
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4044
diff changeset
38 #include "../../OrthancFramework/Sources/OrthancException.h"
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
39
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 namespace Orthanc
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42 {
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
43 bool OrthancHttpHandler::CreateChunkedRequestReader(
3712
2a170a8f1faf replacing std::auto_ptr by std::unique_ptr
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3640
diff changeset
44 std::unique_ptr<IHttpHandler::IChunkedRequestReader>& target,
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
45 RequestOrigin origin,
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
46 const char* remoteIp,
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
47 const char* username,
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
48 HttpMethod method,
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
49 const UriComponents& uri,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
50 const HttpToolbox::Arguments& headers)
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
51 {
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
52 if (method != HttpMethod_Post &&
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
53 method != HttpMethod_Put)
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
54 {
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
55 throw OrthancException(ErrorCode_InternalError);
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
56 }
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
57
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
58 for (Handlers::const_iterator it = handlers_.begin(); it != handlers_.end(); ++it)
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
59 {
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
60 if ((*it)->CreateChunkedRequestReader
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
61 (target, origin, remoteIp, username, method, uri, headers))
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
62 {
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
63 if (target.get() == NULL)
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
64 {
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
65 throw OrthancException(ErrorCode_InternalError);
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
66 }
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
67
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
68 return true;
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
69 }
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
70 }
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
71
3414
b9cba6a91780 simplification
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3401
diff changeset
72 return false;
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
73 }
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
74
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
75
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 bool OrthancHttpHandler::Handle(HttpOutput& output,
1571
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
77 RequestOrigin origin,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
78 const char* remoteIp,
3232f1c995a5 provide the origin of the requests to HTTP handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1446
diff changeset
79 const char* username,
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 HttpMethod method,
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 const UriComponents& uri,
4330
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
82 const HttpToolbox::Arguments& headers,
a01b1c9cbef4 moving generic type definitions from IHttpHandler to HttpToolbox
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4045
diff changeset
83 const HttpToolbox::GetArguments& getArguments,
3401
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3395
diff changeset
84 const void* bodyData,
1446
8dc80ba768aa refactoring: IHttpHandler does not use std::string to hold the request body
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1445
diff changeset
85 size_t bodySize)
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 {
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
87 for (Handlers::const_iterator it = handlers_.begin(); it != handlers_.end(); ++it)
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 {
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
89 if ((*it)->Handle(output, origin, remoteIp, username, method, uri,
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
90 headers, getArguments, bodyData, bodySize))
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
91 {
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
92 return true;
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
93 }
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
94 }
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
3395
0ce9b4f5fdf5 new abstraction: IHttpHandler::CreateStreamHandler()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 3060
diff changeset
96 return false;
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
97 }
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
98
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
99
1443
895ab369d63c refactoring: OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1442
diff changeset
100 void OrthancHttpHandler::Register(IHttpHandler& handler,
895ab369d63c refactoring: OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1442
diff changeset
101 bool isOrthancRestApi)
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
102 {
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103 handlers_.push_back(&handler);
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
104
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
105 if (isOrthancRestApi)
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
106 {
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
107 orthancRestApi_ = &handler;
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
108 }
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
109 }
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
110
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
111
1445
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
112 IHttpHandler& OrthancHttpHandler::RestrictToOrthancRestApi(bool restrict)
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
113 {
1445
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
114 if (restrict)
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
115 {
1445
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
116 if (orthancRestApi_ == NULL)
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
117 {
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
118 throw OrthancException(ErrorCode_InternalError);
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
119 }
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
120
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
121 return *orthancRestApi_;
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
122 }
1445
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
123 else
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
124 {
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
125 return *this;
d26c8a93d05a refactoring: SimpleGet
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1443
diff changeset
126 }
1442
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
127 }
4ff8dd753d79 OrthancHttpHandler
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
128 }