source3/printing/printing.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    printing backend routines
   5    Copyright (C) Andrew Tridgell 1992-2000
   6    Copyright (C) Jeremy Allison 2002
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "printing.h"
  24 #include "librpc/gen_ndr/messaging.h"
  25 #include "../librpc/gen_ndr/ndr_spoolss.h"
  26 #include "nt_printing.h"
  27 #include "../librpc/gen_ndr/netlogon.h"
  28
  29 extern struct current_user current_user;
  30 extern userdom_struct current_user_info;
  31
  32 /* Current printer interface */
  33 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid);
  34
  35 /*
  36    the printing backend revolves around a tdb database that stores the
  37    SMB view of the print queue
  38
  39    The key for this database is a jobid - a internally generated number that
  40    uniquely identifies a print job
  41
  42    reading the print queue involves two steps:
  43      - possibly running lpq and updating the internal database from that
  44      - reading entries from the database
  45
  46    jobids are assigned when a job starts spooling.
  47 */
  48
  49 static TDB_CONTEXT *rap_tdb;
  50 static uint16 next_rap_jobid;
  51 struct rap_jobid_key {
  52         fstring sharename;
  53         uint32  jobid;
  54 };
  55
  56 /***************************************************************************
  57  Nightmare. LANMAN jobid's are 16 bit numbers..... We must map them to 32
  58  bit RPC jobids.... JRA.
  59 ***************************************************************************/
  60
  61 uint16 pjobid_to_rap(const char* sharename, uint32 jobid)
  62 {
  63         uint16 rap_jobid;
  64         TDB_DATA data, key;
  65         struct rap_jobid_key jinfo;
  66         uint8 buf[2];
  67
  68         DEBUG(10,("pjobid_to_rap: called.\n"));
  69
  70         if (!rap_tdb) {
  71                 /* Create the in-memory tdb. */
  72                 rap_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL, (O_RDWR|O_CREAT), 0644);
  73                 if (!rap_tdb)
  74                         return 0;
  75         }
  76
  77         ZERO_STRUCT( jinfo );
  78         fstrcpy( jinfo.sharename, sharename );
  79         jinfo.jobid = jobid;
  80         key.dptr = (uint8 *)&jinfo;
  81         key.dsize = sizeof(jinfo);
  82
  83         data = tdb_fetch(rap_tdb, key);
  84         if (data.dptr && data.dsize == sizeof(uint16)) {
  85                 rap_jobid = SVAL(data.dptr, 0);
  86                 SAFE_FREE(data.dptr);
  87                 DEBUG(10,("pjobid_to_rap: jobid %u maps to RAP jobid %u\n",
  88                         (unsigned int)jobid, (unsigned int)rap_jobid));
  89                 return rap_jobid;
  90         }
  91         SAFE_FREE(data.dptr);
  92         /* Not found - create and store mapping. */
  93         rap_jobid = ++next_rap_jobid;
  94         if (rap_jobid == 0)
  95                 rap_jobid = ++next_rap_jobid;
  96         SSVAL(buf,0,rap_jobid);
  97         data.dptr = buf;
  98         data.dsize = sizeof(rap_jobid);
  99         tdb_store(rap_tdb, key, data, TDB_REPLACE);
 100         tdb_store(rap_tdb, data, key, TDB_REPLACE);
 101
 102         DEBUG(10,("pjobid_to_rap: created jobid %u maps to RAP jobid %u\n",
 103                 (unsigned int)jobid, (unsigned int)rap_jobid));
 104         return rap_jobid;
 105 }
 106
 107 bool rap_to_pjobid(uint16 rap_jobid, fstring sharename, uint32 *pjobid)
 108 {
 109         TDB_DATA data, key;
 110         uint8 buf[2];
 111
 112         DEBUG(10,("rap_to_pjobid called.\n"));
 113
 114         if (!rap_tdb)
 115                 return False;
 116
 117         SSVAL(buf,0,rap_jobid);
 118         key.dptr = buf;
 119         key.dsize = sizeof(rap_jobid);
 120         data = tdb_fetch(rap_tdb, key);
 121         if ( data.dptr && data.dsize == sizeof(struct rap_jobid_key) )
 122         {
 123                 struct rap_jobid_key *jinfo = (struct rap_jobid_key*)data.dptr;
 124                 if (sharename != NULL) {
 125                         fstrcpy( sharename, jinfo->sharename );
 126                 }
 127                 *pjobid = jinfo->jobid;
 128                 DEBUG(10,("rap_to_pjobid: jobid %u maps to RAP jobid %u\n",
 129                         (unsigned int)*pjobid, (unsigned int)rap_jobid));
 130                 SAFE_FREE(data.dptr);
 131                 return True;
 132         }
 133
 134         DEBUG(10,("rap_to_pjobid: Failed to lookup RAP jobid %u\n",
 135                 (unsigned int)rap_jobid));
 136         SAFE_FREE(data.dptr);
 137         return False;
 138 }
 139
 140 void rap_jobid_delete(const char* sharename, uint32 jobid)
 141 {
 142         TDB_DATA key, data;
 143         uint16 rap_jobid;
 144         struct rap_jobid_key jinfo;
 145         uint8 buf[2];
 146
 147         DEBUG(10,("rap_jobid_delete: called.\n"));
 148
 149         if (!rap_tdb)
 150                 return;
 151
 152         ZERO_STRUCT( jinfo );
 153         fstrcpy( jinfo.sharename, sharename );
 154         jinfo.jobid = jobid;
 155         key.dptr = (uint8 *)&jinfo;
 156         key.dsize = sizeof(jinfo);
 157
 158         data = tdb_fetch(rap_tdb, key);
 159         if (!data.dptr || (data.dsize != sizeof(uint16))) {
 160                 DEBUG(10,("rap_jobid_delete: cannot find jobid %u\n",
 161                         (unsigned int)jobid ));
 162                 SAFE_FREE(data.dptr);
 163                 return;
 164         }
 165
 166         DEBUG(10,("rap_jobid_delete: deleting jobid %u\n",
 167                 (unsigned int)jobid ));
 168
 169         rap_jobid = SVAL(data.dptr, 0);
 170         SAFE_FREE(data.dptr);
 171         SSVAL(buf,0,rap_jobid);
 172         data.dptr = buf;
 173         data.dsize = sizeof(rap_jobid);
 174         tdb_delete(rap_tdb, key);
 175         tdb_delete(rap_tdb, data);
 176 }
 177
 178 static int get_queue_status(const char* sharename, print_status_struct *);
 179
 180 /****************************************************************************
 181  Initialise the printing backend. Called once at startup before the fork().
 182 ****************************************************************************/
 183
 184 bool print_backend_init(struct messaging_context *msg_ctx)
 185 {
 186         const char *sversion = "INFO/version";
 187         int services = lp_numservices();
 188         int snum;
 189
 190         unlink(cache_path("printing.tdb"));
 191         mkdir(cache_path("printing"),0755);
 192
 193         /* handle a Samba upgrade */
 194
 195         for (snum = 0; snum < services; snum++) {
 196                 struct tdb_print_db *pdb;
 197                 if (!lp_print_ok(snum))
 198                         continue;
 199
 200                 pdb = get_print_db_byname(lp_const_servicename(snum));
 201                 if (!pdb)
 202                         continue;
 203                 if (tdb_lock_bystring(pdb->tdb, sversion) == -1) {
 204                         DEBUG(0,("print_backend_init: Failed to open printer %s database\n", lp_const_servicename(snum) ));
 205                         release_print_db(pdb);
 206                         return False;
 207                 }
 208                 if (tdb_fetch_int32(pdb->tdb, sversion) != PRINT_DATABASE_VERSION) {
 209                         tdb_wipe_all(pdb->tdb);
 210                         tdb_store_int32(pdb->tdb, sversion, PRINT_DATABASE_VERSION);
 211                 }
 212                 tdb_unlock_bystring(pdb->tdb, sversion);
 213                 release_print_db(pdb);
 214         }
 215
 216         close_all_print_db(); /* Don't leave any open. */
 217
 218         /* do NT print initialization... */
 219         return nt_printing_init(msg_ctx);
 220 }
 221
 222 /****************************************************************************
 223  Shut down printing backend. Called once at shutdown to close the tdb.
 224 ****************************************************************************/
 225
 226 void printing_end(void)
 227 {
 228         close_all_print_db(); /* Don't leave any open. */
 229 }
 230
 231 /****************************************************************************
 232  Retrieve the set of printing functions for a given service.  This allows
 233  us to set the printer function table based on the value of the 'printing'
 234  service parameter.
 235
 236  Use the generic interface as the default and only use cups interface only
 237  when asked for (and only when supported)
 238 ****************************************************************************/
 239
 240 static struct printif *get_printer_fns_from_type( enum printing_types type )
 241 {
 242         struct printif *printer_fns = &generic_printif;
 243
 244 #ifdef HAVE_CUPS
 245         if ( type == PRINT_CUPS ) {
 246                 printer_fns = &cups_printif;
 247         }
 248 #endif /* HAVE_CUPS */
 249
 250 #ifdef HAVE_IPRINT
 251         if ( type == PRINT_IPRINT ) {
 252                 printer_fns = &iprint_printif;
 253         }
 254 #endif /* HAVE_IPRINT */
 255
 256         printer_fns->type = type;
 257
 258         return printer_fns;
 259 }
 260
 261 static struct printif *get_printer_fns( int snum )
 262 {
 263         return get_printer_fns_from_type( (enum printing_types)lp_printing(snum) );
 264 }
 265
 266
 267 /****************************************************************************
 268  Useful function to generate a tdb key.
 269 ****************************************************************************/
 270
 271 static TDB_DATA print_key(uint32 jobid, uint32 *tmp)
 272 {
 273         TDB_DATA ret;
 274
 275         SIVAL(tmp, 0, jobid);
 276         ret.dptr = (uint8 *)tmp;
 277         ret.dsize = sizeof(*tmp);
 278         return ret;
 279 }
 280
 281 /****************************************************************************
 282  Pack the devicemode to store it in a tdb.
 283 ****************************************************************************/
 284 static int pack_devicemode(struct spoolss_DeviceMode *devmode, uint8 *buf, int buflen)
 285 {
 286         enum ndr_err_code ndr_err;
 287         DATA_BLOB blob;
 288         int len = 0;
 289
 290         if (devmode) {
 291                 ndr_err = ndr_push_struct_blob(&blob, talloc_tos(),
 292                                                devmode,
 293                                                (ndr_push_flags_fn_t)
 294                                                ndr_push_spoolss_DeviceMode);
 295                 if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 296                         DEBUG(10, ("pack_devicemode: "
 297                                    "error encoding spoolss_DeviceMode\n"));
 298                         goto done;
 299                 }
 300         } else {
 301                 ZERO_STRUCT(blob);
 302         }
 303
 304         len = tdb_pack(buf, buflen, "B", blob.length, blob.data);
 305
 306         if (devmode) {
 307                 DEBUG(8, ("Packed devicemode [%s]\n", devmode->formname));
 308         }
 309
 310 done:
 311         return len;
 312 }
 313
 314 /****************************************************************************
 315  Unpack the devicemode to store it in a tdb.
 316 ****************************************************************************/
 317 static int unpack_devicemode(TALLOC_CTX *mem_ctx,
 318                       const uint8 *buf, int buflen,
 319                       struct spoolss_DeviceMode **devmode)
 320 {
 321         struct spoolss_DeviceMode *dm;
 322         enum ndr_err_code ndr_err;
 323         char *data = NULL;
 324         int data_len = 0;
 325         DATA_BLOB blob;
 326         int len = 0;
 327
 328         *devmode = NULL;
 329
 330         len = tdb_unpack(buf, buflen, "B", &data_len, &data);
 331         if (!data) {
 332                 return len;
 333         }
 334
 335         dm = talloc_zero(mem_ctx, struct spoolss_DeviceMode);
 336         if (!dm) {
 337                 goto done;
 338         }
 339
 340         blob = data_blob_const(data, data_len);
 341
 342         ndr_err = ndr_pull_struct_blob(&blob, dm, dm,
 343                         (ndr_pull_flags_fn_t)ndr_pull_spoolss_DeviceMode);
 344         if (!NDR_ERR_CODE_IS_SUCCESS(ndr_err)) {
 345                 DEBUG(10, ("unpack_devicemode: "
 346                            "error parsing spoolss_DeviceMode\n"));
 347                 goto done;
 348         }
 349
 350         DEBUG(8, ("Unpacked devicemode [%s](%s)\n",
 351                   dm->devicename, dm->formname));
 352         if (dm->driverextra_data.data) {
 353                 DEBUG(8, ("with a private section of %d bytes\n",
 354                           dm->__driverextra_length));
 355         }
 356
 357         *devmode = dm;
 358
 359 done:
 360         SAFE_FREE(data);
 361         return len;
 362 }
 363
 364 /***********************************************************************
 365  unpack a pjob from a tdb buffer
 366 ***********************************************************************/
 367
 368 int unpack_pjob( uint8 *buf, int buflen, struct printjob *pjob )
 369 {
 370         int     len = 0;
 371         int     used;
 372         uint32 pjpid, pjsysjob, pjfd, pjstarttime, pjstatus;
 373         uint32 pjsize, pjpage_count, pjspooled, pjsmbjob;
 374
 375         if ( !buf || !pjob )
 376                 return -1;
 377
 378         len += tdb_unpack(buf+len, buflen-len, "dddddddddffff",
 379                                 &pjpid,
 380                                 &pjsysjob,
 381                                 &pjfd,
 382                                 &pjstarttime,
 383                                 &pjstatus,
 384                                 &pjsize,
 385                                 &pjpage_count,
 386                                 &pjspooled,
 387                                 &pjsmbjob,
 388                                 pjob->filename,
 389                                 pjob->jobname,
 390                                 pjob->user,
 391                                 pjob->queuename);
 392
 393         if ( len == -1 )
 394                 return -1;
 395
 396         used = unpack_devicemode(NULL, buf+len, buflen-len, &pjob->devmode);
 397         if (used == -1) {
 398                 return -1;
 399         }
 400
 401         len += used;
 402
 403         pjob->pid = pjpid;
 404         pjob->sysjob = pjsysjob;
 405         pjob->fd = pjfd;
 406         pjob->starttime = pjstarttime;
 407         pjob->status = pjstatus;
 408         pjob->size = pjsize;
 409         pjob->page_count = pjpage_count;
 410         pjob->spooled = pjspooled;
 411         pjob->smbjob = pjsmbjob;
 412
 413         return len;
 414
 415 }
 416
 417 /****************************************************************************
 418  Useful function to find a print job in the database.
 419 ****************************************************************************/
 420
 421 static struct printjob *print_job_find(const char *sharename, uint32 jobid)
 422 {
 423         static struct printjob  pjob;
 424         uint32_t tmp;
 425         TDB_DATA                ret;
 426         struct tdb_print_db     *pdb = get_print_db_byname(sharename);
 427
 428         DEBUG(10,("print_job_find: looking up job %u for share %s\n",
 429                         (unsigned int)jobid, sharename ));
 430
 431         if (!pdb) {
 432                 return NULL;
 433         }
 434
 435         ret = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
 436         release_print_db(pdb);
 437
 438         if (!ret.dptr) {
 439                 DEBUG(10,("print_job_find: failed to find jobid %u.\n", (unsigned int)jobid ));
 440                 return NULL;
 441         }
 442
 443         talloc_free(pjob.devmode);
 444
 445         ZERO_STRUCT( pjob );
 446
 447         if ( unpack_pjob( ret.dptr, ret.dsize, &pjob ) == -1 ) {
 448                 DEBUG(10,("print_job_find: failed to unpack jobid %u.\n", (unsigned int)jobid ));
 449                 SAFE_FREE(ret.dptr);
 450                 return NULL;
 451         }
 452
 453         SAFE_FREE(ret.dptr);
 454
 455         DEBUG(10,("print_job_find: returning system job %d for jobid %u.\n",
 456                         (int)pjob.sysjob, (unsigned int)jobid ));
 457
 458         return &pjob;
 459 }
 460
 461 /* Convert a unix jobid to a smb jobid */
 462
 463 struct unixjob_traverse_state {
 464         int sysjob;
 465         uint32 sysjob_to_jobid_value;
 466 };
 467
 468 static int unixjob_traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA key,
 469                                TDB_DATA data, void *private_data)
 470 {
 471         struct printjob *pjob;
 472         struct unixjob_traverse_state *state =
 473                 (struct unixjob_traverse_state *)private_data;
 474
 475         if (!data.dptr || data.dsize == 0)
 476                 return 0;
 477
 478         pjob = (struct printjob *)data.dptr;
 479         if (key.dsize != sizeof(uint32))
 480                 return 0;
 481
 482         if (state->sysjob == pjob->sysjob) {
 483                 uint32 jobid = IVAL(key.dptr,0);
 484
 485                 state->sysjob_to_jobid_value = jobid;
 486                 return 1;
 487         }
 488
 489         return 0;
 490 }
 491
 492 /****************************************************************************
 493  This is a *horribly expensive call as we have to iterate through all the
 494  current printer tdb's. Don't do this often ! JRA.
 495 ****************************************************************************/
 496
 497 uint32 sysjob_to_jobid(int unix_jobid)
 498 {
 499         int services = lp_numservices();
 500         int snum;
 501         struct unixjob_traverse_state state;
 502
 503         state.sysjob = unix_jobid;
 504         state.sysjob_to_jobid_value = (uint32)-1;
 505
 506         for (snum = 0; snum < services; snum++) {
 507                 struct tdb_print_db *pdb;
 508                 if (!lp_print_ok(snum))
 509                         continue;
 510                 pdb = get_print_db_byname(lp_const_servicename(snum));
 511                 if (!pdb) {
 512                         continue;
 513                 }
 514                 tdb_traverse(pdb->tdb, unixjob_traverse_fn, &state);
 515                 release_print_db(pdb);
 516                 if (state.sysjob_to_jobid_value != (uint32)-1)
 517                         return state.sysjob_to_jobid_value;
 518         }
 519         return (uint32)-1;
 520 }
 521
 522 /****************************************************************************
 523  Send notifications based on what has changed after a pjob_store.
 524 ****************************************************************************/
 525
 526 static const struct {
 527         uint32 lpq_status;
 528         uint32 spoolss_status;
 529 } lpq_to_spoolss_status_map[] = {
 530         { LPQ_QUEUED, JOB_STATUS_QUEUED },
 531         { LPQ_PAUSED, JOB_STATUS_PAUSED },
 532         { LPQ_SPOOLING, JOB_STATUS_SPOOLING },
 533         { LPQ_PRINTING, JOB_STATUS_PRINTING },
 534         { LPQ_DELETING, JOB_STATUS_DELETING },
 535         { LPQ_OFFLINE, JOB_STATUS_OFFLINE },
 536         { LPQ_PAPEROUT, JOB_STATUS_PAPEROUT },
 537         { LPQ_PRINTED, JOB_STATUS_PRINTED },
 538         { LPQ_DELETED, JOB_STATUS_DELETED },
 539         { LPQ_BLOCKED, JOB_STATUS_BLOCKED_DEVQ },
 540         { LPQ_USER_INTERVENTION, JOB_STATUS_USER_INTERVENTION },
 541         { -1, 0 }
 542 };
 543
 544 /* Convert a lpq status value stored in printing.tdb into the
 545    appropriate win32 API constant. */
 546
 547 static uint32 map_to_spoolss_status(uint32 lpq_status)
 548 {
 549         int i = 0;
 550
 551         while (lpq_to_spoolss_status_map[i].lpq_status != -1) {
 552                 if (lpq_to_spoolss_status_map[i].lpq_status == lpq_status)
 553                         return lpq_to_spoolss_status_map[i].spoolss_status;
 554                 i++;
 555         }
 556
 557         return 0;
 558 }
 559
 560 static void pjob_store_notify(const char* sharename, uint32 jobid, struct printjob *old_data,
 561                               struct printjob *new_data)
 562 {
 563         bool new_job = False;
 564
 565         if (!old_data)
 566                 new_job = True;
 567
 568         /* Job attributes that can't be changed.  We only send
 569            notification for these on a new job. */
 570
 571         /* ACHTUNG!  Due to a bug in Samba's spoolss parsing of the
 572            NOTIFY_INFO_DATA buffer, we *have* to send the job submission
 573            time first or else we'll end up with potential alignment
 574            errors.  I don't think the systemtime should be spooled as
 575            a string, but this gets us around that error.
 576            --jerry (i'll feel dirty for this) */
 577
 578         if (new_job) {
 579                 notify_job_submitted(sharename, jobid, new_data->starttime);
 580                 notify_job_username(sharename, jobid, new_data->user);
 581         }
 582
 583         if (new_job || !strequal(old_data->jobname, new_data->jobname))
 584                 notify_job_name(sharename, jobid, new_data->jobname);
 585
 586         /* Job attributes of a new job or attributes that can be
 587            modified. */
 588
 589         if (new_job || !strequal(old_data->jobname, new_data->jobname))
 590                 notify_job_name(sharename, jobid, new_data->jobname);
 591
 592         if (new_job || old_data->status != new_data->status)
 593                 notify_job_status(sharename, jobid, map_to_spoolss_status(new_data->status));
 594
 595         if (new_job || old_data->size != new_data->size)
 596                 notify_job_total_bytes(sharename, jobid, new_data->size);
 597
 598         if (new_job || old_data->page_count != new_data->page_count)
 599                 notify_job_total_pages(sharename, jobid, new_data->page_count);
 600 }
 601
 602 /****************************************************************************
 603  Store a job structure back to the database.
 604 ****************************************************************************/
 605
 606 static bool pjob_store(const char* sharename, uint32 jobid, struct printjob *pjob)
 607 {
 608         uint32_t tmp;
 609         TDB_DATA                old_data, new_data;
 610         bool                    ret = False;
 611         struct tdb_print_db     *pdb = get_print_db_byname(sharename);
 612         uint8                   *buf = NULL;
 613         int                     len, newlen, buflen;
 614
 615
 616         if (!pdb)
 617                 return False;
 618
 619         /* Get old data */
 620
 621         old_data = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
 622
 623         /* Doh!  Now we have to pack/unpack data since the NT_DEVICEMODE was added */
 624
 625         newlen = 0;
 626
 627         do {
 628                 len = 0;
 629                 buflen = newlen;
 630                 len += tdb_pack(buf+len, buflen-len, "dddddddddffff",
 631                                 (uint32)pjob->pid,
 632                                 (uint32)pjob->sysjob,
 633                                 (uint32)pjob->fd,
 634                                 (uint32)pjob->starttime,
 635                                 (uint32)pjob->status,
 636                                 (uint32)pjob->size,
 637                                 (uint32)pjob->page_count,
 638                                 (uint32)pjob->spooled,
 639                                 (uint32)pjob->smbjob,
 640                                 pjob->filename,
 641                                 pjob->jobname,
 642                                 pjob->user,
 643                                 pjob->queuename);
 644
 645                 len += pack_devicemode(pjob->devmode, buf+len, buflen-len);
 646
 647                 if (buflen != len) {
 648                         buf = (uint8 *)SMB_REALLOC(buf, len);
 649                         if (!buf) {
 650                                 DEBUG(0,("pjob_store: failed to enlarge buffer!\n"));
 651                                 goto done;
 652                         }
 653                         newlen = len;
 654                 }
 655         } while ( buflen != len );
 656
 657
 658         /* Store new data */
 659
 660         new_data.dptr = buf;
 661         new_data.dsize = len;
 662         ret = (tdb_store(pdb->tdb, print_key(jobid, &tmp), new_data,
 663                          TDB_REPLACE) == 0);
 664
 665         release_print_db(pdb);
 666
 667         /* Send notify updates for what has changed */
 668
 669         if ( ret ) {
 670                 struct printjob old_pjob;
 671
 672                 if ( old_data.dsize )
 673                 {
 674                         if ( unpack_pjob( old_data.dptr, old_data.dsize, &old_pjob ) != -1 )
 675                         {
 676                                 pjob_store_notify( sharename, jobid, &old_pjob , pjob );
 677                                 talloc_free(old_pjob.devmode);
 678                         }
 679                 }
 680                 else {
 681                         /* new job */
 682                         pjob_store_notify( sharename, jobid, NULL, pjob );
 683                 }
 684         }
 685
 686 done:
 687         SAFE_FREE( old_data.dptr );
 688         SAFE_FREE( buf );
 689
 690         return ret;
 691 }
 692
 693 /****************************************************************************
 694  Remove a job structure from the database.
 695 ****************************************************************************/
 696
 697 void pjob_delete(const char* sharename, uint32 jobid)
 698 {
 699         uint32_t tmp;
 700         struct printjob *pjob;
 701         uint32 job_status = 0;
 702         struct tdb_print_db *pdb;
 703
 704         pdb = get_print_db_byname( sharename );
 705
 706         if (!pdb)
 707                 return;
 708
 709         pjob = print_job_find( sharename, jobid );
 710
 711         if (!pjob) {
 712                 DEBUG(5, ("pjob_delete: we were asked to delete nonexistent job %u\n",
 713                                         (unsigned int)jobid));
 714                 release_print_db(pdb);
 715                 return;
 716         }
 717
 718         /* We must cycle through JOB_STATUS_DELETING and
 719            JOB_STATUS_DELETED for the port monitor to delete the job
 720            properly. */
 721
 722         job_status = JOB_STATUS_DELETING|JOB_STATUS_DELETED;
 723         notify_job_status(sharename, jobid, job_status);
 724
 725         /* Remove from printing.tdb */
 726
 727         tdb_delete(pdb->tdb, print_key(jobid, &tmp));
 728         remove_from_jobs_changed(sharename, jobid);
 729         release_print_db( pdb );
 730         rap_jobid_delete(sharename, jobid);
 731 }
 732
 733 /****************************************************************************
 734  List a unix job in the print database.
 735 ****************************************************************************/
 736
 737 static void print_unix_job(const char *sharename, print_queue_struct *q, uint32 jobid)
 738 {
 739         struct printjob pj, *old_pj;
 740
 741         if (jobid == (uint32)-1)
 742                 jobid = q->job + UNIX_JOB_START;
 743
 744         /* Preserve the timestamp on an existing unix print job */
 745
 746         old_pj = print_job_find(sharename, jobid);
 747
 748         ZERO_STRUCT(pj);
 749
 750         pj.pid = (pid_t)-1;
 751         pj.sysjob = q->job;
 752         pj.fd = -1;
 753         pj.starttime = old_pj ? old_pj->starttime : q->time;
 754         pj.status = q->status;
 755         pj.size = q->size;
 756         pj.spooled = True;
 757         fstrcpy(pj.filename, old_pj ? old_pj->filename : "");
 758         if (jobid < UNIX_JOB_START) {
 759                 pj.smbjob = True;
 760                 fstrcpy(pj.jobname, old_pj ? old_pj->jobname : "Remote Downlevel Document");
 761         } else {
 762                 pj.smbjob = False;
 763                 fstrcpy(pj.jobname, old_pj ? old_pj->jobname : q->fs_file);
 764         }
 765         fstrcpy(pj.user, old_pj ? old_pj->user : q->fs_user);
 766         fstrcpy(pj.queuename, old_pj ? old_pj->queuename : sharename );
 767
 768         pjob_store(sharename, jobid, &pj);
 769 }
 770
 771
 772 struct traverse_struct {
 773         print_queue_struct *queue;
 774         int qcount, snum, maxcount, total_jobs;
 775         const char *sharename;
 776         time_t lpq_time;
 777         const char *lprm_command;
 778         struct printif *print_if;
 779 };
 780
 781 /****************************************************************************
 782  Utility fn to delete any jobs that are no longer active.
 783 ****************************************************************************/
 784
 785 static int traverse_fn_delete(TDB_CONTEXT *t, TDB_DATA key, TDB_DATA data, void *state)
 786 {
 787         struct traverse_struct *ts = (struct traverse_struct *)state;
 788         struct printjob pjob;
 789         uint32 jobid;
 790         int i = 0;
 791
 792         if (  key.dsize != sizeof(jobid) )
 793                 return 0;
 794
 795         jobid = IVAL(key.dptr, 0);
 796         if ( unpack_pjob( data.dptr, data.dsize, &pjob ) == -1 )
 797                 return 0;
 798         talloc_free(pjob.devmode);
 799
 800
 801         if (!pjob.smbjob) {
 802                 /* remove a unix job if it isn't in the system queue any more */
 803
 804                 for (i=0;i<ts->qcount;i++) {
 805                         uint32 u_jobid = (ts->queue[i].job + UNIX_JOB_START);
 806                         if (jobid == u_jobid)
 807                                 break;
 808                 }
 809                 if (i == ts->qcount) {
 810                         DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !smbjob\n",
 811                                                 (unsigned int)jobid ));
 812                         pjob_delete(ts->sharename, jobid);
 813                         return 0;
 814                 }
 815
 816                 /* need to continue the the bottom of the function to
 817                    save the correct attributes */
 818         }
 819
 820         /* maybe it hasn't been spooled yet */
 821         if (!pjob.spooled) {
 822                 /* if a job is not spooled and the process doesn't
 823                    exist then kill it. This cleans up after smbd
 824                    deaths */
 825                 if (!process_exists_by_pid(pjob.pid)) {
 826                         DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !process_exists (%u)\n",
 827                                                 (unsigned int)jobid, (unsigned int)pjob.pid ));
 828                         pjob_delete(ts->sharename, jobid);
 829                 } else
 830                         ts->total_jobs++;
 831                 return 0;
 832         }
 833
 834         /* this check only makes sense for jobs submitted from Windows clients */
 835
 836         if ( pjob.smbjob ) {
 837                 for (i=0;i<ts->qcount;i++) {
 838                         uint32 curr_jobid;
 839
 840                         if ( pjob.status == LPQ_DELETED )
 841                                 continue;
 842
 843                         curr_jobid = print_parse_jobid(ts->queue[i].fs_file);
 844
 845                         if (jobid == curr_jobid) {
 846
 847                                 /* try to clean up any jobs that need to be deleted */
 848
 849                                 if ( pjob.status == LPQ_DELETING ) {
 850                                         int result;
 851
 852                                         result = (*(ts->print_if->job_delete))(
 853                                                 ts->sharename, ts->lprm_command, &pjob );
 854
 855                                         if ( result != 0 ) {
 856                                                 /* if we can't delete, then reset the job status */
 857                                                 pjob.status = LPQ_QUEUED;
 858                                                 pjob_store(ts->sharename, jobid, &pjob);
 859                                         }
 860                                         else {
 861                                                 /* if we deleted the job, the remove the tdb record */
 862                                                 pjob_delete(ts->sharename, jobid);
 863                                                 pjob.status = LPQ_DELETED;
 864                                         }
 865
 866                                 }
 867
 868                                 break;
 869                         }
 870                 }
 871         }
 872
 873         /* The job isn't in the system queue - we have to assume it has
 874            completed, so delete the database entry. */
 875
 876         if (i == ts->qcount) {
 877
 878                 /* A race can occur between the time a job is spooled and
 879                    when it appears in the lpq output.  This happens when
 880                    the job is added to printing.tdb when another smbd
 881                    running print_queue_update() has completed a lpq and
 882                    is currently traversing the printing tdb and deleting jobs.
 883                    Don't delete the job if it was submitted after the lpq_time. */
 884
 885                 if (pjob.starttime < ts->lpq_time) {
 886                         DEBUG(10,("traverse_fn_delete: pjob %u deleted due to pjob.starttime (%u) < ts->lpq_time (%u)\n",
 887                                                 (unsigned int)jobid,
 888                                                 (unsigned int)pjob.starttime,
 889                                                 (unsigned int)ts->lpq_time ));
 890                         pjob_delete(ts->sharename, jobid);
 891                 } else
 892                         ts->total_jobs++;
 893                 return 0;
 894         }
 895
 896         /* Save the pjob attributes we will store.
 897            FIXME!!! This is the only place where queue->job
 898            represents the SMB jobid      --jerry */
 899
 900         ts->queue[i].job = jobid;
 901         ts->queue[i].size = pjob.size;
 902         ts->queue[i].page_count = pjob.page_count;
 903         ts->queue[i].status = pjob.status;
 904         ts->queue[i].priority = 1;
 905         ts->queue[i].time = pjob.starttime;
 906         fstrcpy(ts->queue[i].fs_user, pjob.user);
 907         fstrcpy(ts->queue[i].fs_file, pjob.jobname);
 908
 909         ts->total_jobs++;
 910
 911         return 0;
 912 }
 913
 914 /****************************************************************************
 915  Check if the print queue has been updated recently enough.
 916 ****************************************************************************/
 917
 918 static void print_cache_flush(const char *sharename)
 919 {
 920         fstring key;
 921         struct tdb_print_db *pdb = get_print_db_byname(sharename);
 922
 923         if (!pdb)
 924                 return;
 925         slprintf(key, sizeof(key)-1, "CACHE/%s", sharename);
 926         tdb_store_int32(pdb->tdb, key, -1);
 927         release_print_db(pdb);
 928 }
 929
 930 /****************************************************************************
 931  Check if someone already thinks they are doing the update.
 932 ****************************************************************************/
 933
 934 static pid_t get_updating_pid(const char *sharename)
 935 {
 936         fstring keystr;
 937         TDB_DATA data, key;
 938         pid_t updating_pid;
 939         struct tdb_print_db *pdb = get_print_db_byname(sharename);
 940
 941         if (!pdb)
 942                 return (pid_t)-1;
 943         slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
 944         key = string_tdb_data(keystr);
 945
 946         data = tdb_fetch(pdb->tdb, key);
 947         release_print_db(pdb);
 948         if (!data.dptr || data.dsize != sizeof(pid_t)) {
 949                 SAFE_FREE(data.dptr);
 950                 return (pid_t)-1;
 951         }
 952
 953         updating_pid = IVAL(data.dptr, 0);
 954         SAFE_FREE(data.dptr);
 955
 956         if (process_exists_by_pid(updating_pid))
 957                 return updating_pid;
 958
 959         return (pid_t)-1;
 960 }
 961
 962 /****************************************************************************
 963  Set the fact that we're doing the update, or have finished doing the update
 964  in the tdb.
 965 ****************************************************************************/
 966
 967 static void set_updating_pid(const fstring sharename, bool updating)
 968 {
 969         fstring keystr;
 970         TDB_DATA key;
 971         TDB_DATA data;
 972         pid_t updating_pid = sys_getpid();
 973         uint8 buffer[4];
 974
 975         struct tdb_print_db *pdb = get_print_db_byname(sharename);
 976
 977         if (!pdb)
 978                 return;
 979
 980         slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
 981         key = string_tdb_data(keystr);
 982
 983         DEBUG(5, ("set_updating_pid: %s updating lpq cache for print share %s\n",
 984                 updating ? "" : "not ",
 985                 sharename ));
 986
 987         if ( !updating ) {
 988                 tdb_delete(pdb->tdb, key);
 989                 release_print_db(pdb);
 990                 return;
 991         }
 992
 993         SIVAL( buffer, 0, updating_pid);
 994         data.dptr = buffer;
 995         data.dsize = 4;         /* we always assume this is a 4 byte value */
 996
 997         tdb_store(pdb->tdb, key, data, TDB_REPLACE);
 998         release_print_db(pdb);
 999 }
