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