• Home
  • Features
  • Pricing
  • Docs
  • Announcements
  • Sign In

PowerDNS / pdns / 19967963078

05 Dec 2025 03:39PM UTC coverage: 73.31% (-0.02%) from 73.332%
19967963078

Pull #16602

github

web-flow
Merge a2856a980 into 35c98cd4e
Pull Request #16602: auth: proactive test fix

38746 of 63616 branches covered (60.91%)

Branch coverage included in aggregate %.

128707 of 164801 relevant lines covered (78.1%)

5281402.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

67.94
/modules/gpgsqlbackend/spgsql.cc
1
/*
2
 * This file is part of PowerDNS or dnsdist.
3
 * Copyright -- PowerDNS.COM B.V. and its contributors
4
 *
5
 * This program is free software; you can redistribute it and/or modify
6
 * it under the terms of version 2 of the GNU General Public License as
7
 * published by the Free Software Foundation.
8
 *
9
 * In addition, for the avoidance of any doubt, permission is granted to
10
 * link this program with OpenSSL and to (re)distribute the binaries
11
 * produced as the result of such linking.
12
 *
13
 * This program is distributed in the hope that it will be useful,
14
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16
 * GNU General Public License for more details.
17
 *
18
 * You should have received a copy of the GNU General Public License
19
 * along with this program; if not, write to the Free Software
20
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21
 */
22

23
#ifdef HAVE_CONFIG_H
24
#include "config.h"
25
#endif
26
#include <string>
27
#include "spgsql.hh"
28
#include <sys/time.h>
29
#include <iostream>
30
#include "pdns/logger.hh"
31
#include "pdns/dns.hh"
32
#include "pdns/namespaces.hh"
33
#include <algorithm>
34

