s3:smbd: close the low level fd of the base_fsp, if the file was created
[Samba.git] / source / printing / printing.c
blobaf89852fb95d3d6c41078c39fcc6eff37ddbe225
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
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.
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.
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/>.
22 #include "includes.h"
23 #include "printing.h"
25 extern SIG_ATOMIC_T got_sig_term;
26 extern SIG_ATOMIC_T reload_after_sighup;
27 extern struct current_user current_user;
28 extern userdom_struct current_user_info;
30 /* Current printer interface */
31 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid);
33 /*
34 the printing backend revolves around a tdb database that stores the
35 SMB view of the print queue
37 The key for this database is a jobid - a internally generated number that
38 uniquely identifies a print job
40 reading the print queue involves two steps:
41 - possibly running lpq and updating the internal database from that
42 - reading entries from the database
44 jobids are assigned when a job starts spooling.
47 static TDB_CONTEXT *rap_tdb;
48 static uint16 next_rap_jobid;
49 struct rap_jobid_key {
50 fstring sharename;
51 uint32 jobid;
54 /***************************************************************************
55 Nightmare. LANMAN jobid's are 16 bit numbers..... We must map them to 32
56 bit RPC jobids.... JRA.
57 ***************************************************************************/
59 uint16 pjobid_to_rap(const char* sharename, uint32 jobid)
61 uint16 rap_jobid;
62 TDB_DATA data, key;
63 struct rap_jobid_key jinfo;
64 uint8 buf[2];
66 DEBUG(10,("pjobid_to_rap: called.\n"));
68 if (!rap_tdb) {
69 /* Create the in-memory tdb. */
70 rap_tdb = tdb_open_log(NULL, 0, TDB_INTERNAL, (O_RDWR|O_CREAT), 0644);
71 if (!rap_tdb)
72 return 0;
75 ZERO_STRUCT( jinfo );
76 fstrcpy( jinfo.sharename, sharename );
77 jinfo.jobid = jobid;
78 key.dptr = (uint8 *)&jinfo;
79 key.dsize = sizeof(jinfo);
81 data = tdb_fetch(rap_tdb, key);
82 if (data.dptr && data.dsize == sizeof(uint16)) {
83 rap_jobid = SVAL(data.dptr, 0);
84 SAFE_FREE(data.dptr);
85 DEBUG(10,("pjobid_to_rap: jobid %u maps to RAP jobid %u\n",
86 (unsigned int)jobid, (unsigned int)rap_jobid));
87 return rap_jobid;
89 SAFE_FREE(data.dptr);
90 /* Not found - create and store mapping. */
91 rap_jobid = ++next_rap_jobid;
92 if (rap_jobid == 0)
93 rap_jobid = ++next_rap_jobid;
94 SSVAL(buf,0,rap_jobid);
95 data.dptr = buf;
96 data.dsize = sizeof(rap_jobid);
97 tdb_store(rap_tdb, key, data, TDB_REPLACE);
98 tdb_store(rap_tdb, data, key, TDB_REPLACE);
100 DEBUG(10,("pjobid_to_rap: created jobid %u maps to RAP jobid %u\n",
101 (unsigned int)jobid, (unsigned int)rap_jobid));
102 return rap_jobid;
105 bool rap_to_pjobid(uint16 rap_jobid, fstring sharename, uint32 *pjobid)
107 TDB_DATA data, key;
108 uint8 buf[2];
110 DEBUG(10,("rap_to_pjobid called.\n"));
112 if (!rap_tdb)
113 return False;
115 SSVAL(buf,0,rap_jobid);
116 key.dptr = buf;
117 key.dsize = sizeof(rap_jobid);
118 data = tdb_fetch(rap_tdb, key);
119 if ( data.dptr && data.dsize == sizeof(struct rap_jobid_key) )
121 struct rap_jobid_key *jinfo = (struct rap_jobid_key*)data.dptr;
122 fstrcpy( sharename, jinfo->sharename );
123 *pjobid = jinfo->jobid;
124 DEBUG(10,("rap_to_pjobid: jobid %u maps to RAP jobid %u\n",
125 (unsigned int)*pjobid, (unsigned int)rap_jobid));
126 SAFE_FREE(data.dptr);
127 return True;
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;
136 static void rap_jobid_delete(const char* sharename, uint32 jobid)
138 TDB_DATA key, data;
139 uint16 rap_jobid;
140 struct rap_jobid_key jinfo;
141 uint8 buf[2];
143 DEBUG(10,("rap_jobid_delete: called.\n"));
145 if (!rap_tdb)
146 return;
148 ZERO_STRUCT( jinfo );
149 fstrcpy( jinfo.sharename, sharename );
150 jinfo.jobid = jobid;
151 key.dptr = (uint8 *)&jinfo;
152 key.dsize = sizeof(jinfo);
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;
162 DEBUG(10,("rap_jobid_delete: deleting jobid %u\n",
163 (unsigned int)jobid ));
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);
174 static int get_queue_status(const char* sharename, print_status_struct *);
176 /****************************************************************************
177 Initialise the printing backend. Called once at startup before the fork().
178 ****************************************************************************/
180 bool print_backend_init(struct messaging_context *msg_ctx)
182 const char *sversion = "INFO/version";
183 int services = lp_numservices();
184 int snum;
186 unlink(lock_path("printing.tdb"));
187 mkdir(lock_path("printing"),0755);
189 /* handle a Samba upgrade */
191 for (snum = 0; snum < services; snum++) {
192 struct tdb_print_db *pdb;
193 if (!lp_print_ok(snum))
194 continue;
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;
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);
208 tdb_unlock_bystring(pdb->tdb, sversion);
209 release_print_db(pdb);
212 close_all_print_db(); /* Don't leave any open. */
214 /* do NT print initialization... */
215 return nt_printing_init(msg_ctx);
218 /****************************************************************************
219 Shut down printing backend. Called once at shutdown to close the tdb.
220 ****************************************************************************/
222 void printing_end(void)
224 close_all_print_db(); /* Don't leave any open. */
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.
232 Use the generic interface as the default and only use cups interface only
233 when asked for (and only when supported)
234 ****************************************************************************/
236 static struct printif *get_printer_fns_from_type( enum printing_types type )
238 struct printif *printer_fns = &generic_printif;
240 #ifdef HAVE_CUPS
241 if ( type == PRINT_CUPS ) {
242 printer_fns = &cups_printif;
244 #endif /* HAVE_CUPS */
246 #ifdef HAVE_IPRINT
247 if ( type == PRINT_IPRINT ) {
248 printer_fns = &iprint_printif;
250 #endif /* HAVE_IPRINT */
252 printer_fns->type = type;
254 return printer_fns;
257 static struct printif *get_printer_fns( int snum )
259 return get_printer_fns_from_type( (enum printing_types)lp_printing(snum) );
263 /****************************************************************************
264 Useful function to generate a tdb key.
265 ****************************************************************************/
267 static TDB_DATA print_key(uint32 jobid, uint32 *tmp)
269 TDB_DATA ret;
271 SIVAL(tmp, 0, jobid);
272 ret.dptr = (uint8 *)tmp;
273 ret.dsize = sizeof(*tmp);
274 return ret;
277 /***********************************************************************
278 unpack a pjob from a tdb buffer
279 ***********************************************************************/
281 int unpack_pjob( uint8 *buf, int buflen, struct printjob *pjob )
283 int len = 0;
284 int used;
285 uint32 pjpid, pjsysjob, pjfd, pjstarttime, pjstatus;
286 uint32 pjsize, pjpage_count, pjspooled, pjsmbjob;
288 if ( !buf || !pjob )
289 return -1;
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);
306 if ( len == -1 )
307 return -1;
309 if ( (used = unpack_devicemode(&pjob->nt_devmode, buf+len, buflen-len)) == -1 )
310 return -1;
312 len += used;
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;
324 return len;
328 /****************************************************************************
329 Useful function to find a print job in the database.
330 ****************************************************************************/
332 static struct printjob *print_job_find(const char *sharename, uint32 jobid)
334 static struct printjob pjob;
335 uint32_t tmp;
336 TDB_DATA ret;
337 struct tdb_print_db *pdb = get_print_db_byname(sharename);
339 DEBUG(10,("print_job_find: looking up job %u for share %s\n",
340 (unsigned int)jobid, sharename ));
342 if (!pdb) {
343 return NULL;
346 ret = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
347 release_print_db(pdb);
349 if (!ret.dptr) {
350 DEBUG(10,("print_job_find: failed to find jobid %u.\n", (unsigned int)jobid ));
351 return NULL;
354 if ( pjob.nt_devmode ) {
355 free_nt_devicemode( &pjob.nt_devmode );
358 ZERO_STRUCT( pjob );
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;
366 SAFE_FREE(ret.dptr);
368 DEBUG(10,("print_job_find: returning system job %d for jobid %u.\n",
369 (int)pjob.sysjob, (unsigned int)jobid ));
371 return &pjob;
374 /* Convert a unix jobid to a smb jobid */
376 struct unixjob_traverse_state {
377 int sysjob;
378 uint32 sysjob_to_jobid_value;
381 static int unixjob_traverse_fn(TDB_CONTEXT *the_tdb, TDB_DATA key,
382 TDB_DATA data, void *private_data)
384 struct printjob *pjob;
385 struct unixjob_traverse_state *state =
386 (struct unixjob_traverse_state *)private_data;
388 if (!data.dptr || data.dsize == 0)
389 return 0;
391 pjob = (struct printjob *)data.dptr;
392 if (key.dsize != sizeof(uint32))
393 return 0;
395 if (state->sysjob == pjob->sysjob) {
396 uint32 jobid = IVAL(key.dptr,0);
398 state->sysjob_to_jobid_value = jobid;
399 return 1;
402 return 0;
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 ****************************************************************************/
410 uint32 sysjob_to_jobid(int unix_jobid)
412 int services = lp_numservices();
413 int snum;
414 struct unixjob_traverse_state state;
416 state.sysjob = unix_jobid;
417 state.sysjob_to_jobid_value = (uint32)-1;
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;
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;
432 return (uint32)-1;
435 /****************************************************************************
436 Send notifications based on what has changed after a pjob_store.
437 ****************************************************************************/
439 static const struct {
440 uint32 lpq_status;
441 uint32 spoolss_status;
442 } lpq_to_spoolss_status_map[] = {
443 { LPQ_QUEUED, JOB_STATUS_QUEUED },
444 { LPQ_PAUSED, JOB_STATUS_PAUSED },
445 { LPQ_SPOOLING, JOB_STATUS_SPOOLING },
446 { LPQ_PRINTING, JOB_STATUS_PRINTING },
447 { LPQ_DELETING, JOB_STATUS_DELETING },
448 { LPQ_OFFLINE, JOB_STATUS_OFFLINE },
449 { LPQ_PAPEROUT, JOB_STATUS_PAPEROUT },
450 { LPQ_PRINTED, JOB_STATUS_PRINTED },
451 { LPQ_DELETED, JOB_STATUS_DELETED },
452 { LPQ_BLOCKED, JOB_STATUS_BLOCKED },
453 { LPQ_USER_INTERVENTION, JOB_STATUS_USER_INTERVENTION },
454 { -1, 0 }
457 /* Convert a lpq status value stored in printing.tdb into the
458 appropriate win32 API constant. */
460 static uint32 map_to_spoolss_status(uint32 lpq_status)
462 int i = 0;
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++;
470 return 0;
473 static void pjob_store_notify(const char* sharename, uint32 jobid, struct printjob *old_data,
474 struct printjob *new_data)
476 bool new_job = False;
478 if (!old_data)
479 new_job = True;
481 /* Job attributes that can't be changed. We only send
482 notification for these on a new job. */
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) */
491 if (new_job) {
492 notify_job_submitted(sharename, jobid, new_data->starttime);
493 notify_job_username(sharename, jobid, new_data->user);
496 if (new_job || !strequal(old_data->jobname, new_data->jobname))
497 notify_job_name(sharename, jobid, new_data->jobname);
499 /* Job attributes of a new job or attributes that can be
500 modified. */
502 if (new_job || !strequal(old_data->jobname, new_data->jobname))
503 notify_job_name(sharename, jobid, new_data->jobname);
505 if (new_job || old_data->status != new_data->status)
506 notify_job_status(sharename, jobid, map_to_spoolss_status(new_data->status));
508 if (new_job || old_data->size != new_data->size)
509 notify_job_total_bytes(sharename, jobid, new_data->size);
511 if (new_job || old_data->page_count != new_data->page_count)
512 notify_job_total_pages(sharename, jobid, new_data->page_count);
515 /****************************************************************************
516 Store a job structure back to the database.
517 ****************************************************************************/
519 static bool pjob_store(const char* sharename, uint32 jobid, struct printjob *pjob)
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;
529 if (!pdb)
530 return False;
532 /* Get old data */
534 old_data = tdb_fetch(pdb->tdb, print_key(jobid, &tmp));
536 /* Doh! Now we have to pack/unpack data since the NT_DEVICEMODE was added */
538 newlen = 0;
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);
558 len += pack_devicemode(pjob->nt_devmode, buf+len, buflen-len);
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;
566 newlen = len;
568 } while ( buflen != len );
571 /* Store new data */
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);
578 release_print_db(pdb);
580 /* Send notify updates for what has changed */
582 if ( ret ) {
583 struct printjob old_pjob;
585 if ( old_data.dsize )
587 if ( unpack_pjob( old_data.dptr, old_data.dsize, &old_pjob ) != -1 )
589 pjob_store_notify( sharename, jobid, &old_pjob , pjob );
590 free_nt_devicemode( &old_pjob.nt_devmode );
593 else {
594 /* new job */
595 pjob_store_notify( sharename, jobid, NULL, pjob );
599 done:
600 SAFE_FREE( old_data.dptr );
601 SAFE_FREE( buf );
603 return ret;
606 /****************************************************************************
607 Remove a job structure from the database.
608 ****************************************************************************/
610 void pjob_delete(const char* sharename, uint32 jobid)
612 uint32_t tmp;
613 struct printjob *pjob;
614 uint32 job_status = 0;
615 struct tdb_print_db *pdb;
617 pdb = get_print_db_byname( sharename );
619 if (!pdb)
620 return;
622 pjob = print_job_find( sharename, jobid );
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;
631 /* We must cycle through JOB_STATUS_DELETING and
632 JOB_STATUS_DELETED for the port monitor to delete the job
633 properly. */
635 job_status = JOB_STATUS_DELETING|JOB_STATUS_DELETED;
636 notify_job_status(sharename, jobid, job_status);
638 /* Remove from printing.tdb */
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);
646 /****************************************************************************
647 Parse a file name from the system spooler to generate a jobid.
648 ****************************************************************************/
650 static uint32 print_parse_jobid(char *fname)
652 int jobid;
654 if (strncmp(fname,PRINT_SPOOL_PREFIX,strlen(PRINT_SPOOL_PREFIX)) != 0)
655 return (uint32)-1;
656 fname += strlen(PRINT_SPOOL_PREFIX);
658 jobid = atoi(fname);
659 if (jobid <= 0)
660 return (uint32)-1;
662 return (uint32)jobid;
665 /****************************************************************************
666 List a unix job in the print database.
667 ****************************************************************************/
669 static void print_unix_job(const char *sharename, print_queue_struct *q, uint32 jobid)
671 struct printjob pj, *old_pj;
673 if (jobid == (uint32)-1)
674 jobid = q->job + UNIX_JOB_START;
676 /* Preserve the timestamp on an existing unix print job */
678 old_pj = print_job_find(sharename, jobid);
680 ZERO_STRUCT(pj);
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);
697 fstrcpy(pj.user, old_pj ? old_pj->user : q->fs_user);
698 fstrcpy(pj.queuename, old_pj ? old_pj->queuename : sharename );
700 pjob_store(sharename, jobid, &pj);
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;
713 /****************************************************************************
714 Utility fn to delete any jobs that are no longer active.
715 ****************************************************************************/
717 static int traverse_fn_delete(TDB_CONTEXT *t, TDB_DATA key, TDB_DATA data, void *state)
719 struct traverse_struct *ts = (struct traverse_struct *)state;
720 struct printjob pjob;
721 uint32 jobid;
722 int i = 0;
724 if ( key.dsize != sizeof(jobid) )
725 return 0;
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 );
733 if (!pjob.smbjob) {
734 /* remove a unix job if it isn't in the system queue any more */
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;
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;
748 /* need to continue the the bottom of the function to
749 save the correct attributes */
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;
766 /* this check only makes sense for jobs submitted from Windows clients */
768 if ( pjob.smbjob ) {
769 for (i=0;i<ts->qcount;i++) {
770 uint32 curr_jobid;
772 if ( pjob.status == LPQ_DELETED )
773 continue;
775 curr_jobid = print_parse_jobid(ts->queue[i].fs_file);
777 if (jobid == curr_jobid) {
779 /* try to clean up any jobs that need to be deleted */
781 if ( pjob.status == LPQ_DELETING ) {
782 int result;
784 result = (*(ts->print_if->job_delete))(
785 ts->sharename, ts->lprm_command, &pjob );
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);
792 else {
793 /* if we deleted the job, the remove the tdb record */
794 pjob_delete(ts->sharename, jobid);
795 pjob.status = LPQ_DELETED;
800 break;
805 /* The job isn't in the system queue - we have to assume it has
806 completed, so delete the database entry. */
808 if (i == ts->qcount) {
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. */
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;
828 /* Save the pjob attributes we will store.
829 FIXME!!! This is the only place where queue->job
830 represents the SMB jobid --jerry */
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);
841 ts->total_jobs++;
843 return 0;
846 /****************************************************************************
847 Check if the print queue has been updated recently enough.
848 ****************************************************************************/
850 static void print_cache_flush(const char *sharename)
852 fstring key;
853 struct tdb_print_db *pdb = get_print_db_byname(sharename);
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);
862 /****************************************************************************
863 Check if someone already thinks they are doing the update.
864 ****************************************************************************/
866 static pid_t get_updating_pid(const char *sharename)
868 fstring keystr;
869 TDB_DATA data, key;
870 pid_t updating_pid;
871 struct tdb_print_db *pdb = get_print_db_byname(sharename);
873 if (!pdb)
874 return (pid_t)-1;
875 slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
876 key = string_tdb_data(keystr);
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;
885 updating_pid = IVAL(data.dptr, 0);
886 SAFE_FREE(data.dptr);
888 if (process_exists_by_pid(updating_pid))
889 return updating_pid;
891 return (pid_t)-1;
894 /****************************************************************************
895 Set the fact that we're doing the update, or have finished doing the update
896 in the tdb.
897 ****************************************************************************/
899 static void set_updating_pid(const fstring sharename, bool updating)
901 fstring keystr;
902 TDB_DATA key;
903 TDB_DATA data;
904 pid_t updating_pid = sys_getpid();
905 uint8 buffer[4];
907 struct tdb_print_db *pdb = get_print_db_byname(sharename);
909 if (!pdb)
910 return;
912 slprintf(keystr, sizeof(keystr)-1, "UPDATING/%s", sharename);
913 key = string_tdb_data(keystr);
915 DEBUG(5, ("set_updating_pid: %s updating lpq cache for print share %s\n",
916 updating ? "" : "not ",
917 sharename ));
919 if ( !updating ) {
920 tdb_delete(pdb->tdb, key);
921 release_print_db(pdb);
922 return;
925 SIVAL( buffer, 0, updating_pid);
926 data.dptr = buffer;
927 data.dsize = 4; /* we always assume this is a 4 byte value */
929 tdb_store(pdb->tdb, key, data, TDB_REPLACE);
930 release_print_db(pdb);
933 /****************************************************************************
934 Sort print jobs by submittal time.
935 ****************************************************************************/
937 static int printjob_comp(print_queue_struct *j1, print_queue_struct *j2)
939 /* Silly cases */
941 if (!j1 && !j2)
942 return 0;
943 if (!j1)
944 return -1;
945 if (!j2)
946 return 1;
948 /* Sort on job start time */
950 if (j1->time == j2->time)
951 return 0;
952 return (j1->time > j2->time) ? 1 : -1;
955 /****************************************************************************
956 Store the sorted queue representation for later portmon retrieval.
957 Skip deleted jobs
958 ****************************************************************************/
960 static void store_queue_struct(struct tdb_print_db *pdb, struct traverse_struct *pts)
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;
969 if (max_reported_jobs && (max_reported_jobs < pts->qcount))
970 pts->qcount = max_reported_jobs;
971 qcount = 0;
973 /* Work out the size. */
974 data.dsize = 0;
975 data.dsize += tdb_pack(NULL, 0, "d", qcount);
977 for (i = 0; i < pts->qcount; i++) {
978 if ( queue[i].status == LPQ_DELETED )
979 continue;
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);
993 if ((data.dptr = (uint8 *)SMB_MALLOC(data.dsize)) == NULL)
994 return;
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;
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);
1013 tdb_store(pdb->tdb, string_tdb_data("INFO/linear_queue_array"), data,
1014 TDB_REPLACE);
1015 SAFE_FREE(data.dptr);
1016 return;
1019 static TDB_DATA get_jobs_changed_data(struct tdb_print_db *pdb)
1021 TDB_DATA data;
1023 ZERO_STRUCT(data);
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);
1031 return data;
1034 static void check_job_changed(const char *sharename, TDB_DATA data, uint32 jobid)
1036 unsigned int i;
1037 unsigned int job_count = data.dsize / 4;
1039 for (i = 0; i < job_count; i++) {
1040 uint32 ch_jobid;
1042 ch_jobid = IVAL(data.dptr, i*4);
1043 if (ch_jobid == jobid)
1044 remove_from_jobs_changed(sharename, jobid);
1048 /****************************************************************************
1049 Check if the print queue has been updated recently enough.
1050 ****************************************************************************/
1052 static bool print_cache_expired(const char *sharename, bool check_pending)
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;
1059 if (!pdb)
1060 return False;
1062 snprintf(key, sizeof(key), "CACHE/%s", sharename);
1063 last_qscan_time = (time_t)tdb_fetch_int32(pdb->tdb, key);
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.
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))
1079 uint32 u;
1080 time_t msg_pending_time;
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() ));
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. */
1092 snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
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 )
1100 DEBUG(4,("print_cache_expired: message already pending for %s. Accepting cache\n",
1101 sharename));
1102 goto done;
1105 result = True;
1108 done:
1109 release_print_db(pdb);
1110 return result;
1113 /****************************************************************************
1114 main work for updating the lpq cahe for a printer queue
1115 ****************************************************************************/
1117 static void print_queue_update_internal( const char *sharename,
1118 struct printif *current_printif,
1119 char *lpq_command, char *lprm_command )
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);
1132 if (!pdb) {
1133 return;
1136 DEBUG(5,("print_queue_update_internal: printer = %s, type = %d, lpq command = [%s]\n",
1137 sharename, current_printif->type, lpq_command));
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.
1145 slprintf(cachestr, sizeof(cachestr)-1, "CACHE/%s", sharename);
1146 tdb_store_int32(pdb->tdb, cachestr, (int)time(NULL));
1148 /* get the current queue using the appropriate interface */
1149 ZERO_STRUCT(status);
1151 qcount = (*(current_printif->queue_get))(sharename,
1152 current_printif->type,
1153 lpq_command, &queue, &status);
1155 DEBUG(3, ("print_queue_update_internal: %d job%s in queue for %s\n",
1156 qcount, (qcount != 1) ? "s" : "", sharename));
1158 /* Sort the queue by submission time otherwise they are displayed
1159 in hash order. */
1161 qsort(queue, qcount, sizeof(print_queue_struct),
1162 QSORT_CAST(printjob_comp));
1165 any job in the internal database that is marked as spooled
1166 and doesn't exist in the system queue is considered finished
1167 and removed from the database
1169 any job in the system database but not in the internal database
1170 is added as a unix job
1172 fill in any system job numbers as we go
1175 jcdata = get_jobs_changed_data(pdb);
1177 for (i=0; i<qcount; i++) {
1178 uint32 jobid = print_parse_jobid(queue[i].fs_file);
1180 if (jobid == (uint32)-1) {
1181 /* assume its a unix print job */
1182 print_unix_job(sharename, &queue[i], jobid);
1183 continue;
1186 /* we have an active SMB print job - update its status */
1187 pjob = print_job_find(sharename, jobid);
1188 if (!pjob) {
1189 /* err, somethings wrong. Probably smbd was restarted
1190 with jobs in the queue. All we can do is treat them
1191 like unix jobs. Pity. */
1192 print_unix_job(sharename, &queue[i], jobid);
1193 continue;
1196 pjob->sysjob = queue[i].job;
1198 /* don't reset the status on jobs to be deleted */
1200 if ( pjob->status != LPQ_DELETING )
1201 pjob->status = queue[i].status;
1203 pjob_store(sharename, jobid, pjob);
1205 check_job_changed(sharename, jcdata, jobid);
1208 SAFE_FREE(jcdata.dptr);
1210 /* now delete any queued entries that don't appear in the
1211 system queue */
1212 tstruct.queue = queue;
1213 tstruct.qcount = qcount;
1214 tstruct.snum = -1;
1215 tstruct.total_jobs = 0;
1216 tstruct.lpq_time = time(NULL);
1217 tstruct.sharename = sharename;
1218 tstruct.lprm_command = lprm_command;
1219 tstruct.print_if = current_printif;
1221 tdb_traverse(pdb->tdb, traverse_fn_delete, (void *)&tstruct);
1223 /* Store the linearised queue, max jobs only. */
1224 store_queue_struct(pdb, &tstruct);
1226 SAFE_FREE(tstruct.queue);
1228 DEBUG(10,("print_queue_update_internal: printer %s INFO/total_jobs = %d\n",
1229 sharename, tstruct.total_jobs ));
1231 tdb_store_int32(pdb->tdb, "INFO/total_jobs", tstruct.total_jobs);
1233 get_queue_status(sharename, &old_status);
1234 if (old_status.qcount != qcount)
1235 DEBUG(10,("print_queue_update_internal: queue status change %d jobs -> %d jobs for printer %s\n",
1236 old_status.qcount, qcount, sharename));
1238 /* store the new queue status structure */
1239 slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
1240 key = string_tdb_data(keystr);
1242 status.qcount = qcount;
1243 data.dptr = (uint8 *)&status;
1244 data.dsize = sizeof(status);
1245 tdb_store(pdb->tdb, key, data, TDB_REPLACE);
1248 * Update the cache time again. We want to do this call
1249 * as little as possible...
1252 slprintf(keystr, sizeof(keystr)-1, "CACHE/%s", sharename);
1253 tdb_store_int32(pdb->tdb, keystr, (int32)time(NULL));
1255 /* clear the msg pending record for this queue */
1257 snprintf(keystr, sizeof(keystr), "MSG_PENDING/%s", sharename);
1259 if ( !tdb_store_uint32( pdb->tdb, keystr, 0 ) ) {
1260 /* log a message but continue on */
1262 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1263 sharename));
1266 release_print_db( pdb );
1268 return;
1271 /****************************************************************************
1272 Update the internal database from the system print queue for a queue.
1273 obtain a lock on the print queue before proceeding (needed when mutiple
1274 smbd processes maytry to update the lpq cache concurrently).
1275 ****************************************************************************/
1277 static void print_queue_update_with_lock( const char *sharename,
1278 struct printif *current_printif,
1279 char *lpq_command, char *lprm_command )
1281 fstring keystr;
1282 struct tdb_print_db *pdb;
1284 DEBUG(5,("print_queue_update_with_lock: printer share = %s\n", sharename));
1285 pdb = get_print_db_byname(sharename);
1286 if (!pdb)
1287 return;
1289 if ( !print_cache_expired(sharename, False) ) {
1290 DEBUG(5,("print_queue_update_with_lock: print cache for %s is still ok\n", sharename));
1291 release_print_db(pdb);
1292 return;
1296 * Check to see if someone else is doing this update.
1297 * This is essentially a mutex on the update.
1300 if (get_updating_pid(sharename) != -1) {
1301 release_print_db(pdb);
1302 return;
1305 /* Lock the queue for the database update */
1307 slprintf(keystr, sizeof(keystr) - 1, "LOCK/%s", sharename);
1308 /* Only wait 10 seconds for this. */
1309 if (tdb_lock_bystring_with_timeout(pdb->tdb, keystr, 10) == -1) {
1310 DEBUG(0,("print_queue_update_with_lock: Failed to lock printer %s database\n", sharename));
1311 release_print_db(pdb);
1312 return;
1316 * Ensure that no one else got in here.
1317 * If the updating pid is still -1 then we are
1318 * the winner.
1321 if (get_updating_pid(sharename) != -1) {
1323 * Someone else is doing the update, exit.
1325 tdb_unlock_bystring(pdb->tdb, keystr);
1326 release_print_db(pdb);
1327 return;
1331 * We're going to do the update ourselves.
1334 /* Tell others we're doing the update. */
1335 set_updating_pid(sharename, True);
1338 * Allow others to enter and notice we're doing
1339 * the update.
1342 tdb_unlock_bystring(pdb->tdb, keystr);
1344 /* do the main work now */
1346 print_queue_update_internal( sharename, current_printif,
1347 lpq_command, lprm_command );
1349 /* Delete our pid from the db. */
1350 set_updating_pid(sharename, False);
1351 release_print_db(pdb);
1354 /****************************************************************************
1355 this is the receive function of the background lpq updater
1356 ****************************************************************************/
1357 static void print_queue_receive(struct messaging_context *msg,
1358 void *private_data,
1359 uint32_t msg_type,
1360 struct server_id server_id,
1361 DATA_BLOB *data)
1363 fstring sharename;
1364 char *lpqcommand = NULL, *lprmcommand = NULL;
1365 int printing_type;
1366 size_t len;
1368 len = tdb_unpack( (uint8 *)data->data, data->length, "fdPP",
1369 sharename,
1370 &printing_type,
1371 &lpqcommand,
1372 &lprmcommand );
1374 if ( len == -1 ) {
1375 SAFE_FREE(lpqcommand);
1376 SAFE_FREE(lprmcommand);
1377 DEBUG(0,("print_queue_receive: Got invalid print queue update message\n"));
1378 return;
1381 print_queue_update_with_lock(sharename,
1382 get_printer_fns_from_type((enum printing_types)printing_type),
1383 lpqcommand, lprmcommand );
1385 SAFE_FREE(lpqcommand);
1386 SAFE_FREE(lprmcommand);
1387 return;
1390 static pid_t background_lpq_updater_pid = -1;
1392 /****************************************************************************
1393 main thread of the background lpq updater
1394 ****************************************************************************/
1395 void start_background_queue(void)
1397 DEBUG(3,("start_background_queue: Starting background LPQ thread\n"));
1398 background_lpq_updater_pid = sys_fork();
1400 if (background_lpq_updater_pid == -1) {
1401 DEBUG(5,("start_background_queue: background LPQ thread failed to start. %s\n", strerror(errno) ));
1402 exit(1);
1405 if(background_lpq_updater_pid == 0) {
1406 /* Child. */
1407 DEBUG(5,("start_background_queue: background LPQ thread started\n"));
1409 if (!reinit_after_fork(smbd_messaging_context(), true)) {
1410 DEBUG(0,("reinit_after_fork() failed\n"));
1411 smb_panic("reinit_after_fork() failed");
1414 claim_connection( NULL, "smbd lpq backend",
1415 FLAG_MSG_GENERAL|FLAG_MSG_SMBD|FLAG_MSG_PRINT_GENERAL);
1417 if (!locking_init()) {
1418 exit(1);
1421 messaging_register(smbd_messaging_context(), NULL,
1422 MSG_PRINTER_UPDATE, print_queue_receive);
1424 DEBUG(5,("start_background_queue: background LPQ thread waiting for messages\n"));
1425 while (1) {
1426 pause();
1428 /* check for some essential signals first */
1430 if (got_sig_term) {
1431 exit_server_cleanly(NULL);
1434 if (reload_after_sighup) {
1435 change_to_root_user();
1436 DEBUG(1,("Reloading services after SIGHUP\n"));
1437 reload_services(False);
1438 reload_after_sighup = 0;
1441 /* now check for messages */
1443 DEBUG(10,("start_background_queue: background LPQ thread got a message\n"));
1444 message_dispatch(smbd_messaging_context());
1446 /* process any pending print change notify messages */
1448 print_notify_send_messages(smbd_messaging_context(),
1454 /****************************************************************************
1455 update the internal database from the system print queue for a queue
1456 ****************************************************************************/
1458 static void print_queue_update(int snum, bool force)
1460 fstring key;
1461 fstring sharename;
1462 char *lpqcommand = NULL;
1463 char *lprmcommand = NULL;
1464 uint8 *buffer = NULL;
1465 size_t len = 0;
1466 size_t newlen;
1467 struct tdb_print_db *pdb;
1468 int type;
1469 struct printif *current_printif;
1470 TALLOC_CTX *ctx = talloc_tos();
1472 fstrcpy( sharename, lp_const_servicename(snum));
1474 /* don't strip out characters like '$' from the printername */
1476 lpqcommand = talloc_string_sub2(ctx,
1477 lp_lpqcommand(snum),
1478 "%p",
1479 PRINTERNAME(snum),
1480 false, false, false);
1481 if (!lpqcommand) {
1482 return;
1484 lpqcommand = talloc_sub_advanced(ctx,
1485 lp_servicename(snum),
1486 current_user_info.unix_name,
1488 current_user.ut.gid,
1489 get_current_username(),
1490 current_user_info.domain,
1491 lpqcommand);
1492 if (!lpqcommand) {
1493 return;
1496 lprmcommand = talloc_string_sub2(ctx,
1497 lp_lprmcommand(snum),
1498 "%p",
1499 PRINTERNAME(snum),
1500 false, false, false);
1501 if (!lprmcommand) {
1502 return;
1504 lprmcommand = talloc_sub_advanced(ctx,
1505 lp_servicename(snum),
1506 current_user_info.unix_name,
1508 current_user.ut.gid,
1509 get_current_username(),
1510 current_user_info.domain,
1511 lprmcommand);
1512 if (!lprmcommand) {
1513 return;
1517 * Make sure that the background queue process exists.
1518 * Otherwise just do the update ourselves
1521 if ( force || background_lpq_updater_pid == -1 ) {
1522 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename));
1523 current_printif = get_printer_fns( snum );
1524 print_queue_update_with_lock( sharename, current_printif, lpqcommand, lprmcommand );
1526 return;
1529 type = lp_printing(snum);
1531 /* get the length */
1533 len = tdb_pack( NULL, 0, "fdPP",
1534 sharename,
1535 type,
1536 lpqcommand,
1537 lprmcommand );
1539 buffer = SMB_XMALLOC_ARRAY( uint8, len );
1541 /* now pack the buffer */
1542 newlen = tdb_pack( buffer, len, "fdPP",
1543 sharename,
1544 type,
1545 lpqcommand,
1546 lprmcommand );
1548 SMB_ASSERT( newlen == len );
1550 DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1551 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1552 sharename, type, lpqcommand, lprmcommand ));
1554 /* here we set a msg pending record for other smbd processes
1555 to throttle the number of duplicate print_queue_update msgs
1556 sent. */
1558 pdb = get_print_db_byname(sharename);
1559 if (!pdb) {
1560 SAFE_FREE(buffer);
1561 return;
1564 snprintf(key, sizeof(key), "MSG_PENDING/%s", sharename);
1566 if ( !tdb_store_uint32( pdb->tdb, key, time(NULL) ) ) {
1567 /* log a message but continue on */
1569 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1570 sharename));
1573 release_print_db( pdb );
1575 /* finally send the message */
1577 messaging_send_buf(smbd_messaging_context(),
1578 pid_to_procid(background_lpq_updater_pid),
1579 MSG_PRINTER_UPDATE, (uint8 *)buffer, len);
1581 SAFE_FREE( buffer );
1583 return;
1586 /****************************************************************************
1587 Create/Update an entry in the print tdb that will allow us to send notify
1588 updates only to interested smbd's.
1589 ****************************************************************************/
1591 bool print_notify_register_pid(int snum)
1593 TDB_DATA data;
1594 struct tdb_print_db *pdb = NULL;
1595 TDB_CONTEXT *tdb = NULL;
1596 const char *printername;
1597 uint32 mypid = (uint32)sys_getpid();
1598 bool ret = False;
1599 size_t i;
1601 /* if (snum == -1), then the change notify request was
1602 on a print server handle and we need to register on
1603 all print queus */
1605 if (snum == -1)
1607 int num_services = lp_numservices();
1608 int idx;
1610 for ( idx=0; idx<num_services; idx++ ) {
1611 if (lp_snum_ok(idx) && lp_print_ok(idx) )
1612 print_notify_register_pid(idx);
1615 return True;
1617 else /* register for a specific printer */
1619 printername = lp_const_servicename(snum);
1620 pdb = get_print_db_byname(printername);
1621 if (!pdb)
1622 return False;
1623 tdb = pdb->tdb;
1626 if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1627 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1628 printername));
1629 if (pdb)
1630 release_print_db(pdb);
1631 return False;
1634 data = get_printer_notify_pid_list( tdb, printername, True );
1636 /* Add ourselves and increase the refcount. */
1638 for (i = 0; i < data.dsize; i += 8) {
1639 if (IVAL(data.dptr,i) == mypid) {
1640 uint32 new_refcount = IVAL(data.dptr, i+4) + 1;
1641 SIVAL(data.dptr, i+4, new_refcount);
1642 break;
1646 if (i == data.dsize) {
1647 /* We weren't in the list. Realloc. */
1648 data.dptr = (uint8 *)SMB_REALLOC(data.dptr, data.dsize + 8);
1649 if (!data.dptr) {
1650 DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1651 printername));
1652 goto done;
1654 data.dsize += 8;
1655 SIVAL(data.dptr,data.dsize - 8,mypid);
1656 SIVAL(data.dptr,data.dsize - 4,1); /* Refcount. */
1659 /* Store back the record. */
1660 if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1661 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1662 list for printer %s\n", printername));
1663 goto done;
1666 ret = True;
1668 done:
1670 tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1671 if (pdb)
1672 release_print_db(pdb);
1673 SAFE_FREE(data.dptr);
1674 return ret;
1677 /****************************************************************************
1678 Update an entry in the print tdb that will allow us to send notify
1679 updates only to interested smbd's.
1680 ****************************************************************************/
1682 bool print_notify_deregister_pid(int snum)
1684 TDB_DATA data;
1685 struct tdb_print_db *pdb = NULL;
1686 TDB_CONTEXT *tdb = NULL;
1687 const char *printername;
1688 uint32 mypid = (uint32)sys_getpid();
1689 size_t i;
1690 bool ret = False;
1692 /* if ( snum == -1 ), we are deregister a print server handle
1693 which means to deregister on all print queues */
1695 if (snum == -1)
1697 int num_services = lp_numservices();
1698 int idx;
1700 for ( idx=0; idx<num_services; idx++ ) {
1701 if ( lp_snum_ok(idx) && lp_print_ok(idx) )
1702 print_notify_deregister_pid(idx);
1705 return True;
1707 else /* deregister a specific printer */
1709 printername = lp_const_servicename(snum);
1710 pdb = get_print_db_byname(printername);
1711 if (!pdb)
1712 return False;
1713 tdb = pdb->tdb;
1716 if (tdb_lock_bystring_with_timeout(tdb, NOTIFY_PID_LIST_KEY, 10) == -1) {
1717 DEBUG(0,("print_notify_register_pid: Failed to lock \
1718 printer %s database\n", printername));
1719 if (pdb)
1720 release_print_db(pdb);
1721 return False;
1724 data = get_printer_notify_pid_list( tdb, printername, True );
1726 /* Reduce refcount. Remove ourselves if zero. */
1728 for (i = 0; i < data.dsize; ) {
1729 if (IVAL(data.dptr,i) == mypid) {
1730 uint32 refcount = IVAL(data.dptr, i+4);
1732 refcount--;
1734 if (refcount == 0) {
1735 if (data.dsize - i > 8)
1736 memmove( &data.dptr[i], &data.dptr[i+8], data.dsize - i - 8);
1737 data.dsize -= 8;
1738 continue;
1740 SIVAL(data.dptr, i+4, refcount);
1743 i += 8;
1746 if (data.dsize == 0)
1747 SAFE_FREE(data.dptr);
1749 /* Store back the record. */
1750 if (tdb_store_bystring(tdb, NOTIFY_PID_LIST_KEY, data, TDB_REPLACE) == -1) {
1751 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1752 list for printer %s\n", printername));
1753 goto done;
1756 ret = True;
1758 done:
1760 tdb_unlock_bystring(tdb, NOTIFY_PID_LIST_KEY);
1761 if (pdb)
1762 release_print_db(pdb);
1763 SAFE_FREE(data.dptr);
1764 return ret;
1767 /****************************************************************************
1768 Check if a jobid is valid. It is valid if it exists in the database.
1769 ****************************************************************************/
1771 bool print_job_exists(const char* sharename, uint32 jobid)
1773 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1774 bool ret;
1775 uint32_t tmp;
1777 if (!pdb)
1778 return False;
1779 ret = tdb_exists(pdb->tdb, print_key(jobid, &tmp));
1780 release_print_db(pdb);
1781 return ret;
1784 /****************************************************************************
1785 Give the fd used for a jobid.
1786 ****************************************************************************/
1788 int print_job_fd(const char* sharename, uint32 jobid)
1790 struct printjob *pjob = print_job_find(sharename, jobid);
1791 if (!pjob)
1792 return -1;
1793 /* don't allow another process to get this info - it is meaningless */
1794 if (pjob->pid != sys_getpid())
1795 return -1;
1796 return pjob->fd;
1799 /****************************************************************************
1800 Give the filename used for a jobid.
1801 Only valid for the process doing the spooling and when the job
1802 has not been spooled.
1803 ****************************************************************************/
1805 char *print_job_fname(const char* sharename, uint32 jobid)
1807 struct printjob *pjob = print_job_find(sharename, jobid);
1808 if (!pjob || pjob->spooled || pjob->pid != sys_getpid())
1809 return NULL;
1810 return pjob->filename;
1814 /****************************************************************************
1815 Give the filename used for a jobid.
1816 Only valid for the process doing the spooling and when the job
1817 has not been spooled.
1818 ****************************************************************************/
1820 NT_DEVICEMODE *print_job_devmode(const char* sharename, uint32 jobid)
1822 struct printjob *pjob = print_job_find(sharename, jobid);
1824 if ( !pjob )
1825 return NULL;
1827 return pjob->nt_devmode;
1830 /****************************************************************************
1831 Set the place in the queue for a job.
1832 ****************************************************************************/
1834 bool print_job_set_place(const char *sharename, uint32 jobid, int place)
1836 DEBUG(2,("print_job_set_place not implemented yet\n"));
1837 return False;
1840 /****************************************************************************
1841 Set the name of a job. Only possible for owner.
1842 ****************************************************************************/
1844 bool print_job_set_name(const char *sharename, uint32 jobid, char *name)
1846 struct printjob *pjob;
1848 pjob = print_job_find(sharename, jobid);
1849 if (!pjob || pjob->pid != sys_getpid())
1850 return False;
1852 fstrcpy(pjob->jobname, name);
1853 return pjob_store(sharename, jobid, pjob);
1856 /***************************************************************************
1857 Remove a jobid from the 'jobs changed' list.
1858 ***************************************************************************/
1860 static bool remove_from_jobs_changed(const char* sharename, uint32 jobid)
1862 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1863 TDB_DATA data, key;
1864 size_t job_count, i;
1865 bool ret = False;
1866 bool gotlock = False;
1868 if (!pdb) {
1869 return False;
1872 ZERO_STRUCT(data);
1874 key = string_tdb_data("INFO/jobs_changed");
1876 if (tdb_chainlock_with_timeout(pdb->tdb, key, 5) == -1)
1877 goto out;
1879 gotlock = True;
1881 data = tdb_fetch(pdb->tdb, key);
1883 if (data.dptr == NULL || data.dsize == 0 || (data.dsize % 4 != 0))
1884 goto out;
1886 job_count = data.dsize / 4;
1887 for (i = 0; i < job_count; i++) {
1888 uint32 ch_jobid;
1890 ch_jobid = IVAL(data.dptr, i*4);
1891 if (ch_jobid == jobid) {
1892 if (i < job_count -1 )
1893 memmove(data.dptr + (i*4), data.dptr + (i*4) + 4, (job_count - i - 1)*4 );
1894 data.dsize -= 4;
1895 if (tdb_store(pdb->tdb, key, data, TDB_REPLACE) == -1)
1896 goto out;
1897 break;
1901 ret = True;
1902 out:
1904 if (gotlock)
1905 tdb_chainunlock(pdb->tdb, key);
1906 SAFE_FREE(data.dptr);
1907 release_print_db(pdb);
1908 if (ret)
1909 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid ));
1910 else
1911 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid ));
1912 return ret;
1915 /****************************************************************************
1916 Delete a print job - don't update queue.
1917 ****************************************************************************/
1919 static bool print_job_delete1(int snum, uint32 jobid)
1921 const char* sharename = lp_const_servicename(snum);
1922 struct printjob *pjob = print_job_find(sharename, jobid);
1923 int result = 0;
1924 struct printif *current_printif = get_printer_fns( snum );
1926 if (!pjob)
1927 return False;
1930 * If already deleting just return.
1933 if (pjob->status == LPQ_DELETING)
1934 return True;
1936 /* Hrm - we need to be able to cope with deleting a job before it
1937 has reached the spooler. Just mark it as LPQ_DELETING and
1938 let the print_queue_update() code rmeove the record */
1941 if (pjob->sysjob == -1) {
1942 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid));
1945 /* Set the tdb entry to be deleting. */
1947 pjob->status = LPQ_DELETING;
1948 pjob_store(sharename, jobid, pjob);
1950 if (pjob->spooled && pjob->sysjob != -1)
1952 result = (*(current_printif->job_delete))(
1953 PRINTERNAME(snum),
1954 lp_lprmcommand(snum),
1955 pjob);
1957 /* Delete the tdb entry if the delete succeeded or the job hasn't
1958 been spooled. */
1960 if (result == 0) {
1961 struct tdb_print_db *pdb = get_print_db_byname(sharename);
1962 int njobs = 1;
1964 if (!pdb)
1965 return False;
1966 pjob_delete(sharename, jobid);
1967 /* Ensure we keep a rough count of the number of total jobs... */
1968 tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, -1);
1969 release_print_db(pdb);
1973 remove_from_jobs_changed( sharename, jobid );
1975 return (result == 0);
1978 /****************************************************************************
1979 Return true if the current user owns the print job.
1980 ****************************************************************************/
1982 static bool is_owner(struct current_user *user, const char *servicename,
1983 uint32 jobid)
1985 struct printjob *pjob = print_job_find(servicename, jobid);
1986 user_struct *vuser;
1988 if (!pjob || !user)
1989 return False;
1991 if ((vuser = get_valid_user_struct(user->vuid)) != NULL) {
1992 return strequal(pjob->user, vuser->user.smb_name);
1993 } else {
1994 return strequal(pjob->user, uidtoname(user->ut.uid));
1998 /****************************************************************************
1999 Delete a print job.
2000 ****************************************************************************/
2002 bool print_job_delete(struct current_user *user, int snum, uint32 jobid, WERROR *errcode)
2004 const char* sharename = lp_const_servicename( snum );
2005 struct printjob *pjob;
2006 bool owner;
2007 char *fname;
2009 *errcode = WERR_OK;
2011 owner = is_owner(user, lp_const_servicename(snum), jobid);
2013 /* Check access against security descriptor or whether the user
2014 owns their job. */
2016 if (!owner &&
2017 !print_access_check(user, snum, JOB_ACCESS_ADMINISTER)) {
2018 DEBUG(3, ("delete denied by security descriptor\n"));
2019 *errcode = WERR_ACCESS_DENIED;
2021 /* BEGIN_ADMIN_LOG */
2022 sys_adminlog( LOG_ERR,
2023 "Permission denied-- user not allowed to delete, \
2024 pause, or resume print job. User name: %s. Printer name: %s.",
2025 uidtoname(user->ut.uid), PRINTERNAME(snum) );
2026 /* END_ADMIN_LOG */
2028 return False;
2032 * get the spooled filename of the print job
2033 * if this works, then the file has not been spooled
2034 * to the underlying print system. Just delete the
2035 * spool file & return.
2038 if ( (fname = print_job_fname( sharename, jobid )) != NULL )
2040 /* remove the spool file */
2041 DEBUG(10,("print_job_delete: Removing spool file [%s]\n", fname ));
2042 if ( unlink( fname ) == -1 ) {
2043 *errcode = map_werror_from_unix(errno);
2044 return False;
2048 if (!print_job_delete1(snum, jobid)) {
2049 *errcode = WERR_ACCESS_DENIED;
2050 return False;
2053 /* force update the database and say the delete failed if the
2054 job still exists */
2056 print_queue_update(snum, True);
2058 pjob = print_job_find(sharename, jobid);
2059 if ( pjob && (pjob->status != LPQ_DELETING) )
2060 *errcode = WERR_ACCESS_DENIED;
2062 return (pjob == NULL );
2065 /****************************************************************************
2066 Pause a job.
2067 ****************************************************************************/
2069 bool print_job_pause(struct current_user *user, int snum, uint32 jobid, WERROR *errcode)
2071 const char* sharename = lp_const_servicename(snum);
2072 struct printjob *pjob;
2073 int ret = -1;
2074 struct printif *current_printif = get_printer_fns( snum );
2076 pjob = print_job_find(sharename, jobid);
2078 if (!pjob || !user) {
2079 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2080 (unsigned int)jobid ));
2081 return False;
2084 if (!pjob->spooled || pjob->sysjob == -1) {
2085 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2086 (int)pjob->sysjob, (unsigned int)jobid ));
2087 return False;
2090 if (!is_owner(user, lp_const_servicename(snum), jobid) &&
2091 !print_access_check(user, snum, JOB_ACCESS_ADMINISTER)) {
2092 DEBUG(3, ("pause denied by security descriptor\n"));
2094 /* BEGIN_ADMIN_LOG */
2095 sys_adminlog( LOG_ERR,
2096 "Permission denied-- user not allowed to delete, \
2097 pause, or resume print job. User name: %s. Printer name: %s.",
2098 uidtoname(user->ut.uid), PRINTERNAME(snum) );
2099 /* END_ADMIN_LOG */
2101 *errcode = WERR_ACCESS_DENIED;
2102 return False;
2105 /* need to pause the spooled entry */
2106 ret = (*(current_printif->job_pause))(snum, pjob);
2108 if (ret != 0) {
2109 *errcode = WERR_INVALID_PARAM;
2110 return False;
2113 /* force update the database */
2114 print_cache_flush(lp_const_servicename(snum));
2116 /* Send a printer notify message */
2118 notify_job_status(sharename, jobid, JOB_STATUS_PAUSED);
2120 /* how do we tell if this succeeded? */
2122 return True;
2125 /****************************************************************************
2126 Resume a job.
2127 ****************************************************************************/
2129 bool print_job_resume(struct current_user *user, int snum, uint32 jobid, WERROR *errcode)
2131 const char *sharename = lp_const_servicename(snum);
2132 struct printjob *pjob;
2133 int ret;
2134 struct printif *current_printif = get_printer_fns( snum );
2136 pjob = print_job_find(sharename, jobid);
2138 if (!pjob || !user) {
2139 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2140 (unsigned int)jobid ));
2141 return False;
2144 if (!pjob->spooled || pjob->sysjob == -1) {
2145 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2146 (int)pjob->sysjob, (unsigned int)jobid ));
2147 return False;
2150 if (!is_owner(user, lp_const_servicename(snum), jobid) &&
2151 !print_access_check(user, snum, JOB_ACCESS_ADMINISTER)) {
2152 DEBUG(3, ("resume denied by security descriptor\n"));
2153 *errcode = WERR_ACCESS_DENIED;
2155 /* BEGIN_ADMIN_LOG */
2156 sys_adminlog( LOG_ERR,
2157 "Permission denied-- user not allowed to delete, \
2158 pause, or resume print job. User name: %s. Printer name: %s.",
2159 uidtoname(user->ut.uid), PRINTERNAME(snum) );
2160 /* END_ADMIN_LOG */
2161 return False;
2164 ret = (*(current_printif->job_resume))(snum, pjob);
2166 if (ret != 0) {
2167 *errcode = WERR_INVALID_PARAM;
2168 return False;
2171 /* force update the database */
2172 print_cache_flush(lp_const_servicename(snum));
2174 /* Send a printer notify message */
2176 notify_job_status(sharename, jobid, JOB_STATUS_QUEUED);
2178 return True;
2181 /****************************************************************************
2182 Write to a print file.
2183 ****************************************************************************/
2185 ssize_t print_job_write(int snum, uint32 jobid, const char *buf, SMB_OFF_T pos, size_t size)
2187 const char* sharename = lp_const_servicename(snum);
2188 int return_code;
2189 struct printjob *pjob;
2191 pjob = print_job_find(sharename, jobid);
2193 if (!pjob)
2194 return -1;
2195 /* don't allow another process to get this info - it is meaningless */
2196 if (pjob->pid != sys_getpid())
2197 return -1;
2199 return_code = write_data_at_offset(pjob->fd, buf, size, pos);
2201 if (return_code>0) {
2202 pjob->size += size;
2203 pjob_store(sharename, jobid, pjob);
2205 return return_code;
2208 /****************************************************************************
2209 Get the queue status - do not update if db is out of date.
2210 ****************************************************************************/
2212 static int get_queue_status(const char* sharename, print_status_struct *status)
2214 fstring keystr;
2215 TDB_DATA data;
2216 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2217 int len;
2219 if (status) {
2220 ZERO_STRUCTP(status);
2223 if (!pdb)
2224 return 0;
2226 if (status) {
2227 fstr_sprintf(keystr, "STATUS/%s", sharename);
2228 data = tdb_fetch(pdb->tdb, string_tdb_data(keystr));
2229 if (data.dptr) {
2230 if (data.dsize == sizeof(print_status_struct))
2231 /* this memcpy is ok since the status struct was
2232 not packed before storing it in the tdb */
2233 memcpy(status, data.dptr, sizeof(print_status_struct));
2234 SAFE_FREE(data.dptr);
2237 len = tdb_fetch_int32(pdb->tdb, "INFO/total_jobs");
2238 release_print_db(pdb);
2239 return (len == -1 ? 0 : len);
2242 /****************************************************************************
2243 Determine the number of jobs in a queue.
2244 ****************************************************************************/
2246 int print_queue_length(int snum, print_status_struct *pstatus)
2248 const char* sharename = lp_const_servicename( snum );
2249 print_status_struct status;
2250 int len;
2252 ZERO_STRUCT( status );
2254 /* make sure the database is up to date */
2255 if (print_cache_expired(lp_const_servicename(snum), True))
2256 print_queue_update(snum, False);
2258 /* also fetch the queue status */
2259 memset(&status, 0, sizeof(status));
2260 len = get_queue_status(sharename, &status);
2262 if (pstatus)
2263 *pstatus = status;
2265 return len;
2268 /***************************************************************************
2269 Allocate a jobid. Hold the lock for as short a time as possible.
2270 ***************************************************************************/
2272 static bool allocate_print_jobid(struct tdb_print_db *pdb, int snum, const char *sharename, uint32 *pjobid)
2274 int i;
2275 uint32 jobid;
2277 *pjobid = (uint32)-1;
2279 for (i = 0; i < 3; i++) {
2280 /* Lock the database - only wait 20 seconds. */
2281 if (tdb_lock_bystring_with_timeout(pdb->tdb, "INFO/nextjob", 20) == -1) {
2282 DEBUG(0,("allocate_print_jobid: failed to lock printing database %s\n", sharename));
2283 return False;
2286 if (!tdb_fetch_uint32(pdb->tdb, "INFO/nextjob", &jobid)) {
2287 if (tdb_error(pdb->tdb) != TDB_ERR_NOEXIST) {
2288 DEBUG(0, ("allocate_print_jobid: failed to fetch INFO/nextjob for print queue %s\n",
2289 sharename));
2290 return False;
2292 jobid = 0;
2295 jobid = NEXT_JOBID(jobid);
2297 if (tdb_store_int32(pdb->tdb, "INFO/nextjob", jobid)==-1) {
2298 DEBUG(3, ("allocate_print_jobid: failed to store INFO/nextjob.\n"));
2299 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2300 return False;
2303 /* We've finished with the INFO/nextjob lock. */
2304 tdb_unlock_bystring(pdb->tdb, "INFO/nextjob");
2306 if (!print_job_exists(sharename, jobid))
2307 break;
2310 if (i > 2) {
2311 DEBUG(0, ("allocate_print_jobid: failed to allocate a print job for queue %s\n",
2312 sharename));
2313 /* Probably full... */
2314 errno = ENOSPC;
2315 return False;
2318 /* Store a dummy placeholder. */
2320 uint32_t tmp;
2321 TDB_DATA dum;
2322 dum.dptr = NULL;
2323 dum.dsize = 0;
2324 if (tdb_store(pdb->tdb, print_key(jobid, &tmp), dum,
2325 TDB_INSERT) == -1) {
2326 DEBUG(3, ("allocate_print_jobid: jobid (%d) failed to store placeholder.\n",
2327 jobid ));
2328 return False;
2332 *pjobid = jobid;
2333 return True;
2336 /***************************************************************************
2337 Append a jobid to the 'jobs changed' list.
2338 ***************************************************************************/
2340 static bool add_to_jobs_changed(struct tdb_print_db *pdb, uint32 jobid)
2342 TDB_DATA data;
2343 uint32 store_jobid;
2345 SIVAL(&store_jobid, 0, jobid);
2346 data.dptr = (uint8 *)&store_jobid;
2347 data.dsize = 4;
2349 DEBUG(10,("add_to_jobs_changed: Added jobid %u\n", (unsigned int)jobid ));
2351 return (tdb_append(pdb->tdb, string_tdb_data("INFO/jobs_changed"),
2352 data) == 0);
2355 /***************************************************************************
2356 Start spooling a job - return the jobid.
2357 ***************************************************************************/
2359 uint32 print_job_start(struct current_user *user, int snum, char *jobname, NT_DEVICEMODE *nt_devmode )
2361 uint32 jobid;
2362 char *path;
2363 struct printjob pjob;
2364 user_struct *vuser;
2365 const char *sharename = lp_const_servicename(snum);
2366 struct tdb_print_db *pdb = get_print_db_byname(sharename);
2367 int njobs;
2369 errno = 0;
2371 if (!pdb)
2372 return (uint32)-1;
2374 if (!print_access_check(user, snum, PRINTER_ACCESS_USE)) {
2375 DEBUG(3, ("print_job_start: job start denied by security descriptor\n"));
2376 release_print_db(pdb);
2377 return (uint32)-1;
2380 if (!print_time_access_check(lp_servicename(snum))) {
2381 DEBUG(3, ("print_job_start: job start denied by time check\n"));
2382 release_print_db(pdb);
2383 return (uint32)-1;
2386 path = lp_pathname(snum);
2388 /* see if we have sufficient disk space */
2389 if (lp_minprintspace(snum)) {
2390 SMB_BIG_UINT dspace, dsize;
2391 if (sys_fsusage(path, &dspace, &dsize) == 0 &&
2392 dspace < 2*(SMB_BIG_UINT)lp_minprintspace(snum)) {
2393 DEBUG(3, ("print_job_start: disk space check failed.\n"));
2394 release_print_db(pdb);
2395 errno = ENOSPC;
2396 return (uint32)-1;
2400 /* for autoloaded printers, check that the printcap entry still exists */
2401 if (lp_autoloaded(snum) && !pcap_printername_ok(lp_const_servicename(snum))) {
2402 DEBUG(3, ("print_job_start: printer name %s check failed.\n", lp_const_servicename(snum) ));
2403 release_print_db(pdb);
2404 errno = ENOENT;
2405 return (uint32)-1;
2408 /* Insure the maximum queue size is not violated */
2409 if ((njobs = print_queue_length(snum,NULL)) > lp_maxprintjobs(snum)) {
2410 DEBUG(3, ("print_job_start: Queue %s number of jobs (%d) larger than max printjobs per queue (%d).\n",
2411 sharename, njobs, lp_maxprintjobs(snum) ));
2412 release_print_db(pdb);
2413 errno = ENOSPC;
2414 return (uint32)-1;
2417 DEBUG(10,("print_job_start: Queue %s number of jobs (%d), max printjobs = %d\n",
2418 sharename, njobs, lp_maxprintjobs(snum) ));
2420 if (!allocate_print_jobid(pdb, snum, sharename, &jobid))
2421 goto fail;
2423 /* create the database entry */
2425 ZERO_STRUCT(pjob);
2427 pjob.pid = sys_getpid();
2428 pjob.sysjob = -1;
2429 pjob.fd = -1;
2430 pjob.starttime = time(NULL);
2431 pjob.status = LPQ_SPOOLING;
2432 pjob.size = 0;
2433 pjob.spooled = False;
2434 pjob.smbjob = True;
2435 pjob.nt_devmode = nt_devmode;
2437 fstrcpy(pjob.jobname, jobname);
2439 if ((vuser = get_valid_user_struct(user->vuid)) != NULL) {
2440 fstrcpy(pjob.user, lp_printjob_username(snum));
2441 standard_sub_advanced(sharename, vuser->user.smb_name, path,
2442 vuser->gid, vuser->user.smb_name,
2443 vuser->user.domain, pjob.user,
2444 sizeof(pjob.user) - 1);
2445 /* ensure NULL termination */
2446 pjob.user[sizeof(pjob.user)-1] = '\0';
2447 } else {
2448 fstrcpy(pjob.user, uidtoname(user->ut.uid));
2451 fstrcpy(pjob.queuename, lp_const_servicename(snum));
2453 /* we have a job entry - now create the spool file */
2454 slprintf(pjob.filename, sizeof(pjob.filename)-1, "%s/%s%.8u.XXXXXX",
2455 path, PRINT_SPOOL_PREFIX, (unsigned int)jobid);
2456 pjob.fd = smb_mkstemp(pjob.filename);
2458 if (pjob.fd == -1) {
2459 if (errno == EACCES) {
2460 /* Common setup error, force a report. */
2461 DEBUG(0, ("print_job_start: insufficient permissions \
2462 to open spool file %s.\n", pjob.filename));
2463 } else {
2464 /* Normal case, report at level 3 and above. */
2465 DEBUG(3, ("print_job_start: can't open spool file %s,\n", pjob.filename));
2466 DEBUGADD(3, ("errno = %d (%s).\n", errno, strerror(errno)));
2468 goto fail;
2471 pjob_store(sharename, jobid, &pjob);
2473 /* Update the 'jobs changed' entry used by print_queue_status. */
2474 add_to_jobs_changed(pdb, jobid);
2476 /* Ensure we keep a rough count of the number of total jobs... */
2477 tdb_change_int32_atomic(pdb->tdb, "INFO/total_jobs", &njobs, 1);
2479 release_print_db(pdb);
2481 return jobid;
2483 fail:
2484 if (jobid != -1)
2485 pjob_delete(sharename, jobid);
2487 release_print_db(pdb);
2489 DEBUG(3, ("print_job_start: returning fail. Error = %s\n", strerror(errno) ));
2490 return (uint32)-1;
2493 /****************************************************************************
2494 Update the number of pages spooled to jobid
2495 ****************************************************************************/
2497 void print_job_endpage(int snum, uint32 jobid)
2499 const char* sharename = lp_const_servicename(snum);
2500 struct printjob *pjob;
2502 pjob = print_job_find(sharename, jobid);
2503 if (!pjob)
2504 return;
2505 /* don't allow another process to get this info - it is meaningless */
2506 if (pjob->pid != sys_getpid())
2507 return;
2509 pjob->page_count++;
2510 pjob_store(sharename, jobid, pjob);
2513 /****************************************************************************
2514 Print a file - called on closing the file. This spools the job.
2515 If normal close is false then we're tearing down the jobs - treat as an
2516 error.
2517 ****************************************************************************/
2519 bool print_job_end(int snum, uint32 jobid, enum file_close_type close_type)
2521 const char* sharename = lp_const_servicename(snum);
2522 struct printjob *pjob;
2523 int ret;
2524 SMB_STRUCT_STAT sbuf;
2525 struct printif *current_printif = get_printer_fns( snum );
2527 pjob = print_job_find(sharename, jobid);
2529 if (!pjob)
2530 return False;
2532 if (pjob->spooled || pjob->pid != sys_getpid())
2533 return False;
2535 if ((close_type == NORMAL_CLOSE || close_type == SHUTDOWN_CLOSE) &&
2536 (sys_fstat(pjob->fd, &sbuf) == 0)) {
2537 pjob->size = sbuf.st_size;
2538 close(pjob->fd);
2539 pjob->fd = -1;
2540 } else {
2543 * Not a normal close or we couldn't stat the job file,
2544 * so something has gone wrong. Cleanup.
2546 close(pjob->fd);
2547 pjob->fd = -1;
2548 DEBUG(3,("print_job_end: failed to stat file for jobid %d\n", jobid ));
2549 goto fail;
2552 /* Technically, this is not quite right. If the printer has a separator
2553 * page turned on, the NT spooler prints the separator page even if the
2554 * print job is 0 bytes. 010215 JRR */
2555 if (pjob->size == 0 || pjob->status == LPQ_DELETING) {
2556 /* don't bother spooling empty files or something being deleted. */
2557 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
2558 pjob->filename, pjob->size ? "deleted" : "zero length" ));
2559 unlink(pjob->filename);
2560 pjob_delete(sharename, jobid);
2561 return True;
2564 pjob->smbjob = jobid;
2566 ret = (*(current_printif->job_submit))(snum, pjob);
2568 if (ret)
2569 goto fail;
2571 /* The print job has been successfully handed over to the back-end */
2573 pjob->spooled = True;
2574 pjob->status = LPQ_QUEUED;
2575 pjob_store(sharename, jobid, pjob);
2577 /* make sure the database is up to date */
2578 if (print_cache_expired(lp_const_servicename(snum), True))
2579 print_queue_update(snum, False);
2581 return True;
2583 fail:
2585 /* The print job was not successfully started. Cleanup */
2586 /* Still need to add proper error return propagation! 010122:JRR */
2587 unlink(pjob->filename);
2588 pjob_delete(sharename, jobid);
2589 return False;
2592 /****************************************************************************
2593 Get a snapshot of jobs in the system without traversing.
2594 ****************************************************************************/
2596 static bool get_stored_queue_info(struct tdb_print_db *pdb, int snum, int *pcount, print_queue_struct **ppqueue)
2598 TDB_DATA data, cgdata;
2599 print_queue_struct *queue = NULL;
2600 uint32 qcount = 0;
2601 uint32 extra_count = 0;
2602 int total_count = 0;
2603 size_t len = 0;
2604 uint32 i;
2605 int max_reported_jobs = lp_max_reported_jobs(snum);
2606 bool ret = False;
2607 const char* sharename = lp_servicename(snum);
2609 /* make sure the database is up to date */
2610 if (print_cache_expired(lp_const_servicename(snum), True))
2611 print_queue_update(snum, False);
2613 *pcount = 0;
2614 *ppqueue = NULL;
2616 ZERO_STRUCT(data);
2617 ZERO_STRUCT(cgdata);
2619 /* Get the stored queue data. */
2620 data = tdb_fetch(pdb->tdb, string_tdb_data("INFO/linear_queue_array"));
2622 if (data.dptr && data.dsize >= sizeof(qcount))
2623 len += tdb_unpack(data.dptr + len, data.dsize - len, "d", &qcount);
2625 /* Get the changed jobs list. */
2626 cgdata = tdb_fetch(pdb->tdb, string_tdb_data("INFO/jobs_changed"));
2627 if (cgdata.dptr != NULL && (cgdata.dsize % 4 == 0))
2628 extra_count = cgdata.dsize/4;
2630 DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount, (unsigned int)extra_count));
2632 /* Allocate the queue size. */
2633 if (qcount == 0 && extra_count == 0)
2634 goto out;
2636 if ((queue = SMB_MALLOC_ARRAY(print_queue_struct, qcount + extra_count)) == NULL)
2637 goto out;
2639 /* Retrieve the linearised queue data. */
2641 for( i = 0; i < qcount; i++) {
2642 uint32 qjob, qsize, qpage_count, qstatus, qpriority, qtime;
2643 len += tdb_unpack(data.dptr + len, data.dsize - len, "ddddddff",
2644 &qjob,
2645 &qsize,
2646 &qpage_count,
2647 &qstatus,
2648 &qpriority,
2649 &qtime,
2650 queue[i].fs_user,
2651 queue[i].fs_file);
2652 queue[i].job = qjob;
2653 queue[i].size = qsize;
2654 queue[i].page_count = qpage_count;
2655 queue[i].status = qstatus;
2656 queue[i].priority = qpriority;
2657 queue[i].time = qtime;
2660 total_count = qcount;
2662 /* Add in the changed jobids. */
2663 for( i = 0; i < extra_count; i++) {
2664 uint32 jobid;
2665 struct printjob *pjob;
2667 jobid = IVAL(cgdata.dptr, i*4);
2668 DEBUG(5,("get_stored_queue_info: changed job = %u\n", (unsigned int)jobid));
2669 pjob = print_job_find(lp_const_servicename(snum), jobid);
2670 if (!pjob) {
2671 DEBUG(5,("get_stored_queue_info: failed to find changed job = %u\n", (unsigned int)jobid));
2672 remove_from_jobs_changed(sharename, jobid);
2673 continue;
2676 queue[total_count].job = jobid;
2677 queue[total_count].size = pjob->size;
2678 queue[total_count].page_count = pjob->page_count;
2679 queue[total_count].status = pjob->status;
2680 queue[total_count].priority = 1;
2681 queue[total_count].time = pjob->starttime;
2682 fstrcpy(queue[total_count].fs_user, pjob->user);
2683 fstrcpy(queue[total_count].fs_file, pjob->jobname);
2684 total_count++;
2687 /* Sort the queue by submission time otherwise they are displayed
2688 in hash order. */
2690 qsort(queue, total_count, sizeof(print_queue_struct), QSORT_CAST(printjob_comp));
2692 DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count));
2694 if (max_reported_jobs && total_count > max_reported_jobs)
2695 total_count = max_reported_jobs;
2697 *ppqueue = queue;
2698 *pcount = total_count;
2700 ret = True;
2702 out:
2704 SAFE_FREE(data.dptr);
2705 SAFE_FREE(cgdata.dptr);
2706 return ret;
2709 /****************************************************************************
2710 Get a printer queue listing.
2711 set queue = NULL and status = NULL if you just want to update the cache
2712 ****************************************************************************/
2714 int print_queue_status(int snum,
2715 print_queue_struct **ppqueue,
2716 print_status_struct *status)
2718 fstring keystr;
2719 TDB_DATA data, key;
2720 const char *sharename;
2721 struct tdb_print_db *pdb;
2722 int count = 0;
2724 /* make sure the database is up to date */
2726 if (print_cache_expired(lp_const_servicename(snum), True))
2727 print_queue_update(snum, False);
2729 /* return if we are done */
2730 if ( !ppqueue || !status )
2731 return 0;
2733 *ppqueue = NULL;
2734 sharename = lp_const_servicename(snum);
2735 pdb = get_print_db_byname(sharename);
2737 if (!pdb)
2738 return 0;
2741 * Fetch the queue status. We must do this first, as there may
2742 * be no jobs in the queue.
2745 ZERO_STRUCTP(status);
2746 slprintf(keystr, sizeof(keystr)-1, "STATUS/%s", sharename);
2747 key = string_tdb_data(keystr);
2749 data = tdb_fetch(pdb->tdb, key);
2750 if (data.dptr) {
2751 if (data.dsize == sizeof(*status)) {
2752 /* this memcpy is ok since the status struct was
2753 not packed before storing it in the tdb */
2754 memcpy(status, data.dptr, sizeof(*status));
2756 SAFE_FREE(data.dptr);
2760 * Now, fetch the print queue information. We first count the number
2761 * of entries, and then only retrieve the queue if necessary.
2764 if (!get_stored_queue_info(pdb, snum, &count, ppqueue)) {
2765 release_print_db(pdb);
2766 return 0;
2769 release_print_db(pdb);
2770 return count;
2773 /****************************************************************************
2774 Pause a queue.
2775 ****************************************************************************/
2777 bool print_queue_pause(struct current_user *user, int snum, WERROR *errcode)
2779 int ret;
2780 struct printif *current_printif = get_printer_fns( snum );
2782 if (!print_access_check(user, snum, PRINTER_ACCESS_ADMINISTER)) {
2783 *errcode = WERR_ACCESS_DENIED;
2784 return False;
2788 become_root();
2790 ret = (*(current_printif->queue_pause))(snum);
2792 unbecome_root();
2794 if (ret != 0) {
2795 *errcode = WERR_INVALID_PARAM;
2796 return False;
2799 /* force update the database */
2800 print_cache_flush(lp_const_servicename(snum));
2802 /* Send a printer notify message */
2804 notify_printer_status(snum, PRINTER_STATUS_PAUSED);
2806 return True;
2809 /****************************************************************************
2810 Resume a queue.
2811 ****************************************************************************/
2813 bool print_queue_resume(struct current_user *user, int snum, WERROR *errcode)
2815 int ret;
2816 struct printif *current_printif = get_printer_fns( snum );
2818 if (!print_access_check(user, snum, PRINTER_ACCESS_ADMINISTER)) {
2819 *errcode = WERR_ACCESS_DENIED;
2820 return False;
2823 become_root();
2825 ret = (*(current_printif->queue_resume))(snum);
2827 unbecome_root();
2829 if (ret != 0) {
2830 *errcode = WERR_INVALID_PARAM;
2831 return False;
2834 /* make sure the database is up to date */
2835 if (print_cache_expired(lp_const_servicename(snum), True))
2836 print_queue_update(snum, True);
2838 /* Send a printer notify message */
2840 notify_printer_status(snum, PRINTER_STATUS_OK);
2842 return True;
2845 /****************************************************************************
2846 Purge a queue - implemented by deleting all jobs that we can delete.
2847 ****************************************************************************/
2849 bool print_queue_purge(struct current_user *user, int snum, WERROR *errcode)
2851 print_queue_struct *queue;
2852 print_status_struct status;
2853 int njobs, i;
2854 bool can_job_admin;
2856 /* Force and update so the count is accurate (i.e. not a cached count) */
2857 print_queue_update(snum, True);
2859 can_job_admin = print_access_check(user, snum, JOB_ACCESS_ADMINISTER);
2860 njobs = print_queue_status(snum, &queue, &status);
2862 if ( can_job_admin )
2863 become_root();
2865 for (i=0;i<njobs;i++) {
2866 bool owner = is_owner(user, lp_const_servicename(snum), queue[i].job);
2868 if (owner || can_job_admin) {
2869 print_job_delete1(snum, queue[i].job);
2873 if ( can_job_admin )
2874 unbecome_root();
2876 /* update the cache */
2877 print_queue_update( snum, True );
2879 SAFE_FREE(queue);
2881 return True;