Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLDatabase.cpp @ 28:c0cb5d2cd696
checks depending on Orthanc version
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Mon, 16 Jul 2018 14:48:43 +0200 |
parents | b2ff1cd2907a |
children | 2fb9cd42af14 |
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 "PostgreSQLDatabase.h" | |
23 | |
24 #include "PostgreSQLResult.h" | |
25 #include "PostgreSQLStatement.h" | |
26 #include "PostgreSQLTransaction.h" | |
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
27 #include "../Common/ImplicitTransaction.h" |
0 | 28 |
29 #include <Core/Logging.h> | |
30 #include <Core/OrthancException.h> | |
31 | |
32 #include <boost/lexical_cast.hpp> | |
33 | |
34 // PostgreSQL includes | |
35 #include <libpq-fe.h> | |
36 #include <c.h> | |
37 #include <catalog/pg_type.h> | |
38 | |
39 | |
40 namespace OrthancDatabases | |
41 { | |
42 void PostgreSQLDatabase::ThrowException(bool log) | |
43 { | |
44 if (log) | |
45 { | |
46 LOG(ERROR) << "PostgreSQL error: " | |
47 << PQerrorMessage(reinterpret_cast<PGconn*>(pg_)); | |
48 } | |
49 | |
50 if (PQstatus(reinterpret_cast<PGconn*>(pg_)) == CONNECTION_OK) | |
51 { | |
52 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); | |
53 } | |
54 else | |
55 { | |
56 throw Orthanc::OrthancException(Orthanc::ErrorCode_DatabaseUnavailable); | |
57 } | |
58 } | |
59 | |
60 | |
61 void PostgreSQLDatabase::Close() | |
62 { | |
63 if (pg_ != NULL) | |
64 { | |
65 LOG(INFO) << "Closing connection to PostgreSQL"; | |
66 PQfinish(reinterpret_cast<PGconn*>(pg_)); | |
67 pg_ = NULL; | |
68 } | |
69 } | |
70 | |
71 | |
72 void PostgreSQLDatabase::Open() | |
73 { | |
74 if (pg_ != NULL) | |
75 { | |
76 // Already connected | |
77 return; | |
78 } | |
79 | |
80 std::string s; | |
81 parameters_.Format(s); | |
82 | |
83 pg_ = PQconnectdb(s.c_str()); | |
84 | |
85 if (pg_ == NULL || | |
86 PQstatus(reinterpret_cast<PGconn*>(pg_)) != CONNECTION_OK) | |
87 { | |
88 std::string message; | |
89 | |
90 if (pg_) | |
91 { | |
92 message = PQerrorMessage(reinterpret_cast<PGconn*>(pg_)); | |
93 PQfinish(reinterpret_cast<PGconn*>(pg_)); | |
94 pg_ = NULL; | |
95 } | |
96 | |
97 LOG(ERROR) << "PostgreSQL error: " << message; | |
98 throw Orthanc::OrthancException(Orthanc::ErrorCode_DatabaseUnavailable); | |
99 } | |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
100 } |
0 | 101 |
102 | |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
103 void PostgreSQLDatabase::AdvisoryLock(int32_t lock) |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
104 { |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
105 PostgreSQLTransaction transaction(*this); |
0 | 106 |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
107 PostgreSQLStatement s(*this, "select pg_try_advisory_lock(" + |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
108 boost::lexical_cast<std::string>(lock) + ");"); |
0 | 109 |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
110 PostgreSQLResult result(s); |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
111 if (result.IsDone() || |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
112 !result.GetBoolean(0)) |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
113 { |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
114 LOG(ERROR) << "The PostgreSQL database is locked by another instance of Orthanc"; |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
115 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
116 } |
0 | 117 |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
118 transaction.Commit(); |
0 | 119 } |
120 | |
121 | |
122 void PostgreSQLDatabase::Execute(const std::string& sql) | |
123 { | |
124 LOG(TRACE) << "PostgreSQL: " << sql; | |
125 Open(); | |
126 | |
127 PGresult* result = PQexec(reinterpret_cast<PGconn*>(pg_), sql.c_str()); | |
128 if (result == NULL) | |
129 { | |
130 ThrowException(true); | |
131 } | |
132 | |
133 bool ok = (PQresultStatus(result) == PGRES_COMMAND_OK || | |
134 PQresultStatus(result) == PGRES_TUPLES_OK); | |
135 | |
136 if (ok) | |
137 { | |
138 PQclear(result); | |
139 } | |
140 else | |
141 { | |
142 std::string message = PQresultErrorMessage(result); | |
143 PQclear(result); | |
144 | |
145 LOG(ERROR) << "PostgreSQL error: " << message; | |
146 ThrowException(false); | |
147 } | |
148 } | |
149 | |
150 | |
151 bool PostgreSQLDatabase::DoesTableExist(const char* name) | |
152 { | |
153 std::string lower(name); | |
154 std::transform(lower.begin(), lower.end(), lower.begin(), tolower); | |
155 | |
156 // http://stackoverflow.com/a/24089729/881731 | |
157 | |
158 PostgreSQLStatement statement(*this, | |
159 "SELECT 1 FROM pg_catalog.pg_class c " | |
160 "JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace " | |
161 "WHERE n.nspname = 'public' AND c.relkind='r' " | |
162 "AND c.relname=$1", true); | |
163 | |
164 statement.DeclareInputString(0); | |
165 statement.BindString(0, lower); | |
166 | |
167 PostgreSQLResult result(statement); | |
168 return !result.IsDone(); | |
169 } | |
170 | |
171 | |
172 void PostgreSQLDatabase::ClearAll() | |
173 { | |
174 PostgreSQLTransaction transaction(*this); | |
175 | |
176 // Remove all the large objects | |
177 Execute("SELECT lo_unlink(loid) FROM (SELECT DISTINCT loid FROM pg_catalog.pg_largeobject) as loids;"); | |
178 | |
179 // http://stackoverflow.com/a/21247009/881731 | |
180 Execute("DROP SCHEMA public CASCADE;"); | |
181 Execute("CREATE SCHEMA public;"); | |
182 Execute("GRANT ALL ON SCHEMA public TO postgres;"); | |
183 Execute("GRANT ALL ON SCHEMA public TO public;"); | |
184 Execute("COMMENT ON SCHEMA public IS 'standard public schema';"); | |
185 | |
186 transaction.Commit(); | |
187 } | |
188 | |
189 | |
190 IPrecompiledStatement* PostgreSQLDatabase::Compile(const Query& query) | |
191 { | |
192 return new PostgreSQLStatement(*this, query); | |
193 } | |
194 | |
195 | |
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
196 namespace |
0 | 197 { |
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
198 class PostgreSQLImplicitTransaction : public ImplicitTransaction |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
199 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
200 private: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
201 PostgreSQLDatabase& db_; |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
202 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
203 protected: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
204 virtual IResult* ExecuteInternal(IPrecompiledStatement& statement, |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
205 const Dictionary& parameters) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
206 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
207 return dynamic_cast<PostgreSQLStatement&>(statement).Execute(*this, parameters); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
208 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
209 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
210 virtual void ExecuteWithoutResultInternal(IPrecompiledStatement& statement, |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
211 const Dictionary& parameters) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
212 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
213 dynamic_cast<PostgreSQLStatement&>(statement).ExecuteWithoutResult(*this, parameters); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
214 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
215 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
216 public: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
217 PostgreSQLImplicitTransaction(PostgreSQLDatabase& db) : |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
218 db_(db) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
219 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
220 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
221 }; |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
222 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
223 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
224 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
225 ITransaction* PostgreSQLDatabase::CreateTransaction(bool isImplicit) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
226 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
227 if (isImplicit) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
228 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
229 return new PostgreSQLImplicitTransaction(*this); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
230 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
231 else |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
232 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
233 return new PostgreSQLTransaction(*this); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
234 } |
0 | 235 } |
236 } |