source3/printing/printing.c

   1 /*
   2    Unix SMB/Netbios implementation.
   3    Version 3.0
   4    printing backend routines
   5    Copyright (C) Andrew Tridgell 1992-2000
   6    Copyright (C) Jeremy Allison 2002
   7
   8    This program is free software; you can redistribute it and/or modify
   9    it under the terms of the GNU General Public License as published by
  10    the Free Software Foundation; either version 3 of the License, or
  11    (at your option) any later version.
  12
  13    This program is distributed in the hope that it will be useful,
  14    but WITHOUT ANY WARRANTY; without even the implied warranty of
  15    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16    GNU General Public License for more details.
  17
  18    You should have received a copy of the GNU General Public License
  19    along with this program.  If not, see <http://www.gnu.org/licenses/>.
  20 */
  21
  22 #include "includes.h"
  23 #include "printing.h"
  24
  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(cache_path("printing.tdb"));
 187         mkdir(cache_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         background_lpq_updater_pid = sys_fork();
1411
1412         if (background_lpq_updater_pid == -1) {
1413                 DEBUG(5,("start_background_queue: background LPQ thread failed to start. %s\n", strerror(errno) ));
1414                 exit(1);
1415         }
1416
1417         if(background_lpq_updater_pid == 0) {
1418                 /* Child. */
1419                 DEBUG(5,("start_background_queue: background LPQ thread started\n"));
1420
1421                 close(pause_pipe[0]);
1422                 pause_pipe[0] = -1;
1423
1424                 if (!reinit_after_fork(smbd_messaging_context(),
1425                                        smbd_event_context(), true)) {
1426                         DEBUG(0,("reinit_after_fork() failed\n"));
1427                         smb_panic("reinit_after_fork() failed");
1428                 }
1429
1430                 claim_connection( NULL, "smbd lpq backend",
1431                         FLAG_MSG_GENERAL|FLAG_MSG_SMBD|FLAG_MSG_PRINT_GENERAL);
1432
1433                 if (!locking_init()) {
1434                         exit(1);
1435                 }
1436
1437                 messaging_register(smbd_messaging_context(), NULL,
1438                                    MSG_PRINTER_UPDATE, print_queue_receive);
1439
1440                 DEBUG(5,("start_background_queue: background LPQ thread waiting for messages\n"));
1441                 while (1) {
1442                         fd_set pause_fds;
1443                         int pause_select;
1444
1445                         FD_ZERO(&pause_fds);
1446                         FD_SET(pause_pipe[1], &pause_fds);
1447                         pause_select = sys_select(pause_pipe[1]+1, &pause_fds, NULL, NULL, NULL);
1448                         /* If pause_pipe[0] is closed it means the parent smbd
1449                          * and children exited or aborted. */
1450                         if (pause_select == 1) {
1451                                 exit_server_cleanly(NULL);
1452                         }
1453
1454                         /* check for some essential signals first */
1455
1456                         if (got_sig_term) {
1457                                 exit_server_cleanly(NULL);
1458                         }
1459
1460                         if (reload_after_sighup) {
1461                                 change_to_root_user();
1462                                 DEBUG(1,("Reloading services after SIGHUP\n"));
1463                                 reload_services(False);
1464                                 reload_after_sighup = 0;
1465                         }
1466
1467                         /* now check for messages */
1468
1469                         DEBUG(10,("start_background_queue: background LPQ thread got a message\n"));
1470                         message_dispatch(smbd_messaging_context());
1471
1472                         /* process any pending print change notify messages */
1473
1474                         print_notify_send_messages(smbd_messaging_context(),
1475                                                    0);
1476                 }
1477         }
1478
1479         close(pause_pipe[1]);
1480 }
1481
1482 /****************************************************************************
1483 update the internal database from the system print queue for a queue
1484 ****************************************************************************/
1485
1486 static void print_queue_update(int snum, bool force)
1487 {
1488         fstring key;
1489         fstring sharename;
1490         char *lpqcommand = NULL;
1491         char *lprmcommand = NULL;
1492         uint8 *buffer = NULL;
1493         size_t len = 0;
1494         size_t newlen;
1495         struct tdb_print_db *pdb;
1496         int type;
1497         struct printif *current_printif;
1498         TALLOC_CTX *ctx = talloc_tos();
1499
1500         fstrcpy( sharename, lp_const_servicename(snum));
1501
1502         /* don't strip out characters like '$' from the printername */
1503
1504         lpqcommand = talloc_string_sub2(ctx,
1505                         lp_lpqcommand(snum),
1506                         "%p",
1507                         PRINTERNAME(snum),
1508                         false, false, false);
1509         if (!lpqcommand) {
1510                 return;
1511         }
1512         lpqcommand = talloc_sub_advanced(ctx,
1513                         lp_servicename(snum),
1514                         current_user_info.unix_name,
1515                         "",
1516                         current_user.ut.gid,
1517                         get_current_username(),
1518                         current_user_info.domain,
1519                         lpqcommand);
1520         if (!lpqcommand) {
1521                 return;
1522         }
1523
1524         lprmcommand = talloc_string_sub2(ctx,
1525                         lp_lprmcommand(snum),
1526                         "%p",
1527                         PRINTERNAME(snum),
1528                         false, false, false);
1529         if (!lprmcommand) {
1530                 return;
1531         }
1532         lprmcommand = talloc_sub_advanced(ctx,
1533                         lp_servicename(snum),
1534                         current_user_info.unix_name,
1535                         "",
1536                         current_user.ut.gid,
1537                         get_current_username(),
1538                         current_user_info.domain,
1539                         lprmcommand);
1540         if (!lprmcommand) {
1541                 return;
1542         }
1543
1544         /*
1545          * Make sure that the background queue process exists.
1546          * Otherwise just do the update ourselves
1547          */
1548
1549         if ( force || background_lpq_updater_pid == -1 ) {
1550                 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename));
1551                 current_printif = get_printer_fns( snum );
1552                 print_queue_update_with_lock( sharename, current_printif, lpqcommand, lprmcommand );
1553
1554                 return;
1555         }
1556
1557         type = lp_printing(snum);
1558
1559         /* get the length */
1560
1561         len = tdb_pack( NULL, 0, "fdPP",
1562                 sharename,
1563                 type,
1564                 lpqcommand,
1565                 lprmcommand );
1566
1567         buffer = SMB_XMALLOC_ARRAY( uint8, len );
1568
1569         /* now pack the buffer */
1570         newlen = tdb_pack( buffer, len, "fdPP",
1571                 sharename,
1572                 type,
1573                 lpqcommand,
1574                 lprmcommand );
1575
1576         SMB_ASSERT( newlen == len );
1577
1578         DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1579                 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1580                 sharename, type, lpqcommand, lprmcommand ));
1581
1582         /* here we set a msg pending record for other smbd processes
1583            to throttle the number of duplicate print_queue_update msgs
1584            sent.  */
1585
1586         pdb = get_print_db_byname(sharename);
1587         if (!pdb) {
1588                 SAFE_FREE(buffer);
1589                 return;
1590         }
1591
1592         snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1593
1594         if ( !tdb_store_uint32( pdb->tdb, key, time(NULL) ) ) {
1595                 /* log a message but continue on */
1596
1597                 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1598                         sharename));
1599         }
1600
1601         release_print_db( pdb );
1602
1603         /* finally send the message */
1604
1605         messaging_send_buf(smbd_messaging_context(),
1606                            pid_to_procid(background_lpq_updater_pid),
1607                            MSG_PRINTER_UPDATE, (uint8 *)buffer, len);
1608
1609         SAFE_FREE( buffer );
1610
1611         return;
1612 }
1613
1614 /****************************************************************************
1615  Create/Update an entry in the print tdb that will allow us to send notify
1616  updates only to interested smbd's.
1617 ****************************************************************************/
1618
1619 bool print_notify_register_pid(int snum)
1620 {
1621         TDB_DATA data;
1622         struct tdb_print_db *pdb = NULL;
1623         TDB_CONTEXT *tdb = NULL;
1624         const char *printername;
1625         uint32 mypid = (uint32)sys_getpid();
1626         bool ret = False;
1627         size_t i;
1628
1629         /* if (snum == -1), then the change notify request was
1630            on a print server handle and we need to register on
1631            all print queus */
1632
1633         if (snum == -1)
1634         {
1635                 int num_services = lp_numservices();
1636                 int idx;
1637
1638                 for ( idx=0; idx<num_services; idx++ ) {
1639                         if (lp_snum_ok(idx) && lp_print_ok(idx) )
1640                                 print_notify_register_pid(idx);
1641                 }
1642
1643                 return True;
1644         }
1645         else /* register for a specific printer */
1646         {
1647                 printername = lp_const_servicename(snum);
1648                 pdb = get_print_db_byname(printername);
1649                 if (!pdb)
1650                         return False;
1651                 tdb = pdb->tdb;
1652         }
1653
1654         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1655                 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1656                                         printername));
1657                 if (pdb)
1658                         release_print_db(pdb);
1659                 return False;
1660         }
1661
1662         data = get_printer_notify_pid_list( tdb, printername, True );
1663
1664         /* Add ourselves and increase the refcount. */
1665
1666         for (i = 0; i < data.dsize; i += 8) {
1667                 if (IVAL(data.dptr,i) == mypid) {
1668                         uint32 new_refcount = IVAL(data.dptr, i+4) + 1;
1669                         SIVAL(data.dptr, i+4, new_refcount);
1670                         break;
1671                 }
1672         }
1673
1674         if (i == data.dsize) {
1675                 /* We weren't in the list. Realloc. */
1676                 data.dptr = (uint8 *)SMB_REALLOC(data.dptr, data.dsize + 8);
1677                 if (!data.dptr) {
1678                         DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1679                                                 printername));
1680                         goto done;
1681                 }
1682                 data.dsize += 8;
1683                 SIVAL(data.dptr,data.dsize - 8,mypid);
1684                 SIVAL(data.dptr,data.dsize - 4,1); /* Refcount. */
1685         }
1686
1687         /* Store back the record. */
1688         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1689                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1690 list for printer %s\n", printername));
1691                 goto done;
1692         }
1693
1694         ret = True;
1695
1696  done:
1697
1698         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1699         if (pdb)
1700                 release_print_db(pdb);
1701         SAFE_FREE(data.dptr);
1702         return ret;
1703 }
1704
1705 /****************************************************************************
1706  Update an entry in the print tdb that will allow us to send notify
1707  updates only to interested smbd's.
1708 ****************************************************************************/
1709
1710 bool print_notify_deregister_pid(int snum)
1711 {
1712         TDB_DATA data;
1713         struct tdb_print_db *pdb = NULL;
1714         TDB_CONTEXT *tdb = NULL;
1715         const char *printername;
1716         uint32 mypid = (uint32)sys_getpid();
1717         size_t i;
1718         bool ret = False;
1719
1720         /* if ( snum == -1 ), we are deregister a print server handle
1721            which means to deregister on all print queues */
1722
1723         if (snum == -1)
1724         {
1725                 int num_services = lp_numservices();
1726                 int idx;
1727
1728                 for ( idx=0; idx<num_services; idx++ ) {
1729                         if ( lp_snum_ok(idx) && lp_print_ok(idx) )
1730                                 print_notify_deregister_pid(idx);
1731                 }
1732
1733                 return True;
1734         }
1735         else /* deregister a specific printer */
1736         {
1737                 printername = lp_const_servicename(snum);
1738                 pdb = get_print_db_byname(printername);
1739                 if (!pdb)
1740                         return False;
1741                 tdb = pdb->tdb;
1742         }
1743
1744         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1745                 DEBUG(0,("print_notify_register_pid: Failed to lock \
1746 printer %s database\n", printername));
1747                 if (pdb)
1748                         release_print_db(pdb);
1749                 return False;
1750         }
1751
1752         data = get_printer_notify_pid_list( tdb, printername, True );
1753
1754         /* Reduce refcount. Remove ourselves if zero. */
1755
1756         for (i = 0; i < data.dsize; ) {
1757                 if (IVAL(data.dptr,i) == mypid) {
1758                         uint32 refcount = IVAL(data.dptr, i+4);
1759
1760                         refcount--;
1761
1762                         if (refcount == 0) {
1763                                 if (data.dsize - i > 8)
1764                                         memmove( &data.dptr[i], &data.dptr[i+8], data.dsize - i - 8);
1765                                 data.dsize -= 8;
1766                                 continue;
1767                         }
1768                         SIVAL(data.dptr, i+4, refcount);
1769                 }
1770
1771                 i += 8;
1772         }
1773
1774         if (data.dsize == 0)
1775                 SAFE_FREE(data.dptr);
1776
1777         /* Store back the record. */
1778         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1779                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1780 list for printer %s\n", printername));
1781                 goto done;
1782         }
1783
1784         ret = True;
1785
1786   done:
1787
1788         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1789         if (pdb)
1790                 release_print_db(pdb);
1791         SAFE_FREE(data.dptr);
1792         return ret;
1793 }
1794
1795 /****************************************************************************
1796  Check if a jobid is valid. It is valid if it exists in the database.
1797 ****************************************************************************/
1798
1799 bool print_job_exists(const char* sharename, uint32 jobid)
1800 {
1801         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1802         bool ret;
1803         uint32_t tmp;
1804
1805         if (!pdb)
1806                 return False;
1807         ret = tdb_exists(pdb->tdb, print_key(jobid, &tmp));
1808         release_print_db(pdb);
1809         return ret;
1810 }
1811
1812 /****************************************************************************
1813  Give the fd used for a jobid.
1814 ****************************************************************************/
1815
1816 int print_job_fd(const char* sharename, uint32 jobid)
1817 {
1818         struct printjob *pjob = print_job_find(sharename, jobid);
1819         if (!pjob)
1820                 return -1;
1821         /* don't allow another process to get this info - it is meaningless */
1822         if (pjob->pid != sys_getpid())
1823                 return -1;
1824         return pjob->fd;
1825 }
1826
1827 /****************************************************************************
1828  Give the filename used for a jobid.
1829  Only valid for the process doing the spooling and when the job
1830  has not been spooled.
1831 ****************************************************************************/
1832
1833 char *print_job_fname(const char* sharename, uint32 jobid)
1834 {
1835         struct printjob *pjob = print_job_find(sharename, jobid);
1836         if (!pjob || pjob->spooled || pjob->pid != sys_getpid())
1837                 return NULL;
1838         return pjob->filename;
1839 }
1840
1841
1842 /****************************************************************************
1843  Give the filename used for a jobid.
1844  Only valid for the process doing the spooling and when the job
1845  has not been spooled.
1846 ****************************************************************************/
1847
1848 NT_DEVICEMODE *print_job_devmode(const char* sharename, uint32 jobid)
1849 {
1850         struct printjob *pjob = print_job_find(sharename, jobid);
1851
1852         if ( !pjob )
1853                 return NULL;
1854
1855         return pjob->nt_devmode;
1856 }
1857
1858 /****************************************************************************
1859  Set the place in the queue for a job.
1860 ****************************************************************************/
1861
1862 bool print_job_set_place(const char *sharename, uint32 jobid, int place)
1863 {
1864         DEBUG(2,("print_job_set_place not implemented yet\n"));
1865         return False;
1866 }
1867
1868 /****************************************************************************
1869  Set the name of a job. Only possible for owner.
1870 ****************************************************************************/
1871
1872 bool print_job_set_name(const char *sharename, uint32 jobid, char *name)
1873 {
1874         struct printjob *pjob;
1875
1876         pjob = print_job_find(sharename, jobid);
1877         if (!pjob || pjob->pid != sys_getpid())
1878                 return False;
1879
1880         fstrcpy(pjob->jobname, name);
1881         return pjob_store(sharename, jobid, pjob);
1882 }
1883
1884 /***************************************************************************
1885  Remove a jobid from the 'jobs changed' list.
1886 ***************************************************************************/
1887
1888 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid)
1889 {
1890         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1891         TDB_DATA data, key;
1892         size_t job_count, i;
1893         bool ret = False;
1894         bool gotlock = False;
1895
1896         if (!pdb) {
1897                 return False;
1898         }
1899
1900         ZERO_STRUCT(data);
1901
1902         key = string_tdb_data("INFO/jobs_changed");
1903
1904         if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) == -1)
1905                 goto out;
1906
1907         gotlock = True;
1908
1909         data = tdb_fetch(pdb->tdb, key);
1910
1911         if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
1912                 goto out;
1913
1914         job_count = data.dsize / 4;
1915         for (i = 0; i < job_count; i++) {
1916                 uint32 ch_jobid;
1917
1918                 ch_jobid = IVAL(data.dptr, i*4);
1919                 if (ch_jobid == jobid) {
1920                         if (i < job_count -1 )
1921                                 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
1922                         data.dsize -= 4;
1923                         if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) == -1)
1924                                 goto out;
1925                         break;
1926                 }
1927         }
1928
1929         ret = True;
1930   out:
1931
1932         if (gotlock)
1933                 tdb_chainunlock(pdb->tdb, key);
1934         SAFE_FREE(data.dptr);
1935         release_print_db(pdb);
1936         if (ret)
1937                 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid ));
1938         else
1939                 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid ));
1940         return ret;
1941 }
1942
1943 /****************************************************************************
1944  Delete a print job - don't update queue.
1945 ****************************************************************************/
1946
1947 static bool print_job_delete1(int snum, uint32 jobid)
1948 {
1949         const char* sharename = lp_const_servicename(snum);
1950         struct printjob *pjob = print_job_find(sharename, jobid);
1951         int result = 0;
1952         struct printif *current_printif = get_printer_fns( snum );
1953
1954         if (!pjob)
1955                 return False;
1956
1957         /*
1958          * If already deleting just return.
1959          */
1960
1961         if (pjob->status == LPQ_DELETING)
1962                 return True;
1963
1964         /* Hrm - we need to be able to cope with deleting a job before it
1965            has reached the spooler.  Just mark it as LPQ_DELETING and
1966            let the print_queue_update() code rmeove the record */
1967
1968
1969         if (pjob->sysjob == -1) {
1970                 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid));
1971         }
1972
1973         /* Set the tdb entry to be deleting. */
1974
1975         pjob->status = LPQ_DELETING;
1976         pjob_store(sharename, jobid, pjob);
1977
1978         if (pjob->spooled && pjob->sysjob != -1)
1979         {
1980                 result = (*(current_printif->job_delete))(
1981                         PRINTERNAME(snum),
1982                         lp_lprmcommand(snum),
1983                         pjob);
1984
1985                 /* Delete the tdb entry if the delete succeeded or the job hasn't
1986                    been spooled. */
1987
1988                 if (result == 0) {
1989                         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1990                         int njobs = 1;
1991
1992                         if (!pdb)
1993                                 return False;
1994                         pjob_delete(sharename, jobid);
1995                         /* Ensure we keep a rough count of the number of total jobs... */
1996                         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, -1);
1997                         release_print_db(pdb);
1998                 }
1999         }
2000
2001         remove_from_jobs_changed( sharename, jobid );
2002
2003         return (result == 0);
2004 }
2005
2006 /****************************************************************************
2007  Return true if the current user owns the print job.
2008 ****************************************************************************/
2009
2010 static bool is_owner(struct auth_serversupplied_info *server_info,
2011                      const char *servicename,
2012                      uint32 jobid)
2013 {
2014         struct printjob *pjob = print_job_find(servicename, jobid);
2015
2016         if (!pjob || !server_info)
2017                 return False;
2018
2019         return strequal(pjob->user, server_info->sanitized_username);
2020 }
2021
2022 /****************************************************************************
2023  Delete a print job.
2024 ****************************************************************************/
2025
2026 bool print_job_delete(struct auth_serversupplied_info *server_info, int snum,
2027                       uint32 jobid, WERROR *errcode)
2028 {
2029         const char* sharename = lp_const_servicename( snum );
2030         struct printjob *pjob;
2031         bool    owner;
2032         char    *fname;
2033
2034         *errcode = WERR_OK;
2035
2036         owner = is_owner(server_info, lp_const_servicename(snum), jobid);
2037
2038         /* Check access against security descriptor or whether the user
2039            owns their job. */
2040
2041         if (!owner &&
2042             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2043                 DEBUG(3, ("delete denied by security descriptor\n"));
2044                 *errcode = WERR_ACCESS_DENIED;
2045
2046                 /* BEGIN_ADMIN_LOG */
2047                 sys_adminlog( LOG_ERR,
2048                               "Permission denied-- user not allowed to delete, \
2049 pause, or resume print job. User name: %s. Printer name: %s.",
2050                               uidtoname(server_info->utok.uid),
2051                               PRINTERNAME(snum) );
2052                 /* END_ADMIN_LOG */
2053
2054                 return False;
2055         }
2056
2057         /*
2058          * get the spooled filename of the print job
2059          * if this works, then the file has not been spooled
2060          * to the underlying print system.  Just delete the
2061          * spool file & return.
2062          */
2063
2064         if ( (fname = print_job_fname( sharename, jobid )) != NULL )
2065         {
2066                 /* remove the spool file */
2067                 DEBUG(10,("print_job_delete: Removing spool file [%s]\n", fname ));
2068                 if ( unlink( fname ) == -1 ) {
2069                         *errcode = map_werror_from_unix(errno);
2070                         return False;
2071                 }
2072         }
2073
2074         if (!print_job_delete1(snum, jobid)) {
2075                 *errcode = WERR_ACCESS_DENIED;
2076                 return False;
2077         }
2078
2079         /* force update the database and say the delete failed if the
2080            job still exists */
2081
2082         print_queue_update(snum, True);
2083
2084         pjob = print_job_find(sharename, jobid);
2085         if ( pjob && (pjob->status != LPQ_DELETING) )
2086                 *errcode = WERR_ACCESS_DENIED;
2087
2088         return (pjob == NULL );
2089 }
2090
2091 /****************************************************************************
2092  Pause a job.
2093 ****************************************************************************/
2094
2095 bool print_job_pause(struct auth_serversupplied_info *server_info, int snum,
2096                      uint32 jobid, WERROR *errcode)
2097 {
2098         const char* sharename = lp_const_servicename(snum);
2099         struct printjob *pjob;
2100         int ret = -1;
2101         struct printif *current_printif = get_printer_fns( snum );
2102
2103         pjob = print_job_find(sharename, jobid);
2104
2105         if (!pjob || !server_info) {
2106                 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2107                         (unsigned int)jobid ));
2108                 return False;
2109         }
2110
2111         if (!pjob->spooled || pjob->sysjob == -1) {
2112                 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2113                         (int)pjob->sysjob, (unsigned int)jobid ));
2114                 return False;
2115         }
2116
2117         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2118             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2119                 DEBUG(3, ("pause denied by security descriptor\n"));
2120
2121                 /* BEGIN_ADMIN_LOG */
2122                 sys_adminlog( LOG_ERR,
2123                         "Permission denied-- user not allowed to delete, \
2124 pause, or resume print job. User name: %s. Printer name: %s.",
2125                               uidtoname(server_info->utok.uid),
2126                               PRINTERNAME(snum) );
2127                 /* END_ADMIN_LOG */
2128
2129                 *errcode = WERR_ACCESS_DENIED;
2130                 return False;
2131         }
2132
2133         /* need to pause the spooled entry */
2134         ret = (*(current_printif->job_pause))(snum, pjob);
2135
2136         if (ret != 0) {
2137                 *errcode = WERR_INVALID_PARAM;
2138                 return False;
2139         }
2140
2141         /* force update the database */
2142         print_cache_flush(lp_const_servicename(snum));
2143
2144         /* Send a printer notify message */
2145
2146         notify_job_status(sharename, jobid, JOB_STATUS_PAUSED);
2147
2148         /* how do we tell if this succeeded? */
2149
2150         return True;
2151 }
2152
2153 /****************************************************************************
2154  Resume a job.
2155 ****************************************************************************/
2156
2157 bool print_job_resume(struct auth_serversupplied_info *server_info, int snum,
2158                       uint32 jobid, WERROR *errcode)
2159 {
2160         const char *sharename = lp_const_servicename(snum);
2161         struct printjob *pjob;
2162         int ret;
2163         struct printif *current_printif = get_printer_fns( snum );
2164
2165         pjob = print_job_find(sharename, jobid);
2166
2167         if (!pjob || !server_info) {
2168                 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2169                         (unsigned int)jobid ));
2170                 return False;
2171         }
2172
2173         if (!pjob->spooled || pjob->sysjob == -1) {
2174                 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2175                         (int)pjob->sysjob, (unsigned int)jobid ));
2176                 return False;
2177         }
2178
2179         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2180             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2181                 DEBUG(3, ("resume denied by security descriptor\n"));
2182                 *errcode = WERR_ACCESS_DENIED;
2183
2184                 /* BEGIN_ADMIN_LOG */
2185                 sys_adminlog( LOG_ERR,
2186                          "Permission denied-- user not allowed to delete, \
2187 pause, or resume print job. User name: %s. Printer name: %s.",
2188                               uidtoname(server_info->utok.uid),
2189                               PRINTERNAME(snum) );
2190                 /* END_ADMIN_LOG */
2191                 return False;
2192         }
2193
2194         ret = (*(current_printif->job_resume))(snum, pjob);
2195
2196         if (ret != 0) {
2197                 *errcode = WERR_INVALID_PARAM;
2198                 return False;
2199         }
2200
2201         /* force update the database */
2202         print_cache_flush(lp_const_servicename(snum));
2203
2204         /* Send a printer notify message */
2205
2206         notify_job_status(sharename, jobid, JOB_STATUS_QUEUED);
2207
2208         return True;
2209 }
2210
2211 /****************************************************************************
2212  Write to a print file.
2213 ****************************************************************************/
2214
2215 ssize_t print_job_write(int snum, uint32 jobid, const char *buf, SMB_OFF_T pos, size_t size)
2216 {
2217         const char* sharename = lp_const_servicename(snum);
2218         int return_code;
2219         struct printjob *pjob;
2220
2221         pjob = print_job_find(sharename, jobid);
2222
2223         if (!pjob)
2224                 return -1;
2225         /* don't allow another process to get this info - it is meaningless */
2226         if (pjob->pid != sys_getpid())
2227                 return -1;
2228
2229         return_code = write_data_at_offset(pjob->fd, buf, size, pos);
2230
2231         if (return_code>0) {
2232                 pjob->size += size;
2233                 pjob_store(sharename, jobid, pjob);
2234         }
2235         return return_code;
2236 }
2237
2238 /****************************************************************************
2239  Get the queue status - do not update if db is out of date.
2240 ****************************************************************************/
2241
2242 static int get_queue_status(const char* sharename, print_status_struct *status)
2243 {
2244         fstring keystr;
2245         TDB_DATA data;
2246         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2247         int len;
2248
2249         if (status) {
2250                 ZERO_STRUCTP(status);
2251         }
2252
2253         if (!pdb)
2254                 return 0;
2255
2256         if (status) {
2257                 fstr_sprintf(keystr, "STATUS/%s", sharename);
2258                 data = tdb_fetch(pdb->tdb, string_tdb_data(keystr));
2259                 if (data.dptr) {
2260                         if (data.dsize == sizeof(print_status_struct))
2261                                 /* this memcpy is ok since the status struct was
2262                                    not packed before storing it in the tdb */
2263                                 memcpy(status, data.dptr, sizeof(print_status_struct));
2264                         SAFE_FREE(data.dptr);
2265                 }
2266         }
2267         len = tdb_fetch_int32(pdb->tdb, "INFO/total_jobs");
2268         release_print_db(pdb);
2269         return (len == -1 ? 0 : len);
2270 }
2271
2272 /****************************************************************************
2273  Determine the number of jobs in a queue.
2274 ****************************************************************************/
2275
2276 int print_queue_length(int snum, print_status_struct *pstatus)
2277 {
2278         const char* sharename = lp_const_servicename( snum );
2279         print_status_struct status;
2280         int len;
2281
2282         ZERO_STRUCT( status );
2283
2284         /* make sure the database is up to date */
2285         if (print_cache_expired(lp_const_servicename(snum), True))
2286                 print_queue_update(snum, False);
2287
2288         /* also fetch the queue status */
2289         memset(&status, 0, sizeof(status));
2290         len = get_queue_status(sharename, &status);
2291
2292         if (pstatus)
2293                 *pstatus = status;
2294
2295         return len;
2296 }
2297
2298 /***************************************************************************
2299  Allocate a jobid. Hold the lock for as short a time as possible.
2300 ***************************************************************************/
2301
2302 static bool allocate_print_jobid(struct tdb_print_db *pdb, int snum, const char *sharename, uint32 *pjobid)
2303 {
2304         int i;
2305         uint32 jobid;
2306
2307         *pjobid = (uint32)-1;
2308
2309         for (i = 0; i < 3; i++) {
2310                 /* Lock the database - only wait 20 seconds. */
2311                 if (tdb_lock_bystring_with_timeout(pdb->tdb, "INFO/nextjob", 20) == -1) {
2312                         DEBUG(0,("allocate_print_jobid: failed to lock printing database %s\n", sharename));
2313                         return False;
2314                 }
2315
2316                 if (!tdb_fetch_uint32(pdb->tdb, "INFO/nextjob", &jobid)) {
2317                         if (tdb_error(pdb->tdb) != TDB_ERR_NOEXIST) {
2318                                 DEBUG(0, ("allocate_print_jobid: failed to fetch INFO/nextjob for print queue %s\n",
2319                                         sharename));
2320                                 return False;
2321                         }
2322                         jobid = 0;
2323                 }
2324
2325                 jobid = NEXT_JOBID(jobid);
2326
2327                 if (tdb_store_int32(pdb->tdb, "INFO/nextjob", jobid)==-1) {
2328                         DEBUG(3, ("allocate_print_jobid: failed to store INFO/nextjob.\n"));
2329                         tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2330                         return False;
2331                 }
2332
2333                 /* We've finished with the INFO/nextjob lock. */
2334                 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2335
2336                 if (!print_job_exists(sharename, jobid))
2337                         break;
2338         }
2339
2340         if (i > 2) {
2341                 DEBUG(0, ("allocate_print_jobid: failed to allocate a print job for queue %s\n",
2342                         sharename));
2343                 /* Probably full... */
2344                 errno = ENOSPC;
2345                 return False;
2346         }
2347
2348         /* Store a dummy placeholder. */
2349         {
2350                 uint32_t tmp;
2351                 TDB_DATA dum;
2352                 dum.dptr = NULL;
2353                 dum.dsize = 0;
2354                 if (tdb_store(pdb->tdb, print_key(jobid, &tmp), dum,
2355                               TDB_INSERT) == -1) {
2356                         DEBUG(3, ("allocate_print_jobid: jobid (%d) failed to store placeholder.\n",
2357                                 jobid ));
2358                         return False;
2359                 }
2360         }
2361
2362         *pjobid = jobid;
2363         return True;
2364 }
2365
2366 /***************************************************************************
2367  Append a jobid to the 'jobs changed' list.
2368 ***************************************************************************/
2369
2370 static bool add_to_jobs_changed(struct tdb_print_db *pdb, uint32 jobid)
2371 {
2372         TDB_DATA data;
2373         uint32 store_jobid;
2374
2375         SIVAL(&store_jobid, 0, jobid);
2376         data.dptr = (uint8 *)&store_jobid;
2377         data.dsize = 4;
2378
2379         DEBUG(10,("add_to_jobs_changed: Added jobid %u\n", (unsigned int)jobid ));
2380
2381         return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_changed"),
2382                            data) == 0);
2383 }
2384
2385 /***************************************************************************
2386  Start spooling a job - return the jobid.
2387 ***************************************************************************/
2388
2389 uint32 print_job_start(struct auth_serversupplied_info *server_info, int snum,
2390                        char *jobname, NT_DEVICEMODE *nt_devmode )
2391 {
2392         uint32 jobid;
2393         char *path;
2394         struct printjob pjob;
2395         const char *sharename = lp_const_servicename(snum);
2396         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2397         int njobs;
2398
2399         errno = 0;
2400
2401         if (!pdb)
2402                 return (uint32)-1;
2403
2404         if (!print_access_check(server_info, snum, PRINTER_ACCESS_USE)) {
2405                 DEBUG(3, ("print_job_start: job start denied by security descriptor\n"));
2406                 release_print_db(pdb);
2407                 return (uint32)-1;
2408         }
2409
2410         if (!print_time_access_check(lp_servicename(snum))) {
2411                 DEBUG(3, ("print_job_start: job start denied by time check\n"));
2412                 release_print_db(pdb);
2413                 return (uint32)-1;
2414         }
2415
2416         path = lp_pathname(snum);
2417
2418         /* see if we have sufficient disk space */
2419         if (lp_minprintspace(snum)) {
2420                 uint64_t dspace, dsize;
2421                 if (sys_fsusage(path, &dspace, &dsize) == 0 &&
2422                     dspace < 2*(uint64_t)lp_minprintspace(snum)) {
2423                         DEBUG(3, ("print_job_start: disk space check failed.\n"));
2424                         release_print_db(pdb);
2425                         errno = ENOSPC;
2426                         return (uint32)-1;
2427                 }
2428         }
2429
2430         /* for autoloaded printers, check that the printcap entry still exists */
2431         if (lp_autoloaded(snum) && !pcap_printername_ok(lp_const_servicename(snum))) {
2432                 DEBUG(3, ("print_job_start: printer name %s check failed.\n", lp_const_servicename(snum) ));
2433                 release_print_db(pdb);
2434                 errno = ENOENT;
2435                 return (uint32)-1;
2436         }
2437
2438         /* Insure the maximum queue size is not violated */
2439         if ((njobs = print_queue_length(snum,NULL)) > lp_maxprintjobs(snum)) {
2440                 DEBUG(3, ("print_job_start: Queue %s number of jobs (%d) larger than max printjobs per queue (%d).\n",
2441                         sharename, njobs, lp_maxprintjobs(snum) ));
2442                 release_print_db(pdb);
2443                 errno = ENOSPC;
2444                 return (uint32)-1;
2445         }
2446
2447         DEBUG(10,("print_job_start: Queue %s number of jobs (%d), max printjobs = %d\n",
2448                 sharename, njobs, lp_maxprintjobs(snum) ));
2449
2450         if (!allocate_print_jobid(pdb, snum, sharename, &jobid))
2451                 goto fail;
2452
2453         /* create the database entry */
2454
2455         ZERO_STRUCT(pjob);
2456
2457         pjob.pid = sys_getpid();
2458         pjob.sysjob = -1;
2459         pjob.fd = -1;
2460         pjob.starttime = time(NULL);
2461         pjob.status = LPQ_SPOOLING;
2462         pjob.size = 0;
2463         pjob.spooled = False;
2464         pjob.smbjob = True;
2465         pjob.nt_devmode = nt_devmode;
2466
2467         fstrcpy(pjob.jobname, jobname);
2468
2469         fstrcpy(pjob.user, lp_printjob_username(snum));
2470         standard_sub_advanced(sharename, server_info->sanitized_username,
2471                               path, server_info->utok.gid,
2472                               server_info->sanitized_username,
2473                               pdb_get_domain(server_info->sam_account),
2474                               pjob.user, sizeof(pjob.user)-1);
2475         /* ensure NULL termination */
2476         pjob.user[sizeof(pjob.user)-1] = '\0';
2477
2478         fstrcpy(pjob.queuename, lp_const_servicename(snum));
2479
2480         /* we have a job entry - now create the spool file */
2481         slprintf(pjob.filename, sizeof(pjob.filename)-1, "%s/%s%.8u.XXXXXX",
2482                  path, PRINT_SPOOL_PREFIX, (unsigned int)jobid);
2483         pjob.fd = smb_mkstemp(pjob.filename);
2484
2485         if (pjob.fd == -1) {
2486                 if (errno == EACCES) {
2487                         /* Common setup error, force a report. */
2488                         DEBUG(0, ("print_job_start: insufficient permissions \
2489 to open spool file %s.\n", pjob.filename));
2490                 } else {
2491                         /* Normal case, report at level 3 and above. */
2492                         DEBUG(3, ("print_job_start: can't open spool file %s,\n", pjob.filename));
2493                         DEBUGADD(3, ("errno = %d (%s).\n", errno, strerror(errno)));
2494                 }
2495                 goto fail;
2496         }
2497
2498         pjob_store(sharename, jobid, &pjob);
2499
2500         /* Update the 'jobs changed' entry used by print_queue_status. */
2501         add_to_jobs_changed(pdb, jobid);
2502
2503         /* Ensure we keep a rough count of the number of total jobs... */
2504         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, 1);
2505
2506         release_print_db(pdb);
2507
2508         return jobid;
2509
2510  fail:
2511         if (jobid != -1)
2512                 pjob_delete(sharename, jobid);
2513
2514         release_print_db(pdb);
2515
2516         DEBUG(3, ("print_job_start: returning fail. Error = %s\n", strerror(errno) ));
2517         return (uint32)-1;
2518 }
2519
2520 /****************************************************************************
2521  Update the number of pages spooled to jobid
2522 ****************************************************************************/
2523
2524 void print_job_endpage(int snum, uint32 jobid)
2525 {
2526         const char* sharename = lp_const_servicename(snum);
2527         struct printjob *pjob;
2528
2529         pjob = print_job_find(sharename, jobid);
2530         if (!pjob)
2531                 return;
2532         /* don't allow another process to get this info - it is meaningless */
2533         if (pjob->pid != sys_getpid())
2534                 return;
2535
2536         pjob->page_count++;
2537         pjob_store(sharename, jobid, pjob);
2538 }
2539
2540 /****************************************************************************
2541  Print a file - called on closing the file. This spools the job.
2542  If normal close is false then we're tearing down the jobs - treat as an
2543  error.
2544 ****************************************************************************/
2545
2546 bool print_job_end(int snum, uint32 jobid, enum file_close_type close_type)
2547 {
2548         const char* sharename = lp_const_servicename(snum);
2549         struct printjob *pjob;
2550         int ret;
2551         SMB_STRUCT_STAT sbuf;
2552         struct printif *current_printif = get_printer_fns( snum );
2553
2554         pjob = print_job_find(sharename, jobid);
2555
2556         if (!pjob)
2557                 return False;
2558
2559         if (pjob->spooled || pjob->pid != sys_getpid())
2560                 return False;
2561
2562         if ((close_type == NORMAL_CLOSE || close_type == SHUTDOWN_CLOSE) &&
2563                                 (sys_fstat(pjob->fd, &sbuf) == 0)) {
2564                 pjob->size = sbuf.st_size;
2565                 close(pjob->fd);
2566                 pjob->fd = -1;
2567         } else {
2568
2569                 /*
2570                  * Not a normal close or we couldn't stat the job file,
2571                  * so something has gone wrong. Cleanup.
2572                  */
2573                 close(pjob->fd);
2574                 pjob->fd = -1;
2575                 DEBUG(3,("print_job_end: failed to stat file for jobid %d\n", jobid ));
2576                 goto fail;
2577         }
2578
2579         /* Technically, this is not quite right. If the printer has a separator
2580          * page turned on, the NT spooler prints the separator page even if the
2581          * print job is 0 bytes. 010215 JRR */
2582         if (pjob->size == 0 || pjob->status == LPQ_DELETING) {
2583                 /* don't bother spooling empty files or something being deleted. */
2584                 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
2585                         pjob->filename, pjob->size ? "deleted" : "zero length" ));
2586                 unlink(pjob->filename);
2587                 pjob_delete(sharename, jobid);
2588                 return True;
2589         }
2590
2591         pjob->smbjob = jobid;
2592
2593         ret = (*(current_printif->job_submit))(snum, pjob);
2594
2595         if (ret)
2596                 goto fail;
2597
2598         /* The print job has been successfully handed over to the back-end */
2599
2600         pjob->spooled = True;
2601         pjob->status = LPQ_QUEUED;
2602         pjob_store(sharename, jobid, pjob);
2603
2604         /* make sure the database is up to date */
2605         if (print_cache_expired(lp_const_servicename(snum), True))
2606                 print_queue_update(snum, False);
2607
2608         return True;
2609
2610 fail:
2611
2612         /* The print job was not successfully started. Cleanup */
2613         /* Still need to add proper error return propagation! 010122:JRR */
2614         unlink(pjob->filename);
2615         pjob_delete(sharename, jobid);
2616         return False;
2617 }
2618
2619 /****************************************************************************
2620  Get a snapshot of jobs in the system without traversing.
2621 ****************************************************************************/
2622
2623 static bool get_stored_queue_info(struct tdb_print_db *pdb, int snum, int *pcount, print_queue_struct **ppqueue)
2624 {
2625         TDB_DATA data, cgdata;
2626         print_queue_struct *queue = NULL;
2627         uint32 qcount = 0;
2628         uint32 extra_count = 0;
2629         int total_count = 0;
2630         size_t len = 0;
2631         uint32 i;
2632         int max_reported_jobs = lp_max_reported_jobs(snum);
2633         bool ret = False;
2634         const char* sharename = lp_servicename(snum);
2635
2636         /* make sure the database is up to date */
2637         if (print_cache_expired(lp_const_servicename(snum), True))
2638                 print_queue_update(snum, False);
2639
2640         *pcount = 0;
2641         *ppqueue = NULL;
2642
2643         ZERO_STRUCT(data);
2644         ZERO_STRUCT(cgdata);
2645
2646         /* Get the stored queue data. */
2647         data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/linear_queue_array"));
2648
2649         if (data.dptr && data.dsize >= sizeof(qcount))
2650                 len += tdb_unpack(data.dptr + len, data.dsize - len, "d", &qcount);
2651
2652         /* Get the changed jobs list. */
2653         cgdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
2654         if (cgdata.dptr != NULL && (cgdata.dsize % 4 == 0))
2655                 extra_count = cgdata.dsize/4;
2656
2657         DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount, (unsigned int)extra_count));
2658
2659         /* Allocate the queue size. */
2660         if (qcount == 0 && extra_count == 0)
2661                 goto out;
2662
2663         if ((queue = SMB_MALLOC_ARRAY(print_queue_struct, qcount + extra_count)) == NULL)
2664                 goto out;
2665
2666         /* Retrieve the linearised queue data. */
2667
2668         for( i  = 0; i < qcount; i++) {
2669                 uint32 qjob, qsize, qpage_count, qstatus, qpriority, qtime;
2670                 len += tdb_unpack(data.dptr + len, data.dsize - len, "ddddddff",
2671                                 &qjob,
2672                                 &qsize,
2673                                 &qpage_count,
2674                                 &qstatus,
2675                                 &qpriority,
2676                                 &qtime,
2677                                 queue[i].fs_user,
2678                                 queue[i].fs_file);
2679                 queue[i].job = qjob;
2680                 queue[i].size = qsize;
2681                 queue[i].page_count = qpage_count;
2682                 queue[i].status = qstatus;
2683                 queue[i].priority = qpriority;
2684                 queue[i].time = qtime;
2685         }
2686
2687         total_count = qcount;
2688
2689         /* Add in the changed jobids. */
2690         for( i  = 0; i < extra_count; i++) {
2691                 uint32 jobid;
2692                 struct printjob *pjob;
2693
2694                 jobid = IVAL(cgdata.dptr, i*4);
2695                 DEBUG(5,("get_stored_queue_info: changed job = %u\n", (unsigned int)jobid));
2696                 pjob = print_job_find(lp_const_servicename(snum), jobid);
2697                 if (!pjob) {
2698                         DEBUG(5,("get_stored_queue_info: failed to find changed job = %u\n", (unsigned int)jobid));
2699                         remove_from_jobs_changed(sharename, jobid);
2700                         continue;
2701                 }
2702
2703                 queue[total_count].job = jobid;
2704                 queue[total_count].size = pjob->size;
2705                 queue[total_count].page_count = pjob->page_count;
2706                 queue[total_count].status = pjob->status;
2707                 queue[total_count].priority = 1;
2708                 queue[total_count].time = pjob->starttime;
2709                 fstrcpy(queue[total_count].fs_user, pjob->user);
2710                 fstrcpy(queue[total_count].fs_file, pjob->jobname);
2711                 total_count++;
2712         }
2713
2714         /* Sort the queue by submission time otherwise they are displayed
2715            in hash order. */
2716
2717         qsort(queue, total_count, sizeof(print_queue_struct), QSORT_CAST(printjob_comp));
2718
2719         DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count));
2720
2721         if (max_reported_jobs && total_count > max_reported_jobs)
2722                 total_count = max_reported_jobs;
2723
2724         *ppqueue = queue;
2725         *pcount = total_count;
2726
2727         ret = True;
2728
2729   out:
2730
2731         SAFE_FREE(data.dptr);
2732         SAFE_FREE(cgdata.dptr);
2733         return ret;
2734 }
2735
2736 /****************************************************************************
2737  Get a printer queue listing.
2738  set queue = NULL and status = NULL if you just want to update the cache
2739 ****************************************************************************/
2740
2741 int print_queue_status(int snum,
2742                        print_queue_struct **ppqueue,
2743                        print_status_struct *status)
2744 {
2745         fstring keystr;
2746         TDB_DATA data, key;
2747         const char *sharename;
2748         struct tdb_print_db *pdb;
2749         int count = 0;
2750
2751         /* make sure the database is up to date */
2752
2753         if (print_cache_expired(lp_const_servicename(snum), True))
2754                 print_queue_update(snum, False);
2755
2756         /* return if we are done */
2757         if ( !ppqueue || !status )
2758                 return 0;
2759
2760         *ppqueue = NULL;
2761         sharename = lp_const_servicename(snum);
2762         pdb = get_print_db_byname(sharename);
2763
2764         if (!pdb)
2765                 return 0;
2766
2767         /*
2768          * Fetch the queue status.  We must do this first, as there may
2769          * be no jobs in the queue.
2770          */
2771
2772         ZERO_STRUCTP(status);
2773         slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
2774         key = string_tdb_data(keystr);
2775
2776         data = tdb_fetch(pdb->tdb, key);
2777         if (data.dptr) {
2778                 if (data.dsize == sizeof(*status)) {
2779                         /* this memcpy is ok since the status struct was
2780                            not packed before storing it in the tdb */
2781                         memcpy(status, data.dptr, sizeof(*status));
2782                 }
2783                 SAFE_FREE(data.dptr);
2784         }
2785
2786         /*
2787          * Now, fetch the print queue information.  We first count the number
2788          * of entries, and then only retrieve the queue if necessary.
2789          */
2790
2791         if (!get_stored_queue_info(pdb, snum, &count, ppqueue)) {
2792                 release_print_db(pdb);
2793                 return 0;
2794         }
2795
2796         release_print_db(pdb);
2797         return count;
2798 }
2799
2800 /****************************************************************************
2801  Pause a queue.
2802 ****************************************************************************/
2803
2804 bool print_queue_pause(struct auth_serversupplied_info *server_info, int snum,
2805                        WERROR *errcode)
2806 {
2807         int ret;
2808         struct printif *current_printif = get_printer_fns( snum );
2809
2810         if (!print_access_check(server_info, snum,
2811                                 PRINTER_ACCESS_ADMINISTER)) {
2812                 *errcode = WERR_ACCESS_DENIED;
2813                 return False;
2814         }
2815
2816
2817         become_root();
2818
2819         ret = (*(current_printif->queue_pause))(snum);
2820
2821         unbecome_root();
2822
2823         if (ret != 0) {
2824                 *errcode = WERR_INVALID_PARAM;
2825                 return False;
2826         }
2827
2828         /* force update the database */
2829         print_cache_flush(lp_const_servicename(snum));
2830
2831         /* Send a printer notify message */
2832
2833         notify_printer_status(snum, PRINTER_STATUS_PAUSED);
2834
2835         return True;
2836 }
2837
2838 /****************************************************************************
2839  Resume a queue.
2840 ****************************************************************************/
2841
2842 bool print_queue_resume(struct auth_serversupplied_info *server_info, int snum,
2843                         WERROR *errcode)
2844 {
2845         int ret;
2846         struct printif *current_printif = get_printer_fns( snum );
2847
2848         if (!print_access_check(server_info, snum,
2849                                 PRINTER_ACCESS_ADMINISTER)) {
2850                 *errcode = WERR_ACCESS_DENIED;
2851                 return False;
2852         }
2853
2854         become_root();
2855
2856         ret = (*(current_printif->queue_resume))(snum);
2857
2858         unbecome_root();
2859
2860         if (ret != 0) {
2861                 *errcode = WERR_INVALID_PARAM;
2862                 return False;
2863         }
2864
2865         /* make sure the database is up to date */
2866         if (print_cache_expired(lp_const_servicename(snum), True))
2867                 print_queue_update(snum, True);
2868
2869         /* Send a printer notify message */
2870
2871         notify_printer_status(snum, PRINTER_STATUS_OK);
2872
2873         return True;
2874 }
2875
2876 /****************************************************************************
2877  Purge a queue - implemented by deleting all jobs that we can delete.
2878 ****************************************************************************/
2879
2880 bool print_queue_purge(struct auth_serversupplied_info *server_info, int snum,
2881                        WERROR *errcode)
2882 {
2883         print_queue_struct *queue;
2884         print_status_struct status;
2885         int njobs, i;
2886         bool can_job_admin;
2887
2888         /* Force and update so the count is accurate (i.e. not a cached count) */
2889         print_queue_update(snum, True);
2890
2891         can_job_admin = print_access_check(server_info, snum,
2892                                            JOB_ACCESS_ADMINISTER);
2893         njobs = print_queue_status(snum, &queue, &status);
2894
2895         if ( can_job_admin )
2896                 become_root();
2897
2898         for (i=0;i<njobs;i++) {
2899                 bool owner = is_owner(server_info, lp_const_servicename(snum),
2900                                       queue[i].job);
2901
2902                 if (owner || can_job_admin) {
2903                         print_job_delete1(snum, queue[i].job);
2904                 }
2905         }
2906
2907         if ( can_job_admin )
2908                 unbecome_root();
2909
2910         /* update the cache */
2911         print_queue_update( snum, True );
2912
2913         SAFE_FREE(queue);
2914
2915         return True;
2916 }