35
class SPgSQLStatement : public SSqlStatement
36
{
37
public:
38
  SPgSQLStatement(const string& query, bool dolog, int nparams, SPgSQL* db, unsigned int nstatement)
39
  {
130,132✔
40
    d_query = query;
130,132✔
41
    d_dolog = dolog;
130,132✔
42
    d_parent = db;
130,132✔
43
    d_nparams = nparams;
130,132✔
44
    d_nstatement = nstatement;
130,132✔
45
  }
130,132✔
46

47
  SSqlStatement* bind(const string& name, bool value) override { return bind(name, string(value ? "t" : "f")); }
529,516✔
48
  SSqlStatement* bind(const string& name, int value) override { return bind(name, std::to_string(value)); }
547,828✔
49
  SSqlStatement* bind(const string& name, uint32_t value) override { return bind(name, std::to_string(value)); }
223,854✔
50
  SSqlStatement* bind(const string& name, long value) override { return bind(name, std::to_string(value)); }
81✔
51
  SSqlStatement* bind(const string& name, unsigned long value) override { return bind(name, std::to_string(value)); }
11✔
52
  SSqlStatement* bind(const string& name, long long value) override { return bind(name, std::to_string(value)); }
×
53
  SSqlStatement* bind(const string& name, unsigned long long value) override { return bind(name, std::to_string(value)); }
×
54
  SSqlStatement* bind(const string& /* name */, const std::string& value) override
55
  {
2,227,919✔
56
    prepareStatement();
2,227,919✔
57
    allocate();
2,227,919✔
58
    if (d_paridx >= d_nparams) {
2,227,919!
59
      releaseStatement();
×
60
      throw SSqlException("Attempt to bind more parameters than query has: " + d_query);
×
61
    }
×
62
    paramValues[d_paridx] = new char[value.size() + 1];
2,227,919✔
63
    memset(paramValues[d_paridx], 0, sizeof(char) * (value.size() + 1));
2,227,919✔
64
    value.copy(paramValues[d_paridx], value.size());
2,227,919✔
65
    paramLengths[d_paridx] = value.size();
2,227,919✔
66
    d_paridx++;
2,227,919✔
67
    return this;
2,227,919✔
68
  }
2,227,919✔
69
  SSqlStatement* bindNull(const string& /* name */) override
70
  {
162,940✔
71
    prepareStatement();
162,940✔
72
    d_paridx++;
162,940✔
73
    return this;
162,940✔
74
  } // these are set null in allocate()
162,940✔
75
  SSqlStatement* execute() override
76
  {
331,836✔
77
    prepareStatement();
331,836✔
78
    if (d_dolog) {
331,836!
79
      g_log << Logger::Warning << "Query " << ((long)(void*)this) << ": Statement: " << d_query << endl;
×
80
      if (d_paridx) {
×
81
        // Log message is similar, but not exactly the same as the postgres server log.
82
        std::stringstream log_message;
×
83
        log_message << "Query " << ((long)(void*)this) << ": Parameters: ";
×
84
        for (int i = 0; i < d_paridx; i++) {
×
85
          if (i != 0) {
×
86
            log_message << ", ";
×
87
          }
×
88
          log_message << "$" << (i + 1) << " = ";
×
89
          if (paramValues[i] == nullptr) {
×
90
            log_message << "NULL";
×
91
          }
×
92
          else {
×
93
            log_message << "'" << paramValues[i] << "'";
×
94
          }
×
95
        }
×
96
        g_log << Logger::Warning << log_message.str() << endl;
×
97
      }
×
98
      d_dtime.set();
×
99
    }
×
100
    if (!d_stmt.empty()) {
331,836!
101
      d_res_set = PQexecPrepared(d_db(), d_stmt.c_str(), d_nparams, paramValues, paramLengths, nullptr, 0);
331,836✔
102
    }
331,836✔
103
    else {
×
104
      d_res_set = PQexecParams(d_db(), d_query.c_str(), d_nparams, nullptr, paramValues, paramLengths, nullptr, 0);
×
105
    }
×
106
    ExecStatusType status = PQresultStatus(d_res_set);
331,836✔
107
    if (status != PGRES_COMMAND_OK && status != PGRES_TUPLES_OK && status != PGRES_NONFATAL_ERROR) {
331,836!
108
      string errmsg(PQresultErrorMessage(d_res_set));
×
109
      releaseStatement();
×
110
      throw SSqlException("Fatal error during query: " + d_query + string(": ") + errmsg);
×
111
    }
×
112
    d_cur_set = 0;
331,836✔
113
    if (d_dolog) {
331,836!
114
      auto diff = d_dtime.udiffNoReset();
×
115
      g_log << Logger::Warning << "Query " << ((long)(void*)this) << ": " << diff << " us to execute" << endl;
×
116
    }
×
117

118
    nextResult();
331,836✔
119
    return this;
331,836✔
120
  }
331,836✔
121

122
  void nextResult()
123
  {
350,183✔
124
    if (d_res_set == nullptr)
350,183✔
125
      return;
18,347✔
126
    if (d_cur_set >= PQntuples(d_res_set)) {
331,836✔
127
      PQclear(d_res_set);
313,488✔
128
      d_res_set = nullptr;
313,488✔
129
      return;
313,488✔
130
    }
313,488✔
131
    if (PQftype(d_res_set, 0) == 1790) { // REFCURSOR
18,348!
132
      g_log << Logger::Error << "Postgres query returned a REFCURSOR and we do not support those - see https://github.com/PowerDNS/pdns/pull/10259" << endl;
×
133
      PQclear(d_res_set);
×
134
      d_res_set = nullptr;
×
135
    }
×
136
    else {
18,348✔
137
      d_res = d_res_set;
18,348✔
138
      d_res_set = nullptr;
18,348✔
139
      d_resnum = PQntuples(d_res);
18,348✔
140
    }
18,348✔
141
  }
18,348✔
142

143
  bool hasNextRow() override
144
  {
296,024✔
145
    if (d_dolog && d_residx == d_resnum) {
296,024!
146
      g_log << Logger::Warning << "Query " << ((long)(void*)this) << ": " << d_dtime.udiff() << " us total to last row" << endl;
×
147
    }
×
148

149
    return d_residx < d_resnum;
296,024✔
150
  }
296,024✔
151

152
  SSqlStatement* nextRow(row_t& row) override
153
  {
271,967✔
154
    int i;
271,967✔
155
    row.clear();
271,967✔
156
    if (d_residx >= d_resnum || !d_res)
271,967!
157
      return this;
×
158
    row.reserve(PQnfields(d_res));
271,967✔
159
    for (i = 0; i < PQnfields(d_res); i++) {
2,613,626✔
160
      if (PQgetisnull(d_res, d_residx, i)) {
2,341,659✔
161
        row.emplace_back("");
198,605✔
162
      }
198,605✔
163
      else if (PQftype(d_res, i) == 16) { // BOOLEAN
2,143,054✔
164
        char* val = PQgetvalue(d_res, d_residx, i);
166✔
165
        row.emplace_back(val[0] == 't' ? "1" : "0");
166✔
166
      }
166✔
167
      else {
2,142,888✔
168
        row.emplace_back(PQgetvalue(d_res, d_residx, i));
2,142,888✔
169
      }
2,142,888✔
170
    }
2,341,659✔
171
    d_residx++;
271,967✔
172
    if (d_residx >= d_resnum) {
271,967✔
173
      PQclear(d_res);
18,347✔
174
      d_res = nullptr;
18,347✔
175
      nextResult();
18,347✔
176
    }
18,347✔
177
    return this;
271,967✔
178
  }
271,967✔
179

180
  SSqlStatement* getResult(result_t& result) override
181
  {
1,248✔
182
    result.clear();
1,248✔
183
    if (d_res == nullptr)
1,248✔
184
      return this;
171✔
185
    result.reserve(d_resnum);
1,077✔
186
    row_t row;
1,077✔
187
    while (hasNextRow()) {
2,219✔
188
      nextRow(row);
1,142✔
189
      result.push_back(std::move(row));
1,142✔
190
    }
1,142✔
191
    return this;
1,077✔
192
  }
1,248✔
193

194
  SSqlStatement* reset() override
195
  {
453,982✔
196
    int i;
453,982✔
197
    if (d_res) {
453,982!
198
      PQclear(d_res);
×
199
    }
×
200
    if (d_res_set) {
453,982!
201
      PQclear(d_res_set);
×
202
    }
×
203
    d_res_set = nullptr;
453,982✔
204
    d_res = nullptr;
453,982✔
205
    d_paridx = d_residx = d_resnum = 0;
453,982✔
206
    if (paramValues) {
453,982✔
207
      for (i = 0; i < d_nparams; i++) {
2,722,664✔
208
        if (paramValues[i]) {
2,390,854✔
209
          delete[] paramValues[i];
2,227,919✔
210
        }
2,227,919✔
211
      }
2,390,854✔
212
    }
331,810✔
213
    delete[] paramValues;
453,982✔
214
    paramValues = nullptr;
453,982✔
215
    delete[] paramLengths;
453,982✔
216
    paramLengths = nullptr;
453,982✔
217
    return this;
453,982✔
218
  }
453,982✔
219

220
  const std::string& getQuery() override { return d_query; }
×
221

222
  ~SPgSQLStatement() override
223
  {
122,280✔
224
    releaseStatement();
122,280✔
225
  }
122,280✔
226

227
private:
228
  PGconn* d_db()
229
  {
346,104✔
230
    return d_parent->db();
346,104✔
231
  }
346,104✔
232

233
  void releaseStatement()
234
  {
122,300✔
235
    d_prepared = false;
122,300✔
236
    reset();
122,300✔
237
    if (!d_stmt.empty()) {
122,300✔
238
      string cmd = string("DEALLOCATE " + d_stmt);
6,931✔
239
      PGresult* res = PQexec(d_db(), cmd.c_str());
6,931✔
240
      PQclear(res);
6,931✔
241
      d_stmt.clear();
6,931✔
242
    }
6,931✔
243
  }
122,300✔
244

245
  void prepareStatement()
246
  {
2,722,689✔
247
    if (d_prepared)
2,722,689✔
248
      return;
2,715,352✔
249
    if (d_parent->usePrepared()) {
7,337!
250
      // prepare a statement; name must be unique per session (using d_nstatement to ensure this).
251
      this->d_stmt = string("stmt") + std::to_string(d_nstatement);
7,337✔
252
      PGresult* res = PQprepare(d_db(), d_stmt.c_str(), d_query.c_str(), d_nparams, nullptr);
7,337✔
253
      ExecStatusType status = PQresultStatus(res);
7,337✔
254
      string errmsg(PQresultErrorMessage(res));
7,337✔
255
      PQclear(res);
7,337✔
256
      if (status != PGRES_COMMAND_OK && status != PGRES_TUPLES_OK && status != PGRES_NONFATAL_ERROR) {
7,337!
257
        releaseStatement();
×
258
        throw SSqlException("Fatal error during prePQpreparepare: " + d_query + string(": ") + errmsg);
×
259
      }
×
260
    }
7,337✔
261
    paramValues = nullptr;
7,337✔
262
    paramLengths = nullptr;
7,337✔
263
    d_cur_set = d_paridx = d_residx = d_resnum = 0;
7,337✔
264
    d_res = nullptr;
7,337✔
265
    d_res_set = nullptr;
7,337✔
266
    d_prepared = true;
7,337✔
267
  }
7,337✔
268

269
  void allocate()
270
  {
2,227,913✔
271
    if (paramValues != nullptr)
2,227,913✔
272
      return;
1,896,103✔
273
    paramValues = new char*[d_nparams];
331,810✔
274
    paramLengths = new int[d_nparams];
331,810✔
275
    memset(paramValues, 0, sizeof(char*) * d_nparams);
331,810✔
276
    memset(paramLengths, 0, sizeof(int) * d_nparams);
331,810✔
277
  }
331,810✔
278

279
  string d_query;
280
  string d_stmt;
281
  SPgSQL* d_parent;
282
  PGresult* d_res_set{nullptr};
283
  PGresult* d_res{nullptr};
284
  bool d_dolog;
285
  DTime d_dtime; // only used if d_dolog is set
286
  bool d_prepared{false};
287
  int d_nparams;
288
  int d_paridx{0};
289
  char** paramValues{nullptr};
290
  int* paramLengths{nullptr};
291
  int d_residx{0};
292
  int d_resnum{0};
293
  int d_cur_set{0};
294
  unsigned int d_nstatement;
295
};
296

