Mercurial > hg > orthanc

annotate OrthancServer/Plugins/Samples/ServeFolders/Plugin.cpp @ 5561:0b18690c1935

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
author Alain Mazy <am@orthanc.team>
date Tue, 23 Apr 2024 09:34:02 +0200
parents 6ce05f8b5b13
children e02cdf358905
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
1900
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1628
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
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
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 *
1375
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
8 * This program is free software: you can redistribute it and/or
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
9 * modify it under the terms of the GNU General Public License as
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
10 * published by the Free Software Foundation, either version 3 of the
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
11 * License, or (at your option) any later version.
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
12 *
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
13 * This program is distributed in the hope that it will be useful, but
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
14 * WITHOUT ANY WARRANTY; without even the implied warranty of
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
16 * General Public License for more details.
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 *
1375
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
18 * You should have received a copy of the GNU General Public License
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
19 * along with this program. If not, see <http://www.gnu.org/licenses/>.
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20 **/
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
5538
6ce05f8b5b13 deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
23 #define SERVE_FOLDERS_NAME "serve-folders"
6ce05f8b5b13 deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
24
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
25 #include "../Common/OrthancPluginCppWrapper.h"
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
26 #include "../../../OrthancFramework/Sources/Logging.h"
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
27
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
28 #include <json/value.h>
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
29 #include <boost/filesystem.hpp>
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
30 #include <boost/date_time/posix_time/posix_time.hpp>
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
31
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32
2176
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
33 #if HAS_ORTHANC_EXCEPTION == 1
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
34 # error The macro HAS_ORTHANC_EXCEPTION must be set to 0 to compile this plugin
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
35 #endif
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
36
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
37
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
38
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
39 static std::map<std::string, std::string> extensions_;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
40 static std::map<std::string, std::string> folders_;
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
41 static const char* INDEX_URI = "/app/plugin-serve-folders.html";
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
42 static bool allowCache_ = false;
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
43 static bool generateETag_ = true;
2061
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
44
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
45
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
46 static void SetHttpHeaders(OrthancPluginRestOutput* output)
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
47 {
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
48 if (!allowCache_)
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
49 {
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
50 // http://stackoverflow.com/a/2068407/881731
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
51 OrthancPluginContext* context = OrthancPlugins::GetGlobalContext();
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
52 OrthancPluginSetHttpHeader(context, output, "Cache-Control", "no-cache, no-store, must-revalidate");
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
53 OrthancPluginSetHttpHeader(context, output, "Pragma", "no-cache");
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
54 OrthancPluginSetHttpHeader(context, output, "Expires", "0");
2061
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
55 }
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
56 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
57
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
58
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
59 static void RegisterDefaultExtensions()
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
60 {
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
61 extensions_["css"] = "text/css";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
62 extensions_["gif"] = "image/gif";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
63 extensions_["html"] = "text/html";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
64 extensions_["jpeg"] = "image/jpeg";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
65 extensions_["jpg"] = "image/jpeg";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
66 extensions_["js"] = "application/javascript";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
67 extensions_["json"] = "application/json";
4262
9a01e0f89b6d ServeFolders plugin: mime type for ".map" file extension
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4146
diff changeset
68 extensions_["map"] = "application/octet-stream"; // https://stackoverflow.com/a/19912684/881731
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
69 extensions_["nexe"] = "application/x-nacl";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
70 extensions_["nmf"] = "application/json";
4262
9a01e0f89b6d ServeFolders plugin: mime type for ".map" file extension
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4146
diff changeset
71 extensions_["pdf"] = "application/pdf";
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
72 extensions_["pexe"] = "application/x-pnacl";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
73 extensions_["png"] = "image/png";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
74 extensions_["svg"] = "image/svg+xml";
2433
b382879072a5 added application/wasm MIME type for WebAssembly
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2268
diff changeset
75 extensions_["wasm"] = "application/wasm";
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
76 extensions_["woff"] = "application/x-font-woff";
4262
9a01e0f89b6d ServeFolders plugin: mime type for ".map" file extension
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 4146
diff changeset
77 extensions_["woff2"] = "font/woff2";
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
78 extensions_["xml"] = "application/xml";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
79 }
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
80
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
81
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
82 static std::string GetMimeType(const std::string& path)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
83 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
84 size_t dot = path.find_last_of('.');
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
85
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
86 std::string extension = (dot == std::string::npos) ? "" : path.substr(dot + 1);
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
87 std::transform(extension.begin(), extension.end(), extension.begin(), tolower);
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
88
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
89 std::map<std::string, std::string>::const_iterator found = extensions_.find(extension);
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
90
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
91 if (found != extensions_.end() &&
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
92 !found->second.empty())
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
93 {
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
94 return found->second;
2061
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
95 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
96 else
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
97 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
98 LOG(WARNING) << "ServeFolders: Unknown MIME type for extension \"" << extension << "\"";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
99 return "application/octet-stream";
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
100 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
101 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
102
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
103
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
104 static bool LookupFolder(std::string& folder,
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
105 OrthancPluginRestOutput* output,
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
106 const OrthancPluginHttpRequest* request)
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
107 {
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
108 const std::string uri = request->groups[0];
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
109
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
110 std::map<std::string, std::string>::const_iterator found = folders_.find(uri);
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
111 if (found == folders_.end())
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
112 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
113 LOG(ERROR) << "Unknown URI in plugin server-folders: " << uri;
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
114 OrthancPluginSendHttpStatusCode(OrthancPlugins::GetGlobalContext(), output, 404);
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
115 return false;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
116 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
117 else
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
118 {
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
119 folder = found->second;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
120 return true;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
121 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
122 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
123
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
124
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
125 static void Answer(OrthancPluginRestOutput* output,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
126 const char* content,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
127 size_t size,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
128 const std::string& mime)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
129 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
130 if (generateETag_)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
131 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
132 OrthancPlugins::OrthancString md5;
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
133 md5.Assign(OrthancPluginComputeMd5(OrthancPlugins::GetGlobalContext(), content, size));
2205
395522e46b2b refactoring of the worklist sample using OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2177
diff changeset
134
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
135 std::string etag = "\"" + std::string(md5.GetContent()) + "\"";
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
136 OrthancPluginSetHttpHeader(OrthancPlugins::GetGlobalContext(), output, "ETag", etag.c_str());
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
137 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
138
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
139 SetHttpHeaders(output);
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
140 OrthancPluginAnswerBuffer(OrthancPlugins::GetGlobalContext(), output, content, size, mime.c_str());
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
141 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
142
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
143
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
144 void ServeFolder(OrthancPluginRestOutput* output,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
145 const char* url,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
146 const OrthancPluginHttpRequest* request)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
147 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
148 namespace fs = boost::filesystem;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
149
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
150 if (request->method != OrthancPluginHttpMethod_Get)
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
151 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
152 OrthancPluginSendMethodNotAllowed(OrthancPlugins::GetGlobalContext(), output, "GET");
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
153 return;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
154 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
155
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
156 std::string folder;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
157
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
158 if (LookupFolder(folder, output, request))
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
159 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
160 const fs::path item(request->groups[1]);
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
161 const fs::path parent((fs::path(folder) / item).parent_path());
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
162
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
163 if (item.filename().string() == "index.html" &&
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
164 fs::is_directory(parent) &&
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
165 !fs::is_regular_file(fs::path(folder) / item))
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
166 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
167 // On-the-fly generation of an "index.html"
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
168 std::string s;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
169 s += "<html>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
170 s += " <body>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
171 s += " <ul>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
172
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
173 fs::directory_iterator end;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
174
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
175 for (fs::directory_iterator it(parent) ; it != end; ++it)
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
176 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
177 if (fs::is_directory(it->status()))
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
178 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
179 std::string f = it->path().filename().string();
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
180 s += " <li><a href=\"" + f + "/index.html\">" + f + "/</a></li>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
181 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
182 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
183
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
184 for (fs::directory_iterator it(parent) ; it != end; ++it)
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
185 {
1911
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
186 fs::file_type type = it->status().type();
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
187
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
188 if (type == fs::regular_file ||
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
189 type == fs::reparse_file) // cf. BitBucket issue #11
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
190 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
191 std::string f = it->path().filename().string();
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
192 s += " <li><a href=\"" + f + "\">" + f + "</a></li>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
193 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
194 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
195
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
196 s += " </ul>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
197 s += " </body>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
198 s += "</html>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
199
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
200 Answer(output, s.c_str(), s.size(), "text/html");
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
201 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
202 else
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
203 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
204 std::string path = folder + "/" + item.string();
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
205 std::string mime = GetMimeType(path);
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
206
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
207 OrthancPlugins::MemoryBuffer content;
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
208
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
209 try
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
210 {
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
211 content.ReadFile(path);
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
212 }
2176
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
213 catch (...)
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
214 {
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
215 ORTHANC_PLUGINS_THROW_EXCEPTION(InexistentFile);
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
216 }
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
217
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
218 boost::posix_time::ptime lastModification =
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
219 boost::posix_time::from_time_t(fs::last_write_time(path));
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
220 std::string t = boost::posix_time::to_iso_string(lastModification);
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
221 OrthancPluginSetHttpHeader(OrthancPlugins::GetGlobalContext(),
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
222 output, "Last-Modified", t.c_str());
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
223
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
224 Answer(output, content.GetData(), content.GetSize(), mime);
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
225 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
226 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
227 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
228
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
229
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
230 void ListServedFolders(OrthancPluginRestOutput* output,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
231 const char* url,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
232 const OrthancPluginHttpRequest* request)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
233 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
234 if (request->method != OrthancPluginHttpMethod_Get)
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
235 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
236 OrthancPluginSendMethodNotAllowed(OrthancPlugins::GetGlobalContext(), output, "GET");
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
237 return;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
238 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
239
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
240 std::string s = "<html><body><h1>Additional folders served by Orthanc</h1>\n";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
241
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
242 if (folders_.empty())
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
243 {
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
244 s += "<p>Empty section <tt>ServeFolders</tt> in your configuration file: No additional folder is served.</p>\n";
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
245 }
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
246 else
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
247 {
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
248 s += "<ul>\n";
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
249 for (std::map<std::string, std::string>::const_iterator
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
250 it = folders_.begin(); it != folders_.end(); ++it)
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
251 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
252 // The URI is relative to INDEX_URI ("/app/plugin-serve-folders.html")
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
253 s += "<li><a href=\"../" + it->first + "/index.html\">" + it->first + "</li>\n";
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
254 }
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
255
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
256 s += "</ul>\n";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
257 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
258
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
259 s += "</body></html>\n";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
260
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
261 Answer(output, s.c_str(), s.size(), "text/html");
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
262 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
263
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
264
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
265 static void ConfigureFolders(const Json::Value& folders)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
266 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
267 if (folders.type() != Json::objectValue)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
268 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
269 LOG(ERROR) << "The list of folders to be served is badly formatted (must be a JSON object)";
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
270 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
271 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
272
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
273 Json::Value::Members members = folders.getMemberNames();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
274
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
275 // Register the callback for each base URI
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
276 for (Json::Value::Members::const_iterator
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
277 it = members.begin(); it != members.end(); ++it)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
278 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
279 if (folders[*it].type() != Json::stringValue)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
280 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
281 LOG(ERROR) << "The folder to be served \"" << *it <<
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
282 "\" must be associated with a string value (its mapped URI)";
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
283 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
284 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
285
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
286 std::string baseUri = *it;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
287
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
288 // Remove the heading and trailing slashes in the root URI, if any
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
289 while (!baseUri.empty() &&
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
290 *baseUri.begin() == '/')
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
291 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
292 baseUri = baseUri.substr(1);
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
293 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
294
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
295 while (!baseUri.empty() &&
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
296 *baseUri.rbegin() == '/')
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
297 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
298 baseUri.resize(baseUri.size() - 1);
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
299 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
300
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
301 if (baseUri.empty())
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
302 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
303 LOG(ERROR) << "The URI of a folder to be served cannot be empty";
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
304 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
305 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
306
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
307 // Check whether the source folder exists and is indeed a directory
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
308 const std::string folder = folders[*it].asString();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
309 if (!boost::filesystem::is_directory(folder))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
310 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
311 LOG(ERROR) << "Trying to serve an inexistent folder: " + folder;
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
312 ORTHANC_PLUGINS_THROW_EXCEPTION(InexistentFile);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
313 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
314
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
315 folders_[baseUri] = folder;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
316
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
317 // Register the callback to serve the folder
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
318 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
319 const std::string regex = "/(" + baseUri + ")/(.*)";
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
320 OrthancPlugins::RegisterRestCallback<ServeFolder>(regex.c_str(), true);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
321 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
322 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
323 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
324
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
325
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
326 static void ConfigureExtensions(const Json::Value& extensions)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
327 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
328 if (extensions.type() != Json::objectValue)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
329 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
330 LOG(ERROR) << "The list of extensions is badly formatted (must be a JSON object)";
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
331 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat);
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
332 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
333
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
334 Json::Value::Members members = extensions.getMemberNames();
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
335
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
336 for (Json::Value::Members::const_iterator
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
337 it = members.begin(); it != members.end(); ++it)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
338 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
339 if (extensions[*it].type() != Json::stringValue)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
340 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
341 LOG(ERROR) << "The file extension \"" << *it <<
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
342 "\" must be associated with a string value (its MIME type)";
2234
a78d15509a1c cleaner separation of PluginException
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2205
diff changeset
343 ORTHANC_PLUGINS_THROW_EXCEPTION(BadFileFormat);
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
344 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
345
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
346 const std::string& mime = extensions[*it].asString();
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
347
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
348 std::string name = *it;
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
349
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
350 if (!name.empty() &&
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
351 name[0] == '.')
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
352 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
353 name = name.substr(1); // Remove the leading dot "."
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
354 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
355
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
356 extensions_[name] = mime;
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
357
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
358 if (mime.empty())
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
359 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
360 LOG(WARNING) << "ServeFolders: Removing MIME type for file extension \"." << name << "\"";
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
361 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
362 else
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
363 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
364 LOG(WARNING) << "ServeFolders: Associating file extension \"." << name << "\" with MIME type \"" << mime << "\"";
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
365 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
366 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
367 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
368
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
369
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
370 static void ReadConfiguration()
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
371 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
372 OrthancPlugins::OrthancConfiguration configuration;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
373
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
374 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
375 OrthancPlugins::OrthancConfiguration globalConfiguration;
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
376 globalConfiguration.GetSection(configuration, "ServeFolders");
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
377 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
378
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
379 if (!configuration.IsSection("Folders"))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
380 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
381 // This is a basic configuration
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
382 ConfigureFolders(configuration.GetJson());
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
383 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
384 else
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
385 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
386 // This is an advanced configuration
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
387 ConfigureFolders(configuration.GetJson()["Folders"]);
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
388
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
389 bool tmp;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
390
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
391 if (configuration.LookupBooleanValue(tmp, "AllowCache"))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
392 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
393 allowCache_ = tmp;
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
394 LOG(WARNING) << "ServeFolders: Requesting the HTTP client to " << (tmp ? "enable" : "disable") << " its caching mechanism";
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
395 }
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
396
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
397 if (configuration.LookupBooleanValue(tmp, "GenerateETag"))
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
398 {
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
399 generateETag_ = tmp;
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
400 LOG(WARNING) << "ServeFolders: The computation of an ETag for the served resources is " << (tmp ? "enabled" : "disabled");
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
401 }
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
402
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
403 OrthancPlugins::OrthancConfiguration extensions;
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
404 configuration.GetSection(extensions, "Extensions");
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
405 ConfigureExtensions(extensions.GetJson());
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
406 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
407
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
408 if (folders_.empty())
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
409 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
410 LOG(WARNING) << "ServeFolders: Empty configuration file: No additional folder will be served!";
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
411 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
412 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
413
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
414
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
415 extern "C"
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
416 {
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
417 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* context)
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
419 OrthancPlugins::SetGlobalContext(context);
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421 /* Check the version of the Orthanc core */
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
422 if (OrthancPluginCheckVersion(context) == 0)
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
423 {
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
424 OrthancPlugins::ReportMinimalOrthancVersion(ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
2268
ce5c13b95dac New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
425 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
ce5c13b95dac New function: OrthancPluginRegisterIncomingHttpRequestFilter2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2244
diff changeset
426 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427 return -1;
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
428 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
429
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
430 RegisterDefaultExtensions();
5538
6ce05f8b5b13 deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
431 OrthancPluginSetDescription2(context, SERVE_FOLDERS_NAME, "Serve additional folders with the HTTP server of Orthanc.");
6ce05f8b5b13 deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
432 OrthancPluginSetRootUri2(context, SERVE_FOLDERS_NAME, INDEX_URI);
2958
bb7a66efbeb1 OrthancPlugins::SetGlobalContext() in OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2447
diff changeset
433 OrthancPlugins::RegisterRestCallback<ListServedFolders>(INDEX_URI, true);
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
434
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
435 try
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
436 {
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
437 ReadConfiguration();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
438 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
439 catch (OrthancPlugins::PluginException& e)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
440 {
5561
0b18690c1935 SDK: added OrthancPluginLogMessage to display plugin name + file and line from plugin
Alain Mazy <am@orthanc.team>
parents: 5538
diff changeset
441 LOG(ERROR) << "Error while initializing the ServeFolders plugin: " << e.What(context);
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
442 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
443
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
444 return 0;
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
445 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
446
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
447
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
448 ORTHANC_PLUGINS_API void OrthancPluginFinalize()
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
449 {
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
450 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
451
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
452
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
453 ORTHANC_PLUGINS_API const char* OrthancPluginGetName()
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
454 {
5538
6ce05f8b5b13 deprecating OrthancPluginSetDescription2(), OrthancPluginExtendOrthancExplorer2() and OrthancPluginSetRootUri2()
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 5485
diff changeset
455 return SERVE_FOLDERS_NAME;
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
456 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
457
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
458
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
459 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion()
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
460 {
1391
b3119c32c920 version in ServerFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1384
diff changeset
461 return SERVE_FOLDERS_VERSION;
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
462 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
463 }