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