297
bool SPgSQL::s_dolog;
298

299
static string escapeForPQparam(const string& v)
300
{
3,326✔
301
  string ret = v;
3,326✔
302
  boost::replace_all(ret, "\\", "\\\\");
3,326✔
303
  boost::replace_all(ret, "'", "\\'");
3,326✔
304

305
  return string("'") + ret + string("'");
3,326✔
306
}
3,326✔
307

308
SPgSQL::SPgSQL(const string& database, const string& host, const string& port, const string& user,
309
               const string& password, const string& extra_connection_parameters, const bool use_prepared)
310
{
1,913✔
311
  d_db = nullptr;
1,913✔
312
  d_in_trx = false;
1,913✔
313
  d_connectstr = "";
1,913✔
314
  d_nstatements = 0;
1,913✔
315

316
  if (!database.empty())
1,913✔
317
    d_connectstr += "dbname=" + escapeForPQparam(database);
1,911✔
318

319
  if (!user.empty())
1,913✔
320
    d_connectstr += " user=" + escapeForPQparam(user);
1,412✔
321

322
  if (!host.empty())
1,913!
323
    d_connectstr += " host=" + escapeForPQparam(host);
×
324

325
  if (!port.empty())
1,913!
326
    d_connectstr += " port=" + escapeForPQparam(port);
×
327

328
  if (!extra_connection_parameters.empty())
1,913!
329
    d_connectstr += " " + extra_connection_parameters;
×
330

331
  d_connectlogstr = d_connectstr;
1,913✔
332

333
  if (!password.empty()) {
1,913!
334
    d_connectlogstr += " password=<HIDDEN>";
×
335
    d_connectstr += " password=" + escapeForPQparam(password);
×
336
  }
×
337

338
  d_use_prepared = use_prepared;
1,913✔
339

340
  d_db = PQconnectdb(d_connectstr.c_str());
1,913✔
341

342
  if (!d_db || PQstatus(d_db) == CONNECTION_BAD) {
1,914!
343
    try {
×
344
      throw sPerrorException("Unable to connect to database, connect string: " + d_connectlogstr);
×
345
    }
×
346
    catch (...) {
×
347
      if (d_db)
×
348
        PQfinish(d_db);
×
349
      d_db = 0;
×
350
      throw;
×
351
    }
×
352
  }
×
353
}
1,913✔
354

