blob: 9d0c621c97ddc39b482780b3a58509b4aa2f60c1 [file] [log] [blame]
Harald Weltee72cf552016-04-28 07:18:49 +02001/* (C) 2015 by Harald Welte <laforge@gnumonks.org>
2 *
3 * All Rights Reserved
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU Affero General Public License as published by
7 * the Free Software Foundation; either version 3 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU Affero General Public License for more details.
14 *
15 * You should have received a copy of the GNU Affero General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
17 *
18 */
19
20#include <osmocom/core/utils.h>
21
Max00b37152017-02-20 11:09:27 +010022#include <stdbool.h>
Harald Weltee72cf552016-04-28 07:18:49 +020023#include <sqlite3.h>
Neels Hofmeyrcd83b8a2017-10-06 04:20:37 +020024#include <string.h>
Harald Weltee72cf552016-04-28 07:18:49 +020025
Neels Hofmeyr2f758032019-11-20 00:37:07 +010026#include <osmocom/hlr/logging.h>
27#include <osmocom/hlr/db.h>
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +020028#include "db_bootstrap.h"
Harald Weltee72cf552016-04-28 07:18:49 +020029
Stefan Sperling638ba8c2018-12-04 15:07:29 +010030/* This constant is currently duplicated in sql/hlr.sql and must be kept in sync! */
Neels Hofmeyr07e16022019-11-20 02:36:35 +010031#define CURRENT_SCHEMA_VERSION 4
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +010032
Neels Hofmeyr9c2bbc82017-10-09 17:30:32 +020033#define SEL_COLUMNS \
34 "id," \
35 "imsi," \
36 "msisdn," \
Oliver Smith81db3892019-01-09 12:03:51 +010037 "imei," \
Neels Hofmeyr9c2bbc82017-10-09 17:30:32 +020038 "vlr_number," \
39 "sgsn_number," \
40 "sgsn_address," \
41 "periodic_lu_tmr," \
42 "periodic_rau_tau_tmr," \
43 "nam_cs," \
44 "nam_ps," \
45 "lmsi," \
46 "ms_purged_cs," \
Stefan Sperling638ba8c2018-12-04 15:07:29 +010047 "ms_purged_ps," \
Neels Hofmeyr07e16022019-11-20 02:36:35 +010048 "last_lu_seen," \
49 "last_lu_seen_ps" \
Neels Hofmeyr9c2bbc82017-10-09 17:30:32 +020050
Harald Weltee72cf552016-04-28 07:18:49 +020051static const char *stmt_sql[] = {
Neels Hofmeyr9c2bbc82017-10-09 17:30:32 +020052 [DB_STMT_SEL_BY_IMSI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imsi = ?",
53 [DB_STMT_SEL_BY_MSISDN] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE msisdn = ?",
54 [DB_STMT_SEL_BY_ID] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE id = ?",
Oliver Smith81db3892019-01-09 12:03:51 +010055 [DB_STMT_SEL_BY_IMEI] = "SELECT " SEL_COLUMNS " FROM subscriber WHERE imei = ?",
Neels Hofmeyrdd783052017-10-09 17:36:08 +020056 [DB_STMT_UPD_VLR_BY_ID] = "UPDATE subscriber SET vlr_number = $number WHERE id = $subscriber_id",
57 [DB_STMT_UPD_SGSN_BY_ID] = "UPDATE subscriber SET sgsn_number = $number WHERE id = $subscriber_id",
Oliver Smith81db3892019-01-09 12:03:51 +010058 [DB_STMT_UPD_IMEI_BY_IMSI] = "UPDATE subscriber SET imei = $imei WHERE imsi = $imsi",
Neels Hofmeyr0cac0a02017-10-09 17:47:21 +020059 [DB_STMT_AUC_BY_IMSI] =
60 "SELECT id, algo_id_2g, ki, algo_id_3g, k, op, opc, sqn, ind_bitlen"
61 " FROM subscriber"
62 " LEFT JOIN auc_2g ON auc_2g.subscriber_id = subscriber.id"
63 " LEFT JOIN auc_3g ON auc_3g.subscriber_id = subscriber.id"
Neels Hofmeyrc5122f22017-10-09 23:12:57 +020064 " WHERE imsi = $imsi",
Neels Hofmeyr1cbdb702017-10-09 23:03:57 +020065 [DB_STMT_AUC_UPD_SQN] = "UPDATE auc_3g SET sqn = $sqn WHERE subscriber_id = $subscriber_id",
Neels Hofmeyre50121e2017-10-09 17:48:51 +020066 [DB_STMT_UPD_PURGE_CS_BY_IMSI] = "UPDATE subscriber SET ms_purged_cs = $val WHERE imsi = $imsi",
67 [DB_STMT_UPD_PURGE_PS_BY_IMSI] = "UPDATE subscriber SET ms_purged_ps = $val WHERE imsi = $imsi",
Neels Hofmeyre8ccd502017-10-06 04:10:06 +020068 [DB_STMT_UPD_NAM_CS_BY_IMSI] = "UPDATE subscriber SET nam_cs = $val WHERE imsi = $imsi",
69 [DB_STMT_UPD_NAM_PS_BY_IMSI] = "UPDATE subscriber SET nam_ps = $val WHERE imsi = $imsi",
Oliver Smithcd2af5e2019-03-06 13:17:39 +010070 [DB_STMT_SUBSCR_CREATE] = "INSERT INTO subscriber (imsi, nam_cs, nam_ps) VALUES ($imsi, $nam_cs, $nam_ps)",
Neels Hofmeyrf7c3e6e2017-10-09 17:55:16 +020071 [DB_STMT_DEL_BY_ID] = "DELETE FROM subscriber WHERE id = $subscriber_id",
72 [DB_STMT_SET_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = $msisdn WHERE imsi = $imsi",
Neels Hofmeyra820ea12018-12-02 19:46:46 +010073 [DB_STMT_DELETE_MSISDN_BY_IMSI] = "UPDATE subscriber SET msisdn = NULL WHERE imsi = $imsi",
Neels Hofmeyr1332a172017-10-10 02:25:00 +020074 [DB_STMT_AUC_2G_INSERT] =
75 "INSERT INTO auc_2g (subscriber_id, algo_id_2g, ki)"
76 " VALUES($subscriber_id, $algo_id_2g, $ki)",
77 [DB_STMT_AUC_2G_DELETE] = "DELETE FROM auc_2g WHERE subscriber_id = $subscriber_id",
78 [DB_STMT_AUC_3G_INSERT] =
79 "INSERT INTO auc_3g (subscriber_id, algo_id_3g, k, op, opc, ind_bitlen)"
80 " VALUES($subscriber_id, $algo_id_3g, $k, $op, $opc, $ind_bitlen)",
81 [DB_STMT_AUC_3G_DELETE] = "DELETE FROM auc_3g WHERE subscriber_id = $subscriber_id",
Stefan Sperling638ba8c2018-12-04 15:07:29 +010082 [DB_STMT_SET_LAST_LU_SEEN] = "UPDATE subscriber SET last_lu_seen = datetime($val, 'unixepoch') WHERE id = $subscriber_id",
Neels Hofmeyr07e16022019-11-20 02:36:35 +010083 [DB_STMT_SET_LAST_LU_SEEN_PS] = "UPDATE subscriber SET last_lu_seen_ps = datetime($val, 'unixepoch') WHERE id = $subscriber_id",
Oliver Smith6b73fd92019-03-06 13:49:05 +010084 [DB_STMT_EXISTS_BY_IMSI] = "SELECT 1 FROM subscriber WHERE imsi = $imsi",
Vadim Yanitskiyc13599d2019-03-30 17:03:42 +070085 [DB_STMT_EXISTS_BY_MSISDN] = "SELECT 1 FROM subscriber WHERE msisdn = $msisdn",
Harald Weltee72cf552016-04-28 07:18:49 +020086};
87
88static void sql3_error_log_cb(void *arg, int err_code, const char *msg)
89{
90 LOGP(DDB, LOGL_ERROR, "(%d) %s\n", err_code, msg);
91}
92
93static void sql3_sql_log_cb(void *arg, sqlite3 *s3, const char *stmt, int type)
94{
95 switch (type) {
96 case 0:
97 LOGP(DDB, LOGL_DEBUG, "Opened database\n");
98 break;
99 case 1:
Max58d4a842017-02-20 11:06:12 +0100100 LOGP(DDB, LOGL_DEBUG, "%s\n", stmt);
Harald Weltee72cf552016-04-28 07:18:49 +0200101 break;
102 case 2:
103 LOGP(DDB, LOGL_DEBUG, "Closed database\n");
104 break;
105 default:
106 LOGP(DDB, LOGL_DEBUG, "Unknown %d\n", type);
107 break;
108 }
109}
110
Max00b37152017-02-20 11:09:27 +0100111/* remove bindings and reset statement to be re-executed */
Neels Hofmeyrd7d96972017-10-06 03:50:30 +0200112void db_remove_reset(sqlite3_stmt *stmt)
Max00b37152017-02-20 11:09:27 +0100113{
Neels Hofmeyrd7d96972017-10-06 03:50:30 +0200114 sqlite3_clear_bindings(stmt);
Neels Hofmeyr4f3841c2017-11-07 13:24:44 +0100115 /* sqlite3_reset() just repeats an error code already evaluated during sqlite3_step(). */
116 /* coverity[CHECKED_RETURN] */
Neels Hofmeyrd7d96972017-10-06 03:50:30 +0200117 sqlite3_reset(stmt);
Max00b37152017-02-20 11:09:27 +0100118}
119
Neels Hofmeyrf3144592017-10-06 03:40:52 +0200120/** bind text arg and do proper cleanup in case of failure. If param_name is
121 * NULL, bind to the first parameter (useful for SQL statements that have only
122 * one parameter). */
123bool db_bind_text(sqlite3_stmt *stmt, const char *param_name, const char *text)
Max00b37152017-02-20 11:09:27 +0100124{
Neels Hofmeyrf3144592017-10-06 03:40:52 +0200125 int rc;
126 int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1;
127 if (idx < 1) {
128 LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n",
129 param_name);
130 return false;
131 }
132 rc = sqlite3_bind_text(stmt, idx, text, -1, SQLITE_STATIC);
Max00b37152017-02-20 11:09:27 +0100133 if (rc != SQLITE_OK) {
Neels Hofmeyrf3144592017-10-06 03:40:52 +0200134 LOGP(DDB, LOGL_ERROR, "Error binding text to SQL parameter %s: %d\n",
135 param_name ? param_name : "#1", rc);
Max00b37152017-02-20 11:09:27 +0100136 db_remove_reset(stmt);
137 return false;
138 }
Max00b37152017-02-20 11:09:27 +0100139 return true;
140}
141
Neels Hofmeyr28da26e2017-10-06 03:44:57 +0200142/** bind int arg and do proper cleanup in case of failure. If param_name is
143 * NULL, bind to the first parameter (useful for SQL statements that have only
144 * one parameter). */
145bool db_bind_int(sqlite3_stmt *stmt, const char *param_name, int nr)
146{
147 int rc;
148 int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1;
149 if (idx < 1) {
150 LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n",
151 param_name);
152 return false;
153 }
154 rc = sqlite3_bind_int(stmt, idx, nr);
155 if (rc != SQLITE_OK) {
156 LOGP(DDB, LOGL_ERROR, "Error binding int64 to SQL parameter %s: %d\n",
157 param_name ? param_name : "#1", rc);
158 db_remove_reset(stmt);
159 return false;
160 }
161 return true;
162}
163
164/** bind int64 arg and do proper cleanup in case of failure. If param_name is
165 * NULL, bind to the first parameter (useful for SQL statements that have only
166 * one parameter). */
167bool db_bind_int64(sqlite3_stmt *stmt, const char *param_name, int64_t nr)
168{
169 int rc;
170 int idx = param_name ? sqlite3_bind_parameter_index(stmt, param_name) : 1;
171 if (idx < 1) {
172 LOGP(DDB, LOGL_ERROR, "Error composing SQL, cannot bind parameter '%s'\n",
173 param_name);
174 return false;
175 }
176 rc = sqlite3_bind_int64(stmt, idx, nr);
177 if (rc != SQLITE_OK) {
178 LOGP(DDB, LOGL_ERROR, "Error binding int64 to SQL parameter %s: %d\n",
179 param_name ? param_name : "#1", rc);
180 db_remove_reset(stmt);
181 return false;
182 }
183 return true;
184}
185
Harald Weltee72cf552016-04-28 07:18:49 +0200186void db_close(struct db_context *dbc)
187{
188 unsigned int i;
Vadim Yanitskiydc17e052018-07-30 20:14:16 +0700189 int rc;
Harald Weltee72cf552016-04-28 07:18:49 +0200190
191 for (i = 0; i < ARRAY_SIZE(dbc->stmt); i++) {
192 /* it is ok to call finalize on NULL */
193 sqlite3_finalize(dbc->stmt[i]);
194 }
Vadim Yanitskiydc17e052018-07-30 20:14:16 +0700195
196 /* Ask sqlite3 to close DB */
197 rc = sqlite3_close(dbc->db);
198 if (rc != SQLITE_OK) { /* Make sure it's actually closed! */
199 LOGP(DDB, LOGL_ERROR, "Couldn't close database: (rc=%d) %s\n",
200 rc, sqlite3_errmsg(dbc->db));
201 }
202
Harald Weltee72cf552016-04-28 07:18:49 +0200203 talloc_free(dbc);
204}
205
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100206static int db_run_statements(struct db_context *dbc, const char **statements, size_t statements_count)
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200207{
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100208 int rc;
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200209 int i;
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100210 for (i = 0; i < statements_count; i++) {
211 const char *stmt_str = statements[i];
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200212 sqlite3_stmt *stmt;
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100213
214 rc = sqlite3_prepare_v2(dbc->db, stmt_str, -1, &stmt, NULL);
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200215 if (rc != SQLITE_OK) {
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100216 LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", stmt_str);
Vadim Yanitskiy050eb1d2018-07-30 20:48:19 +0700217 return rc;
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200218 }
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200219 rc = sqlite3_step(stmt);
220 db_remove_reset(stmt);
Vadim Yanitskiydc17e052018-07-30 20:14:16 +0700221 sqlite3_finalize(stmt);
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200222 if (rc != SQLITE_DONE) {
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100223 LOGP(DDB, LOGL_ERROR, "SQL error: (%d) %s, during stmt '%s'",
224 rc, sqlite3_errmsg(dbc->db), stmt_str);
Vadim Yanitskiy050eb1d2018-07-30 20:48:19 +0700225 return rc;
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200226 }
227 }
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100228 return rc;
229}
230
231static int db_bootstrap(struct db_context *dbc)
232{
233 int rc = db_run_statements(dbc, stmt_bootstrap_sql, ARRAY_SIZE(stmt_bootstrap_sql));
234 if (rc != SQLITE_DONE) {
235 LOGP(DDB, LOGL_ERROR, "Cannot bootstrap database\n");
236 return rc;
237 }
Vadim Yanitskiy050eb1d2018-07-30 20:48:19 +0700238 return SQLITE_OK;
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200239}
240
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100241/* https://www.sqlite.org/fileformat2.html#storage_of_the_sql_database_schema */
242static bool db_table_exists(struct db_context *dbc, const char *table_name)
243{
244 const char *table_exists_sql = "SELECT name FROM sqlite_master WHERE type='table' AND name=?";
245 sqlite3_stmt *stmt;
246 int rc;
247
248 rc = sqlite3_prepare_v2(dbc->db, table_exists_sql, -1, &stmt, NULL);
249 if (rc != SQLITE_OK) {
250 LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", table_exists_sql);
251 return false;
252 }
253
254 if (!db_bind_text(stmt, NULL, table_name))
255 return false;
256
257 rc = sqlite3_step(stmt);
258 db_remove_reset(stmt);
259 sqlite3_finalize(stmt);
260 return (rc == SQLITE_ROW);
261}
262
263/* Indicate whether the database is initialized with tables for schema version 0.
264 * We only check for the 'subscriber' table here because Neels said so. */
265static bool db_is_bootstrapped_v0(struct db_context *dbc)
266{
267 if (!db_table_exists(dbc, "subscriber")) {
268 LOGP(DDB, LOGL_DEBUG, "Table 'subscriber' not found in database '%s'\n", dbc->fname);
269 return false;
270 }
271
272 return true;
273}
274
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100275static int
276db_upgrade_v1(struct db_context *dbc)
277{
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100278 int rc;
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100279 const char *statements[] = {
280 "ALTER TABLE subscriber ADD COLUMN last_lu_seen TIMESTAMP default NULL",
281 "PRAGMA user_version = 1",
282 };
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100283
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100284 rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100285 if (rc != SQLITE_DONE) {
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100286 LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 1\n");
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100287 return rc;
288 }
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100289 return rc;
290}
291
Oliver Smith81db3892019-01-09 12:03:51 +0100292static int db_upgrade_v2(struct db_context *dbc)
293{
Oliver Smith81db3892019-01-09 12:03:51 +0100294 int rc;
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100295 const char *statements[] = {
296 "ALTER TABLE subscriber ADD COLUMN imei VARCHAR(14)",
297 "PRAGMA user_version = 2",
298 };
Oliver Smith81db3892019-01-09 12:03:51 +0100299
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100300 rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
Oliver Smith81db3892019-01-09 12:03:51 +0100301 if (rc != SQLITE_DONE) {
Neels Hofmeyrf5459de2019-10-31 01:29:59 +0100302 LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 2\n");
Oliver Smith81db3892019-01-09 12:03:51 +0100303 return rc;
304 }
Oliver Smith81db3892019-01-09 12:03:51 +0100305 return rc;
306}
307
Neels Hofmeyra8045da2019-10-31 01:19:44 +0100308static int db_upgrade_v3(struct db_context *dbc)
309{
Neels Hofmeyra8045da2019-10-31 01:19:44 +0100310 int rc;
311
312 /* A newer SQLite version would allow simply 'ATLER TABLE subscriber RENAME COLUMN hlr_number TO msc_number'.
313 * This is a really expensive workaround for that in order to cover earlier SQLite versions as well:
314 * Create a new table with the new column name and copy the data over (https://www.sqlite.org/faq.html#q11).
315 */
316#define SUBSCR_V3_CREATE \
317"(\n" \
318"-- OsmoHLR's DB scheme is modelled roughly after TS 23.008 version 13.3.0\n" \
319" id INTEGER PRIMARY KEY,\n" \
320" -- Chapter 2.1.1.1\n" \
321" imsi VARCHAR(15) UNIQUE NOT NULL,\n" \
322" -- Chapter 2.1.2\n" \
323" msisdn VARCHAR(15) UNIQUE,\n" \
324" -- Chapter 2.2.3: Most recent / current IMEISV\n" \
325" imeisv VARCHAR,\n" \
326" -- Chapter 2.1.9: Most recent / current IMEI\n" \
327" imei VARCHAR(14),\n" \
328" -- Chapter 2.4.5\n" \
329" vlr_number VARCHAR(15),\n" \
330" -- Chapter 2.4.6\n" \
331" msc_number VARCHAR(15),\n" \
332" -- Chapter 2.4.8.1\n" \
333" sgsn_number VARCHAR(15),\n" \
334" -- Chapter 2.13.10\n" \
335" sgsn_address VARCHAR,\n" \
336" -- Chapter 2.4.8.2\n" \
337" ggsn_number VARCHAR(15),\n" \
338" -- Chapter 2.4.9.2\n" \
339" gmlc_number VARCHAR(15),\n" \
340" -- Chapter 2.4.23\n" \
341" smsc_number VARCHAR(15),\n" \
342" -- Chapter 2.4.24\n" \
343" periodic_lu_tmr INTEGER,\n" \
344" -- Chapter 2.13.115\n" \
345" periodic_rau_tau_tmr INTEGER,\n" \
346" -- Chapter 2.1.1.2: network access mode\n" \
347" nam_cs BOOLEAN NOT NULL DEFAULT 1,\n" \
348" nam_ps BOOLEAN NOT NULL DEFAULT 1,\n" \
349" -- Chapter 2.1.8\n" \
350" lmsi INTEGER,\n" \
351 \
352" -- The below purged flags might not even be stored non-volatile,\n" \
353" -- refer to TS 23.012 Chapter 3.6.1.4\n" \
354" -- Chapter 2.7.5\n" \
355" ms_purged_cs BOOLEAN NOT NULL DEFAULT 0,\n" \
356" -- Chapter 2.7.6\n" \
357" ms_purged_ps BOOLEAN NOT NULL DEFAULT 0,\n" \
358 \
359" -- Timestamp of last location update seen from subscriber\n" \
360" -- The value is a string which encodes a UTC timestamp in granularity of seconds.\n" \
361" last_lu_seen TIMESTAMP default NULL\n" \
362")\n"
363
364#define SUBSCR_V2_COLUMN_NAMES \
365 "id," \
366 "imsi," \
367 "msisdn," \
368 "imeisv," \
369 "imei," \
370 "vlr_number," \
371 "hlr_number," \
372 "sgsn_number," \
373 "sgsn_address," \
374 "ggsn_number," \
375 "gmlc_number," \
376 "smsc_number," \
377 "periodic_lu_tmr," \
378 "periodic_rau_tau_tmr," \
379 "nam_cs," \
380 "nam_ps," \
381 "lmsi," \
382 "ms_purged_cs," \
383 "ms_purged_ps," \
384 "last_lu_seen"
385
386#define SUBSCR_V3_COLUMN_NAMES \
387 "id," \
388 "imsi," \
389 "msisdn," \
390 "imeisv," \
391 "imei," \
392 "vlr_number," \
393 "msc_number," \
394 "sgsn_number," \
395 "sgsn_address," \
396 "ggsn_number," \
397 "gmlc_number," \
398 "smsc_number," \
399 "periodic_lu_tmr," \
400 "periodic_rau_tau_tmr," \
401 "nam_cs," \
402 "nam_ps," \
403 "lmsi," \
404 "ms_purged_cs," \
405 "ms_purged_ps," \
406 "last_lu_seen"
407
408 const char *statements[] = {
409 "BEGIN TRANSACTION",
410 "CREATE TEMPORARY TABLE subscriber_backup" SUBSCR_V3_CREATE,
411 "INSERT INTO subscriber_backup SELECT " SUBSCR_V2_COLUMN_NAMES " FROM subscriber",
412 "DROP TABLE subscriber",
413 "CREATE TABLE subscriber" SUBSCR_V3_CREATE,
414 "INSERT INTO subscriber SELECT " SUBSCR_V3_COLUMN_NAMES " FROM subscriber_backup",
415 "DROP TABLE subscriber_backup",
416 "COMMIT",
417 "PRAGMA user_version = 3",
418 };
419
Neels Hofmeyr7f4dd112019-10-31 21:23:10 +0100420 rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
421 if (rc != SQLITE_DONE) {
422 LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 3\n");
423 return rc;
Neels Hofmeyra8045da2019-10-31 01:19:44 +0100424 }
425 return rc;
426}
427
Neels Hofmeyr07e16022019-11-20 02:36:35 +0100428static int db_upgrade_v4(struct db_context *dbc)
429{
430 int rc;
431 const char *statements[] = {
432 "ALTER TABLE subscriber ADD COLUMN last_lu_seen_ps TIMESTAMP default NULL",
433 "PRAGMA user_version = 4",
434 };
435
436 rc = db_run_statements(dbc, statements, ARRAY_SIZE(statements));
437 if (rc != SQLITE_DONE) {
438 LOGP(DDB, LOGL_ERROR, "Unable to update HLR database schema to version 4\n");
439 return rc;
440 }
441 return rc;
442}
443
Neels Hofmeyr981e1262019-11-05 02:00:19 +0100444typedef int (*db_upgrade_func_t)(struct db_context *dbc);
445static db_upgrade_func_t db_upgrade_path[] = {
446 db_upgrade_v1,
447 db_upgrade_v2,
448 db_upgrade_v3,
Neels Hofmeyr07e16022019-11-20 02:36:35 +0100449 db_upgrade_v4,
Neels Hofmeyr981e1262019-11-05 02:00:19 +0100450};
451
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100452static int db_get_user_version(struct db_context *dbc)
453{
454 const char *user_version_sql = "PRAGMA user_version";
455 sqlite3_stmt *stmt;
456 int version, rc;
457
458 rc = sqlite3_prepare_v2(dbc->db, user_version_sql, -1, &stmt, NULL);
459 if (rc != SQLITE_OK) {
460 LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", user_version_sql);
461 return -1;
462 }
463 rc = sqlite3_step(stmt);
464 if (rc == SQLITE_ROW) {
465 version = sqlite3_column_int(stmt, 0);
466 } else {
467 LOGP(DDB, LOGL_ERROR, "SQL statement '%s' failed: %d\n", user_version_sql, rc);
468 version = -1;
469 }
470
471 db_remove_reset(stmt);
472 sqlite3_finalize(stmt);
473 return version;
474}
475
476struct db_context *db_open(void *ctx, const char *fname, bool enable_sqlite_logging, bool allow_upgrade)
Harald Weltee72cf552016-04-28 07:18:49 +0200477{
478 struct db_context *dbc = talloc_zero(ctx, struct db_context);
479 unsigned int i;
480 int rc;
Neels Hofmeyrcd83b8a2017-10-06 04:20:37 +0200481 bool has_sqlite_config_sqllog = false;
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100482 int version;
Harald Weltee72cf552016-04-28 07:18:49 +0200483
Neels Hofmeyr7f9491f2017-01-30 13:30:47 +0100484 LOGP(DDB, LOGL_NOTICE, "using database: %s\n", fname);
Harald Weltee72cf552016-04-28 07:18:49 +0200485 LOGP(DDB, LOGL_INFO, "Compiled against SQLite3 lib version %s\n", SQLITE_VERSION);
486 LOGP(DDB, LOGL_INFO, "Running with SQLite3 lib version %s\n", sqlite3_libversion());
487
Vadim Yanitskiyfbd736e2018-07-31 22:40:30 +0700488#ifdef SQLITE_USE_TALLOC
489 /* Configure SQLite3 to use talloc memory allocator */
490 rc = db_sqlite3_use_talloc(ctx);
491 if (rc == SQLITE_OK) {
492 LOGP(DDB, LOGL_NOTICE, "SQLite3 is configured to use talloc\n");
493 } else {
494 LOGP(DDB, LOGL_ERROR, "Failed to configure SQLite3 "
495 "to use talloc, using default memory allocator\n");
496 }
497#endif
498
Harald Weltee72cf552016-04-28 07:18:49 +0200499 dbc->fname = talloc_strdup(dbc, fname);
500
501 for (i = 0; i < 0xfffff; i++) {
502 const char *o = sqlite3_compileoption_get(i);
503 if (!o)
504 break;
Neels Hofmeyre9c0c5b2017-10-10 16:52:22 +0200505 LOGP(DDB, LOGL_DEBUG, "SQLite3 compiled with '%s'\n", o);
Neels Hofmeyrcd83b8a2017-10-06 04:20:37 +0200506 if (!strcmp(o, "ENABLE_SQLLOG"))
507 has_sqlite_config_sqllog = true;
Harald Weltee72cf552016-04-28 07:18:49 +0200508 }
509
Neels Hofmeyrd3814b92017-11-21 12:28:07 +0100510 if (enable_sqlite_logging) {
511 rc = sqlite3_config(SQLITE_CONFIG_LOG, sql3_error_log_cb, NULL);
512 if (rc != SQLITE_OK)
513 LOGP(DDB, LOGL_NOTICE, "Unable to set SQLite3 error log callback\n");
514 }
Harald Weltee72cf552016-04-28 07:18:49 +0200515
Neels Hofmeyrcd83b8a2017-10-06 04:20:37 +0200516 if (has_sqlite_config_sqllog) {
517 rc = sqlite3_config(SQLITE_CONFIG_SQLLOG, sql3_sql_log_cb, NULL);
518 if (rc != SQLITE_OK)
519 LOGP(DDB, LOGL_NOTICE, "Unable to set SQLite3 SQL log callback\n");
520 } else
521 LOGP(DDB, LOGL_DEBUG, "Not setting SQL log callback:"
522 " SQLite3 compiled without support for it\n");
Harald Weltee72cf552016-04-28 07:18:49 +0200523
524 rc = sqlite3_open(dbc->fname, &dbc->db);
525 if (rc != SQLITE_OK) {
526 LOGP(DDB, LOGL_ERROR, "Unable to open DB; rc = %d\n", rc);
527 talloc_free(dbc);
528 return NULL;
529 }
530
531 /* enable extended result codes */
532 rc = sqlite3_extended_result_codes(dbc->db, 1);
533 if (rc != SQLITE_OK)
Neels Hofmeyre9c0c5b2017-10-10 16:52:22 +0200534 LOGP(DDB, LOGL_ERROR, "Unable to enable SQLite3 extended result codes\n");
Harald Weltee72cf552016-04-28 07:18:49 +0200535
Harald Welteabd1a542016-05-03 18:50:41 +0200536 char *err_msg;
537 rc = sqlite3_exec(dbc->db, "PRAGMA journal_mode=WAL; PRAGMA synchonous = NORMAL;", 0, 0, &err_msg);
Vadim Yanitskiy15ad7be2020-02-09 05:32:46 +0700538 if (rc != SQLITE_OK) {
Harald Welteabd1a542016-05-03 18:50:41 +0200539 LOGP(DDB, LOGL_ERROR, "Unable to set Write-Ahead Logging: %s\n",
540 err_msg);
Vadim Yanitskiy15ad7be2020-02-09 05:32:46 +0700541 sqlite3_free(err_msg);
542 }
Harald Welteabd1a542016-05-03 18:50:41 +0200543
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100544 version = db_get_user_version(dbc);
545 if (version < 0) {
546 LOGP(DDB, LOGL_ERROR, "Unable to read user version number from database '%s'\n", dbc->fname);
547 goto out_free;
548 }
549
550 /* An empty database will always report version zero. */
551 if (version == 0 && !db_is_bootstrapped_v0(dbc)) {
552 LOGP(DDB, LOGL_NOTICE, "Missing database tables detected; Bootstrapping database '%s'\n", dbc->fname);
553 rc = db_bootstrap(dbc);
554 if (rc != SQLITE_OK) {
555 LOGP(DDB, LOGL_ERROR, "Failed to bootstrap DB: (rc=%d) %s\n",
556 rc, sqlite3_errmsg(dbc->db));
557 goto out_free;
558 }
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100559 version = CURRENT_SCHEMA_VERSION;
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100560 }
561
562 LOGP(DDB, LOGL_NOTICE, "Database '%s' has HLR DB schema version %d\n", dbc->fname, version);
563
Neels Hofmeyr981e1262019-11-05 02:00:19 +0100564 for (; allow_upgrade && (version < ARRAY_SIZE(db_upgrade_path)); version++) {
565 db_upgrade_func_t upgrade_func = db_upgrade_path[version];
566 rc = upgrade_func(dbc);
567 if (rc != SQLITE_DONE) {
568 LOGP(DDB, LOGL_ERROR, "Failed to upgrade HLR DB schema to version %d: (rc=%d) %s\n",
569 version+1, rc, sqlite3_errmsg(dbc->db));
570 goto out_free;
Stefan Sperling638ba8c2018-12-04 15:07:29 +0100571 }
572 LOGP(DDB, LOGL_NOTICE, "Database '%s' has been upgraded to HLR DB schema version %d\n",
Neels Hofmeyr981e1262019-11-05 02:00:19 +0100573 dbc->fname, version+1);
Stefan Sperling8f3a7cc2018-11-27 12:10:45 +0100574 }
575
576 if (version != CURRENT_SCHEMA_VERSION) {
577 if (version < CURRENT_SCHEMA_VERSION) {
578 LOGP(DDB, LOGL_NOTICE, "HLR DB schema version %d is outdated\n", version);
579 if (!allow_upgrade) {
580 LOGP(DDB, LOGL_ERROR, "Not upgrading HLR database to schema version %d; "
581 "use the --db-upgrade option to allow HLR database upgrades\n",
582 CURRENT_SCHEMA_VERSION);
583 }
584 } else
585 LOGP(DDB, LOGL_ERROR, "HLR DB schema version %d is unknown\n", version);
586
Vadim Yanitskiy050eb1d2018-07-30 20:48:19 +0700587 goto out_free;
588 }
Neels Hofmeyr7750d2c2017-10-24 23:26:27 +0200589
Harald Weltee72cf552016-04-28 07:18:49 +0200590 /* prepare all SQL statements */
591 for (i = 0; i < ARRAY_SIZE(dbc->stmt); i++) {
592 rc = sqlite3_prepare_v2(dbc->db, stmt_sql[i], -1,
593 &dbc->stmt[i], NULL);
594 if (rc != SQLITE_OK) {
595 LOGP(DDB, LOGL_ERROR, "Unable to prepare SQL statement '%s'\n", stmt_sql[i]);
596 goto out_free;
597 }
598 }
599
600 return dbc;
601out_free:
602 db_close(dbc);
603 return NULL;
604}