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