Mercurial > hg > orthanc

annotate Plugins/Samples/ServeFolders/Plugin.cpp @ 2199:feabd88c88e4

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
todo
author Sebastien Jodogne <s.jodogne@gmail.com>
date Sun, 04 Dec 2016 09:26:44 +0100
parents 11420238f337
children 395522e46b2b
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
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
5 *
1375
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
6 * 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
7 * 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
8 * 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
9 * License, or (at your option) any later version.
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
10 *
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
11 * 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
12 * 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
13 * 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
14 * General Public License for more details.
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 *
1375
3d76e26b3865 fix licensing terms of samples
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1323
diff changeset
16 * 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
17 * 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
18 **/
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
21 #include "../Common/OrthancPluginCppWrapper.h"
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
23 #include <json/reader.h>
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
24 #include <json/value.h>
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
25 #include <boost/filesystem.hpp>
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
26 #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
27
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
28
2176
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
29 #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
30 # 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
31 #endif
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
32
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
33
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
34
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 static OrthancPluginContext* context_ = NULL;
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
36 static std::map<std::string, std::string> extensions_;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
37 static std::map<std::string, std::string> folders_;
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
38 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
39 static bool allowCache_ = false;
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
40 static bool generateETag_ = true;
2061
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
41
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
42
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
43 static void SetHttpHeaders(OrthancPluginRestOutput* output)
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 if (!allowCache_)
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
46 {
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
47 // http://stackoverflow.com/a/2068407/881731
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
48 OrthancPluginSetHttpHeader(context_, output, "Cache-Control", "no-cache, no-store, must-revalidate");
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
49 OrthancPluginSetHttpHeader(context_, output, "Pragma", "no-cache");
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
50 OrthancPluginSetHttpHeader(context_, output, "Expires", "0");
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
51 }
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
52 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
53
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
54
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
55 static void RegisterDefaultExtensions()
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
56 {
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
57 extensions_["css"] = "text/css";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
58 extensions_["gif"] = "image/gif";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
59 extensions_["html"] = "text/html";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
60 extensions_["jpeg"] = "image/jpeg";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
61 extensions_["jpg"] = "image/jpeg";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
62 extensions_["js"] = "application/javascript";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
63 extensions_["json"] = "application/json";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
64 extensions_["nexe"] = "application/x-nacl";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
65 extensions_["nmf"] = "application/json";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
66 extensions_["pexe"] = "application/x-pnacl";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
67 extensions_["png"] = "image/png";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
68 extensions_["svg"] = "image/svg+xml";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
69 extensions_["woff"] = "application/x-font-woff";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
70 extensions_["xml"] = "application/xml";
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
71 }
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
72
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
73
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
74 static std::string GetMimeType(const std::string& path)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
75 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
76 size_t dot = path.find_last_of('.');
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
77
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
78 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
79 std::transform(extension.begin(), extension.end(), extension.begin(), tolower);
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
80
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
81 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
82
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
83 if (found != extensions_.end() &&
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
84 !found->second.empty())
1323
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 return found->second;
2061
8856f15b3e02 disabling cache in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1911
diff changeset
87 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
88 else
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
89 {
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
90 OrthancPlugins::LogWarning(context_, "ServeFolders: Unknown MIME type for extension \"" + extension + "\"");
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
91 return "application/octet-stream";
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
92 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
93 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
94
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
95
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
96 static bool LookupFolder(std::string& folder,
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
97 OrthancPluginRestOutput* output,
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
98 const OrthancPluginHttpRequest* request)
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
99 {
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
100 const std::string uri = request->groups[0];
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
101
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
102 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
103 if (found == folders_.end())
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
104 {
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
105 OrthancPlugins::LogError(context_, "Unknown URI in plugin server-folders: " + uri);
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
106 OrthancPluginSendHttpStatusCode(context_, output, 404);
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
107 return false;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
108 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
109 else
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
110 {
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
111 folder = found->second;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
112 return true;
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
113 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
114 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
115
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
116
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
117 static void Answer(OrthancPluginRestOutput* output,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
118 const char* content,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
119 size_t size,
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
120 const std::string& mime)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
121 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
122 if (generateETag_)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
123 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
124 OrthancPlugins::OrthancString md5(context_, OrthancPluginComputeMd5(context_, content, size));
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
125 std::string etag = "\"" + std::string(md5.GetContent()) + "\"";
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
126 OrthancPluginSetHttpHeader(context_, output, "ETag", etag.c_str());
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
127 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
128
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
129 SetHttpHeaders(output);
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
130 OrthancPluginAnswerBuffer(context_, output, content, size, mime.c_str());
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
131 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
132
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
133
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
134 void ServeFolder(OrthancPluginRestOutput* output,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
135 const char* url,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
136 const OrthancPluginHttpRequest* request)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
137 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
138 namespace fs = boost::filesystem;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
139
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
140 if (request->method != OrthancPluginHttpMethod_Get)
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
141 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
142 OrthancPluginSendMethodNotAllowed(context_, output, "GET");
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
143 return;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
144 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
145
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
146 std::string folder;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
147
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
148 if (LookupFolder(folder, output, request))
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
149 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
150 const fs::path item(request->groups[1]);
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
151 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
152
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
153 if (item.filename().string() == "index.html" &&
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
154 fs::is_directory(parent) &&
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
155 !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
156 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
157 // 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
158 std::string s;
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
159 s += "<html>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
160 s += " <body>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
161 s += " <ul>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
162
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
163 fs::directory_iterator end;
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
164
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
165 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
166 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
167 if (fs::is_directory(it->status()))
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
168 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
169 std::string f = it->path().filename().string();
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
170 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
171 }
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
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
174 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
175 {
1911
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
176 fs::file_type type = it->status().type();
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
177
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
178 if (type == fs::regular_file ||
7a05144cb919 fix issue 11
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1900
diff changeset
179 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
180 {
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
181 std::string f = it->path().filename().string();
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
182 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
183 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
184 }
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
185
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
186 s += " </ul>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
187 s += " </body>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
188 s += "</html>\n";
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
189
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
190 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
191 }
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
192 else
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
193 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
194 std::string path = folder + "/" + item.string();
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
195 std::string mime = GetMimeType(path);
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
196
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
197 OrthancPlugins::MemoryBuffer content(context_);
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
198
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
199 try
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
200 {
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
201 content.ReadFile(path);
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
202 }
2176
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
203 catch (...)
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
204 {
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
205 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_InexistentFile);
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
206 }
2062
40ffd0e8676a generation of etag in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2061
diff changeset
207
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
208 boost::posix_time::ptime lastModification = boost::posix_time::from_time_t(fs::last_write_time(path));
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
209 std::string t = boost::posix_time::to_iso_string(lastModification);
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
210 OrthancPluginSetHttpHeader(context_, output, "Last-Modified", t.c_str());
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
211
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
212 Answer(output, content.GetData(), content.GetSize(), mime);
1589
334d3a92ed83 improvements to the ServeFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1588
diff changeset
213 }
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
214 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
215 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
216
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
217
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
218 void ListServedFolders(OrthancPluginRestOutput* output,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
219 const char* url,
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
220 const OrthancPluginHttpRequest* request)
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
221 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
222 if (request->method != OrthancPluginHttpMethod_Get)
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
223 {
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
224 OrthancPluginSendMethodNotAllowed(context_, output, "GET");
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
225 return;
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
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
228 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
229
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
230 if (folders_.empty())
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
231 {
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
232 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
233 }
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
234 else
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
235 {
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
236 s += "<ul>\n";
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
237 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
238 it = folders_.begin(); it != folders_.end(); ++it)
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
239 {
1597
415dfd1d1c61 Improvements to the sample "ServeFolders" plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1589
diff changeset
240 // 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
241 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
242 }
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 += "</ul>\n";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
245 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
246
1434
f9cd40166269 refactoring of OrthancPlugins, improvement in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1425
diff changeset
247 s += "</body></html>\n";
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
248
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
249 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
250 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
251
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
252
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
253 static void ConfigureFolders(const Json::Value& folders)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
254 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
255 if (folders.type() != Json::objectValue)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
256 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
257 OrthancPlugins::LogError(context_, "The list of folders to be served is badly formatted (must be a JSON object)");
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
258 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_BadFileFormat);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
259 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
260
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
261 Json::Value::Members members = folders.getMemberNames();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
262
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
263 // Register the callback for each base URI
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
264 for (Json::Value::Members::const_iterator
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
265 it = members.begin(); it != members.end(); ++it)
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[*it].type() != Json::stringValue)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
268 {
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
269 OrthancPlugins::LogError(context_, "The folder to be served \"" + *it +
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
270 "\" must be associated with a string value (its mapped URI)");
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
271 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_BadFileFormat);
2167
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
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
274 std::string baseUri = *it;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
275
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
276 // 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
277 while (!baseUri.empty() &&
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
278 *baseUri.begin() == '/')
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
279 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
280 baseUri = baseUri.substr(1);
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
281 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
282
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
283 while (!baseUri.empty() &&
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
284 *baseUri.rbegin() == '/')
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 baseUri.resize(baseUri.size() - 1);
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
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
289 if (baseUri.empty())
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
290 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
291 OrthancPlugins::LogError(context_, "The URI of a folder to be served cannot be empty");
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
292 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_BadFileFormat);
2167
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 // 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
296 const std::string folder = folders[*it].asString();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
297 if (!boost::filesystem::is_directory(folder))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
298 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
299 OrthancPlugins::LogError(context_, "Trying and serve an inexistent folder: " + folder);
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
300 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_InexistentFile);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
301 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
302
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
303 folders_[baseUri] = folder;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
304
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
305 // Register the callback to serve the folder
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 const std::string regex = "/(" + baseUri + ")/(.*)";
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
308 OrthancPlugins::RegisterRestCallback<ServeFolder>(context_, regex.c_str(), true);
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
309 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
310 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
311 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
312
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
313
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
314 static void ConfigureExtensions(const Json::Value& extensions)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
315 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
316 if (extensions.type() != Json::objectValue)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
317 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
318 OrthancPlugins::LogError(context_, "The list of extensions is badly formatted (must be a JSON object)");
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
319 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_BadFileFormat);
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
320 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
321
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
322 Json::Value::Members members = extensions.getMemberNames();
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
323
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
324 for (Json::Value::Members::const_iterator
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
325 it = members.begin(); it != members.end(); ++it)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
326 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
327 if (extensions[*it].type() != Json::stringValue)
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
328 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
329 OrthancPlugins::LogError(context_, "The file extension \"" + *it +
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
330 "\" must be associated with a string value (its MIME type)");
2177
11420238f337 ORTHANC_PLUGINS_THROW_EXCEPTION macro
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2176
diff changeset
331 ORTHANC_PLUGINS_THROW_EXCEPTION(OrthancPluginErrorCode_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 const std::string& mime = extensions[*it].asString();
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 std::string name = *it;
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
337
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
338 if (!name.empty() &&
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
339 name[0] == '.')
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
340 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
341 name = name.substr(1); // Remove the leading dot "."
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
342 }
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
343
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
344 extensions_[name] = mime;
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 if (mime.empty())
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 OrthancPlugins::LogWarning(context_, "ServeFolders: Removing MIME type for file extension \"." + name + "\"");
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 else
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
351 {
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
352 OrthancPlugins::LogWarning(context_, "ServeFolders: Associating file extension \"." + name +
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
353 "\" with MIME type \"" + mime + "\"");
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 }
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
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
359 static void ReadConfiguration()
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
360 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
361 OrthancPlugins::OrthancConfiguration configuration;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
362
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
363 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
364 OrthancPlugins::OrthancConfiguration globalConfiguration(context_);
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
365 globalConfiguration.GetSection(configuration, "ServeFolders");
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
366 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
367
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
368 if (!configuration.IsSection("Folders"))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
369 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
370 // This is a basic configuration
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
371 ConfigureFolders(configuration.GetJson());
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
372 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
373 else
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
374 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
375 // This is an advanced configuration
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
376 ConfigureFolders(configuration.GetJson()["Folders"]);
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 bool tmp;
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
379
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
380 if (configuration.LookupBooleanValue(tmp, "AllowCache"))
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
381 {
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
382 allowCache_ = tmp;
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
383 OrthancPlugins::LogWarning(context_, "ServeFolders: Requesting the HTTP client to " +
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
384 std::string(tmp ? "enable" : "disable") +
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
385 " its caching mechanism");
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
386 }
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
387
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
388 if (configuration.LookupBooleanValue(tmp, "GenerateETag"))
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
389 {
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
390 generateETag_ = tmp;
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
391 OrthancPlugins::LogWarning(context_, "ServeFolders: The computation of an ETag for the served resources is " +
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
392 std::string(tmp ? "enabled" : "disabled"));
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
393 }
2169
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
394
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
395 OrthancPlugins::OrthancConfiguration extensions;
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
396 configuration.GetSection(extensions, "Extensions");
d15de5685ad8 ServeFolders: "Extensions" configuration option
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2168
diff changeset
397 ConfigureExtensions(extensions.GetJson());
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
398 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
399
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
400 if (folders_.empty())
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
401 {
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
402 OrthancPlugins::LogWarning(context_, "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
403 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
404 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
405
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
406
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
407 extern "C"
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
408 {
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
409 ORTHANC_PLUGINS_API int32_t OrthancPluginInitialize(OrthancPluginContext* context)
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
410 {
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
411 context_ = context;
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
412
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
413 /* Check the version of the Orthanc core */
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
414 if (OrthancPluginCheckVersion(context_) == 0)
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
415 {
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
416 char info[1024];
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
417 sprintf(info, "Your version of Orthanc (%s) must be above %d.%d.%d to run this plugin",
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
418 context_->orthancVersion,
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
419 ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER,
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
420 ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER,
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
421 ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER);
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
422 OrthancPluginLogError(context_, info);
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
423 return -1;
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
424 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
425
2166
700dbb3baac9 refactoring in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2062
diff changeset
426 RegisterDefaultExtensions();
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
427 OrthancPluginSetDescription(context_, "Serve additional folders with the HTTP server of Orthanc.");
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
428 OrthancPluginSetRootUri(context, INDEX_URI);
2168
84033563f7f0 ServeFolders: Better protection against exceptions in the callbacks
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2167
diff changeset
429 OrthancPlugins::RegisterRestCallback<ListServedFolders>(context_, INDEX_URI, true);
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
430
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
431 try
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
432 {
2167
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
433 ReadConfiguration();
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
434 }
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
435 catch (OrthancPlugins::PluginException& e)
aa2915963531 "Folders" sub-configuration in ServeFolders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2166
diff changeset
436 {
2176
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
437 OrthancPlugins::LogError(context_, "Error while initializing the ServeFolders plugin: " +
fead5549aaa7 introduction of HAS_ORTHANC_EXCEPTION to avoid PluginException if not necessary
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 2169
diff changeset
438 std::string(e.What(context_)));
1323
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
439 }
5a92665dee23 Sample plugin: Serve folders
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1322
diff changeset
440
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
441 return 0;
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
442 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
443
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
444
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
445 ORTHANC_PLUGINS_API void OrthancPluginFinalize()
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
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 ORTHANC_PLUGINS_API const char* OrthancPluginGetName()
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 return "serve-folders";
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
453 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
454
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
455
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
456 ORTHANC_PLUGINS_API const char* OrthancPluginGetVersion()
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
457 {
1391
b3119c32c920 version in ServerFolders plugin
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 1384
diff changeset
458 return SERVE_FOLDERS_VERSION;
1322
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
459 }
f497a72d9f71 fixes to the sample plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
460 }