Mercurial > hg > orthanc-databases

annotate Framework/Plugins/PluginInitialization.cpp @ 127:3424a54ca2ee OrthancPostgreSQL-3.1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
fix performance warning
author Sebastien Jodogne <s.jodogne@gmail.com>
date Fri, 08 Feb 2019 19:54:13 +0100
parents f73050ad32b4
children 534759b0cf14
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
1 /**
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
2 * Orthanc - A Lightweight, RESTful DICOM Store
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
4 * Department, University Hospital of Liege, Belgium
67
714c5d2bee76 preparing for 2019
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 64
diff changeset
5 * Copyright (C) 2017-2019 Osimis S.A., Belgium
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
6 *
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
7 * This program is free software: you can redistribute it and/or
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
8 * modify it under the terms of the GNU Affero General Public License
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
9 * as published by the Free Software Foundation, either version 3 of
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
10 * the License, or (at your option) any later version.
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
11 *
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
12 * This program is distributed in the hope that it will be useful, but
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
13 * WITHOUT ANY WARRANTY; without even the implied warranty of
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
15 * Affero General Public License for more details.
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
16 *
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
17 * You should have received a copy of the GNU Affero General Public License
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
18 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
19 **/
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
20
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
21
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
22 #include "PluginInitialization.h"
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
23
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
24 #include "../Common/ImplicitTransaction.h"
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
25
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
26 #include <Core/Logging.h>
64
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
27 #include <Core/Toolbox.h>
62
eedd082355f9 fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 28
diff changeset
28 #include <Plugins/Samples/Common/OrthancPluginCppWrapper.h>
eedd082355f9 fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 28
diff changeset
29
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
30
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
31 namespace OrthancDatabases
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
32 {
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
33 static bool DisplayPerformanceWarning(const std::string& dbms,
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
34 bool isIndex)
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
35 {
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
36 (void) DisplayPerformanceWarning; // Disable warning about unused function
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
37 LOG(WARNING) << "Performance warning in " << dbms
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
38 << (isIndex ? " index" : " storage area")
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
39 << ": Non-release build, runtime debug assertions are turned on";
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
40 return true;
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
41 }
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
42
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
43
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
44 bool InitializePlugin(OrthancPluginContext* context,
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
45 const std::string& dbms,
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
46 bool isIndex)
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
47 {
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
48 Orthanc::Logging::Initialize(context);
62
eedd082355f9 fix for compatibility with simplified OrthancPluginCppWrapper
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 28
diff changeset
49 OrthancPlugins::SetGlobalContext(context);
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
50 ImplicitTransaction::SetErrorOnDoubleExecution(false);
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
51
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
52 assert(DisplayPerformanceWarning(dbms, isIndex));
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
53
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
54 /* Check the version of the Orthanc core */
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
55
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
56 bool useFallback = true;
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
57 bool isOptimal = false;
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
58
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
59 #if defined(ORTHANC_PLUGINS_VERSION_IS_ABOVE) // Macro introduced in Orthanc 1.3.1
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
60 # if ORTHANC_PLUGINS_VERSION_IS_ABOVE(1, 4, 0)
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
61 if (OrthancPluginCheckVersionAdvanced(context, 0, 9, 5) == 0)
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
62 {
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
63 LOG(ERROR) << "Your version of Orthanc (" << context->orthancVersion
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
64 << ") must be above 0.9.5 to run this plugin";
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
65 return false;
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
66 }
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
67
127
3424a54ca2ee fix performance warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 112
diff changeset
68 if (OrthancPluginCheckVersionAdvanced(context, 1, 5, 4) == 1)
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
69 {
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
70 ImplicitTransaction::SetErrorOnDoubleExecution(true);
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
71 isOptimal = true;
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
72 }
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
73
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
74 useFallback = false;
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
75 # endif
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
76 #endif
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
77
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
78 if (useFallback &&
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
79 OrthancPluginCheckVersion(context) == 0)
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
80 {
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
81 LOG(ERROR) << "Your version of Orthanc ("
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
82 << context->orthancVersion << ") must be above "
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
83 << ORTHANC_PLUGINS_MINIMAL_MAJOR_NUMBER << "."
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
84 << ORTHANC_PLUGINS_MINIMAL_MINOR_NUMBER << "."
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
85 << ORTHANC_PLUGINS_MINIMAL_REVISION_NUMBER
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
86 << " to run this plugin";
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
87 return false;
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
88 }
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
89
64
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
90 if (useFallback)
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
91 {
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
92 std::string v(context->orthancVersion);
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
93
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
94 if (v == "mainline")
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
95 {
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
96 isOptimal = true;
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
97 }
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
98 else
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
99 {
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
100 std::vector<std::string> tokens;
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
101 Orthanc::Toolbox::TokenizeString(tokens, v, '.');
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
102
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
103 if (tokens.size() != 3)
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
104 {
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
105 LOG(ERROR) << "Bad version of Orthanc: " << v;
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
106 return false;
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
107 }
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
108
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
109 int major = boost::lexical_cast<int>(tokens[0]);
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
110 int minor = boost::lexical_cast<int>(tokens[1]);
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
111 int revision = boost::lexical_cast<int>(tokens[2]);
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
112
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
113 isOptimal = (major > 1 ||
127
3424a54ca2ee fix performance warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 112
diff changeset
114 (major == 1 && minor > 5) ||
3424a54ca2ee fix performance warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 112
diff changeset
115 (major == 1 && minor == 5 && revision >= 4));
64
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
116 }
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
117 }
e39c1ebb7a0e fix in backwards compatibility
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 62
diff changeset
118
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
119 if (!isOptimal &&
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
120 isIndex)
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
121 {
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
122 LOG(WARNING) << "Performance warning in " << dbms
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
123 << " index: Your version of Orthanc ("
127
3424a54ca2ee fix performance warning
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 112
diff changeset
124 << context->orthancVersion << ") should be upgraded to 1.5.4 "
28
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
125 << "to benefit from best performance";
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
126 }
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
127
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
128
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
129 std::string description = ("Stores the Orthanc " +
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
130 std::string(isIndex ? "index" : "storage area") +
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
131 " into a " + dbms + " database");
c0cb5d2cd696 checks depending on Orthanc version
Sebastien Jodogne <s.jodogne@gmail.com>
parents: 24
diff changeset
132
24
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
133 OrthancPluginSetDescription(context, description.c_str());
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
134
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
135 return true;
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
136 }
17f849b2af34 sharing plugin initialization code
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
diff changeset
137 }