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         SAFE_FREE(lstr);
 137         TALLOC_FREE(key);
 138         return status;
 139 }
 140
 141 NTSTATUS printer_list_set_printer(TALLOC_CTX *mem_ctx,
 142                                   const char *name,
 143                                   const char *comment,
 144                                   const char *location,
 145                                   time_t last_refresh)
 146 {
 147         struct db_context *db;
 148         char *key;
 149         TDB_DATA data;
 150         uint64_t time_64;
 151         uint32_t time_h, time_l;
 152         NTSTATUS status;
 153         int len;
 154
 155         db = get_printer_list_db();
 156         if (db == NULL) {
 157                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 158         }
 159
 160         key = talloc_asprintf(mem_ctx, PL_KEY_FORMAT, name);
 161         if (!key) {
 162                 DEBUG(0, ("Failed to allocate key name!\n"));
 163                 return NT_STATUS_NO_MEMORY;
 164         }
 165
 166         if (comment == NULL) {
 167                 comment = "";
 168         }
 169
 170         if (location == NULL) {
 171                 location = "";
 172         }
 173
 174         time_64 = last_refresh;
 175         time_l = time_64 & 0xFFFFFFFFL;
 176         time_h = time_64 >> 32;
 177
 178         len = tdb_pack(NULL, 0,
 179                        PL_DATA_FORMAT,
 180                        time_h,
 181                        time_l,
 182                        name,
 183                        comment,
 184                        location);
 185
 186         data.dptr = talloc_array(key, uint8_t, len);
 187         if (!data.dptr) {
 188                 DEBUG(0, ("Failed to allocate tdb data buffer!\n"));
 189                 status = NT_STATUS_NO_MEMORY;
 190                 goto done;
 191         }
 192         data.dsize = len;
 193
 194         len = tdb_pack(data.dptr, data.dsize,
 195                        PL_DATA_FORMAT,
 196                        time_h,
 197                        time_l,
 198                        name,
 199                        comment,
 200                        location);
 201
 202         status = dbwrap_store_bystring_upper(db, key, data, TDB_REPLACE);
 203
 204 done:
 205         TALLOC_FREE(key);
 206         return status;
 207 }
 208
 209 NTSTATUS printer_list_get_last_refresh(time_t *last_refresh)
 210 {
 211         struct db_context *db;
 212         TDB_DATA data;
 213         uint32_t time_h, time_l;
 214         NTSTATUS status;
 215         int ret;
 216
 217         db = get_printer_list_db();
 218         if (db == NULL) {
 219                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 220         }
 221
 222         ZERO_STRUCT(data);
 223
 224         status = dbwrap_fetch_bystring(db, talloc_tos(), PL_TIMESTAMP_KEY, &data);
 225         if (!NT_STATUS_IS_OK(status)) {
 226                 DEBUG(1, ("Failed to fetch record!\n"));
 227                 goto done;
 228         }
 229
 230         ret = tdb_unpack(data.dptr, data.dsize,
 231                          PL_TSTAMP_FORMAT, &time_h, &time_l);
 232         if (ret == -1) {
 233                 DEBUG(1, ("Failed to un pack printer data"));
 234                 status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 235                 goto done;
 236         }
 237
 238         *last_refresh = (time_t)(((uint64_t)time_h << 32) + time_l);
 239         status = NT_STATUS_OK;
 240
 241 done:
 242         return status;
 243 }
 244
 245 NTSTATUS printer_list_mark_reload(void)
 246 {
 247         struct db_context *db;
 248         TDB_DATA data;
 249         uint32_t time_h, time_l;
 250         time_t now = time_mono(NULL);
 251         NTSTATUS status;
 252         int len;
 253
 254         db = get_printer_list_db();
 255         if (db == NULL) {
 256                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 257         }
 258
 259         time_l = ((uint64_t)now) & 0xFFFFFFFFL;
 260         time_h = ((uint64_t)now) >> 32;
 261
 262         len = tdb_pack(NULL, 0, PL_TSTAMP_FORMAT, time_h, time_l);
 263
 264         data.dptr = talloc_array(talloc_tos(), uint8_t, len);
 265         if (!data.dptr) {
 266                 DEBUG(0, ("Failed to allocate tdb data buffer!\n"));
 267                 status = NT_STATUS_NO_MEMORY;
 268                 goto done;
 269         }
 270         data.dsize = len;
 271
 272         len = tdb_pack(data.dptr, data.dsize,
 273                        PL_TSTAMP_FORMAT, time_h, time_l);
 274
 275         status = dbwrap_store_bystring(db, PL_TIMESTAMP_KEY,
 276                                                 data, TDB_REPLACE);
 277
 278 done:
 279         TALLOC_FREE(data.dptr);
 280         return status;
 281 }
 282
 283 typedef int (printer_list_trv_fn_t)(struct db_record *, void *);
 284
 285 static NTSTATUS printer_list_traverse(printer_list_trv_fn_t *fn,
 286                                       void *private_data,
 287                                       bool read_only)
 288 {
 289         struct db_context *db;
 290         NTSTATUS status;
 291
 292         db = get_printer_list_db();
 293         if (db == NULL) {
 294                 return NT_STATUS_INTERNAL_DB_CORRUPTION;
 295         }
 296
 297         if (read_only) {
 298                 status = dbwrap_traverse_read(db, fn, private_data, NULL);
 299         } else {
 300                 status = dbwrap_traverse(db, fn, private_data, NULL);
 301         }
 302
 303         return status;
 304 }
 305
 306 struct printer_list_clean_state {
 307         time_t last_refresh;
 308         NTSTATUS status;
 309 };
 310
 311 static int printer_list_clean_fn(struct db_record *rec, void *private_data)
 312 {
 313         struct printer_list_clean_state *state =
 314                         (struct printer_list_clean_state *)private_data;
 315         uint32_t time_h, time_l;
 316         time_t refresh;
 317         char *name;
 318         char *comment;
 319         char *location;
 320         int ret;
 321         TDB_DATA key;
 322         TDB_DATA value;
 323
 324         key = dbwrap_record_get_key(rec);
 325
 326         /* skip anything that does not contain PL_DATA_FORMAT data */
 327         if (strncmp((char *)key.dptr,
 328                     PL_KEY_PREFIX, sizeof(PL_KEY_PREFIX)-1)) {
 329                 return 0;
 330         }
 331
 332         value = dbwrap_record_get_value(rec);
 333
 334         ret = tdb_unpack(value.dptr, value.dsize,
 335                          PL_DATA_FORMAT, &time_h, &time_l, &name, &comment,
 336                          &location);
 337         if (ret == -1) {
 338                 DEBUG(1, ("Failed to un pack printer data"));
 339                 state->status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 340                 return -1;
 341         }
 342
 343         SAFE_FREE(name);
 344         SAFE_FREE(comment);
 345         SAFE_FREE(location);
 346
 347         refresh = (time_t)(((uint64_t)time_h << 32) + time_l);
 348
 349         if (refresh < state->last_refresh) {
 350                 state->status = dbwrap_record_delete(rec);
 351                 if (!NT_STATUS_IS_OK(state->status)) {
 352                         return -1;
 353                 }
 354         }
 355
 356         return 0;
 357 }
 358
 359 NTSTATUS printer_list_clean_old(void)
 360 {
 361         struct printer_list_clean_state state;
 362         NTSTATUS status;
 363
 364         status = printer_list_get_last_refresh(&state.last_refresh);
 365         if (!NT_STATUS_IS_OK(status)) {
 366                 return status;
 367         }
 368
 369         state.status = NT_STATUS_OK;
 370
 371         status = printer_list_traverse(printer_list_clean_fn, &state, false);
 372         if (NT_STATUS_EQUAL(status, NT_STATUS_UNSUCCESSFUL) &&
 373             !NT_STATUS_IS_OK(state.status)) {
 374                 status = state.status;
 375         }
 376
 377         return status;
 378 }
 379
 380 struct printer_list_exec_state {
 381         void (*fn)(const char *, const char *, const char *, void *);
 382         void *private_data;
 383         NTSTATUS status;
 384 };
 385
 386 static int printer_list_exec_fn(struct db_record *rec, void *private_data)
 387 {
 388         struct printer_list_exec_state *state =
 389                         (struct printer_list_exec_state *)private_data;
 390         uint32_t time_h, time_l;
 391         char *name;
 392         char *comment;
 393         char *location;
 394         int ret;
 395         TDB_DATA key;
 396         TDB_DATA value;
 397
 398         key = dbwrap_record_get_key(rec);
 399
 400         /* always skip PL_TIMESTAMP_KEY key */
 401         if (strequal((const char *)key.dptr, PL_TIMESTAMP_KEY)) {
 402                 return 0;
 403         }
 404
 405         value = dbwrap_record_get_value(rec);
 406
 407         ret = tdb_unpack(value.dptr, value.dsize,
 408                          PL_DATA_FORMAT, &time_h, &time_l, &name, &comment,
 409                          &location);
 410         if (ret == -1) {
 411                 DEBUG(1, ("Failed to un pack printer data"));
 412                 state->status = NT_STATUS_INTERNAL_DB_CORRUPTION;
 413                 return -1;
 414         }
 415
 416         state->fn(name, comment, location, state->private_data);
 417
 418         SAFE_FREE(name);
 419         SAFE_FREE(comment);
 420         SAFE_FREE(location);
 421         return 0;
 422 }
 423
 424 NTSTATUS printer_list_read_run_fn(void (*fn)(const char *, const char *, const char *, void *),
 425                                   void *private_data)
 426 {
 427         struct printer_list_exec_state state;
 428         NTSTATUS status;
 429
 430         state.fn = fn;
 431         state.private_data = private_data;
 432         state.status = NT_STATUS_OK;
 433
 434         status = printer_list_traverse(printer_list_exec_fn, &state, true);
 435         if (NT_STATUS_EQUAL(status, NT_STATUS_UNSUCCESSFUL) &&
 436             !NT_STATUS_IS_OK(state.status)) {
 437                 status = state.status;
 438         }
 439
 440         return status;
 441 }