355
void SPgSQL::setLog(bool state)
356
{
1,914✔
357
  s_dolog = state;
1,914✔
358
}
1,914✔
359

360
SPgSQL::~SPgSQL()
361
{
1,806✔
362
  PQfinish(d_db);
1,806✔
363
}
1,806✔
364

365
SSqlException SPgSQL::sPerrorException(const string& reason)
366
{
×
367
  return SSqlException(reason + string(": ") + (d_db ? PQerrorMessage(d_db) : "no connection"));
×
368
}
×
369

370
void SPgSQL::execute(const string& query)
371
{
1,123✔
372
  PGresult* res = PQexec(d_db, query.c_str());
1,123✔
373
  ExecStatusType status = PQresultStatus(res);
1,123✔
374
  string errmsg(PQresultErrorMessage(res));
1,123✔
375
  PQclear(res);
1,123✔
376
  if (status != PGRES_COMMAND_OK && status != PGRES_TUPLES_OK && status != PGRES_NONFATAL_ERROR) {
1,123!
377
    throw sPerrorException("Fatal error during query: " + errmsg);
×
378
  }
×
379
}
1,123✔
380

381
std::unique_ptr<SSqlStatement> SPgSQL::prepare(const string& query, int nparams)
382
{
130,144✔
383
  d_nstatements++;
130,144✔
384
  return std::make_unique<SPgSQLStatement>(query, s_dolog, nparams, this, d_nstatements);
130,144✔
385
}
130,144✔
386

