source3/printing/printer_list.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    Share Database of available printers.
   4    Copyright (C) Simo Sorce 2010
   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 3 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
  17    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19
  20 #include "includes.h"
  21 #include "system/filesys.h"
  22 #include "dbwrap/dbwrap.h"
  23 #include "dbwrap/dbwrap_open.h"
  24 #include "util_tdb.h"
  25 #include "printer_list.h"
  26
  27 #define PL_DB_NAME() lock_path("printer_list.tdb")
  28 #define PL_KEY_PREFIX "PRINTERLIST/PRN/"
  29 #define PL_KEY_FORMAT PL_KEY_PREFIX"%s"
  30 #define PL_TIMESTAMP_KEY "PRINTERLIST/GLOBAL/LAST_REFRESH"
  31 #define PL_DATA_FORMAT "ddPPP"
  32 #define PL_TSTAMP_FORMAT "dd"
  33
  34 static struct db_context *get_printer_list_db(void)
  35 {
  36         static struct db_context *db;
  37
  38         if (db != NULL) {
  39                 return db;
  40         }
  41         db = db_open(NULL, PL_DB_NAME(), 0,
  42                      TDB_DEFAULT|TDB_CLEAR_IF_FIRST|TDB_INCOMPATIBLE_HASH,
  43                      O_RDWR|O_CREAT, 0644, DBWRAP_LOCK_ORDER_1);
  44         return db;
  45 }
  46
  47 bool printer_list_parent_init(void)
  48 {
  49         struct db_context *db;
  50
  51         /*
  52          * Open the tdb in the parent process (smbd) so that our
  53          * CLEAR_IF_FIRST optimization in tdb_reopen_all can properly
  54          * work.
  55          */
  56
  57         db = get_printer_list_db();
  58         if (db == NULL) {
  59                 DEBUG(1, ("could not open Printer List Database: %s\n",
  60                           strerror(errno)));
  61                 return false;
  62         }
  63         return true;
  64 }
  65
  66 NTSTATUS printer_list_get_printer(TALLOC_CTX *mem_ctx,
  67                                   const char *name,
  68                                   const char **comment,
  69                                   const char **location,
  70                                   time_t *last_refresh)
  71 {
  72         struct db_context *db;
  73         char *key;
  74         TDB_DATA data;
  75         uint32_t time_h, time_l;
  76         char *nstr = NULL;
  77         char *cstr = NULL;
  78         char *lstr = NULL;
  79         NTSTATUS status;
  80         int ret;
  81
  82         db = get_printer_list_db();
  83         if (db == NULL) {
  84                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
  85         }
  86
  87         key = talloc_asprintf(mem_ctx, PL_KEY_FORMAT, name);
  88         if (!key) {
  89                 DEBUG(0, ("Failed to allocate key name!\n"));
  90                 return NT_STATUS_NO_MEMORY;
  91         }
  92
  93         status = dbwrap_fetch_bystring_upper(db, key, key, &data);
  94         if (!NT_STATUS_IS_OK(status)) {
  95                 DEBUG(6, ("Failed to fetch record! "
  96                           "The printer database is empty?\n"));
  97                 goto done;
  98         }
  99
 100         ret = tdb_unpack(data.dptr, data.dsize,
 101                          PL_DATA_FORMAT,
 102                          &time_h, &time_l, &nstr, &cstr, &lstr);
 103         if (ret == -1) {
 104                 DEBUG(1, ("Failed to un pack printer data"));
 105                 status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 106                 goto done;
 107         }
 108
 109         if (last_refresh) {
 110                 *last_refresh = (time_t)(((uint64_t)time_h << 32) + time_l);
 111         }
 112
 113         if (comment) {
 114                 *comment = talloc_strdup(mem_ctx, cstr);
 115                 if (!*comment) {
 116                         DEBUG(1, ("Failed to strdup comment!\n"));
 117                         status = NT_STATUS_NO_MEMORY;
 118                         goto done;
 119                 }
 120         }
 121
 122         if (location) {
 123                 *location = talloc_strdup(mem_ctx, lstr);
 124                 if (*location == NULL) {
 125                         DEBUG(1, ("Failed to strdup location!\n"));
 126                         status = NT_STATUS_NO_MEMORY;
 127                         goto done;
 128                 }
 129         }
 130
 131         status = NT_STATUS_OK;
 132
 133 done:
 134         SAFE_FREE(nstr);
 135         SAFE_FREE(cstr);
 136         TALLOC_FREE(key);
 137         return status;
 138 }
 139
 140 NTSTATUS printer_list_set_printer(TALLOC_CTX *mem_ctx,
 141                                   const char *name,
 142                                   const char *comment,
 143                                   const char *location,
 144                                   time_t last_refresh)
 145 {
 146         struct db_context *db;
 147         char *key;
 148         TDB_DATA data;
 149         uint64_t time_64;
 150         uint32_t time_h, time_l;
 151         NTSTATUS status;
 152         int len;
 153
 154         db = get_printer_list_db();
 155         if (db == NULL) {
 156                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 157         }
 158
 159         key = talloc_asprintf(mem_ctx, PL_KEY_FORMAT, name);
 160         if (!key) {
 161                 DEBUG(0, ("Failed to allocate key name!\n"));
 162                 return NT_STATUS_NO_MEMORY;
 163         }
 164
 165         if (comment == NULL) {
 166                 comment = "";
 167         }
 168
 169         if (location == NULL) {
 170                 location = "";
 171         }
 172
 173         time_64 = last_refresh;
 174         time_l = time_64 & 0xFFFFFFFFL;
 175         time_h = time_64 >> 32;
 176
 177         len = tdb_pack(NULL, 0,
 178                        PL_DATA_FORMAT,
 179                        time_h,
 180                        time_l,
 181                        name,
 182                        comment,
 183                        location);
 184
 185         data.dptr = talloc_array(key, uint8_t, len);
 186         if (!data.dptr) {
 187                 DEBUG(0, ("Failed to allocate tdb data buffer!\n"));
 188                 status = NT_STATUS_NO_MEMORY;
 189                 goto done;
 190         }
 191         data.dsize = len;
 192
 193         len = tdb_pack(data.dptr, data.dsize,
 194                        PL_DATA_FORMAT,
 195                        time_h,
 196                        time_l,
 197                        name,
 198                        comment,
 199                        location);
 200
 201         status = dbwrap_store_bystring_upper(db, key, data, TDB_REPLACE);
 202
 203 done:
 204         TALLOC_FREE(key);
 205         return status;
 206 }
 207
 208 NTSTATUS printer_list_get_last_refresh(time_t *last_refresh)
 209 {
 210         struct db_context *db;
 211         TDB_DATA data;
 212         uint32_t time_h, time_l;
 213         NTSTATUS status;
 214         int ret;
 215
 216         db = get_printer_list_db();
 217         if (db == NULL) {
 218                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 219         }
 220
 221         ZERO_STRUCT(data);
 222
 223         status = dbwrap_fetch_bystring(db, talloc_tos(), PL_TIMESTAMP_KEY, &data);
 224         if (!NT_STATUS_IS_OK(status)) {
 225                 DEBUG(1, ("Failed to fetch record!\n"));
 226                 goto done;
 227         }
 228
 229         ret = tdb_unpack(data.dptr, data.dsize,
 230                          PL_TSTAMP_FORMAT, &time_h, &time_l);
 231         if (ret == -1) {
 232                 DEBUG(1, ("Failed to un pack printer data"));
 233                 status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 234                 goto done;
 235         }
 236
 237         *last_refresh = (time_t)(((uint64_t)time_h << 32) + time_l);
 238         status = NT_STATUS_OK;
 239
 240 done:
 241         return status;
 242 }
 243
 244 NTSTATUS printer_list_mark_reload(void)
 245 {
 246         struct db_context *db;
 247         TDB_DATA data;
 248         uint32_t time_h, time_l;
 249         time_t now = time_mono(NULL);
 250         NTSTATUS status;
 251         int len;
 252
 253         db = get_printer_list_db();
 254         if (db == NULL) {
 255                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 256         }
 257
 258         time_l = ((uint64_t)now) & 0xFFFFFFFFL;
 259         time_h = ((uint64_t)now) >> 32;
 260
 261         len = tdb_pack(NULL, 0, PL_TSTAMP_FORMAT, time_h, time_l);
 262
 263         data.dptr = talloc_array(talloc_tos(), uint8_t, len);
 264         if (!data.dptr) {
 265                 DEBUG(0, ("Failed to allocate tdb data buffer!\n"));
 266                 status = NT_STATUS_NO_MEMORY;
 267                 goto done;
 268         }
 269         data.dsize = len;
 270
 271         len = tdb_pack(data.dptr, data.dsize,
 272                        PL_TSTAMP_FORMAT, time_h, time_l);
 273
 274         status = dbwrap_store_bystring(db, PL_TIMESTAMP_KEY,
 275                                                 data, TDB_REPLACE);
 276
 277 done:
 278         TALLOC_FREE(data.dptr);
 279         return status;
 280 }
 281
 282 typedef int (printer_list_trv_fn_t)(struct db_record *, void *);
 283
 284 static NTSTATUS printer_list_traverse(printer_list_trv_fn_t *fn,
 285                                                 void *private_data)
 286 {
 287         struct db_context *db;
 288         NTSTATUS status;
 289
 290         db = get_printer_list_db();
 291         if (db == NULL) {
 292                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 293         }
 294
 295         status = dbwrap_traverse(db, fn, private_data, NULL);
 296
 297         return status;
 298 }
 299
 300 struct printer_list_clean_state {
 301         time_t last_refresh;
 302         NTSTATUS status;
 303 };
 304
 305 static int printer_list_clean_fn(struct db_record *rec, void *private_data)
 306 {
 307         struct printer_list_clean_state *state =
 308                         (struct printer_list_clean_state *)private_data;
 309         uint32_t time_h, time_l;
 310         time_t refresh;
 311         char *name;
 312         char *comment;
 313         char *location;
 314         int ret;
 315         TDB_DATA key;
 316         TDB_DATA value;
 317
 318         key = dbwrap_record_get_key(rec);
 319
 320         /* skip anything that does not contain PL_DATA_FORMAT data */
 321         if (strncmp((char *)key.dptr,
 322                     PL_KEY_PREFIX, sizeof(PL_KEY_PREFIX)-1)) {
 323                 return 0;
 324         }
 325
 326         value = dbwrap_record_get_value(rec);
 327
 328         ret = tdb_unpack(value.dptr, value.dsize,
 329                          PL_DATA_FORMAT, &time_h, &time_l, &name, &comment,
 330                          &location);
 331         if (ret == -1) {
 332                 DEBUG(1, ("Failed to un pack printer data"));
 333                 state->status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 334                 return -1;
 335         }
 336
 337         SAFE_FREE(name);
 338         SAFE_FREE(comment);
 339         SAFE_FREE(location);
 340
 341         refresh = (time_t)(((uint64_t)time_h << 32) + time_l);
 342
 343         if (refresh < state->last_refresh) {
 344                 state->status = dbwrap_record_delete(rec);
 345                 if (!NT_STATUS_IS_OK(state->status)) {
 346                         return -1;
 347                 }
 348         }
 349
 350         return 0;
 351 }
 352
 353 NTSTATUS printer_list_clean_old(void)
 354 {
 355         struct printer_list_clean_state state;
 356         NTSTATUS status;
 357
 358         status = printer_list_get_last_refresh(&state.last_refresh);
 359         if (!NT_STATUS_IS_OK(status)) {
 360                 return status;
 361         }
 362
 363         state.status = NT_STATUS_OK;
 364
 365         status = printer_list_traverse(printer_list_clean_fn, &state);
 366         if (NT_STATUS_EQUAL(status, NT_STATUS_UNSUCCESSFUL) &&
 367             !NT_STATUS_IS_OK(state.status)) {
 368                 status = state.status;
 369         }
 370
 371         return status;
 372 }
 373
 374 struct printer_list_exec_state {
 375         void (*fn)(const char *, const char *, const char *, void *);
 376         void *private_data;
 377         NTSTATUS status;
 378 };
 379
 380 static int printer_list_exec_fn(struct db_record *rec, void *private_data)
 381 {
 382         struct printer_list_exec_state *state =
 383                         (struct printer_list_exec_state *)private_data;
 384         uint32_t time_h, time_l;
 385         char *name;
 386         char *comment;
 387         char *location;
 388         int ret;
 389         TDB_DATA key;
 390         TDB_DATA value;
 391
 392         key = dbwrap_record_get_key(rec);
 393
 394         /* always skip PL_TIMESTAMP_KEY key */
 395         if (strequal((const char *)key.dptr, PL_TIMESTAMP_KEY)) {
 396                 return 0;
 397         }
 398
 399         value = dbwrap_record_get_value(rec);
 400
 401         ret = tdb_unpack(value.dptr, value.dsize,
 402                          PL_DATA_FORMAT, &time_h, &time_l, &name, &comment,
 403                          &location);
 404         if (ret == -1) {
 405                 DEBUG(1, ("Failed to un pack printer data"));
 406                 state->status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 407                 return -1;
 408         }
 409
 410         state->fn(name, comment, location, state->private_data);
 411
 412         SAFE_FREE(name);
 413         SAFE_FREE(comment);
 414         SAFE_FREE(location);
 415         return 0;
 416 }
 417
 418 NTSTATUS printer_list_run_fn(void (*fn)(const char *, const char *, const char *, void *),
 419                              void *private_data)
 420 {
 421         struct printer_list_exec_state state;
 422         NTSTATUS status;
 423
 424         state.fn = fn;
 425         state.private_data = private_data;
 426         state.status = NT_STATUS_OK;
 427
 428         status = printer_list_traverse(printer_list_exec_fn, &state);
 429         if (NT_STATUS_EQUAL(status, NT_STATUS_UNSUCCESSFUL) &&
 430             !NT_STATUS_IS_OK(state.status)) {
 431                 status = state.status;
 432         }
 433
 434         return status;
 435 }