Mercurial > hg > orthanc-databases
annotate MySQL/Plugins/MySQLIndex.cpp @ 22:1e9bad493475
prevent running unit tests on a non-existing db
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Wed, 11 Jul 2018 14:39:59 +0200 |
parents | 9e419261f1c9 |
children | b2ff1cd2907a |
rev | line source |
---|---|
0 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2016 Sebastien Jodogne, Medical Physics | |
4 * Department, University Hospital of Liege, Belgium | |
5 * Copyright (C) 2017-2018 Osimis S.A., Belgium | |
6 * | |
7 * This program is free software: you can redistribute it and/or | |
8 * modify it under the terms of the GNU Affero General Public License | |
9 * as published by the Free Software Foundation, either version 3 of | |
10 * the License, or (at your option) any later version. | |
11 * | |
12 * This program is distributed in the hope that it will be useful, but | |
13 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
15 * Affero General Public License for more details. | |
16 * | |
17 * You should have received a copy of the GNU Affero General Public License | |
18 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
19 **/ | |
20 | |
21 | |
22 #include "MySQLIndex.h" | |
23 | |
24 #include "../../Framework/Plugins/GlobalProperties.h" | |
25 #include "../../Framework/MySQL/MySQLDatabase.h" | |
26 #include "../../Framework/MySQL/MySQLTransaction.h" | |
27 | |
28 #include <EmbeddedResources.h> // Auto-generated file | |
29 | |
30 #include <Core/Logging.h> | |
31 #include <Core/OrthancException.h> | |
32 | |
33 #include <ctype.h> | |
34 | |
35 namespace OrthancDatabases | |
36 { | |
37 IDatabase* MySQLIndex::OpenInternal() | |
38 { | |
39 uint32_t expectedVersion = 6; | |
40 if (context_) | |
41 { | |
42 expectedVersion = OrthancPluginGetExpectedDatabaseVersion(context_); | |
43 } | |
44 else | |
45 { | |
46 // This case only occurs during unit testing | |
47 expectedVersion = 6; | |
48 } | |
49 | |
50 // Check the expected version of the database | |
51 if (expectedVersion != 6) | |
52 { | |
53 LOG(ERROR) << "This database plugin is incompatible with your version of Orthanc " | |
54 << "expecting the DB schema version " << expectedVersion | |
55 << ", but this plugin is only compatible with version 6"; | |
56 throw Orthanc::OrthancException(Orthanc::ErrorCode_Plugin); | |
57 } | |
58 | |
59 if (parameters_.GetDatabase().empty()) | |
60 { | |
61 LOG(ERROR) << "Empty database name"; | |
62 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
63 } | |
64 | |
65 for (size_t i = 0; i < parameters_.GetDatabase().length(); i++) | |
66 { | |
67 if (!isalnum(parameters_.GetDatabase() [i])) | |
68 { | |
69 LOG(ERROR) << "Only alphanumeric characters are allowed in a " | |
70 << "MySQL database name: \"" << parameters_.GetDatabase() << "\""; | |
71 throw Orthanc::OrthancException(Orthanc::ErrorCode_ParameterOutOfRange); | |
72 } | |
73 } | |
74 | |
75 if (clearAll_) | |
76 { | |
77 MySQLParameters p = parameters_; | |
78 const std::string database = p.GetDatabase(); | |
79 p.SetDatabase(""); | |
80 | |
81 MySQLDatabase db(p); | |
82 db.Open(); | |
83 | |
84 MySQLTransaction t(db); | |
22
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
85 |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
86 if (!db.DoesDatabaseExist(t, database)) |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
87 { |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
88 LOG(ERROR) << "Inexistent database, please create it first: " << database; |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
89 throw Orthanc::OrthancException(Orthanc::ErrorCode_UnknownResource); |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
90 } |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
91 |
1e9bad493475
prevent running unit tests on a non-existing db
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
16
diff
changeset
|
92 db.Execute("DROP DATABASE " + database, false); |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
93 db.Execute("CREATE DATABASE " + database, false); |
0 | 94 t.Commit(); |
95 } | |
96 | |
97 std::auto_ptr<MySQLDatabase> db(new MySQLDatabase(parameters_)); | |
98 | |
99 db->Open(); | |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
100 |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
101 db->Execute("SET SESSION TRANSACTION ISOLATION LEVEL SERIALIZABLE", false); |
0 | 102 |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
103 if (parameters_.HasLock()) |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
104 { |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
105 db->AdvisoryLock(42 /* some arbitrary constant */); |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
106 } |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
107 |
0 | 108 { |
109 MySQLTransaction t(*db); | |
110 | |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
111 db->Execute("ALTER DATABASE " + parameters_.GetDatabase() + |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
112 " CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci", false); |
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
113 |
0 | 114 if (!db->DoesTableExist(t, "Resources")) |
115 { | |
116 std::string query; | |
117 | |
118 Orthanc::EmbeddedResources::GetFileResource | |
119 (query, Orthanc::EmbeddedResources::MYSQL_PREPARE_INDEX); | |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
120 db->Execute(query, true); |
0 | 121 |
122 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion, expectedVersion); | |
123 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, 1); | |
124 } | |
125 | |
126 if (!db->DoesTableExist(t, "Resources")) | |
127 { | |
128 LOG(ERROR) << "Corrupted MySQL database"; | |
129 throw Orthanc::OrthancException(Orthanc::ErrorCode_InternalError); | |
130 } | |
131 | |
132 int version = 0; | |
133 if (!LookupGlobalIntegerProperty(version, *db, t, Orthanc::GlobalProperty_DatabaseSchemaVersion) || | |
134 version != 6) | |
135 { | |
136 LOG(ERROR) << "PostgreSQL plugin is incompatible with database schema version: " << version; | |
137 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
138 } | |
139 | |
140 int revision; | |
141 if (!LookupGlobalIntegerProperty(revision, *db, t, Orthanc::GlobalProperty_DatabasePatchLevel)) | |
142 { | |
143 revision = 1; | |
144 SetGlobalIntegerProperty(*db, t, Orthanc::GlobalProperty_DatabasePatchLevel, revision); | |
145 } | |
146 | |
147 if (revision != 1) | |
148 { | |
149 LOG(ERROR) << "PostgreSQL plugin is incompatible with database schema revision: " << revision; | |
150 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
151 } | |
152 | |
16
9e419261f1c9
mysql storage area working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
153 t.Commit(); |
0 | 154 } |
155 | |
156 return db.release(); | |
157 } | |
158 | |
159 | |
160 MySQLIndex::MySQLIndex(const MySQLParameters& parameters) : | |
161 IndexBackend(new Factory(*this)), | |
162 context_(NULL), | |
163 parameters_(parameters), | |
164 clearAll_(false) | |
165 { | |
166 } | |
167 | |
168 | |
169 int64_t MySQLIndex::CreateResource(const char* publicId, | |
170 OrthancPluginResourceType type) | |
171 { | |
172 { | |
173 DatabaseManager::CachedStatement statement( | |
174 STATEMENT_FROM_HERE, GetManager(), | |
175 "INSERT INTO Resources VALUES(${}, ${type}, ${id}, NULL)"); | |
176 | |
177 statement.SetParameterType("id", ValueType_Utf8String); | |
178 statement.SetParameterType("type", ValueType_Integer64); | |
179 | |
180 Dictionary args; | |
181 args.SetUtf8Value("id", publicId); | |
182 args.SetIntegerValue("type", static_cast<int>(type)); | |
183 | |
184 statement.Execute(args); | |
185 } | |
186 | |
187 { | |
188 DatabaseManager::CachedStatement statement( | |
189 STATEMENT_FROM_HERE, GetManager(), | |
190 "SELECT LAST_INSERT_ID()"); | |
191 | |
192 statement.Execute(); | |
193 | |
194 return ReadInteger64(statement, 0); | |
195 } | |
196 } | |
197 | |
198 | |
199 void MySQLIndex::DeleteResource(int64_t id) | |
200 { | |
201 ClearDeletedFiles(); | |
202 | |
203 // Recursive exploration of resources to be deleted, from the "id" | |
204 // resource to the top of the tree of resources | |
205 | |
206 bool done = false; | |
207 | |
208 while (!done) | |
209 { | |
210 int64_t parentId; | |
211 | |
212 { | |
213 DatabaseManager::CachedStatement lookupSiblings( | |
214 STATEMENT_FROM_HERE, GetManager(), | |
215 "SELECT parentId FROM Resources " | |
216 "WHERE parentId = (SELECT parentId FROM Resources WHERE internalId=${id});"); | |
217 | |
218 lookupSiblings.SetParameterType("id", ValueType_Integer64); | |
219 | |
220 Dictionary args; | |
221 args.SetIntegerValue("id", id); | |
222 | |
223 lookupSiblings.Execute(args); | |
224 | |
225 if (lookupSiblings.IsDone()) | |
226 { | |
227 // "id" is a root node | |
228 done = true; | |
229 } | |
230 else | |
231 { | |
232 parentId = ReadInteger64(lookupSiblings, 0); | |
233 lookupSiblings.Next(); | |
234 | |
235 if (lookupSiblings.IsDone()) | |
236 { | |
237 // "id" has no sibling node, recursively remove | |
238 done = false; | |
239 id = parentId; | |
240 } | |
241 else | |
242 { | |
243 // "id" has at least one sibling node: the parent node is the remaining ancestor | |
244 done = true; | |
245 | |
246 DatabaseManager::CachedStatement parent( | |
247 STATEMENT_FROM_HERE, GetManager(), | |
248 "SELECT publicId, resourceType FROM Resources WHERE internalId=${id};"); | |
249 | |
250 parent.SetParameterType("id", ValueType_Integer64); | |
251 | |
252 Dictionary args; | |
253 args.SetIntegerValue("id", parentId); | |
254 | |
255 parent.Execute(args); | |
256 | |
257 GetOutput().SignalRemainingAncestor( | |
258 ReadString(parent, 0), | |
259 static_cast<OrthancPluginResourceType>(ReadInteger32(parent, 1))); | |
260 } | |
261 } | |
262 } | |
263 } | |
264 | |
265 { | |
266 DatabaseManager::CachedStatement deleteHierarchy( | |
267 STATEMENT_FROM_HERE, GetManager(), | |
268 "DELETE FROM Resources WHERE internalId IN (SELECT * FROM (SELECT internalId FROM Resources WHERE internalId=${id} OR parentId=${id} OR parentId IN (SELECT internalId FROM Resources WHERE parentId=${id}) OR parentId IN (SELECT internalId FROM Resources WHERE parentId IN (SELECT internalId FROM Resources WHERE parentId=${id}))) as t);"); | |
269 | |
270 deleteHierarchy.SetParameterType("id", ValueType_Integer64); | |
271 | |
272 Dictionary args; | |
273 args.SetIntegerValue("id", id); | |
274 | |
275 deleteHierarchy.Execute(args); | |
276 } | |
277 | |
278 SignalDeletedFiles(); | |
279 } | |
280 } |