387
void SPgSQL::startTransaction()
388
{
569✔
389
  execute("begin");
569✔
390
  d_in_trx = true;
569✔
391
}
569✔
392

393
void SPgSQL::commit()
394
{
531✔
395
  execute("commit");
531✔
396
  d_in_trx = false;
531✔
397
}
531✔
398

399
void SPgSQL::rollback()
400
{
23✔
401
  execute("rollback");
23✔
402
  d_in_trx = false;
23✔
403
}
23✔
404

405
bool SPgSQL::isConnectionUsable()
406
{
23,212✔
407
  if (PQstatus(d_db) != CONNECTION_OK) {
23,212!
408
    return false;
×
409
  }
×
410

411
  bool usable = false;
23,212✔
412
  int sd = PQsocket(d_db);
23,212✔
413
  bool wasNonBlocking = isNonBlocking(sd);
23,212✔
414

415
  if (!wasNonBlocking) {
23,212!
416
    if (!setNonBlocking(sd)) {
×
417
      return usable;
×
418
    }
×
419
  }
×
420

421
  usable = isTCPSocketUsable(sd);
23,212✔
422

423
  if (!wasNonBlocking) {
23,212!
424
    if (!setBlocking(sd)) {
×
425
      usable = false;
×
426
    }
×
427
  }
×
428

429
  return usable;
23,212✔
430
}
23,212✔
431

432
void SPgSQL::reconnect()
433
{
×
434
  PQreset(d_db);
×
435
}
×
STATUS · Troubleshooting · Open an Issue · Sales · Support · CAREERS · ENTERPRISE · START FREE · SCHEDULE DEMO
ANNOUNCEMENTS · TWITTER · TOS & SLA · Supported CI Services · What's a CI service? · Automated Testing

© 2025 Coveralls, Inc