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 struct current_user current_user;
  26 extern userdom_struct current_user_info;
  27
  28 /* Current printer interface */
  29 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid);
  30
  31 /*
  32    the printing backend revolves around a tdb database that stores the
  33    SMB view of the print queue
  34
  35    The key for this database is a jobid - a internally generated number that
  36    uniquely identifies a print job
  37
  38    reading the print queue involves two steps:
  39      - possibly running lpq and updating the internal database from that
  40      - reading entries from the database
  41
  42    jobids are assigned when a job starts spooling.
  43 */
  44
  45 static TDB_CONTEXT *rap_tdb;
  46 static uint16 next_rap_jobid;
  47 struct rap_jobid_key {
  48         fstring sharename;
  49         uint32  jobid;
  50 };
  51
  52 /***************************************************************************
  53  Nightmare. LANMAN jobid's are 16 bit numbers..... We must map them to 32
  54  bit RPC jobids.... JRA.
  55 ***************************************************************************/
  56
  57 uint16 pjobid_to_rap(const char* sharename, uint32 jobid)
  58 {
  59         uint16 rap_jobid;
  60         TDB_DATA data, key;
  61         struct rap_jobid_key jinfo;
  62         uint8 buf[2];
  63
  64         DEBUG(10,("pjobid_to_rap: called.\n"));
  65
  66         if (!rap_tdb) {
  67                 /* Create the in-memory tdb. */
  68                 rap_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL, (O_RDWR|O_CREAT), 0644);
  69                 if (!rap_tdb)
  70                         return 0;
  71         }
  72
  73         ZERO_STRUCT( jinfo );
  74         fstrcpy( jinfo.sharename, sharename );
  75         jinfo.jobid = jobid;
  76         key.dptr = (uint8 *)&jinfo;
  77         key.dsize = sizeof(jinfo);
  78
  79         data = tdb_fetch(rap_tdb, key);
  80         if (data.dptr && data.dsize == sizeof(uint16)) {
  81                 rap_jobid = SVAL(data.dptr, 0);
  82                 SAFE_FREE(data.dptr);
  83                 DEBUG(10,("pjobid_to_rap: jobid %u maps to RAP jobid %u\n",
  84                         (unsigned int)jobid, (unsigned int)rap_jobid));
  85                 return rap_jobid;
  86         }
  87         SAFE_FREE(data.dptr);
  88         /* Not found - create and store mapping. */
  89         rap_jobid = ++next_rap_jobid;
  90         if (rap_jobid == 0)
  91                 rap_jobid = ++next_rap_jobid;
  92         SSVAL(buf,0,rap_jobid);
  93         data.dptr = buf;
  94         data.dsize = sizeof(rap_jobid);
  95         tdb_store(rap_tdb, key, data, TDB_REPLACE);
  96         tdb_store(rap_tdb, data, key, TDB_REPLACE);
  97
  98         DEBUG(10,("pjobid_to_rap: created jobid %u maps to RAP jobid %u\n",
  99                 (unsigned int)jobid, (unsigned int)rap_jobid));
 100         return rap_jobid;
 101 }
 102
 103 bool rap_to_pjobid(uint16 rap_jobid, fstring sharename, uint32 *pjobid)
 104 {
 105         TDB_DATA data, key;
 106         uint8 buf[2];
 107
 108         DEBUG(10,("rap_to_pjobid called.\n"));
 109
 110         if (!rap_tdb)
 111                 return False;
 112
 113         SSVAL(buf,0,rap_jobid);
 114         key.dptr = buf;
 115         key.dsize = sizeof(rap_jobid);
 116         data = tdb_fetch(rap_tdb, key);
 117         if ( data.dptr && data.dsize == sizeof(struct rap_jobid_key) )
 118         {
 119                 struct rap_jobid_key *jinfo = (struct rap_jobid_key*)data.dptr;
 120                 if (sharename != NULL) {
 121                         fstrcpy( sharename, jinfo->sharename );
 122                 }
 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_DEVQ },
 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         TYPESAFE_QSORT(queue, qcount, printjob_comp);
1162
1163         /*
1164           any job in the internal database that is marked as spooled
1165           and doesn't exist in the system queue is considered finished
1166           and removed from the database
1167
1168           any job in the system database but not in the internal database
1169           is added as a unix job
1170
1171           fill in any system job numbers as we go
1172         */
1173
1174         jcdata = get_jobs_changed_data(pdb);
1175
1176         for (i=0; i<qcount; i++) {
1177                 uint32 jobid = print_parse_jobid(queue[i].fs_file);
1178
1179                 if (jobid == (uint32)-1) {
1180                         /* assume its a unix print job */
1181                         print_unix_job(sharename, &queue[i], jobid);
1182                         continue;
1183                 }
1184
1185                 /* we have an active SMB print job - update its status */
1186                 pjob = print_job_find(sharename, jobid);
1187                 if (!pjob) {
1188                         /* err, somethings wrong. Probably smbd was restarted
1189                            with jobs in the queue. All we can do is treat them
1190                            like unix jobs. Pity. */
1191                         print_unix_job(sharename, &queue[i], jobid);
1192                         continue;
1193                 }
1194
1195                 pjob->sysjob = queue[i].job;
1196
1197                 /* don't reset the status on jobs to be deleted */
1198
1199                 if ( pjob->status != LPQ_DELETING )
1200                         pjob->status = queue[i].status;
1201
1202                 pjob_store(sharename, jobid, pjob);
1203
1204                 check_job_changed(sharename, jcdata, jobid);
1205         }
1206
1207         SAFE_FREE(jcdata.dptr);
1208
1209         /* now delete any queued entries that don't appear in the
1210            system queue */
1211         tstruct.queue = queue;
1212         tstruct.qcount = qcount;
1213         tstruct.snum = -1;
1214         tstruct.total_jobs = 0;
1215         tstruct.lpq_time = time(NULL);
1216         tstruct.sharename = sharename;
1217         tstruct.lprm_command = lprm_command;
1218         tstruct.print_if = current_printif;
1219
1220         tdb_traverse(pdb->tdb, traverse_fn_delete, (void *)&tstruct);
1221
1222         /* Store the linearised queue, max jobs only. */
1223         store_queue_struct(pdb, &tstruct);
1224
1225         SAFE_FREE(tstruct.queue);
1226
1227         DEBUG(10,("print_queue_update_internal: printer %s INFO/total_jobs = %d\n",
1228                                 sharename, tstruct.total_jobs ));
1229
1230         tdb_store_int32(pdb->tdb, "INFO/total_jobs", tstruct.total_jobs);
1231
1232         get_queue_status(sharename, &old_status);
1233         if (old_status.qcount != qcount)
1234                 DEBUG(10,("print_queue_update_internal: queue status change %d jobs -> %d jobs for printer %s\n",
1235                                         old_status.qcount, qcount, sharename));
1236
1237         /* store the new queue status structure */
1238         slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
1239         key = string_tdb_data(keystr);
1240
1241         status.qcount = qcount;
1242         data.dptr = (uint8 *)&status;
1243         data.dsize = sizeof(status);
1244         tdb_store(pdb->tdb, key, data, TDB_REPLACE);
1245
1246         /*
1247          * Update the cache time again. We want to do this call
1248          * as little as possible...
1249          */
1250
1251         slprintf(keystr, sizeof(keystr)-1, "CACHE/%s", sharename);
1252         tdb_store_int32(pdb->tdb, keystr, (int32)time(NULL));
1253
1254         /* clear the msg pending record for this queue */
1255
1256         snprintf(keystr, sizeof(keystr), "MSG_PENDING/%s", sharename);
1257
1258         if ( !tdb_store_uint32( pdb->tdb, keystr, 0 ) ) {
1259                 /* log a message but continue on */
1260
1261                 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1262                         sharename));
1263         }
1264
1265         release_print_db( pdb );
1266
1267         return;
1268 }
1269
1270 /****************************************************************************
1271  Update the internal database from the system print queue for a queue.
1272  obtain a lock on the print queue before proceeding (needed when mutiple
1273  smbd processes maytry to update the lpq cache concurrently).
1274 ****************************************************************************/
1275
1276 static void print_queue_update_with_lock( const char *sharename,
1277                                           struct printif *current_printif,
1278                                           char *lpq_command, char *lprm_command )
1279 {
1280         fstring keystr;
1281         struct tdb_print_db *pdb;
1282
1283         DEBUG(5,("print_queue_update_with_lock: printer share = %s\n", sharename));
1284         pdb = get_print_db_byname(sharename);
1285         if (!pdb)
1286                 return;
1287
1288         if ( !print_cache_expired(sharename, False) ) {
1289                 DEBUG(5,("print_queue_update_with_lock: print cache for %s is still ok\n", sharename));
1290                 release_print_db(pdb);
1291                 return;
1292         }
1293
1294         /*
1295          * Check to see if someone else is doing this update.
1296          * This is essentially a mutex on the update.
1297          */
1298
1299         if (get_updating_pid(sharename) != -1) {
1300                 release_print_db(pdb);
1301                 return;
1302         }
1303
1304         /* Lock the queue for the database update */
1305
1306         slprintf(keystr, sizeof(keystr) - 1, "LOCK/%s", sharename);
1307         /* Only wait 10 seconds for this. */
1308         if (tdb_lock_bystring_with_timeout(pdb->tdb, keystr, 10) == -1) {
1309                 DEBUG(0,("print_queue_update_with_lock: Failed to lock printer %s database\n", sharename));
1310                 release_print_db(pdb);
1311                 return;
1312         }
1313
1314         /*
1315          * Ensure that no one else got in here.
1316          * If the updating pid is still -1 then we are
1317          * the winner.
1318          */
1319
1320         if (get_updating_pid(sharename) != -1) {
1321                 /*
1322                  * Someone else is doing the update, exit.
1323                  */
1324                 tdb_unlock_bystring(pdb->tdb, keystr);
1325                 release_print_db(pdb);
1326                 return;
1327         }
1328
1329         /*
1330          * We're going to do the update ourselves.
1331          */
1332
1333         /* Tell others we're doing the update. */
1334         set_updating_pid(sharename, True);
1335
1336         /*
1337          * Allow others to enter and notice we're doing
1338          * the update.
1339          */
1340
1341         tdb_unlock_bystring(pdb->tdb, keystr);
1342
1343         /* do the main work now */
1344
1345         print_queue_update_internal( sharename, current_printif,
1346                 lpq_command, lprm_command );
1347
1348         /* Delete our pid from the db. */
1349         set_updating_pid(sharename, False);
1350         release_print_db(pdb);
1351 }
1352
1353 /****************************************************************************
1354 this is the receive function of the background lpq updater
1355 ****************************************************************************/
1356 static void print_queue_receive(struct messaging_context *msg,
1357                                 void *private_data,
1358                                 uint32_t msg_type,
1359                                 struct server_id server_id,
1360                                 DATA_BLOB *data)
1361 {
1362         fstring sharename;
1363         char *lpqcommand = NULL, *lprmcommand = NULL;
1364         int printing_type;
1365         size_t len;
1366
1367         len = tdb_unpack( (uint8 *)data->data, data->length, "fdPP",
1368                 sharename,
1369                 &printing_type,
1370                 &lpqcommand,
1371                 &lprmcommand );
1372
1373         if ( len == -1 ) {
1374                 SAFE_FREE(lpqcommand);
1375                 SAFE_FREE(lprmcommand);
1376                 DEBUG(0,("print_queue_receive: Got invalid print queue update message\n"));
1377                 return;
1378         }
1379
1380         print_queue_update_with_lock(sharename,
1381                 get_printer_fns_from_type((enum printing_types)printing_type),
1382                 lpqcommand, lprmcommand );
1383
1384         SAFE_FREE(lpqcommand);
1385         SAFE_FREE(lprmcommand);
1386         return;
1387 }
1388
1389 static void printing_pause_fd_handler(struct tevent_context *ev,
1390                                       struct tevent_fd *fde,
1391                                       uint16_t flags,
1392                                       void *private_data)
1393 {
1394         /*
1395          * If pause_pipe[1] is closed it means the parent smbd
1396          * and children exited or aborted.
1397          */
1398         exit_server_cleanly(NULL);
1399 }
1400
1401 static void add_child_pid(pid_t pid)
1402 {
1403         extern struct child_pid *children;
1404         struct child_pid *child;
1405         extern int num_children;
1406
1407         child = SMB_MALLOC_P(struct child_pid);
1408         if (child == NULL) {
1409                 DEBUG(0, ("Could not add child struct -- malloc failed\n"));
1410                 return;
1411         }
1412         child->pid = pid;
1413         DLIST_ADD(children, child);
1414         num_children += 1;
1415 }
1416
1417 static pid_t background_lpq_updater_pid = -1;
1418
1419 /****************************************************************************
1420 main thread of the background lpq updater
1421 ****************************************************************************/
1422 void start_background_queue(void)
1423 {
1424         /* Use local variables for this as we don't
1425          * need to save the parent side of this, just
1426          * ensure it closes when the process exits.
1427          */
1428         int pause_pipe[2];
1429
1430         DEBUG(3,("start_background_queue: Starting background LPQ thread\n"));
1431
1432         if (pipe(pause_pipe) == -1) {
1433                 DEBUG(5,("start_background_queue: cannot create pipe. %s\n", strerror(errno) ));
1434                 exit(1);
1435         }
1436
1437         background_lpq_updater_pid = sys_fork();
1438
1439         if (background_lpq_updater_pid == -1) {
1440                 DEBUG(5,("start_background_queue: background LPQ thread failed to start. %s\n", strerror(errno) ));
1441                 exit(1);
1442         }
1443
1444         /* Track the printing pid along with other smbd children */
1445         add_child_pid(background_lpq_updater_pid);
1446
1447         if(background_lpq_updater_pid == 0) {
1448                 struct tevent_fd *fde;
1449                 int ret;
1450
1451                 /* Child. */
1452                 DEBUG(5,("start_background_queue: background LPQ thread started\n"));
1453
1454                 close(pause_pipe[0]);
1455                 pause_pipe[0] = -1;
1456
1457                 if (!NT_STATUS_IS_OK(reinit_after_fork(smbd_messaging_context(),
1458                                                        smbd_event_context(),
1459                                                        true))) {
1460                         DEBUG(0,("reinit_after_fork() failed\n"));
1461                         smb_panic("reinit_after_fork() failed");
1462                 }
1463
1464                 smbd_setup_sig_term_handler();
1465                 smbd_setup_sig_hup_handler();
1466
1467                 claim_connection( NULL, "smbd lpq backend",
1468                         FLAG_MSG_GENERAL|FLAG_MSG_SMBD|FLAG_MSG_PRINT_GENERAL);
1469
1470                 if (!locking_init()) {
1471                         exit(1);
1472                 }
1473
1474                 messaging_register(smbd_messaging_context(), NULL,
1475                                    MSG_PRINTER_UPDATE, print_queue_receive);
1476
1477                 fde = tevent_add_fd(smbd_event_context(), smbd_event_context(),
1478                                     pause_pipe[1], TEVENT_FD_READ,
1479                                     printing_pause_fd_handler,
1480                                     NULL);
1481                 if (!fde) {
1482                         DEBUG(0,("tevent_add_fd() failed for pause_pipe\n"));
1483                         smb_panic("tevent_add_fd() failed for pause_pipe");
1484                 }
1485
1486                 DEBUG(5,("start_background_queue: background LPQ thread waiting for messages\n"));
1487                 ret = tevent_loop_wait(smbd_event_context());
1488                 /* should not be reached */
1489                 DEBUG(0,("background_queue: tevent_loop_wait() exited with %d - %s\n",
1490                          ret, (ret == 0) ? "out of events" : strerror(errno)));
1491                 exit(1);
1492         }
1493
1494         close(pause_pipe[1]);
1495 }
1496
1497 /****************************************************************************
1498 update the internal database from the system print queue for a queue
1499 ****************************************************************************/
1500
1501 static void print_queue_update(int snum, bool force)
1502 {
1503         fstring key;
1504         fstring sharename;
1505         char *lpqcommand = NULL;
1506         char *lprmcommand = NULL;
1507         uint8 *buffer = NULL;
1508         size_t len = 0;
1509         size_t newlen;
1510         struct tdb_print_db *pdb;
1511         int type;
1512         struct printif *current_printif;
1513         TALLOC_CTX *ctx = talloc_tos();
1514
1515         fstrcpy( sharename, lp_const_servicename(snum));
1516
1517         /* don't strip out characters like '$' from the printername */
1518
1519         lpqcommand = talloc_string_sub2(ctx,
1520                         lp_lpqcommand(snum),
1521                         "%p",
1522                         PRINTERNAME(snum),
1523                         false, false, false);
1524         if (!lpqcommand) {
1525                 return;
1526         }
1527         lpqcommand = talloc_sub_advanced(ctx,
1528                         lp_servicename(snum),
1529                         current_user_info.unix_name,
1530                         "",
1531                         current_user.ut.gid,
1532                         get_current_username(),
1533                         current_user_info.domain,
1534                         lpqcommand);
1535         if (!lpqcommand) {
1536                 return;
1537         }
1538
1539         lprmcommand = talloc_string_sub2(ctx,
1540                         lp_lprmcommand(snum),
1541                         "%p",
1542                         PRINTERNAME(snum),
1543                         false, false, false);
1544         if (!lprmcommand) {
1545                 return;
1546         }
1547         lprmcommand = talloc_sub_advanced(ctx,
1548                         lp_servicename(snum),
1549                         current_user_info.unix_name,
1550                         "",
1551                         current_user.ut.gid,
1552                         get_current_username(),
1553                         current_user_info.domain,
1554                         lprmcommand);
1555         if (!lprmcommand) {
1556                 return;
1557         }
1558
1559         /*
1560          * Make sure that the background queue process exists.
1561          * Otherwise just do the update ourselves
1562          */
1563
1564         if ( force || background_lpq_updater_pid == -1 ) {
1565                 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename));
1566                 current_printif = get_printer_fns( snum );
1567                 print_queue_update_with_lock( sharename, current_printif, lpqcommand, lprmcommand );
1568
1569                 return;
1570         }
1571
1572         type = lp_printing(snum);
1573
1574         /* get the length */
1575
1576         len = tdb_pack( NULL, 0, "fdPP",
1577                 sharename,
1578                 type,
1579                 lpqcommand,
1580                 lprmcommand );
1581
1582         buffer = SMB_XMALLOC_ARRAY( uint8, len );
1583
1584         /* now pack the buffer */
1585         newlen = tdb_pack( buffer, len, "fdPP",
1586                 sharename,
1587                 type,
1588                 lpqcommand,
1589                 lprmcommand );
1590
1591         SMB_ASSERT( newlen == len );
1592
1593         DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1594                 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1595                 sharename, type, lpqcommand, lprmcommand ));
1596
1597         /* here we set a msg pending record for other smbd processes
1598            to throttle the number of duplicate print_queue_update msgs
1599            sent.  */
1600
1601         pdb = get_print_db_byname(sharename);
1602         if (!pdb) {
1603                 SAFE_FREE(buffer);
1604                 return;
1605         }
1606
1607         snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1608
1609         if ( !tdb_store_uint32( pdb->tdb, key, time(NULL) ) ) {
1610                 /* log a message but continue on */
1611
1612                 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1613                         sharename));
1614         }
1615
1616         release_print_db( pdb );
1617
1618         /* finally send the message */
1619
1620         messaging_send_buf(smbd_messaging_context(),
1621                            pid_to_procid(background_lpq_updater_pid),
1622                            MSG_PRINTER_UPDATE, (uint8 *)buffer, len);
1623
1624         SAFE_FREE( buffer );
1625
1626         return;
1627 }
1628
1629 /****************************************************************************
1630  Create/Update an entry in the print tdb that will allow us to send notify
1631  updates only to interested smbd's.
1632 ****************************************************************************/
1633
1634 bool print_notify_register_pid(int snum)
1635 {
1636         TDB_DATA data;
1637         struct tdb_print_db *pdb = NULL;
1638         TDB_CONTEXT *tdb = NULL;
1639         const char *printername;
1640         uint32 mypid = (uint32)sys_getpid();
1641         bool ret = False;
1642         size_t i;
1643
1644         /* if (snum == -1), then the change notify request was
1645            on a print server handle and we need to register on
1646            all print queus */
1647
1648         if (snum == -1)
1649         {
1650                 int num_services = lp_numservices();
1651                 int idx;
1652
1653                 for ( idx=0; idx<num_services; idx++ ) {
1654                         if (lp_snum_ok(idx) && lp_print_ok(idx) )
1655                                 print_notify_register_pid(idx);
1656                 }
1657
1658                 return True;
1659         }
1660         else /* register for a specific printer */
1661         {
1662                 printername = lp_const_servicename(snum);
1663                 pdb = get_print_db_byname(printername);
1664                 if (!pdb)
1665                         return False;
1666                 tdb = pdb->tdb;
1667         }
1668
1669         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1670                 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1671                                         printername));
1672                 if (pdb)
1673                         release_print_db(pdb);
1674                 return False;
1675         }
1676
1677         data = get_printer_notify_pid_list( tdb, printername, True );
1678
1679         /* Add ourselves and increase the refcount. */
1680
1681         for (i = 0; i < data.dsize; i += 8) {
1682                 if (IVAL(data.dptr,i) == mypid) {
1683                         uint32 new_refcount = IVAL(data.dptr, i+4) + 1;
1684                         SIVAL(data.dptr, i+4, new_refcount);
1685                         break;
1686                 }
1687         }
1688
1689         if (i == data.dsize) {
1690                 /* We weren't in the list. Realloc. */
1691                 data.dptr = (uint8 *)SMB_REALLOC(data.dptr, data.dsize + 8);
1692                 if (!data.dptr) {
1693                         DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1694                                                 printername));
1695                         goto done;
1696                 }
1697                 data.dsize += 8;
1698                 SIVAL(data.dptr,data.dsize - 8,mypid);
1699                 SIVAL(data.dptr,data.dsize - 4,1); /* Refcount. */
1700         }
1701
1702         /* Store back the record. */
1703         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1704                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1705 list for printer %s\n", printername));
1706                 goto done;
1707         }
1708
1709         ret = True;
1710
1711  done:
1712
1713         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1714         if (pdb)
1715                 release_print_db(pdb);
1716         SAFE_FREE(data.dptr);
1717         return ret;
1718 }
1719
1720 /****************************************************************************
1721  Update an entry in the print tdb that will allow us to send notify
1722  updates only to interested smbd's.
1723 ****************************************************************************/
1724
1725 bool print_notify_deregister_pid(int snum)
1726 {
1727         TDB_DATA data;
1728         struct tdb_print_db *pdb = NULL;
1729         TDB_CONTEXT *tdb = NULL;
1730         const char *printername;
1731         uint32 mypid = (uint32)sys_getpid();
1732         size_t i;
1733         bool ret = False;
1734
1735         /* if ( snum == -1 ), we are deregister a print server handle
1736            which means to deregister on all print queues */
1737
1738         if (snum == -1)
1739         {
1740                 int num_services = lp_numservices();
1741                 int idx;
1742
1743                 for ( idx=0; idx<num_services; idx++ ) {
1744                         if ( lp_snum_ok(idx) && lp_print_ok(idx) )
1745                                 print_notify_deregister_pid(idx);
1746                 }
1747
1748                 return True;
1749         }
1750         else /* deregister a specific printer */
1751         {
1752                 printername = lp_const_servicename(snum);
1753                 pdb = get_print_db_byname(printername);
1754                 if (!pdb)
1755                         return False;
1756                 tdb = pdb->tdb;
1757         }
1758
1759         if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1760                 DEBUG(0,("print_notify_register_pid: Failed to lock \
1761 printer %s database\n", printername));
1762                 if (pdb)
1763                         release_print_db(pdb);
1764                 return False;
1765         }
1766
1767         data = get_printer_notify_pid_list( tdb, printername, True );
1768
1769         /* Reduce refcount. Remove ourselves if zero. */
1770
1771         for (i = 0; i < data.dsize; ) {
1772                 if (IVAL(data.dptr,i) == mypid) {
1773                         uint32 refcount = IVAL(data.dptr, i+4);
1774
1775                         refcount--;
1776
1777                         if (refcount == 0) {
1778                                 if (data.dsize - i > 8)
1779                                         memmove( &data.dptr[i], &data.dptr[i+8], data.dsize - i - 8);
1780                                 data.dsize -= 8;
1781                                 continue;
1782                         }
1783                         SIVAL(data.dptr, i+4, refcount);
1784                 }
1785
1786                 i += 8;
1787         }
1788
1789         if (data.dsize == 0)
1790                 SAFE_FREE(data.dptr);
1791
1792         /* Store back the record. */
1793         if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1794                 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1795 list for printer %s\n", printername));
1796                 goto done;
1797         }
1798
1799         ret = True;
1800
1801   done:
1802
1803         tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1804         if (pdb)
1805                 release_print_db(pdb);
1806         SAFE_FREE(data.dptr);
1807         return ret;
1808 }
1809
1810 /****************************************************************************
1811  Check if a jobid is valid. It is valid if it exists in the database.
1812 ****************************************************************************/
1813
1814 bool print_job_exists(const char* sharename, uint32 jobid)
1815 {
1816         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1817         bool ret;
1818         uint32_t tmp;
1819
1820         if (!pdb)
1821                 return False;
1822         ret = tdb_exists(pdb->tdb, print_key(jobid, &tmp));
1823         release_print_db(pdb);
1824         return ret;
1825 }
1826
1827 /****************************************************************************
1828  Give the fd used for a jobid.
1829 ****************************************************************************/
1830
1831 int print_job_fd(const char* sharename, uint32 jobid)
1832 {
1833         struct printjob *pjob = print_job_find(sharename, jobid);
1834         if (!pjob)
1835                 return -1;
1836         /* don't allow another process to get this info - it is meaningless */
1837         if (pjob->pid != sys_getpid())
1838                 return -1;
1839         return pjob->fd;
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 char *print_job_fname(const char* sharename, uint32 jobid)
1849 {
1850         struct printjob *pjob = print_job_find(sharename, jobid);
1851         if (!pjob || pjob->spooled || pjob->pid != sys_getpid())
1852                 return NULL;
1853         return pjob->filename;
1854 }
1855
1856
1857 /****************************************************************************
1858  Give the filename used for a jobid.
1859  Only valid for the process doing the spooling and when the job
1860  has not been spooled.
1861 ****************************************************************************/
1862
1863 NT_DEVICEMODE *print_job_devmode(const char* sharename, uint32 jobid)
1864 {
1865         struct printjob *pjob = print_job_find(sharename, jobid);
1866
1867         if ( !pjob )
1868                 return NULL;
1869
1870         return pjob->nt_devmode;
1871 }
1872
1873 /****************************************************************************
1874  Set the place in the queue for a job.
1875 ****************************************************************************/
1876
1877 bool print_job_set_place(const char *sharename, uint32 jobid, int place)
1878 {
1879         DEBUG(2,("print_job_set_place not implemented yet\n"));
1880         return False;
1881 }
1882
1883 /****************************************************************************
1884  Set the name of a job. Only possible for owner.
1885 ****************************************************************************/
1886
1887 bool print_job_set_name(const char *sharename, uint32 jobid, char *name)
1888 {
1889         struct printjob *pjob;
1890
1891         pjob = print_job_find(sharename, jobid);
1892         if (!pjob || pjob->pid != sys_getpid())
1893                 return False;
1894
1895         fstrcpy(pjob->jobname, name);
1896         return pjob_store(sharename, jobid, pjob);
1897 }
1898
1899 /***************************************************************************
1900  Remove a jobid from the 'jobs changed' list.
1901 ***************************************************************************/
1902
1903 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid)
1904 {
1905         struct tdb_print_db *pdb = get_print_db_byname(sharename);
1906         TDB_DATA data, key;
1907         size_t job_count, i;
1908         bool ret = False;
1909         bool gotlock = False;
1910
1911         if (!pdb) {
1912                 return False;
1913         }
1914
1915         ZERO_STRUCT(data);
1916
1917         key = string_tdb_data("INFO/jobs_changed");
1918
1919         if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) == -1)
1920                 goto out;
1921
1922         gotlock = True;
1923
1924         data = tdb_fetch(pdb->tdb, key);
1925
1926         if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
1927                 goto out;
1928
1929         job_count = data.dsize / 4;
1930         for (i = 0; i < job_count; i++) {
1931                 uint32 ch_jobid;
1932
1933                 ch_jobid = IVAL(data.dptr, i*4);
1934                 if (ch_jobid == jobid) {
1935                         if (i < job_count -1 )
1936                                 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
1937                         data.dsize -= 4;
1938                         if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) == -1)
1939                                 goto out;
1940                         break;
1941                 }
1942         }
1943
1944         ret = True;
1945   out:
1946
1947         if (gotlock)
1948                 tdb_chainunlock(pdb->tdb, key);
1949         SAFE_FREE(data.dptr);
1950         release_print_db(pdb);
1951         if (ret)
1952                 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid ));
1953         else
1954                 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid ));
1955         return ret;
1956 }
1957
1958 /****************************************************************************
1959  Delete a print job - don't update queue.
1960 ****************************************************************************/
1961
1962 static bool print_job_delete1(int snum, uint32 jobid)
1963 {
1964         const char* sharename = lp_const_servicename(snum);
1965         struct printjob *pjob = print_job_find(sharename, jobid);
1966         int result = 0;
1967         struct printif *current_printif = get_printer_fns( snum );
1968
1969         if (!pjob)
1970                 return False;
1971
1972         /*
1973          * If already deleting just return.
1974          */
1975
1976         if (pjob->status == LPQ_DELETING)
1977                 return True;
1978
1979         /* Hrm - we need to be able to cope with deleting a job before it
1980            has reached the spooler.  Just mark it as LPQ_DELETING and
1981            let the print_queue_update() code rmeove the record */
1982
1983
1984         if (pjob->sysjob == -1) {
1985                 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid));
1986         }
1987
1988         /* Set the tdb entry to be deleting. */
1989
1990         pjob->status = LPQ_DELETING;
1991         pjob_store(sharename, jobid, pjob);
1992
1993         if (pjob->spooled && pjob->sysjob != -1)
1994         {
1995                 result = (*(current_printif->job_delete))(
1996                         PRINTERNAME(snum),
1997                         lp_lprmcommand(snum),
1998                         pjob);
1999
2000                 /* Delete the tdb entry if the delete succeeded or the job hasn't
2001                    been spooled. */
2002
2003                 if (result == 0) {
2004                         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2005                         int njobs = 1;
2006
2007                         if (!pdb)
2008                                 return False;
2009                         pjob_delete(sharename, jobid);
2010                         /* Ensure we keep a rough count of the number of total jobs... */
2011                         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, -1);
2012                         release_print_db(pdb);
2013                 }
2014         }
2015
2016         remove_from_jobs_changed( sharename, jobid );
2017
2018         return (result == 0);
2019 }
2020
2021 /****************************************************************************
2022  Return true if the current user owns the print job.
2023 ****************************************************************************/
2024
2025 static bool is_owner(struct auth_serversupplied_info *server_info,
2026                      const char *servicename,
2027                      uint32 jobid)
2028 {
2029         struct printjob *pjob = print_job_find(servicename, jobid);
2030
2031         if (!pjob || !server_info)
2032                 return False;
2033
2034         return strequal(pjob->user, server_info->sanitized_username);
2035 }
2036
2037 /****************************************************************************
2038  Delete a print job.
2039 ****************************************************************************/
2040
2041 bool print_job_delete(struct auth_serversupplied_info *server_info, int snum,
2042                       uint32 jobid, WERROR *errcode)
2043 {
2044         const char* sharename = lp_const_servicename( snum );
2045         struct printjob *pjob;
2046         bool    owner;
2047         char    *fname;
2048
2049         *errcode = WERR_OK;
2050
2051         owner = is_owner(server_info, lp_const_servicename(snum), jobid);
2052
2053         /* Check access against security descriptor or whether the user
2054            owns their job. */
2055
2056         if (!owner &&
2057             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2058                 DEBUG(3, ("delete denied by security descriptor\n"));
2059                 *errcode = WERR_ACCESS_DENIED;
2060
2061                 /* BEGIN_ADMIN_LOG */
2062                 sys_adminlog( LOG_ERR,
2063                               "Permission denied-- user not allowed to delete, \
2064 pause, or resume print job. User name: %s. Printer name: %s.",
2065                               uidtoname(server_info->utok.uid),
2066                               PRINTERNAME(snum) );
2067                 /* END_ADMIN_LOG */
2068
2069                 return False;
2070         }
2071
2072         /*
2073          * get the spooled filename of the print job
2074          * if this works, then the file has not been spooled
2075          * to the underlying print system.  Just delete the
2076          * spool file & return.
2077          */
2078
2079         if ( (fname = print_job_fname( sharename, jobid )) != NULL )
2080         {
2081                 /* remove the spool file */
2082                 DEBUG(10,("print_job_delete: Removing spool file [%s]\n", fname ));
2083                 if ( unlink( fname ) == -1 ) {
2084                         *errcode = map_werror_from_unix(errno);
2085                         return False;
2086                 }
2087         }
2088
2089         if (!print_job_delete1(snum, jobid)) {
2090                 *errcode = WERR_ACCESS_DENIED;
2091                 return False;
2092         }
2093
2094         /* force update the database and say the delete failed if the
2095            job still exists */
2096
2097         print_queue_update(snum, True);
2098
2099         pjob = print_job_find(sharename, jobid);
2100         if ( pjob && (pjob->status != LPQ_DELETING) )
2101                 *errcode = WERR_ACCESS_DENIED;
2102
2103         return (pjob == NULL );
2104 }
2105
2106 /****************************************************************************
2107  Pause a job.
2108 ****************************************************************************/
2109
2110 bool print_job_pause(struct auth_serversupplied_info *server_info, int snum,
2111                      uint32 jobid, WERROR *errcode)
2112 {
2113         const char* sharename = lp_const_servicename(snum);
2114         struct printjob *pjob;
2115         int ret = -1;
2116         struct printif *current_printif = get_printer_fns( snum );
2117
2118         pjob = print_job_find(sharename, jobid);
2119
2120         if (!pjob || !server_info) {
2121                 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2122                         (unsigned int)jobid ));
2123                 return False;
2124         }
2125
2126         if (!pjob->spooled || pjob->sysjob == -1) {
2127                 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2128                         (int)pjob->sysjob, (unsigned int)jobid ));
2129                 return False;
2130         }
2131
2132         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2133             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2134                 DEBUG(3, ("pause denied by security descriptor\n"));
2135
2136                 /* BEGIN_ADMIN_LOG */
2137                 sys_adminlog( LOG_ERR,
2138                         "Permission denied-- user not allowed to delete, \
2139 pause, or resume print job. User name: %s. Printer name: %s.",
2140                               uidtoname(server_info->utok.uid),
2141                               PRINTERNAME(snum) );
2142                 /* END_ADMIN_LOG */
2143
2144                 *errcode = WERR_ACCESS_DENIED;
2145                 return False;
2146         }
2147
2148         /* need to pause the spooled entry */
2149         ret = (*(current_printif->job_pause))(snum, pjob);
2150
2151         if (ret != 0) {
2152                 *errcode = WERR_INVALID_PARAM;
2153                 return False;
2154         }
2155
2156         /* force update the database */
2157         print_cache_flush(lp_const_servicename(snum));
2158
2159         /* Send a printer notify message */
2160
2161         notify_job_status(sharename, jobid, JOB_STATUS_PAUSED);
2162
2163         /* how do we tell if this succeeded? */
2164
2165         return True;
2166 }
2167
2168 /****************************************************************************
2169  Resume a job.
2170 ****************************************************************************/
2171
2172 bool print_job_resume(struct auth_serversupplied_info *server_info, int snum,
2173                       uint32 jobid, WERROR *errcode)
2174 {
2175         const char *sharename = lp_const_servicename(snum);
2176         struct printjob *pjob;
2177         int ret;
2178         struct printif *current_printif = get_printer_fns( snum );
2179
2180         pjob = print_job_find(sharename, jobid);
2181
2182         if (!pjob || !server_info) {
2183                 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2184                         (unsigned int)jobid ));
2185                 return False;
2186         }
2187
2188         if (!pjob->spooled || pjob->sysjob == -1) {
2189                 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2190                         (int)pjob->sysjob, (unsigned int)jobid ));
2191                 return False;
2192         }
2193
2194         if (!is_owner(server_info, lp_const_servicename(snum), jobid) &&
2195             !print_access_check(server_info, snum, JOB_ACCESS_ADMINISTER)) {
2196                 DEBUG(3, ("resume denied by security descriptor\n"));
2197                 *errcode = WERR_ACCESS_DENIED;
2198
2199                 /* BEGIN_ADMIN_LOG */
2200                 sys_adminlog( LOG_ERR,
2201                          "Permission denied-- user not allowed to delete, \
2202 pause, or resume print job. User name: %s. Printer name: %s.",
2203                               uidtoname(server_info->utok.uid),
2204                               PRINTERNAME(snum) );
2205                 /* END_ADMIN_LOG */
2206                 return False;
2207         }
2208
2209         ret = (*(current_printif->job_resume))(snum, pjob);
2210
2211         if (ret != 0) {
2212                 *errcode = WERR_INVALID_PARAM;
2213                 return False;
2214         }
2215
2216         /* force update the database */
2217         print_cache_flush(lp_const_servicename(snum));
2218
2219         /* Send a printer notify message */
2220
2221         notify_job_status(sharename, jobid, JOB_STATUS_QUEUED);
2222
2223         return True;
2224 }
2225
2226 /****************************************************************************
2227  Write to a print file.
2228 ****************************************************************************/
2229
2230 ssize_t print_job_write(int snum, uint32 jobid, const char *buf, SMB_OFF_T pos, size_t size)
2231 {
2232         const char* sharename = lp_const_servicename(snum);
2233         int return_code;
2234         struct printjob *pjob;
2235
2236         pjob = print_job_find(sharename, jobid);
2237
2238         if (!pjob)
2239                 return -1;
2240         /* don't allow another process to get this info - it is meaningless */
2241         if (pjob->pid != sys_getpid())
2242                 return -1;
2243
2244         return_code = write_data_at_offset(pjob->fd, buf, size, pos);
2245
2246         if (return_code>0) {
2247                 pjob->size += size;
2248                 pjob_store(sharename, jobid, pjob);
2249         }
2250         return return_code;
2251 }
2252
2253 /****************************************************************************
2254  Get the queue status - do not update if db is out of date.
2255 ****************************************************************************/
2256
2257 static int get_queue_status(const char* sharename, print_status_struct *status)
2258 {
2259         fstring keystr;
2260         TDB_DATA data;
2261         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2262         int len;
2263
2264         if (status) {
2265                 ZERO_STRUCTP(status);
2266         }
2267
2268         if (!pdb)
2269                 return 0;
2270
2271         if (status) {
2272                 fstr_sprintf(keystr, "STATUS/%s", sharename);
2273                 data = tdb_fetch(pdb->tdb, string_tdb_data(keystr));
2274                 if (data.dptr) {
2275                         if (data.dsize == sizeof(print_status_struct))
2276                                 /* this memcpy is ok since the status struct was
2277                                    not packed before storing it in the tdb */
2278                                 memcpy(status, data.dptr, sizeof(print_status_struct));
2279                         SAFE_FREE(data.dptr);
2280                 }
2281         }
2282         len = tdb_fetch_int32(pdb->tdb, "INFO/total_jobs");
2283         release_print_db(pdb);
2284         return (len == -1 ? 0 : len);
2285 }
2286
2287 /****************************************************************************
2288  Determine the number of jobs in a queue.
2289 ****************************************************************************/
2290
2291 int print_queue_length(int snum, print_status_struct *pstatus)
2292 {
2293         const char* sharename = lp_const_servicename( snum );
2294         print_status_struct status;
2295         int len;
2296
2297         ZERO_STRUCT( status );
2298
2299         /* make sure the database is up to date */
2300         if (print_cache_expired(lp_const_servicename(snum), True))
2301                 print_queue_update(snum, False);
2302
2303         /* also fetch the queue status */
2304         memset(&status, 0, sizeof(status));
2305         len = get_queue_status(sharename, &status);
2306
2307         if (pstatus)
2308                 *pstatus = status;
2309
2310         return len;
2311 }
2312
2313 /***************************************************************************
2314  Allocate a jobid. Hold the lock for as short a time as possible.
2315 ***************************************************************************/
2316
2317 static bool allocate_print_jobid(struct tdb_print_db *pdb, int snum, const char *sharename, uint32 *pjobid)
2318 {
2319         int i;
2320         uint32 jobid;
2321
2322         *pjobid = (uint32)-1;
2323
2324         for (i = 0; i < 3; i++) {
2325                 /* Lock the database - only wait 20 seconds. */
2326                 if (tdb_lock_bystring_with_timeout(pdb->tdb, "INFO/nextjob", 20) == -1) {
2327                         DEBUG(0,("allocate_print_jobid: failed to lock printing database %s\n", sharename));
2328                         return False;
2329                 }
2330
2331                 if (!tdb_fetch_uint32(pdb->tdb, "INFO/nextjob", &jobid)) {
2332                         if (tdb_error(pdb->tdb) != TDB_ERR_NOEXIST) {
2333                                 DEBUG(0, ("allocate_print_jobid: failed to fetch INFO/nextjob for print queue %s\n",
2334                                         sharename));
2335                                 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2336                                 return False;
2337                         }
2338                         DEBUG(10,("allocate_print_jobid: no existing jobid in %s\n", sharename));
2339                         jobid = 0;
2340                 }
2341
2342                 DEBUG(10,("allocate_print_jobid: read jobid %u from %s\n", jobid, sharename));
2343
2344                 jobid = NEXT_JOBID(jobid);
2345
2346                 if (tdb_store_int32(pdb->tdb, "INFO/nextjob", jobid)==-1) {
2347                         DEBUG(3, ("allocate_print_jobid: failed to store INFO/nextjob.\n"));
2348                         tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2349                         return False;
2350                 }
2351
2352                 /* We've finished with the INFO/nextjob lock. */
2353                 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2354
2355                 if (!print_job_exists(sharename, jobid)) {
2356                         break;
2357                 }
2358                 DEBUG(10,("allocate_print_jobid: found jobid %u in %s\n", jobid, sharename));
2359         }
2360
2361         if (i > 2) {
2362                 DEBUG(0, ("allocate_print_jobid: failed to allocate a print job for queue %s\n",
2363                         sharename));
2364                 /* Probably full... */
2365                 errno = ENOSPC;
2366                 return False;
2367         }
2368
2369         /* Store a dummy placeholder. */
2370         {
2371                 uint32_t tmp;
2372                 TDB_DATA dum;
2373                 dum.dptr = NULL;
2374                 dum.dsize = 0;
2375                 if (tdb_store(pdb->tdb, print_key(jobid, &tmp), dum,
2376                               TDB_INSERT) == -1) {
2377                         DEBUG(3, ("allocate_print_jobid: jobid (%d) failed to store placeholder.\n",
2378                                 jobid ));
2379                         return False;
2380                 }
2381         }
2382
2383         *pjobid = jobid;
2384         return True;
2385 }
2386
2387 /***************************************************************************
2388  Append a jobid to the 'jobs changed' list.
2389 ***************************************************************************/
2390
2391 static bool add_to_jobs_changed(struct tdb_print_db *pdb, uint32 jobid)
2392 {
2393         TDB_DATA data;
2394         uint32 store_jobid;
2395
2396         SIVAL(&store_jobid, 0, jobid);
2397         data.dptr = (uint8 *)&store_jobid;
2398         data.dsize = 4;
2399
2400         DEBUG(10,("add_to_jobs_changed: Added jobid %u\n", (unsigned int)jobid ));
2401
2402         return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_changed"),
2403                            data) == 0);
2404 }
2405
2406 /***************************************************************************
2407  Start spooling a job - return the jobid.
2408 ***************************************************************************/
2409
2410 uint32 print_job_start(struct auth_serversupplied_info *server_info, int snum,
2411                        const char *jobname, NT_DEVICEMODE *nt_devmode )
2412 {
2413         uint32 jobid;
2414         char *path;
2415         struct printjob pjob;
2416         const char *sharename = lp_const_servicename(snum);
2417         struct tdb_print_db *pdb = get_print_db_byname(sharename);
2418         int njobs;
2419
2420         errno = 0;
2421
2422         if (!pdb)
2423                 return (uint32)-1;
2424
2425         if (!print_access_check(server_info, snum, PRINTER_ACCESS_USE)) {
2426                 DEBUG(3, ("print_job_start: job start denied by security descriptor\n"));
2427                 release_print_db(pdb);
2428                 return (uint32)-1;
2429         }
2430
2431         if (!print_time_access_check(lp_servicename(snum))) {
2432                 DEBUG(3, ("print_job_start: job start denied by time check\n"));
2433                 release_print_db(pdb);
2434                 return (uint32)-1;
2435         }
2436
2437         path = lp_pathname(snum);
2438
2439         /* see if we have sufficient disk space */
2440         if (lp_minprintspace(snum)) {
2441                 uint64_t dspace, dsize;
2442                 if (sys_fsusage(path, &dspace, &dsize) == 0 &&
2443                     dspace < 2*(uint64_t)lp_minprintspace(snum)) {
2444                         DEBUG(3, ("print_job_start: disk space check failed.\n"));
2445                         release_print_db(pdb);
2446                         errno = ENOSPC;
2447                         return (uint32)-1;
2448                 }
2449         }
2450
2451         /* for autoloaded printers, check that the printcap entry still exists */
2452         if (lp_autoloaded(snum) && !pcap_printername_ok(lp_const_servicename(snum))) {
2453                 DEBUG(3, ("print_job_start: printer name %s check failed.\n", lp_const_servicename(snum) ));
2454                 release_print_db(pdb);
2455                 errno = ENOENT;
2456                 return (uint32)-1;
2457         }
2458
2459         /* Insure the maximum queue size is not violated */
2460         if ((njobs = print_queue_length(snum,NULL)) > lp_maxprintjobs(snum)) {
2461                 DEBUG(3, ("print_job_start: Queue %s number of jobs (%d) larger than max printjobs per queue (%d).\n",
2462                         sharename, njobs, lp_maxprintjobs(snum) ));
2463                 release_print_db(pdb);
2464                 errno = ENOSPC;
2465                 return (uint32)-1;
2466         }
2467
2468         DEBUG(10,("print_job_start: Queue %s number of jobs (%d), max printjobs = %d\n",
2469                 sharename, njobs, lp_maxprintjobs(snum) ));
2470
2471         if (!allocate_print_jobid(pdb, snum, sharename, &jobid))
2472                 goto fail;
2473
2474         /* create the database entry */
2475
2476         ZERO_STRUCT(pjob);
2477
2478         pjob.pid = sys_getpid();
2479         pjob.sysjob = -1;
2480         pjob.fd = -1;
2481         pjob.starttime = time(NULL);
2482         pjob.status = LPQ_SPOOLING;
2483         pjob.size = 0;
2484         pjob.spooled = False;
2485         pjob.smbjob = True;
2486         pjob.nt_devmode = nt_devmode;
2487
2488         fstrcpy(pjob.jobname, jobname);
2489
2490         fstrcpy(pjob.user, lp_printjob_username(snum));
2491         standard_sub_advanced(sharename, server_info->sanitized_username,
2492                               path, server_info->utok.gid,
2493                               server_info->sanitized_username,
2494                               pdb_get_domain(server_info->sam_account),
2495                               pjob.user, sizeof(pjob.user)-1);
2496         /* ensure NULL termination */
2497         pjob.user[sizeof(pjob.user)-1] = '\0';
2498
2499         fstrcpy(pjob.queuename, lp_const_servicename(snum));
2500
2501         /* we have a job entry - now create the spool file */
2502         slprintf(pjob.filename, sizeof(pjob.filename)-1, "%s/%s%.8u.XXXXXX",
2503                  path, PRINT_SPOOL_PREFIX, (unsigned int)jobid);
2504         pjob.fd = mkstemp(pjob.filename);
2505
2506         if (pjob.fd == -1) {
2507                 if (errno == EACCES) {
2508                         /* Common setup error, force a report. */
2509                         DEBUG(0, ("print_job_start: insufficient permissions \
2510 to open spool file %s.\n", pjob.filename));
2511                 } else {
2512                         /* Normal case, report at level 3 and above. */
2513                         DEBUG(3, ("print_job_start: can't open spool file %s,\n", pjob.filename));
2514                         DEBUGADD(3, ("errno = %d (%s).\n", errno, strerror(errno)));
2515                 }
2516                 goto fail;
2517         }
2518
2519         pjob_store(sharename, jobid, &pjob);
2520
2521         /* Update the 'jobs changed' entry used by print_queue_status. */
2522         add_to_jobs_changed(pdb, jobid);
2523
2524         /* Ensure we keep a rough count of the number of total jobs... */
2525         tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, 1);
2526
2527         release_print_db(pdb);
2528
2529         return jobid;
2530
2531  fail:
2532         if (jobid != -1)
2533                 pjob_delete(sharename, jobid);
2534
2535         release_print_db(pdb);
2536
2537         DEBUG(3, ("print_job_start: returning fail. Error = %s\n", strerror(errno) ));
2538         return (uint32)-1;
2539 }
2540
2541 /****************************************************************************
2542  Update the number of pages spooled to jobid
2543 ****************************************************************************/
2544
2545 void print_job_endpage(int snum, uint32 jobid)
2546 {
2547         const char* sharename = lp_const_servicename(snum);
2548         struct printjob *pjob;
2549
2550         pjob = print_job_find(sharename, jobid);
2551         if (!pjob)
2552                 return;
2553         /* don't allow another process to get this info - it is meaningless */
2554         if (pjob->pid != sys_getpid())
2555                 return;
2556
2557         pjob->page_count++;
2558         pjob_store(sharename, jobid, pjob);
2559 }
2560
2561 /****************************************************************************
2562  Print a file - called on closing the file. This spools the job.
2563  If normal close is false then we're tearing down the jobs - treat as an
2564  error.
2565 ****************************************************************************/
2566
2567 bool print_job_end(int snum, uint32 jobid, enum file_close_type close_type)
2568 {
2569         const char* sharename = lp_const_servicename(snum);
2570         struct printjob *pjob;
2571         int ret;
2572         SMB_STRUCT_STAT sbuf;
2573         struct printif *current_printif = get_printer_fns( snum );
2574
2575         pjob = print_job_find(sharename, jobid);
2576
2577         if (!pjob)
2578                 return False;
2579
2580         if (pjob->spooled || pjob->pid != sys_getpid())
2581                 return False;
2582
2583         if ((close_type == NORMAL_CLOSE || close_type == SHUTDOWN_CLOSE) &&
2584             (sys_fstat(pjob->fd, &sbuf, false) == 0)) {
2585                 pjob->size = sbuf.st_ex_size;
2586                 close(pjob->fd);
2587                 pjob->fd = -1;
2588         } else {
2589
2590                 /*
2591                  * Not a normal close or we couldn't stat the job file,
2592                  * so something has gone wrong. Cleanup.
2593                  */
2594                 close(pjob->fd);
2595                 pjob->fd = -1;
2596                 DEBUG(3,("print_job_end: failed to stat file for jobid %d\n", jobid ));
2597                 goto fail;
2598         }
2599
2600         /* Technically, this is not quite right. If the printer has a separator
2601          * page turned on, the NT spooler prints the separator page even if the
2602          * print job is 0 bytes. 010215 JRR */
2603         if (pjob->size == 0 || pjob->status == LPQ_DELETING) {
2604                 /* don't bother spooling empty files or something being deleted. */
2605                 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
2606                         pjob->filename, pjob->size ? "deleted" : "zero length" ));
2607                 unlink(pjob->filename);
2608                 pjob_delete(sharename, jobid);
2609                 return True;
2610         }
2611
2612         pjob->smbjob = jobid;
2613
2614         ret = (*(current_printif->job_submit))(snum, pjob);
2615
2616         if (ret)
2617                 goto fail;
2618
2619         /* The print job has been successfully handed over to the back-end */
2620
2621         pjob->spooled = True;
2622         pjob->status = LPQ_QUEUED;
2623         pjob_store(sharename, jobid, pjob);
2624
2625         /* make sure the database is up to date */
2626         if (print_cache_expired(lp_const_servicename(snum), True))
2627                 print_queue_update(snum, False);
2628
2629         return True;
2630
2631 fail:
2632
2633         /* The print job was not successfully started. Cleanup */
2634         /* Still need to add proper error return propagation! 010122:JRR */
2635         unlink(pjob->filename);
2636         pjob_delete(sharename, jobid);
2637         return False;
2638 }
2639
2640 /****************************************************************************
2641  Get a snapshot of jobs in the system without traversing.
2642 ****************************************************************************/
2643
2644 static bool get_stored_queue_info(struct tdb_print_db *pdb, int snum, int *pcount, print_queue_struct **ppqueue)
2645 {
2646         TDB_DATA data, cgdata;
2647         print_queue_struct *queue = NULL;
2648         uint32 qcount = 0;
2649         uint32 extra_count = 0;
2650         int total_count = 0;
2651         size_t len = 0;
2652         uint32 i;
2653         int max_reported_jobs = lp_max_reported_jobs(snum);
2654         bool ret = False;
2655         const char* sharename = lp_servicename(snum);
2656
2657         /* make sure the database is up to date */
2658         if (print_cache_expired(lp_const_servicename(snum), True))
2659                 print_queue_update(snum, False);
2660
2661         *pcount = 0;
2662         *ppqueue = NULL;
2663
2664         ZERO_STRUCT(data);
2665         ZERO_STRUCT(cgdata);
2666
2667         /* Get the stored queue data. */
2668         data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/linear_queue_array"));
2669
2670         if (data.dptr && data.dsize >= sizeof(qcount))
2671                 len += tdb_unpack(data.dptr + len, data.dsize - len, "d", &qcount);
2672
2673         /* Get the changed jobs list. */
2674         cgdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
2675         if (cgdata.dptr != NULL && (cgdata.dsize % 4 == 0))
2676                 extra_count = cgdata.dsize/4;
2677
2678         DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount, (unsigned int)extra_count));
2679
2680         /* Allocate the queue size. */
2681         if (qcount == 0 && extra_count == 0)
2682                 goto out;
2683
2684         if ((queue = SMB_MALLOC_ARRAY(print_queue_struct, qcount + extra_count)) == NULL)
2685                 goto out;
2686
2687         /* Retrieve the linearised queue data. */
2688
2689         for( i  = 0; i < qcount; i++) {
2690                 uint32 qjob, qsize, qpage_count, qstatus, qpriority, qtime;
2691                 len += tdb_unpack(data.dptr + len, data.dsize - len, "ddddddff",
2692                                 &qjob,
2693                                 &qsize,
2694                                 &qpage_count,
2695                                 &qstatus,
2696                                 &qpriority,
2697                                 &qtime,
2698                                 queue[i].fs_user,
2699                                 queue[i].fs_file);
2700                 queue[i].job = qjob;
2701                 queue[i].size = qsize;
2702                 queue[i].page_count = qpage_count;
2703                 queue[i].status = qstatus;
2704                 queue[i].priority = qpriority;
2705                 queue[i].time = qtime;
2706         }
2707
2708         total_count = qcount;
2709
2710         /* Add in the changed jobids. */
2711         for( i  = 0; i < extra_count; i++) {
2712                 uint32 jobid;
2713                 struct printjob *pjob;
2714
2715                 jobid = IVAL(cgdata.dptr, i*4);
2716                 DEBUG(5,("get_stored_queue_info: changed job = %u\n", (unsigned int)jobid));
2717                 pjob = print_job_find(lp_const_servicename(snum), jobid);
2718                 if (!pjob) {
2719                         DEBUG(5,("get_stored_queue_info: failed to find changed job = %u\n", (unsigned int)jobid));
2720                         remove_from_jobs_changed(sharename, jobid);
2721                         continue;
2722                 }
2723
2724                 queue[total_count].job = jobid;
2725                 queue[total_count].size = pjob->size;
2726                 queue[total_count].page_count = pjob->page_count;
2727                 queue[total_count].status = pjob->status;
2728                 queue[total_count].priority = 1;
2729                 queue[total_count].time = pjob->starttime;
2730                 fstrcpy(queue[total_count].fs_user, pjob->user);
2731                 fstrcpy(queue[total_count].fs_file, pjob->jobname);
2732                 total_count++;
2733         }
2734
2735         /* Sort the queue by submission time otherwise they are displayed
2736            in hash order. */
2737
2738         TYPESAFE_QSORT(queue, total_count, printjob_comp);
2739
2740         DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count));
2741
2742         if (max_reported_jobs && total_count > max_reported_jobs)
2743                 total_count = max_reported_jobs;
2744
2745         *ppqueue = queue;
2746         *pcount = total_count;
2747
2748         ret = True;
2749
2750   out:
2751
2752         SAFE_FREE(data.dptr);
2753         SAFE_FREE(cgdata.dptr);
2754         return ret;
2755 }
2756
2757 /****************************************************************************
2758  Get a printer queue listing.
2759  set queue = NULL and status = NULL if you just want to update the cache
2760 ****************************************************************************/
2761
2762 int print_queue_status(int snum,
2763                        print_queue_struct **ppqueue,
2764                        print_status_struct *status)
2765 {
2766         fstring keystr;
2767         TDB_DATA data, key;
2768         const char *sharename;
2769         struct tdb_print_db *pdb;
2770         int count = 0;
2771
2772         /* make sure the database is up to date */
2773
2774         if (print_cache_expired(lp_const_servicename(snum), True))
2775                 print_queue_update(snum, False);
2776
2777         /* return if we are done */
2778         if ( !ppqueue || !status )
2779                 return 0;
2780
2781         *ppqueue = NULL;
2782         sharename = lp_const_servicename(snum);
2783         pdb = get_print_db_byname(sharename);
2784
2785         if (!pdb)
2786                 return 0;
2787
2788         /*
2789          * Fetch the queue status.  We must do this first, as there may
2790          * be no jobs in the queue.
2791          */
2792
2793         ZERO_STRUCTP(status);
2794         slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
2795         key = string_tdb_data(keystr);
2796
2797         data = tdb_fetch(pdb->tdb, key);
2798         if (data.dptr) {
2799                 if (data.dsize == sizeof(*status)) {
2800                         /* this memcpy is ok since the status struct was
2801                            not packed before storing it in the tdb */
2802                         memcpy(status, data.dptr, sizeof(*status));
2803                 }
2804                 SAFE_FREE(data.dptr);
2805         }
2806
2807         /*
2808          * Now, fetch the print queue information.  We first count the number
2809          * of entries, and then only retrieve the queue if necessary.
2810          */
2811
2812         if (!get_stored_queue_info(pdb, snum, &count, ppqueue)) {
2813                 release_print_db(pdb);
2814                 return 0;
2815         }
2816
2817         release_print_db(pdb);
2818         return count;
2819 }
2820
2821 /****************************************************************************
2822  Pause a queue.
2823 ****************************************************************************/
2824
2825 WERROR print_queue_pause(struct auth_serversupplied_info *server_info, int snum)
2826 {
2827         int ret;
2828         struct printif *current_printif = get_printer_fns( snum );
2829
2830         if (!print_access_check(server_info, snum,
2831                                 PRINTER_ACCESS_ADMINISTER)) {
2832                 return WERR_ACCESS_DENIED;
2833         }
2834
2835
2836         become_root();
2837
2838         ret = (*(current_printif->queue_pause))(snum);
2839
2840         unbecome_root();
2841
2842         if (ret != 0) {
2843                 return WERR_INVALID_PARAM;
2844         }
2845
2846         /* force update the database */
2847         print_cache_flush(lp_const_servicename(snum));
2848
2849         /* Send a printer notify message */
2850
2851         notify_printer_status(snum, PRINTER_STATUS_PAUSED);
2852
2853         return WERR_OK;
2854 }
2855
2856 /****************************************************************************
2857  Resume a queue.
2858 ****************************************************************************/
2859
2860 WERROR print_queue_resume(struct auth_serversupplied_info *server_info, int snum)
2861 {
2862         int ret;
2863         struct printif *current_printif = get_printer_fns( snum );
2864
2865         if (!print_access_check(server_info, snum,
2866                                 PRINTER_ACCESS_ADMINISTER)) {
2867                 return WERR_ACCESS_DENIED;
2868         }
2869
2870         become_root();
2871
2872         ret = (*(current_printif->queue_resume))(snum);
2873
2874         unbecome_root();
2875
2876         if (ret != 0) {
2877                 return WERR_INVALID_PARAM;
2878         }
2879
2880         /* make sure the database is up to date */
2881         if (print_cache_expired(lp_const_servicename(snum), True))
2882                 print_queue_update(snum, True);
2883
2884         /* Send a printer notify message */
2885
2886         notify_printer_status(snum, PRINTER_STATUS_OK);
2887
2888         return WERR_OK;
2889 }
2890
2891 /****************************************************************************
2892  Purge a queue - implemented by deleting all jobs that we can delete.
2893 ****************************************************************************/
2894
2895 WERROR print_queue_purge(struct auth_serversupplied_info *server_info, int snum)
2896 {
2897         print_queue_struct *queue;
2898         print_status_struct status;
2899         int njobs, i;
2900         bool can_job_admin;
2901
2902         /* Force and update so the count is accurate (i.e. not a cached count) */
2903         print_queue_update(snum, True);
2904
2905         can_job_admin = print_access_check(server_info, snum,
2906                                            JOB_ACCESS_ADMINISTER);
2907         njobs = print_queue_status(snum, &queue, &status);
2908
2909         if ( can_job_admin )
2910                 become_root();
2911
2912         for (i=0;i<njobs;i++) {
2913                 bool owner = is_owner(server_info, lp_const_servicename(snum),
2914                                       queue[i].job);
2915
2916                 if (owner || can_job_admin) {
2917                         print_job_delete1(snum, queue[i].job);
2918                 }
2919         }
2920
2921         if ( can_job_admin )
2922                 unbecome_root();
2923
2924         /* update the cache */
2925         print_queue_update( snum, True );
2926
2927         SAFE_FREE(queue);
2928
2929         return WERR_OK;
2930 }