Harald Welte | 59b0468 | 2009-06-10 05:40:52 +0800 | [diff] [blame] | 1 | /* Simple HLR/VLR database backend using dbi */ |
| 2 | /* (C) 2008 by Jan Luebbe <jluebbe@debian.org> |
| 3 | * (C) 2009 by Holger Hans Peter Freyther <zecke@selfish.org> |
| 4 | * All Rights Reserved |
| 5 | * |
| 6 | * This program is free software; you can redistribute it and/or modify |
| 7 | * it under the terms of the GNU General Public License as published by |
| 8 | * the Free Software Foundation; either version 2 of the License, or |
| 9 | * (at your option) any later version. |
| 10 | * |
| 11 | * This program is distributed in the hope that it will be useful, |
| 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 14 | * GNU General Public License for more details. |
| 15 | * |
| 16 | * You should have received a copy of the GNU General Public License along |
| 17 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 18 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 19 | * |
| 20 | */ |
| 21 | |
| 22 | #include <openbsc/gsm_data.h> |
| 23 | #include <openbsc/db.h> |
| 24 | |
| 25 | #include <libgen.h> |
| 26 | #include <stdio.h> |
| 27 | #include <stdlib.h> |
| 28 | #include <string.h> |
| 29 | #include <errno.h> |
| 30 | #include <dbi/dbi.h> |
| 31 | |
| 32 | static char *db_basename = NULL; |
| 33 | static char *db_dirname = NULL; |
| 34 | static dbi_conn conn; |
| 35 | |
| 36 | static char *create_stmts[] = { |
| 37 | "CREATE TABLE IF NOT EXISTS Meta (" |
| 38 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 39 | "key TEXT UNIQUE NOT NULL, " |
| 40 | "value TEXT NOT NULL" |
| 41 | ")", |
| 42 | "INSERT OR IGNORE INTO Meta " |
| 43 | "(key, value) " |
| 44 | "VALUES " |
| 45 | "('revision', '1')", |
| 46 | "CREATE TABLE IF NOT EXISTS Subscriber (" |
| 47 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 48 | "created TIMESTAMP NOT NULL, " |
| 49 | "updated TIMESTAMP NOT NULL, " |
| 50 | "imsi NUMERIC UNIQUE NOT NULL, " |
| 51 | "name TEXT, " |
| 52 | "extension TEXT UNIQUE, " |
| 53 | "authorized INTEGER NOT NULL DEFAULT 0, " |
| 54 | "tmsi TEXT UNIQUE, " |
| 55 | "lac INTEGER NOT NULL DEFAULT 0" |
| 56 | ")", |
| 57 | "CREATE TABLE IF NOT EXISTS Equipment (" |
| 58 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 59 | "created TIMESTAMP NOT NULL, " |
| 60 | "updated TIMESTAMP NOT NULL, " |
| 61 | "name TEXT, " |
| 62 | "imei NUMERIC UNIQUE NOT NULL" |
| 63 | ")", |
| 64 | "CREATE TABLE IF NOT EXISTS EquipmentWatch (" |
| 65 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 66 | "created TIMESTAMP NOT NULL, " |
| 67 | "updated TIMESTAMP NOT NULL, " |
| 68 | "subscriber_id NUMERIC NOT NULL, " |
| 69 | "equipment_id NUMERIC NOT NULL, " |
| 70 | "UNIQUE (subscriber_id, equipment_id) " |
| 71 | ")", |
| 72 | "CREATE TABLE IF NOT EXISTS SMS (" |
| 73 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 74 | "created TIMESTAMP NOT NULL, " |
| 75 | "sent TIMESTAMP, " |
| 76 | "sender_id NUMERIC NOT NULL, " |
| 77 | "receiver_id NUMERIC NOT NULL, " |
| 78 | "header NUMERIC, " |
| 79 | "text TEXT NOT NULL " |
| 80 | ")", |
| 81 | "CREATE TABLE IF NOT EXISTS VLR (" |
| 82 | "id INTEGER PRIMARY KEY AUTOINCREMENT, " |
| 83 | "created TIMESTAMP NOT NULL, " |
| 84 | "updated TIMESTAMP NOT NULL, " |
| 85 | "subscriber_id NUMERIC UNIQUE NOT NULL, " |
| 86 | "last_bts NUMERIC NOT NULL " |
| 87 | ")", |
| 88 | }; |
| 89 | |
| 90 | void db_error_func(dbi_conn conn, void* data) { |
| 91 | const char* msg; |
| 92 | dbi_conn_error(conn, &msg); |
| 93 | printf("DBI: %s\n", msg); |
| 94 | } |
| 95 | |
| 96 | int db_init(const char *name) { |
| 97 | dbi_initialize(NULL); |
| 98 | conn = dbi_conn_new("sqlite3"); |
| 99 | if (conn==NULL) { |
| 100 | printf("DB: Failed to create connection.\n"); |
| 101 | return 1; |
| 102 | } |
| 103 | |
| 104 | dbi_conn_error_handler( conn, db_error_func, NULL ); |
| 105 | |
| 106 | /* MySQL |
| 107 | dbi_conn_set_option(conn, "host", "localhost"); |
| 108 | dbi_conn_set_option(conn, "username", "your_name"); |
| 109 | dbi_conn_set_option(conn, "password", "your_password"); |
| 110 | dbi_conn_set_option(conn, "dbname", "your_dbname"); |
| 111 | dbi_conn_set_option(conn, "encoding", "UTF-8"); |
| 112 | */ |
| 113 | |
| 114 | /* SqLite 3 */ |
| 115 | db_basename = strdup(name); |
| 116 | db_dirname = strdup(name); |
| 117 | dbi_conn_set_option(conn, "sqlite3_dbdir", dirname(db_dirname)); |
| 118 | dbi_conn_set_option(conn, "dbname", basename(db_basename)); |
| 119 | |
| 120 | if (dbi_conn_connect(conn) < 0) { |
| 121 | free(db_dirname); |
| 122 | free(db_basename); |
| 123 | db_dirname = db_basename = NULL; |
| 124 | return 1; |
| 125 | } |
| 126 | |
| 127 | return 0; |
| 128 | } |
| 129 | |
| 130 | int db_prepare() { |
| 131 | dbi_result result; |
| 132 | int i; |
| 133 | |
| 134 | for (i = 0; i < ARRAY_SIZE(create_stmts); i++) { |
| 135 | result = dbi_conn_query(conn, create_stmts[i]); |
| 136 | if (result==NULL) { |
| 137 | printf("DB: Failed to create some table.\n"); |
| 138 | return 1; |
| 139 | } |
| 140 | dbi_result_free(result); |
| 141 | } |
| 142 | |
| 143 | return 0; |
| 144 | } |
| 145 | |
| 146 | int db_fini() { |
| 147 | dbi_conn_close(conn); |
| 148 | dbi_shutdown(); |
| 149 | |
| 150 | if (db_dirname) |
| 151 | free(db_dirname); |
| 152 | if (db_basename) |
| 153 | free(db_basename); |
| 154 | return 0; |
| 155 | } |
| 156 | |
| 157 | struct gsm_subscriber* db_create_subscriber(char *imsi) { |
| 158 | dbi_result result; |
| 159 | struct gsm_subscriber* subscr; |
| 160 | |
| 161 | /* Is this subscriber known in the db? */ |
| 162 | subscr = db_get_subscriber(GSM_SUBSCRIBER_IMSI, imsi); |
| 163 | if (subscr) { |
| 164 | result = dbi_conn_queryf(conn, |
| 165 | "UPDATE Subscriber set updated = datetime('now') " |
| 166 | "WHERE imsi = %s " , imsi); |
| 167 | if (result==NULL) { |
| 168 | printf("DB: failed to update timestamp\n"); |
| 169 | } else { |
| 170 | dbi_result_free(result); |
| 171 | } |
| 172 | return subscr; |
| 173 | } |
| 174 | |
| 175 | subscr = subscr_alloc(); |
| 176 | if (!subscr) |
| 177 | return NULL; |
| 178 | result = dbi_conn_queryf(conn, |
| 179 | "INSERT INTO Subscriber " |
| 180 | "(imsi, created, updated) " |
| 181 | "VALUES " |
| 182 | "(%s, datetime('now'), datetime('now')) ", |
| 183 | imsi |
| 184 | ); |
| 185 | if (result==NULL) { |
| 186 | printf("DB: Failed to create Subscriber by IMSI.\n"); |
| 187 | } |
| 188 | subscr->id = dbi_conn_sequence_last(conn, NULL); |
| 189 | strncpy(subscr->imsi, imsi, GSM_IMSI_LENGTH-1); |
| 190 | dbi_result_free(result); |
| 191 | printf("DB: New Subscriber: ID %llu, IMSI %s\n", subscr->id, subscr->imsi); |
| 192 | return subscr; |
| 193 | } |
| 194 | |
| 195 | struct gsm_subscriber *db_get_subscriber(enum gsm_subscriber_field field, const char *id) { |
| 196 | dbi_result result; |
| 197 | const char *string; |
| 198 | char *quoted; |
| 199 | struct gsm_subscriber *subscr; |
| 200 | |
| 201 | switch (field) { |
| 202 | case GSM_SUBSCRIBER_IMSI: |
| 203 | dbi_conn_quote_string_copy(conn, id, "ed); |
| 204 | result = dbi_conn_queryf(conn, |
| 205 | "SELECT * FROM Subscriber " |
| 206 | "WHERE imsi = %s ", |
| 207 | quoted |
| 208 | ); |
| 209 | free(quoted); |
| 210 | break; |
| 211 | case GSM_SUBSCRIBER_TMSI: |
| 212 | dbi_conn_quote_string_copy(conn, id, "ed); |
| 213 | result = dbi_conn_queryf(conn, |
| 214 | "SELECT * FROM Subscriber " |
| 215 | "WHERE tmsi = %s ", |
| 216 | quoted |
| 217 | ); |
| 218 | free(quoted); |
| 219 | break; |
| 220 | case GSM_SUBSCRIBER_EXTENSION: |
| 221 | dbi_conn_quote_string_copy(conn, id, "ed); |
| 222 | result = dbi_conn_queryf(conn, |
| 223 | "SELECT * FROM Subscriber " |
| 224 | "WHERE extension = %s ", |
| 225 | quoted |
| 226 | ); |
| 227 | free(quoted); |
| 228 | break; |
| 229 | default: |
| 230 | printf("DB: Unknown query selector for Subscriber.\n"); |
| 231 | return NULL; |
| 232 | } |
| 233 | if (result==NULL) { |
| 234 | printf("DB: Failed to query Subscriber.\n"); |
| 235 | return NULL; |
| 236 | } |
| 237 | if (!dbi_result_next_row(result)) { |
| 238 | printf("DB: Failed to find the Subscriber. '%u' '%s'\n", |
| 239 | field, id); |
| 240 | dbi_result_free(result); |
| 241 | return NULL; |
| 242 | } |
| 243 | |
| 244 | subscr = subscr_alloc(); |
| 245 | subscr->id = dbi_result_get_ulonglong(result, "id"); |
| 246 | string = dbi_result_get_string(result, "imsi"); |
| 247 | if (string) |
| 248 | strncpy(subscr->imsi, string, GSM_IMSI_LENGTH); |
| 249 | |
| 250 | string = dbi_result_get_string(result, "tmsi"); |
| 251 | if (string) |
| 252 | strncpy(subscr->tmsi, string, GSM_TMSI_LENGTH); |
| 253 | |
| 254 | string = dbi_result_get_string(result, "name"); |
| 255 | if (string) |
| 256 | strncpy(subscr->name, string, GSM_NAME_LENGTH); |
| 257 | |
| 258 | string = dbi_result_get_string(result, "extension"); |
| 259 | if (string) |
| 260 | strncpy(subscr->extension, string, GSM_EXTENSION_LENGTH); |
| 261 | |
| 262 | subscr->lac = dbi_result_get_uint(result, "lac"); |
| 263 | subscr->authorized = dbi_result_get_uint(result, "authorized"); |
| 264 | printf("DB: Found Subscriber: ID %llu, IMSI %s, NAME '%s', TMSI %s, EXTEN '%s', LAC %hu, AUTH %u\n", |
| 265 | subscr->id, subscr->imsi, subscr->name, subscr->tmsi, subscr->extension, |
| 266 | subscr->lac, subscr->authorized); |
| 267 | dbi_result_free(result); |
| 268 | return subscr; |
| 269 | } |
| 270 | |
| 271 | int db_sync_subscriber(struct gsm_subscriber* subscriber) { |
| 272 | dbi_result result; |
| 273 | result = dbi_conn_queryf(conn, |
| 274 | "UPDATE Subscriber " |
| 275 | "SET updated = datetime('now'), " |
| 276 | "tmsi = '%s', " |
| 277 | "lac = %i, " |
| 278 | "authorized = %i " |
| 279 | "WHERE imsi = %s ", |
| 280 | subscriber->tmsi, subscriber->lac, subscriber->authorized, subscriber->imsi |
| 281 | ); |
| 282 | |
| 283 | if (result==NULL) { |
| 284 | printf("DB: Failed to update Subscriber (by IMSI).\n"); |
| 285 | return 1; |
| 286 | } |
| 287 | dbi_result_free(result); |
| 288 | return 0; |
| 289 | } |
| 290 | |
| 291 | int db_subscriber_alloc_tmsi(struct gsm_subscriber* subscriber) { |
| 292 | dbi_result result=NULL; |
| 293 | char* tmsi_quoted; |
| 294 | for (;;) { |
| 295 | sprintf(subscriber->tmsi, "%i", rand()); |
| 296 | dbi_conn_quote_string_copy(conn, subscriber->tmsi, &tmsi_quoted); |
| 297 | result = dbi_conn_queryf(conn, |
| 298 | "SELECT * FROM Subscriber " |
| 299 | "WHERE tmsi = %s ", |
| 300 | tmsi_quoted |
| 301 | ); |
| 302 | free(tmsi_quoted); |
| 303 | if (result==NULL) { |
| 304 | printf("DB: Failed to query Subscriber while allocating new TMSI.\n"); |
| 305 | return 1; |
| 306 | } |
| 307 | if (dbi_result_get_numrows(result)){ |
| 308 | dbi_result_free(result); |
| 309 | continue; |
| 310 | } |
| 311 | if (!dbi_result_next_row(result)) { |
| 312 | dbi_result_free(result); |
| 313 | printf("DB: Allocated TMSI %s for IMSI %s.\n", subscriber->tmsi, subscriber->imsi); |
| 314 | return db_sync_subscriber(subscriber); |
| 315 | } |
| 316 | dbi_result_free(result); |
| 317 | } |
| 318 | return 0; |
| 319 | } |
| 320 | |
| 321 | int db_subscriber_assoc_imei(struct gsm_subscriber* subscriber, char imei[GSM_IMEI_LENGTH]) { |
| 322 | u_int64_t equipment_id, watch_id; |
| 323 | dbi_result result; |
| 324 | |
| 325 | result = dbi_conn_queryf(conn, |
| 326 | "INSERT OR IGNORE INTO Equipment " |
| 327 | "(imei, created, updated) " |
| 328 | "VALUES " |
| 329 | "(%s, datetime('now'), datetime('now')) ", |
| 330 | imei |
| 331 | ); |
| 332 | if (result==NULL) { |
| 333 | printf("DB: Failed to create Equipment by IMEI.\n"); |
| 334 | return 1; |
| 335 | } |
| 336 | equipment_id = 0; |
| 337 | if (dbi_result_get_numrows_affected(result)) { |
| 338 | equipment_id = dbi_conn_sequence_last(conn, NULL); |
| 339 | } |
| 340 | dbi_result_free(result); |
| 341 | if (equipment_id) { |
| 342 | printf("DB: New Equipment: ID %llu, IMEI %s\n", equipment_id, imei); |
| 343 | } |
| 344 | else { |
| 345 | result = dbi_conn_queryf(conn, |
| 346 | "SELECT id FROM Equipment " |
| 347 | "WHERE imei = %s ", |
| 348 | imei |
| 349 | ); |
| 350 | if (result==NULL) { |
| 351 | printf("DB: Failed to query Equipment by IMEI.\n"); |
| 352 | return 1; |
| 353 | } |
| 354 | if (!dbi_result_next_row(result)) { |
| 355 | printf("DB: Failed to find the Equipment.\n"); |
| 356 | dbi_result_free(result); |
| 357 | return 1; |
| 358 | } |
| 359 | equipment_id = dbi_result_get_ulonglong(result, "id"); |
| 360 | dbi_result_free(result); |
| 361 | } |
| 362 | |
| 363 | result = dbi_conn_queryf(conn, |
| 364 | "INSERT OR IGNORE INTO EquipmentWatch " |
| 365 | "(subscriber_id, equipment_id, created, updated) " |
| 366 | "VALUES " |
| 367 | "(%llu, %llu, datetime('now'), datetime('now')) ", |
| 368 | subscriber->id, equipment_id |
| 369 | ); |
| 370 | if (result==NULL) { |
| 371 | printf("DB: Failed to create EquipmentWatch.\n"); |
| 372 | return 1; |
| 373 | } |
| 374 | watch_id = 0; |
| 375 | if (dbi_result_get_numrows_affected(result)) { |
| 376 | watch_id = dbi_conn_sequence_last(conn, NULL); |
| 377 | } |
| 378 | dbi_result_free(result); |
| 379 | if (watch_id) { |
| 380 | printf("DB: New EquipmentWatch: ID %llu, IMSI %s, IMEI %s\n", equipment_id, subscriber->imsi, imei); |
| 381 | } |
| 382 | else { |
| 383 | result = dbi_conn_queryf(conn, |
| 384 | "UPDATE EquipmentWatch " |
| 385 | "SET updated = datetime('now') " |
| 386 | "WHERE subscriber_id = %llu AND equipment_id = %llu ", |
| 387 | subscriber->id, equipment_id |
| 388 | ); |
| 389 | if (result==NULL) { |
| 390 | printf("DB: Failed to update EquipmentWatch.\n"); |
| 391 | return 1; |
| 392 | } |
| 393 | dbi_result_free(result); |
| 394 | printf("DB: Updated EquipmentWatch: ID %llu, IMSI %s, IMEI %s\n", equipment_id, subscriber->imsi, imei); |
| 395 | } |
| 396 | |
| 397 | return 0; |
| 398 | } |
| 399 | |
| 400 | /* store an [unsent] SMS to the database */ |
| 401 | int db_sms_store(struct gsm_sms *sms) |
| 402 | { |
| 403 | dbi_result result; |
| 404 | char *q_text; |
| 405 | |
| 406 | dbi_conn_quote_string_copy(conn, (char *)sms->text, &q_text); |
| 407 | result = dbi_conn_queryf(conn, |
| 408 | "INSERT INTO SMS " |
| 409 | "(created,sender_id,receiver_id,header,text) VALUES " |
| 410 | "(datetime('now'),%llu,%llu,%s,%s)", |
| 411 | sms->sender->id, |
| 412 | sms->receiver ? sms->receiver->id : 0, |
| 413 | NULL, q_text); |
| 414 | free(q_text); |
| 415 | |
| 416 | if (!result) |
| 417 | return -EIO; |
| 418 | |
| 419 | dbi_result_free(result); |
| 420 | return 0; |
| 421 | } |
| 422 | |
| 423 | /* retrieve the next unsent SMS with ID >= min_id */ |
| 424 | struct gsm_sms *db_sms_get_unsent(int min_id) |
| 425 | { |
| 426 | dbi_result result; |
| 427 | struct gsm_sms *sms = malloc(sizeof(*sms)); |
| 428 | |
| 429 | if (!sms) { |
| 430 | free(sms); |
| 431 | return NULL; |
| 432 | } |
| 433 | |
| 434 | result = dbi_conn_queryf(conn, |
| 435 | "SELECT * FROM SMS " |
| 436 | "WHERE id >= %llu ORDER BY id", min_id); |
| 437 | if (!result) { |
| 438 | free(sms); |
| 439 | return NULL; |
| 440 | } |
| 441 | |
| 442 | /* FIXME: fill gsm_sms from database */ |
| 443 | |
| 444 | dbi_result_free(result); |
| 445 | return sms; |
| 446 | } |
| 447 | |
| 448 | /* mark a given SMS as read */ |
| 449 | int db_sms_mark_sent(struct gsm_sms *sms) |
| 450 | { |
| 451 | dbi_result result; |
| 452 | |
| 453 | result = dbi_conn_queryf(conn, |
| 454 | "UPDATE SMS " |
| 455 | "SET sent = datetime('now') " |
| 456 | "WHERE id = %llu", sms->id); |
| 457 | if (!result) { |
| 458 | printf("DB: Failed to mark SMS %llu as sent.\n", sms->id); |
| 459 | return 1; |
| 460 | } |
| 461 | |
| 462 | dbi_result_free(result); |
| 463 | return 0; |
| 464 | } |