1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
/*
* This file is part of LibEuFin.
* Copyright (C) 2024 Taler Systems S.A.
*
* LibEuFin is free software; you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation; either version 3, or
* (at your option) any later version.
*
* LibEuFin is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General
* Public License for more details.
*
* You should have received a copy of the GNU Affero General Public
* License along with LibEuFin; see the file COPYING. If not, see
* <http://www.gnu.org/licenses/>
*/
package tech.libeufin.common.db
import tech.libeufin.common.*
import org.postgresql.ds.PGSimpleDataSource
import org.postgresql.jdbc.PgConnection
import org.postgresql.util.PSQLState
import org.slf4j.Logger
import org.slf4j.LoggerFactory
import java.net.URI
import java.nio.file.Path
import java.sql.PreparedStatement
import java.sql.ResultSet
import java.sql.SQLException
import kotlin.io.path.Path
internal val logger: Logger = LoggerFactory.getLogger("libeufin-db")
/**
* This function converts postgresql:// URIs to JDBC URIs.
*
* URIs that are already jdbc: URIs are passed through.
*
* This avoids the user having to create complex JDBC URIs for postgres connections.
* They are especially complex when using unix domain sockets, as they're not really
* supported natively by JDBC.
*/
fun getJdbcConnectionFromPg(pgConn: String): String {
// Pass through jdbc URIs.
if (pgConn.startsWith("jdbc:")) {
return pgConn
}
if (!pgConn.startsWith("postgresql://") && !pgConn.startsWith("postgres://")) {
throw Exception("Not a Postgres connection string: $pgConn")
}
var maybeUnixSocket = false
val parsed = URI(pgConn)
var hostAsParam: String? = if (parsed.query != null) {
getQueryParam(parsed.query, "host")
} else {
null
}
var pgHost = System.getenv("PGHOST")
if (null == pgHost)
pgHost = parsed.host
var pgPort = System.getenv("PGPORT")
if (null == pgPort) {
if (-1 == parsed.port)
pgPort = "5432"
else
pgPort = parsed.port.toString()
}
/**
* In some cases, it is possible to leave the hostname empty
* and specify it via a query param, therefore a "postgresql:///"-starting
* connection string does NOT always mean Unix domain socket.
* https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
*/
if (pgHost == null &&
(hostAsParam == null || hostAsParam.startsWith('/'))
) {
maybeUnixSocket = true
}
if (pgHost != null &&
(pgHost.startsWith('/'))
) {
maybeUnixSocket = true
}
if (maybeUnixSocket) {
// Check whether the database user should differ from the process user.
var pgUser = getCurrentUser()
if (parsed.query != null) {
val maybeUserParam = getQueryParam(parsed.query, "user")
if (maybeUserParam != null) pgUser = maybeUserParam
}
// Check whether the Unix domain socket location was given non-standard.
if ( (null == hostAsParam) && (null != pgHost) )
hostAsParam = pgHost + "/.s.PGSQL." + pgPort
val socketLocation = hostAsParam ?: "/var/run/postgresql/.s.PGSQL." + pgPort
if (!socketLocation.startsWith('/')) {
throw Exception("PG connection wants Unix domain socket, but non-null host doesn't start with slash")
}
return "jdbc:postgresql://localhost${parsed.path}?user=$pgUser&socketFactory=org.newsclub.net.unix." +
"AFUNIXSocketFactory\$FactoryArg&socketFactoryArg=$socketLocation"
}
if (pgConn.startsWith("postgres://")) {
// The JDBC driver doesn't like postgres://, only postgresql://.
// For consistency with other components, we normalize the postgres:// URI
// into one that the JDBC driver likes.
return "jdbc:postgresql://" + pgConn.removePrefix("postgres://")
}
logger.info("connecting to database via JDBC string '$pgConn'")
return "jdbc:$pgConn"
}
data class DatabaseConfig(
val dbConnStr: String,
val sqlDir: Path
)
fun pgDataSource(dbConfig: String): PGSimpleDataSource {
val jdbcConnStr = getJdbcConnectionFromPg(dbConfig)
logger.debug("connecting to database via JDBC string '$jdbcConnStr'")
val pgSource = PGSimpleDataSource()
pgSource.setUrl(jdbcConnStr)
pgSource.prepareThreshold = 1
return pgSource
}
fun PGSimpleDataSource.pgConnection(schema: String? = null): PgConnection {
val conn = connection.unwrap(PgConnection::class.java)
if (schema != null) conn.execSQLUpdate("SET search_path TO $schema")
return conn
}
fun <R> PgConnection.transaction(lambda: (PgConnection) -> R): R {
try {
autoCommit = false
val result = lambda(this)
commit()
autoCommit = true
return result
} catch (e: Exception) {
rollback()
autoCommit = true
throw e
}
}
fun <T> PreparedStatement.oneOrNull(lambda: (ResultSet) -> T): T? {
executeQuery().use {
return if (it.next()) lambda(it) else null
}
}
fun <T> PreparedStatement.one(lambda: (ResultSet) -> T): T =
requireNotNull(oneOrNull(lambda)) { "Missing result to database query" }
fun <T> PreparedStatement.all(lambda: (ResultSet) -> T): List<T> {
executeQuery().use {
val ret = mutableListOf<T>()
while (it.next()) {
ret.add(lambda(it))
}
return ret
}
}
fun PreparedStatement.executeQueryCheck(): Boolean {
executeQuery().use {
return it.next()
}
}
fun PreparedStatement.executeUpdateCheck(): Boolean {
executeUpdate()
return updateCount > 0
}
/**
* Helper that returns false if the row to be inserted
* hits a unique key constraint violation, true when it
* succeeds. Any other error (re)throws exception.
*/
fun PreparedStatement.executeUpdateViolation(): Boolean {
return try {
executeUpdateCheck()
} catch (e: SQLException) {
logger.debug(e.message)
if (e.sqlState == PSQLState.UNIQUE_VIOLATION.state) return false
throw e // rethrowing, not to hide other types of errors.
}
}
fun PreparedStatement.executeProcedureViolation(): Boolean {
val savepoint = connection.setSavepoint()
return try {
executeUpdate()
connection.releaseSavepoint(savepoint)
true
} catch (e: SQLException) {
connection.rollback(savepoint)
if (e.sqlState == PSQLState.UNIQUE_VIOLATION.state) return false
throw e // rethrowing, not to hide other types of errors.
}
}
// TODO comment
fun PgConnection.dynamicUpdate(
table: String,
fields: Sequence<String>,
filter: String,
bind: Sequence<Any?>,
) {
val sql = fields.joinToString()
if (sql.isEmpty()) return
prepareStatement("UPDATE $table SET $sql $filter").run {
for ((idx, value) in bind.withIndex()) {
setObject(idx + 1, value)
}
executeUpdate()
}
}
|
