Mercurial > hg > orthanc-databases
annotate Framework/PostgreSQL/PostgreSQLDatabase.cpp @ 40:5600949bfb12
preparing for release
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 17 Jul 2018 08:28:02 +0200 |
parents | 2fb9cd42af14 |
children | 6a574d810b98 |
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 |
29 | 107 Query query("select pg_try_advisory_lock(" + |
108 boost::lexical_cast<std::string>(lock) + ");", false); | |
109 PostgreSQLStatement s(*this, query); | |
0 | 110 |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
111 PostgreSQLResult result(s); |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
112 if (result.IsDone() || |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
113 !result.GetBoolean(0)) |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
114 { |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
115 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
|
116 throw Orthanc::OrthancException(Orthanc::ErrorCode_Database); |
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
117 } |
0 | 118 |
12
41543239072d
transactions for storage area
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
0
diff
changeset
|
119 transaction.Commit(); |
0 | 120 } |
121 | |
122 | |
123 void PostgreSQLDatabase::Execute(const std::string& sql) | |
124 { | |
125 LOG(TRACE) << "PostgreSQL: " << sql; | |
126 Open(); | |
127 | |
128 PGresult* result = PQexec(reinterpret_cast<PGconn*>(pg_), sql.c_str()); | |
129 if (result == NULL) | |
130 { | |
131 ThrowException(true); | |
132 } | |
133 | |
134 bool ok = (PQresultStatus(result) == PGRES_COMMAND_OK || | |
135 PQresultStatus(result) == PGRES_TUPLES_OK); | |
136 | |
137 if (ok) | |
138 { | |
139 PQclear(result); | |
140 } | |
141 else | |
142 { | |
143 std::string message = PQresultErrorMessage(result); | |
144 PQclear(result); | |
145 | |
146 LOG(ERROR) << "PostgreSQL error: " << message; | |
147 ThrowException(false); | |
148 } | |
149 } | |
150 | |
151 | |
152 bool PostgreSQLDatabase::DoesTableExist(const char* name) | |
153 { | |
154 std::string lower(name); | |
155 std::transform(lower.begin(), lower.end(), lower.begin(), tolower); | |
156 | |
157 // http://stackoverflow.com/a/24089729/881731 | |
158 | |
159 PostgreSQLStatement statement(*this, | |
160 "SELECT 1 FROM pg_catalog.pg_class c " | |
161 "JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace " | |
162 "WHERE n.nspname = 'public' AND c.relkind='r' " | |
163 "AND c.relname=$1", true); | |
164 | |
165 statement.DeclareInputString(0); | |
166 statement.BindString(0, lower); | |
167 | |
168 PostgreSQLResult result(statement); | |
169 return !result.IsDone(); | |
170 } | |
171 | |
172 | |
173 void PostgreSQLDatabase::ClearAll() | |
174 { | |
175 PostgreSQLTransaction transaction(*this); | |
176 | |
177 // Remove all the large objects | |
178 Execute("SELECT lo_unlink(loid) FROM (SELECT DISTINCT loid FROM pg_catalog.pg_largeobject) as loids;"); | |
179 | |
180 // http://stackoverflow.com/a/21247009/881731 | |
181 Execute("DROP SCHEMA public CASCADE;"); | |
182 Execute("CREATE SCHEMA public;"); | |
183 Execute("GRANT ALL ON SCHEMA public TO postgres;"); | |
184 Execute("GRANT ALL ON SCHEMA public TO public;"); | |
185 Execute("COMMENT ON SCHEMA public IS 'standard public schema';"); | |
186 | |
187 transaction.Commit(); | |
188 } | |
189 | |
190 | |
191 IPrecompiledStatement* PostgreSQLDatabase::Compile(const Query& query) | |
192 { | |
193 return new PostgreSQLStatement(*this, query); | |
194 } | |
195 | |
196 | |
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
197 namespace |
0 | 198 { |
23
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
199 class PostgreSQLImplicitTransaction : public ImplicitTransaction |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
200 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
201 private: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
202 PostgreSQLDatabase& db_; |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
203 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
204 protected: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
205 virtual IResult* ExecuteInternal(IPrecompiledStatement& statement, |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
206 const Dictionary& parameters) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
207 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
208 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
|
209 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
210 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
211 virtual void ExecuteWithoutResultInternal(IPrecompiledStatement& statement, |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
212 const Dictionary& parameters) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
213 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
214 dynamic_cast<PostgreSQLStatement&>(statement).ExecuteWithoutResult(*this, parameters); |
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 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
217 public: |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
218 PostgreSQLImplicitTransaction(PostgreSQLDatabase& db) : |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
219 db_(db) |
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 |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
226 ITransaction* PostgreSQLDatabase::CreateTransaction(bool isImplicit) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
227 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
228 if (isImplicit) |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
229 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
230 return new PostgreSQLImplicitTransaction(*this); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
231 } |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
232 else |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
233 { |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
234 return new PostgreSQLTransaction(*this); |
b2ff1cd2907a
handling of implicit transactions in DatabaseManager
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
12
diff
changeset
|
235 } |
0 | 236 } |
237 } |