2 Unix SMB/Netbios implementation.
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 2 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, write to the Free Software
20 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
26 extern SIG_ATOMIC_T got_sig_term
;
27 extern SIG_ATOMIC_T reload_after_sighup
;
28 extern struct current_user current_user
;
29 extern userdom_struct current_user_info
;
31 /* Current printer interface */
32 static BOOL
remove_from_jobs_changed(const char* sharename
, uint32 jobid
);
35 the printing backend revolves around a tdb database that stores the
36 SMB view of the print queue
38 The key for this database is a jobid - a internally generated number that
39 uniquely identifies a print job
41 reading the print queue involves two steps:
42 - possibly running lpq and updating the internal database from that
43 - reading entries from the database
45 jobids are assigned when a job starts spooling.
48 static TDB_CONTEXT
*rap_tdb
;
49 static uint16 next_rap_jobid
;
50 struct rap_jobid_key
{
55 /***************************************************************************
56 Nightmare. LANMAN jobid's are 16 bit numbers..... We must map them to 32
57 bit RPC jobids.... JRA.
58 ***************************************************************************/
60 uint16
pjobid_to_rap(const char* sharename
, uint32 jobid
)
64 struct rap_jobid_key jinfo
;
67 DEBUG(10,("pjobid_to_rap: called.\n"));
70 /* Create the in-memory tdb. */
71 rap_tdb
= tdb_open_log(NULL
, 0, TDB_INTERNAL
, (O_RDWR
|O_CREAT
), 0644);
77 fstrcpy( jinfo
.sharename
, sharename
);
79 key
.dptr
= (uint8
*)&jinfo
;
80 key
.dsize
= sizeof(jinfo
);
82 data
= tdb_fetch(rap_tdb
, key
);
83 if (data
.dptr
&& data
.dsize
== sizeof(uint16
)) {
84 rap_jobid
= SVAL(data
.dptr
, 0);
86 DEBUG(10,("pjobid_to_rap: jobid %u maps to RAP jobid %u\n",
87 (unsigned int)jobid
, (unsigned int)rap_jobid
));
91 /* Not found - create and store mapping. */
92 rap_jobid
= ++next_rap_jobid
;
94 rap_jobid
= ++next_rap_jobid
;
95 SSVAL(buf
,0,rap_jobid
);
97 data
.dsize
= sizeof(rap_jobid
);
98 tdb_store(rap_tdb
, key
, data
, TDB_REPLACE
);
99 tdb_store(rap_tdb
, data
, key
, TDB_REPLACE
);
101 DEBUG(10,("pjobid_to_rap: created jobid %u maps to RAP jobid %u\n",
102 (unsigned int)jobid
, (unsigned int)rap_jobid
));
106 BOOL
rap_to_pjobid(uint16 rap_jobid
, fstring sharename
, uint32
*pjobid
)
111 DEBUG(10,("rap_to_pjobid called.\n"));
116 SSVAL(buf
,0,rap_jobid
);
118 key
.dsize
= sizeof(rap_jobid
);
119 data
= tdb_fetch(rap_tdb
, key
);
120 if ( data
.dptr
&& data
.dsize
== sizeof(struct rap_jobid_key
) )
122 struct rap_jobid_key
*jinfo
= (struct rap_jobid_key
*)data
.dptr
;
123 fstrcpy( sharename
, jinfo
->sharename
);
124 *pjobid
= jinfo
->jobid
;
125 DEBUG(10,("rap_to_pjobid: jobid %u maps to RAP jobid %u\n",
126 (unsigned int)*pjobid
, (unsigned int)rap_jobid
));
127 SAFE_FREE(data
.dptr
);
131 DEBUG(10,("rap_to_pjobid: Failed to lookup RAP jobid %u\n",
132 (unsigned int)rap_jobid
));
133 SAFE_FREE(data
.dptr
);
137 static void rap_jobid_delete(const char* sharename
, uint32 jobid
)
141 struct rap_jobid_key jinfo
;
144 DEBUG(10,("rap_jobid_delete: called.\n"));
149 ZERO_STRUCT( jinfo
);
150 fstrcpy( jinfo
.sharename
, sharename
);
152 key
.dptr
= (uint8
*)&jinfo
;
153 key
.dsize
= sizeof(jinfo
);
155 data
= tdb_fetch(rap_tdb
, key
);
156 if (!data
.dptr
|| (data
.dsize
!= sizeof(uint16
))) {
157 DEBUG(10,("rap_jobid_delete: cannot find jobid %u\n",
158 (unsigned int)jobid
));
159 SAFE_FREE(data
.dptr
);
163 DEBUG(10,("rap_jobid_delete: deleting jobid %u\n",
164 (unsigned int)jobid
));
166 rap_jobid
= SVAL(data
.dptr
, 0);
167 SAFE_FREE(data
.dptr
);
168 SSVAL(buf
,0,rap_jobid
);
170 data
.dsize
= sizeof(rap_jobid
);
171 tdb_delete(rap_tdb
, key
);
172 tdb_delete(rap_tdb
, data
);
175 static int get_queue_status(const char* sharename
, print_status_struct
*);
177 /****************************************************************************
178 Initialise the printing backend. Called once at startup before the fork().
179 ****************************************************************************/
181 BOOL
print_backend_init(void)
183 const char *sversion
= "INFO/version";
184 pstring printing_path
;
185 int services
= lp_numservices();
188 unlink(lock_path("printing.tdb"));
189 pstrcpy(printing_path
,lock_path("printing"));
190 mkdir(printing_path
,0755);
192 /* handle a Samba upgrade */
194 for (snum
= 0; snum
< services
; snum
++) {
195 struct tdb_print_db
*pdb
;
196 if (!lp_print_ok(snum
))
199 pdb
= get_print_db_byname(lp_const_servicename(snum
));
202 if (tdb_lock_bystring(pdb
->tdb
, sversion
) == -1) {
203 DEBUG(0,("print_backend_init: Failed to open printer %s database\n", lp_const_servicename(snum
) ));
204 release_print_db(pdb
);
207 if (tdb_fetch_int32(pdb
->tdb
, sversion
) != PRINT_DATABASE_VERSION
) {
208 tdb_traverse(pdb
->tdb
, tdb_traverse_delete_fn
, NULL
);
209 tdb_store_int32(pdb
->tdb
, sversion
, PRINT_DATABASE_VERSION
);
211 tdb_unlock_bystring(pdb
->tdb
, sversion
);
212 release_print_db(pdb
);
215 close_all_print_db(); /* Don't leave any open. */
217 /* do NT print initialization... */
218 return nt_printing_init();
221 /****************************************************************************
222 Shut down printing backend. Called once at shutdown to close the tdb.
223 ****************************************************************************/
225 void printing_end(void)
227 close_all_print_db(); /* Don't leave any open. */
230 /****************************************************************************
231 Retrieve the set of printing functions for a given service. This allows
232 us to set the printer function table based on the value of the 'printing'
235 Use the generic interface as the default and only use cups interface only
236 when asked for (and only when supported)
237 ****************************************************************************/
239 static struct printif
*get_printer_fns_from_type( enum printing_types type
)
241 struct printif
*printer_fns
= &generic_printif
;
244 if ( type
== PRINT_CUPS
) {
245 printer_fns
= &cups_printif
;
247 #endif /* HAVE_CUPS */
250 if ( type
== PRINT_IPRINT
) {
251 printer_fns
= &iprint_printif
;
253 #endif /* HAVE_IPRINT */
255 printer_fns
->type
= type
;
260 static struct printif
*get_printer_fns( int snum
)
262 return get_printer_fns_from_type( (enum printing_types
)lp_printing(snum
) );
266 /****************************************************************************
267 Useful function to generate a tdb key.
268 ****************************************************************************/
270 static TDB_DATA
print_key(uint32 jobid
)
276 ret
.dptr
= (uint8
*)&j
;
277 ret
.dsize
= sizeof(j
);
281 /***********************************************************************
282 unpack a pjob from a tdb buffer
283 ***********************************************************************/
285 int unpack_pjob( uint8
*buf
, int buflen
, struct printjob
*pjob
)
289 uint32 pjpid
, pjsysjob
, pjfd
, pjstarttime
, pjstatus
;
290 uint32 pjsize
, pjpage_count
, pjspooled
, pjsmbjob
;
295 len
+= tdb_unpack(buf
+len
, buflen
-len
, "dddddddddffff",
313 if ( (used
= unpack_devicemode(&pjob
->nt_devmode
, buf
+len
, buflen
-len
)) == -1 )
319 pjob
->sysjob
= pjsysjob
;
321 pjob
->starttime
= pjstarttime
;
322 pjob
->status
= pjstatus
;
324 pjob
->page_count
= pjpage_count
;
325 pjob
->spooled
= pjspooled
;
326 pjob
->smbjob
= pjsmbjob
;
332 /****************************************************************************
333 Useful function to find a print job in the database.
334 ****************************************************************************/
336 static struct printjob
*print_job_find(const char *sharename
, uint32 jobid
)
338 static struct printjob pjob
;
340 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
342 DEBUG(10,("print_job_find: looking up job %u for share %s\n",
343 (unsigned int)jobid
, sharename
));
349 ret
= tdb_fetch(pdb
->tdb
, print_key(jobid
));
350 release_print_db(pdb
);
353 DEBUG(10,("print_job_find: failed to find jobid %u.\n", (unsigned int)jobid
));
357 if ( pjob
.nt_devmode
) {
358 free_nt_devicemode( &pjob
.nt_devmode
);
363 if ( unpack_pjob( ret
.dptr
, ret
.dsize
, &pjob
) == -1 ) {
364 DEBUG(10,("print_job_find: failed to unpack jobid %u.\n", (unsigned int)jobid
));
371 DEBUG(10,("print_job_find: returning system job %d for jobid %u.\n",
372 (int)pjob
.sysjob
, (unsigned int)jobid
));
377 /* Convert a unix jobid to a smb jobid */
379 static uint32 sysjob_to_jobid_value
;
381 static int unixjob_traverse_fn(TDB_CONTEXT
*the_tdb
, TDB_DATA key
,
382 TDB_DATA data
, void *state
)
384 struct printjob
*pjob
;
385 int *sysjob
= (int *)state
;
387 if (!data
.dptr
|| data
.dsize
== 0)
390 pjob
= (struct printjob
*)data
.dptr
;
391 if (key
.dsize
!= sizeof(uint32
))
394 if (*sysjob
== pjob
->sysjob
) {
395 uint32 jobid
= IVAL(key
.dptr
,0);
397 sysjob_to_jobid_value
= jobid
;
404 /****************************************************************************
405 This is a *horribly expensive call as we have to iterate through all the
406 current printer tdb's. Don't do this often ! JRA.
407 ****************************************************************************/
409 uint32
sysjob_to_jobid(int unix_jobid
)
411 int services
= lp_numservices();
414 sysjob_to_jobid_value
= (uint32
)-1;
416 for (snum
= 0; snum
< services
; snum
++) {
417 struct tdb_print_db
*pdb
;
418 if (!lp_print_ok(snum
))
420 pdb
= get_print_db_byname(lp_const_servicename(snum
));
424 tdb_traverse(pdb
->tdb
, unixjob_traverse_fn
, &unix_jobid
);
425 release_print_db(pdb
);
426 if (sysjob_to_jobid_value
!= (uint32
)-1)
427 return sysjob_to_jobid_value
;
432 /****************************************************************************
433 Send notifications based on what has changed after a pjob_store.
434 ****************************************************************************/
438 uint32 spoolss_status
;
439 } lpq_to_spoolss_status_map
[] = {
440 { LPQ_QUEUED
, JOB_STATUS_QUEUED
},
441 { LPQ_PAUSED
, JOB_STATUS_PAUSED
},
442 { LPQ_SPOOLING
, JOB_STATUS_SPOOLING
},
443 { LPQ_PRINTING
, JOB_STATUS_PRINTING
},
444 { LPQ_DELETING
, JOB_STATUS_DELETING
},
445 { LPQ_OFFLINE
, JOB_STATUS_OFFLINE
},
446 { LPQ_PAPEROUT
, JOB_STATUS_PAPEROUT
},
447 { LPQ_PRINTED
, JOB_STATUS_PRINTED
},
448 { LPQ_DELETED
, JOB_STATUS_DELETED
},
449 { LPQ_BLOCKED
, JOB_STATUS_BLOCKED
},
450 { LPQ_USER_INTERVENTION
, JOB_STATUS_USER_INTERVENTION
},
454 /* Convert a lpq status value stored in printing.tdb into the
455 appropriate win32 API constant. */
457 static uint32
map_to_spoolss_status(uint32 lpq_status
)
461 while (lpq_to_spoolss_status_map
[i
].lpq_status
!= -1) {
462 if (lpq_to_spoolss_status_map
[i
].lpq_status
== lpq_status
)
463 return lpq_to_spoolss_status_map
[i
].spoolss_status
;
470 static void pjob_store_notify(const char* sharename
, uint32 jobid
, struct printjob
*old_data
,
471 struct printjob
*new_data
)
473 BOOL new_job
= False
;
478 /* Job attributes that can't be changed. We only send
479 notification for these on a new job. */
481 /* ACHTUNG! Due to a bug in Samba's spoolss parsing of the
482 NOTIFY_INFO_DATA buffer, we *have* to send the job submission
483 time first or else we'll end up with potential alignment
484 errors. I don't think the systemtime should be spooled as
485 a string, but this gets us around that error.
486 --jerry (i'll feel dirty for this) */
489 notify_job_submitted(sharename
, jobid
, new_data
->starttime
);
490 notify_job_username(sharename
, jobid
, new_data
->user
);
493 if (new_job
|| !strequal(old_data
->jobname
, new_data
->jobname
))
494 notify_job_name(sharename
, jobid
, new_data
->jobname
);
496 /* Job attributes of a new job or attributes that can be
499 if (new_job
|| !strequal(old_data
->jobname
, new_data
->jobname
))
500 notify_job_name(sharename
, jobid
, new_data
->jobname
);
502 if (new_job
|| old_data
->status
!= new_data
->status
)
503 notify_job_status(sharename
, jobid
, map_to_spoolss_status(new_data
->status
));
505 if (new_job
|| old_data
->size
!= new_data
->size
)
506 notify_job_total_bytes(sharename
, jobid
, new_data
->size
);
508 if (new_job
|| old_data
->page_count
!= new_data
->page_count
)
509 notify_job_total_pages(sharename
, jobid
, new_data
->page_count
);
512 /****************************************************************************
513 Store a job structure back to the database.
514 ****************************************************************************/
516 static BOOL
pjob_store(const char* sharename
, uint32 jobid
, struct printjob
*pjob
)
518 TDB_DATA old_data
, new_data
;
520 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
522 int len
, newlen
, buflen
;
530 old_data
= tdb_fetch(pdb
->tdb
, print_key(jobid
));
532 /* Doh! Now we have to pack/unpack data since the NT_DEVICEMODE was added */
539 len
+= tdb_pack(buf
+len
, buflen
-len
, "dddddddddffff",
541 (uint32
)pjob
->sysjob
,
543 (uint32
)pjob
->starttime
,
544 (uint32
)pjob
->status
,
546 (uint32
)pjob
->page_count
,
547 (uint32
)pjob
->spooled
,
548 (uint32
)pjob
->smbjob
,
554 len
+= pack_devicemode(pjob
->nt_devmode
, buf
+len
, buflen
-len
);
557 buf
= (uint8
*)SMB_REALLOC(buf
, len
);
559 DEBUG(0,("pjob_store: failed to enlarge buffer!\n"));
564 } while ( buflen
!= len
);
570 new_data
.dsize
= len
;
571 ret
= (tdb_store(pdb
->tdb
, print_key(jobid
), new_data
, TDB_REPLACE
) == 0);
573 release_print_db(pdb
);
575 /* Send notify updates for what has changed */
578 struct printjob old_pjob
;
580 if ( old_data
.dsize
)
582 if ( unpack_pjob( old_data
.dptr
, old_data
.dsize
, &old_pjob
) != -1 )
584 pjob_store_notify( sharename
, jobid
, &old_pjob
, pjob
);
585 free_nt_devicemode( &old_pjob
.nt_devmode
);
590 pjob_store_notify( sharename
, jobid
, NULL
, pjob
);
595 SAFE_FREE( old_data
.dptr
);
601 /****************************************************************************
602 Remove a job structure from the database.
603 ****************************************************************************/
605 void pjob_delete(const char* sharename
, uint32 jobid
)
607 struct printjob
*pjob
;
608 uint32 job_status
= 0;
609 struct tdb_print_db
*pdb
;
611 pdb
= get_print_db_byname( sharename
);
616 pjob
= print_job_find( sharename
, jobid
);
619 DEBUG(5, ("pjob_delete: we were asked to delete nonexistent job %u\n",
620 (unsigned int)jobid
));
621 release_print_db(pdb
);
625 /* We must cycle through JOB_STATUS_DELETING and
626 JOB_STATUS_DELETED for the port monitor to delete the job
629 job_status
= JOB_STATUS_DELETING
|JOB_STATUS_DELETED
;
630 notify_job_status(sharename
, jobid
, job_status
);
632 /* Remove from printing.tdb */
634 tdb_delete(pdb
->tdb
, print_key(jobid
));
635 remove_from_jobs_changed(sharename
, jobid
);
636 release_print_db( pdb
);
637 rap_jobid_delete(sharename
, jobid
);
640 /****************************************************************************
641 Parse a file name from the system spooler to generate a jobid.
642 ****************************************************************************/
644 static uint32
print_parse_jobid(char *fname
)
648 if (strncmp(fname
,PRINT_SPOOL_PREFIX
,strlen(PRINT_SPOOL_PREFIX
)) != 0)
650 fname
+= strlen(PRINT_SPOOL_PREFIX
);
656 return (uint32
)jobid
;
659 /****************************************************************************
660 List a unix job in the print database.
661 ****************************************************************************/
663 static void print_unix_job(const char *sharename
, print_queue_struct
*q
, uint32 jobid
)
665 struct printjob pj
, *old_pj
;
667 if (jobid
== (uint32
)-1)
668 jobid
= q
->job
+ UNIX_JOB_START
;
670 /* Preserve the timestamp on an existing unix print job */
672 old_pj
= print_job_find(sharename
, jobid
);
679 pj
.starttime
= old_pj
? old_pj
->starttime
: q
->time
;
680 pj
.status
= q
->status
;
683 fstrcpy(pj
.filename
, old_pj
? old_pj
->filename
: "");
684 if (jobid
< UNIX_JOB_START
) {
686 fstrcpy(pj
.jobname
, old_pj
? old_pj
->jobname
: "Remote Downlevel Document");
689 fstrcpy(pj
.jobname
, old_pj
? old_pj
->jobname
: q
->fs_file
);
691 fstrcpy(pj
.user
, old_pj
? old_pj
->user
: q
->fs_user
);
692 fstrcpy(pj
.queuename
, old_pj
? old_pj
->queuename
: sharename
);
694 pjob_store(sharename
, jobid
, &pj
);
698 struct traverse_struct
{
699 print_queue_struct
*queue
;
700 int qcount
, snum
, maxcount
, total_jobs
;
701 const char *sharename
;
703 const char *lprm_command
;
704 struct printif
*print_if
;
707 /****************************************************************************
708 Utility fn to delete any jobs that are no longer active.
709 ****************************************************************************/
711 static int traverse_fn_delete(TDB_CONTEXT
*t
, TDB_DATA key
, TDB_DATA data
, void *state
)
713 struct traverse_struct
*ts
= (struct traverse_struct
*)state
;
714 struct printjob pjob
;
718 if ( key
.dsize
!= sizeof(jobid
) )
721 jobid
= IVAL(key
.dptr
, 0);
722 if ( unpack_pjob( data
.dptr
, data
.dsize
, &pjob
) == -1 )
724 free_nt_devicemode( &pjob
.nt_devmode
);
728 /* remove a unix job if it isn't in the system queue any more */
730 for (i
=0;i
<ts
->qcount
;i
++) {
731 uint32 u_jobid
= (ts
->queue
[i
].job
+ UNIX_JOB_START
);
732 if (jobid
== u_jobid
)
735 if (i
== ts
->qcount
) {
736 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !smbjob\n",
737 (unsigned int)jobid
));
738 pjob_delete(ts
->sharename
, jobid
);
742 /* need to continue the the bottom of the function to
743 save the correct attributes */
746 /* maybe it hasn't been spooled yet */
748 /* if a job is not spooled and the process doesn't
749 exist then kill it. This cleans up after smbd
751 if (!process_exists_by_pid(pjob
.pid
)) {
752 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to !process_exists (%u)\n",
753 (unsigned int)jobid
, (unsigned int)pjob
.pid
));
754 pjob_delete(ts
->sharename
, jobid
);
760 /* this check only makes sense for jobs submitted from Windows clients */
763 for (i
=0;i
<ts
->qcount
;i
++) {
766 if ( pjob
.status
== LPQ_DELETED
)
769 curr_jobid
= print_parse_jobid(ts
->queue
[i
].fs_file
);
771 if (jobid
== curr_jobid
) {
773 /* try to clean up any jobs that need to be deleted */
775 if ( pjob
.status
== LPQ_DELETING
) {
778 result
= (*(ts
->print_if
->job_delete
))(
779 ts
->sharename
, ts
->lprm_command
, &pjob
);
782 /* if we can't delete, then reset the job status */
783 pjob
.status
= LPQ_QUEUED
;
784 pjob_store(ts
->sharename
, jobid
, &pjob
);
787 /* if we deleted the job, the remove the tdb record */
788 pjob_delete(ts
->sharename
, jobid
);
789 pjob
.status
= LPQ_DELETED
;
799 /* The job isn't in the system queue - we have to assume it has
800 completed, so delete the database entry. */
802 if (i
== ts
->qcount
) {
804 /* A race can occur between the time a job is spooled and
805 when it appears in the lpq output. This happens when
806 the job is added to printing.tdb when another smbd
807 running print_queue_update() has completed a lpq and
808 is currently traversing the printing tdb and deleting jobs.
809 Don't delete the job if it was submitted after the lpq_time. */
811 if (pjob
.starttime
< ts
->lpq_time
) {
812 DEBUG(10,("traverse_fn_delete: pjob %u deleted due to pjob.starttime (%u) < ts->lpq_time (%u)\n",
814 (unsigned int)pjob
.starttime
,
815 (unsigned int)ts
->lpq_time
));
816 pjob_delete(ts
->sharename
, jobid
);
822 /* Save the pjob attributes we will store.
823 FIXME!!! This is the only place where queue->job
824 represents the SMB jobid --jerry */
826 ts
->queue
[i
].job
= jobid
;
827 ts
->queue
[i
].size
= pjob
.size
;
828 ts
->queue
[i
].page_count
= pjob
.page_count
;
829 ts
->queue
[i
].status
= pjob
.status
;
830 ts
->queue
[i
].priority
= 1;
831 ts
->queue
[i
].time
= pjob
.starttime
;
832 fstrcpy(ts
->queue
[i
].fs_user
, pjob
.user
);
833 fstrcpy(ts
->queue
[i
].fs_file
, pjob
.jobname
);
840 /****************************************************************************
841 Check if the print queue has been updated recently enough.
842 ****************************************************************************/
844 static void print_cache_flush(const char *sharename
)
847 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
851 slprintf(key
, sizeof(key
)-1, "CACHE/%s", sharename
);
852 tdb_store_int32(pdb
->tdb
, key
, -1);
853 release_print_db(pdb
);
856 /****************************************************************************
857 Check if someone already thinks they are doing the update.
858 ****************************************************************************/
860 static pid_t
get_updating_pid(const char *sharename
)
865 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
869 slprintf(keystr
, sizeof(keystr
)-1, "UPDATING/%s", sharename
);
870 key
= string_tdb_data(keystr
);
872 data
= tdb_fetch(pdb
->tdb
, key
);
873 release_print_db(pdb
);
874 if (!data
.dptr
|| data
.dsize
!= sizeof(pid_t
)) {
875 SAFE_FREE(data
.dptr
);
879 updating_pid
= IVAL(data
.dptr
, 0);
880 SAFE_FREE(data
.dptr
);
882 if (process_exists_by_pid(updating_pid
))
888 /****************************************************************************
889 Set the fact that we're doing the update, or have finished doing the update
891 ****************************************************************************/
893 static void set_updating_pid(const fstring sharename
, BOOL updating
)
898 pid_t updating_pid
= sys_getpid();
901 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
906 slprintf(keystr
, sizeof(keystr
)-1, "UPDATING/%s", sharename
);
907 key
= string_tdb_data(keystr
);
909 DEBUG(5, ("set_updating_pid: %s updating lpq cache for print share %s\n",
910 updating
? "" : "not ",
914 tdb_delete(pdb
->tdb
, key
);
915 release_print_db(pdb
);
919 SIVAL( buffer
, 0, updating_pid
);
921 data
.dsize
= 4; /* we always assume this is a 4 byte value */
923 tdb_store(pdb
->tdb
, key
, data
, TDB_REPLACE
);
924 release_print_db(pdb
);
927 /****************************************************************************
928 Sort print jobs by submittal time.
929 ****************************************************************************/
931 static int printjob_comp(print_queue_struct
*j1
, print_queue_struct
*j2
)
942 /* Sort on job start time */
944 if (j1
->time
== j2
->time
)
946 return (j1
->time
> j2
->time
) ? 1 : -1;
949 /****************************************************************************
950 Store the sorted queue representation for later portmon retrieval.
952 ****************************************************************************/
954 static void store_queue_struct(struct tdb_print_db
*pdb
, struct traverse_struct
*pts
)
957 int max_reported_jobs
= lp_max_reported_jobs(pts
->snum
);
958 print_queue_struct
*queue
= pts
->queue
;
963 if (max_reported_jobs
&& (max_reported_jobs
< pts
->qcount
))
964 pts
->qcount
= max_reported_jobs
;
967 /* Work out the size. */
969 data
.dsize
+= tdb_pack(NULL
, 0, "d", qcount
);
971 for (i
= 0; i
< pts
->qcount
; i
++) {
972 if ( queue
[i
].status
== LPQ_DELETED
)
976 data
.dsize
+= tdb_pack(NULL
, 0, "ddddddff",
977 (uint32
)queue
[i
].job
,
978 (uint32
)queue
[i
].size
,
979 (uint32
)queue
[i
].page_count
,
980 (uint32
)queue
[i
].status
,
981 (uint32
)queue
[i
].priority
,
982 (uint32
)queue
[i
].time
,
987 if ((data
.dptr
= (uint8
*)SMB_MALLOC(data
.dsize
)) == NULL
)
991 len
+= tdb_pack(data
.dptr
+ len
, data
.dsize
- len
, "d", qcount
);
992 for (i
= 0; i
< pts
->qcount
; i
++) {
993 if ( queue
[i
].status
== LPQ_DELETED
)
996 len
+= tdb_pack(data
.dptr
+ len
, data
.dsize
- len
, "ddddddff",
997 (uint32
)queue
[i
].job
,
998 (uint32
)queue
[i
].size
,
999 (uint32
)queue
[i
].page_count
,
1000 (uint32
)queue
[i
].status
,
1001 (uint32
)queue
[i
].priority
,
1002 (uint32
)queue
[i
].time
,
1007 tdb_store(pdb
->tdb
, string_tdb_data("INFO/linear_queue_array"), data
,
1009 SAFE_FREE(data
.dptr
);
1013 static TDB_DATA
get_jobs_changed_data(struct tdb_print_db
*pdb
)
1019 data
= tdb_fetch(pdb
->tdb
, string_tdb_data("INFO/jobs_changed"));
1020 if (data
.dptr
== NULL
|| data
.dsize
== 0 || (data
.dsize
% 4 != 0)) {
1021 SAFE_FREE(data
.dptr
);
1028 static void check_job_changed(const char *sharename
, TDB_DATA data
, uint32 jobid
)
1031 unsigned int job_count
= data
.dsize
/ 4;
1033 for (i
= 0; i
< job_count
; i
++) {
1036 ch_jobid
= IVAL(data
.dptr
, i
*4);
1037 if (ch_jobid
== jobid
)
1038 remove_from_jobs_changed(sharename
, jobid
);
1042 /****************************************************************************
1043 Check if the print queue has been updated recently enough.
1044 ****************************************************************************/
1046 static BOOL
print_cache_expired(const char *sharename
, BOOL check_pending
)
1049 time_t last_qscan_time
, time_now
= time(NULL
);
1050 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
1051 BOOL result
= False
;
1056 snprintf(key
, sizeof(key
), "CACHE/%s", sharename
);
1057 last_qscan_time
= (time_t)tdb_fetch_int32(pdb
->tdb
, key
);
1060 * Invalidate the queue for 3 reasons.
1061 * (1). last queue scan time == -1.
1062 * (2). Current time - last queue scan time > allowed cache time.
1063 * (3). last queue scan time > current time + MAX_CACHE_VALID_TIME (1 hour by default).
1064 * This last test picks up machines for which the clock has been moved
1065 * forward, an lpq scan done and then the clock moved back. Otherwise
1066 * that last lpq scan would stay around for a loooong loooong time... :-). JRA.
1069 if (last_qscan_time
== ((time_t)-1)
1070 || (time_now
- last_qscan_time
) >= lp_lpqcachetime()
1071 || last_qscan_time
> (time_now
+ MAX_CACHE_VALID_TIME
))
1074 time_t msg_pending_time
;
1076 DEBUG(4, ("print_cache_expired: cache expired for queue %s "
1077 "(last_qscan_time = %d, time now = %d, qcachetime = %d)\n",
1078 sharename
, (int)last_qscan_time
, (int)time_now
,
1079 (int)lp_lpqcachetime() ));
1081 /* check if another smbd has already sent a message to update the
1082 queue. Give the pending message one minute to clear and
1083 then send another message anyways. Make sure to check for
1084 clocks that have been run forward and then back again. */
1086 snprintf(key
, sizeof(key
), "MSG_PENDING/%s", sharename
);
1089 && tdb_fetch_uint32( pdb
->tdb
, key
, &u
)
1090 && (msg_pending_time
=u
) > 0
1091 && msg_pending_time
<= time_now
1092 && (time_now
- msg_pending_time
) < 60 )
1094 DEBUG(4,("print_cache_expired: message already pending for %s. Accepting cache\n",
1103 release_print_db(pdb
);
1107 /****************************************************************************
1108 main work for updating the lpq cahe for a printer queue
1109 ****************************************************************************/
1111 static void print_queue_update_internal( const char *sharename
,
1112 struct printif
*current_printif
,
1113 char *lpq_command
, char *lprm_command
)
1116 print_queue_struct
*queue
= NULL
;
1117 print_status_struct status
;
1118 print_status_struct old_status
;
1119 struct printjob
*pjob
;
1120 struct traverse_struct tstruct
;
1123 fstring keystr
, cachestr
;
1124 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
1130 DEBUG(5,("print_queue_update_internal: printer = %s, type = %d, lpq command = [%s]\n",
1131 sharename
, current_printif
->type
, lpq_command
));
1134 * Update the cache time FIRST ! Stops others even
1135 * attempting to get the lock and doing this
1136 * if the lpq takes a long time.
1139 slprintf(cachestr
, sizeof(cachestr
)-1, "CACHE/%s", sharename
);
1140 tdb_store_int32(pdb
->tdb
, cachestr
, (int)time(NULL
));
1142 /* get the current queue using the appropriate interface */
1143 ZERO_STRUCT(status
);
1145 qcount
= (*(current_printif
->queue_get
))(sharename
,
1146 current_printif
->type
,
1147 lpq_command
, &queue
, &status
);
1149 DEBUG(3, ("print_queue_update_internal: %d job%s in queue for %s\n",
1150 qcount
, (qcount
!= 1) ? "s" : "", sharename
));
1152 /* Sort the queue by submission time otherwise they are displayed
1155 qsort(queue
, qcount
, sizeof(print_queue_struct
),
1156 QSORT_CAST(printjob_comp
));
1159 any job in the internal database that is marked as spooled
1160 and doesn't exist in the system queue is considered finished
1161 and removed from the database
1163 any job in the system database but not in the internal database
1164 is added as a unix job
1166 fill in any system job numbers as we go
1169 jcdata
= get_jobs_changed_data(pdb
);
1171 for (i
=0; i
<qcount
; i
++) {
1172 uint32 jobid
= print_parse_jobid(queue
[i
].fs_file
);
1174 if (jobid
== (uint32
)-1) {
1175 /* assume its a unix print job */
1176 print_unix_job(sharename
, &queue
[i
], jobid
);
1180 /* we have an active SMB print job - update its status */
1181 pjob
= print_job_find(sharename
, jobid
);
1183 /* err, somethings wrong. Probably smbd was restarted
1184 with jobs in the queue. All we can do is treat them
1185 like unix jobs. Pity. */
1186 print_unix_job(sharename
, &queue
[i
], jobid
);
1190 pjob
->sysjob
= queue
[i
].job
;
1192 /* don't reset the status on jobs to be deleted */
1194 if ( pjob
->status
!= LPQ_DELETING
)
1195 pjob
->status
= queue
[i
].status
;
1197 pjob_store(sharename
, jobid
, pjob
);
1199 check_job_changed(sharename
, jcdata
, jobid
);
1202 SAFE_FREE(jcdata
.dptr
);
1204 /* now delete any queued entries that don't appear in the
1206 tstruct
.queue
= queue
;
1207 tstruct
.qcount
= qcount
;
1209 tstruct
.total_jobs
= 0;
1210 tstruct
.lpq_time
= time(NULL
);
1211 tstruct
.sharename
= sharename
;
1212 tstruct
.lprm_command
= lprm_command
;
1213 tstruct
.print_if
= current_printif
;
1215 tdb_traverse(pdb
->tdb
, traverse_fn_delete
, (void *)&tstruct
);
1217 /* Store the linearised queue, max jobs only. */
1218 store_queue_struct(pdb
, &tstruct
);
1220 SAFE_FREE(tstruct
.queue
);
1222 DEBUG(10,("print_queue_update_internal: printer %s INFO/total_jobs = %d\n",
1223 sharename
, tstruct
.total_jobs
));
1225 tdb_store_int32(pdb
->tdb
, "INFO/total_jobs", tstruct
.total_jobs
);
1227 get_queue_status(sharename
, &old_status
);
1228 if (old_status
.qcount
!= qcount
)
1229 DEBUG(10,("print_queue_update_internal: queue status change %d jobs -> %d jobs for printer %s\n",
1230 old_status
.qcount
, qcount
, sharename
));
1232 /* store the new queue status structure */
1233 slprintf(keystr
, sizeof(keystr
)-1, "STATUS/%s", sharename
);
1234 key
= string_tdb_data(keystr
);
1236 status
.qcount
= qcount
;
1237 data
.dptr
= (uint8
*)&status
;
1238 data
.dsize
= sizeof(status
);
1239 tdb_store(pdb
->tdb
, key
, data
, TDB_REPLACE
);
1242 * Update the cache time again. We want to do this call
1243 * as little as possible...
1246 slprintf(keystr
, sizeof(keystr
)-1, "CACHE/%s", sharename
);
1247 tdb_store_int32(pdb
->tdb
, keystr
, (int32
)time(NULL
));
1249 /* clear the msg pending record for this queue */
1251 snprintf(keystr
, sizeof(keystr
), "MSG_PENDING/%s", sharename
);
1253 if ( !tdb_store_uint32( pdb
->tdb
, keystr
, 0 ) ) {
1254 /* log a message but continue on */
1256 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1260 release_print_db( pdb
);
1265 /****************************************************************************
1266 Update the internal database from the system print queue for a queue.
1267 obtain a lock on the print queue before proceeding (needed when mutiple
1268 smbd processes maytry to update the lpq cache concurrently).
1269 ****************************************************************************/
1271 static void print_queue_update_with_lock( const char *sharename
,
1272 struct printif
*current_printif
,
1273 char *lpq_command
, char *lprm_command
)
1276 struct tdb_print_db
*pdb
;
1278 DEBUG(5,("print_queue_update_with_lock: printer share = %s\n", sharename
));
1279 pdb
= get_print_db_byname(sharename
);
1283 if ( !print_cache_expired(sharename
, False
) ) {
1284 DEBUG(5,("print_queue_update_with_lock: print cache for %s is still ok\n", sharename
));
1285 release_print_db(pdb
);
1290 * Check to see if someone else is doing this update.
1291 * This is essentially a mutex on the update.
1294 if (get_updating_pid(sharename
) != -1) {
1295 release_print_db(pdb
);
1299 /* Lock the queue for the database update */
1301 slprintf(keystr
, sizeof(keystr
) - 1, "LOCK/%s", sharename
);
1302 /* Only wait 10 seconds for this. */
1303 if (tdb_lock_bystring_with_timeout(pdb
->tdb
, keystr
, 10) == -1) {
1304 DEBUG(0,("print_queue_update_with_lock: Failed to lock printer %s database\n", sharename
));
1305 release_print_db(pdb
);
1310 * Ensure that no one else got in here.
1311 * If the updating pid is still -1 then we are
1315 if (get_updating_pid(sharename
) != -1) {
1317 * Someone else is doing the update, exit.
1319 tdb_unlock_bystring(pdb
->tdb
, keystr
);
1320 release_print_db(pdb
);
1325 * We're going to do the update ourselves.
1328 /* Tell others we're doing the update. */
1329 set_updating_pid(sharename
, True
);
1332 * Allow others to enter and notice we're doing
1336 tdb_unlock_bystring(pdb
->tdb
, keystr
);
1338 /* do the main work now */
1340 print_queue_update_internal( sharename
, current_printif
,
1341 lpq_command
, lprm_command
);
1343 /* Delete our pid from the db. */
1344 set_updating_pid(sharename
, False
);
1345 release_print_db(pdb
);
1348 /****************************************************************************
1349 this is the receive function of the background lpq updater
1350 ****************************************************************************/
1351 static void print_queue_receive(int msg_type
, struct server_id src
,
1352 void *buf
, size_t msglen
,
1356 pstring lpqcommand
, lprmcommand
;
1360 len
= tdb_unpack( (uint8
*)buf
, msglen
, "fdPP",
1367 DEBUG(0,("print_queue_receive: Got invalid print queue update message\n"));
1371 print_queue_update_with_lock(sharename
,
1372 get_printer_fns_from_type((enum printing_types
)printing_type
),
1373 lpqcommand
, lprmcommand
);
1378 static pid_t background_lpq_updater_pid
= -1;
1380 /****************************************************************************
1381 main thread of the background lpq updater
1382 ****************************************************************************/
1383 void start_background_queue(void)
1385 DEBUG(3,("start_background_queue: Starting background LPQ thread\n"));
1386 background_lpq_updater_pid
= sys_fork();
1388 if (background_lpq_updater_pid
== -1) {
1389 DEBUG(5,("start_background_queue: background LPQ thread failed to start. %s\n", strerror(errno
) ));
1393 if(background_lpq_updater_pid
== 0) {
1395 DEBUG(5,("start_background_queue: background LPQ thread started\n"));
1397 claim_connection( NULL
, "smbd lpq backend", 0, False
,
1398 FLAG_MSG_GENERAL
|FLAG_MSG_SMBD
|FLAG_MSG_PRINT_GENERAL
);
1400 if (!locking_init(0)) {
1404 message_register(MSG_PRINTER_UPDATE
, print_queue_receive
,
1407 DEBUG(5,("start_background_queue: background LPQ thread waiting for messages\n"));
1411 /* check for some essential signals first */
1414 exit_server_cleanly(NULL
);
1417 if (reload_after_sighup
) {
1418 change_to_root_user();
1419 DEBUG(1,("Reloading services after SIGHUP\n"));
1420 reload_services(False
);
1421 reload_after_sighup
= 0;
1424 /* now check for messages */
1426 DEBUG(10,("start_background_queue: background LPQ thread got a message\n"));
1429 /* process any pending print change notify messages */
1431 print_notify_send_messages(smbd_messaging_context(),
1437 /****************************************************************************
1438 update the internal database from the system print queue for a queue
1439 ****************************************************************************/
1441 static void print_queue_update(int snum
, BOOL force
)
1445 pstring lpqcommand
, lprmcommand
;
1446 uint8
*buffer
= NULL
;
1449 struct tdb_print_db
*pdb
;
1451 struct printif
*current_printif
;
1453 fstrcpy( sharename
, lp_const_servicename(snum
));
1455 /* don't strip out characters like '$' from the printername */
1457 pstrcpy( lpqcommand
, lp_lpqcommand(snum
));
1458 string_sub2( lpqcommand
, "%p", PRINTERNAME(snum
), sizeof(lpqcommand
),
1459 False
, False
, False
);
1460 standard_sub_advanced(lp_servicename(snum
),
1461 current_user_info
.unix_name
, "",
1462 current_user
.ut
.gid
,
1463 get_current_username(),
1464 current_user_info
.domain
,
1465 lpqcommand
, sizeof(lpqcommand
) );
1467 pstrcpy( lprmcommand
, lp_lprmcommand(snum
));
1468 string_sub2( lprmcommand
, "%p", PRINTERNAME(snum
), sizeof(lprmcommand
),
1469 False
, False
, False
);
1470 standard_sub_advanced(lp_servicename(snum
),
1471 current_user_info
.unix_name
, "",
1472 current_user
.ut
.gid
,
1473 get_current_username(),
1474 current_user_info
.domain
,
1475 lprmcommand
, sizeof(lprmcommand
) );
1478 * Make sure that the background queue process exists.
1479 * Otherwise just do the update ourselves
1482 if ( force
|| background_lpq_updater_pid
== -1 ) {
1483 DEBUG(4,("print_queue_update: updating queue [%s] myself\n", sharename
));
1484 current_printif
= get_printer_fns( snum
);
1485 print_queue_update_with_lock( sharename
, current_printif
, lpqcommand
, lprmcommand
);
1490 type
= lp_printing(snum
);
1492 /* get the length */
1494 len
= tdb_pack( NULL
, 0, "fdPP",
1500 buffer
= SMB_XMALLOC_ARRAY( uint8
, len
);
1502 /* now pack the buffer */
1503 newlen
= tdb_pack( buffer
, len
, "fdPP",
1509 SMB_ASSERT( newlen
== len
);
1511 DEBUG(10,("print_queue_update: Sending message -> printer = %s, "
1512 "type = %d, lpq command = [%s] lprm command = [%s]\n",
1513 sharename
, type
, lpqcommand
, lprmcommand
));
1515 /* here we set a msg pending record for other smbd processes
1516 to throttle the number of duplicate print_queue_update msgs
1519 pdb
= get_print_db_byname(sharename
);
1525 snprintf(key
, sizeof(key
), "MSG_PENDING/%s", sharename
);
1527 if ( !tdb_store_uint32( pdb
->tdb
, key
, time(NULL
) ) ) {
1528 /* log a message but continue on */
1530 DEBUG(0,("print_queue_update: failed to store MSG_PENDING flag for [%s]!\n",
1534 release_print_db( pdb
);
1536 /* finally send the message */
1538 message_send_pid(pid_to_procid(background_lpq_updater_pid
),
1539 MSG_PRINTER_UPDATE
, buffer
, len
, False
);
1541 SAFE_FREE( buffer
);
1546 /****************************************************************************
1547 Create/Update an entry in the print tdb that will allow us to send notify
1548 updates only to interested smbd's.
1549 ****************************************************************************/
1551 BOOL
print_notify_register_pid(int snum
)
1554 struct tdb_print_db
*pdb
= NULL
;
1555 TDB_CONTEXT
*tdb
= NULL
;
1556 const char *printername
;
1557 uint32 mypid
= (uint32
)sys_getpid();
1561 /* if (snum == -1), then the change notify request was
1562 on a print server handle and we need to register on
1567 int num_services
= lp_numservices();
1570 for ( idx
=0; idx
<num_services
; idx
++ ) {
1571 if (lp_snum_ok(idx
) && lp_print_ok(idx
) )
1572 print_notify_register_pid(idx
);
1577 else /* register for a specific printer */
1579 printername
= lp_const_servicename(snum
);
1580 pdb
= get_print_db_byname(printername
);
1586 if (tdb_lock_bystring_with_timeout(tdb
, NOTIFY_PID_LIST_KEY
, 10) == -1) {
1587 DEBUG(0,("print_notify_register_pid: Failed to lock printer %s\n",
1590 release_print_db(pdb
);
1594 data
= get_printer_notify_pid_list( tdb
, printername
, True
);
1596 /* Add ourselves and increase the refcount. */
1598 for (i
= 0; i
< data
.dsize
; i
+= 8) {
1599 if (IVAL(data
.dptr
,i
) == mypid
) {
1600 uint32 new_refcount
= IVAL(data
.dptr
, i
+4) + 1;
1601 SIVAL(data
.dptr
, i
+4, new_refcount
);
1606 if (i
== data
.dsize
) {
1607 /* We weren't in the list. Realloc. */
1608 data
.dptr
= (uint8
*)SMB_REALLOC(data
.dptr
, data
.dsize
+ 8);
1610 DEBUG(0,("print_notify_register_pid: Relloc fail for printer %s\n",
1615 SIVAL(data
.dptr
,data
.dsize
- 8,mypid
);
1616 SIVAL(data
.dptr
,data
.dsize
- 4,1); /* Refcount. */
1619 /* Store back the record. */
1620 if (tdb_store_bystring(tdb
, NOTIFY_PID_LIST_KEY
, data
, TDB_REPLACE
) == -1) {
1621 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1622 list for printer %s\n", printername
));
1630 tdb_unlock_bystring(tdb
, NOTIFY_PID_LIST_KEY
);
1632 release_print_db(pdb
);
1633 SAFE_FREE(data
.dptr
);
1637 /****************************************************************************
1638 Update an entry in the print tdb that will allow us to send notify
1639 updates only to interested smbd's.
1640 ****************************************************************************/
1642 BOOL
print_notify_deregister_pid(int snum
)
1645 struct tdb_print_db
*pdb
= NULL
;
1646 TDB_CONTEXT
*tdb
= NULL
;
1647 const char *printername
;
1648 uint32 mypid
= (uint32
)sys_getpid();
1652 /* if ( snum == -1 ), we are deregister a print server handle
1653 which means to deregister on all print queues */
1657 int num_services
= lp_numservices();
1660 for ( idx
=0; idx
<num_services
; idx
++ ) {
1661 if ( lp_snum_ok(idx
) && lp_print_ok(idx
) )
1662 print_notify_deregister_pid(idx
);
1667 else /* deregister a specific printer */
1669 printername
= lp_const_servicename(snum
);
1670 pdb
= get_print_db_byname(printername
);
1676 if (tdb_lock_bystring_with_timeout(tdb
, NOTIFY_PID_LIST_KEY
, 10) == -1) {
1677 DEBUG(0,("print_notify_register_pid: Failed to lock \
1678 printer %s database\n", printername
));
1680 release_print_db(pdb
);
1684 data
= get_printer_notify_pid_list( tdb
, printername
, True
);
1686 /* Reduce refcount. Remove ourselves if zero. */
1688 for (i
= 0; i
< data
.dsize
; ) {
1689 if (IVAL(data
.dptr
,i
) == mypid
) {
1690 uint32 refcount
= IVAL(data
.dptr
, i
+4);
1694 if (refcount
== 0) {
1695 if (data
.dsize
- i
> 8)
1696 memmove( &data
.dptr
[i
], &data
.dptr
[i
+8], data
.dsize
- i
- 8);
1700 SIVAL(data
.dptr
, i
+4, refcount
);
1706 if (data
.dsize
== 0)
1707 SAFE_FREE(data
.dptr
);
1709 /* Store back the record. */
1710 if (tdb_store_bystring(tdb
, NOTIFY_PID_LIST_KEY
, data
, TDB_REPLACE
) == -1) {
1711 DEBUG(0,("print_notify_register_pid: Failed to update pid \
1712 list for printer %s\n", printername
));
1720 tdb_unlock_bystring(tdb
, NOTIFY_PID_LIST_KEY
);
1722 release_print_db(pdb
);
1723 SAFE_FREE(data
.dptr
);
1727 /****************************************************************************
1728 Check if a jobid is valid. It is valid if it exists in the database.
1729 ****************************************************************************/
1731 BOOL
print_job_exists(const char* sharename
, uint32 jobid
)
1733 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
1738 ret
= tdb_exists(pdb
->tdb
, print_key(jobid
));
1739 release_print_db(pdb
);
1743 /****************************************************************************
1744 Give the fd used for a jobid.
1745 ****************************************************************************/
1747 int print_job_fd(const char* sharename
, uint32 jobid
)
1749 struct printjob
*pjob
= print_job_find(sharename
, jobid
);
1752 /* don't allow another process to get this info - it is meaningless */
1753 if (pjob
->pid
!= sys_getpid())
1758 /****************************************************************************
1759 Give the filename used for a jobid.
1760 Only valid for the process doing the spooling and when the job
1761 has not been spooled.
1762 ****************************************************************************/
1764 char *print_job_fname(const char* sharename
, uint32 jobid
)
1766 struct printjob
*pjob
= print_job_find(sharename
, jobid
);
1767 if (!pjob
|| pjob
->spooled
|| pjob
->pid
!= sys_getpid())
1769 return pjob
->filename
;
1773 /****************************************************************************
1774 Give the filename used for a jobid.
1775 Only valid for the process doing the spooling and when the job
1776 has not been spooled.
1777 ****************************************************************************/
1779 NT_DEVICEMODE
*print_job_devmode(const char* sharename
, uint32 jobid
)
1781 struct printjob
*pjob
= print_job_find(sharename
, jobid
);
1786 return pjob
->nt_devmode
;
1789 /****************************************************************************
1790 Set the place in the queue for a job.
1791 ****************************************************************************/
1793 BOOL
print_job_set_place(const char *sharename
, uint32 jobid
, int place
)
1795 DEBUG(2,("print_job_set_place not implemented yet\n"));
1799 /****************************************************************************
1800 Set the name of a job. Only possible for owner.
1801 ****************************************************************************/
1803 BOOL
print_job_set_name(const char *sharename
, uint32 jobid
, char *name
)
1805 struct printjob
*pjob
;
1807 pjob
= print_job_find(sharename
, jobid
);
1808 if (!pjob
|| pjob
->pid
!= sys_getpid())
1811 fstrcpy(pjob
->jobname
, name
);
1812 return pjob_store(sharename
, jobid
, pjob
);
1815 /***************************************************************************
1816 Remove a jobid from the 'jobs changed' list.
1817 ***************************************************************************/
1819 static BOOL
remove_from_jobs_changed(const char* sharename
, uint32 jobid
)
1821 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
1823 size_t job_count
, i
;
1825 BOOL gotlock
= False
;
1833 key
= string_tdb_data("INFO/jobs_changed");
1835 if (tdb_chainlock_with_timeout(pdb
->tdb
, key
, 5) == -1)
1840 data
= tdb_fetch(pdb
->tdb
, key
);
1842 if (data
.dptr
== NULL
|| data
.dsize
== 0 || (data
.dsize
% 4 != 0))
1845 job_count
= data
.dsize
/ 4;
1846 for (i
= 0; i
< job_count
; i
++) {
1849 ch_jobid
= IVAL(data
.dptr
, i
*4);
1850 if (ch_jobid
== jobid
) {
1851 if (i
< job_count
-1 )
1852 memmove(data
.dptr
+ (i
*4), data
.dptr
+ (i
*4) + 4, (job_count
- i
- 1)*4 );
1854 if (tdb_store(pdb
->tdb
, key
, data
, TDB_REPLACE
) == -1)
1864 tdb_chainunlock(pdb
->tdb
, key
);
1865 SAFE_FREE(data
.dptr
);
1866 release_print_db(pdb
);
1868 DEBUG(10,("remove_from_jobs_changed: removed jobid %u\n", (unsigned int)jobid
));
1870 DEBUG(10,("remove_from_jobs_changed: Failed to remove jobid %u\n", (unsigned int)jobid
));
1874 /****************************************************************************
1875 Delete a print job - don't update queue.
1876 ****************************************************************************/
1878 static BOOL
print_job_delete1(int snum
, uint32 jobid
)
1880 const char* sharename
= lp_const_servicename(snum
);
1881 struct printjob
*pjob
= print_job_find(sharename
, jobid
);
1883 struct printif
*current_printif
= get_printer_fns( snum
);
1889 * If already deleting just return.
1892 if (pjob
->status
== LPQ_DELETING
)
1895 /* Hrm - we need to be able to cope with deleting a job before it
1896 has reached the spooler. Just mark it as LPQ_DELETING and
1897 let the print_queue_update() code rmeove the record */
1900 if (pjob
->sysjob
== -1) {
1901 DEBUG(5, ("attempt to delete job %u not seen by lpr\n", (unsigned int)jobid
));
1904 /* Set the tdb entry to be deleting. */
1906 pjob
->status
= LPQ_DELETING
;
1907 pjob_store(sharename
, jobid
, pjob
);
1909 if (pjob
->spooled
&& pjob
->sysjob
!= -1)
1911 result
= (*(current_printif
->job_delete
))(
1913 lp_lprmcommand(snum
),
1916 /* Delete the tdb entry if the delete succeeded or the job hasn't
1920 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
1925 pjob_delete(sharename
, jobid
);
1926 /* Ensure we keep a rough count of the number of total jobs... */
1927 tdb_change_int32_atomic(pdb
->tdb
, "INFO/total_jobs", &njobs
, -1);
1928 release_print_db(pdb
);
1932 remove_from_jobs_changed( sharename
, jobid
);
1934 return (result
== 0);
1937 /****************************************************************************
1938 Return true if the current user owns the print job.
1939 ****************************************************************************/
1941 static BOOL
is_owner(struct current_user
*user
, const char *servicename
,
1944 struct printjob
*pjob
= print_job_find(servicename
, jobid
);
1950 if ((vuser
= get_valid_user_struct(user
->vuid
)) != NULL
) {
1951 return strequal(pjob
->user
, vuser
->user
.smb_name
);
1953 return strequal(pjob
->user
, uidtoname(user
->ut
.uid
));
1957 /****************************************************************************
1959 ****************************************************************************/
1961 BOOL
print_job_delete(struct current_user
*user
, int snum
, uint32 jobid
, WERROR
*errcode
)
1963 const char* sharename
= lp_const_servicename( snum
);
1964 struct printjob
*pjob
;
1970 owner
= is_owner(user
, lp_const_servicename(snum
), jobid
);
1972 /* Check access against security descriptor or whether the user
1976 !print_access_check(user
, snum
, JOB_ACCESS_ADMINISTER
)) {
1977 DEBUG(3, ("delete denied by security descriptor\n"));
1978 *errcode
= WERR_ACCESS_DENIED
;
1980 /* BEGIN_ADMIN_LOG */
1981 sys_adminlog( LOG_ERR
,
1982 "Permission denied-- user not allowed to delete, \
1983 pause, or resume print job. User name: %s. Printer name: %s.",
1984 uidtoname(user
->ut
.uid
), PRINTERNAME(snum
) );
1991 * get the spooled filename of the print job
1992 * if this works, then the file has not been spooled
1993 * to the underlying print system. Just delete the
1994 * spool file & return.
1997 if ( (fname
= print_job_fname( sharename
, jobid
)) != NULL
)
1999 /* remove the spool file */
2000 DEBUG(10,("print_job_delete: Removing spool file [%s]\n", fname
));
2001 if ( unlink( fname
) == -1 ) {
2002 *errcode
= map_werror_from_unix(errno
);
2007 if (!print_job_delete1(snum
, jobid
)) {
2008 *errcode
= WERR_ACCESS_DENIED
;
2012 /* force update the database and say the delete failed if the
2015 print_queue_update(snum
, True
);
2017 pjob
= print_job_find(sharename
, jobid
);
2018 if ( pjob
&& (pjob
->status
!= LPQ_DELETING
) )
2019 *errcode
= WERR_ACCESS_DENIED
;
2021 return (pjob
== NULL
);
2024 /****************************************************************************
2026 ****************************************************************************/
2028 BOOL
print_job_pause(struct current_user
*user
, int snum
, uint32 jobid
, WERROR
*errcode
)
2030 const char* sharename
= lp_const_servicename(snum
);
2031 struct printjob
*pjob
;
2033 struct printif
*current_printif
= get_printer_fns( snum
);
2035 pjob
= print_job_find(sharename
, jobid
);
2037 if (!pjob
|| !user
) {
2038 DEBUG(10, ("print_job_pause: no pjob or user for jobid %u\n",
2039 (unsigned int)jobid
));
2043 if (!pjob
->spooled
|| pjob
->sysjob
== -1) {
2044 DEBUG(10, ("print_job_pause: not spooled or bad sysjob = %d for jobid %u\n",
2045 (int)pjob
->sysjob
, (unsigned int)jobid
));
2049 if (!is_owner(user
, lp_const_servicename(snum
), jobid
) &&
2050 !print_access_check(user
, snum
, JOB_ACCESS_ADMINISTER
)) {
2051 DEBUG(3, ("pause denied by security descriptor\n"));
2053 /* BEGIN_ADMIN_LOG */
2054 sys_adminlog( LOG_ERR
,
2055 "Permission denied-- user not allowed to delete, \
2056 pause, or resume print job. User name: %s. Printer name: %s.",
2057 uidtoname(user
->ut
.uid
), PRINTERNAME(snum
) );
2060 *errcode
= WERR_ACCESS_DENIED
;
2064 /* need to pause the spooled entry */
2065 ret
= (*(current_printif
->job_pause
))(snum
, pjob
);
2068 *errcode
= WERR_INVALID_PARAM
;
2072 /* force update the database */
2073 print_cache_flush(lp_const_servicename(snum
));
2075 /* Send a printer notify message */
2077 notify_job_status(sharename
, jobid
, JOB_STATUS_PAUSED
);
2079 /* how do we tell if this succeeded? */
2084 /****************************************************************************
2086 ****************************************************************************/
2088 BOOL
print_job_resume(struct current_user
*user
, int snum
, uint32 jobid
, WERROR
*errcode
)
2090 const char *sharename
= lp_const_servicename(snum
);
2091 struct printjob
*pjob
;
2093 struct printif
*current_printif
= get_printer_fns( snum
);
2095 pjob
= print_job_find(sharename
, jobid
);
2097 if (!pjob
|| !user
) {
2098 DEBUG(10, ("print_job_resume: no pjob or user for jobid %u\n",
2099 (unsigned int)jobid
));
2103 if (!pjob
->spooled
|| pjob
->sysjob
== -1) {
2104 DEBUG(10, ("print_job_resume: not spooled or bad sysjob = %d for jobid %u\n",
2105 (int)pjob
->sysjob
, (unsigned int)jobid
));
2109 if (!is_owner(user
, lp_const_servicename(snum
), jobid
) &&
2110 !print_access_check(user
, snum
, JOB_ACCESS_ADMINISTER
)) {
2111 DEBUG(3, ("resume denied by security descriptor\n"));
2112 *errcode
= WERR_ACCESS_DENIED
;
2114 /* BEGIN_ADMIN_LOG */
2115 sys_adminlog( LOG_ERR
,
2116 "Permission denied-- user not allowed to delete, \
2117 pause, or resume print job. User name: %s. Printer name: %s.",
2118 uidtoname(user
->ut
.uid
), PRINTERNAME(snum
) );
2123 ret
= (*(current_printif
->job_resume
))(snum
, pjob
);
2126 *errcode
= WERR_INVALID_PARAM
;
2130 /* force update the database */
2131 print_cache_flush(lp_const_servicename(snum
));
2133 /* Send a printer notify message */
2135 notify_job_status(sharename
, jobid
, JOB_STATUS_QUEUED
);
2140 /****************************************************************************
2141 Write to a print file.
2142 ****************************************************************************/
2144 ssize_t
print_job_write(int snum
, uint32 jobid
, const char *buf
, SMB_OFF_T pos
, size_t size
)
2146 const char* sharename
= lp_const_servicename(snum
);
2148 struct printjob
*pjob
;
2150 pjob
= print_job_find(sharename
, jobid
);
2154 /* don't allow another process to get this info - it is meaningless */
2155 if (pjob
->pid
!= sys_getpid())
2158 return_code
= write_data_at_offset(pjob
->fd
, buf
, size
, pos
);
2160 if (return_code
>0) {
2162 pjob_store(sharename
, jobid
, pjob
);
2167 /****************************************************************************
2168 Get the queue status - do not update if db is out of date.
2169 ****************************************************************************/
2171 static int get_queue_status(const char* sharename
, print_status_struct
*status
)
2175 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
2179 ZERO_STRUCTP(status
);
2186 fstr_sprintf(keystr
, "STATUS/%s", sharename
);
2187 data
= tdb_fetch(pdb
->tdb
, string_tdb_data(keystr
));
2189 if (data
.dsize
== sizeof(print_status_struct
))
2190 /* this memcpy is ok since the status struct was
2191 not packed before storing it in the tdb */
2192 memcpy(status
, data
.dptr
, sizeof(print_status_struct
));
2193 SAFE_FREE(data
.dptr
);
2196 len
= tdb_fetch_int32(pdb
->tdb
, "INFO/total_jobs");
2197 release_print_db(pdb
);
2198 return (len
== -1 ? 0 : len
);
2201 /****************************************************************************
2202 Determine the number of jobs in a queue.
2203 ****************************************************************************/
2205 int print_queue_length(int snum
, print_status_struct
*pstatus
)
2207 const char* sharename
= lp_const_servicename( snum
);
2208 print_status_struct status
;
2211 ZERO_STRUCT( status
);
2213 /* make sure the database is up to date */
2214 if (print_cache_expired(lp_const_servicename(snum
), True
))
2215 print_queue_update(snum
, False
);
2217 /* also fetch the queue status */
2218 memset(&status
, 0, sizeof(status
));
2219 len
= get_queue_status(sharename
, &status
);
2227 /***************************************************************************
2228 Allocate a jobid. Hold the lock for as short a time as possible.
2229 ***************************************************************************/
2231 static BOOL
allocate_print_jobid(struct tdb_print_db
*pdb
, int snum
, const char *sharename
, uint32
*pjobid
)
2236 *pjobid
= (uint32
)-1;
2238 for (i
= 0; i
< 3; i
++) {
2239 /* Lock the database - only wait 20 seconds. */
2240 if (tdb_lock_bystring_with_timeout(pdb
->tdb
, "INFO/nextjob", 20) == -1) {
2241 DEBUG(0,("allocate_print_jobid: failed to lock printing database %s\n", sharename
));
2245 if (!tdb_fetch_uint32(pdb
->tdb
, "INFO/nextjob", &jobid
)) {
2246 if (tdb_error(pdb
->tdb
) != TDB_ERR_NOEXIST
) {
2247 DEBUG(0, ("allocate_print_jobid: failed to fetch INFO/nextjob for print queue %s\n",
2254 jobid
= NEXT_JOBID(jobid
);
2256 if (tdb_store_int32(pdb
->tdb
, "INFO/nextjob", jobid
)==-1) {
2257 DEBUG(3, ("allocate_print_jobid: failed to store INFO/nextjob.\n"));
2258 tdb_unlock_bystring(pdb
->tdb
, "INFO/nextjob");
2262 /* We've finished with the INFO/nextjob lock. */
2263 tdb_unlock_bystring(pdb
->tdb
, "INFO/nextjob");
2265 if (!print_job_exists(sharename
, jobid
))
2270 DEBUG(0, ("allocate_print_jobid: failed to allocate a print job for queue %s\n",
2272 /* Probably full... */
2277 /* Store a dummy placeholder. */
2282 if (tdb_store(pdb
->tdb
, print_key(jobid
), dum
, TDB_INSERT
) == -1) {
2283 DEBUG(3, ("allocate_print_jobid: jobid (%d) failed to store placeholder.\n",
2293 /***************************************************************************
2294 Append a jobid to the 'jobs changed' list.
2295 ***************************************************************************/
2297 static BOOL
add_to_jobs_changed(struct tdb_print_db
*pdb
, uint32 jobid
)
2302 SIVAL(&store_jobid
, 0, jobid
);
2303 data
.dptr
= (uint8
*)&store_jobid
;
2306 DEBUG(10,("add_to_jobs_changed: Added jobid %u\n", (unsigned int)jobid
));
2308 return (tdb_append(pdb
->tdb
, string_tdb_data("INFO/jobs_changed"),
2312 /***************************************************************************
2313 Start spooling a job - return the jobid.
2314 ***************************************************************************/
2316 uint32
print_job_start(struct current_user
*user
, int snum
, char *jobname
, NT_DEVICEMODE
*nt_devmode
)
2320 struct printjob pjob
;
2322 const char *sharename
= lp_const_servicename(snum
);
2323 struct tdb_print_db
*pdb
= get_print_db_byname(sharename
);
2331 if (!print_access_check(user
, snum
, PRINTER_ACCESS_USE
)) {
2332 DEBUG(3, ("print_job_start: job start denied by security descriptor\n"));
2333 release_print_db(pdb
);
2337 if (!print_time_access_check(lp_servicename(snum
))) {
2338 DEBUG(3, ("print_job_start: job start denied by time check\n"));
2339 release_print_db(pdb
);
2343 path
= lp_pathname(snum
);
2345 /* see if we have sufficient disk space */
2346 if (lp_minprintspace(snum
)) {
2347 SMB_BIG_UINT dspace
, dsize
;
2348 if (sys_fsusage(path
, &dspace
, &dsize
) == 0 &&
2349 dspace
< 2*(SMB_BIG_UINT
)lp_minprintspace(snum
)) {
2350 DEBUG(3, ("print_job_start: disk space check failed.\n"));
2351 release_print_db(pdb
);
2357 /* for autoloaded printers, check that the printcap entry still exists */
2358 if (lp_autoloaded(snum
) && !pcap_printername_ok(lp_const_servicename(snum
))) {
2359 DEBUG(3, ("print_job_start: printer name %s check failed.\n", lp_const_servicename(snum
) ));
2360 release_print_db(pdb
);
2365 /* Insure the maximum queue size is not violated */
2366 if ((njobs
= print_queue_length(snum
,NULL
)) > lp_maxprintjobs(snum
)) {
2367 DEBUG(3, ("print_job_start: Queue %s number of jobs (%d) larger than max printjobs per queue (%d).\n",
2368 sharename
, njobs
, lp_maxprintjobs(snum
) ));
2369 release_print_db(pdb
);
2374 DEBUG(10,("print_job_start: Queue %s number of jobs (%d), max printjobs = %d\n",
2375 sharename
, njobs
, lp_maxprintjobs(snum
) ));
2377 if (!allocate_print_jobid(pdb
, snum
, sharename
, &jobid
))
2380 /* create the database entry */
2384 pjob
.pid
= sys_getpid();
2387 pjob
.starttime
= time(NULL
);
2388 pjob
.status
= LPQ_SPOOLING
;
2390 pjob
.spooled
= False
;
2392 pjob
.nt_devmode
= nt_devmode
;
2394 fstrcpy(pjob
.jobname
, jobname
);
2396 if ((vuser
= get_valid_user_struct(user
->vuid
)) != NULL
) {
2397 fstrcpy(pjob
.user
, lp_printjob_username(snum
));
2398 standard_sub_basic(vuser
->user
.smb_name
, vuser
->user
.domain
,
2399 pjob
.user
, sizeof(pjob
.user
)-1);
2400 /* ensure NULL termination */
2401 pjob
.user
[sizeof(pjob
.user
)-1] = '\0';
2403 fstrcpy(pjob
.user
, uidtoname(user
->ut
.uid
));
2406 fstrcpy(pjob
.queuename
, lp_const_servicename(snum
));
2408 /* we have a job entry - now create the spool file */
2409 slprintf(pjob
.filename
, sizeof(pjob
.filename
)-1, "%s/%s%.8u.XXXXXX",
2410 path
, PRINT_SPOOL_PREFIX
, (unsigned int)jobid
);
2411 pjob
.fd
= smb_mkstemp(pjob
.filename
);
2413 if (pjob
.fd
== -1) {
2414 if (errno
== EACCES
) {
2415 /* Common setup error, force a report. */
2416 DEBUG(0, ("print_job_start: insufficient permissions \
2417 to open spool file %s.\n", pjob
.filename
));
2419 /* Normal case, report at level 3 and above. */
2420 DEBUG(3, ("print_job_start: can't open spool file %s,\n", pjob
.filename
));
2421 DEBUGADD(3, ("errno = %d (%s).\n", errno
, strerror(errno
)));
2426 pjob_store(sharename
, jobid
, &pjob
);
2428 /* Update the 'jobs changed' entry used by print_queue_status. */
2429 add_to_jobs_changed(pdb
, jobid
);
2431 /* Ensure we keep a rough count of the number of total jobs... */
2432 tdb_change_int32_atomic(pdb
->tdb
, "INFO/total_jobs", &njobs
, 1);
2434 release_print_db(pdb
);
2440 pjob_delete(sharename
, jobid
);
2442 release_print_db(pdb
);
2444 DEBUG(3, ("print_job_start: returning fail. Error = %s\n", strerror(errno
) ));
2448 /****************************************************************************
2449 Update the number of pages spooled to jobid
2450 ****************************************************************************/
2452 void print_job_endpage(int snum
, uint32 jobid
)
2454 const char* sharename
= lp_const_servicename(snum
);
2455 struct printjob
*pjob
;
2457 pjob
= print_job_find(sharename
, jobid
);
2460 /* don't allow another process to get this info - it is meaningless */
2461 if (pjob
->pid
!= sys_getpid())
2465 pjob_store(sharename
, jobid
, pjob
);
2468 /****************************************************************************
2469 Print a file - called on closing the file. This spools the job.
2470 If normal close is false then we're tearing down the jobs - treat as an
2472 ****************************************************************************/
2474 BOOL
print_job_end(int snum
, uint32 jobid
, enum file_close_type close_type
)
2476 const char* sharename
= lp_const_servicename(snum
);
2477 struct printjob
*pjob
;
2479 SMB_STRUCT_STAT sbuf
;
2480 struct printif
*current_printif
= get_printer_fns( snum
);
2482 pjob
= print_job_find(sharename
, jobid
);
2487 if (pjob
->spooled
|| pjob
->pid
!= sys_getpid())
2490 if ((close_type
== NORMAL_CLOSE
|| close_type
== SHUTDOWN_CLOSE
) &&
2491 (sys_fstat(pjob
->fd
, &sbuf
) == 0)) {
2492 pjob
->size
= sbuf
.st_size
;
2498 * Not a normal close or we couldn't stat the job file,
2499 * so something has gone wrong. Cleanup.
2503 DEBUG(3,("print_job_end: failed to stat file for jobid %d\n", jobid
));
2507 /* Technically, this is not quite right. If the printer has a separator
2508 * page turned on, the NT spooler prints the separator page even if the
2509 * print job is 0 bytes. 010215 JRR */
2510 if (pjob
->size
== 0 || pjob
->status
== LPQ_DELETING
) {
2511 /* don't bother spooling empty files or something being deleted. */
2512 DEBUG(5,("print_job_end: canceling spool of %s (%s)\n",
2513 pjob
->filename
, pjob
->size
? "deleted" : "zero length" ));
2514 unlink(pjob
->filename
);
2515 pjob_delete(sharename
, jobid
);
2519 pjob
->smbjob
= jobid
;
2521 ret
= (*(current_printif
->job_submit
))(snum
, pjob
);
2526 /* The print job has been sucessfully handed over to the back-end */
2528 pjob
->spooled
= True
;
2529 pjob
->status
= LPQ_QUEUED
;
2530 pjob_store(sharename
, jobid
, pjob
);
2532 /* make sure the database is up to date */
2533 if (print_cache_expired(lp_const_servicename(snum
), True
))
2534 print_queue_update(snum
, False
);
2540 /* The print job was not succesfully started. Cleanup */
2541 /* Still need to add proper error return propagation! 010122:JRR */
2542 unlink(pjob
->filename
);
2543 pjob_delete(sharename
, jobid
);
2547 /****************************************************************************
2548 Get a snapshot of jobs in the system without traversing.
2549 ****************************************************************************/
2551 static BOOL
get_stored_queue_info(struct tdb_print_db
*pdb
, int snum
, int *pcount
, print_queue_struct
**ppqueue
)
2553 TDB_DATA data
, cgdata
;
2554 print_queue_struct
*queue
= NULL
;
2556 uint32 extra_count
= 0;
2557 int total_count
= 0;
2560 int max_reported_jobs
= lp_max_reported_jobs(snum
);
2562 const char* sharename
= lp_servicename(snum
);
2564 /* make sure the database is up to date */
2565 if (print_cache_expired(lp_const_servicename(snum
), True
))
2566 print_queue_update(snum
, False
);
2572 ZERO_STRUCT(cgdata
);
2574 /* Get the stored queue data. */
2575 data
= tdb_fetch(pdb
->tdb
, string_tdb_data("INFO/linear_queue_array"));
2577 if (data
.dptr
&& data
.dsize
>= sizeof(qcount
))
2578 len
+= tdb_unpack(data
.dptr
+ len
, data
.dsize
- len
, "d", &qcount
);
2580 /* Get the changed jobs list. */
2581 cgdata
= tdb_fetch(pdb
->tdb
, string_tdb_data("INFO/jobs_changed"));
2582 if (cgdata
.dptr
!= NULL
&& (cgdata
.dsize
% 4 == 0))
2583 extra_count
= cgdata
.dsize
/4;
2585 DEBUG(5,("get_stored_queue_info: qcount = %u, extra_count = %u\n", (unsigned int)qcount
, (unsigned int)extra_count
));
2587 /* Allocate the queue size. */
2588 if (qcount
== 0 && extra_count
== 0)
2591 if ((queue
= SMB_MALLOC_ARRAY(print_queue_struct
, qcount
+ extra_count
)) == NULL
)
2594 /* Retrieve the linearised queue data. */
2596 for( i
= 0; i
< qcount
; i
++) {
2597 uint32 qjob
, qsize
, qpage_count
, qstatus
, qpriority
, qtime
;
2598 len
+= tdb_unpack(data
.dptr
+ len
, data
.dsize
- len
, "ddddddff",
2607 queue
[i
].job
= qjob
;
2608 queue
[i
].size
= qsize
;
2609 queue
[i
].page_count
= qpage_count
;
2610 queue
[i
].status
= qstatus
;
2611 queue
[i
].priority
= qpriority
;
2612 queue
[i
].time
= qtime
;
2615 total_count
= qcount
;
2617 /* Add in the changed jobids. */
2618 for( i
= 0; i
< extra_count
; i
++) {
2620 struct printjob
*pjob
;
2622 jobid
= IVAL(cgdata
.dptr
, i
*4);
2623 DEBUG(5,("get_stored_queue_info: changed job = %u\n", (unsigned int)jobid
));
2624 pjob
= print_job_find(lp_const_servicename(snum
), jobid
);
2626 DEBUG(5,("get_stored_queue_info: failed to find changed job = %u\n", (unsigned int)jobid
));
2627 remove_from_jobs_changed(sharename
, jobid
);
2631 queue
[total_count
].job
= jobid
;
2632 queue
[total_count
].size
= pjob
->size
;
2633 queue
[total_count
].page_count
= pjob
->page_count
;
2634 queue
[total_count
].status
= pjob
->status
;
2635 queue
[total_count
].priority
= 1;
2636 queue
[total_count
].time
= pjob
->starttime
;
2637 fstrcpy(queue
[total_count
].fs_user
, pjob
->user
);
2638 fstrcpy(queue
[total_count
].fs_file
, pjob
->jobname
);
2642 /* Sort the queue by submission time otherwise they are displayed
2645 qsort(queue
, total_count
, sizeof(print_queue_struct
), QSORT_CAST(printjob_comp
));
2647 DEBUG(5,("get_stored_queue_info: total_count = %u\n", (unsigned int)total_count
));
2649 if (max_reported_jobs
&& total_count
> max_reported_jobs
)
2650 total_count
= max_reported_jobs
;
2653 *pcount
= total_count
;
2659 SAFE_FREE(data
.dptr
);
2660 SAFE_FREE(cgdata
.dptr
);
2664 /****************************************************************************
2665 Get a printer queue listing.
2666 set queue = NULL and status = NULL if you just want to update the cache
2667 ****************************************************************************/
2669 int print_queue_status(int snum
,
2670 print_queue_struct
**ppqueue
,
2671 print_status_struct
*status
)
2675 const char *sharename
;
2676 struct tdb_print_db
*pdb
;
2679 /* make sure the database is up to date */
2681 if (print_cache_expired(lp_const_servicename(snum
), True
))
2682 print_queue_update(snum
, False
);
2684 /* return if we are done */
2685 if ( !ppqueue
|| !status
)
2689 sharename
= lp_const_servicename(snum
);
2690 pdb
= get_print_db_byname(sharename
);
2696 * Fetch the queue status. We must do this first, as there may
2697 * be no jobs in the queue.
2700 ZERO_STRUCTP(status
);
2701 slprintf(keystr
, sizeof(keystr
)-1, "STATUS/%s", sharename
);
2702 key
= string_tdb_data(keystr
);
2704 data
= tdb_fetch(pdb
->tdb
, key
);
2706 if (data
.dsize
== sizeof(*status
)) {
2707 /* this memcpy is ok since the status struct was
2708 not packed before storing it in the tdb */
2709 memcpy(status
, data
.dptr
, sizeof(*status
));
2711 SAFE_FREE(data
.dptr
);
2715 * Now, fetch the print queue information. We first count the number
2716 * of entries, and then only retrieve the queue if necessary.
2719 if (!get_stored_queue_info(pdb
, snum
, &count
, ppqueue
)) {
2720 release_print_db(pdb
);
2724 release_print_db(pdb
);
2728 /****************************************************************************
2730 ****************************************************************************/
2732 BOOL
print_queue_pause(struct current_user
*user
, int snum
, WERROR
*errcode
)
2735 struct printif
*current_printif
= get_printer_fns( snum
);
2737 if (!print_access_check(user
, snum
, PRINTER_ACCESS_ADMINISTER
)) {
2738 *errcode
= WERR_ACCESS_DENIED
;
2745 ret
= (*(current_printif
->queue_pause
))(snum
);
2750 *errcode
= WERR_INVALID_PARAM
;
2754 /* force update the database */
2755 print_cache_flush(lp_const_servicename(snum
));
2757 /* Send a printer notify message */
2759 notify_printer_status(snum
, PRINTER_STATUS_PAUSED
);
2764 /****************************************************************************
2766 ****************************************************************************/
2768 BOOL
print_queue_resume(struct current_user
*user
, int snum
, WERROR
*errcode
)
2771 struct printif
*current_printif
= get_printer_fns( snum
);
2773 if (!print_access_check(user
, snum
, PRINTER_ACCESS_ADMINISTER
)) {
2774 *errcode
= WERR_ACCESS_DENIED
;
2780 ret
= (*(current_printif
->queue_resume
))(snum
);
2785 *errcode
= WERR_INVALID_PARAM
;
2789 /* make sure the database is up to date */
2790 if (print_cache_expired(lp_const_servicename(snum
), True
))
2791 print_queue_update(snum
, True
);
2793 /* Send a printer notify message */
2795 notify_printer_status(snum
, PRINTER_STATUS_OK
);
2800 /****************************************************************************
2801 Purge a queue - implemented by deleting all jobs that we can delete.
2802 ****************************************************************************/
2804 BOOL
print_queue_purge(struct current_user
*user
, int snum
, WERROR
*errcode
)
2806 print_queue_struct
*queue
;
2807 print_status_struct status
;
2811 /* Force and update so the count is accurate (i.e. not a cached count) */
2812 print_queue_update(snum
, True
);
2814 can_job_admin
= print_access_check(user
, snum
, JOB_ACCESS_ADMINISTER
);
2815 njobs
= print_queue_status(snum
, &queue
, &status
);
2817 if ( can_job_admin
)
2820 for (i
=0;i
<njobs
;i
++) {
2821 BOOL owner
= is_owner(user
, lp_const_servicename(snum
), queue
[i
].job
);
2823 if (owner
|| can_job_admin
) {
2824 print_job_delete1(snum
, queue
[i
].job
);
2828 if ( can_job_admin
)
2831 /* update the cache */
2832 print_queue_update( snum
, True
);