Mercurial > hg > orthanc
annotate Core/HttpServer/MongooseServer.h @ 898:7000fc86fe62 plugins
improved plugin api
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Wed, 18 Jun 2014 09:18:28 +0200 |
| parents | 7e8cde5905fd |
| children | bb0a51561016 |
| rev | line source |
|---|---|
| 0 | 1 /** |
| 59 | 2 * Orthanc - A Lightweight, RESTful DICOM Store |
| 689 | 3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, |
| 0 | 4 * Belgium |
| 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 as | |
| 8 * published by the Free Software Foundation, either version 3 of the | |
| 9 * License, or (at your option) any later version. | |
| 136 | 10 * |
| 11 * In addition, as a special exception, the copyright holders of this | |
| 12 * program give permission to link the code of its release with the | |
| 13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
| 14 * that use the same license as the "OpenSSL" library), and distribute | |
| 15 * the linked executables. You must obey the GNU General Public License | |
| 16 * in all respects for all of the code used other than "OpenSSL". If you | |
| 17 * modify file(s) with this exception, you may extend this exception to | |
| 18 * your version of the file(s), but you are not obligated to do so. If | |
| 19 * you do not wish to do so, delete this exception statement from your | |
| 20 * version. If you delete this exception statement from all source files | |
| 21 * in the program, then also delete it here. | |
| 0 | 22 * |
| 23 * This program is distributed in the hope that it will be useful, but | |
| 24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
| 26 * General Public License for more details. | |
| 27 * | |
| 28 * You should have received a copy of the GNU General Public License | |
| 29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
| 30 **/ | |
| 31 | |
| 32 | |
| 33 #pragma once | |
| 34 | |
| 35 #include "HttpHandler.h" | |
| 36 | |
| 37 #include <list> | |
| 23 | 38 #include <map> |
| 217 | 39 #include <set> |
| 0 | 40 #include <stdint.h> |
| 41 #include <boost/shared_ptr.hpp> | |
| 42 | |
| 59 | 43 namespace Orthanc |
| 0 | 44 { |
| 45 class ChunkStore; | |
| 46 | |
|
409
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
47 class IIncomingHttpRequestFilter |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
48 { |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
49 public: |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
50 virtual ~IIncomingHttpRequestFilter() |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
51 { |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
52 } |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
53 |
|
473
c9a5d72f8481
changing the namespace of HTTP enumerations
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
409
diff
changeset
|
54 virtual bool IsAllowed(HttpMethod method, |
|
409
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
55 const char* uri, |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
56 const char* ip, |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
57 const char* username) const = 0; |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
58 }; |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
59 |
| 0 | 60 class MongooseServer |
| 61 { | |
| 62 private: | |
| 63 // http://stackoverflow.com/questions/311166/stdauto-ptr-or-boostshared-ptr-for-pimpl-idiom | |
| 64 struct PImpl; | |
| 65 boost::shared_ptr<PImpl> pimpl_; | |
| 66 | |
| 67 typedef std::list<HttpHandler*> Handlers; | |
| 68 Handlers handlers_; | |
| 69 | |
| 24 | 70 typedef std::set<std::string> RegisteredUsers; |
| 23 | 71 RegisteredUsers registeredUsers_; |
| 72 | |
|
34
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
73 bool remoteAllowed_; |
|
25
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
74 bool authentication_; |
| 23 | 75 bool ssl_; |
| 76 std::string certificate_; | |
| 0 | 77 uint16_t port_; |
|
409
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
78 IIncomingHttpRequestFilter* filter_; |
| 0 | 79 |
| 80 bool IsRunning() const; | |
| 81 | |
| 82 public: | |
| 83 MongooseServer(); | |
| 84 | |
| 85 ~MongooseServer(); | |
| 86 | |
| 128 | 87 void SetPortNumber(uint16_t port); |
| 0 | 88 |
| 128 | 89 uint16_t GetPortNumber() const |
| 0 | 90 { |
| 91 return port_; | |
| 92 } | |
| 93 | |
| 94 void Start(); | |
| 95 | |
| 96 void Stop(); | |
| 97 | |
|
25
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
98 void ClearUsers(); |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
99 |
| 23 | 100 void RegisterUser(const char* username, |
| 101 const char* password); | |
| 102 | |
| 0 | 103 void RegisterHandler(HttpHandler* handler); // This takes the ownership |
| 104 | |
|
25
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
105 bool IsAuthenticationEnabled() const |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
106 { |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
107 return authentication_; |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
108 } |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
109 |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
110 void SetAuthenticationEnabled(bool enabled); |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
111 |
| 23 | 112 bool IsSslEnabled() const |
| 113 { | |
| 114 return ssl_; | |
| 115 } | |
| 116 | |
| 117 void SetSslEnabled(bool enabled); | |
| 118 | |
| 119 const std::string& GetSslCertificate() const | |
| 120 { | |
| 121 return certificate_; | |
| 122 } | |
| 123 | |
| 124 void SetSslCertificate(const char* path); | |
| 125 | |
|
34
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
126 bool IsRemoteAccessAllowed() const |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
127 { |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
128 return remoteAllowed_; |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
129 } |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
130 |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
131 void SetRemoteAccessAllowed(bool allowed); |
|
96e57b863dd9
option to disallow remote access
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
25
diff
changeset
|
132 |
|
409
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
133 const IIncomingHttpRequestFilter* GetIncomingHttpRequestFilter() const |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
134 { |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
135 return filter_; |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
136 } |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
137 |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
138 void SetIncomingHttpRequestFilter(IIncomingHttpRequestFilter& filter); |
|
63f707278fc8
lua filtering of incoming http requests
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
398
diff
changeset
|
139 |
| 0 | 140 void ClearHandlers(); |
| 141 | |
|
895
7e8cde5905fd
allow superposition of REST handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
142 void FindHandlers(std::list<HttpHandler*>& result, |
|
7e8cde5905fd
allow superposition of REST handlers
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
689
diff
changeset
|
143 const UriComponents& forUri) const; |
| 0 | 144 |
| 145 ChunkStore& GetChunkStore(); | |
|
25
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
146 |
|
dd1489098265
basic http authentication
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
24
diff
changeset
|
147 bool IsValidBasicHttpAuthentication(const std::string& basic) const; |
| 0 | 148 }; |
| 149 } |