1000
1001 /****************************************************************************
1002  Sort print jobs by submittal time.
1003 ****************************************************************************/
1004
1005 static int printjob_comp(print_queue_struct *j1, print_queue_struct *j2)
1006 {
1007         /* Silly cases */
1008
1009         if (!j1 && !j2)
1010                 return 0;
1011         if (!j1)
1012                 return -1;
1013         if (!j2)
1014                 return 1;
1015
1016         /* Sort on job start time */
1017
1018         if (j1->time == j2->time)
1019                 return 0;
1020         return (j1->time > j2->time) ? 1 : -1;
1021 }
1022
1023 /****************************************************************************
1024  Store the sorted queue representation for later portmon retrieval.
1025  Skip deleted jobs
1026 ****************************************************************************/
1027
1028 static void store_queue_struct(struct tdb_print_db *pdb, struct traverse_struct *pts)
1029 {
1030         TDB_DATA data;
1031         int max_reported_jobs = lp_max_reported_jobs(pts->snum);
1032         print_queue_struct *queue = pts->queue;
1033         size_t len;
1034         size_t i;
1035         unsigned int qcount;
1036
1037         if (max_reported_jobs && (max_reported_jobs < pts->qcount))
1038                 pts->qcount = max_reported_jobs;
1039         qcount = 0;
1040
1041         /* Work out the size. */
1042         data.dsize = 0;
1043         data.dsize += tdb_pack(NULL, 0, "d", qcount);
1044
1045         for (i = 0; i < pts->qcount; i++) {
1046                 if ( queue[i].status == LPQ_DELETED )
1047                         continue;
1048
1049                 qcount++;
1050                 data.dsize += tdb_pack(NULL, 0, "ddddddff",
1051                                 (uint32)queue[i].job,
1052                                 (uint32)queue[i].size,
1053                                 (uint32)queue[i].page_count,
1054                                 (uint32)queue[i].status,
1055                                 (uint32)queue[i].priority,
1056                                 (uint32)queue[i].time,
1057                                 queue[i].fs_user,
1058                                 queue[i].fs_file);
1059         }
1060
1061         if ((data.dptr = (uint8 *)SMB_MALLOC(data.dsize)) == NULL)
1062                 return;
1063
1064         len = 0;
1065         len += tdb_pack(data.dptr + len, data.dsize - len, "d", qcount);
1066         for (i = 0; i < pts->qcount; i++) {
1067                 if ( queue[i].status == LPQ_DELETED )
1068                         continue;
1069
1070                 len += tdb_pack(data.dptr + len, data.dsize - len, "ddddddff",
1071                                 (uint32)queue[i].job,
1072                                 (uint32)queue[i].size,
1073                                 (uint32)queue[i].page_count,
1074                                 (uint32)queue[i].status,
1075                                 (uint32)queue[i].priority,
1076                                 (uint32)queue[i].time,
1077                                 queue[i].fs_user,
1078                                 queue[i].fs_file);
1079         }
1080
1081         tdb_store(pdb->tdb, string_tdb_data("INFO/linear_queue_array"), data,
1082                   TDB_REPLACE);
1083         SAFE_FREE(data.dptr);
1084         return;
1085 }
1086
1087 static TDB_DATA get_jobs_changed_data(struct tdb_print_db *pdb)
1088 {
1089         TDB_DATA data;
1090
1091         ZERO_STRUCT(data);
1092
1093         data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
1094         if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0)) {
1095                 SAFE_FREE(data.dptr);
1096                 ZERO_STRUCT(data);
1097         }
1098
1099         return data;
1100 }
1101
1102 static void check_job_changed(const char *sharename, TDB_DATA data, uint32 jobid)
1103 {
1104         unsigned int i;
1105         unsigned int job_count = data.dsize / 4;
1106
1107         for (i = 0; i < job_count; i++) {
1108                 uint32 ch_jobid;
1109
1110                 ch_jobid = IVAL(data.dptr, i*4);
1111                 if (ch_jobid == jobid)
1112                         remove_from_jobs_changed(sharename, jobid);
1113         }
1114 }
1115
1116 /****************************************************************************
1117  Check if the print queue has been updated recently enough.
1118 ****************************************************************************/
1119
1120 static bool print_cache_expired(const char *sharename, bool check_pending)
1121 {
1122         fstring key;
1123         time_t last_qscan_time, time_now = time(NULL);
1124         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1125         bool result = False;
1126
1127         if (!pdb)
1128                 return False;
1129
1130         snprintf(key, sizeof(key), "CACHE/%s", sharename);
1131         last_qscan_time = (time_t)tdb_fetch_int32(pdb->tdb, key);
1132
1133         /*
1134          * Invalidate the queue for 3 reasons.
1135          * (1). last queue scan time == -1.
1136          * (2). Current time - last queue scan time > allowed cache time.
1137          * (3). last queue scan time > current time + MAX_CACHE_VALID_TIME (1 hour by default).
1138          * This last test picks up machines for which the clock has been moved
1139          * forward, an lpq scan done and then the clock moved back. Otherwise
1140          * that last lpq scan would stay around for a loooong loooong time... :-). JRA.
1141          */
1142
1143         if (last_qscan_time == ((time_t)-1)
1144                 || (time_now - last_qscan_time) >= lp_lpqcachetime()
1145                 || last_qscan_time > (time_now + MAX_CACHE_VALID_TIME))
1146         {
1147                 uint32 u;
1148                 time_t msg_pending_time;
1149
1150                 DEBUG(4, ("print_cache_expired: cache expired for queue %s "
1151                         "(last_qscan_time = %d, time now = %d, qcachetime = %d)\n",
1152                         sharename, (int)last_qscan_time, (int)time_now,
1153                         (int)lp_lpqcachetime() ));
1154
1155                 /* check if another smbd has already sent a message to update the
1156                    queue.  Give the pending message one minute to clear and
1157                    then send another message anyways.  Make sure to check for
1158                    clocks that have been run forward and then back again. */
1159
1160                 snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1161
1162                 if ( check_pending
1163                         && tdb_fetch_uint32( pdb->tdb, key, &u )
1164                         && (msg_pending_time=u) > 0
1165                         && msg_pending_time <= time_now
1166                         && (time_now - msg_pending_time) < 60 )
1167                 {
1168                         DEBUG(4,("print_cache_expired: message already pending for %s.  Accepting cache\n",
1169                                 sharename));
1170                         goto done;
1171                 }
1172
1173                 result = True;
1174         }
1175
1176 done:
1177         release_print_db(pdb);
1178         return result;
1179 }
1180
1181 /****************************************************************************
1182  main work for updating the lpq cahe for a printer queue
1183 ****************************************************************************/
1184
1185 static void print_queue_update_internal( const char *sharename,
1186                                          struct printif *current_printif,
1187                                          char *lpq_command, char *lprm_command )
1188 {
1189         int i, qcount;
1190         print_queue_struct *queue = NULL;
1191         print_status_struct status;
1192         print_status_struct old_status;
1193         struct printjob *pjob;
1194         struct traverse_struct tstruct;
1195         TDB_DATA data, key;
1196         TDB_DATA jcdata;
1197         fstring keystr, cachestr;
1198         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1199
1200         if (!pdb) {
1201                 return;
1202         }
1203
1204         DEBUG(5,("print_queue_update_internal: printer = %s, type = %d, lpq command = [%s]\n",
1205                 sharename, current_printif->type, lpq_command));
1206
1207         /*
1208          * Update the cache time FIRST ! Stops others even
1209          * attempting to get the lock and doing this
1210          * if the lpq takes a long time.
1211          */
1212
1213         slprintf(cachestr, sizeof(cachestr)-1, "CACHE/%s", sharename);
1214         tdb_store_int32(pdb->tdb, cachestr, (int)time(NULL));
1215
1216         /* get the current queue using the appropriate interface */
1217         ZERO_STRUCT(status);
1218
1219         qcount = (*(current_printif->queue_get))(sharename,
1220                 current_printif->type,
1221                 lpq_command, &queue, &status);
1222
1223         DEBUG(3, ("print_queue_update_internal: %d job%s in queue for %s\n",
1224                 qcount, (qcount != 1) ? "s" : "", sharename));
1225
1226         /* Sort the queue by submission time otherwise they are displayed
1227            in hash order. */
1228
1229         TYPESAFE_QSORT(queue, qcount, printjob_comp);
1230
1231         /*
1232           any job in the internal database that is marked as spooled
1233           and doesn't exist in the system queue is considered finished
1234           and removed from the database
1235
1236           any job in the system database but not in the internal database
1237           is added as a unix job
1238
1239           fill in any system job numbers as we go
1240         */
1241
1242         jcdata = get_jobs_changed_data(pdb);
1243
1244         for (i=0; i<qcount; i++) {
1245                 uint32 jobid = print_parse_jobid(queue[i].fs_file);
1246
1247                 if (jobid == (uint32)-1) {
1248                         /* assume its a unix print job */
1249                         print_unix_job(sharename, &queue[i], jobid);
1250                         continue;
1251                 }
1252
1253                 /* we have an active SMB print job - update its status */
1254                 pjob = print_job_find(sharename, jobid);
1255                 if (!pjob) {
1256                         /* err, somethings wrong. Probably smbd was restarted
1257                            with jobs in the queue. All we can do is treat them
1258                            like unix jobs. Pity. */
1259                         print_unix_job(sharename, &queue[i], jobid);
1260                         continue;
1261                 }
1262
1263                 pjob->sysjob = queue[i].job;
1264
1265                 /* don't reset the status on jobs to be deleted */
1266
1267                 if ( pjob->status != LPQ_DELETING )
1268                         pjob->status = queue[i].status;
1269
1270                 pjob_store(sharename, jobid, pjob);
1271
1272                 check_job_changed(sharename, jcdata, jobid);
1273         }
1274
1275         SAFE_FREE(jcdata.dptr);
1276
1277         /* now delete any queued entries that don't appear in the
1278            system queue */
1279         tstruct.queue = queue;
1280         tstruct.qcount = qcount;
1281         tstruct.snum = -1;
1282         tstruct.total_jobs = 0;
1283         tstruct.lpq_time = time(NULL);
1284         tstruct.sharename = sharename;
1285         tstruct.lprm_command = lprm_command;
1286         tstruct.print_if = current_printif;
1287
1288         tdb_traverse(pdb->tdb, traverse_fn_delete, (void *)&tstruct);
1289
1290         /* Store the linearised queue, max jobs only. */
1291         store_queue_struct(pdb, &tstruct);
1292
1293         SAFE_FREE(tstruct.queue);
1294
1295         DEBUG(10,("print_queue_update_internal: printer %s INFO/total_jobs = %d\n",
1296                                 sharename, tstruct.total_jobs ));
1297
1298         tdb_store_int32(pdb->tdb, "INFO/total_jobs", tstruct.total_jobs);
1299
1300         get_queue_status(sharename, &old_status);
1301         if (old_status.qcount != qcount)
1302                 DEBUG(10,("print_queue_update_internal: queue status change %d jobs -> %d jobs for printer %s\n",
1303                                         old_status.qcount, qcount, sharename));
1304
1305         /* store the new queue status structure */
1306         slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
1307         key = string_tdb_data(keystr);
1308
1309         status.qcount = qcount;
1310         data.dptr = (uint8 *)&status;
1311         data.dsize = sizeof(status);
1312         tdb_store(pdb->tdb, key, data, TDB_REPLACE);
1313
1314         /*
1315          * Update the cache time again. We want to do this call
1316          * as little as possible...
1317          */
1318
1319         slprintf(keystr, sizeof(keystr)-1, "CACHE/%s", sharename);
1320         tdb_store_int32(pdb->tdb, keystr, (int32)time(NULL));
1321
1322         /* clear the msg pending record for this queue */
1323
1324         snprintf(keystr, sizeof(keystr), "MSG_PENDING/%s", sharename);
1325
1326         if ( !tdb_store_uint32( pdb->tdb, keystr, 0 ) ) {
1327                 /* log a message but continue on */
1328
1329                 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1330                         sharename));
1331         }
1332
1333         release_print_db( pdb );
1334
1335         return;
1336 }
1337
1338 /****************************************************************************
1339  Update the internal database from the system print queue for a queue.
1340  obtain a lock on the print queue before proceeding (needed when mutiple
1341  smbd processes maytry to update the lpq cache concurrently).
1342 ****************************************************************************/
1343
1344 static void print_queue_update_with_lock( const char *sharename,
1345                                           struct printif *current_printif,
1346                                           char *lpq_command, char *lprm_command )
1347 {
1348         fstring keystr;
1349         struct tdb_print_db *pdb;
1350
1351         DEBUG(5,("print_queue_update_with_lock: printer share = %s\n", sharename));
1352         pdb = get_print_db_byname(sharename);
1353         if (!pdb)
1354                 return;
1355
1356         if ( !print_cache_expired(sharename, False) ) {
1357                 DEBUG(5,("print_queue_update_with_lock: print cache for %s is still ok\n", sharename));
1358                 release_print_db(pdb);
1359                 return;
1360         }
1361
1362         /*
1363          * Check to see if someone else is doing this update.
1364          * This is essentially a mutex on the update.
1365          */
1366
1367         if (get_updating_pid(sharename) != -1) {
1368                 release_print_db(pdb);
1369                 return;
1370         }
1371
1372         /* Lock the queue for the database update */
1373
1374         slprintf(keystr, sizeof(keystr) - 1, "LOCK/%s", sharename);
1375         /* Only wait 10 seconds for this. */
1376         if (tdb_lock_bystring_with_timeout(pdb->tdb, keystr, 10) == -1) {
1377                 DEBUG(0,("print_queue_update_with_lock: Failed to lock printer %s database\n", sharename));
1378                 release_print_db(pdb);
1379                 return;
1380         }
1381
1382         /*
1383          * Ensure that no one else got in here.
1384          * If the updating pid is still -1 then we are
1385          * the winner.
1386          */
1387
1388         if (get_updating_pid(sharename) != -1) {
1389                 /*
1390                  * Someone else is doing the update, exit.
1391                  */
1392                 tdb_unlock_bystring(pdb->tdb, keystr);
1393                 release_print_db(pdb);
1394                 return;
1395         }
1396
1397         /*
1398          * We're going to do the update ourselves.
1399          */
1400
1401         /* Tell others we're doing the update. */
1402         set_updating_pid(sharename, True);
1403
1404         /*
1405          * Allow others to enter and notice we're doing
1406          * the update.
1407          */
1408
1409         tdb_unlock_bystring(pdb->tdb, keystr);
1410
1411         /* do the main work now */
1412
1413         print_queue_update_internal( sharename, current_printif,
1414                 lpq_command, lprm_command );
1415
1416         /* Delete our pid from the db. */
1417         set_updating_pid(sharename, False);
1418         release_print_db(pdb);
1419 }
1420
1421 /****************************************************************************
1422 this is the receive function of the background lpq updater
1423 ****************************************************************************/
1424 static void print_queue_receive(struct messaging_context *msg,
1425                                 void *private_data,
1426                                 uint32_t msg_type,
1427                                 struct server_id server_id,
1428                                 DATA_BLOB *data)
1429 {
1430         fstring sharename;
1431         char *lpqcommand = NULL, *lprmcommand = NULL;
1432         int printing_type;
1433         size_t len;
1434
1435         len = tdb_unpack( (uint8 *)data->data, data->length, "fdPP",
1436                 sharename,
1437                 &printing_type,
1438                 &lpqcommand,
1439                 &lprmcommand );
1440
1441         if ( len == -1 ) {
1442                 SAFE_FREE(lpqcommand);
1443                 SAFE_FREE(lprmcommand);
1444                 DEBUG(0,("print_queue_receive: Got invalid print queue update message\n"));
1445                 return;
1446         }
1447
1448         print_queue_update_with_lock(sharename,
1449                 get_printer_fns_from_type((enum printing_types)printing_type),
1450                 lpqcommand, lprmcommand );
1451
1452         SAFE_FREE(lpqcommand);
1453         SAFE_FREE(lprmcommand);
1454         return;
1455 }
1456
1457 static void printing_pause_fd_handler(struct tevent_context *ev,
1458                                       struct tevent_fd *fde,
1459                                       uint16_t flags,
1460                                       void *private_data)
1461 {
1462         /*
1463          * If pause_pipe[1] is closed it means the parent smbd
1464          * and children exited or aborted.
1465          */
1466         exit_server_cleanly(NULL);
1467 }
1468
1469 extern struct child_pid *children;
1470 extern int num_children;
1471
1472 static void add_child_pid(pid_t pid)
1473 {
1474         struct child_pid *child;
1475
1476         child = SMB_MALLOC_P(struct child_pid);
1477         if (child == NULL) {
1478                 DEBUG(0, ("Could not add child struct -- malloc failed\n"));
1479                 return;
1480         }
1481         child->pid = pid;
1482         DLIST_ADD(children, child);
1483         num_children += 1;
1484 }
1485
1486 static pid_t background_lpq_updater_pid = -1;
1487
1488 /****************************************************************************
1489 main thread of the background lpq updater
1490 ****************************************************************************/
1491 void start_background_queue(void)
1492 {
1493         /* Use local variables for this as we don't
1494          * need to save the parent side of this, just
1495          * ensure it closes when the process exits.
1496          */
1497         int pause_pipe[2];
1498
1499         DEBUG(3,("start_background_queue: Starting background LPQ thread\n"));
1500
1501         if (pipe(pause_pipe) == -1) {
1502                 DEBUG(5,("start_background_queue: cannot create pipe. %s\n", strerror(errno) ));
1503                 exit(1);
1504         }
1505
1506         background_lpq_updater_pid = sys_fork();
1507
1508         if (background_lpq_updater_pid == -1) {
1509                 DEBUG(5,("start_background_queue: background LPQ thread failed to start. %s\n", strerror(errno) ));
1510                 exit(1);
1511         }
1512
1513         /* Track the printing pid along with other smbd children */
1514         add_child_pid(background_lpq_updater_pid);
1515
1516         if(background_lpq_updater_pid == 0) {
1517                 struct tevent_fd *fde;
1518                 int ret;
1519                 NTSTATUS status;
1520
1521                 /* Child. */
1522                 DEBUG(5,("start_background_queue: background LPQ thread started\n"));
1523
1524                 close(pause_pipe[0]);
1525                 pause_pipe[0] = -1;
1526
1527                 status = reinit_after_fork(server_messaging_context(),
1528                                            server_event_context(),
1529                                            procid_self(), true);
1530
1531                 if (!NT_STATUS_IS_OK(status)) {
1532                         DEBUG(0,("reinit_after_fork() failed\n"));
1533                         smb_panic("reinit_after_fork() failed");
1534                 }
1535
1536                 smbd_setup_sig_term_handler();
1537                 smbd_setup_sig_hup_handler();
1538
1539                 if (!serverid_register(procid_self(),
1540                                        FLAG_MSG_GENERAL|FLAG_MSG_SMBD
1541                                        |FLAG_MSG_PRINT_GENERAL)) {
1542                         exit(1);
1543                 }
1544
1545                 if (!locking_init()) {
1546                         exit(1);
1547                 }
1548
1549                 messaging_register(server_messaging_context(), NULL,
1550                                    MSG_PRINTER_UPDATE, print_queue_receive);
1551
1552                 fde = tevent_add_fd(server_event_context(),
1553                                     server_event_context(),
1554                                     pause_pipe[1], TEVENT_FD_READ,
1555                                     printing_pause_fd_handler,
1556                                     NULL);
1557                 if (!fde) {
1558                         DEBUG(0,("tevent_add_fd() failed for pause_pipe\n"));
1559                         smb_panic("tevent_add_fd() failed for pause_pipe");
1560                 }
1561
1562                 DEBUG(5,("start_background_queue: background LPQ thread waiting for messages\n"));
1563                 ret = tevent_loop_wait(server_event_context());
1564                 /* should not be reached */
1565                 DEBUG(0,("background_queue: tevent_loop_wait() exited with %d - %s\n",
1566                          ret, (ret == 0) ? "out of events" : strerror(errno)));
1567                 exit(1);
1568         }
1569
1570         close(pause_pipe[1]);
1571 }
1572
1573 /****************************************************************************
1574 update the internal database from the system print queue for a queue
1575 ****************************************************************************/
1576
1577 static void print_queue_update(int snum, bool force)
1578 {
1579         fstring key;
1580         fstring sharename;
1581         char *lpqcommand = NULL;
1582         char *lprmcommand = NULL;
1583         uint8 *buffer = NULL;
1584         size_t len = 0;
1585         size_t newlen;
1586         struct tdb_print_db *pdb;
1587         int type;
1588         struct printif *current_printif;
1589         TALLOC_CTX *ctx = talloc_tos();
1590
1591         fstrcpy( sharename, lp_const_servicename(snum));
1592
1593         /* don't strip out characters like '$' from the printername */
1594
1595         lpqcommand = talloc_string_sub2(ctx,
1596                         lp_lpqcommand(snum),
1597                         "%p",
1598                         lp_printername(snum),
1599                         false, false, false);
1600         if (!lpqcommand) {
1601                 return;
1602         }
1603         lpqcommand = talloc_sub_advanced(ctx,
1604                         lp_servicename(snum),
1605                         current_user_info.unix_name,
1606                         "",
1607                         current_user.ut.gid,
1608                         get_current_username(),
1609                         current_user_info.domain,
1610                         lpqcommand);
1611         if (!lpqcommand) {
1612                 return;
1613         }
1614
1615         lprmcommand = talloc_string_sub2(ctx,
1616                         lp_lprmcommand(snum),
1617                         "%p",
1618                         lp_printername(snum),
1619                         false, false, false);
1620         if (!lprmcommand) {
1621                 return;
1622         }
1623         lprmcommand = talloc_sub_advanced(ctx,
1624                         lp_servicename(snum),
1625                         current_user_info.unix_name,
1626                         "",
1627                         current_user.ut.gid,
1628                         get_current_username(),
1629                         current_user_info.domain,
1630                         lprmcommand);
1631         if (!lprmcommand) {
1632                 return;
1633         }
1634
1635         /*
1636          * Make sure that the background queue process exists.
1637          * Otherwise just do the update ourselves
1638          */
1639
1640         if ( force || background_lpq_updater_pid == -1 ) {
1641                 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename));
1642                 current_printif = get_printer_fns( snum );
1643                 print_queue_update_with_lock( sharename, current_printif, lpqcommand, lprmcommand );
1644
1645                 return;
1646         }
1647
1648         type = lp_printing(snum);
1649
1650         /* get the length */
1651
1652         len = tdb_pack( NULL, 0, "fdPP",
1653                 sharename,
1654                 type,
1655                 lpqcommand,
1656                 lprmcommand );
1657
1658         buffer = SMB_XMALLOC_ARRAY( uint8, len );
1659
1660         /* now pack the buffer */
1661         newlen = tdb_pack( buffer, len, "fdPP",
1662                 sharename,
1663                 type,
1664                 lpqcommand,
1665                 lprmcommand );
1666
1667         SMB_ASSERT( newlen == len );
1668
1669         DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1670                 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1671                 sharename, type, lpqcommand, lprmcommand ));
1672
1673         /* here we set a msg pending record for other smbd processes
1674            to throttle the number of duplicate print_queue_update msgs
1675            sent.  */
1676
1677         pdb = get_print_db_byname(sharename);
1678         if (!pdb) {
1679                 SAFE_FREE(buffer);
1680                 return;
1681         }
1682
1683         snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1684
1685         if ( !tdb_store_uint32( pdb->tdb, key, time(NULL) ) ) {
1686                 /* log a message but continue on */
1687
1688                 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1689                         sharename));
1690         }
1691
1692         release_print_db( pdb );
1693
1694         /* finally send the message */
1695
1696         messaging_send_buf(server_messaging_context(),
1697                            pid_to_procid(background_lpq_updater_pid),
1698                            MSG_PRINTER_UPDATE, (uint8 *)buffer, len);
1699
1700         SAFE_FREE( buffer );
1701
1702         return;
1703 }
1704
1705 /****************************************************************************
1706  Create/Update an entry in the print tdb that will allow us to send notify
1707  updates only to interested smbd's.
1708 ****************************************************************************/
1709
1710 bool print_notify_register_pid(int snum)
1711 {
1712         TDB_DATA data;
1713         struct tdb_print_db *pdb = NULL;
1714         TDB_CONTEXT *tdb = NULL;
1715         const char *printername;
1716         uint32 mypid = (uint32)sys_getpid();
1717         bool ret = False;
1718         size_t i;
1719
1720         /* if (snum == -1), then the change notify request was
1721            on a print server handle and we need to register on
1722            all print queus */
1723
1724         if (snum == -1)
1725         {
1726                 int num_services = lp_numservices();
1727                 int idx;
1728
1729                 for ( idx=0; idx<num_services; idx++ ) {
1730                         if (lp_snum_ok(idx) && lp_print_ok(idx) )
1731                                 print_notify_register_pid(idx);
1732                 }
1733
1734                 return True;
1735         }
1736         else /* register for a specific printer */
1737         {
1738                 printername = lp_const_servicename(snum);
1739                 pdb = get_print_db_byname(printername);
1740                 if (!pdb)
1741                         return False;
1742                 tdb = pdb->tdb;
1743         }
1744
1745         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1746                 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1747                                         printername));
1748                 if (pdb)
1749                         release_print_db(pdb);
1750                 return False;
1751         }
1752
1753         data = get_printer_notify_pid_list( tdb, printername, True );
1754
1755         /* Add ourselves and increase the refcount. */
1756
1757         for (i = 0; i < data.dsize; i += 8) {
1758                 if (IVAL(data.dptr,i) == mypid) {
1759                         uint32 new_refcount = IVAL(data.dptr, i+4) + 1;
1760                         SIVAL(data.dptr, i+4, new_refcount);
1761                         break;
1762                 }
1763         }
1764
1765         if (i == data.dsize) {
1766                 /* We weren't in the list. Realloc. */
1767                 data.dptr = (uint8 *)SMB_REALLOC(data.dptr, data.dsize + 8);
1768                 if (!data.dptr) {
1769                         DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1770                                                 printername));
1771                         goto done;
1772                 }
1773                 data.dsize += 8;
1774                 SIVAL(data.dptr,data.dsize - 8,mypid);
1775                 SIVAL(data.dptr,data.dsize - 4,1); /* Refcount. */
1776         }
1777
1778         /* Store back the record. */
1779         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1780                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1781 list for printer %s\n", printername));
1782                 goto done;
1783         }
1784
1785         ret = True;
1786
1787  done:
1788
1789         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1790         if (pdb)
1791                 release_print_db(pdb);
1792         SAFE_FREE(data.dptr);
1793         return ret;
1794 }
1795
1796 /****************************************************************************
1797  Update an entry in the print tdb that will allow us to send notify
1798  updates only to interested smbd's.
1799 ****************************************************************************/
1800
1801 bool print_notify_deregister_pid(int snum)
1802 {
1803         TDB_DATA data;
1804         struct tdb_print_db *pdb = NULL;
1805         TDB_CONTEXT *tdb = NULL;
1806         const char *printername;
1807         uint32 mypid = (uint32)sys_getpid();
1808         size_t i;
1809         bool ret = False;
1810
1811         /* if ( snum == -1 ), we are deregister a print server handle
1812            which means to deregister on all print queues */
1813
1814         if (snum == -1)
1815         {
1816                 int num_services = lp_numservices();
1817                 int idx;
1818
1819                 for ( idx=0; idx<num_services; idx++ ) {
1820                         if ( lp_snum_ok(idx) && lp_print_ok(idx) )
1821                                 print_notify_deregister_pid(idx);
1822                 }
1823
1824                 return True;
1825         }
1826         else /* deregister a specific printer */
1827         {
1828                 printername = lp_const_servicename(snum);
1829                 pdb = get_print_db_byname(printername);
1830                 if (!pdb)
1831                         return False;
1832                 tdb = pdb->tdb;
1833         }
1834
1835         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1836                 DEBUG(0,("print_notify_register_pid: Failed to lock \
1837 printer %s database\n", printername));
1838                 if (pdb)
1839                         release_print_db(pdb);
1840                 return False;
1841         }
1842
1843         data = get_printer_notify_pid_list( tdb, printername, True );
1844
1845         /* Reduce refcount. Remove ourselves if zero. */
1846
1847         for (i = 0; i < data.dsize; ) {
1848                 if (IVAL(data.dptr,i) == mypid) {
1849                         uint32 refcount = IVAL(data.dptr, i+4);
1850
1851                         refcount--;
1852
1853                         if (refcount == 0) {
1854                                 if (data.dsize - i > 8)
1855                                         memmove( &data.dptr[i], &data.dptr[i+8], data.dsize - i - 8);
1856                                 data.dsize -= 8;
1857                                 continue;
1858                         }
1859                         SIVAL(data.dptr, i+4, refcount);
1860                 }
1861
1862                 i += 8;
1863         }
1864
1865         if (data.dsize == 0)
1866                 SAFE_FREE(data.dptr);
1867
1868         /* Store back the record. */
1869         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1870                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1871 list for printer %s\n", printername));
1872                 goto done;
1873         }
1874
1875         ret = True;
1876
1877   done:
1878
1879         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1880         if (pdb)
1881                 release_print_db(pdb);
1882         SAFE_FREE(data.dptr);
1883         return ret;
1884 }
1885
1886 /****************************************************************************
1887  Check if a jobid is valid. It is valid if it exists in the database.
1888 ****************************************************************************/
1889
1890 bool print_job_exists(const char* sharename, uint32 jobid)
1891 {
1892         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1893         bool ret;
1894         uint32_t tmp;
1895
1896         if (!pdb)
1897                 return False;
1898         ret = tdb_exists(pdb->tdb, print_key(jobid, &tmp));
1899         release_print_db(pdb);
1900         return ret;
1901 }
1902
1903 /****************************************************************************
1904  Give the filename used for a jobid.
1905  Only valid for the process doing the spooling and when the job
1906  has not been spooled.
1907 ****************************************************************************/
1908
1909 char *print_job_fname(const char* sharename, uint32 jobid)
1910 {
1911         struct printjob *pjob = print_job_find(sharename, jobid);
1912         if (!pjob || pjob->spooled || pjob->pid != sys_getpid())
1913                 return NULL;
1914         return pjob->filename;
1915 }
1916
1917
1918 /****************************************************************************
1919  Give the filename used for a jobid.
1920  Only valid for the process doing the spooling and when the job
1921  has not been spooled.
1922 ****************************************************************************/
1923
1924 struct spoolss_DeviceMode *print_job_devmode(const char* sharename, uint32 jobid)
1925 {
1926         struct printjob *pjob = print_job_find(sharename, jobid);
1927
1928         if ( !pjob )
1929                 return NULL;
1930
1931         return pjob->devmode;
1932 }
1933
1934 /****************************************************************************
1935  Set the name of a job. Only possible for owner.
1936 ****************************************************************************/
1937
1938 bool print_job_set_name(const char *sharename, uint32 jobid, const char *name)
1939 {
1940         struct printjob *pjob;
1941
1942         pjob = print_job_find(sharename, jobid);
1943         if (!pjob || pjob->pid != sys_getpid())
1944                 return False;
1945
1946         fstrcpy(pjob->jobname, name);
1947         return pjob_store(sharename, jobid, pjob);
1948 }
1949
1950 /****************************************************************************
1951  Get the name of a job. Only possible for owner.
1952 ****************************************************************************/
1953
1954 bool print_job_get_name(TALLOC_CTX *mem_ctx, const char *sharename, uint32_t jobid, char **name)
1955 {
1956         struct printjob *pjob;
1957
1958         pjob = print_job_find(sharename, jobid);
1959         if (!pjob || pjob->pid != sys_getpid()) {
1960                 return false;
1961         }
1962
1963         *name = talloc_strdup(mem_ctx, pjob->jobname);
1964         if (!*name) {
1965                 return false;
1966         }
1967
1968         return true;
1969 }
1970
1971
1972 /***************************************************************************
1973  Remove a jobid from the 'jobs changed' list.
1974 ***************************************************************************/
1975
1976 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid)
1977 {
1978         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1979         TDB_DATA data, key;
1980         size_t job_count, i;
1981         bool ret = False;
1982         bool gotlock = False;
1983
1984         if (!pdb) {
1985                 return False;
1986         }
1987
1988         ZERO_STRUCT(data);
1989
1990         key = string_tdb_data("INFO/jobs_changed");
1991
1992         if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) == -1)
1993                 goto out;
1994
1995         gotlock = True;
1996
1997         data = tdb_fetch(pdb->tdb, key);
1998
1999         if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
2000                 goto out;
2001
2002         job_count = data.dsize / 4;
2003         for (i = 0; i < job_count; i++) {
2004                 uint32 ch_jobid;
2005
2006                 ch_jobid = IVAL(data.dptr, i*4);
2007                 if (ch_jobid == jobid) {
2008                         if (i < job_count -1 )
2009                                 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
2010                         data.dsize -= 4;
2011                         if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) == -1)
2012                                 goto out;
2013                         break;
2014                 }
2015         }
2016
2017         ret = True;
2018   out:
2019
2020         if (gotlock)
2021                 tdb_chainunlock(pdb->tdb, key);
2022         SAFE_FREE(data.dptr);
2023         release_print_db(pdb);
2024         if (ret)
2025                 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid ));
2026         else
2027                 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid ));
2028         return ret;
2029 }
2030
2031 /****************************************************************************
2032  Delete a print job - don't update queue.
2033 ****************************************************************************/
2034
2035 static bool print_job_delete1(int snum, uint32 jobid)
2036 {
2037         const char* sharename = lp_const_servicename(snum);
2038         struct printjob *pjob = print_job_find(sharename, jobid);
2039         int result = 0;
2040         struct printif *current_printif = get_printer_fns( snum );
2041
2042         if (!pjob)
2043                 return False;
2044
2045         /*
2046          * If already deleting just return.
2047          */
2048
2049         if (pjob->status == LPQ_DELETING)
2050                 return True;
2051
2052         /* Hrm - we need to be able to cope with deleting a job before it
2053            has reached the spooler.  Just mark it as LPQ_DELETING and
2054            let the print_queue_update() code rmeove the record */
2055
2056
2057         if (pjob->sysjob == -1) {
2058                 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid));
2059         }
2060
2061         /* Set the tdb entry to be deleting. */
2062
2063         pjob->status = LPQ_DELETING;
2064         pjob_store(sharename, jobid, pjob);
2065
2066         if (pjob->spooled && pjob->sysjob != -1)
2067         {
2068                 result = (*(current_printif->job_delete))(
2069                         lp_printername(snum),
2070                         lp_lprmcommand(snum),
2071                         pjob);
2072
2073                 /* Delete the tdb entry if the delete succeeded or the job hasn't
2074                    been spooled. */
2075
2076                 if (result == 0) {
2077                         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2078                         int njobs = 1;
2079
2080                         if (!pdb)
2081                                 return False;
2082                         pjob_delete(sharename, jobid);
2083                         /* Ensure we keep a rough count of the number of total jobs... */
2084                         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, -1);
2085                         release_print_db(pdb);
2086                 }
2087         }
2088
2089         remove_from_jobs_changed( sharename, jobid );
2090
2091         return (result == 0);
2092 }
2093
2094 /****************************************************************************
2095  Return true if the current user owns the print job.
2096 ****************************************************************************/
2097
2098 static bool is_owner(struct auth_serversupplied_info *server_info,
2099                      const char *servicename,
2100                      uint32 jobid)
2101 {
2102         struct printjob *pjob = print_job_find(servicename, jobid);
2103
2104         if (!pjob || !server_info)
2105                 return False;
2106
2107         return strequal(pjob->user, server_info->sanitized_username);
2108 }
2109
2110 /****************************************************************************
2111  Delete a print job.
2112 ****************************************************************************/
2113
2114 WERROR print_job_delete(struct auth_serversupplied_info *server_info,
2115                         struct messaging_context *msg_ctx,
2116                         int snum, uint32_t jobid)
2117 {
2118         const char* sharename = lp_const_servicename(snum);
2119         struct printjob *pjob;
2120         bool    owner;
2121         char    *fname;
2122
2123         owner = is_owner(server_info, lp_const_servicename(snum), jobid);
2124
2125         /* Check access against security descriptor or whether the user
2126            owns their job. */
2127
2128         if (!owner &&
2129             !print_access_check(server_info, msg_ctx, snum,
2130                                 JOB_ACCESS_ADMINISTER)) {
2131                 DEBUG(3, ("delete denied by security descriptor\n"));
2132
2133                 /* BEGIN_ADMIN_LOG */
2134                 sys_adminlog( LOG_ERR,
2135                               "Permission denied-- user not allowed to delete, \
2136 pause, or resume print job. User name: %s. Printer name: %s.",
2137                               uidtoname(server_info->utok.uid),
2138                               lp_printername(snum) );
2139                 /* END_ADMIN_LOG */
2140
2141                 return WERR_ACCESS_DENIED;
2142         }
2143
2144         /*
2145          * get the spooled filename of the print job
2146          * if this works, then the file has not been spooled
2147          * to the underlying print system.  Just delete the
2148          * spool file & return.
2149          */
2150
2151         fname = print_job_fname(sharename, jobid);
2152         if (fname != NULL) {
2153                 /* remove the spool file */
2154                 DEBUG(10, ("print_job_delete: "
2155                            "Removing spool file [%s]\n", fname));
2156                 if (unlink(fname) == -1) {
2157                         return map_werror_from_unix(errno);
2158                 }
2159         }
2160
2161         if (!print_job_delete1(snum, jobid)) {
2162                 return WERR_ACCESS_DENIED;
2163         }
2164
2165         /* force update the database and say the delete failed if the
2166            job still exists */
2167
2168         print_queue_update(snum, True);
2169
2170         pjob = print_job_find(sharename, jobid);
2171         if (pjob && (pjob->status != LPQ_DELETING)) {
2172                 return WERR_ACCESS_DENIED;
2173         }
2174
2175         return WERR_PRINTER_HAS_JOBS_QUEUED;
2176 }
2177
2178 /****************************************************************************
2179  Pause a job.
2180 ****************************************************************************/
2181
2182 bool print_job_pause(struct auth_serversupplied_info *server_info,
2183                      struct messaging_context *msg_ctx,
2184                      int snum, uint32 jobid, WERROR *errcode)
2185 {
2186         const char* sharename = lp_const_servicename(snum);
2187         struct printjob *pjob;
2188         int ret = -1;
2189         struct printif *current_printif = get_printer_fns( snum );
2190
2191         pjob = print_job_find(sharename, jobid);
2192
2193         if (!pjob || !server_info) {
2194                 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2195                         (unsigned int)jobid ));
2196                 return False;
2197         }
2198
2199         if (!pjob->spooled || pjob->sysjob == -1) {
2200                 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2201                         (int)pjob->sysjob, (unsigned int)jobid ));
2202                 return False;
2203         }
2204
2205         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2206             !print_access_check(server_info, msg_ctx, snum,
2207                                 JOB_ACCESS_ADMINISTER)) {
2208                 DEBUG(3, ("pause denied by security descriptor\n"));
2209
2210                 /* BEGIN_ADMIN_LOG */
2211                 sys_adminlog( LOG_ERR,
2212                         "Permission denied-- user not allowed to delete, \
2213 pause, or resume print job. User name: %s. Printer name: %s.",
2214                               uidtoname(server_info->utok.uid),
2215                               lp_printername(snum) );
2216                 /* END_ADMIN_LOG */
2217
2218                 *errcode = WERR_ACCESS_DENIED;
2219                 return False;
2220         }
2221
2222         /* need to pause the spooled entry */
2223         ret = (*(current_printif->job_pause))(snum, pjob);
2224
2225         if (ret != 0) {
2226                 *errcode = WERR_INVALID_PARAM;
2227                 return False;
2228         }
2229
2230         /* force update the database */
2231         print_cache_flush(lp_const_servicename(snum));
2232
2233         /* Send a printer notify message */
2234
2235         notify_job_status(sharename, jobid, JOB_STATUS_PAUSED);
2236
2237         /* how do we tell if this succeeded? */
2238
2239         return True;
2240 }
2241
2242 /****************************************************************************
2243  Resume a job.
2244 ****************************************************************************/
2245
2246 bool print_job_resume(struct auth_serversupplied_info *server_info,
2247                       struct messaging_context *msg_ctx,
2248                       int snum, uint32 jobid, WERROR *errcode)
2249 {
2250         const char *sharename = lp_const_servicename(snum);
2251         struct printjob *pjob;
2252         int ret;
2253         struct printif *current_printif = get_printer_fns( snum );
2254
2255         pjob = print_job_find(sharename, jobid);
2256
2257         if (!pjob || !server_info) {
2258                 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2259                         (unsigned int)jobid ));
2260                 return False;
2261         }
2262
2263         if (!pjob->spooled || pjob->sysjob == -1) {
2264                 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2265                         (int)pjob->sysjob, (unsigned int)jobid ));
2266                 return False;
2267         }
2268
2269         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2270             !print_access_check(server_info, msg_ctx, snum,
2271                                 JOB_ACCESS_ADMINISTER)) {
2272                 DEBUG(3, ("resume denied by security descriptor\n"));
2273                 *errcode = WERR_ACCESS_DENIED;
2274
2275                 /* BEGIN_ADMIN_LOG */
2276                 sys_adminlog( LOG_ERR,
2277                          "Permission denied-- user not allowed to delete, \
2278 pause, or resume print job. User name: %s. Printer name: %s.",
2279                               uidtoname(server_info->utok.uid),
2280                               lp_printername(snum) );
2281                 /* END_ADMIN_LOG */
2282                 return False;
2283         }
2284
2285         ret = (*(current_printif->job_resume))(snum, pjob);
2286
2287         if (ret != 0) {
2288                 *errcode = WERR_INVALID_PARAM;
2289                 return False;
2290         }
2291
2292         /* force update the database */
2293         print_cache_flush(lp_const_servicename(snum));
2294
2295         /* Send a printer notify message */
2296
2297         notify_job_status(sharename, jobid, JOB_STATUS_QUEUED);
2298
2299         return True;
2300 }
2301
2302 /****************************************************************************
2303  Write to a print file.
2304 ****************************************************************************/
2305
2306 ssize_t print_job_write(int snum, uint32 jobid, const char *buf, SMB_OFF_T pos, size_t size)
2307 {
2308         const char* sharename = lp_const_servicename(snum);
2309         ssize_t return_code;
2310         struct printjob *pjob;
2311
2312         pjob = print_job_find(sharename, jobid);
2313
2314         if (!pjob)
2315                 return -1;
2316         /* don't allow another process to get this info - it is meaningless */
2317         if (pjob->pid != sys_getpid())
2318                 return -1;
2319
2320         /* if SMBD is spooling this can't be allowed */
2321         if (pjob->status == PJOB_SMBD_SPOOLING) {
2322                 return -1;
2323         }
2324
2325         return_code = write_data_at_offset(pjob->fd, buf, size, pos);
2326
2327         if (return_code>0) {
2328                 pjob->size += size;
2329                 pjob_store(sharename, jobid, pjob);
2330         }
2331         return return_code;
2332 }
2333
2334 /****************************************************************************
2335  Get the queue status - do not update if db is out of date.
2336 ****************************************************************************/
2337
2338 static int get_queue_status(const char* sharename, print_status_struct *status)
2339 {
2340         fstring keystr;
2341         TDB_DATA data;
2342         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2343         int len;
2344
2345         if (status) {
2346                 ZERO_STRUCTP(status);
2347         }
2348
2349         if (!pdb)
2350                 return 0;
2351
2352         if (status) {
2353                 fstr_sprintf(keystr, "STATUS/%s", sharename);
2354                 data = tdb_fetch(pdb->tdb, string_tdb_data(keystr));
2355                 if (data.dptr) {
2356                         if (data.dsize == sizeof(print_status_struct))
2357                                 /* this memcpy is ok since the status struct was
2358                                    not packed before storing it in the tdb */
2359                                 memcpy(status, data.dptr, sizeof(print_status_struct));
2360                         SAFE_FREE(data.dptr);
2361                 }
2362         }
2363         len = tdb_fetch_int32(pdb->tdb, "INFO/total_jobs");
2364         release_print_db(pdb);
2365         return (len == -1 ? 0 : len);
2366 }
2367
2368 /****************************************************************************
2369  Determine the number of jobs in a queue.
2370 ****************************************************************************/
2371
2372 int print_queue_length(int snum, print_status_struct *pstatus)
2373 {
2374         const char* sharename = lp_const_servicename( snum );
2375         print_status_struct status;
2376         int len;
2377
2378         ZERO_STRUCT( status );
2379
2380         /* make sure the database is up to date */
2381         if (print_cache_expired(lp_const_servicename(snum), True))
2382                 print_queue_update(snum, False);
2383
2384         /* also fetch the queue status */
2385         memset(&status, 0, sizeof(status));
2386         len = get_queue_status(sharename, &status);
2387
2388         if (pstatus)
2389                 *pstatus = status;
2390
2391         return len;
2392 }
2393
2394 /***************************************************************************
2395  Allocate a jobid. Hold the lock for as short a time as possible.
2396 ***************************************************************************/
2397
2398 static WERROR allocate_print_jobid(struct tdb_print_db *pdb, int snum,
2399                                    const char *sharename, uint32 *pjobid)
2400 {
2401         int i;
2402         uint32 jobid;
2403         enum TDB_ERROR terr;
2404         int ret;
2405
2406         *pjobid = (uint32)-1;
2407
2408         for (i = 0; i < 3; i++) {
2409                 /* Lock the database - only wait 20 seconds. */
2410                 ret = tdb_lock_bystring_with_timeout(pdb->tdb,
2411                                                      "INFO/nextjob", 20);
2412                 if (ret == -1) {
2413                         DEBUG(0, ("allocate_print_jobid: "
2414                                   "Failed to lock printing database %s\n",
2415                                   sharename));
2416                         terr = tdb_error(pdb->tdb);
2417                         return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2418                 }
2419
2420                 if (!tdb_fetch_uint32(pdb->tdb, "INFO/nextjob", &jobid)) {
2421                         terr = tdb_error(pdb->tdb);
2422                         if (terr != TDB_ERR_NOEXIST) {
2423                                 DEBUG(0, ("allocate_print_jobid: "
2424                                           "Failed to fetch INFO/nextjob "
2425                                           "for print queue %s\n", sharename));
2426                                 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2427                                 return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2428                         }
2429                         DEBUG(10, ("allocate_print_jobid: "
2430                                    "No existing jobid in %s\n", sharename));
2431                         jobid = 0;
2432                 }
2433
2434                 DEBUG(10, ("allocate_print_jobid: "
2435                            "Read jobid %u from %s\n", jobid, sharename));
2436
2437                 jobid = NEXT_JOBID(jobid);
2438
2439                 ret = tdb_store_int32(pdb->tdb, "INFO/nextjob", jobid);
2440                 if (ret == -1) {
2441                         terr = tdb_error(pdb->tdb);
2442                         DEBUG(3, ("allocate_print_jobid: "
2443                                   "Failed to store INFO/nextjob.\n"));
2444                         tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2445                         return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2446                 }
2447
2448                 /* We've finished with the INFO/nextjob lock. */
2449                 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2450
2451                 if (!print_job_exists(sharename, jobid)) {
2452                         break;
2453                 }
2454                 DEBUG(10, ("allocate_print_jobid: "
2455                            "Found jobid %u in %s\n", jobid, sharename));
2456         }
2457
2458         if (i > 2) {
2459                 DEBUG(0, ("allocate_print_jobid: "
2460                           "Failed to allocate a print job for queue %s\n",
2461                           sharename));
2462                 /* Probably full... */
2463                 return WERR_NO_SPOOL_SPACE;
2464         }
2465
2466         /* Store a dummy placeholder. */
2467         {
2468                 uint32_t tmp;
2469                 TDB_DATA dum;
2470                 dum.dptr = NULL;
2471                 dum.dsize = 0;
2472                 if (tdb_store(pdb->tdb, print_key(jobid, &tmp), dum,
2473                               TDB_INSERT) == -1) {
2474                         DEBUG(3, ("allocate_print_jobid: "
2475                                   "jobid (%d) failed to store placeholder.\n",
2476                                   jobid ));
2477                         terr = tdb_error(pdb->tdb);
2478                         return ntstatus_to_werror(map_nt_error_from_tdb(terr));
2479                 }
2480         }
2481
2482         *pjobid = jobid;
2483         return WERR_OK;
2484 }
2485
2486 /***************************************************************************
2487  Append a jobid to the 'jobs changed' list.
2488 ***************************************************************************/
2489
2490 static bool add_to_jobs_changed(struct tdb_print_db *pdb, uint32 jobid)
2491 {
2492         TDB_DATA data;
2493         uint32 store_jobid;
2494
2495         SIVAL(&store_jobid, 0, jobid);
2496         data.dptr = (uint8 *)&store_jobid;
2497         data.dsize = 4;
2498
2499         DEBUG(10,("add_to_jobs_changed: Added jobid %u\n", (unsigned int)jobid ));
2500
2501         return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_changed"),
2502                            data) == 0);
2503 }
2504
2505
2506 /***************************************************************************
2507  Do all checks needed to determine if we can start a job.
2508 ***************************************************************************/
2509
2510 static WERROR print_job_checks(struct auth_serversupplied_info *server_info,
2511                                struct messaging_context *msg_ctx,
2512                                int snum, int *njobs)
2513 {
2514         const char *sharename = lp_const_servicename(snum);
2515         uint64_t dspace, dsize;
2516         uint64_t minspace;
2517         int ret;
2518
2519         if (!print_access_check(server_info, msg_ctx, snum,
2520                                 PRINTER_ACCESS_USE)) {
2521                 DEBUG(3, ("print_job_checks: "
2522                           "job start denied by security descriptor\n"));
2523                 return WERR_ACCESS_DENIED;
2524         }
2525
2526         if (!print_time_access_check(server_info, msg_ctx, sharename)) {
2527                 DEBUG(3, ("print_job_checks: "
2528                           "job start denied by time check\n"));
2529                 return WERR_ACCESS_DENIED;
2530         }
2531
2532         /* see if we have sufficient disk space */
2533         if (lp_minprintspace(snum)) {
2534                 minspace = lp_minprintspace(snum);
2535                 ret = sys_fsusage(lp_pathname(snum), &dspace, &dsize);
2536                 if (ret == 0 && dspace < 2*minspace) {
2537                         DEBUG(3, ("print_job_checks: "
2538                                   "disk space check failed.\n"));
2539                         return WERR_NO_SPOOL_SPACE;
2540                 }
2541         }
2542
2543         /* for autoloaded printers, check that the printcap entry still exists */
2544         if (lp_autoloaded(snum) && !pcap_printername_ok(sharename)) {
2545                 DEBUG(3, ("print_job_checks: printer name %s check failed.\n",
2546                           sharename));
2547                 return WERR_ACCESS_DENIED;
2548         }
2549
2550         /* Insure the maximum queue size is not violated */
2551         *njobs = print_queue_length(snum, NULL);
2552         if (*njobs > lp_maxprintjobs(snum)) {
2553                 DEBUG(3, ("print_job_checks: Queue %s number of jobs (%d) "
2554                           "larger than max printjobs per queue (%d).\n",
2555                           sharename, *njobs, lp_maxprintjobs(snum)));
2556                 return WERR_NO_SPOOL_SPACE;
2557         }
2558
2559         return WERR_OK;
2560 }
2561
2562 /***************************************************************************
2563  Create a job file.
2564 ***************************************************************************/
2565
2566 static WERROR print_job_spool_file(int snum, uint32_t jobid,
2567                                    const char *output_file,
2568                                    struct printjob *pjob)
2569 {
2570         WERROR werr;
2571         SMB_STRUCT_STAT st;
2572         const char *path;
2573         int len;
2574
2575         /* if this file is within the printer path, it means that smbd
2576          * is spooling it and will pass us control when it is finished.
2577          * Verify that the file name is ok, within path, and it is
2578          * already already there */
2579         if (output_file) {
2580                 path = lp_pathname(snum);
2581                 len = strlen(path);
2582                 if (strncmp(output_file, path, len) == 0 &&
2583                     (output_file[len - 1] == '/' || output_file[len] == '/')) {
2584
2585                         /* verify path is not too long */
2586                         if (strlen(output_file) >= sizeof(pjob->filename)) {
2587                                 return WERR_INVALID_NAME;
2588                         }
2589
2590                         /* verify that the file exists */
2591                         if (sys_stat(output_file, &st, false) != 0) {
2592                                 return WERR_INVALID_NAME;
2593                         }
2594
2595                         fstrcpy(pjob->filename, output_file);
2596
2597                         DEBUG(3, ("print_job_spool_file:"
2598                                   "External spooling activated"));
2599
2600                         /* we do not open the file until spooling is done */
2601                         pjob->fd = -1;
2602                         pjob->status = PJOB_SMBD_SPOOLING;
2603
2604                         return WERR_OK;
2605                 }
2606         }
2607
2608         slprintf(pjob->filename, sizeof(pjob->filename)-1,
2609                  "%s/%s%.8u.XXXXXX", lp_pathname(snum),
2610                  PRINT_SPOOL_PREFIX, (unsigned int)jobid);
2611         pjob->fd = mkstemp(pjob->filename);
2612
2613         if (pjob->fd == -1) {
2614                 werr = map_werror_from_unix(errno);
2615                 if (W_ERROR_EQUAL(werr, WERR_ACCESS_DENIED)) {
2616                         /* Common setup error, force a report. */
2617                         DEBUG(0, ("print_job_spool_file: "
2618                                   "insufficient permissions to open spool "
2619                                   "file %s.\n", pjob->filename));
2620                 } else {
2621                         /* Normal case, report at level 3 and above. */
2622                         DEBUG(3, ("print_job_spool_file: "
2623                                   "can't open spool file %s\n",
2624                                   pjob->filename));
2625                 }
2626                 return werr;
2627         }
2628
2629         return WERR_OK;
2630 }
2631
2632 /***************************************************************************
2633  Start spooling a job - return the jobid.
2634 ***************************************************************************/
2635
2636 WERROR print_job_start(struct auth_serversupplied_info *server_info,
2637                        struct messaging_context *msg_ctx,
2638                        int snum, const char *docname, const char *filename,
2639                        struct spoolss_DeviceMode *devmode, uint32_t *_jobid)
2640 {
2641         uint32_t jobid;
2642         char *path;
2643         struct printjob pjob;
2644         const char *sharename = lp_const_servicename(snum);
2645         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2646         int njobs;
2647         WERROR werr;
2648
2649         if (!pdb) {
2650                 return WERR_INTERNAL_DB_CORRUPTION;
2651         }
2652
2653         path = lp_pathname(snum);
2654
2655         werr = print_job_checks(server_info, msg_ctx, snum, &njobs);
2656         if (!W_ERROR_IS_OK(werr)) {
2657                 release_print_db(pdb);
2658                 return werr;
2659         }
2660
2661         DEBUG(10, ("print_job_start: "
2662                    "Queue %s number of jobs (%d), max printjobs = %d\n",
2663                    sharename, njobs, lp_maxprintjobs(snum)));
2664
2665         werr = allocate_print_jobid(pdb, snum, sharename, &jobid);
2666         if (!W_ERROR_IS_OK(werr)) {
2667                 goto fail;
2668         }
2669
2670         /* create the database entry */
2671
2672         ZERO_STRUCT(pjob);
2673
2674         pjob.pid = sys_getpid();
2675         pjob.sysjob = -1;
2676         pjob.fd = -1;
2677         pjob.starttime = time(NULL);
2678         pjob.status = LPQ_SPOOLING;
2679         pjob.size = 0;
2680         pjob.spooled = False;
2681         pjob.smbjob = True;
2682         pjob.devmode = devmode;
2683
2684         fstrcpy(pjob.jobname, docname);
2685
2686         fstrcpy(pjob.user, lp_printjob_username(snum));
2687         standard_sub_advanced(sharename, server_info->sanitized_username,
2688                               path, server_info->utok.gid,
2689                               server_info->sanitized_username,
2690                               server_info->info3->base.domain.string,
2691                               pjob.user, sizeof(pjob.user)-1);
2692         /* ensure NULL termination */
2693         pjob.user[sizeof(pjob.user)-1] = '\0';
2694
2695         fstrcpy(pjob.queuename, lp_const_servicename(snum));
2696
2697         /* we have a job entry - now create the spool file */
2698         werr = print_job_spool_file(snum, jobid, filename, &pjob);
2699         if (!W_ERROR_IS_OK(werr)) {
2700                 goto fail;
2701         }
2702
2703         pjob_store(sharename, jobid, &pjob);
2704
2705         /* Update the 'jobs changed' entry used by print_queue_status. */
2706         add_to_jobs_changed(pdb, jobid);
2707
2708         /* Ensure we keep a rough count of the number of total jobs... */
2709         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, 1);
2710
2711         release_print_db(pdb);
2712
2713         *_jobid = jobid;
2714         return WERR_OK;
2715
2716 fail:
2717         if (jobid != -1) {
2718                 pjob_delete(sharename, jobid);
2719         }
2720
2721         release_print_db(pdb);
2722
2723         DEBUG(3, ("print_job_start: returning fail. "
2724                   "Error = %s\n", win_errstr(werr)));
2725         return werr;
2726 }
2727
2728 /****************************************************************************
2729  Update the number of pages spooled to jobid
2730 ****************************************************************************/
2731
2732 void print_job_endpage(int snum, uint32 jobid)
2733 {
2734         const char* sharename = lp_const_servicename(snum);
2735         struct printjob *pjob;
2736
2737         pjob = print_job_find(sharename, jobid);
2738         if (!pjob)
2739                 return;
2740         /* don't allow another process to get this info - it is meaningless */
2741         if (pjob->pid != sys_getpid())
2742                 return;
2743
2744         pjob->page_count++;
2745         pjob_store(sharename, jobid, pjob);
2746 }
2747
2748 /****************************************************************************
2749  Print a file - called on closing the file. This spools the job.
2750  If normal close is false then we're tearing down the jobs - treat as an
2751  error.
2752 ****************************************************************************/
2753
2754 NTSTATUS print_job_end(int snum, uint32 jobid, enum file_close_type close_type)
2755 {
2756         const char* sharename = lp_const_servicename(snum);
2757         struct printjob *pjob;
2758         int ret;
2759         SMB_STRUCT_STAT sbuf;
2760         struct printif *current_printif = get_printer_fns( snum );
2761         NTSTATUS status = NT_STATUS_UNSUCCESSFUL;
2762
2763         pjob = print_job_find(sharename, jobid);
2764
2765         if (!pjob) {
2766                 return NT_STATUS_PRINT_CANCELLED;
2767         }
2768
2769         if (pjob->spooled || pjob->pid != sys_getpid()) {
2770                 return NT_STATUS_ACCESS_DENIED;
2771         }
2772
2773         if (close_type == NORMAL_CLOSE || close_type == SHUTDOWN_CLOSE) {
2774                 if (pjob->status == PJOB_SMBD_SPOOLING) {
2775                         /* take over the file now, smbd is done */
2776                         if (sys_stat(pjob->filename, &sbuf, false) != 0) {
2777                                 status = map_nt_error_from_unix(errno);
2778                                 DEBUG(3, ("print_job_end: "
2779                                           "stat file failed for jobid %d\n",
2780                                           jobid));
2781                                 goto fail;
2782                         }
2783
2784                         pjob->status = LPQ_SPOOLING;
2785
2786                 } else {
2787
2788                         if ((sys_fstat(pjob->fd, &sbuf, false) != 0)) {
2789                                 status = map_nt_error_from_unix(errno);
2790                                 close(pjob->fd);
2791                                 DEBUG(3, ("print_job_end: "
2792                                           "stat file failed for jobid %d\n",
2793                                           jobid));
2794                                 goto fail;
2795                         }
2796
2797                         close(pjob->fd);
2798                 }
2799
2800                 pjob->size = sbuf.st_ex_size;
2801         } else {
2802
2803                 /*
2804                  * Not a normal close, something has gone wrong. Cleanup.
2805                  */
2806                 if (pjob->fd != -1) {
2807                         close(pjob->fd);
2808                 }
2809                 goto fail;
2810         }
2811
2812         /* Technically, this is not quite right. If the printer has a separator
2813          * page turned on, the NT spooler prints the separator page even if the
2814          * print job is 0 bytes. 010215 JRR */
2815         if (pjob->size == 0 || pjob->status == LPQ_DELETING) {
2816                 /* don't bother spooling empty files or something being deleted. */
2817                 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
2818                         pjob->filename, pjob->size ? "deleted" : "zero length" ));
2819                 unlink(pjob->filename);
2820                 pjob_delete(sharename, jobid);
2821                 return NT_STATUS_OK;
2822         }
2823
2824         ret = (*(current_printif->job_submit))(snum, pjob);
2825
2826         if (ret) {
2827                 status = NT_STATUS_PRINT_CANCELLED;
2828                 goto fail;
2829         }
2830
2831         /* The print job has been successfully handed over to the back-end */
2832
2833         pjob->spooled = True;
2834         pjob->status = LPQ_QUEUED;
2835         pjob_store(sharename, jobid, pjob);
2836
2837         /* make sure the database is up to date */
2838         if (print_cache_expired(lp_const_servicename(snum), True))
2839                 print_queue_update(snum, False);
2840
2841         return NT_STATUS_OK;
2842
2843 fail:
2844
2845         /* The print job was not successfully started. Cleanup */
2846         /* Still need to add proper error return propagation! 010122:JRR */
2847         pjob->fd = -1;
2848         unlink(pjob->filename);
2849         pjob_delete(sharename, jobid);
2850         return status;
2851 }
2852
2853 /****************************************************************************
2854  Get a snapshot of jobs in the system without traversing.
2855 ****************************************************************************/
2856
2857 static bool get_stored_queue_info(struct tdb_print_db *pdb, int snum, int *pcount, print_queue_struct **ppqueue)
2858 {
2859         TDB_DATA data, cgdata;
2860         print_queue_struct *queue = NULL;
2861         uint32 qcount = 0;
2862         uint32 extra_count = 0;
2863         int total_count = 0;
2864         size_t len = 0;
2865         uint32 i;
2866         int max_reported_jobs = lp_max_reported_jobs(snum);
2867         bool ret = False;
2868         const char* sharename = lp_servicename(snum);
2869
2870         /* make sure the database is up to date */
2871         if (print_cache_expired(lp_const_servicename(snum), True))
2872                 print_queue_update(snum, False);
2873
2874         *pcount = 0;
2875         *ppqueue = NULL;
2876
2877         ZERO_STRUCT(data);
2878         ZERO_STRUCT(cgdata);
2879
2880         /* Get the stored queue data. */
2881         data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/linear_queue_array"));
2882
2883         if (data.dptr && data.dsize >= sizeof(qcount))
2884                 len += tdb_unpack(data.dptr + len, data.dsize - len, "d", &qcount);
2885
2886         /* Get the changed jobs list. */
2887         cgdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
2888         if (cgdata.dptr != NULL && (cgdata.dsize % 4 == 0))
2889                 extra_count = cgdata.dsize/4;
2890
2891         DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount, (unsigned int)extra_count));
2892
2893         /* Allocate the queue size. */
2894         if (qcount == 0 && extra_count == 0)
2895                 goto out;
2896
2897         if ((queue = SMB_MALLOC_ARRAY(print_queue_struct, qcount + extra_count)) == NULL)
2898                 goto out;
2899
2900         /* Retrieve the linearised queue data. */
2901
2902         for( i  = 0; i < qcount; i++) {
2903                 uint32 qjob, qsize, qpage_count, qstatus, qpriority, qtime;
2904                 len += tdb_unpack(data.dptr + len, data.dsize - len, "ddddddff",
2905                                 &qjob,
2906                                 &qsize,
2907                                 &qpage_count,
2908                                 &qstatus,
2909                                 &qpriority,
2910                                 &qtime,
2911                                 queue[i].fs_user,
2912                                 queue[i].fs_file);
2913                 queue[i].job = qjob;
2914                 queue[i].size = qsize;
2915                 queue[i].page_count = qpage_count;
2916                 queue[i].status = qstatus;
2917                 queue[i].priority = qpriority;
2918                 queue[i].time = qtime;
2919         }
2920
2921         total_count = qcount;
2922
2923         /* Add in the changed jobids. */
2924         for( i  = 0; i < extra_count; i++) {
2925                 uint32 jobid;
2926                 struct printjob *pjob;
2927
2928                 jobid = IVAL(cgdata.dptr, i*4);
2929                 DEBUG(5,("get_stored_queue_info: changed job = %u\n", (unsigned int)jobid));
2930                 pjob = print_job_find(lp_const_servicename(snum), jobid);
2931                 if (!pjob) {
2932                         DEBUG(5,("get_stored_queue_info: failed to find changed job = %u\n", (unsigned int)jobid));
2933                         remove_from_jobs_changed(sharename, jobid);
2934                         continue;
2935                 }
2936
2937                 queue[total_count].job = jobid;
2938                 queue[total_count].size = pjob->size;
2939                 queue[total_count].page_count = pjob->page_count;
2940                 queue[total_count].status = pjob->status;
2941                 queue[total_count].priority = 1;
2942                 queue[total_count].time = pjob->starttime;
2943                 fstrcpy(queue[total_count].fs_user, pjob->user);
2944                 fstrcpy(queue[total_count].fs_file, pjob->jobname);
2945                 total_count++;
2946         }
2947
2948         /* Sort the queue by submission time otherwise they are displayed
2949            in hash order. */
2950
2951         TYPESAFE_QSORT(queue, total_count, printjob_comp);
2952
2953         DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count));
2954
2955         if (max_reported_jobs && total_count > max_reported_jobs)
2956                 total_count = max_reported_jobs;
2957
2958         *ppqueue = queue;
2959         *pcount = total_count;
2960
2961         ret = True;
2962
2963   out:
2964
2965         SAFE_FREE(data.dptr);
2966         SAFE_FREE(cgdata.dptr);
2967         return ret;
2968 }
2969
2970 /****************************************************************************
2971  Get a printer queue listing.
2972  set queue = NULL and status = NULL if you just want to update the cache
2973 ****************************************************************************/
2974
2975 int print_queue_status(int snum,
2976                        print_queue_struct **ppqueue,
2977                        print_status_struct *status)
2978 {
2979         fstring keystr;
2980         TDB_DATA data, key;
2981         const char *sharename;
2982         struct tdb_print_db *pdb;
2983         int count = 0;
2984
2985         /* make sure the database is up to date */
2986
2987         if (print_cache_expired(lp_const_servicename(snum), True))
2988                 print_queue_update(snum, False);
2989
2990         /* return if we are done */
2991         if ( !ppqueue || !status )
2992                 return 0;
2993
2994         *ppqueue = NULL;
2995         sharename = lp_const_servicename(snum);
2996         pdb = get_print_db_byname(sharename);
2997
2998         if (!pdb)
2999                 return 0;
3000
3001         /*
3002          * Fetch the queue status.  We must do this first, as there may
3003          * be no jobs in the queue.
3004          */
3005
3006         ZERO_STRUCTP(status);
3007         slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
3008         key = string_tdb_data(keystr);
3009
3010         data = tdb_fetch(pdb->tdb, key);
3011         if (data.dptr) {
3012                 if (data.dsize == sizeof(*status)) {
3013                         /* this memcpy is ok since the status struct was
3014                            not packed before storing it in the tdb */
3015                         memcpy(status, data.dptr, sizeof(*status));
3016                 }
3017                 SAFE_FREE(data.dptr);
3018         }
3019
3020         /*
3021          * Now, fetch the print queue information.  We first count the number
3022          * of entries, and then only retrieve the queue if necessary.
3023          */
3024
3025         if (!get_stored_queue_info(pdb, snum, &count, ppqueue)) {
3026                 release_print_db(pdb);
3027                 return 0;
3028         }
3029
3030         release_print_db(pdb);
3031         return count;
3032 }
3033
3034 /****************************************************************************
3035  Pause a queue.
3036 ****************************************************************************/
3037
3038 WERROR print_queue_pause(struct auth_serversupplied_info *server_info,
3039                          struct messaging_context *msg_ctx, int snum)
3040 {
3041         int ret;
3042         struct printif *current_printif = get_printer_fns( snum );
3043
3044         if (!print_access_check(server_info, msg_ctx, snum,
3045                                 PRINTER_ACCESS_ADMINISTER)) {
3046                 return WERR_ACCESS_DENIED;
3047         }
3048
3049
3050         become_root();
3051
3052         ret = (*(current_printif->queue_pause))(snum);
3053
3054         unbecome_root();
3055
3056         if (ret != 0) {
3057                 return WERR_INVALID_PARAM;
3058         }
3059
3060         /* force update the database */
3061         print_cache_flush(lp_const_servicename(snum));
3062
3063         /* Send a printer notify message */
3064
3065         notify_printer_status(snum, PRINTER_STATUS_PAUSED);
3066
3067         return WERR_OK;
3068 }
3069
3070 /****************************************************************************
3071  Resume a queue.
3072 ****************************************************************************/
3073
3074 WERROR print_queue_resume(struct auth_serversupplied_info *server_info, int snum)
3075 {
3076         int ret;
3077         struct printif *current_printif = get_printer_fns( snum );
3078
3079         if (!print_access_check(server_info, smbd_messaging_context(), snum,
3080                                 PRINTER_ACCESS_ADMINISTER)) {
3081                 return WERR_ACCESS_DENIED;
3082         }
3083
3084         become_root();
3085
3086         ret = (*(current_printif->queue_resume))(snum);
3087
3088         unbecome_root();
3089
3090         if (ret != 0) {
3091                 return WERR_INVALID_PARAM;
3092         }
3093
3094         /* make sure the database is up to date */
3095         if (print_cache_expired(lp_const_servicename(snum), True))
3096                 print_queue_update(snum, True);
3097
3098         /* Send a printer notify message */
3099
3100         notify_printer_status(snum, PRINTER_STATUS_OK);
3101
3102         return WERR_OK;
3103 }
3104
3105 /****************************************************************************
3106  Purge a queue - implemented by deleting all jobs that we can delete.
3107 ****************************************************************************/
3108
3109 WERROR print_queue_purge(struct auth_serversupplied_info *server_info, int snum)
3110 {
3111         print_queue_struct *queue;
3112         print_status_struct status;
3113         int njobs, i;
3114         bool can_job_admin;
3115
3116         /* Force and update so the count is accurate (i.e. not a cached count) */
3117         print_queue_update(snum, True);
3118
3119         can_job_admin = print_access_check(server_info,
3120                                            smbd_messaging_context(),
3121                                            snum,
3122                                            JOB_ACCESS_ADMINISTER);
3123         njobs = print_queue_status(snum, &queue, &status);
3124
3125         if ( can_job_admin )
3126                 become_root();
3127
3128         for (i=0;i<njobs;i++) {
3129                 bool owner = is_owner(server_info, lp_const_servicename(snum),
3130                                       queue[i].job);
3131
3132                 if (owner || can_job_admin) {
3133                         print_job_delete1(snum, queue[i].job);
3134                 }
3135         }
3136
3137         if ( can_job_admin )
3138                 unbecome_root();
3139
3140         /* update the cache */
3141         print_queue_update( snum, True );
3142
3143         SAFE_FREE(queue);
3144
3145         return WERR_OK;
3146 }